blob: 169677650d430b3c7f81a93e3e1d4e8e5e7bdc0f [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) */
48 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 {
92 // This method is actually just a duplicate of preferFullscreenClears(), with a descriptive
93 // name for the sake of readability.
94 return this->preferFullscreenClears();
95 }
96
Chris Dalton3d28b6a2020-04-13 11:12:28 -060097 // D3D does not allow the refs or masks to differ on a two-sided stencil draw.
98 bool twoSidedStencilRefsAndMasksMustMatch() const {
99 return fTwoSidedStencilRefsAndMasksMustMatch;
100 }
101
robertphillips63926682015-08-20 09:39:02 -0700102 bool preferVRAMUseOverFlushes() const { return fPreferVRAMUseOverFlushes; }
103
Chris Dalton0dffbab2019-03-27 13:08:50 -0600104 bool preferTrianglesOverSampleMask() const { return fPreferTrianglesOverSampleMask; }
105
Eric Karl5c779752017-05-08 12:02:07 -0700106 bool avoidStencilBuffers() const { return fAvoidStencilBuffers; }
107
Greg Daniel4374e962018-09-28 15:09:47 -0400108 bool avoidWritePixelsFastPath() const { return fAvoidWritePixelsFastPath; }
109
Chris Daltone1196c52019-12-28 14:31:09 -0700110 // http://skbug.com/9739
111 bool requiresManualFBBarrierAfterTessellatedStencilDraw() const {
112 return fRequiresManualFBBarrierAfterTessellatedStencilDraw;
113 }
114
Chris Dalton03fdf6a2020-04-07 12:31:59 -0600115 // glDrawElementsIndirect fails GrMeshTest on every Win10 Intel bot.
116 bool nativeDrawIndexedIndirectIsBroken() const { return fNativeDrawIndexedIndirectIsBroken; }
117
csmartdaltone0d36292016-07-29 08:14:20 -0700118 /**
cdalton8917d622015-05-06 13:40:21 -0700119 * Indicates the capabilities of the fixed function blend unit.
120 */
121 enum BlendEquationSupport {
122 kBasic_BlendEquationSupport, //<! Support to select the operator that
123 // combines src and dst terms.
124 kAdvanced_BlendEquationSupport, //<! Additional fixed function support for specific
125 // SVG/PDF blend modes. Requires blend barriers.
126 kAdvancedCoherent_BlendEquationSupport, //<! Advanced blend equation support that does not
127 // require blend barriers, and permits overlap.
128
129 kLast_BlendEquationSupport = kAdvancedCoherent_BlendEquationSupport
130 };
131
132 BlendEquationSupport blendEquationSupport() const { return fBlendEquationSupport; }
133
134 bool advancedBlendEquationSupport() const {
135 return fBlendEquationSupport >= kAdvanced_BlendEquationSupport;
136 }
137
138 bool advancedCoherentBlendEquationSupport() const {
139 return kAdvancedCoherent_BlendEquationSupport == fBlendEquationSupport;
140 }
141
Jim Van Verth1bef9792020-07-09 08:09:13 -0400142 bool isAdvancedBlendEquationDisabled(GrBlendEquation equation) const {
cdalton1dd05422015-06-12 09:01:18 -0700143 SkASSERT(GrBlendEquationIsAdvanced(equation));
Chris Dalton302d5be2019-01-22 23:41:25 -0700144 SkASSERT(this->advancedBlendEquationSupport());
Jim Van Verth1bef9792020-07-09 08:09:13 -0400145 return SkToBool(fAdvBlendEqDisableFlags & (1 << equation));
cdalton1dd05422015-06-12 09:01:18 -0700146 }
147
Greg Danielf6d60d32020-01-08 13:39:16 -0500148 // On some GPUs it is a performance win to disable blending instead of doing src-over with a src
149 // alpha equal to 1. To disable blending we collapse src-over to src and the backends will
150 // handle the disabling of blending.
151 bool shouldCollapseSrcOverToSrcWhenAble() const {
152 return fShouldCollapseSrcOverToSrcWhenAble;
153 }
154
cdalton8917d622015-05-06 13:40:21 -0700155 /**
commit-bot@chromium.org160b4782014-05-05 12:32:37 +0000156 * Indicates whether GPU->CPU memory mapping for GPU resources such as vertex buffers and
157 * textures allows partial mappings or full mappings.
158 */
159 enum MapFlags {
Brian Salomon105d7c22019-04-16 13:46:14 -0400160 kNone_MapFlags = 0x0, //<! Cannot map the resource.
commit-bot@chromium.org160b4782014-05-05 12:32:37 +0000161
Brian Salomon105d7c22019-04-16 13:46:14 -0400162 kCanMap_MapFlag = 0x1, //<! The resource can be mapped. Must be set for any of
163 // the other flags to have meaning.
164 kSubset_MapFlag = 0x2, //<! The resource can be partially mapped.
Greg Daniel2d41d0d2019-08-26 11:08:51 -0400165 kAsyncRead_MapFlag = 0x4, //<! Are maps for reading asynchronous WRT GrOpsRenderPass
Brian Salomon105d7c22019-04-16 13:46:14 -0400166 // submitted to GrGpu.
commit-bot@chromium.org160b4782014-05-05 12:32:37 +0000167 };
168
169 uint32_t mapBufferFlags() const { return fMapBufferFlags; }
170
robertphillips@google.com2d2e5c42013-10-30 21:30:43 +0000171 // Scratch textures not being reused means that those scratch textures
skia.committer@gmail.com7ed98df2013-10-31 07:01:53 +0000172 // that we upload to (i.e., don't have a render target) will not be
robertphillips@google.com2d2e5c42013-10-30 21:30:43 +0000173 // recycled in the texture cache. This is to prevent ghosting by drivers
174 // (in particular for deferred architectures).
commit-bot@chromium.orgb8356522013-07-18 22:26:39 +0000175 bool reuseScratchTextures() const { return fReuseScratchTextures; }
robertphillips1b8e1b52015-06-24 06:54:10 -0700176 bool reuseScratchBuffers() const { return fReuseScratchBuffers; }
bsalomon@google.comc26d94f2013-03-25 18:19:00 +0000177
bsalomon7dbd45d2016-03-23 10:40:53 -0700178 /// maximum number of attribute values per vertex
179 int maxVertexAttributes() const { return fMaxVertexAttributes; }
180
bsalomon@google.comc26d94f2013-03-25 18:19:00 +0000181 int maxRenderTargetSize() const { return fMaxRenderTargetSize; }
Chris Dalton2612bae2018-02-22 13:41:37 -0700182
183 /** This is the largest render target size that can be used without incurring extra perfomance
184 cost. It is usually the max RT size, unless larger render targets are known to be slower. */
185 int maxPreferredRenderTargetSize() const { return fMaxPreferredRenderTargetSize; }
186
bsalomon@google.comc26d94f2013-03-25 18:19:00 +0000187 int maxTextureSize() const { return fMaxTextureSize; }
Chris Dalton2612bae2018-02-22 13:41:37 -0700188
bsalomon8c07b7a2015-11-02 11:36:52 -0800189 /** This is the maximum tile size to use by GPU devices for rendering sw-backed images/bitmaps.
190 It is usually the max texture size, unless we're overriding it for testing. */
Brian Salomonc7fe0f72018-05-11 10:14:21 -0400191 int maxTileSize() const {
192 SkASSERT(fMaxTileSize <= fMaxTextureSize);
193 return fMaxTileSize;
194 }
bsalomonc59a1df2015-06-01 07:13:42 -0700195
csmartdalton9bc11872016-08-09 12:42:47 -0700196 int maxWindowRectangles() const { return fMaxWindowRectangles; }
bsalomon@google.comc26d94f2013-03-25 18:19:00 +0000197
Greg Daniel2a303902018-02-20 10:25:54 -0500198 // Returns whether mixed samples is supported for the given backend render target.
199 bool isWindowRectanglesSupportedForRT(const GrBackendRenderTarget& rt) const {
200 return this->maxWindowRectangles() > 0 && this->onIsWindowRectanglesSupportedForRT(rt);
201 }
202
Robert Phillipsf209e882019-06-25 15:59:50 -0400203 virtual bool isFormatSRGB(const GrBackendFormat&) const = 0;
Greg Daniela00bcad2019-10-11 13:21:48 -0400204
Greg Daniel01f278c2020-06-12 16:58:17 -0400205 bool isFormatCompressed(const GrBackendFormat& format) const;
Robert Phillipsf209e882019-06-25 15:59:50 -0400206
Greg Daniel7bfc9132019-08-14 14:23:53 -0400207 // Can a texture be made with the GrBackendFormat, and then be bound and sampled in a shader.
208 virtual bool isFormatTexturable(const GrBackendFormat&) const = 0;
Brian Salomonbdecacf2018-02-02 20:32:49 -0500209
Greg Daniel6980c4e2019-07-30 16:18:18 -0400210 // Returns whether a texture of the given format can be copied to a texture of the same format.
211 virtual bool isFormatCopyable(const GrBackendFormat&) const = 0;
Brian Salomonbdecacf2018-02-02 20:32:49 -0500212
Greg Danieleadfac92019-08-02 09:03:53 -0400213 // Returns the maximum supported sample count for a format. 0 means the format is not renderable
Brian Salomon469046c2020-03-30 14:21:04 -0400214 // 1 means the format is renderable but doesn't support MSAA.
Greg Danieleadfac92019-08-02 09:03:53 -0400215 virtual int maxRenderTargetSampleCount(const GrBackendFormat&) const = 0;
Brian Salomonbdecacf2018-02-02 20:32:49 -0500216
Chris Dalton1e6c5b82019-06-17 14:16:49 -0600217 // Returns the number of samples to use when performing internal draws to the given config with
Chris Daltona1638a52019-06-24 11:54:24 -0600218 // MSAA or mixed samples. If 0, Ganesh should not attempt to use internal multisampling.
Greg Danieleadfac92019-08-02 09:03:53 -0400219 int internalMultisampleCount(const GrBackendFormat& format) const {
Brian Osman788b9162020-02-07 10:36:46 -0500220 return std::min(fInternalMultisampleCount, this->maxRenderTargetSampleCount(format));
Chris Dalton1e6c5b82019-06-17 14:16:49 -0600221 }
222
Greg Daniel900583a2019-08-06 12:05:31 -0400223 virtual bool isFormatAsColorTypeRenderable(GrColorType ct, const GrBackendFormat& format,
224 int sampleCount = 1) const = 0;
225
226 virtual bool isFormatRenderable(const GrBackendFormat& format, int sampleCount) const = 0;
Brian Salomonbdecacf2018-02-02 20:32:49 -0500227
228 // Find a sample count greater than or equal to the requested count which is supported for a
Greg Daniel6fa62e22019-08-07 15:52:37 -0400229 // 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 -0500230 // sample count is 1 then 1 will be returned if non-MSAA rendering is supported, otherwise 0.
231 // For historical reasons requestedCount==0 is handled identically to requestedCount==1.
Greg Daniel6fa62e22019-08-07 15:52:37 -0400232 virtual int getRenderTargetSampleCount(int requestedCount, const GrBackendFormat&) const = 0;
commit-bot@chromium.org42dc8132014-05-27 19:26:59 +0000233
Greg Daniel7fd7a8a2019-10-10 16:10:31 -0400234 // Returns the number of bytes per pixel for the given GrBackendFormat. This is only supported
235 // for "normal" formats. For compressed formats this will return 0.
236 virtual size_t bytesPerPixel(const GrBackendFormat&) const = 0;
237
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 Daniel25af6712018-04-25 10:44:38 -0400382 /**
Brian Salomon1e03b6b12019-07-17 17:28:24 -0400383 * This is used to try to ensure a successful copy a dst in order to perform shader-based
384 * blending.
385 *
386 * fRectsMustMatch will be set to true if the copy operation must ensure that the src and dest
387 * rects are identical.
388 *
389 * fMustCopyWholeSrc will be set to true if copy rect must equal src's bounds.
390 *
391 * Caller will detect cases when copy cannot succeed and try copy-as-draw as a fallback.
Brian Salomon467921e2017-03-06 16:17:12 -0500392 */
Brian Salomon1e03b6b12019-07-17 17:28:24 -0400393 struct DstCopyRestrictions {
394 GrSurfaceProxy::RectsMustMatch fRectsMustMatch = GrSurfaceProxy::RectsMustMatch::kNo;
395 bool fMustCopyWholeSrc = false;
396 };
Greg Daniel0258c902019-08-01 13:08:33 -0400397 virtual DstCopyRestrictions getDstCopyRestrictions(const GrRenderTargetProxy* src,
398 GrColorType ct) const {
Brian Salomon1e03b6b12019-07-17 17:28:24 -0400399 return {};
400 }
Brian Salomon467921e2017-03-06 16:17:12 -0500401
Greg Daniel9a48beb2020-01-16 16:57:16 -0500402 bool validateSurfaceParams(const SkISize&, const GrBackendFormat&, GrRenderable renderable,
403 int renderTargetSampleCnt, GrMipMapped) const;
Brian Salomonbdecacf2018-02-02 20:32:49 -0500404
Greg Daniel01f278c2020-06-12 16:58:17 -0400405 bool areColorTypeAndFormatCompatible(GrColorType grCT, const GrBackendFormat& format) const;
Robert Phillipsc046ff02019-07-01 10:34:03 -0400406
Brian Salomonf391d0f2018-12-14 09:18:50 -0500407 /** These are used when creating a new texture internally. */
Robert Phillips0a15cc62019-07-30 12:49:10 -0400408 GrBackendFormat getDefaultBackendFormat(GrColorType, GrRenderable) const;
Greg Daniel4065d452018-11-16 15:43:41 -0500409
Brian Salomonbb8dde82019-06-27 10:52:13 -0400410 virtual GrBackendFormat getBackendFormatFromCompressionType(SkImage::CompressionType) const = 0;
411
Timothy Liang036fdfe2018-06-28 15:50:36 -0400412 /**
Michael Ludwigf23a1522018-12-10 11:36:13 -0500413 * The CLAMP_TO_BORDER wrap mode for texture coordinates was added to desktop GL in 1.3, and
414 * GLES 3.2, but is also available in extensions. Vulkan and Metal always have support.
415 */
416 bool clampToBorderSupport() const { return fClampToBorderSupport; }
417
Greg Danieleb4a8272019-05-16 16:52:55 -0400418 /**
Greg Daniel14b57212019-12-17 16:18:06 -0500419 * Returns the GrSwizzle to use when sampling or reading back from a texture with the passed in
420 * GrBackendFormat and GrColorType.
Greg Danieleb4a8272019-05-16 16:52:55 -0400421 */
Greg Daniel01f278c2020-06-12 16:58:17 -0400422 GrSwizzle getReadSwizzle(const GrBackendFormat& format, GrColorType colorType) const;
Greg Danieleb4a8272019-05-16 16:52:55 -0400423
424 /**
Brian Salomon982f5462020-03-30 12:52:33 -0400425 * Returns the GrSwizzle to use when writing colors to a surface with the passed in
Greg Danieleb4a8272019-05-16 16:52:55 -0400426 * GrBackendFormat and GrColorType.
427 */
Brian Salomon982f5462020-03-30 12:52:33 -0400428 virtual GrSwizzle getWriteSwizzle(const GrBackendFormat&, GrColorType) const = 0;
Greg Danieleb4a8272019-05-16 16:52:55 -0400429
Greg Danield51fa2f2020-01-22 16:53:38 -0500430 virtual uint64_t computeFormatKey(const GrBackendFormat&) const = 0;
431
Adrienne Walker3ed33992018-05-15 11:44:34 -0700432 const GrDriverBugWorkarounds& workarounds() const { return fDriverBugWorkarounds; }
433
Brian Salomon947efe22019-07-16 15:36:11 -0400434 /**
Robert Phillips323471e2019-11-11 11:33:37 -0500435 * Adds fields to the key to represent the sampler that will be created for the passed
436 * in parameters. Currently this extra keying is only needed when building a vulkan pipeline
437 * with immutable samplers.
438 */
439 virtual void addExtraSamplerKey(GrProcessorKeyBuilder*,
Brian Salomonccb61422020-01-09 10:46:36 -0500440 GrSamplerState,
Robert Phillips323471e2019-11-11 11:33:37 -0500441 const GrBackendFormat&) const {}
442
Robert Phillips03e4c952019-11-26 16:20:22 -0500443 virtual GrProgramDesc makeDesc(const GrRenderTarget*, const GrProgramInfo&) const = 0;
444
Robert Phillipsffe27292019-08-01 10:08:07 -0400445#if GR_TEST_UTILS
446 struct TestFormatColorTypeCombination {
447 GrColorType fColorType;
448 GrBackendFormat fFormat;
449 };
450
451 virtual std::vector<TestFormatColorTypeCombination> getTestingCombinations() const = 0;
452#endif
453
bsalomon@google.comc26d94f2013-03-25 18:19:00 +0000454protected:
Chris Dalton8367e112019-11-13 12:43:21 -0700455 // Subclasses must call this at the end of their init method in order to do final processing on
456 // the caps (including overrides requested by the client).
457 // NOTE: this method will only reduce the caps, never expand them.
458 void finishInitialization(const GrContextOptions& options);
bsalomon4ee6bd82015-05-27 13:23:23 -0700459
bungeman6bd52842016-10-27 09:30:08 -0700460 sk_sp<GrShaderCaps> fShaderCaps;
jvanverthe9c0fc62015-04-29 11:18:05 -0700461
joshualitt83bc2292015-06-18 14:18:02 -0700462 bool fNPOTTextureTileSupport : 1;
463 bool fMipMapSupport : 1;
joshualitt83bc2292015-06-18 14:18:02 -0700464 bool fReuseScratchTextures : 1;
robertphillips1b8e1b52015-06-24 06:54:10 -0700465 bool fReuseScratchBuffers : 1;
joshualitt83bc2292015-06-18 14:18:02 -0700466 bool fGpuTracingSupport : 1;
joshualitt83bc2292015-06-18 14:18:02 -0700467 bool fOversizedStencilSupport : 1;
468 bool fTextureBarrierSupport : 1;
Robert Phillips7f861922018-01-30 13:13:42 +0000469 bool fSampleLocationsSupport : 1;
csmartdalton2b5f2cb2016-06-10 14:06:32 -0700470 bool fMultisampleDisableSupport : 1;
Chris Daltona77cdee2020-04-03 14:50:43 -0600471 bool fDrawInstancedSupport : 1;
Chris Dalton03fdf6a2020-04-07 12:31:59 -0600472 bool fNativeDrawIndirectSupport : 1;
Chris Daltonbde4bb72020-07-17 14:11:04 -0600473 bool fUseClientSideIndirectBuffers : 1;
Chris Dalton6ce447a2019-06-23 18:07:38 -0600474 bool fMixedSamplesSupport : 1;
Chris Daltonce425af2019-12-16 10:39:03 -0700475 bool fConservativeRasterSupport : 1;
Chris Dalton1215cda2019-12-17 21:44:04 -0700476 bool fWireframeSupport : 1;
Chris Daltond5d8a642019-08-08 15:29:20 -0600477 bool fMSAAResolvesAutomatically : 1;
Chris Dalton27059d32018-01-23 14:06:50 -0700478 bool fUsePrimitiveRestart : 1;
csmartdalton485a1202016-07-13 10:16:32 -0700479 bool fPreferClientSideDynamicBuffers : 1;
Chris Dalton344e9032017-12-11 15:42:09 -0700480 bool fPreferFullscreenClears : 1;
Chris Dalton3d28b6a2020-04-13 11:12:28 -0600481 bool fTwoSidedStencilRefsAndMasksMustMatch : 1;
bsalomon7dea7b72015-08-19 08:26:51 -0700482 bool fMustClearUploadedBufferData : 1;
Kevin Lubick61a5f0a2019-03-28 09:47:15 -0400483 bool fShouldInitializeTextures : 1;
Greg Danielb2acf0a2018-09-12 09:17:11 -0400484 bool fSupportsAHardwareBufferImages : 1;
Brian Osman499bf1a2018-09-17 11:32:42 -0400485 bool fHalfFloatVertexAttributeSupport : 1;
Michael Ludwigf23a1522018-12-10 11:36:13 -0500486 bool fClampToBorderSupport : 1;
Michael Ludwiga21d1962019-01-11 15:26:22 -0500487 bool fPerformPartialClearsAsDraws : 1;
488 bool fPerformColorClearsAsDraws : 1;
Robert Phillips2f05a482019-11-25 09:54:43 -0500489 bool fAvoidLargeIndexBufferDraws : 1;
Michael Ludwiga21d1962019-01-11 15:26:22 -0500490 bool fPerformStencilClearsAsDraws : 1;
Chris Daltona8fbeba2019-03-30 00:31:23 -0600491 bool fAllowCoverageCounting : 1;
Brian Salomonfb28c6f2020-01-10 13:04:45 -0500492 bool fTransferFromBufferToTextureSupport : 1;
493 bool fTransferFromSurfaceToBufferSupport : 1;
Brian Salomon1047a492019-07-02 12:25:21 -0400494 bool fWritePixelsRowBytesSupport : 1;
495 bool fReadPixelsRowBytesSupport : 1;
Greg Danielf6d60d32020-01-08 13:39:16 -0500496 bool fShouldCollapseSrcOverToSrcWhenAble : 1;
robertphillips1b8e1b52015-06-24 06:54:10 -0700497
bsalomon63b21962014-11-05 07:05:34 -0800498 // Driver workaround
Jim Van Verth1bef9792020-07-09 08:09:13 -0400499 bool fDriverDisableCCPR : 1;
500 bool fDriverDisableMSAACCPR : 1;
Eric Karl5c779752017-05-08 12:02:07 -0700501 bool fAvoidStencilBuffers : 1;
Greg Daniel4374e962018-09-28 15:09:47 -0400502 bool fAvoidWritePixelsFastPath : 1;
Chris Daltone1196c52019-12-28 14:31:09 -0700503 bool fRequiresManualFBBarrierAfterTessellatedStencilDraw : 1;
Chris Dalton03fdf6a2020-04-07 12:31:59 -0600504 bool fNativeDrawIndexedIndirectIsBroken : 1;
bsalomon63b21962014-11-05 07:05:34 -0800505
Brian Salomon01b476a2018-01-23 11:06:41 -0500506 // ANGLE performance workaround
robertphillips63926682015-08-20 09:39:02 -0700507 bool fPreferVRAMUseOverFlushes : 1;
508
Chris Dalton0dffbab2019-03-27 13:08:50 -0600509 // On some platforms it's better to make more triangles than to use the sample mask (MSAA only).
510 bool fPreferTrianglesOverSampleMask : 1;
511
jvanverth84741b32016-09-30 08:39:02 -0700512 bool fFenceSyncSupport : 1;
Brian Salomon9ff5acb2019-05-08 09:04:47 -0400513 bool fSemaphoreSupport : 1;
ethannicholas28ef4452016-03-25 09:26:03 -0700514
Brian Salomonf7232642018-09-19 08:58:08 -0400515 // Requires fence sync support in GL.
Brian Osman2c2bc112017-02-28 10:02:49 -0500516 bool fCrossContextTextureSupport : 1;
517
Brian Salomonf7232642018-09-19 08:58:08 -0400518 // Not (yet) implemented in VK backend.
519 bool fDynamicStateArrayGeometryProcessorTextureSupport : 1;
520
cdalton8917d622015-05-06 13:40:21 -0700521 BlendEquationSupport fBlendEquationSupport;
Jim Van Verth1bef9792020-07-09 08:09:13 -0400522 uint32_t fAdvBlendEqDisableFlags;
Brian Salomon4dea72a2019-12-18 10:43:10 -0500523 static_assert(kLast_GrBlendEquation < 32);
cdalton1dd05422015-06-12 09:01:18 -0700524
commit-bot@chromium.org160b4782014-05-05 12:32:37 +0000525 uint32_t fMapBufferFlags;
cdalton397536c2016-03-25 12:15:03 -0700526 int fBufferMapThreshold;
commit-bot@chromium.org160b4782014-05-05 12:32:37 +0000527
bsalomon@google.comc26d94f2013-03-25 18:19:00 +0000528 int fMaxRenderTargetSize;
Chris Dalton2612bae2018-02-22 13:41:37 -0700529 int fMaxPreferredRenderTargetSize;
bsalomon7dbd45d2016-03-23 10:40:53 -0700530 int fMaxVertexAttributes;
bsalomon@google.comc26d94f2013-03-25 18:19:00 +0000531 int fMaxTextureSize;
bsalomon8c07b7a2015-11-02 11:36:52 -0800532 int fMaxTileSize;
csmartdalton9bc11872016-08-09 12:42:47 -0700533 int fMaxWindowRectangles;
Chris Daltona1638a52019-06-24 11:54:24 -0600534 int fInternalMultisampleCount;
bsalomon@google.comc26d94f2013-03-25 18:19:00 +0000535
Adrienne Walker68314842018-05-14 14:02:53 -0700536 GrDriverBugWorkarounds fDriverBugWorkarounds;
537
egdanielbc127a32014-09-19 12:07:43 -0700538private:
Chris Dalton8367e112019-11-13 12:43:21 -0700539 void applyOptionsOverrides(const GrContextOptions& options);
540
Mike Kleinfc6c37b2016-09-27 09:34:10 -0400541 virtual void onApplyOptionsOverrides(const GrContextOptions&) {}
Brian Osman71a18892017-08-10 10:23:25 -0400542 virtual void onDumpJSON(SkJSONWriter*) const {}
Brian Salomonc67c31c2018-12-06 10:00:03 -0500543 virtual bool onSurfaceSupportsWritePixels(const GrSurface*) const = 0;
544 virtual bool onCanCopySurface(const GrSurfaceProxy* dst, const GrSurfaceProxy* src,
545 const SkIRect& srcRect, const SkIPoint& dstPoint) const = 0;
Brian Salomon469046c2020-03-30 14:21:04 -0400546 virtual GrBackendFormat onGetDefaultBackendFormat(GrColorType) const = 0;
egdanielb7e7d572015-11-04 04:23:53 -0800547
Greg Daniel2a303902018-02-20 10:25:54 -0500548 // Backends should implement this if they have any extra requirements for use of window
549 // rectangles for a specific GrBackendRenderTarget outside of basic support.
550 virtual bool onIsWindowRectanglesSupportedForRT(const GrBackendRenderTarget&) const {
551 return true;
552 }
553
Greg Daniel627d0532019-07-08 16:48:14 -0400554 virtual bool onAreColorTypeAndFormatCompatible(GrColorType, const GrBackendFormat&) const = 0;
555
Greg Danielba88ab62019-07-26 09:14:01 -0400556 virtual SupportedRead onSupportedReadPixelsColorType(GrColorType srcColorType,
557 const GrBackendFormat& srcFormat,
558 GrColorType dstColorType) const = 0;
559
Greg Daniel01f278c2020-06-12 16:58:17 -0400560 virtual GrSwizzle onGetReadSwizzle(const GrBackendFormat&, GrColorType) const = 0;
561
562
robertphillipscaef3452015-11-11 13:18:11 -0800563 bool fSuppressPrints : 1;
Jim Van Verthfbdc0802017-05-02 16:15:53 -0400564 bool fWireframeMode : 1;
bsalomon682c2692015-05-22 14:01:46 -0700565
bsalomon@google.comc26d94f2013-03-25 18:19:00 +0000566 typedef SkRefCnt INHERITED;
567};
568
569#endif