blob: 230a8f7b436964d586bedd594815c5a430cc2f33 [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
Chris Dalton0dffbab2019-03-27 13:08:50 -0600108 bool preferTrianglesOverSampleMask() const { return fPreferTrianglesOverSampleMask; }
109
Eric Karl5c779752017-05-08 12:02:07 -0700110 bool avoidStencilBuffers() const { return fAvoidStencilBuffers; }
111
Greg Daniel4374e962018-09-28 15:09:47 -0400112 bool avoidWritePixelsFastPath() const { return fAvoidWritePixelsFastPath; }
113
Chris Daltone1196c52019-12-28 14:31:09 -0700114 // http://skbug.com/9739
115 bool requiresManualFBBarrierAfterTessellatedStencilDraw() const {
116 return fRequiresManualFBBarrierAfterTessellatedStencilDraw;
117 }
118
Chris Dalton03fdf6a2020-04-07 12:31:59 -0600119 // glDrawElementsIndirect fails GrMeshTest on every Win10 Intel bot.
120 bool nativeDrawIndexedIndirectIsBroken() const { return fNativeDrawIndexedIndirectIsBroken; }
121
csmartdaltone0d36292016-07-29 08:14:20 -0700122 /**
cdalton8917d622015-05-06 13:40:21 -0700123 * Indicates the capabilities of the fixed function blend unit.
124 */
125 enum BlendEquationSupport {
126 kBasic_BlendEquationSupport, //<! Support to select the operator that
127 // combines src and dst terms.
128 kAdvanced_BlendEquationSupport, //<! Additional fixed function support for specific
129 // SVG/PDF blend modes. Requires blend barriers.
130 kAdvancedCoherent_BlendEquationSupport, //<! Advanced blend equation support that does not
131 // require blend barriers, and permits overlap.
132
133 kLast_BlendEquationSupport = kAdvancedCoherent_BlendEquationSupport
134 };
135
136 BlendEquationSupport blendEquationSupport() const { return fBlendEquationSupport; }
137
138 bool advancedBlendEquationSupport() const {
139 return fBlendEquationSupport >= kAdvanced_BlendEquationSupport;
140 }
141
142 bool advancedCoherentBlendEquationSupport() const {
143 return kAdvancedCoherent_BlendEquationSupport == fBlendEquationSupport;
144 }
145
Jim Van Verth1bef9792020-07-09 08:09:13 -0400146 bool isAdvancedBlendEquationDisabled(GrBlendEquation equation) const {
cdalton1dd05422015-06-12 09:01:18 -0700147 SkASSERT(GrBlendEquationIsAdvanced(equation));
Chris Dalton302d5be2019-01-22 23:41:25 -0700148 SkASSERT(this->advancedBlendEquationSupport());
Jim Van Verth1bef9792020-07-09 08:09:13 -0400149 return SkToBool(fAdvBlendEqDisableFlags & (1 << equation));
cdalton1dd05422015-06-12 09:01:18 -0700150 }
151
Greg Danielf6d60d32020-01-08 13:39:16 -0500152 // On some GPUs it is a performance win to disable blending instead of doing src-over with a src
153 // alpha equal to 1. To disable blending we collapse src-over to src and the backends will
154 // handle the disabling of blending.
155 bool shouldCollapseSrcOverToSrcWhenAble() const {
156 return fShouldCollapseSrcOverToSrcWhenAble;
157 }
158
cdalton8917d622015-05-06 13:40:21 -0700159 /**
commit-bot@chromium.org160b4782014-05-05 12:32:37 +0000160 * Indicates whether GPU->CPU memory mapping for GPU resources such as vertex buffers and
161 * textures allows partial mappings or full mappings.
162 */
163 enum MapFlags {
Brian Salomon105d7c22019-04-16 13:46:14 -0400164 kNone_MapFlags = 0x0, //<! Cannot map the resource.
commit-bot@chromium.org160b4782014-05-05 12:32:37 +0000165
Brian Salomon105d7c22019-04-16 13:46:14 -0400166 kCanMap_MapFlag = 0x1, //<! The resource can be mapped. Must be set for any of
167 // the other flags to have meaning.
168 kSubset_MapFlag = 0x2, //<! The resource can be partially mapped.
Greg Daniel2d41d0d2019-08-26 11:08:51 -0400169 kAsyncRead_MapFlag = 0x4, //<! Are maps for reading asynchronous WRT GrOpsRenderPass
Brian Salomon105d7c22019-04-16 13:46:14 -0400170 // submitted to GrGpu.
commit-bot@chromium.org160b4782014-05-05 12:32:37 +0000171 };
172
173 uint32_t mapBufferFlags() const { return fMapBufferFlags; }
174
robertphillips@google.com2d2e5c42013-10-30 21:30:43 +0000175 // Scratch textures not being reused means that those scratch textures
skia.committer@gmail.com7ed98df2013-10-31 07:01:53 +0000176 // that we upload to (i.e., don't have a render target) will not be
robertphillips@google.com2d2e5c42013-10-30 21:30:43 +0000177 // recycled in the texture cache. This is to prevent ghosting by drivers
178 // (in particular for deferred architectures).
commit-bot@chromium.orgb8356522013-07-18 22:26:39 +0000179 bool reuseScratchTextures() const { return fReuseScratchTextures; }
robertphillips1b8e1b52015-06-24 06:54:10 -0700180 bool reuseScratchBuffers() const { return fReuseScratchBuffers; }
bsalomon@google.comc26d94f2013-03-25 18:19:00 +0000181
bsalomon7dbd45d2016-03-23 10:40:53 -0700182 /// maximum number of attribute values per vertex
183 int maxVertexAttributes() const { return fMaxVertexAttributes; }
184
bsalomon@google.comc26d94f2013-03-25 18:19:00 +0000185 int maxRenderTargetSize() const { return fMaxRenderTargetSize; }
Chris Dalton2612bae2018-02-22 13:41:37 -0700186
187 /** This is the largest render target size that can be used without incurring extra perfomance
188 cost. It is usually the max RT size, unless larger render targets are known to be slower. */
189 int maxPreferredRenderTargetSize() const { return fMaxPreferredRenderTargetSize; }
190
bsalomon@google.comc26d94f2013-03-25 18:19:00 +0000191 int maxTextureSize() const { return fMaxTextureSize; }
Chris Dalton2612bae2018-02-22 13:41:37 -0700192
bsalomon8c07b7a2015-11-02 11:36:52 -0800193 /** This is the maximum tile size to use by GPU devices for rendering sw-backed images/bitmaps.
194 It is usually the max texture size, unless we're overriding it for testing. */
Brian Salomonc7fe0f72018-05-11 10:14:21 -0400195 int maxTileSize() const {
196 SkASSERT(fMaxTileSize <= fMaxTextureSize);
197 return fMaxTileSize;
198 }
bsalomonc59a1df2015-06-01 07:13:42 -0700199
csmartdalton9bc11872016-08-09 12:42:47 -0700200 int maxWindowRectangles() const { return fMaxWindowRectangles; }
bsalomon@google.comc26d94f2013-03-25 18:19:00 +0000201
Greg Daniel2a303902018-02-20 10:25:54 -0500202 // Returns whether mixed samples is supported for the given backend render target.
203 bool isWindowRectanglesSupportedForRT(const GrBackendRenderTarget& rt) const {
204 return this->maxWindowRectangles() > 0 && this->onIsWindowRectanglesSupportedForRT(rt);
205 }
206
Robert Phillipsf209e882019-06-25 15:59:50 -0400207 virtual bool isFormatSRGB(const GrBackendFormat&) const = 0;
Greg Daniela00bcad2019-10-11 13:21:48 -0400208
Greg Daniel01f278c2020-06-12 16:58:17 -0400209 bool isFormatCompressed(const GrBackendFormat& format) const;
Robert Phillipsf209e882019-06-25 15:59:50 -0400210
Greg Daniel7bfc9132019-08-14 14:23:53 -0400211 // Can a texture be made with the GrBackendFormat, and then be bound and sampled in a shader.
212 virtual bool isFormatTexturable(const GrBackendFormat&) const = 0;
Brian Salomonbdecacf2018-02-02 20:32:49 -0500213
Greg Daniel6980c4e2019-07-30 16:18:18 -0400214 // Returns whether a texture of the given format can be copied to a texture of the same format.
215 virtual bool isFormatCopyable(const GrBackendFormat&) const = 0;
Brian Salomonbdecacf2018-02-02 20:32:49 -0500216
Greg Danieleadfac92019-08-02 09:03:53 -0400217 // Returns the maximum supported sample count for a format. 0 means the format is not renderable
Brian Salomon469046c2020-03-30 14:21:04 -0400218 // 1 means the format is renderable but doesn't support MSAA.
Greg Danieleadfac92019-08-02 09:03:53 -0400219 virtual int maxRenderTargetSampleCount(const GrBackendFormat&) const = 0;
Brian Salomonbdecacf2018-02-02 20:32:49 -0500220
Chris Dalton1e6c5b82019-06-17 14:16:49 -0600221 // Returns the number of samples to use when performing internal draws to the given config with
Chris Daltona1638a52019-06-24 11:54:24 -0600222 // MSAA or mixed samples. If 0, Ganesh should not attempt to use internal multisampling.
Greg Danieleadfac92019-08-02 09:03:53 -0400223 int internalMultisampleCount(const GrBackendFormat& format) const {
Brian Osman788b9162020-02-07 10:36:46 -0500224 return std::min(fInternalMultisampleCount, this->maxRenderTargetSampleCount(format));
Chris Dalton1e6c5b82019-06-17 14:16:49 -0600225 }
226
Greg Daniel900583a2019-08-06 12:05:31 -0400227 virtual bool isFormatAsColorTypeRenderable(GrColorType ct, const GrBackendFormat& format,
228 int sampleCount = 1) const = 0;
229
230 virtual bool isFormatRenderable(const GrBackendFormat& format, int sampleCount) const = 0;
Brian Salomonbdecacf2018-02-02 20:32:49 -0500231
232 // Find a sample count greater than or equal to the requested count which is supported for a
Greg Daniel6fa62e22019-08-07 15:52:37 -0400233 // 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 -0500234 // sample count is 1 then 1 will be returned if non-MSAA rendering is supported, otherwise 0.
235 // For historical reasons requestedCount==0 is handled identically to requestedCount==1.
Greg Daniel6fa62e22019-08-07 15:52:37 -0400236 virtual int getRenderTargetSampleCount(int requestedCount, const GrBackendFormat&) const = 0;
commit-bot@chromium.org42dc8132014-05-27 19:26:59 +0000237
Brian Salomon5f33a8c2018-02-26 14:32:39 -0500238 /**
Brian Salomon3d86a192018-02-27 16:46:11 -0500239 * Backends may have restrictions on what types of surfaces support GrGpu::writePixels().
240 * If this returns false then the caller should implement a fallback where a temporary texture
241 * 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 -0500242 */
Brian Salomonc67c31c2018-12-06 10:00:03 -0500243 bool surfaceSupportsWritePixels(const GrSurface*) const;
Brian Salomon19eaf2d2018-03-19 16:06:44 -0400244
Emircan Uysaler23ca4e72019-06-24 10:53:09 -0400245 /**
Brian Salomondc0710f2019-07-01 14:59:32 -0400246 * Indicates whether surface supports GrGpu::readPixels, must be copied, or cannot be read.
Emircan Uysaler23ca4e72019-06-24 10:53:09 -0400247 */
Brian Salomondc0710f2019-07-01 14:59:32 -0400248 enum class SurfaceReadPixelsSupport {
249 /** GrGpu::readPixels is supported by the surface. */
250 kSupported,
251 /**
252 * GrGpu::readPixels is not supported by this surface but this surface can be drawn
253 * or copied to a Ganesh-created GrTextureType::kTexture2D and then that surface will be
254 * readable.
255 */
256 kCopyToTexture2D,
257 /**
258 * Not supported
259 */
260 kUnsupported,
Emircan Uysaler23ca4e72019-06-24 10:53:09 -0400261 };
Brian Salomon19eaf2d2018-03-19 16:06:44 -0400262 /**
Brian Salomondc0710f2019-07-01 14:59:32 -0400263 * Backends may have restrictions on what types of surfaces support GrGpu::readPixels(). We may
264 * either be able to read directly from the surface, read from a copy of the surface, or not
265 * read at all.
Brian Salomon19eaf2d2018-03-19 16:06:44 -0400266 */
Brian Salomondc0710f2019-07-01 14:59:32 -0400267 virtual SurfaceReadPixelsSupport surfaceSupportsReadPixels(const GrSurface*) const = 0;
Brian Salomon5f33a8c2018-02-26 14:32:39 -0500268
Brian Salomon42be09d2019-07-26 12:12:26 -0400269 struct SupportedWrite {
270 GrColorType fColorType;
271 // If the write is occurring using GrGpu::transferPixelsTo then this provides the
272 // minimum alignment of the offset into the transfer buffer.
273 size_t fOffsetAlignmentForTransferBuffer;
274 };
275
Brian Salomon5f33a8c2018-02-26 14:32:39 -0500276 /**
277 * Given a dst pixel config and a src color type what color type must the caller coax the
278 * the data into in order to use GrGpu::writePixels().
279 */
Brian Salomon01915c02019-08-02 09:57:21 -0400280 virtual SupportedWrite supportedWritePixelsColorType(GrColorType surfaceColorType,
281 const GrBackendFormat& surfaceFormat,
Brian Salomon42be09d2019-07-26 12:12:26 -0400282 GrColorType srcColorType) const = 0;
Brian Salomon5f33a8c2018-02-26 14:32:39 -0500283
Brian Salomonf30b1c12019-06-20 12:25:02 -0400284 struct SupportedRead {
Brian Salomonf30b1c12019-06-20 12:25:02 -0400285 GrColorType fColorType;
Brian Salomon42be09d2019-07-26 12:12:26 -0400286 // If the read is occurring using GrGpu::transferPixelsFrom then this provides the
287 // minimum alignment of the offset into the transfer buffer.
Greg Danielba88ab62019-07-26 09:14:01 -0400288 size_t fOffsetAlignmentForTransferBuffer;
Brian Salomonf30b1c12019-06-20 12:25:02 -0400289 };
290
Brian Salomon19eaf2d2018-03-19 16:06:44 -0400291 /**
Greg Daniel00fb7242019-07-18 14:28:01 -0400292 * 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 -0400293 * would like read into, this provides a legal color type that the caller may pass to
294 * GrGpu::readPixels(). The returned color type may differ from the passed dstColorType, in
295 * which case the caller must convert the read pixel data (see GrConvertPixels). When converting
296 * to dstColorType the swizzle in the returned struct should be applied. The caller must check
297 * the returned color type for kUnknown.
Brian Salomon19eaf2d2018-03-19 16:06:44 -0400298 */
Greg Danielba88ab62019-07-26 09:14:01 -0400299 SupportedRead supportedReadPixelsColorType(GrColorType srcColorType,
300 const GrBackendFormat& srcFormat,
301 GrColorType dstColorType) const;
Brian Salomon19eaf2d2018-03-19 16:06:44 -0400302
Brian Salomon1047a492019-07-02 12:25:21 -0400303 /**
304 * Do GrGpu::writePixels() and GrGpu::transferPixelsTo() support a src buffer where the row
305 * bytes is not equal to bpp * w?
306 */
307 bool writePixelsRowBytesSupport() const { return fWritePixelsRowBytesSupport; }
308 /**
309 * Does GrGpu::readPixels() support a dst buffer where the row bytes is not equal to bpp * w?
310 */
311 bool readPixelsRowBytesSupport() const { return fReadPixelsRowBytesSupport; }
312
Brian Salomonfb28c6f2020-01-10 13:04:45 -0500313 bool transferFromSurfaceToBufferSupport() const { return fTransferFromSurfaceToBufferSupport; }
314 bool transferFromBufferToTextureSupport() const { return fTransferFromBufferToTextureSupport; }
Brian Salomone05ba5a2019-04-08 11:59:07 -0400315
robertphillipscaef3452015-11-11 13:18:11 -0800316 bool suppressPrints() const { return fSuppressPrints; }
317
cdalton397536c2016-03-25 12:15:03 -0700318 size_t bufferMapThreshold() const {
319 SkASSERT(fBufferMapThreshold >= 0);
320 return fBufferMapThreshold;
joshualitt7224c862015-05-29 06:46:47 -0700321 }
bsalomon682c2692015-05-22 14:01:46 -0700322
Mike Kleinfc6c37b2016-09-27 09:34:10 -0400323 /** True in environments that will issue errors if memory uploaded to buffers
bsalomon7dea7b72015-08-19 08:26:51 -0700324 is not initialized (even if not read by draw calls). */
325 bool mustClearUploadedBufferData() const { return fMustClearUploadedBufferData; }
326
Kevin Lubick61a5f0a2019-03-28 09:47:15 -0400327 /** For some environments, there is a performance or safety concern to not
328 initializing textures. For example, with WebGL and Firefox, there is a large
329 performance hit to not doing it.
330 */
331 bool shouldInitializeTextures() const { return fShouldInitializeTextures; }
332
Greg Danielb2acf0a2018-09-12 09:17:11 -0400333 /** Returns true if the given backend supports importing AHardwareBuffers via the
334 * GrAHardwarebufferImageGenerator. This will only ever be supported on Android devices with API
335 * level >= 26.
336 * */
337 bool supportsAHardwareBufferImages() const { return fSupportsAHardwareBufferImages; }
338
Jim Van Verthfbdc0802017-05-02 16:15:53 -0400339 bool wireframeMode() const { return fWireframeMode; }
340
Brian Salomon9ff5acb2019-05-08 09:04:47 -0400341 /** Supports using GrFence. */
jvanverth84741b32016-09-30 08:39:02 -0700342 bool fenceSyncSupport() const { return fFenceSyncSupport; }
Brian Salomon9ff5acb2019-05-08 09:04:47 -0400343
344 /** Supports using GrSemaphore. */
345 bool semaphoreSupport() const { return fSemaphoreSupport; }
346
Brian Osman2c2bc112017-02-28 10:02:49 -0500347 bool crossContextTextureSupport() const { return fCrossContextTextureSupport; }
Brian Salomon467921e2017-03-06 16:17:12 -0500348 /**
Greg Daniel25af6712018-04-25 10:44:38 -0400349 * Returns whether or not we will be able to do a copy given the passed in params
350 */
Brian Salomonc67c31c2018-12-06 10:00:03 -0500351 bool canCopySurface(const GrSurfaceProxy* dst, const GrSurfaceProxy* src,
352 const SkIRect& srcRect, const SkIPoint& dstPoint) const;
Greg Daniel25af6712018-04-25 10:44:38 -0400353
Brian Salomonf7232642018-09-19 08:58:08 -0400354 bool dynamicStateArrayGeometryProcessorTextureSupport() const {
355 return fDynamicStateArrayGeometryProcessorTextureSupport;
356 }
357
Michael Ludwigc39d0c82019-01-15 10:03:43 -0500358 // Not all backends support clearing with a scissor test (e.g. Metal), this will always
359 // return true if performColorClearsAsDraws() returns true.
Michael Ludwiga21d1962019-01-11 15:26:22 -0500360 bool performPartialClearsAsDraws() const {
Michael Ludwigc39d0c82019-01-15 10:03:43 -0500361 return fPerformColorClearsAsDraws || fPerformPartialClearsAsDraws;
Michael Ludwiga21d1962019-01-11 15:26:22 -0500362 }
363
364 // Many drivers have issues with color clears.
Chris Daltona8fbeba2019-03-30 00:31:23 -0600365 bool performColorClearsAsDraws() const { return fPerformColorClearsAsDraws; }
Michael Ludwiga21d1962019-01-11 15:26:22 -0500366
Robert Phillips2f05a482019-11-25 09:54:43 -0500367 bool avoidLargeIndexBufferDraws() const { return fAvoidLargeIndexBufferDraws; }
368
Michael Ludwiga21d1962019-01-11 15:26:22 -0500369 /// Adreno 4xx devices experience an issue when there are a large number of stencil clip bit
370 /// clears. The minimal repro steps are not precisely known but drawing a rect with a stencil
371 /// op instead of using glClear seems to resolve the issue.
Chris Daltona8fbeba2019-03-30 00:31:23 -0600372 bool performStencilClearsAsDraws() const { return fPerformStencilClearsAsDraws; }
373
374 // Can we use coverage counting shortcuts to render paths? Coverage counting can cause artifacts
375 // along shared edges if care isn't taken to ensure both contours wind in the same direction.
376 bool allowCoverageCounting() const { return fAllowCoverageCounting; }
377
378 // Should we disable the CCPR code due to a faulty driver?
Jim Van Verth1bef9792020-07-09 08:09:13 -0400379 bool driverDisableCCPR() const { return fDriverDisableCCPR; }
380 bool driverDisableMSAACCPR() const { return fDriverDisableMSAACCPR; }
Ethan Nicholas56d19a52018-10-15 11:26:20 -0400381
Greg Danield358cbe2020-09-11 09:33:54 -0400382 // Returns how to sample the dst values for the passed in GrRenderTargetProxy.
383 GrDstSampleType getDstSampleTypeForProxy(const GrRenderTargetProxy*) const;
384
Greg Daniel25af6712018-04-25 10:44:38 -0400385 /**
Brian Salomon1e03b6b12019-07-17 17:28:24 -0400386 * This is used to try to ensure a successful copy a dst in order to perform shader-based
387 * blending.
388 *
389 * fRectsMustMatch will be set to true if the copy operation must ensure that the src and dest
390 * rects are identical.
391 *
392 * fMustCopyWholeSrc will be set to true if copy rect must equal src's bounds.
393 *
394 * Caller will detect cases when copy cannot succeed and try copy-as-draw as a fallback.
Brian Salomon467921e2017-03-06 16:17:12 -0500395 */
Brian Salomon1e03b6b12019-07-17 17:28:24 -0400396 struct DstCopyRestrictions {
397 GrSurfaceProxy::RectsMustMatch fRectsMustMatch = GrSurfaceProxy::RectsMustMatch::kNo;
398 bool fMustCopyWholeSrc = false;
399 };
Greg Daniel0258c902019-08-01 13:08:33 -0400400 virtual DstCopyRestrictions getDstCopyRestrictions(const GrRenderTargetProxy* src,
401 GrColorType ct) const {
Brian Salomon1e03b6b12019-07-17 17:28:24 -0400402 return {};
403 }
Brian Salomon467921e2017-03-06 16:17:12 -0500404
Greg Daniel9a48beb2020-01-16 16:57:16 -0500405 bool validateSurfaceParams(const SkISize&, const GrBackendFormat&, GrRenderable renderable,
Brian Salomon7e67dca2020-07-21 09:27:25 -0400406 int renderTargetSampleCnt, GrMipmapped) const;
Brian Salomonbdecacf2018-02-02 20:32:49 -0500407
Greg Daniel01f278c2020-06-12 16:58:17 -0400408 bool areColorTypeAndFormatCompatible(GrColorType grCT, const GrBackendFormat& format) const;
Robert Phillipsc046ff02019-07-01 10:34:03 -0400409
Brian Salomonf391d0f2018-12-14 09:18:50 -0500410 /** These are used when creating a new texture internally. */
Robert Phillips0a15cc62019-07-30 12:49:10 -0400411 GrBackendFormat getDefaultBackendFormat(GrColorType, GrRenderable) const;
Greg Daniel4065d452018-11-16 15:43:41 -0500412
Brian Salomonbb8dde82019-06-27 10:52:13 -0400413 virtual GrBackendFormat getBackendFormatFromCompressionType(SkImage::CompressionType) const = 0;
414
Timothy Liang036fdfe2018-06-28 15:50:36 -0400415 /**
Michael Ludwigf23a1522018-12-10 11:36:13 -0500416 * The CLAMP_TO_BORDER wrap mode for texture coordinates was added to desktop GL in 1.3, and
417 * GLES 3.2, but is also available in extensions. Vulkan and Metal always have support.
418 */
419 bool clampToBorderSupport() const { return fClampToBorderSupport; }
420
Greg Danieleb4a8272019-05-16 16:52:55 -0400421 /**
Greg Daniel14b57212019-12-17 16:18:06 -0500422 * Returns the GrSwizzle to use when sampling or reading back from a texture with the passed in
423 * GrBackendFormat and GrColorType.
Greg Danieleb4a8272019-05-16 16:52:55 -0400424 */
Greg Daniel01f278c2020-06-12 16:58:17 -0400425 GrSwizzle getReadSwizzle(const GrBackendFormat& format, GrColorType colorType) const;
Greg Danieleb4a8272019-05-16 16:52:55 -0400426
427 /**
Brian Salomon982f5462020-03-30 12:52:33 -0400428 * Returns the GrSwizzle to use when writing colors to a surface with the passed in
Greg Danieleb4a8272019-05-16 16:52:55 -0400429 * GrBackendFormat and GrColorType.
430 */
Brian Salomon982f5462020-03-30 12:52:33 -0400431 virtual GrSwizzle getWriteSwizzle(const GrBackendFormat&, GrColorType) const = 0;
Greg Danieleb4a8272019-05-16 16:52:55 -0400432
Greg Danield51fa2f2020-01-22 16:53:38 -0500433 virtual uint64_t computeFormatKey(const GrBackendFormat&) const = 0;
434
Adrienne Walker3ed33992018-05-15 11:44:34 -0700435 const GrDriverBugWorkarounds& workarounds() const { return fDriverBugWorkarounds; }
436
Brian Salomon947efe22019-07-16 15:36:11 -0400437 /**
Robert Phillips323471e2019-11-11 11:33:37 -0500438 * Adds fields to the key to represent the sampler that will be created for the passed
439 * in parameters. Currently this extra keying is only needed when building a vulkan pipeline
440 * with immutable samplers.
441 */
442 virtual void addExtraSamplerKey(GrProcessorKeyBuilder*,
Brian Salomonccb61422020-01-09 10:46:36 -0500443 GrSamplerState,
Robert Phillips323471e2019-11-11 11:33:37 -0500444 const GrBackendFormat&) const {}
445
Brian Salomonf7f54332020-07-28 09:23:35 -0400446 virtual GrProgramDesc makeDesc(GrRenderTarget*, const GrProgramInfo&) const = 0;
Robert Phillips03e4c952019-11-26 16:20:22 -0500447
Greg Daniel638b2e82020-08-27 14:29:00 -0400448 // This method specifies, for each backend, the extra properties of a RT when Ganesh creates one
449 // internally. For example, for Vulkan, Ganesh always creates RTs that can be used as input
450 // attachments.
451 virtual GrInternalSurfaceFlags getExtraSurfaceFlagsForDeferredRT() const {
452 return GrInternalSurfaceFlags::kNone;
453 }
454
Robert Phillipsffe27292019-08-01 10:08:07 -0400455#if GR_TEST_UTILS
456 struct TestFormatColorTypeCombination {
457 GrColorType fColorType;
458 GrBackendFormat fFormat;
459 };
460
461 virtual std::vector<TestFormatColorTypeCombination> getTestingCombinations() const = 0;
462#endif
463
bsalomon@google.comc26d94f2013-03-25 18:19:00 +0000464protected:
Chris Dalton8367e112019-11-13 12:43:21 -0700465 // Subclasses must call this at the end of their init method in order to do final processing on
466 // the caps (including overrides requested by the client).
467 // NOTE: this method will only reduce the caps, never expand them.
468 void finishInitialization(const GrContextOptions& options);
bsalomon4ee6bd82015-05-27 13:23:23 -0700469
bungeman6bd52842016-10-27 09:30:08 -0700470 sk_sp<GrShaderCaps> fShaderCaps;
jvanverthe9c0fc62015-04-29 11:18:05 -0700471
joshualitt83bc2292015-06-18 14:18:02 -0700472 bool fNPOTTextureTileSupport : 1;
Brian Salomon69100f02020-07-21 10:49:25 -0400473 bool fMipmapSupport : 1;
joshualitt83bc2292015-06-18 14:18:02 -0700474 bool fReuseScratchTextures : 1;
robertphillips1b8e1b52015-06-24 06:54:10 -0700475 bool fReuseScratchBuffers : 1;
joshualitt83bc2292015-06-18 14:18:02 -0700476 bool fGpuTracingSupport : 1;
joshualitt83bc2292015-06-18 14:18:02 -0700477 bool fOversizedStencilSupport : 1;
478 bool fTextureBarrierSupport : 1;
Robert Phillips7f861922018-01-30 13:13:42 +0000479 bool fSampleLocationsSupport : 1;
csmartdalton2b5f2cb2016-06-10 14:06:32 -0700480 bool fMultisampleDisableSupport : 1;
Chris Daltona77cdee2020-04-03 14:50:43 -0600481 bool fDrawInstancedSupport : 1;
Chris Dalton03fdf6a2020-04-07 12:31:59 -0600482 bool fNativeDrawIndirectSupport : 1;
Chris Daltonbde4bb72020-07-17 14:11:04 -0600483 bool fUseClientSideIndirectBuffers : 1;
Chris Dalton6ce447a2019-06-23 18:07:38 -0600484 bool fMixedSamplesSupport : 1;
Chris Daltonce425af2019-12-16 10:39:03 -0700485 bool fConservativeRasterSupport : 1;
Chris Dalton1215cda2019-12-17 21:44:04 -0700486 bool fWireframeSupport : 1;
Chris Daltond5d8a642019-08-08 15:29:20 -0600487 bool fMSAAResolvesAutomatically : 1;
Chris Dalton27059d32018-01-23 14:06:50 -0700488 bool fUsePrimitiveRestart : 1;
csmartdalton485a1202016-07-13 10:16:32 -0700489 bool fPreferClientSideDynamicBuffers : 1;
Chris Dalton344e9032017-12-11 15:42:09 -0700490 bool fPreferFullscreenClears : 1;
Chris Dalton3d28b6a2020-04-13 11:12:28 -0600491 bool fTwoSidedStencilRefsAndMasksMustMatch : 1;
bsalomon7dea7b72015-08-19 08:26:51 -0700492 bool fMustClearUploadedBufferData : 1;
Kevin Lubick61a5f0a2019-03-28 09:47:15 -0400493 bool fShouldInitializeTextures : 1;
Greg Danielb2acf0a2018-09-12 09:17:11 -0400494 bool fSupportsAHardwareBufferImages : 1;
Brian Osman499bf1a2018-09-17 11:32:42 -0400495 bool fHalfFloatVertexAttributeSupport : 1;
Michael Ludwigf23a1522018-12-10 11:36:13 -0500496 bool fClampToBorderSupport : 1;
Michael Ludwiga21d1962019-01-11 15:26:22 -0500497 bool fPerformPartialClearsAsDraws : 1;
498 bool fPerformColorClearsAsDraws : 1;
Robert Phillips2f05a482019-11-25 09:54:43 -0500499 bool fAvoidLargeIndexBufferDraws : 1;
Michael Ludwiga21d1962019-01-11 15:26:22 -0500500 bool fPerformStencilClearsAsDraws : 1;
Chris Daltona8fbeba2019-03-30 00:31:23 -0600501 bool fAllowCoverageCounting : 1;
Brian Salomonfb28c6f2020-01-10 13:04:45 -0500502 bool fTransferFromBufferToTextureSupport : 1;
503 bool fTransferFromSurfaceToBufferSupport : 1;
Brian Salomon1047a492019-07-02 12:25:21 -0400504 bool fWritePixelsRowBytesSupport : 1;
505 bool fReadPixelsRowBytesSupport : 1;
Greg Danielf6d60d32020-01-08 13:39:16 -0500506 bool fShouldCollapseSrcOverToSrcWhenAble : 1;
robertphillips1b8e1b52015-06-24 06:54:10 -0700507
bsalomon63b21962014-11-05 07:05:34 -0800508 // Driver workaround
Jim Van Verth1bef9792020-07-09 08:09:13 -0400509 bool fDriverDisableCCPR : 1;
510 bool fDriverDisableMSAACCPR : 1;
Eric Karl5c779752017-05-08 12:02:07 -0700511 bool fAvoidStencilBuffers : 1;
Greg Daniel4374e962018-09-28 15:09:47 -0400512 bool fAvoidWritePixelsFastPath : 1;
Chris Daltone1196c52019-12-28 14:31:09 -0700513 bool fRequiresManualFBBarrierAfterTessellatedStencilDraw : 1;
Chris Dalton03fdf6a2020-04-07 12:31:59 -0600514 bool fNativeDrawIndexedIndirectIsBroken : 1;
bsalomon63b21962014-11-05 07:05:34 -0800515
Brian Salomon01b476a2018-01-23 11:06:41 -0500516 // ANGLE performance workaround
robertphillips63926682015-08-20 09:39:02 -0700517 bool fPreferVRAMUseOverFlushes : 1;
518
Chris Dalton0dffbab2019-03-27 13:08:50 -0600519 // On some platforms it's better to make more triangles than to use the sample mask (MSAA only).
520 bool fPreferTrianglesOverSampleMask : 1;
521
jvanverth84741b32016-09-30 08:39:02 -0700522 bool fFenceSyncSupport : 1;
Brian Salomon9ff5acb2019-05-08 09:04:47 -0400523 bool fSemaphoreSupport : 1;
ethannicholas28ef4452016-03-25 09:26:03 -0700524
Brian Salomonf7232642018-09-19 08:58:08 -0400525 // Requires fence sync support in GL.
Brian Osman2c2bc112017-02-28 10:02:49 -0500526 bool fCrossContextTextureSupport : 1;
527
Brian Salomonf7232642018-09-19 08:58:08 -0400528 // Not (yet) implemented in VK backend.
529 bool fDynamicStateArrayGeometryProcessorTextureSupport : 1;
530
cdalton8917d622015-05-06 13:40:21 -0700531 BlendEquationSupport fBlendEquationSupport;
Jim Van Verth1bef9792020-07-09 08:09:13 -0400532 uint32_t fAdvBlendEqDisableFlags;
Brian Salomon4dea72a2019-12-18 10:43:10 -0500533 static_assert(kLast_GrBlendEquation < 32);
cdalton1dd05422015-06-12 09:01:18 -0700534
commit-bot@chromium.org160b4782014-05-05 12:32:37 +0000535 uint32_t fMapBufferFlags;
cdalton397536c2016-03-25 12:15:03 -0700536 int fBufferMapThreshold;
commit-bot@chromium.org160b4782014-05-05 12:32:37 +0000537
bsalomon@google.comc26d94f2013-03-25 18:19:00 +0000538 int fMaxRenderTargetSize;
Chris Dalton2612bae2018-02-22 13:41:37 -0700539 int fMaxPreferredRenderTargetSize;
bsalomon7dbd45d2016-03-23 10:40:53 -0700540 int fMaxVertexAttributes;
bsalomon@google.comc26d94f2013-03-25 18:19:00 +0000541 int fMaxTextureSize;
bsalomon8c07b7a2015-11-02 11:36:52 -0800542 int fMaxTileSize;
csmartdalton9bc11872016-08-09 12:42:47 -0700543 int fMaxWindowRectangles;
Chris Daltona1638a52019-06-24 11:54:24 -0600544 int fInternalMultisampleCount;
bsalomon@google.comc26d94f2013-03-25 18:19:00 +0000545
Adrienne Walker68314842018-05-14 14:02:53 -0700546 GrDriverBugWorkarounds fDriverBugWorkarounds;
547
egdanielbc127a32014-09-19 12:07:43 -0700548private:
Chris Dalton8367e112019-11-13 12:43:21 -0700549 void applyOptionsOverrides(const GrContextOptions& options);
550
Mike Kleinfc6c37b2016-09-27 09:34:10 -0400551 virtual void onApplyOptionsOverrides(const GrContextOptions&) {}
Brian Osman71a18892017-08-10 10:23:25 -0400552 virtual void onDumpJSON(SkJSONWriter*) const {}
Brian Salomonc67c31c2018-12-06 10:00:03 -0500553 virtual bool onSurfaceSupportsWritePixels(const GrSurface*) const = 0;
554 virtual bool onCanCopySurface(const GrSurfaceProxy* dst, const GrSurfaceProxy* src,
555 const SkIRect& srcRect, const SkIPoint& dstPoint) const = 0;
Brian Salomon469046c2020-03-30 14:21:04 -0400556 virtual GrBackendFormat onGetDefaultBackendFormat(GrColorType) const = 0;
egdanielb7e7d572015-11-04 04:23:53 -0800557
Greg Daniel2a303902018-02-20 10:25:54 -0500558 // Backends should implement this if they have any extra requirements for use of window
559 // rectangles for a specific GrBackendRenderTarget outside of basic support.
560 virtual bool onIsWindowRectanglesSupportedForRT(const GrBackendRenderTarget&) const {
561 return true;
562 }
563
Greg Daniel627d0532019-07-08 16:48:14 -0400564 virtual bool onAreColorTypeAndFormatCompatible(GrColorType, const GrBackendFormat&) const = 0;
565
Greg Danielba88ab62019-07-26 09:14:01 -0400566 virtual SupportedRead onSupportedReadPixelsColorType(GrColorType srcColorType,
567 const GrBackendFormat& srcFormat,
568 GrColorType dstColorType) const = 0;
569
Greg Daniel01f278c2020-06-12 16:58:17 -0400570 virtual GrSwizzle onGetReadSwizzle(const GrBackendFormat&, GrColorType) const = 0;
571
Greg Danield358cbe2020-09-11 09:33:54 -0400572 virtual GrDstSampleType onGetDstSampleTypeForProxy(const GrRenderTargetProxy*) const {
573 return GrDstSampleType::kAsTextureCopy;
574 }
Greg Daniel01f278c2020-06-12 16:58:17 -0400575
robertphillipscaef3452015-11-11 13:18:11 -0800576 bool fSuppressPrints : 1;
Jim Van Verthfbdc0802017-05-02 16:15:53 -0400577 bool fWireframeMode : 1;
bsalomon682c2692015-05-22 14:01:46 -0700578
John Stiles7571f9e2020-09-02 22:42:33 -0400579 using INHERITED = SkRefCnt;
bsalomon@google.comc26d94f2013-03-25 18:19:00 +0000580};
581
582#endif