blob: 18e8bf6379a515f873372fe8b74711ae062241ed [file] [log] [blame]
bsalomon@google.comc26d94f2013-03-25 18:19:00 +00001
2/*
3 * Copyright 2013 Google Inc.
4 *
5 * Use of this source code is governed by a BSD-style license that can be
6 * found in the LICENSE file.
7 */
bsalomon4b91f762015-05-19 09:29:46 -07008#ifndef GrCaps_DEFINED
9#define GrCaps_DEFINED
bsalomon@google.comc26d94f2013-03-25 18:19:00 +000010
Mike Kleinc0bd9f92019-04-23 12:05:21 -050011#include "include/core/SkImageInfo.h"
12#include "include/core/SkRefCnt.h"
13#include "include/core/SkString.h"
Mike Kleinc0bd9f92019-04-23 12:05:21 -050014#include "include/gpu/GrDriverBugWorkarounds.h"
15#include "include/private/GrTypesPriv.h"
Greg Daniel01f278c2020-06-12 16:58:17 -040016#include "src/core/SkCompressedDataUtils.h"
Brian Salomon096b0912019-08-14 16:56:13 -040017#include "src/gpu/GrBlend.h"
Brian Salomonccb61422020-01-09 10:46:36 -050018#include "src/gpu/GrSamplerState.h"
Mike Kleinc0bd9f92019-04-23 12:05:21 -050019#include "src/gpu/GrShaderCaps.h"
Brian Salomon1e03b6b12019-07-17 17:28:24 -040020#include "src/gpu/GrSurfaceProxy.h"
commit-bot@chromium.org8b656c62013-11-21 15:23:15 +000021
Robert Phillipsfc711a22018-02-13 17:03:00 -050022class GrBackendFormat;
Greg Danielfaa095e2017-12-19 13:15:02 -050023class GrBackendRenderTarget;
Greg Danielf5d87582017-12-18 14:48:15 -050024class GrBackendTexture;
bsalomon682c2692015-05-22 14:01:46 -070025struct GrContextOptions;
Robert Phillips323471e2019-11-11 11:33:37 -050026class GrProcessorKeyBuilder;
Robert Phillips03e4c952019-11-26 16:20:22 -050027class GrProgramDesc;
28class GrProgramInfo;
Robert Phillipsbf25d432017-04-07 10:08:53 -040029class GrRenderTargetProxy;
Brian Salomon3d86a192018-02-27 16:46:11 -050030class GrSurface;
Brian Osman71a18892017-08-10 10:23:25 -040031class SkJSONWriter;
jvanverthe9c0fc62015-04-29 11:18:05 -070032
33/**
bsalomon4b91f762015-05-19 09:29:46 -070034 * Represents the capabilities of a GrContext.
jvanverthe9c0fc62015-04-29 11:18:05 -070035 */
bsalomon4b91f762015-05-19 09:29:46 -070036class GrCaps : public SkRefCnt {
jvanverthe9c0fc62015-04-29 11:18:05 -070037public:
bsalomon682c2692015-05-22 14:01:46 -070038 GrCaps(const GrContextOptions&);
bsalomon@google.comc26d94f2013-03-25 18:19:00 +000039
Brian Osman71a18892017-08-10 10:23:25 -040040 void dumpJSON(SkJSONWriter*) const;
41
Brian Salomon94efbf52016-11-29 13:43:05 -050042 const GrShaderCaps* shaderCaps() const { return fShaderCaps.get(); }
Robert Phillips7f11fb52019-12-03 13:35:19 -050043 sk_sp<const GrShaderCaps> refShaderCaps() const { return fShaderCaps; }
jvanverthe9c0fc62015-04-29 11:18:05 -070044
bsalomon@google.comc26d94f2013-03-25 18:19:00 +000045 bool npotTextureTileSupport() const { return fNPOTTextureTileSupport; }
commit-bot@chromium.org47442312013-12-19 16:18:01 +000046 /** To avoid as-yet-unnecessary complexity we don't allow any partial support of MIP Maps (e.g.
47 only for POT textures) */
Brian Salomon69100f02020-07-21 10:49:25 -040048 bool mipmapSupport() const { return fMipmapSupport; }
brianosman64d094d2016-03-25 06:01:59 -070049
commit-bot@chromium.orga3baf3b2014-02-21 18:45:30 +000050 bool gpuTracingSupport() const { return fGpuTracingSupport; }
bsalomond08ea5f2015-02-20 06:58:13 -080051 bool oversizedStencilSupport() const { return fOversizedStencilSupport; }
cdaltonfd4167d2015-04-21 11:45:56 -070052 bool textureBarrierSupport() const { return fTextureBarrierSupport; }
Robert Phillips7f861922018-01-30 13:13:42 +000053 bool sampleLocationsSupport() const { return fSampleLocationsSupport; }
csmartdalton2b5f2cb2016-06-10 14:06:32 -070054 bool multisampleDisableSupport() const { return fMultisampleDisableSupport; }
Chris Daltona77cdee2020-04-03 14:50:43 -060055 bool drawInstancedSupport() const { return fDrawInstancedSupport; }
Chris Dalton03fdf6a2020-04-07 12:31:59 -060056 // Is there hardware support for indirect draws? (Ganesh always supports indirect draws as long
57 // as it can polyfill them with instanced calls, but this cap tells us if they are supported
58 // natively.)
59 bool nativeDrawIndirectSupport() const { return fNativeDrawIndirectSupport; }
Chris Daltonbde4bb72020-07-17 14:11:04 -060060 bool useClientSideIndirectBuffers() const {
61#ifdef SK_DEBUG
62 if (!fNativeDrawIndirectSupport || fNativeDrawIndexedIndirectIsBroken) {
63 // We might implement indirect draws with a polyfill, so the commands need to reside in
64 // CPU memory.
65 SkASSERT(fUseClientSideIndirectBuffers);
66 }
67#endif
68 return fUseClientSideIndirectBuffers;
69 }
Chris Dalton6ce447a2019-06-23 18:07:38 -060070 bool mixedSamplesSupport() const { return fMixedSamplesSupport; }
Chris Daltonce425af2019-12-16 10:39:03 -070071 bool conservativeRasterSupport() const { return fConservativeRasterSupport; }
Chris Dalton1215cda2019-12-17 21:44:04 -070072 bool wireframeSupport() const { return fWireframeSupport; }
Chris Daltond5d8a642019-08-08 15:29:20 -060073 // This flag indicates that we never have to resolve MSAA. In practice, it means that we have
74 // an MSAA-render-to-texture extension: Any render target we create internally will use the
75 // extension, and any wrapped render target is the client's responsibility.
76 bool msaaResolvesAutomatically() const { return fMSAAResolvesAutomatically; }
Brian Osman499bf1a2018-09-17 11:32:42 -040077 bool halfFloatVertexAttributeSupport() const { return fHalfFloatVertexAttributeSupport; }
Chris Dalton27059d32018-01-23 14:06:50 -070078
79 // Primitive restart functionality is core in ES 3.0, but using it will cause slowdowns on some
80 // systems. This cap is only set if primitive restart will improve performance.
81 bool usePrimitiveRestart() const { return fUsePrimitiveRestart; }
82
csmartdalton485a1202016-07-13 10:16:32 -070083 bool preferClientSideDynamicBuffers() const { return fPreferClientSideDynamicBuffers; }
robertphillips@google.com2d2e5c42013-10-30 21:30:43 +000084
Chris Dalton344e9032017-12-11 15:42:09 -070085 // On tilers, an initial fullscreen clear is an OPTIMIZATION. It allows the hardware to
86 // initialize each tile with a constant value rather than loading each pixel from memory.
87 bool preferFullscreenClears() const { return fPreferFullscreenClears; }
88
Chris Dalton674f77a2019-09-30 20:49:39 -060089 // Should we discard stencil values after a render pass? (Tilers get better performance if we
90 // always load stencil buffers with a "clear" op, and then discard the content when finished.)
91 bool discardStencilValuesAfterRenderPass() const {
Chris Daltona8b16362020-07-17 17:38:54 -070092 // b/160958008
93 return false;
94#if 0
Chris Dalton674f77a2019-09-30 20:49:39 -060095 // This method is actually just a duplicate of preferFullscreenClears(), with a descriptive
96 // name for the sake of readability.
97 return this->preferFullscreenClears();
Chris Daltona8b16362020-07-17 17:38:54 -070098#endif
Chris Dalton674f77a2019-09-30 20:49:39 -060099 }
100
Chris Dalton3d28b6a2020-04-13 11:12:28 -0600101 // D3D does not allow the refs or masks to differ on a two-sided stencil draw.
102 bool twoSidedStencilRefsAndMasksMustMatch() const {
103 return fTwoSidedStencilRefsAndMasksMustMatch;
104 }
105
robertphillips63926682015-08-20 09:39:02 -0700106 bool preferVRAMUseOverFlushes() const { return fPreferVRAMUseOverFlushes; }
107
Eric Karl5c779752017-05-08 12:02:07 -0700108 bool avoidStencilBuffers() const { return fAvoidStencilBuffers; }
109
Greg Daniel4374e962018-09-28 15:09:47 -0400110 bool avoidWritePixelsFastPath() const { return fAvoidWritePixelsFastPath; }
111
Chris Daltone1196c52019-12-28 14:31:09 -0700112 // http://skbug.com/9739
113 bool requiresManualFBBarrierAfterTessellatedStencilDraw() const {
114 return fRequiresManualFBBarrierAfterTessellatedStencilDraw;
115 }
116
Chris Dalton03fdf6a2020-04-07 12:31:59 -0600117 // glDrawElementsIndirect fails GrMeshTest on every Win10 Intel bot.
118 bool nativeDrawIndexedIndirectIsBroken() const { return fNativeDrawIndexedIndirectIsBroken; }
119
csmartdaltone0d36292016-07-29 08:14:20 -0700120 /**
cdalton8917d622015-05-06 13:40:21 -0700121 * Indicates the capabilities of the fixed function blend unit.
122 */
123 enum BlendEquationSupport {
124 kBasic_BlendEquationSupport, //<! Support to select the operator that
125 // combines src and dst terms.
126 kAdvanced_BlendEquationSupport, //<! Additional fixed function support for specific
127 // SVG/PDF blend modes. Requires blend barriers.
128 kAdvancedCoherent_BlendEquationSupport, //<! Advanced blend equation support that does not
129 // require blend barriers, and permits overlap.
130
131 kLast_BlendEquationSupport = kAdvancedCoherent_BlendEquationSupport
132 };
133
134 BlendEquationSupport blendEquationSupport() const { return fBlendEquationSupport; }
135
136 bool advancedBlendEquationSupport() const {
137 return fBlendEquationSupport >= kAdvanced_BlendEquationSupport;
138 }
139
140 bool advancedCoherentBlendEquationSupport() const {
141 return kAdvancedCoherent_BlendEquationSupport == fBlendEquationSupport;
142 }
143
Jim Van Verth1bef9792020-07-09 08:09:13 -0400144 bool isAdvancedBlendEquationDisabled(GrBlendEquation equation) const {
cdalton1dd05422015-06-12 09:01:18 -0700145 SkASSERT(GrBlendEquationIsAdvanced(equation));
Chris Dalton302d5be2019-01-22 23:41:25 -0700146 SkASSERT(this->advancedBlendEquationSupport());
Jim Van Verth1bef9792020-07-09 08:09:13 -0400147 return SkToBool(fAdvBlendEqDisableFlags & (1 << equation));
cdalton1dd05422015-06-12 09:01:18 -0700148 }
149
Greg Danielf6d60d32020-01-08 13:39:16 -0500150 // On some GPUs it is a performance win to disable blending instead of doing src-over with a src
151 // alpha equal to 1. To disable blending we collapse src-over to src and the backends will
152 // handle the disabling of blending.
153 bool shouldCollapseSrcOverToSrcWhenAble() const {
154 return fShouldCollapseSrcOverToSrcWhenAble;
155 }
156
Greg Daniela89b4302021-01-29 10:48:40 -0500157 // When abandoning the GrDirectContext do we need to sync the GPU before we start abandoning
158 // resources.
159 bool mustSyncGpuDuringAbandon() const {
160 return fMustSyncGpuDuringAbandon;
161 }
162
cdalton8917d622015-05-06 13:40:21 -0700163 /**
commit-bot@chromium.org160b4782014-05-05 12:32:37 +0000164 * Indicates whether GPU->CPU memory mapping for GPU resources such as vertex buffers and
165 * textures allows partial mappings or full mappings.
166 */
167 enum MapFlags {
Brian Salomon105d7c22019-04-16 13:46:14 -0400168 kNone_MapFlags = 0x0, //<! Cannot map the resource.
commit-bot@chromium.org160b4782014-05-05 12:32:37 +0000169
Brian Salomon105d7c22019-04-16 13:46:14 -0400170 kCanMap_MapFlag = 0x1, //<! The resource can be mapped. Must be set for any of
171 // the other flags to have meaning.
172 kSubset_MapFlag = 0x2, //<! The resource can be partially mapped.
Greg Daniel2d41d0d2019-08-26 11:08:51 -0400173 kAsyncRead_MapFlag = 0x4, //<! Are maps for reading asynchronous WRT GrOpsRenderPass
Brian Salomon105d7c22019-04-16 13:46:14 -0400174 // submitted to GrGpu.
commit-bot@chromium.org160b4782014-05-05 12:32:37 +0000175 };
176
Greg Daniel5af72c12021-02-08 13:52:08 -0500177 // This returns the general mapping support for the GPU. However, even if this returns a flag
178 // that says buffers can be mapped, it does NOT mean that every buffer will be mappable. Thus
179 // calls of map should still check to see if a valid pointer was returned from the map call and
180 // handle fallbacks appropriately. If this does return kNone_MapFlags then all calls to map() on
181 // any buffer will fail.
commit-bot@chromium.org160b4782014-05-05 12:32:37 +0000182 uint32_t mapBufferFlags() const { return fMapBufferFlags; }
183
robertphillips@google.com2d2e5c42013-10-30 21:30:43 +0000184 // Scratch textures not being reused means that those scratch textures
skia.committer@gmail.com7ed98df2013-10-31 07:01:53 +0000185 // that we upload to (i.e., don't have a render target) will not be
robertphillips@google.com2d2e5c42013-10-30 21:30:43 +0000186 // recycled in the texture cache. This is to prevent ghosting by drivers
187 // (in particular for deferred architectures).
commit-bot@chromium.orgb8356522013-07-18 22:26:39 +0000188 bool reuseScratchTextures() const { return fReuseScratchTextures; }
robertphillips1b8e1b52015-06-24 06:54:10 -0700189 bool reuseScratchBuffers() const { return fReuseScratchBuffers; }
bsalomon@google.comc26d94f2013-03-25 18:19:00 +0000190
bsalomon7dbd45d2016-03-23 10:40:53 -0700191 /// maximum number of attribute values per vertex
192 int maxVertexAttributes() const { return fMaxVertexAttributes; }
193
bsalomon@google.comc26d94f2013-03-25 18:19:00 +0000194 int maxRenderTargetSize() const { return fMaxRenderTargetSize; }
Chris Dalton2612bae2018-02-22 13:41:37 -0700195
196 /** This is the largest render target size that can be used without incurring extra perfomance
197 cost. It is usually the max RT size, unless larger render targets are known to be slower. */
198 int maxPreferredRenderTargetSize() const { return fMaxPreferredRenderTargetSize; }
199
bsalomon@google.comc26d94f2013-03-25 18:19:00 +0000200 int maxTextureSize() const { return fMaxTextureSize; }
Chris Dalton2612bae2018-02-22 13:41:37 -0700201
csmartdalton9bc11872016-08-09 12:42:47 -0700202 int maxWindowRectangles() const { return fMaxWindowRectangles; }
bsalomon@google.comc26d94f2013-03-25 18:19:00 +0000203
Greg Daniel2a303902018-02-20 10:25:54 -0500204 // Returns whether mixed samples is supported for the given backend render target.
205 bool isWindowRectanglesSupportedForRT(const GrBackendRenderTarget& rt) const {
206 return this->maxWindowRectangles() > 0 && this->onIsWindowRectanglesSupportedForRT(rt);
207 }
208
Jim Van Verth023f2e72020-10-09 15:38:58 -0400209 uint32_t maxPushConstantsSize() const { return fMaxPushConstantsSize; }
Jim Van Verth4b3d1f32020-10-08 15:46:36 -0400210
Robert Phillipsf209e882019-06-25 15:59:50 -0400211 virtual bool isFormatSRGB(const GrBackendFormat&) const = 0;
Greg Daniela00bcad2019-10-11 13:21:48 -0400212
Greg Daniel01f278c2020-06-12 16:58:17 -0400213 bool isFormatCompressed(const GrBackendFormat& format) const;
Robert Phillipsf209e882019-06-25 15:59:50 -0400214
Greg Daniel7bfc9132019-08-14 14:23:53 -0400215 // Can a texture be made with the GrBackendFormat, and then be bound and sampled in a shader.
216 virtual bool isFormatTexturable(const GrBackendFormat&) const = 0;
Brian Salomonbdecacf2018-02-02 20:32:49 -0500217
Greg Daniel6980c4e2019-07-30 16:18:18 -0400218 // Returns whether a texture of the given format can be copied to a texture of the same format.
219 virtual bool isFormatCopyable(const GrBackendFormat&) const = 0;
Brian Salomonbdecacf2018-02-02 20:32:49 -0500220
Greg Danieleadfac92019-08-02 09:03:53 -0400221 // Returns the maximum supported sample count for a format. 0 means the format is not renderable
Brian Salomon469046c2020-03-30 14:21:04 -0400222 // 1 means the format is renderable but doesn't support MSAA.
Greg Danieleadfac92019-08-02 09:03:53 -0400223 virtual int maxRenderTargetSampleCount(const GrBackendFormat&) const = 0;
Brian Salomonbdecacf2018-02-02 20:32:49 -0500224
Chris Dalton1e6c5b82019-06-17 14:16:49 -0600225 // Returns the number of samples to use when performing internal draws to the given config with
Chris Daltona1638a52019-06-24 11:54:24 -0600226 // MSAA or mixed samples. If 0, Ganesh should not attempt to use internal multisampling.
Greg Danieleadfac92019-08-02 09:03:53 -0400227 int internalMultisampleCount(const GrBackendFormat& format) const {
Brian Osman788b9162020-02-07 10:36:46 -0500228 return std::min(fInternalMultisampleCount, this->maxRenderTargetSampleCount(format));
Chris Dalton1e6c5b82019-06-17 14:16:49 -0600229 }
230
Greg Daniel900583a2019-08-06 12:05:31 -0400231 virtual bool isFormatAsColorTypeRenderable(GrColorType ct, const GrBackendFormat& format,
232 int sampleCount = 1) const = 0;
233
234 virtual bool isFormatRenderable(const GrBackendFormat& format, int sampleCount) const = 0;
Brian Salomonbdecacf2018-02-02 20:32:49 -0500235
236 // Find a sample count greater than or equal to the requested count which is supported for a
Greg Daniel6fa62e22019-08-07 15:52:37 -0400237 // render target of the given format or 0 if no such sample count is supported. If the requested
Brian Salomonbdecacf2018-02-02 20:32:49 -0500238 // sample count is 1 then 1 will be returned if non-MSAA rendering is supported, otherwise 0.
239 // For historical reasons requestedCount==0 is handled identically to requestedCount==1.
Greg Daniel6fa62e22019-08-07 15:52:37 -0400240 virtual int getRenderTargetSampleCount(int requestedCount, const GrBackendFormat&) const = 0;
commit-bot@chromium.org42dc8132014-05-27 19:26:59 +0000241
Brian Salomon5f33a8c2018-02-26 14:32:39 -0500242 /**
Brian Salomon3d86a192018-02-27 16:46:11 -0500243 * Backends may have restrictions on what types of surfaces support GrGpu::writePixels().
244 * If this returns false then the caller should implement a fallback where a temporary texture
245 * is created, pixels are written to it, and then that is copied or drawn into the the surface.
Brian Salomon5f33a8c2018-02-26 14:32:39 -0500246 */
Brian Salomonc67c31c2018-12-06 10:00:03 -0500247 bool surfaceSupportsWritePixels(const GrSurface*) const;
Brian Salomon19eaf2d2018-03-19 16:06:44 -0400248
Emircan Uysaler23ca4e72019-06-24 10:53:09 -0400249 /**
Brian Salomondc0710f2019-07-01 14:59:32 -0400250 * Indicates whether surface supports GrGpu::readPixels, must be copied, or cannot be read.
Emircan Uysaler23ca4e72019-06-24 10:53:09 -0400251 */
Brian Salomondc0710f2019-07-01 14:59:32 -0400252 enum class SurfaceReadPixelsSupport {
253 /** GrGpu::readPixels is supported by the surface. */
254 kSupported,
255 /**
256 * GrGpu::readPixels is not supported by this surface but this surface can be drawn
257 * or copied to a Ganesh-created GrTextureType::kTexture2D and then that surface will be
258 * readable.
259 */
260 kCopyToTexture2D,
261 /**
262 * Not supported
263 */
264 kUnsupported,
Emircan Uysaler23ca4e72019-06-24 10:53:09 -0400265 };
Brian Salomon19eaf2d2018-03-19 16:06:44 -0400266 /**
Brian Salomondc0710f2019-07-01 14:59:32 -0400267 * Backends may have restrictions on what types of surfaces support GrGpu::readPixels(). We may
268 * either be able to read directly from the surface, read from a copy of the surface, or not
269 * read at all.
Brian Salomon19eaf2d2018-03-19 16:06:44 -0400270 */
Brian Salomondc0710f2019-07-01 14:59:32 -0400271 virtual SurfaceReadPixelsSupport surfaceSupportsReadPixels(const GrSurface*) const = 0;
Brian Salomon5f33a8c2018-02-26 14:32:39 -0500272
Brian Salomon42be09d2019-07-26 12:12:26 -0400273 struct SupportedWrite {
274 GrColorType fColorType;
275 // If the write is occurring using GrGpu::transferPixelsTo then this provides the
276 // minimum alignment of the offset into the transfer buffer.
277 size_t fOffsetAlignmentForTransferBuffer;
278 };
279
Brian Salomon5f33a8c2018-02-26 14:32:39 -0500280 /**
281 * Given a dst pixel config and a src color type what color type must the caller coax the
282 * the data into in order to use GrGpu::writePixels().
283 */
Brian Salomon01915c02019-08-02 09:57:21 -0400284 virtual SupportedWrite supportedWritePixelsColorType(GrColorType surfaceColorType,
285 const GrBackendFormat& surfaceFormat,
Brian Salomon42be09d2019-07-26 12:12:26 -0400286 GrColorType srcColorType) const = 0;
Brian Salomon5f33a8c2018-02-26 14:32:39 -0500287
Brian Salomonf30b1c12019-06-20 12:25:02 -0400288 struct SupportedRead {
Brian Salomonf30b1c12019-06-20 12:25:02 -0400289 GrColorType fColorType;
Brian Salomon42be09d2019-07-26 12:12:26 -0400290 // If the read is occurring using GrGpu::transferPixelsFrom then this provides the
291 // minimum alignment of the offset into the transfer buffer.
Greg Danielba88ab62019-07-26 09:14:01 -0400292 size_t fOffsetAlignmentForTransferBuffer;
Brian Salomonf30b1c12019-06-20 12:25:02 -0400293 };
294
Brian Salomon19eaf2d2018-03-19 16:06:44 -0400295 /**
Greg Daniel00fb7242019-07-18 14:28:01 -0400296 * Given a src surface's color type and its backend format as well as a color type the caller
Brian Salomonf30b1c12019-06-20 12:25:02 -0400297 * would like read into, this provides a legal color type that the caller may pass to
298 * GrGpu::readPixels(). The returned color type may differ from the passed dstColorType, in
299 * which case the caller must convert the read pixel data (see GrConvertPixels). When converting
300 * to dstColorType the swizzle in the returned struct should be applied. The caller must check
301 * the returned color type for kUnknown.
Brian Salomon19eaf2d2018-03-19 16:06:44 -0400302 */
Greg Danielba88ab62019-07-26 09:14:01 -0400303 SupportedRead supportedReadPixelsColorType(GrColorType srcColorType,
304 const GrBackendFormat& srcFormat,
305 GrColorType dstColorType) const;
Brian Salomon19eaf2d2018-03-19 16:06:44 -0400306
Brian Salomon1047a492019-07-02 12:25:21 -0400307 /**
308 * Do GrGpu::writePixels() and GrGpu::transferPixelsTo() support a src buffer where the row
309 * bytes is not equal to bpp * w?
310 */
311 bool writePixelsRowBytesSupport() const { return fWritePixelsRowBytesSupport; }
312 /**
313 * Does GrGpu::readPixels() support a dst buffer where the row bytes is not equal to bpp * w?
314 */
315 bool readPixelsRowBytesSupport() const { return fReadPixelsRowBytesSupport; }
316
Brian Salomonfb28c6f2020-01-10 13:04:45 -0500317 bool transferFromSurfaceToBufferSupport() const { return fTransferFromSurfaceToBufferSupport; }
318 bool transferFromBufferToTextureSupport() const { return fTransferFromBufferToTextureSupport; }
Brian Salomone05ba5a2019-04-08 11:59:07 -0400319
robertphillipscaef3452015-11-11 13:18:11 -0800320 bool suppressPrints() const { return fSuppressPrints; }
321
cdalton397536c2016-03-25 12:15:03 -0700322 size_t bufferMapThreshold() const {
323 SkASSERT(fBufferMapThreshold >= 0);
324 return fBufferMapThreshold;
joshualitt7224c862015-05-29 06:46:47 -0700325 }
bsalomon682c2692015-05-22 14:01:46 -0700326
Mike Kleinfc6c37b2016-09-27 09:34:10 -0400327 /** True in environments that will issue errors if memory uploaded to buffers
bsalomon7dea7b72015-08-19 08:26:51 -0700328 is not initialized (even if not read by draw calls). */
329 bool mustClearUploadedBufferData() const { return fMustClearUploadedBufferData; }
330
Kevin Lubick61a5f0a2019-03-28 09:47:15 -0400331 /** For some environments, there is a performance or safety concern to not
332 initializing textures. For example, with WebGL and Firefox, there is a large
333 performance hit to not doing it.
334 */
335 bool shouldInitializeTextures() const { return fShouldInitializeTextures; }
336
Greg Danielb2acf0a2018-09-12 09:17:11 -0400337 /** Returns true if the given backend supports importing AHardwareBuffers via the
338 * GrAHardwarebufferImageGenerator. This will only ever be supported on Android devices with API
339 * level >= 26.
340 * */
341 bool supportsAHardwareBufferImages() const { return fSupportsAHardwareBufferImages; }
342
Jim Van Verthfbdc0802017-05-02 16:15:53 -0400343 bool wireframeMode() const { return fWireframeMode; }
344
Brian Salomon9ff5acb2019-05-08 09:04:47 -0400345 /** Supports using GrFence. */
jvanverth84741b32016-09-30 08:39:02 -0700346 bool fenceSyncSupport() const { return fFenceSyncSupport; }
Brian Salomon9ff5acb2019-05-08 09:04:47 -0400347
348 /** Supports using GrSemaphore. */
349 bool semaphoreSupport() const { return fSemaphoreSupport; }
350
Brian Osman2c2bc112017-02-28 10:02:49 -0500351 bool crossContextTextureSupport() const { return fCrossContextTextureSupport; }
Brian Salomon467921e2017-03-06 16:17:12 -0500352 /**
Greg Daniel25af6712018-04-25 10:44:38 -0400353 * Returns whether or not we will be able to do a copy given the passed in params
354 */
Brian Salomonc67c31c2018-12-06 10:00:03 -0500355 bool canCopySurface(const GrSurfaceProxy* dst, const GrSurfaceProxy* src,
356 const SkIRect& srcRect, const SkIPoint& dstPoint) const;
Greg Daniel25af6712018-04-25 10:44:38 -0400357
Brian Salomonf7232642018-09-19 08:58:08 -0400358 bool dynamicStateArrayGeometryProcessorTextureSupport() const {
359 return fDynamicStateArrayGeometryProcessorTextureSupport;
360 }
361
Michael Ludwigc39d0c82019-01-15 10:03:43 -0500362 // Not all backends support clearing with a scissor test (e.g. Metal), this will always
363 // return true if performColorClearsAsDraws() returns true.
Michael Ludwiga21d1962019-01-11 15:26:22 -0500364 bool performPartialClearsAsDraws() const {
Michael Ludwigc39d0c82019-01-15 10:03:43 -0500365 return fPerformColorClearsAsDraws || fPerformPartialClearsAsDraws;
Michael Ludwiga21d1962019-01-11 15:26:22 -0500366 }
367
368 // Many drivers have issues with color clears.
Chris Daltona8fbeba2019-03-30 00:31:23 -0600369 bool performColorClearsAsDraws() const { return fPerformColorClearsAsDraws; }
Michael Ludwiga21d1962019-01-11 15:26:22 -0500370
Robert Phillips2f05a482019-11-25 09:54:43 -0500371 bool avoidLargeIndexBufferDraws() const { return fAvoidLargeIndexBufferDraws; }
372
Michael Ludwiga21d1962019-01-11 15:26:22 -0500373 /// Adreno 4xx devices experience an issue when there are a large number of stencil clip bit
374 /// clears. The minimal repro steps are not precisely known but drawing a rect with a stencil
375 /// op instead of using glClear seems to resolve the issue.
Chris Daltona8fbeba2019-03-30 00:31:23 -0600376 bool performStencilClearsAsDraws() const { return fPerformStencilClearsAsDraws; }
377
Chris Dalton94310792021-03-12 11:10:24 -0700378 // Should we disable the clip mask atlas due to a faulty driver?
379 bool driverDisableMSAAClipAtlas() const { return fDriverDisableMSAAClipAtlas; }
Ethan Nicholas56d19a52018-10-15 11:26:20 -0400380
Chris Daltoneae5c162020-12-29 10:18:21 -0700381 // Should we disable GrTessellationPathRenderer due to a faulty driver?
382 bool disableTessellationPathRenderer() const { return fDisableTessellationPathRenderer; }
383
Greg Danield358cbe2020-09-11 09:33:54 -0400384 // Returns how to sample the dst values for the passed in GrRenderTargetProxy.
385 GrDstSampleType getDstSampleTypeForProxy(const GrRenderTargetProxy*) const;
386
Greg Daniel25af6712018-04-25 10:44:38 -0400387 /**
Brian Salomon1e03b6b12019-07-17 17:28:24 -0400388 * This is used to try to ensure a successful copy a dst in order to perform shader-based
389 * blending.
390 *
391 * fRectsMustMatch will be set to true if the copy operation must ensure that the src and dest
392 * rects are identical.
393 *
394 * fMustCopyWholeSrc will be set to true if copy rect must equal src's bounds.
395 *
396 * Caller will detect cases when copy cannot succeed and try copy-as-draw as a fallback.
Brian Salomon467921e2017-03-06 16:17:12 -0500397 */
Brian Salomon1e03b6b12019-07-17 17:28:24 -0400398 struct DstCopyRestrictions {
399 GrSurfaceProxy::RectsMustMatch fRectsMustMatch = GrSurfaceProxy::RectsMustMatch::kNo;
400 bool fMustCopyWholeSrc = false;
401 };
Greg Daniel0258c902019-08-01 13:08:33 -0400402 virtual DstCopyRestrictions getDstCopyRestrictions(const GrRenderTargetProxy* src,
403 GrColorType ct) const {
Brian Salomon1e03b6b12019-07-17 17:28:24 -0400404 return {};
405 }
Brian Salomon467921e2017-03-06 16:17:12 -0500406
Greg Daniel9a48beb2020-01-16 16:57:16 -0500407 bool validateSurfaceParams(const SkISize&, const GrBackendFormat&, GrRenderable renderable,
Brian Salomon7e67dca2020-07-21 09:27:25 -0400408 int renderTargetSampleCnt, GrMipmapped) const;
Brian Salomonbdecacf2018-02-02 20:32:49 -0500409
Greg Daniel01f278c2020-06-12 16:58:17 -0400410 bool areColorTypeAndFormatCompatible(GrColorType grCT, const GrBackendFormat& format) const;
Robert Phillipsc046ff02019-07-01 10:34:03 -0400411
Brian Salomonf391d0f2018-12-14 09:18:50 -0500412 /** These are used when creating a new texture internally. */
Robert Phillips0a15cc62019-07-30 12:49:10 -0400413 GrBackendFormat getDefaultBackendFormat(GrColorType, GrRenderable) const;
Greg Daniel4065d452018-11-16 15:43:41 -0500414
Brian Salomonbb8dde82019-06-27 10:52:13 -0400415 virtual GrBackendFormat getBackendFormatFromCompressionType(SkImage::CompressionType) const = 0;
416
Timothy Liang036fdfe2018-06-28 15:50:36 -0400417 /**
Michael Ludwigf23a1522018-12-10 11:36:13 -0500418 * The CLAMP_TO_BORDER wrap mode for texture coordinates was added to desktop GL in 1.3, and
419 * GLES 3.2, but is also available in extensions. Vulkan and Metal always have support.
420 */
421 bool clampToBorderSupport() const { return fClampToBorderSupport; }
422
Greg Danieleb4a8272019-05-16 16:52:55 -0400423 /**
Greg Daniel14b57212019-12-17 16:18:06 -0500424 * Returns the GrSwizzle to use when sampling or reading back from a texture with the passed in
425 * GrBackendFormat and GrColorType.
Greg Danieleb4a8272019-05-16 16:52:55 -0400426 */
Greg Daniel01f278c2020-06-12 16:58:17 -0400427 GrSwizzle getReadSwizzle(const GrBackendFormat& format, GrColorType colorType) const;
Greg Danieleb4a8272019-05-16 16:52:55 -0400428
429 /**
Brian Salomon982f5462020-03-30 12:52:33 -0400430 * Returns the GrSwizzle to use when writing colors to a surface with the passed in
Greg Danieleb4a8272019-05-16 16:52:55 -0400431 * GrBackendFormat and GrColorType.
432 */
Brian Salomon982f5462020-03-30 12:52:33 -0400433 virtual GrSwizzle getWriteSwizzle(const GrBackendFormat&, GrColorType) const = 0;
Greg Danieleb4a8272019-05-16 16:52:55 -0400434
Greg Danield51fa2f2020-01-22 16:53:38 -0500435 virtual uint64_t computeFormatKey(const GrBackendFormat&) const = 0;
436
Adrienne Walker3ed33992018-05-15 11:44:34 -0700437 const GrDriverBugWorkarounds& workarounds() const { return fDriverBugWorkarounds; }
438
Brian Salomon947efe22019-07-16 15:36:11 -0400439 /**
Robert Phillips323471e2019-11-11 11:33:37 -0500440 * Adds fields to the key to represent the sampler that will be created for the passed
441 * in parameters. Currently this extra keying is only needed when building a vulkan pipeline
442 * with immutable samplers.
443 */
444 virtual void addExtraSamplerKey(GrProcessorKeyBuilder*,
Brian Salomonccb61422020-01-09 10:46:36 -0500445 GrSamplerState,
Robert Phillips323471e2019-11-11 11:33:37 -0500446 const GrBackendFormat&) const {}
447
Greg Daniel91b37b12021-01-05 15:40:54 -0500448 enum class ProgramDescOverrideFlags {
449 kNone = 0,
450 // If using discardable msaa surfaces in vulkan, when we break up a render pass for an
451 // inline upload, we must do a load msaa subpass for the second render pass. However, if the
452 // original render pass did not have this load subpass (e.g. clear or discard load op), then
453 // all the GrProgramInfos for draws that end up in the second render pass will have been
454 // recorded thinking they will be in a render pass with only 1 subpass. Thus we add an
455 // override flag to the makeDesc call to force the actually VkPipeline that gets created to
456 // be created using a render pass with 2 subpasses. We do miss on the pre-compile with this
457 // approach, but inline uploads are very rare and already slow.
458 kVulkanHasResolveLoadSubpass = 0x1,
459 };
460 GR_DECL_BITFIELD_CLASS_OPS_FRIENDS(ProgramDescOverrideFlags);
461
462
463 virtual GrProgramDesc makeDesc(
464 GrRenderTarget*, const GrProgramInfo&,
465 ProgramDescOverrideFlags overrideFlags = ProgramDescOverrideFlags::kNone) const = 0;
Robert Phillips03e4c952019-11-26 16:20:22 -0500466
Greg Daniel638b2e82020-08-27 14:29:00 -0400467 // This method specifies, for each backend, the extra properties of a RT when Ganesh creates one
468 // internally. For example, for Vulkan, Ganesh always creates RTs that can be used as input
469 // attachments.
470 virtual GrInternalSurfaceFlags getExtraSurfaceFlagsForDeferredRT() const {
471 return GrInternalSurfaceFlags::kNone;
472 }
473
Robert Phillipsffe27292019-08-01 10:08:07 -0400474#if GR_TEST_UTILS
475 struct TestFormatColorTypeCombination {
476 GrColorType fColorType;
477 GrBackendFormat fFormat;
478 };
479
480 virtual std::vector<TestFormatColorTypeCombination> getTestingCombinations() const = 0;
481#endif
482
bsalomon@google.comc26d94f2013-03-25 18:19:00 +0000483protected:
Chris Dalton8367e112019-11-13 12:43:21 -0700484 // Subclasses must call this at the end of their init method in order to do final processing on
485 // the caps (including overrides requested by the client).
486 // NOTE: this method will only reduce the caps, never expand them.
487 void finishInitialization(const GrContextOptions& options);
bsalomon4ee6bd82015-05-27 13:23:23 -0700488
bungeman6bd52842016-10-27 09:30:08 -0700489 sk_sp<GrShaderCaps> fShaderCaps;
jvanverthe9c0fc62015-04-29 11:18:05 -0700490
joshualitt83bc2292015-06-18 14:18:02 -0700491 bool fNPOTTextureTileSupport : 1;
Brian Salomon69100f02020-07-21 10:49:25 -0400492 bool fMipmapSupport : 1;
joshualitt83bc2292015-06-18 14:18:02 -0700493 bool fReuseScratchTextures : 1;
robertphillips1b8e1b52015-06-24 06:54:10 -0700494 bool fReuseScratchBuffers : 1;
joshualitt83bc2292015-06-18 14:18:02 -0700495 bool fGpuTracingSupport : 1;
joshualitt83bc2292015-06-18 14:18:02 -0700496 bool fOversizedStencilSupport : 1;
497 bool fTextureBarrierSupport : 1;
Robert Phillips7f861922018-01-30 13:13:42 +0000498 bool fSampleLocationsSupport : 1;
csmartdalton2b5f2cb2016-06-10 14:06:32 -0700499 bool fMultisampleDisableSupport : 1;
Chris Daltona77cdee2020-04-03 14:50:43 -0600500 bool fDrawInstancedSupport : 1;
Chris Dalton03fdf6a2020-04-07 12:31:59 -0600501 bool fNativeDrawIndirectSupport : 1;
Chris Daltonbde4bb72020-07-17 14:11:04 -0600502 bool fUseClientSideIndirectBuffers : 1;
Chris Dalton6ce447a2019-06-23 18:07:38 -0600503 bool fMixedSamplesSupport : 1;
Chris Daltonce425af2019-12-16 10:39:03 -0700504 bool fConservativeRasterSupport : 1;
Chris Dalton1215cda2019-12-17 21:44:04 -0700505 bool fWireframeSupport : 1;
Chris Daltond5d8a642019-08-08 15:29:20 -0600506 bool fMSAAResolvesAutomatically : 1;
Chris Dalton27059d32018-01-23 14:06:50 -0700507 bool fUsePrimitiveRestart : 1;
csmartdalton485a1202016-07-13 10:16:32 -0700508 bool fPreferClientSideDynamicBuffers : 1;
Chris Dalton344e9032017-12-11 15:42:09 -0700509 bool fPreferFullscreenClears : 1;
Chris Dalton3d28b6a2020-04-13 11:12:28 -0600510 bool fTwoSidedStencilRefsAndMasksMustMatch : 1;
bsalomon7dea7b72015-08-19 08:26:51 -0700511 bool fMustClearUploadedBufferData : 1;
Kevin Lubick61a5f0a2019-03-28 09:47:15 -0400512 bool fShouldInitializeTextures : 1;
Greg Danielb2acf0a2018-09-12 09:17:11 -0400513 bool fSupportsAHardwareBufferImages : 1;
Brian Osman499bf1a2018-09-17 11:32:42 -0400514 bool fHalfFloatVertexAttributeSupport : 1;
Michael Ludwigf23a1522018-12-10 11:36:13 -0500515 bool fClampToBorderSupport : 1;
Michael Ludwiga21d1962019-01-11 15:26:22 -0500516 bool fPerformPartialClearsAsDraws : 1;
517 bool fPerformColorClearsAsDraws : 1;
Robert Phillips2f05a482019-11-25 09:54:43 -0500518 bool fAvoidLargeIndexBufferDraws : 1;
Michael Ludwiga21d1962019-01-11 15:26:22 -0500519 bool fPerformStencilClearsAsDraws : 1;
Brian Salomonfb28c6f2020-01-10 13:04:45 -0500520 bool fTransferFromBufferToTextureSupport : 1;
521 bool fTransferFromSurfaceToBufferSupport : 1;
Brian Salomon1047a492019-07-02 12:25:21 -0400522 bool fWritePixelsRowBytesSupport : 1;
523 bool fReadPixelsRowBytesSupport : 1;
Greg Danielf6d60d32020-01-08 13:39:16 -0500524 bool fShouldCollapseSrcOverToSrcWhenAble : 1;
Greg Daniela89b4302021-01-29 10:48:40 -0500525 bool fMustSyncGpuDuringAbandon : 1;
robertphillips1b8e1b52015-06-24 06:54:10 -0700526
bsalomon63b21962014-11-05 07:05:34 -0800527 // Driver workaround
Chris Dalton94310792021-03-12 11:10:24 -0700528 bool fDriverDisableMSAAClipAtlas : 1;
Chris Daltoneae5c162020-12-29 10:18:21 -0700529 bool fDisableTessellationPathRenderer : 1;
Eric Karl5c779752017-05-08 12:02:07 -0700530 bool fAvoidStencilBuffers : 1;
Greg Daniel4374e962018-09-28 15:09:47 -0400531 bool fAvoidWritePixelsFastPath : 1;
Chris Daltone1196c52019-12-28 14:31:09 -0700532 bool fRequiresManualFBBarrierAfterTessellatedStencilDraw : 1;
Chris Dalton03fdf6a2020-04-07 12:31:59 -0600533 bool fNativeDrawIndexedIndirectIsBroken : 1;
bsalomon63b21962014-11-05 07:05:34 -0800534
Brian Salomon01b476a2018-01-23 11:06:41 -0500535 // ANGLE performance workaround
robertphillips63926682015-08-20 09:39:02 -0700536 bool fPreferVRAMUseOverFlushes : 1;
537
jvanverth84741b32016-09-30 08:39:02 -0700538 bool fFenceSyncSupport : 1;
Brian Salomon9ff5acb2019-05-08 09:04:47 -0400539 bool fSemaphoreSupport : 1;
ethannicholas28ef4452016-03-25 09:26:03 -0700540
Brian Salomonf7232642018-09-19 08:58:08 -0400541 // Requires fence sync support in GL.
Brian Osman2c2bc112017-02-28 10:02:49 -0500542 bool fCrossContextTextureSupport : 1;
543
Brian Salomonf7232642018-09-19 08:58:08 -0400544 // Not (yet) implemented in VK backend.
545 bool fDynamicStateArrayGeometryProcessorTextureSupport : 1;
546
cdalton8917d622015-05-06 13:40:21 -0700547 BlendEquationSupport fBlendEquationSupport;
Jim Van Verth1bef9792020-07-09 08:09:13 -0400548 uint32_t fAdvBlendEqDisableFlags;
Brian Salomon4dea72a2019-12-18 10:43:10 -0500549 static_assert(kLast_GrBlendEquation < 32);
cdalton1dd05422015-06-12 09:01:18 -0700550
commit-bot@chromium.org160b4782014-05-05 12:32:37 +0000551 uint32_t fMapBufferFlags;
cdalton397536c2016-03-25 12:15:03 -0700552 int fBufferMapThreshold;
commit-bot@chromium.org160b4782014-05-05 12:32:37 +0000553
bsalomon@google.comc26d94f2013-03-25 18:19:00 +0000554 int fMaxRenderTargetSize;
Chris Dalton2612bae2018-02-22 13:41:37 -0700555 int fMaxPreferredRenderTargetSize;
bsalomon7dbd45d2016-03-23 10:40:53 -0700556 int fMaxVertexAttributes;
bsalomon@google.comc26d94f2013-03-25 18:19:00 +0000557 int fMaxTextureSize;
csmartdalton9bc11872016-08-09 12:42:47 -0700558 int fMaxWindowRectangles;
Chris Daltona1638a52019-06-24 11:54:24 -0600559 int fInternalMultisampleCount;
Jim Van Verth023f2e72020-10-09 15:38:58 -0400560 uint32_t fMaxPushConstantsSize = 0;
bsalomon@google.comc26d94f2013-03-25 18:19:00 +0000561
Adrienne Walker68314842018-05-14 14:02:53 -0700562 GrDriverBugWorkarounds fDriverBugWorkarounds;
563
egdanielbc127a32014-09-19 12:07:43 -0700564private:
Chris Dalton8367e112019-11-13 12:43:21 -0700565 void applyOptionsOverrides(const GrContextOptions& options);
566
Mike Kleinfc6c37b2016-09-27 09:34:10 -0400567 virtual void onApplyOptionsOverrides(const GrContextOptions&) {}
Brian Osman71a18892017-08-10 10:23:25 -0400568 virtual void onDumpJSON(SkJSONWriter*) const {}
Brian Salomonc67c31c2018-12-06 10:00:03 -0500569 virtual bool onSurfaceSupportsWritePixels(const GrSurface*) const = 0;
570 virtual bool onCanCopySurface(const GrSurfaceProxy* dst, const GrSurfaceProxy* src,
571 const SkIRect& srcRect, const SkIPoint& dstPoint) const = 0;
Brian Salomon469046c2020-03-30 14:21:04 -0400572 virtual GrBackendFormat onGetDefaultBackendFormat(GrColorType) const = 0;
egdanielb7e7d572015-11-04 04:23:53 -0800573
Greg Daniel2a303902018-02-20 10:25:54 -0500574 // Backends should implement this if they have any extra requirements for use of window
575 // rectangles for a specific GrBackendRenderTarget outside of basic support.
576 virtual bool onIsWindowRectanglesSupportedForRT(const GrBackendRenderTarget&) const {
577 return true;
578 }
579
Greg Daniel627d0532019-07-08 16:48:14 -0400580 virtual bool onAreColorTypeAndFormatCompatible(GrColorType, const GrBackendFormat&) const = 0;
581
Greg Danielba88ab62019-07-26 09:14:01 -0400582 virtual SupportedRead onSupportedReadPixelsColorType(GrColorType srcColorType,
583 const GrBackendFormat& srcFormat,
584 GrColorType dstColorType) const = 0;
585
Greg Daniel01f278c2020-06-12 16:58:17 -0400586 virtual GrSwizzle onGetReadSwizzle(const GrBackendFormat&, GrColorType) const = 0;
587
Greg Danield358cbe2020-09-11 09:33:54 -0400588 virtual GrDstSampleType onGetDstSampleTypeForProxy(const GrRenderTargetProxy*) const {
589 return GrDstSampleType::kAsTextureCopy;
590 }
Greg Daniel01f278c2020-06-12 16:58:17 -0400591
robertphillipscaef3452015-11-11 13:18:11 -0800592 bool fSuppressPrints : 1;
Jim Van Verthfbdc0802017-05-02 16:15:53 -0400593 bool fWireframeMode : 1;
bsalomon682c2692015-05-22 14:01:46 -0700594
John Stiles7571f9e2020-09-02 22:42:33 -0400595 using INHERITED = SkRefCnt;
bsalomon@google.comc26d94f2013-03-25 18:19:00 +0000596};
597
Greg Daniel91b37b12021-01-05 15:40:54 -0500598GR_MAKE_BITFIELD_CLASS_OPS(GrCaps::ProgramDescOverrideFlags);
599
bsalomon@google.comc26d94f2013-03-25 18:19:00 +0000600#endif