blob: d869a56b48807ec3865270bb10e96bdc5e3da1af [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"
Brian Salomon096b0912019-08-14 16:56:13 -040016#include "src/gpu/GrBlend.h"
Mike Kleinc0bd9f92019-04-23 12:05:21 -050017#include "src/gpu/GrShaderCaps.h"
Brian Salomon1e03b6b12019-07-17 17:28:24 -040018#include "src/gpu/GrSurfaceProxy.h"
commit-bot@chromium.org8b656c62013-11-21 15:23:15 +000019
Robert Phillipsfc711a22018-02-13 17:03:00 -050020class GrBackendFormat;
Greg Danielfaa095e2017-12-19 13:15:02 -050021class GrBackendRenderTarget;
Greg Danielf5d87582017-12-18 14:48:15 -050022class GrBackendTexture;
bsalomon682c2692015-05-22 14:01:46 -070023struct GrContextOptions;
Robert Phillips323471e2019-11-11 11:33:37 -050024class GrProcessorKeyBuilder;
Robert Phillips03e4c952019-11-26 16:20:22 -050025class GrProgramDesc;
26class GrProgramInfo;
Robert Phillipsbf25d432017-04-07 10:08:53 -040027class GrRenderTargetProxy;
Robert Phillips323471e2019-11-11 11:33:37 -050028class GrSamplerState;
Brian Salomon3d86a192018-02-27 16:46:11 -050029class GrSurface;
Brian Osman71a18892017-08-10 10:23:25 -040030class SkJSONWriter;
jvanverthe9c0fc62015-04-29 11:18:05 -070031
32/**
bsalomon4b91f762015-05-19 09:29:46 -070033 * Represents the capabilities of a GrContext.
jvanverthe9c0fc62015-04-29 11:18:05 -070034 */
bsalomon4b91f762015-05-19 09:29:46 -070035class GrCaps : public SkRefCnt {
jvanverthe9c0fc62015-04-29 11:18:05 -070036public:
bsalomon682c2692015-05-22 14:01:46 -070037 GrCaps(const GrContextOptions&);
bsalomon@google.comc26d94f2013-03-25 18:19:00 +000038
Brian Osman71a18892017-08-10 10:23:25 -040039 void dumpJSON(SkJSONWriter*) const;
40
Brian Salomon94efbf52016-11-29 13:43:05 -050041 const GrShaderCaps* shaderCaps() const { return fShaderCaps.get(); }
Robert Phillips7f11fb52019-12-03 13:35:19 -050042 sk_sp<const GrShaderCaps> refShaderCaps() const { return fShaderCaps; }
jvanverthe9c0fc62015-04-29 11:18:05 -070043
bsalomon@google.comc26d94f2013-03-25 18:19:00 +000044 bool npotTextureTileSupport() const { return fNPOTTextureTileSupport; }
commit-bot@chromium.org47442312013-12-19 16:18:01 +000045 /** To avoid as-yet-unnecessary complexity we don't allow any partial support of MIP Maps (e.g.
46 only for POT textures) */
47 bool mipMapSupport() const { return fMipMapSupport; }
brianosman64d094d2016-03-25 06:01:59 -070048
commit-bot@chromium.orga3baf3b2014-02-21 18:45:30 +000049 bool gpuTracingSupport() const { return fGpuTracingSupport; }
bsalomond08ea5f2015-02-20 06:58:13 -080050 bool oversizedStencilSupport() const { return fOversizedStencilSupport; }
cdaltonfd4167d2015-04-21 11:45:56 -070051 bool textureBarrierSupport() const { return fTextureBarrierSupport; }
Robert Phillips7f861922018-01-30 13:13:42 +000052 bool sampleLocationsSupport() const { return fSampleLocationsSupport; }
csmartdalton2b5f2cb2016-06-10 14:06:32 -070053 bool multisampleDisableSupport() const { return fMultisampleDisableSupport; }
Chris Dalton1d616352017-05-31 12:51:23 -060054 bool instanceAttribSupport() const { return fInstanceAttribSupport; }
Chris Dalton6ce447a2019-06-23 18:07:38 -060055 bool mixedSamplesSupport() const { return fMixedSamplesSupport; }
Chris Daltonce425af2019-12-16 10:39:03 -070056 bool conservativeRasterSupport() const { return fConservativeRasterSupport; }
Chris Daltond5d8a642019-08-08 15:29:20 -060057 // This flag indicates that we never have to resolve MSAA. In practice, it means that we have
58 // an MSAA-render-to-texture extension: Any render target we create internally will use the
59 // extension, and any wrapped render target is the client's responsibility.
60 bool msaaResolvesAutomatically() const { return fMSAAResolvesAutomatically; }
Brian Osman499bf1a2018-09-17 11:32:42 -040061 bool halfFloatVertexAttributeSupport() const { return fHalfFloatVertexAttributeSupport; }
Chris Dalton27059d32018-01-23 14:06:50 -070062
63 // Primitive restart functionality is core in ES 3.0, but using it will cause slowdowns on some
64 // systems. This cap is only set if primitive restart will improve performance.
65 bool usePrimitiveRestart() const { return fUsePrimitiveRestart; }
66
csmartdalton485a1202016-07-13 10:16:32 -070067 bool preferClientSideDynamicBuffers() const { return fPreferClientSideDynamicBuffers; }
robertphillips@google.com2d2e5c42013-10-30 21:30:43 +000068
Chris Dalton344e9032017-12-11 15:42:09 -070069 // On tilers, an initial fullscreen clear is an OPTIMIZATION. It allows the hardware to
70 // initialize each tile with a constant value rather than loading each pixel from memory.
71 bool preferFullscreenClears() const { return fPreferFullscreenClears; }
72
Chris Dalton674f77a2019-09-30 20:49:39 -060073 // Should we discard stencil values after a render pass? (Tilers get better performance if we
74 // always load stencil buffers with a "clear" op, and then discard the content when finished.)
75 bool discardStencilValuesAfterRenderPass() const {
76 // This method is actually just a duplicate of preferFullscreenClears(), with a descriptive
77 // name for the sake of readability.
78 return this->preferFullscreenClears();
79 }
80
robertphillips63926682015-08-20 09:39:02 -070081 bool preferVRAMUseOverFlushes() const { return fPreferVRAMUseOverFlushes; }
82
Chris Dalton0dffbab2019-03-27 13:08:50 -060083 bool preferTrianglesOverSampleMask() const { return fPreferTrianglesOverSampleMask; }
84
Eric Karl5c779752017-05-08 12:02:07 -070085 bool avoidStencilBuffers() const { return fAvoidStencilBuffers; }
86
Greg Daniel4374e962018-09-28 15:09:47 -040087 bool avoidWritePixelsFastPath() const { return fAvoidWritePixelsFastPath; }
88
csmartdaltone0d36292016-07-29 08:14:20 -070089 /**
cdalton8917d622015-05-06 13:40:21 -070090 * Indicates the capabilities of the fixed function blend unit.
91 */
92 enum BlendEquationSupport {
93 kBasic_BlendEquationSupport, //<! Support to select the operator that
94 // combines src and dst terms.
95 kAdvanced_BlendEquationSupport, //<! Additional fixed function support for specific
96 // SVG/PDF blend modes. Requires blend barriers.
97 kAdvancedCoherent_BlendEquationSupport, //<! Advanced blend equation support that does not
98 // require blend barriers, and permits overlap.
99
100 kLast_BlendEquationSupport = kAdvancedCoherent_BlendEquationSupport
101 };
102
103 BlendEquationSupport blendEquationSupport() const { return fBlendEquationSupport; }
104
105 bool advancedBlendEquationSupport() const {
106 return fBlendEquationSupport >= kAdvanced_BlendEquationSupport;
107 }
108
109 bool advancedCoherentBlendEquationSupport() const {
110 return kAdvancedCoherent_BlendEquationSupport == fBlendEquationSupport;
111 }
112
Chris Dalton302d5be2019-01-22 23:41:25 -0700113 bool isAdvancedBlendEquationBlacklisted(GrBlendEquation equation) const {
cdalton1dd05422015-06-12 09:01:18 -0700114 SkASSERT(GrBlendEquationIsAdvanced(equation));
Chris Dalton302d5be2019-01-22 23:41:25 -0700115 SkASSERT(this->advancedBlendEquationSupport());
cdalton1dd05422015-06-12 09:01:18 -0700116 return SkToBool(fAdvBlendEqBlacklist & (1 << equation));
117 }
118
cdalton8917d622015-05-06 13:40:21 -0700119 /**
commit-bot@chromium.org160b4782014-05-05 12:32:37 +0000120 * Indicates whether GPU->CPU memory mapping for GPU resources such as vertex buffers and
121 * textures allows partial mappings or full mappings.
122 */
123 enum MapFlags {
Brian Salomon105d7c22019-04-16 13:46:14 -0400124 kNone_MapFlags = 0x0, //<! Cannot map the resource.
commit-bot@chromium.org160b4782014-05-05 12:32:37 +0000125
Brian Salomon105d7c22019-04-16 13:46:14 -0400126 kCanMap_MapFlag = 0x1, //<! The resource can be mapped. Must be set for any of
127 // the other flags to have meaning.
128 kSubset_MapFlag = 0x2, //<! The resource can be partially mapped.
Greg Daniel2d41d0d2019-08-26 11:08:51 -0400129 kAsyncRead_MapFlag = 0x4, //<! Are maps for reading asynchronous WRT GrOpsRenderPass
Brian Salomon105d7c22019-04-16 13:46:14 -0400130 // submitted to GrGpu.
commit-bot@chromium.org160b4782014-05-05 12:32:37 +0000131 };
132
133 uint32_t mapBufferFlags() const { return fMapBufferFlags; }
134
robertphillips@google.com2d2e5c42013-10-30 21:30:43 +0000135 // Scratch textures not being reused means that those scratch textures
skia.committer@gmail.com7ed98df2013-10-31 07:01:53 +0000136 // that we upload to (i.e., don't have a render target) will not be
robertphillips@google.com2d2e5c42013-10-30 21:30:43 +0000137 // recycled in the texture cache. This is to prevent ghosting by drivers
138 // (in particular for deferred architectures).
commit-bot@chromium.orgb8356522013-07-18 22:26:39 +0000139 bool reuseScratchTextures() const { return fReuseScratchTextures; }
robertphillips1b8e1b52015-06-24 06:54:10 -0700140 bool reuseScratchBuffers() const { return fReuseScratchBuffers; }
bsalomon@google.comc26d94f2013-03-25 18:19:00 +0000141
bsalomon7dbd45d2016-03-23 10:40:53 -0700142 /// maximum number of attribute values per vertex
143 int maxVertexAttributes() const { return fMaxVertexAttributes; }
144
bsalomon@google.comc26d94f2013-03-25 18:19:00 +0000145 int maxRenderTargetSize() const { return fMaxRenderTargetSize; }
Chris Dalton2612bae2018-02-22 13:41:37 -0700146
147 /** This is the largest render target size that can be used without incurring extra perfomance
148 cost. It is usually the max RT size, unless larger render targets are known to be slower. */
149 int maxPreferredRenderTargetSize() const { return fMaxPreferredRenderTargetSize; }
150
bsalomon@google.comc26d94f2013-03-25 18:19:00 +0000151 int maxTextureSize() const { return fMaxTextureSize; }
Chris Dalton2612bae2018-02-22 13:41:37 -0700152
bsalomon8c07b7a2015-11-02 11:36:52 -0800153 /** This is the maximum tile size to use by GPU devices for rendering sw-backed images/bitmaps.
154 It is usually the max texture size, unless we're overriding it for testing. */
Brian Salomonc7fe0f72018-05-11 10:14:21 -0400155 int maxTileSize() const {
156 SkASSERT(fMaxTileSize <= fMaxTextureSize);
157 return fMaxTileSize;
158 }
bsalomonc59a1df2015-06-01 07:13:42 -0700159
csmartdalton9bc11872016-08-09 12:42:47 -0700160 int maxWindowRectangles() const { return fMaxWindowRectangles; }
bsalomon@google.comc26d94f2013-03-25 18:19:00 +0000161
Greg Daniel2a303902018-02-20 10:25:54 -0500162 // Returns whether mixed samples is supported for the given backend render target.
163 bool isWindowRectanglesSupportedForRT(const GrBackendRenderTarget& rt) const {
164 return this->maxWindowRectangles() > 0 && this->onIsWindowRectanglesSupportedForRT(rt);
165 }
166
Robert Phillipsf209e882019-06-25 15:59:50 -0400167 virtual bool isFormatSRGB(const GrBackendFormat&) const = 0;
Greg Daniela00bcad2019-10-11 13:21:48 -0400168
Robert Phillipsd6df7b52019-12-13 11:17:46 -0500169 // This will return SkImage::CompressionType::kNone if the backend format is not compressed.
170 virtual SkImage::CompressionType compressionType(const GrBackendFormat&) const = 0;
171
172 bool isFormatCompressed(const GrBackendFormat& format) const {
173 return this->compressionType(format) != SkImage::CompressionType::kNone;
174 }
Robert Phillipsf209e882019-06-25 15:59:50 -0400175
Greg Daniel7bfc9132019-08-14 14:23:53 -0400176 // TODO: Once we use the supportWritePixels call for uploads, we can remove this function and
177 // instead only have the version that takes a GrBackendFormat.
178 virtual bool isFormatTexturableAndUploadable(GrColorType, const GrBackendFormat&) const = 0;
179 // Can a texture be made with the GrBackendFormat, and then be bound and sampled in a shader.
180 virtual bool isFormatTexturable(const GrBackendFormat&) const = 0;
Brian Salomonbdecacf2018-02-02 20:32:49 -0500181
Greg Daniel6980c4e2019-07-30 16:18:18 -0400182 // Returns whether a texture of the given format can be copied to a texture of the same format.
183 virtual bool isFormatCopyable(const GrBackendFormat&) const = 0;
Brian Salomonbdecacf2018-02-02 20:32:49 -0500184
Greg Danieleadfac92019-08-02 09:03:53 -0400185 // Returns the maximum supported sample count for a format. 0 means the format is not renderable
186 // 1 means the format is renderable but doesn't support MSAA. This call only refers to the
187 // format itself. A caller should also confirm if the format is renderable with a given
188 // GrColorType by calling isFormatRenderable.
189 virtual int maxRenderTargetSampleCount(const GrBackendFormat&) const = 0;
Brian Salomonbdecacf2018-02-02 20:32:49 -0500190
Chris Dalton1e6c5b82019-06-17 14:16:49 -0600191 // Returns the number of samples to use when performing internal draws to the given config with
Chris Daltona1638a52019-06-24 11:54:24 -0600192 // MSAA or mixed samples. If 0, Ganesh should not attempt to use internal multisampling.
Greg Danieleadfac92019-08-02 09:03:53 -0400193 int internalMultisampleCount(const GrBackendFormat& format) const {
194 return SkTMin(fInternalMultisampleCount, this->maxRenderTargetSampleCount(format));
Chris Dalton1e6c5b82019-06-17 14:16:49 -0600195 }
196
Greg Daniel900583a2019-08-06 12:05:31 -0400197 virtual bool isFormatAsColorTypeRenderable(GrColorType ct, const GrBackendFormat& format,
198 int sampleCount = 1) const = 0;
199
200 virtual bool isFormatRenderable(const GrBackendFormat& format, int sampleCount) const = 0;
Brian Salomonbdecacf2018-02-02 20:32:49 -0500201
202 // Find a sample count greater than or equal to the requested count which is supported for a
Greg Daniel6fa62e22019-08-07 15:52:37 -0400203 // 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 -0500204 // sample count is 1 then 1 will be returned if non-MSAA rendering is supported, otherwise 0.
205 // For historical reasons requestedCount==0 is handled identically to requestedCount==1.
Greg Daniel6fa62e22019-08-07 15:52:37 -0400206 virtual int getRenderTargetSampleCount(int requestedCount, const GrBackendFormat&) const = 0;
commit-bot@chromium.org42dc8132014-05-27 19:26:59 +0000207
Greg Daniel7fd7a8a2019-10-10 16:10:31 -0400208 // Returns the number of bytes per pixel for the given GrBackendFormat. This is only supported
209 // for "normal" formats. For compressed formats this will return 0.
210 virtual size_t bytesPerPixel(const GrBackendFormat&) const = 0;
211
Brian Salomon5f33a8c2018-02-26 14:32:39 -0500212 /**
Brian Salomon3d86a192018-02-27 16:46:11 -0500213 * Backends may have restrictions on what types of surfaces support GrGpu::writePixels().
214 * If this returns false then the caller should implement a fallback where a temporary texture
215 * 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 -0500216 */
Brian Salomonc67c31c2018-12-06 10:00:03 -0500217 bool surfaceSupportsWritePixels(const GrSurface*) const;
Brian Salomon19eaf2d2018-03-19 16:06:44 -0400218
Emircan Uysaler23ca4e72019-06-24 10:53:09 -0400219 /**
Brian Salomondc0710f2019-07-01 14:59:32 -0400220 * Indicates whether surface supports GrGpu::readPixels, must be copied, or cannot be read.
Emircan Uysaler23ca4e72019-06-24 10:53:09 -0400221 */
Brian Salomondc0710f2019-07-01 14:59:32 -0400222 enum class SurfaceReadPixelsSupport {
223 /** GrGpu::readPixels is supported by the surface. */
224 kSupported,
225 /**
226 * GrGpu::readPixels is not supported by this surface but this surface can be drawn
227 * or copied to a Ganesh-created GrTextureType::kTexture2D and then that surface will be
228 * readable.
229 */
230 kCopyToTexture2D,
231 /**
232 * Not supported
233 */
234 kUnsupported,
Emircan Uysaler23ca4e72019-06-24 10:53:09 -0400235 };
Brian Salomon19eaf2d2018-03-19 16:06:44 -0400236 /**
Brian Salomondc0710f2019-07-01 14:59:32 -0400237 * Backends may have restrictions on what types of surfaces support GrGpu::readPixels(). We may
238 * either be able to read directly from the surface, read from a copy of the surface, or not
239 * read at all.
Brian Salomon19eaf2d2018-03-19 16:06:44 -0400240 */
Brian Salomondc0710f2019-07-01 14:59:32 -0400241 virtual SurfaceReadPixelsSupport surfaceSupportsReadPixels(const GrSurface*) const = 0;
Brian Salomon5f33a8c2018-02-26 14:32:39 -0500242
Brian Salomon42be09d2019-07-26 12:12:26 -0400243 struct SupportedWrite {
244 GrColorType fColorType;
245 // If the write is occurring using GrGpu::transferPixelsTo then this provides the
246 // minimum alignment of the offset into the transfer buffer.
247 size_t fOffsetAlignmentForTransferBuffer;
248 };
249
Brian Salomon5f33a8c2018-02-26 14:32:39 -0500250 /**
251 * Given a dst pixel config and a src color type what color type must the caller coax the
252 * the data into in order to use GrGpu::writePixels().
253 */
Brian Salomon01915c02019-08-02 09:57:21 -0400254 virtual SupportedWrite supportedWritePixelsColorType(GrColorType surfaceColorType,
255 const GrBackendFormat& surfaceFormat,
Brian Salomon42be09d2019-07-26 12:12:26 -0400256 GrColorType srcColorType) const = 0;
Brian Salomon5f33a8c2018-02-26 14:32:39 -0500257
Brian Salomonf30b1c12019-06-20 12:25:02 -0400258 struct SupportedRead {
Brian Salomonf30b1c12019-06-20 12:25:02 -0400259 GrColorType fColorType;
Brian Salomon42be09d2019-07-26 12:12:26 -0400260 // If the read is occurring using GrGpu::transferPixelsFrom then this provides the
261 // minimum alignment of the offset into the transfer buffer.
Greg Danielba88ab62019-07-26 09:14:01 -0400262 size_t fOffsetAlignmentForTransferBuffer;
Brian Salomonf30b1c12019-06-20 12:25:02 -0400263 };
264
Brian Salomon19eaf2d2018-03-19 16:06:44 -0400265 /**
Greg Daniel00fb7242019-07-18 14:28:01 -0400266 * 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 -0400267 * would like read into, this provides a legal color type that the caller may pass to
268 * GrGpu::readPixels(). The returned color type may differ from the passed dstColorType, in
269 * which case the caller must convert the read pixel data (see GrConvertPixels). When converting
270 * to dstColorType the swizzle in the returned struct should be applied. The caller must check
271 * the returned color type for kUnknown.
Brian Salomon19eaf2d2018-03-19 16:06:44 -0400272 */
Greg Danielba88ab62019-07-26 09:14:01 -0400273 SupportedRead supportedReadPixelsColorType(GrColorType srcColorType,
274 const GrBackendFormat& srcFormat,
275 GrColorType dstColorType) const;
Brian Salomon19eaf2d2018-03-19 16:06:44 -0400276
Brian Salomon1047a492019-07-02 12:25:21 -0400277 /**
278 * Do GrGpu::writePixels() and GrGpu::transferPixelsTo() support a src buffer where the row
279 * bytes is not equal to bpp * w?
280 */
281 bool writePixelsRowBytesSupport() const { return fWritePixelsRowBytesSupport; }
282 /**
283 * Does GrGpu::readPixels() support a dst buffer where the row bytes is not equal to bpp * w?
284 */
285 bool readPixelsRowBytesSupport() const { return fReadPixelsRowBytesSupport; }
286
Brian Salomone05ba5a2019-04-08 11:59:07 -0400287 /** Are transfer buffers (to textures and from surfaces) supported? */
288 bool transferBufferSupport() const { return fTransferBufferSupport; }
289
robertphillipscaef3452015-11-11 13:18:11 -0800290 bool suppressPrints() const { return fSuppressPrints; }
291
cdalton397536c2016-03-25 12:15:03 -0700292 size_t bufferMapThreshold() const {
293 SkASSERT(fBufferMapThreshold >= 0);
294 return fBufferMapThreshold;
joshualitt7224c862015-05-29 06:46:47 -0700295 }
bsalomon682c2692015-05-22 14:01:46 -0700296
Mike Kleinfc6c37b2016-09-27 09:34:10 -0400297 /** True in environments that will issue errors if memory uploaded to buffers
bsalomon7dea7b72015-08-19 08:26:51 -0700298 is not initialized (even if not read by draw calls). */
299 bool mustClearUploadedBufferData() const { return fMustClearUploadedBufferData; }
300
Kevin Lubick61a5f0a2019-03-28 09:47:15 -0400301 /** For some environments, there is a performance or safety concern to not
302 initializing textures. For example, with WebGL and Firefox, there is a large
303 performance hit to not doing it.
304 */
305 bool shouldInitializeTextures() const { return fShouldInitializeTextures; }
306
Greg Danielb2acf0a2018-09-12 09:17:11 -0400307 /** Returns true if the given backend supports importing AHardwareBuffers via the
308 * GrAHardwarebufferImageGenerator. This will only ever be supported on Android devices with API
309 * level >= 26.
310 * */
311 bool supportsAHardwareBufferImages() const { return fSupportsAHardwareBufferImages; }
312
Jim Van Verthfbdc0802017-05-02 16:15:53 -0400313 bool wireframeMode() const { return fWireframeMode; }
314
Brian Salomon9ff5acb2019-05-08 09:04:47 -0400315 /** Supports using GrFence. */
jvanverth84741b32016-09-30 08:39:02 -0700316 bool fenceSyncSupport() const { return fFenceSyncSupport; }
Brian Salomon9ff5acb2019-05-08 09:04:47 -0400317
318 /** Supports using GrSemaphore. */
319 bool semaphoreSupport() const { return fSemaphoreSupport; }
320
Brian Osman2c2bc112017-02-28 10:02:49 -0500321 bool crossContextTextureSupport() const { return fCrossContextTextureSupport; }
Brian Salomon467921e2017-03-06 16:17:12 -0500322 /**
Greg Daniel25af6712018-04-25 10:44:38 -0400323 * Returns whether or not we will be able to do a copy given the passed in params
324 */
Brian Salomonc67c31c2018-12-06 10:00:03 -0500325 bool canCopySurface(const GrSurfaceProxy* dst, const GrSurfaceProxy* src,
326 const SkIRect& srcRect, const SkIPoint& dstPoint) const;
Greg Daniel25af6712018-04-25 10:44:38 -0400327
Brian Salomonf7232642018-09-19 08:58:08 -0400328 bool dynamicStateArrayGeometryProcessorTextureSupport() const {
329 return fDynamicStateArrayGeometryProcessorTextureSupport;
330 }
331
Michael Ludwigc39d0c82019-01-15 10:03:43 -0500332 // Not all backends support clearing with a scissor test (e.g. Metal), this will always
333 // return true if performColorClearsAsDraws() returns true.
Michael Ludwiga21d1962019-01-11 15:26:22 -0500334 bool performPartialClearsAsDraws() const {
Michael Ludwigc39d0c82019-01-15 10:03:43 -0500335 return fPerformColorClearsAsDraws || fPerformPartialClearsAsDraws;
Michael Ludwiga21d1962019-01-11 15:26:22 -0500336 }
337
338 // Many drivers have issues with color clears.
Chris Daltona8fbeba2019-03-30 00:31:23 -0600339 bool performColorClearsAsDraws() const { return fPerformColorClearsAsDraws; }
Michael Ludwiga21d1962019-01-11 15:26:22 -0500340
Robert Phillips2f05a482019-11-25 09:54:43 -0500341 bool avoidLargeIndexBufferDraws() const { return fAvoidLargeIndexBufferDraws; }
342
Michael Ludwiga21d1962019-01-11 15:26:22 -0500343 /// Adreno 4xx devices experience an issue when there are a large number of stencil clip bit
344 /// clears. The minimal repro steps are not precisely known but drawing a rect with a stencil
345 /// op instead of using glClear seems to resolve the issue.
Chris Daltona8fbeba2019-03-30 00:31:23 -0600346 bool performStencilClearsAsDraws() const { return fPerformStencilClearsAsDraws; }
347
348 // Can we use coverage counting shortcuts to render paths? Coverage counting can cause artifacts
349 // along shared edges if care isn't taken to ensure both contours wind in the same direction.
350 bool allowCoverageCounting() const { return fAllowCoverageCounting; }
351
352 // Should we disable the CCPR code due to a faulty driver?
353 bool driverBlacklistCCPR() const { return fDriverBlacklistCCPR; }
Chris Dalton7c012082019-07-22 00:45:52 -0400354 bool driverBlacklistMSAACCPR() const { return fDriverBlacklistMSAACCPR; }
Ethan Nicholas56d19a52018-10-15 11:26:20 -0400355
Greg Daniel25af6712018-04-25 10:44:38 -0400356 /**
Brian Salomon1e03b6b12019-07-17 17:28:24 -0400357 * This is used to try to ensure a successful copy a dst in order to perform shader-based
358 * blending.
359 *
360 * fRectsMustMatch will be set to true if the copy operation must ensure that the src and dest
361 * rects are identical.
362 *
363 * fMustCopyWholeSrc will be set to true if copy rect must equal src's bounds.
364 *
365 * Caller will detect cases when copy cannot succeed and try copy-as-draw as a fallback.
Brian Salomon467921e2017-03-06 16:17:12 -0500366 */
Brian Salomon1e03b6b12019-07-17 17:28:24 -0400367 struct DstCopyRestrictions {
368 GrSurfaceProxy::RectsMustMatch fRectsMustMatch = GrSurfaceProxy::RectsMustMatch::kNo;
369 bool fMustCopyWholeSrc = false;
370 };
Greg Daniel0258c902019-08-01 13:08:33 -0400371 virtual DstCopyRestrictions getDstCopyRestrictions(const GrRenderTargetProxy* src,
372 GrColorType ct) const {
Brian Salomon1e03b6b12019-07-17 17:28:24 -0400373 return {};
374 }
Brian Salomon467921e2017-03-06 16:17:12 -0500375
Greg Daniel6fa62e22019-08-07 15:52:37 -0400376 bool validateSurfaceParams(const SkISize&, const GrBackendFormat&, GrPixelConfig,
377 GrRenderable renderable, int renderTargetSampleCnt,
378 GrMipMapped) const;
Brian Salomonbdecacf2018-02-02 20:32:49 -0500379
Greg Daniel627d0532019-07-08 16:48:14 -0400380 bool areColorTypeAndFormatCompatible(GrColorType grCT,
Robert Phillips1e2cb442019-07-02 15:51:28 -0400381 const GrBackendFormat& format) const {
Robert Phillips1e2cb442019-07-02 15:51:28 -0400382 if (GrColorType::kUnknown == grCT) {
383 return false;
384 }
385
Greg Daniel627d0532019-07-08 16:48:14 -0400386 return this->onAreColorTypeAndFormatCompatible(grCT, format);
Robert Phillips1e2cb442019-07-02 15:51:28 -0400387 }
Robert Phillipsc046ff02019-07-01 10:34:03 -0400388
Robert Phillipsfc711a22018-02-13 17:03:00 -0500389 // TODO: it seems like we could pass the full SkImageInfo and validate its colorSpace too
Brian Salomonf391d0f2018-12-14 09:18:50 -0500390 // Returns kUnknown if a valid config could not be determined.
Greg Daniel627d0532019-07-08 16:48:14 -0400391 GrPixelConfig getConfigFromBackendFormat(const GrBackendFormat& format,
392 GrColorType grCT) const {
393 if (GrColorType::kUnknown == grCT) {
394 return kUnknown_GrPixelConfig;
395 }
396
397 return this->onGetConfigFromBackendFormat(format, grCT);
398 }
Robert Phillipsdf6c7342019-12-16 13:40:51 -0500399 GrPixelConfig getConfigFromCompressedBackendFormat(const GrBackendFormat& format) const {
400 return this->onGetConfigFromCompressedBackendFormat(format);
401 }
Robert Phillipsfc711a22018-02-13 17:03:00 -0500402
Jim Van Verthb7f0b9c2018-10-22 14:12:03 -0400403 /**
Robert Phillips00c9f0d2019-08-02 17:17:35 -0400404 * Special method only for YUVA images. Returns a colortype that matches the backend format or
405 * kUnknown if a colortype could not be determined.
Jim Van Verth9bf81202018-10-30 15:53:36 -0400406 */
Robert Phillips00c9f0d2019-08-02 17:17:35 -0400407 virtual GrColorType getYUVAColorTypeFromBackendFormat(const GrBackendFormat&,
408 bool isAlphaChannel) const = 0;
Jim Van Verth9bf81202018-10-30 15:53:36 -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 Daniel14b57212019-12-17 16:18:06 -0500425 virtual GrSwizzle getReadSwizzle(const GrBackendFormat&, GrColorType) const = 0;
Greg Danieleb4a8272019-05-16 16:52:55 -0400426
427 /**
428 * Returns the GrSwizzle to use when outputting to a render target with the passed in
429 * GrBackendFormat and GrColorType.
430 */
431 virtual GrSwizzle getOutputSwizzle(const GrBackendFormat&, GrColorType) const = 0;
432
Adrienne Walker3ed33992018-05-15 11:44:34 -0700433 const GrDriverBugWorkarounds& workarounds() const { return fDriverBugWorkarounds; }
434
Brian Salomon947efe22019-07-16 15:36:11 -0400435 /**
436 * Given a possibly generic GrPixelConfig and a backend format return a specific
437 * GrPixelConfig.
438 */
439 GrPixelConfig makeConfigSpecific(GrPixelConfig config, const GrBackendFormat& format) const {
440 auto ct = GrPixelConfigToColorType(config);
441 auto result = this->getConfigFromBackendFormat(format, ct);
442 SkASSERT(config == result || AreConfigsCompatible(config, result));
443 return result;
444 }
445
Robert Phillips323471e2019-11-11 11:33:37 -0500446 /**
447 * Adds fields to the key to represent the sampler that will be created for the passed
448 * in parameters. Currently this extra keying is only needed when building a vulkan pipeline
449 * with immutable samplers.
450 */
451 virtual void addExtraSamplerKey(GrProcessorKeyBuilder*,
452 const GrSamplerState&,
453 const GrBackendFormat&) const {}
454
Robert Phillips03e4c952019-11-26 16:20:22 -0500455 virtual GrProgramDesc makeDesc(const GrRenderTarget*, const GrProgramInfo&) const = 0;
456
Robert Phillips0902c982019-07-16 07:47:56 -0400457#ifdef SK_DEBUG
458 // This is just a debugging entry point until we're weaned off of GrPixelConfig. It
459 // should be used to verify that the pixel config from user-level code (the genericConfig)
460 // is compatible with a pixel config we've computed from scratch (the specificConfig).
461 static bool AreConfigsCompatible(GrPixelConfig genericConfig, GrPixelConfig specificConfig);
462#endif
463
Robert Phillipsffe27292019-08-01 10:08:07 -0400464#if GR_TEST_UTILS
465 struct TestFormatColorTypeCombination {
466 GrColorType fColorType;
467 GrBackendFormat fFormat;
468 };
469
470 virtual std::vector<TestFormatColorTypeCombination> getTestingCombinations() const = 0;
471#endif
472
bsalomon@google.comc26d94f2013-03-25 18:19:00 +0000473protected:
Chris Dalton8367e112019-11-13 12:43:21 -0700474 // Subclasses must call this at the end of their init method in order to do final processing on
475 // the caps (including overrides requested by the client).
476 // NOTE: this method will only reduce the caps, never expand them.
477 void finishInitialization(const GrContextOptions& options);
bsalomon4ee6bd82015-05-27 13:23:23 -0700478
bungeman6bd52842016-10-27 09:30:08 -0700479 sk_sp<GrShaderCaps> fShaderCaps;
jvanverthe9c0fc62015-04-29 11:18:05 -0700480
joshualitt83bc2292015-06-18 14:18:02 -0700481 bool fNPOTTextureTileSupport : 1;
482 bool fMipMapSupport : 1;
joshualitt83bc2292015-06-18 14:18:02 -0700483 bool fReuseScratchTextures : 1;
robertphillips1b8e1b52015-06-24 06:54:10 -0700484 bool fReuseScratchBuffers : 1;
joshualitt83bc2292015-06-18 14:18:02 -0700485 bool fGpuTracingSupport : 1;
joshualitt83bc2292015-06-18 14:18:02 -0700486 bool fOversizedStencilSupport : 1;
487 bool fTextureBarrierSupport : 1;
Robert Phillips7f861922018-01-30 13:13:42 +0000488 bool fSampleLocationsSupport : 1;
csmartdalton2b5f2cb2016-06-10 14:06:32 -0700489 bool fMultisampleDisableSupport : 1;
Chris Dalton1d616352017-05-31 12:51:23 -0600490 bool fInstanceAttribSupport : 1;
Chris Dalton6ce447a2019-06-23 18:07:38 -0600491 bool fMixedSamplesSupport : 1;
Chris Daltonce425af2019-12-16 10:39:03 -0700492 bool fConservativeRasterSupport : 1;
Chris Daltond5d8a642019-08-08 15:29:20 -0600493 bool fMSAAResolvesAutomatically : 1;
Chris Dalton27059d32018-01-23 14:06:50 -0700494 bool fUsePrimitiveRestart : 1;
csmartdalton485a1202016-07-13 10:16:32 -0700495 bool fPreferClientSideDynamicBuffers : 1;
Chris Dalton344e9032017-12-11 15:42:09 -0700496 bool fPreferFullscreenClears : 1;
bsalomon7dea7b72015-08-19 08:26:51 -0700497 bool fMustClearUploadedBufferData : 1;
Kevin Lubick61a5f0a2019-03-28 09:47:15 -0400498 bool fShouldInitializeTextures : 1;
Greg Danielb2acf0a2018-09-12 09:17:11 -0400499 bool fSupportsAHardwareBufferImages : 1;
Brian Osman499bf1a2018-09-17 11:32:42 -0400500 bool fHalfFloatVertexAttributeSupport : 1;
Michael Ludwigf23a1522018-12-10 11:36:13 -0500501 bool fClampToBorderSupport : 1;
Michael Ludwiga21d1962019-01-11 15:26:22 -0500502 bool fPerformPartialClearsAsDraws : 1;
503 bool fPerformColorClearsAsDraws : 1;
Robert Phillips2f05a482019-11-25 09:54:43 -0500504 bool fAvoidLargeIndexBufferDraws : 1;
Michael Ludwiga21d1962019-01-11 15:26:22 -0500505 bool fPerformStencilClearsAsDraws : 1;
Chris Daltona8fbeba2019-03-30 00:31:23 -0600506 bool fAllowCoverageCounting : 1;
Brian Salomone05ba5a2019-04-08 11:59:07 -0400507 bool fTransferBufferSupport : 1;
Brian Salomon1047a492019-07-02 12:25:21 -0400508 bool fWritePixelsRowBytesSupport : 1;
509 bool fReadPixelsRowBytesSupport : 1;
robertphillips1b8e1b52015-06-24 06:54:10 -0700510
bsalomon63b21962014-11-05 07:05:34 -0800511 // Driver workaround
Chris Daltona8fbeba2019-03-30 00:31:23 -0600512 bool fDriverBlacklistCCPR : 1;
Chris Dalton7c012082019-07-22 00:45:52 -0400513 bool fDriverBlacklistMSAACCPR : 1;
Eric Karl5c779752017-05-08 12:02:07 -0700514 bool fAvoidStencilBuffers : 1;
Greg Daniel4374e962018-09-28 15:09:47 -0400515 bool fAvoidWritePixelsFastPath : 1;
bsalomon63b21962014-11-05 07:05:34 -0800516
Brian Salomon01b476a2018-01-23 11:06:41 -0500517 // ANGLE performance workaround
robertphillips63926682015-08-20 09:39:02 -0700518 bool fPreferVRAMUseOverFlushes : 1;
519
Chris Dalton0dffbab2019-03-27 13:08:50 -0600520 // On some platforms it's better to make more triangles than to use the sample mask (MSAA only).
521 bool fPreferTrianglesOverSampleMask : 1;
522
jvanverth84741b32016-09-30 08:39:02 -0700523 bool fFenceSyncSupport : 1;
Brian Salomon9ff5acb2019-05-08 09:04:47 -0400524 bool fSemaphoreSupport : 1;
ethannicholas28ef4452016-03-25 09:26:03 -0700525
Brian Salomonf7232642018-09-19 08:58:08 -0400526 // Requires fence sync support in GL.
Brian Osman2c2bc112017-02-28 10:02:49 -0500527 bool fCrossContextTextureSupport : 1;
528
Brian Salomonf7232642018-09-19 08:58:08 -0400529 // Not (yet) implemented in VK backend.
530 bool fDynamicStateArrayGeometryProcessorTextureSupport : 1;
531
cdalton8917d622015-05-06 13:40:21 -0700532 BlendEquationSupport fBlendEquationSupport;
cdalton1dd05422015-06-12 09:01:18 -0700533 uint32_t fAdvBlendEqBlacklist;
Greg Daniel3f1a98b2019-12-17 23:16:42 +0000534 GR_STATIC_ASSERT(kLast_GrBlendEquation < 32);
cdalton1dd05422015-06-12 09:01:18 -0700535
commit-bot@chromium.org160b4782014-05-05 12:32:37 +0000536 uint32_t fMapBufferFlags;
cdalton397536c2016-03-25 12:15:03 -0700537 int fBufferMapThreshold;
commit-bot@chromium.org160b4782014-05-05 12:32:37 +0000538
bsalomon@google.comc26d94f2013-03-25 18:19:00 +0000539 int fMaxRenderTargetSize;
Chris Dalton2612bae2018-02-22 13:41:37 -0700540 int fMaxPreferredRenderTargetSize;
bsalomon7dbd45d2016-03-23 10:40:53 -0700541 int fMaxVertexAttributes;
bsalomon@google.comc26d94f2013-03-25 18:19:00 +0000542 int fMaxTextureSize;
bsalomon8c07b7a2015-11-02 11:36:52 -0800543 int fMaxTileSize;
csmartdalton9bc11872016-08-09 12:42:47 -0700544 int fMaxWindowRectangles;
Chris Daltona1638a52019-06-24 11:54:24 -0600545 int fInternalMultisampleCount;
bsalomon@google.comc26d94f2013-03-25 18:19:00 +0000546
Adrienne Walker68314842018-05-14 14:02:53 -0700547 GrDriverBugWorkarounds fDriverBugWorkarounds;
548
egdanielbc127a32014-09-19 12:07:43 -0700549private:
Chris Dalton8367e112019-11-13 12:43:21 -0700550 void applyOptionsOverrides(const GrContextOptions& options);
551
Mike Kleinfc6c37b2016-09-27 09:34:10 -0400552 virtual void onApplyOptionsOverrides(const GrContextOptions&) {}
Brian Osman71a18892017-08-10 10:23:25 -0400553 virtual void onDumpJSON(SkJSONWriter*) const {}
Brian Salomonc67c31c2018-12-06 10:00:03 -0500554 virtual bool onSurfaceSupportsWritePixels(const GrSurface*) const = 0;
555 virtual bool onCanCopySurface(const GrSurfaceProxy* dst, const GrSurfaceProxy* src,
556 const SkIRect& srcRect, const SkIPoint& dstPoint) const = 0;
Robert Phillips0a15cc62019-07-30 12:49:10 -0400557 virtual GrBackendFormat onGetDefaultBackendFormat(GrColorType, GrRenderable) const = 0;
egdanielb7e7d572015-11-04 04:23:53 -0800558
Greg Daniel2a303902018-02-20 10:25:54 -0500559 // Backends should implement this if they have any extra requirements for use of window
560 // rectangles for a specific GrBackendRenderTarget outside of basic support.
561 virtual bool onIsWindowRectanglesSupportedForRT(const GrBackendRenderTarget&) const {
562 return true;
563 }
564
Greg Daniel627d0532019-07-08 16:48:14 -0400565 virtual GrPixelConfig onGetConfigFromBackendFormat(const GrBackendFormat& format,
566 GrColorType ct) const = 0;
Robert Phillipsdf6c7342019-12-16 13:40:51 -0500567 virtual GrPixelConfig onGetConfigFromCompressedBackendFormat(const GrBackendFormat&) const = 0;
Greg Daniel627d0532019-07-08 16:48:14 -0400568
569 virtual bool onAreColorTypeAndFormatCompatible(GrColorType, const GrBackendFormat&) const = 0;
570
Greg Danielba88ab62019-07-26 09:14:01 -0400571 virtual SupportedRead onSupportedReadPixelsColorType(GrColorType srcColorType,
572 const GrBackendFormat& srcFormat,
573 GrColorType dstColorType) const = 0;
574
Greg Daniel627d0532019-07-08 16:48:14 -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
bsalomon@google.comc26d94f2013-03-25 18:19:00 +0000579 typedef SkRefCnt INHERITED;
580};
581
582#endif