blob: b81e3c027c8325880d106a6caac2316063401520 [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 Dalton1215cda2019-12-17 21:44:04 -070057 bool wireframeSupport() const { return fWireframeSupport; }
Chris Daltond5d8a642019-08-08 15:29:20 -060058 // This flag indicates that we never have to resolve MSAA. In practice, it means that we have
59 // an MSAA-render-to-texture extension: Any render target we create internally will use the
60 // extension, and any wrapped render target is the client's responsibility.
61 bool msaaResolvesAutomatically() const { return fMSAAResolvesAutomatically; }
Brian Osman499bf1a2018-09-17 11:32:42 -040062 bool halfFloatVertexAttributeSupport() const { return fHalfFloatVertexAttributeSupport; }
Chris Dalton27059d32018-01-23 14:06:50 -070063
64 // Primitive restart functionality is core in ES 3.0, but using it will cause slowdowns on some
65 // systems. This cap is only set if primitive restart will improve performance.
66 bool usePrimitiveRestart() const { return fUsePrimitiveRestart; }
67
csmartdalton485a1202016-07-13 10:16:32 -070068 bool preferClientSideDynamicBuffers() const { return fPreferClientSideDynamicBuffers; }
robertphillips@google.com2d2e5c42013-10-30 21:30:43 +000069
Chris Dalton344e9032017-12-11 15:42:09 -070070 // On tilers, an initial fullscreen clear is an OPTIMIZATION. It allows the hardware to
71 // initialize each tile with a constant value rather than loading each pixel from memory.
72 bool preferFullscreenClears() const { return fPreferFullscreenClears; }
73
Chris Dalton674f77a2019-09-30 20:49:39 -060074 // Should we discard stencil values after a render pass? (Tilers get better performance if we
75 // always load stencil buffers with a "clear" op, and then discard the content when finished.)
76 bool discardStencilValuesAfterRenderPass() const {
77 // This method is actually just a duplicate of preferFullscreenClears(), with a descriptive
78 // name for the sake of readability.
79 return this->preferFullscreenClears();
80 }
81
robertphillips63926682015-08-20 09:39:02 -070082 bool preferVRAMUseOverFlushes() const { return fPreferVRAMUseOverFlushes; }
83
Chris Dalton0dffbab2019-03-27 13:08:50 -060084 bool preferTrianglesOverSampleMask() const { return fPreferTrianglesOverSampleMask; }
85
Eric Karl5c779752017-05-08 12:02:07 -070086 bool avoidStencilBuffers() const { return fAvoidStencilBuffers; }
87
Greg Daniel4374e962018-09-28 15:09:47 -040088 bool avoidWritePixelsFastPath() const { return fAvoidWritePixelsFastPath; }
89
csmartdaltone0d36292016-07-29 08:14:20 -070090 /**
cdalton8917d622015-05-06 13:40:21 -070091 * Indicates the capabilities of the fixed function blend unit.
92 */
93 enum BlendEquationSupport {
94 kBasic_BlendEquationSupport, //<! Support to select the operator that
95 // combines src and dst terms.
96 kAdvanced_BlendEquationSupport, //<! Additional fixed function support for specific
97 // SVG/PDF blend modes. Requires blend barriers.
98 kAdvancedCoherent_BlendEquationSupport, //<! Advanced blend equation support that does not
99 // require blend barriers, and permits overlap.
100
101 kLast_BlendEquationSupport = kAdvancedCoherent_BlendEquationSupport
102 };
103
104 BlendEquationSupport blendEquationSupport() const { return fBlendEquationSupport; }
105
106 bool advancedBlendEquationSupport() const {
107 return fBlendEquationSupport >= kAdvanced_BlendEquationSupport;
108 }
109
110 bool advancedCoherentBlendEquationSupport() const {
111 return kAdvancedCoherent_BlendEquationSupport == fBlendEquationSupport;
112 }
113
Chris Dalton302d5be2019-01-22 23:41:25 -0700114 bool isAdvancedBlendEquationBlacklisted(GrBlendEquation equation) const {
cdalton1dd05422015-06-12 09:01:18 -0700115 SkASSERT(GrBlendEquationIsAdvanced(equation));
Chris Dalton302d5be2019-01-22 23:41:25 -0700116 SkASSERT(this->advancedBlendEquationSupport());
cdalton1dd05422015-06-12 09:01:18 -0700117 return SkToBool(fAdvBlendEqBlacklist & (1 << equation));
118 }
119
cdalton8917d622015-05-06 13:40:21 -0700120 /**
commit-bot@chromium.org160b4782014-05-05 12:32:37 +0000121 * Indicates whether GPU->CPU memory mapping for GPU resources such as vertex buffers and
122 * textures allows partial mappings or full mappings.
123 */
124 enum MapFlags {
Brian Salomon105d7c22019-04-16 13:46:14 -0400125 kNone_MapFlags = 0x0, //<! Cannot map the resource.
commit-bot@chromium.org160b4782014-05-05 12:32:37 +0000126
Brian Salomon105d7c22019-04-16 13:46:14 -0400127 kCanMap_MapFlag = 0x1, //<! The resource can be mapped. Must be set for any of
128 // the other flags to have meaning.
129 kSubset_MapFlag = 0x2, //<! The resource can be partially mapped.
Greg Daniel2d41d0d2019-08-26 11:08:51 -0400130 kAsyncRead_MapFlag = 0x4, //<! Are maps for reading asynchronous WRT GrOpsRenderPass
Brian Salomon105d7c22019-04-16 13:46:14 -0400131 // submitted to GrGpu.
commit-bot@chromium.org160b4782014-05-05 12:32:37 +0000132 };
133
134 uint32_t mapBufferFlags() const { return fMapBufferFlags; }
135
robertphillips@google.com2d2e5c42013-10-30 21:30:43 +0000136 // Scratch textures not being reused means that those scratch textures
skia.committer@gmail.com7ed98df2013-10-31 07:01:53 +0000137 // that we upload to (i.e., don't have a render target) will not be
robertphillips@google.com2d2e5c42013-10-30 21:30:43 +0000138 // recycled in the texture cache. This is to prevent ghosting by drivers
139 // (in particular for deferred architectures).
commit-bot@chromium.orgb8356522013-07-18 22:26:39 +0000140 bool reuseScratchTextures() const { return fReuseScratchTextures; }
robertphillips1b8e1b52015-06-24 06:54:10 -0700141 bool reuseScratchBuffers() const { return fReuseScratchBuffers; }
bsalomon@google.comc26d94f2013-03-25 18:19:00 +0000142
bsalomon7dbd45d2016-03-23 10:40:53 -0700143 /// maximum number of attribute values per vertex
144 int maxVertexAttributes() const { return fMaxVertexAttributes; }
145
bsalomon@google.comc26d94f2013-03-25 18:19:00 +0000146 int maxRenderTargetSize() const { return fMaxRenderTargetSize; }
Chris Dalton2612bae2018-02-22 13:41:37 -0700147
148 /** This is the largest render target size that can be used without incurring extra perfomance
149 cost. It is usually the max RT size, unless larger render targets are known to be slower. */
150 int maxPreferredRenderTargetSize() const { return fMaxPreferredRenderTargetSize; }
151
bsalomon@google.comc26d94f2013-03-25 18:19:00 +0000152 int maxTextureSize() const { return fMaxTextureSize; }
Chris Dalton2612bae2018-02-22 13:41:37 -0700153
bsalomon8c07b7a2015-11-02 11:36:52 -0800154 /** This is the maximum tile size to use by GPU devices for rendering sw-backed images/bitmaps.
155 It is usually the max texture size, unless we're overriding it for testing. */
Brian Salomonc7fe0f72018-05-11 10:14:21 -0400156 int maxTileSize() const {
157 SkASSERT(fMaxTileSize <= fMaxTextureSize);
158 return fMaxTileSize;
159 }
bsalomonc59a1df2015-06-01 07:13:42 -0700160
csmartdalton9bc11872016-08-09 12:42:47 -0700161 int maxWindowRectangles() const { return fMaxWindowRectangles; }
bsalomon@google.comc26d94f2013-03-25 18:19:00 +0000162
Greg Daniel2a303902018-02-20 10:25:54 -0500163 // Returns whether mixed samples is supported for the given backend render target.
164 bool isWindowRectanglesSupportedForRT(const GrBackendRenderTarget& rt) const {
165 return this->maxWindowRectangles() > 0 && this->onIsWindowRectanglesSupportedForRT(rt);
166 }
167
Robert Phillipsf209e882019-06-25 15:59:50 -0400168 virtual bool isFormatSRGB(const GrBackendFormat&) const = 0;
Greg Daniela00bcad2019-10-11 13:21:48 -0400169
Robert Phillipsd6df7b52019-12-13 11:17:46 -0500170 // This will return SkImage::CompressionType::kNone if the backend format is not compressed.
171 virtual SkImage::CompressionType compressionType(const GrBackendFormat&) const = 0;
172
173 bool isFormatCompressed(const GrBackendFormat& format) const {
174 return this->compressionType(format) != SkImage::CompressionType::kNone;
175 }
Robert Phillipsf209e882019-06-25 15:59:50 -0400176
Greg Daniel7bfc9132019-08-14 14:23:53 -0400177 // TODO: Once we use the supportWritePixels call for uploads, we can remove this function and
178 // instead only have the version that takes a GrBackendFormat.
179 virtual bool isFormatTexturableAndUploadable(GrColorType, const GrBackendFormat&) const = 0;
180 // Can a texture be made with the GrBackendFormat, and then be bound and sampled in a shader.
181 virtual bool isFormatTexturable(const GrBackendFormat&) const = 0;
Brian Salomonbdecacf2018-02-02 20:32:49 -0500182
Greg Daniel6980c4e2019-07-30 16:18:18 -0400183 // Returns whether a texture of the given format can be copied to a texture of the same format.
184 virtual bool isFormatCopyable(const GrBackendFormat&) const = 0;
Brian Salomonbdecacf2018-02-02 20:32:49 -0500185
Greg Danieleadfac92019-08-02 09:03:53 -0400186 // Returns the maximum supported sample count for a format. 0 means the format is not renderable
187 // 1 means the format is renderable but doesn't support MSAA. This call only refers to the
188 // format itself. A caller should also confirm if the format is renderable with a given
189 // GrColorType by calling isFormatRenderable.
190 virtual int maxRenderTargetSampleCount(const GrBackendFormat&) const = 0;
Brian Salomonbdecacf2018-02-02 20:32:49 -0500191
Chris Dalton1e6c5b82019-06-17 14:16:49 -0600192 // Returns the number of samples to use when performing internal draws to the given config with
Chris Daltona1638a52019-06-24 11:54:24 -0600193 // MSAA or mixed samples. If 0, Ganesh should not attempt to use internal multisampling.
Greg Danieleadfac92019-08-02 09:03:53 -0400194 int internalMultisampleCount(const GrBackendFormat& format) const {
195 return SkTMin(fInternalMultisampleCount, this->maxRenderTargetSampleCount(format));
Chris Dalton1e6c5b82019-06-17 14:16:49 -0600196 }
197
Greg Daniel900583a2019-08-06 12:05:31 -0400198 virtual bool isFormatAsColorTypeRenderable(GrColorType ct, const GrBackendFormat& format,
199 int sampleCount = 1) const = 0;
200
201 virtual bool isFormatRenderable(const GrBackendFormat& format, int sampleCount) const = 0;
Brian Salomonbdecacf2018-02-02 20:32:49 -0500202
203 // Find a sample count greater than or equal to the requested count which is supported for a
Greg Daniel6fa62e22019-08-07 15:52:37 -0400204 // 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 -0500205 // sample count is 1 then 1 will be returned if non-MSAA rendering is supported, otherwise 0.
206 // For historical reasons requestedCount==0 is handled identically to requestedCount==1.
Greg Daniel6fa62e22019-08-07 15:52:37 -0400207 virtual int getRenderTargetSampleCount(int requestedCount, const GrBackendFormat&) const = 0;
commit-bot@chromium.org42dc8132014-05-27 19:26:59 +0000208
Greg Daniel7fd7a8a2019-10-10 16:10:31 -0400209 // Returns the number of bytes per pixel for the given GrBackendFormat. This is only supported
210 // for "normal" formats. For compressed formats this will return 0.
211 virtual size_t bytesPerPixel(const GrBackendFormat&) const = 0;
212
Brian Salomon5f33a8c2018-02-26 14:32:39 -0500213 /**
Brian Salomon3d86a192018-02-27 16:46:11 -0500214 * Backends may have restrictions on what types of surfaces support GrGpu::writePixels().
215 * If this returns false then the caller should implement a fallback where a temporary texture
216 * 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 -0500217 */
Brian Salomonc67c31c2018-12-06 10:00:03 -0500218 bool surfaceSupportsWritePixels(const GrSurface*) const;
Brian Salomon19eaf2d2018-03-19 16:06:44 -0400219
Emircan Uysaler23ca4e72019-06-24 10:53:09 -0400220 /**
Brian Salomondc0710f2019-07-01 14:59:32 -0400221 * Indicates whether surface supports GrGpu::readPixels, must be copied, or cannot be read.
Emircan Uysaler23ca4e72019-06-24 10:53:09 -0400222 */
Brian Salomondc0710f2019-07-01 14:59:32 -0400223 enum class SurfaceReadPixelsSupport {
224 /** GrGpu::readPixels is supported by the surface. */
225 kSupported,
226 /**
227 * GrGpu::readPixels is not supported by this surface but this surface can be drawn
228 * or copied to a Ganesh-created GrTextureType::kTexture2D and then that surface will be
229 * readable.
230 */
231 kCopyToTexture2D,
232 /**
233 * Not supported
234 */
235 kUnsupported,
Emircan Uysaler23ca4e72019-06-24 10:53:09 -0400236 };
Brian Salomon19eaf2d2018-03-19 16:06:44 -0400237 /**
Brian Salomondc0710f2019-07-01 14:59:32 -0400238 * Backends may have restrictions on what types of surfaces support GrGpu::readPixels(). We may
239 * either be able to read directly from the surface, read from a copy of the surface, or not
240 * read at all.
Brian Salomon19eaf2d2018-03-19 16:06:44 -0400241 */
Brian Salomondc0710f2019-07-01 14:59:32 -0400242 virtual SurfaceReadPixelsSupport surfaceSupportsReadPixels(const GrSurface*) const = 0;
Brian Salomon5f33a8c2018-02-26 14:32:39 -0500243
Brian Salomon42be09d2019-07-26 12:12:26 -0400244 struct SupportedWrite {
245 GrColorType fColorType;
246 // If the write is occurring using GrGpu::transferPixelsTo then this provides the
247 // minimum alignment of the offset into the transfer buffer.
248 size_t fOffsetAlignmentForTransferBuffer;
249 };
250
Brian Salomon5f33a8c2018-02-26 14:32:39 -0500251 /**
252 * Given a dst pixel config and a src color type what color type must the caller coax the
253 * the data into in order to use GrGpu::writePixels().
254 */
Brian Salomon01915c02019-08-02 09:57:21 -0400255 virtual SupportedWrite supportedWritePixelsColorType(GrColorType surfaceColorType,
256 const GrBackendFormat& surfaceFormat,
Brian Salomon42be09d2019-07-26 12:12:26 -0400257 GrColorType srcColorType) const = 0;
Brian Salomon5f33a8c2018-02-26 14:32:39 -0500258
Brian Salomonf30b1c12019-06-20 12:25:02 -0400259 struct SupportedRead {
Brian Salomonf30b1c12019-06-20 12:25:02 -0400260 GrColorType fColorType;
Brian Salomon42be09d2019-07-26 12:12:26 -0400261 // If the read is occurring using GrGpu::transferPixelsFrom then this provides the
262 // minimum alignment of the offset into the transfer buffer.
Greg Danielba88ab62019-07-26 09:14:01 -0400263 size_t fOffsetAlignmentForTransferBuffer;
Brian Salomonf30b1c12019-06-20 12:25:02 -0400264 };
265
Brian Salomon19eaf2d2018-03-19 16:06:44 -0400266 /**
Greg Daniel00fb7242019-07-18 14:28:01 -0400267 * 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 -0400268 * would like read into, this provides a legal color type that the caller may pass to
269 * GrGpu::readPixels(). The returned color type may differ from the passed dstColorType, in
270 * which case the caller must convert the read pixel data (see GrConvertPixels). When converting
271 * to dstColorType the swizzle in the returned struct should be applied. The caller must check
272 * the returned color type for kUnknown.
Brian Salomon19eaf2d2018-03-19 16:06:44 -0400273 */
Greg Danielba88ab62019-07-26 09:14:01 -0400274 SupportedRead supportedReadPixelsColorType(GrColorType srcColorType,
275 const GrBackendFormat& srcFormat,
276 GrColorType dstColorType) const;
Brian Salomon19eaf2d2018-03-19 16:06:44 -0400277
Brian Salomon1047a492019-07-02 12:25:21 -0400278 /**
279 * Do GrGpu::writePixels() and GrGpu::transferPixelsTo() support a src buffer where the row
280 * bytes is not equal to bpp * w?
281 */
282 bool writePixelsRowBytesSupport() const { return fWritePixelsRowBytesSupport; }
283 /**
284 * Does GrGpu::readPixels() support a dst buffer where the row bytes is not equal to bpp * w?
285 */
286 bool readPixelsRowBytesSupport() const { return fReadPixelsRowBytesSupport; }
287
Brian Salomone05ba5a2019-04-08 11:59:07 -0400288 /** Are transfer buffers (to textures and from surfaces) supported? */
289 bool transferBufferSupport() const { return fTransferBufferSupport; }
290
robertphillipscaef3452015-11-11 13:18:11 -0800291 bool suppressPrints() const { return fSuppressPrints; }
292
cdalton397536c2016-03-25 12:15:03 -0700293 size_t bufferMapThreshold() const {
294 SkASSERT(fBufferMapThreshold >= 0);
295 return fBufferMapThreshold;
joshualitt7224c862015-05-29 06:46:47 -0700296 }
bsalomon682c2692015-05-22 14:01:46 -0700297
Mike Kleinfc6c37b2016-09-27 09:34:10 -0400298 /** True in environments that will issue errors if memory uploaded to buffers
bsalomon7dea7b72015-08-19 08:26:51 -0700299 is not initialized (even if not read by draw calls). */
300 bool mustClearUploadedBufferData() const { return fMustClearUploadedBufferData; }
301
Kevin Lubick61a5f0a2019-03-28 09:47:15 -0400302 /** For some environments, there is a performance or safety concern to not
303 initializing textures. For example, with WebGL and Firefox, there is a large
304 performance hit to not doing it.
305 */
306 bool shouldInitializeTextures() const { return fShouldInitializeTextures; }
307
Greg Danielb2acf0a2018-09-12 09:17:11 -0400308 /** Returns true if the given backend supports importing AHardwareBuffers via the
309 * GrAHardwarebufferImageGenerator. This will only ever be supported on Android devices with API
310 * level >= 26.
311 * */
312 bool supportsAHardwareBufferImages() const { return fSupportsAHardwareBufferImages; }
313
Jim Van Verthfbdc0802017-05-02 16:15:53 -0400314 bool wireframeMode() const { return fWireframeMode; }
315
Brian Salomon9ff5acb2019-05-08 09:04:47 -0400316 /** Supports using GrFence. */
jvanverth84741b32016-09-30 08:39:02 -0700317 bool fenceSyncSupport() const { return fFenceSyncSupport; }
Brian Salomon9ff5acb2019-05-08 09:04:47 -0400318
319 /** Supports using GrSemaphore. */
320 bool semaphoreSupport() const { return fSemaphoreSupport; }
321
Brian Osman2c2bc112017-02-28 10:02:49 -0500322 bool crossContextTextureSupport() const { return fCrossContextTextureSupport; }
Brian Salomon467921e2017-03-06 16:17:12 -0500323 /**
Greg Daniel25af6712018-04-25 10:44:38 -0400324 * Returns whether or not we will be able to do a copy given the passed in params
325 */
Brian Salomonc67c31c2018-12-06 10:00:03 -0500326 bool canCopySurface(const GrSurfaceProxy* dst, const GrSurfaceProxy* src,
327 const SkIRect& srcRect, const SkIPoint& dstPoint) const;
Greg Daniel25af6712018-04-25 10:44:38 -0400328
Brian Salomonf7232642018-09-19 08:58:08 -0400329 bool dynamicStateArrayGeometryProcessorTextureSupport() const {
330 return fDynamicStateArrayGeometryProcessorTextureSupport;
331 }
332
Michael Ludwigc39d0c82019-01-15 10:03:43 -0500333 // Not all backends support clearing with a scissor test (e.g. Metal), this will always
334 // return true if performColorClearsAsDraws() returns true.
Michael Ludwiga21d1962019-01-11 15:26:22 -0500335 bool performPartialClearsAsDraws() const {
Michael Ludwigc39d0c82019-01-15 10:03:43 -0500336 return fPerformColorClearsAsDraws || fPerformPartialClearsAsDraws;
Michael Ludwiga21d1962019-01-11 15:26:22 -0500337 }
338
339 // Many drivers have issues with color clears.
Chris Daltona8fbeba2019-03-30 00:31:23 -0600340 bool performColorClearsAsDraws() const { return fPerformColorClearsAsDraws; }
Michael Ludwiga21d1962019-01-11 15:26:22 -0500341
Robert Phillips2f05a482019-11-25 09:54:43 -0500342 bool avoidLargeIndexBufferDraws() const { return fAvoidLargeIndexBufferDraws; }
343
Michael Ludwiga21d1962019-01-11 15:26:22 -0500344 /// Adreno 4xx devices experience an issue when there are a large number of stencil clip bit
345 /// clears. The minimal repro steps are not precisely known but drawing a rect with a stencil
346 /// op instead of using glClear seems to resolve the issue.
Chris Daltona8fbeba2019-03-30 00:31:23 -0600347 bool performStencilClearsAsDraws() const { return fPerformStencilClearsAsDraws; }
348
349 // Can we use coverage counting shortcuts to render paths? Coverage counting can cause artifacts
350 // along shared edges if care isn't taken to ensure both contours wind in the same direction.
351 bool allowCoverageCounting() const { return fAllowCoverageCounting; }
352
353 // Should we disable the CCPR code due to a faulty driver?
354 bool driverBlacklistCCPR() const { return fDriverBlacklistCCPR; }
Chris Dalton7c012082019-07-22 00:45:52 -0400355 bool driverBlacklistMSAACCPR() const { return fDriverBlacklistMSAACCPR; }
Ethan Nicholas56d19a52018-10-15 11:26:20 -0400356
Greg Daniel25af6712018-04-25 10:44:38 -0400357 /**
Brian Salomon1e03b6b12019-07-17 17:28:24 -0400358 * This is used to try to ensure a successful copy a dst in order to perform shader-based
359 * blending.
360 *
361 * fRectsMustMatch will be set to true if the copy operation must ensure that the src and dest
362 * rects are identical.
363 *
364 * fMustCopyWholeSrc will be set to true if copy rect must equal src's bounds.
365 *
366 * Caller will detect cases when copy cannot succeed and try copy-as-draw as a fallback.
Brian Salomon467921e2017-03-06 16:17:12 -0500367 */
Brian Salomon1e03b6b12019-07-17 17:28:24 -0400368 struct DstCopyRestrictions {
369 GrSurfaceProxy::RectsMustMatch fRectsMustMatch = GrSurfaceProxy::RectsMustMatch::kNo;
370 bool fMustCopyWholeSrc = false;
371 };
Greg Daniel0258c902019-08-01 13:08:33 -0400372 virtual DstCopyRestrictions getDstCopyRestrictions(const GrRenderTargetProxy* src,
373 GrColorType ct) const {
Brian Salomon1e03b6b12019-07-17 17:28:24 -0400374 return {};
375 }
Brian Salomon467921e2017-03-06 16:17:12 -0500376
Greg Daniel6fa62e22019-08-07 15:52:37 -0400377 bool validateSurfaceParams(const SkISize&, const GrBackendFormat&, GrPixelConfig,
378 GrRenderable renderable, int renderTargetSampleCnt,
379 GrMipMapped) const;
Brian Salomonbdecacf2018-02-02 20:32:49 -0500380
Greg Daniel627d0532019-07-08 16:48:14 -0400381 bool areColorTypeAndFormatCompatible(GrColorType grCT,
Robert Phillips1e2cb442019-07-02 15:51:28 -0400382 const GrBackendFormat& format) const {
Robert Phillips1e2cb442019-07-02 15:51:28 -0400383 if (GrColorType::kUnknown == grCT) {
384 return false;
385 }
386
Greg Daniel627d0532019-07-08 16:48:14 -0400387 return this->onAreColorTypeAndFormatCompatible(grCT, format);
Robert Phillips1e2cb442019-07-02 15:51:28 -0400388 }
Robert Phillipsc046ff02019-07-01 10:34:03 -0400389
Robert Phillipsfc711a22018-02-13 17:03:00 -0500390 // TODO: it seems like we could pass the full SkImageInfo and validate its colorSpace too
Brian Salomonf391d0f2018-12-14 09:18:50 -0500391 // Returns kUnknown if a valid config could not be determined.
Greg Daniel627d0532019-07-08 16:48:14 -0400392 GrPixelConfig getConfigFromBackendFormat(const GrBackendFormat& format,
393 GrColorType grCT) const {
394 if (GrColorType::kUnknown == grCT) {
395 return kUnknown_GrPixelConfig;
396 }
397
398 return this->onGetConfigFromBackendFormat(format, grCT);
399 }
Robert Phillipsdf6c7342019-12-16 13:40:51 -0500400 GrPixelConfig getConfigFromCompressedBackendFormat(const GrBackendFormat& format) const {
401 return this->onGetConfigFromCompressedBackendFormat(format);
402 }
Robert Phillipsfc711a22018-02-13 17:03:00 -0500403
Jim Van Verthb7f0b9c2018-10-22 14:12:03 -0400404 /**
Robert Phillips00c9f0d2019-08-02 17:17:35 -0400405 * Special method only for YUVA images. Returns a colortype that matches the backend format or
406 * kUnknown if a colortype could not be determined.
Jim Van Verth9bf81202018-10-30 15:53:36 -0400407 */
Robert Phillips00c9f0d2019-08-02 17:17:35 -0400408 virtual GrColorType getYUVAColorTypeFromBackendFormat(const GrBackendFormat&,
409 bool isAlphaChannel) const = 0;
Jim Van Verth9bf81202018-10-30 15:53:36 -0400410
Brian Salomonf391d0f2018-12-14 09:18:50 -0500411 /** These are used when creating a new texture internally. */
Robert Phillips0a15cc62019-07-30 12:49:10 -0400412 GrBackendFormat getDefaultBackendFormat(GrColorType, GrRenderable) const;
Greg Daniel4065d452018-11-16 15:43:41 -0500413
Brian Salomonbb8dde82019-06-27 10:52:13 -0400414 virtual GrBackendFormat getBackendFormatFromCompressionType(SkImage::CompressionType) const = 0;
415
Timothy Liang036fdfe2018-06-28 15:50:36 -0400416 /**
Michael Ludwigf23a1522018-12-10 11:36:13 -0500417 * The CLAMP_TO_BORDER wrap mode for texture coordinates was added to desktop GL in 1.3, and
418 * GLES 3.2, but is also available in extensions. Vulkan and Metal always have support.
419 */
420 bool clampToBorderSupport() const { return fClampToBorderSupport; }
421
Greg Danieleb4a8272019-05-16 16:52:55 -0400422 /**
Greg Daniel14b57212019-12-17 16:18:06 -0500423 * Returns the GrSwizzle to use when sampling or reading back from a texture with the passed in
424 * GrBackendFormat and GrColorType.
Greg Danieleb4a8272019-05-16 16:52:55 -0400425 */
Greg Daniel14b57212019-12-17 16:18:06 -0500426 virtual GrSwizzle getReadSwizzle(const GrBackendFormat&, GrColorType) const = 0;
Greg Danieleb4a8272019-05-16 16:52:55 -0400427
428 /**
429 * Returns the GrSwizzle to use when outputting to a render target with the passed in
430 * GrBackendFormat and GrColorType.
431 */
432 virtual GrSwizzle getOutputSwizzle(const GrBackendFormat&, GrColorType) const = 0;
433
Adrienne Walker3ed33992018-05-15 11:44:34 -0700434 const GrDriverBugWorkarounds& workarounds() const { return fDriverBugWorkarounds; }
435
Brian Salomon947efe22019-07-16 15:36:11 -0400436 /**
437 * Given a possibly generic GrPixelConfig and a backend format return a specific
438 * GrPixelConfig.
439 */
440 GrPixelConfig makeConfigSpecific(GrPixelConfig config, const GrBackendFormat& format) const {
441 auto ct = GrPixelConfigToColorType(config);
442 auto result = this->getConfigFromBackendFormat(format, ct);
443 SkASSERT(config == result || AreConfigsCompatible(config, result));
444 return result;
445 }
446
Robert Phillips323471e2019-11-11 11:33:37 -0500447 /**
448 * Adds fields to the key to represent the sampler that will be created for the passed
449 * in parameters. Currently this extra keying is only needed when building a vulkan pipeline
450 * with immutable samplers.
451 */
452 virtual void addExtraSamplerKey(GrProcessorKeyBuilder*,
453 const GrSamplerState&,
454 const GrBackendFormat&) const {}
455
Robert Phillips03e4c952019-11-26 16:20:22 -0500456 virtual GrProgramDesc makeDesc(const GrRenderTarget*, const GrProgramInfo&) const = 0;
457
Robert Phillips0902c982019-07-16 07:47:56 -0400458#ifdef SK_DEBUG
459 // This is just a debugging entry point until we're weaned off of GrPixelConfig. It
460 // should be used to verify that the pixel config from user-level code (the genericConfig)
461 // is compatible with a pixel config we've computed from scratch (the specificConfig).
462 static bool AreConfigsCompatible(GrPixelConfig genericConfig, GrPixelConfig specificConfig);
463#endif
464
Robert Phillipsffe27292019-08-01 10:08:07 -0400465#if GR_TEST_UTILS
466 struct TestFormatColorTypeCombination {
467 GrColorType fColorType;
468 GrBackendFormat fFormat;
469 };
470
471 virtual std::vector<TestFormatColorTypeCombination> getTestingCombinations() const = 0;
472#endif
473
bsalomon@google.comc26d94f2013-03-25 18:19:00 +0000474protected:
Chris Dalton8367e112019-11-13 12:43:21 -0700475 // Subclasses must call this at the end of their init method in order to do final processing on
476 // the caps (including overrides requested by the client).
477 // NOTE: this method will only reduce the caps, never expand them.
478 void finishInitialization(const GrContextOptions& options);
bsalomon4ee6bd82015-05-27 13:23:23 -0700479
bungeman6bd52842016-10-27 09:30:08 -0700480 sk_sp<GrShaderCaps> fShaderCaps;
jvanverthe9c0fc62015-04-29 11:18:05 -0700481
joshualitt83bc2292015-06-18 14:18:02 -0700482 bool fNPOTTextureTileSupport : 1;
483 bool fMipMapSupport : 1;
joshualitt83bc2292015-06-18 14:18:02 -0700484 bool fReuseScratchTextures : 1;
robertphillips1b8e1b52015-06-24 06:54:10 -0700485 bool fReuseScratchBuffers : 1;
joshualitt83bc2292015-06-18 14:18:02 -0700486 bool fGpuTracingSupport : 1;
joshualitt83bc2292015-06-18 14:18:02 -0700487 bool fOversizedStencilSupport : 1;
488 bool fTextureBarrierSupport : 1;
Robert Phillips7f861922018-01-30 13:13:42 +0000489 bool fSampleLocationsSupport : 1;
csmartdalton2b5f2cb2016-06-10 14:06:32 -0700490 bool fMultisampleDisableSupport : 1;
Chris Dalton1d616352017-05-31 12:51:23 -0600491 bool fInstanceAttribSupport : 1;
Chris Dalton6ce447a2019-06-23 18:07:38 -0600492 bool fMixedSamplesSupport : 1;
Chris Daltonce425af2019-12-16 10:39:03 -0700493 bool fConservativeRasterSupport : 1;
Chris Dalton1215cda2019-12-17 21:44:04 -0700494 bool fWireframeSupport : 1;
Chris Daltond5d8a642019-08-08 15:29:20 -0600495 bool fMSAAResolvesAutomatically : 1;
Chris Dalton27059d32018-01-23 14:06:50 -0700496 bool fUsePrimitiveRestart : 1;
csmartdalton485a1202016-07-13 10:16:32 -0700497 bool fPreferClientSideDynamicBuffers : 1;
Chris Dalton344e9032017-12-11 15:42:09 -0700498 bool fPreferFullscreenClears : 1;
bsalomon7dea7b72015-08-19 08:26:51 -0700499 bool fMustClearUploadedBufferData : 1;
Kevin Lubick61a5f0a2019-03-28 09:47:15 -0400500 bool fShouldInitializeTextures : 1;
Greg Danielb2acf0a2018-09-12 09:17:11 -0400501 bool fSupportsAHardwareBufferImages : 1;
Brian Osman499bf1a2018-09-17 11:32:42 -0400502 bool fHalfFloatVertexAttributeSupport : 1;
Michael Ludwigf23a1522018-12-10 11:36:13 -0500503 bool fClampToBorderSupport : 1;
Michael Ludwiga21d1962019-01-11 15:26:22 -0500504 bool fPerformPartialClearsAsDraws : 1;
505 bool fPerformColorClearsAsDraws : 1;
Robert Phillips2f05a482019-11-25 09:54:43 -0500506 bool fAvoidLargeIndexBufferDraws : 1;
Michael Ludwiga21d1962019-01-11 15:26:22 -0500507 bool fPerformStencilClearsAsDraws : 1;
Chris Daltona8fbeba2019-03-30 00:31:23 -0600508 bool fAllowCoverageCounting : 1;
Brian Salomone05ba5a2019-04-08 11:59:07 -0400509 bool fTransferBufferSupport : 1;
Brian Salomon1047a492019-07-02 12:25:21 -0400510 bool fWritePixelsRowBytesSupport : 1;
511 bool fReadPixelsRowBytesSupport : 1;
robertphillips1b8e1b52015-06-24 06:54:10 -0700512
bsalomon63b21962014-11-05 07:05:34 -0800513 // Driver workaround
Chris Daltona8fbeba2019-03-30 00:31:23 -0600514 bool fDriverBlacklistCCPR : 1;
Chris Dalton7c012082019-07-22 00:45:52 -0400515 bool fDriverBlacklistMSAACCPR : 1;
Eric Karl5c779752017-05-08 12:02:07 -0700516 bool fAvoidStencilBuffers : 1;
Greg Daniel4374e962018-09-28 15:09:47 -0400517 bool fAvoidWritePixelsFastPath : 1;
bsalomon63b21962014-11-05 07:05:34 -0800518
Brian Salomon01b476a2018-01-23 11:06:41 -0500519 // ANGLE performance workaround
robertphillips63926682015-08-20 09:39:02 -0700520 bool fPreferVRAMUseOverFlushes : 1;
521
Chris Dalton0dffbab2019-03-27 13:08:50 -0600522 // On some platforms it's better to make more triangles than to use the sample mask (MSAA only).
523 bool fPreferTrianglesOverSampleMask : 1;
524
jvanverth84741b32016-09-30 08:39:02 -0700525 bool fFenceSyncSupport : 1;
Brian Salomon9ff5acb2019-05-08 09:04:47 -0400526 bool fSemaphoreSupport : 1;
ethannicholas28ef4452016-03-25 09:26:03 -0700527
Brian Salomonf7232642018-09-19 08:58:08 -0400528 // Requires fence sync support in GL.
Brian Osman2c2bc112017-02-28 10:02:49 -0500529 bool fCrossContextTextureSupport : 1;
530
Brian Salomonf7232642018-09-19 08:58:08 -0400531 // Not (yet) implemented in VK backend.
532 bool fDynamicStateArrayGeometryProcessorTextureSupport : 1;
533
cdalton8917d622015-05-06 13:40:21 -0700534 BlendEquationSupport fBlendEquationSupport;
cdalton1dd05422015-06-12 09:01:18 -0700535 uint32_t fAdvBlendEqBlacklist;
Greg Daniel3f1a98b2019-12-17 23:16:42 +0000536 GR_STATIC_ASSERT(kLast_GrBlendEquation < 32);
cdalton1dd05422015-06-12 09:01:18 -0700537
commit-bot@chromium.org160b4782014-05-05 12:32:37 +0000538 uint32_t fMapBufferFlags;
cdalton397536c2016-03-25 12:15:03 -0700539 int fBufferMapThreshold;
commit-bot@chromium.org160b4782014-05-05 12:32:37 +0000540
bsalomon@google.comc26d94f2013-03-25 18:19:00 +0000541 int fMaxRenderTargetSize;
Chris Dalton2612bae2018-02-22 13:41:37 -0700542 int fMaxPreferredRenderTargetSize;
bsalomon7dbd45d2016-03-23 10:40:53 -0700543 int fMaxVertexAttributes;
bsalomon@google.comc26d94f2013-03-25 18:19:00 +0000544 int fMaxTextureSize;
bsalomon8c07b7a2015-11-02 11:36:52 -0800545 int fMaxTileSize;
csmartdalton9bc11872016-08-09 12:42:47 -0700546 int fMaxWindowRectangles;
Chris Daltona1638a52019-06-24 11:54:24 -0600547 int fInternalMultisampleCount;
bsalomon@google.comc26d94f2013-03-25 18:19:00 +0000548
Adrienne Walker68314842018-05-14 14:02:53 -0700549 GrDriverBugWorkarounds fDriverBugWorkarounds;
550
egdanielbc127a32014-09-19 12:07:43 -0700551private:
Chris Dalton8367e112019-11-13 12:43:21 -0700552 void applyOptionsOverrides(const GrContextOptions& options);
553
Mike Kleinfc6c37b2016-09-27 09:34:10 -0400554 virtual void onApplyOptionsOverrides(const GrContextOptions&) {}
Brian Osman71a18892017-08-10 10:23:25 -0400555 virtual void onDumpJSON(SkJSONWriter*) const {}
Brian Salomonc67c31c2018-12-06 10:00:03 -0500556 virtual bool onSurfaceSupportsWritePixels(const GrSurface*) const = 0;
557 virtual bool onCanCopySurface(const GrSurfaceProxy* dst, const GrSurfaceProxy* src,
558 const SkIRect& srcRect, const SkIPoint& dstPoint) const = 0;
Robert Phillips0a15cc62019-07-30 12:49:10 -0400559 virtual GrBackendFormat onGetDefaultBackendFormat(GrColorType, GrRenderable) const = 0;
egdanielb7e7d572015-11-04 04:23:53 -0800560
Greg Daniel2a303902018-02-20 10:25:54 -0500561 // Backends should implement this if they have any extra requirements for use of window
562 // rectangles for a specific GrBackendRenderTarget outside of basic support.
563 virtual bool onIsWindowRectanglesSupportedForRT(const GrBackendRenderTarget&) const {
564 return true;
565 }
566
Greg Daniel627d0532019-07-08 16:48:14 -0400567 virtual GrPixelConfig onGetConfigFromBackendFormat(const GrBackendFormat& format,
568 GrColorType ct) const = 0;
Robert Phillipsdf6c7342019-12-16 13:40:51 -0500569 virtual GrPixelConfig onGetConfigFromCompressedBackendFormat(const GrBackendFormat&) const = 0;
Greg Daniel627d0532019-07-08 16:48:14 -0400570
571 virtual bool onAreColorTypeAndFormatCompatible(GrColorType, const GrBackendFormat&) const = 0;
572
Greg Danielba88ab62019-07-26 09:14:01 -0400573 virtual SupportedRead onSupportedReadPixelsColorType(GrColorType srcColorType,
574 const GrBackendFormat& srcFormat,
575 GrColorType dstColorType) const = 0;
576
Greg Daniel627d0532019-07-08 16:48:14 -0400577
robertphillipscaef3452015-11-11 13:18:11 -0800578 bool fSuppressPrints : 1;
Jim Van Verthfbdc0802017-05-02 16:15:53 -0400579 bool fWireframeMode : 1;
bsalomon682c2692015-05-22 14:01:46 -0700580
bsalomon@google.comc26d94f2013-03-25 18:19:00 +0000581 typedef SkRefCnt INHERITED;
582};
583
584#endif