blob: 447bbb77f3e4257fe50d9a36a00880d79a821780 [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"
Brian Salomonccb61422020-01-09 10:46:36 -050017#include "src/gpu/GrSamplerState.h"
Mike Kleinc0bd9f92019-04-23 12:05:21 -050018#include "src/gpu/GrShaderCaps.h"
Brian Salomon1e03b6b12019-07-17 17:28:24 -040019#include "src/gpu/GrSurfaceProxy.h"
commit-bot@chromium.org8b656c62013-11-21 15:23:15 +000020
Robert Phillipsfc711a22018-02-13 17:03:00 -050021class GrBackendFormat;
Greg Danielfaa095e2017-12-19 13:15:02 -050022class GrBackendRenderTarget;
Greg Danielf5d87582017-12-18 14:48:15 -050023class GrBackendTexture;
bsalomon682c2692015-05-22 14:01:46 -070024struct GrContextOptions;
Robert Phillips323471e2019-11-11 11:33:37 -050025class GrProcessorKeyBuilder;
Robert Phillips03e4c952019-11-26 16:20:22 -050026class GrProgramDesc;
27class GrProgramInfo;
Robert Phillipsbf25d432017-04-07 10:08:53 -040028class GrRenderTargetProxy;
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
Chris Daltone1196c52019-12-28 14:31:09 -070090 // http://skbug.com/9739
91 bool requiresManualFBBarrierAfterTessellatedStencilDraw() const {
92 return fRequiresManualFBBarrierAfterTessellatedStencilDraw;
93 }
94
csmartdaltone0d36292016-07-29 08:14:20 -070095 /**
cdalton8917d622015-05-06 13:40:21 -070096 * Indicates the capabilities of the fixed function blend unit.
97 */
98 enum BlendEquationSupport {
99 kBasic_BlendEquationSupport, //<! Support to select the operator that
100 // combines src and dst terms.
101 kAdvanced_BlendEquationSupport, //<! Additional fixed function support for specific
102 // SVG/PDF blend modes. Requires blend barriers.
103 kAdvancedCoherent_BlendEquationSupport, //<! Advanced blend equation support that does not
104 // require blend barriers, and permits overlap.
105
106 kLast_BlendEquationSupport = kAdvancedCoherent_BlendEquationSupport
107 };
108
109 BlendEquationSupport blendEquationSupport() const { return fBlendEquationSupport; }
110
111 bool advancedBlendEquationSupport() const {
112 return fBlendEquationSupport >= kAdvanced_BlendEquationSupport;
113 }
114
115 bool advancedCoherentBlendEquationSupport() const {
116 return kAdvancedCoherent_BlendEquationSupport == fBlendEquationSupport;
117 }
118
Chris Dalton302d5be2019-01-22 23:41:25 -0700119 bool isAdvancedBlendEquationBlacklisted(GrBlendEquation equation) const {
cdalton1dd05422015-06-12 09:01:18 -0700120 SkASSERT(GrBlendEquationIsAdvanced(equation));
Chris Dalton302d5be2019-01-22 23:41:25 -0700121 SkASSERT(this->advancedBlendEquationSupport());
cdalton1dd05422015-06-12 09:01:18 -0700122 return SkToBool(fAdvBlendEqBlacklist & (1 << equation));
123 }
124
cdalton8917d622015-05-06 13:40:21 -0700125 /**
commit-bot@chromium.org160b4782014-05-05 12:32:37 +0000126 * Indicates whether GPU->CPU memory mapping for GPU resources such as vertex buffers and
127 * textures allows partial mappings or full mappings.
128 */
129 enum MapFlags {
Brian Salomon105d7c22019-04-16 13:46:14 -0400130 kNone_MapFlags = 0x0, //<! Cannot map the resource.
commit-bot@chromium.org160b4782014-05-05 12:32:37 +0000131
Brian Salomon105d7c22019-04-16 13:46:14 -0400132 kCanMap_MapFlag = 0x1, //<! The resource can be mapped. Must be set for any of
133 // the other flags to have meaning.
134 kSubset_MapFlag = 0x2, //<! The resource can be partially mapped.
Greg Daniel2d41d0d2019-08-26 11:08:51 -0400135 kAsyncRead_MapFlag = 0x4, //<! Are maps for reading asynchronous WRT GrOpsRenderPass
Brian Salomon105d7c22019-04-16 13:46:14 -0400136 // submitted to GrGpu.
commit-bot@chromium.org160b4782014-05-05 12:32:37 +0000137 };
138
139 uint32_t mapBufferFlags() const { return fMapBufferFlags; }
140
robertphillips@google.com2d2e5c42013-10-30 21:30:43 +0000141 // Scratch textures not being reused means that those scratch textures
skia.committer@gmail.com7ed98df2013-10-31 07:01:53 +0000142 // that we upload to (i.e., don't have a render target) will not be
robertphillips@google.com2d2e5c42013-10-30 21:30:43 +0000143 // recycled in the texture cache. This is to prevent ghosting by drivers
144 // (in particular for deferred architectures).
commit-bot@chromium.orgb8356522013-07-18 22:26:39 +0000145 bool reuseScratchTextures() const { return fReuseScratchTextures; }
robertphillips1b8e1b52015-06-24 06:54:10 -0700146 bool reuseScratchBuffers() const { return fReuseScratchBuffers; }
bsalomon@google.comc26d94f2013-03-25 18:19:00 +0000147
bsalomon7dbd45d2016-03-23 10:40:53 -0700148 /// maximum number of attribute values per vertex
149 int maxVertexAttributes() const { return fMaxVertexAttributes; }
150
bsalomon@google.comc26d94f2013-03-25 18:19:00 +0000151 int maxRenderTargetSize() const { return fMaxRenderTargetSize; }
Chris Dalton2612bae2018-02-22 13:41:37 -0700152
153 /** This is the largest render target size that can be used without incurring extra perfomance
154 cost. It is usually the max RT size, unless larger render targets are known to be slower. */
155 int maxPreferredRenderTargetSize() const { return fMaxPreferredRenderTargetSize; }
156
bsalomon@google.comc26d94f2013-03-25 18:19:00 +0000157 int maxTextureSize() const { return fMaxTextureSize; }
Chris Dalton2612bae2018-02-22 13:41:37 -0700158
bsalomon8c07b7a2015-11-02 11:36:52 -0800159 /** This is the maximum tile size to use by GPU devices for rendering sw-backed images/bitmaps.
160 It is usually the max texture size, unless we're overriding it for testing. */
Brian Salomonc7fe0f72018-05-11 10:14:21 -0400161 int maxTileSize() const {
162 SkASSERT(fMaxTileSize <= fMaxTextureSize);
163 return fMaxTileSize;
164 }
bsalomonc59a1df2015-06-01 07:13:42 -0700165
csmartdalton9bc11872016-08-09 12:42:47 -0700166 int maxWindowRectangles() const { return fMaxWindowRectangles; }
bsalomon@google.comc26d94f2013-03-25 18:19:00 +0000167
Greg Daniel2a303902018-02-20 10:25:54 -0500168 // Returns whether mixed samples is supported for the given backend render target.
169 bool isWindowRectanglesSupportedForRT(const GrBackendRenderTarget& rt) const {
170 return this->maxWindowRectangles() > 0 && this->onIsWindowRectanglesSupportedForRT(rt);
171 }
172
Robert Phillipsf209e882019-06-25 15:59:50 -0400173 virtual bool isFormatSRGB(const GrBackendFormat&) const = 0;
Greg Daniela00bcad2019-10-11 13:21:48 -0400174
Robert Phillipsd6df7b52019-12-13 11:17:46 -0500175 // This will return SkImage::CompressionType::kNone if the backend format is not compressed.
176 virtual SkImage::CompressionType compressionType(const GrBackendFormat&) const = 0;
177
178 bool isFormatCompressed(const GrBackendFormat& format) const {
179 return this->compressionType(format) != SkImage::CompressionType::kNone;
180 }
Robert Phillipsf209e882019-06-25 15:59:50 -0400181
Greg Daniel7bfc9132019-08-14 14:23:53 -0400182 // TODO: Once we use the supportWritePixels call for uploads, we can remove this function and
183 // instead only have the version that takes a GrBackendFormat.
184 virtual bool isFormatTexturableAndUploadable(GrColorType, const GrBackendFormat&) const = 0;
185 // Can a texture be made with the GrBackendFormat, and then be bound and sampled in a shader.
186 virtual bool isFormatTexturable(const GrBackendFormat&) const = 0;
Brian Salomonbdecacf2018-02-02 20:32:49 -0500187
Greg Daniel6980c4e2019-07-30 16:18:18 -0400188 // Returns whether a texture of the given format can be copied to a texture of the same format.
189 virtual bool isFormatCopyable(const GrBackendFormat&) const = 0;
Brian Salomonbdecacf2018-02-02 20:32:49 -0500190
Greg Danieleadfac92019-08-02 09:03:53 -0400191 // Returns the maximum supported sample count for a format. 0 means the format is not renderable
192 // 1 means the format is renderable but doesn't support MSAA. This call only refers to the
193 // format itself. A caller should also confirm if the format is renderable with a given
194 // GrColorType by calling isFormatRenderable.
195 virtual int maxRenderTargetSampleCount(const GrBackendFormat&) const = 0;
Brian Salomonbdecacf2018-02-02 20:32:49 -0500196
Chris Dalton1e6c5b82019-06-17 14:16:49 -0600197 // Returns the number of samples to use when performing internal draws to the given config with
Chris Daltona1638a52019-06-24 11:54:24 -0600198 // MSAA or mixed samples. If 0, Ganesh should not attempt to use internal multisampling.
Greg Danieleadfac92019-08-02 09:03:53 -0400199 int internalMultisampleCount(const GrBackendFormat& format) const {
200 return SkTMin(fInternalMultisampleCount, this->maxRenderTargetSampleCount(format));
Chris Dalton1e6c5b82019-06-17 14:16:49 -0600201 }
202
Greg Daniel900583a2019-08-06 12:05:31 -0400203 virtual bool isFormatAsColorTypeRenderable(GrColorType ct, const GrBackendFormat& format,
204 int sampleCount = 1) const = 0;
205
206 virtual bool isFormatRenderable(const GrBackendFormat& format, int sampleCount) const = 0;
Brian Salomonbdecacf2018-02-02 20:32:49 -0500207
208 // Find a sample count greater than or equal to the requested count which is supported for a
Greg Daniel6fa62e22019-08-07 15:52:37 -0400209 // 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 -0500210 // sample count is 1 then 1 will be returned if non-MSAA rendering is supported, otherwise 0.
211 // For historical reasons requestedCount==0 is handled identically to requestedCount==1.
Greg Daniel6fa62e22019-08-07 15:52:37 -0400212 virtual int getRenderTargetSampleCount(int requestedCount, const GrBackendFormat&) const = 0;
commit-bot@chromium.org42dc8132014-05-27 19:26:59 +0000213
Greg Daniel7fd7a8a2019-10-10 16:10:31 -0400214 // Returns the number of bytes per pixel for the given GrBackendFormat. This is only supported
215 // for "normal" formats. For compressed formats this will return 0.
216 virtual size_t bytesPerPixel(const GrBackendFormat&) const = 0;
217
Brian Salomon5f33a8c2018-02-26 14:32:39 -0500218 /**
Brian Salomon3d86a192018-02-27 16:46:11 -0500219 * Backends may have restrictions on what types of surfaces support GrGpu::writePixels().
220 * If this returns false then the caller should implement a fallback where a temporary texture
221 * 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 -0500222 */
Brian Salomonc67c31c2018-12-06 10:00:03 -0500223 bool surfaceSupportsWritePixels(const GrSurface*) const;
Brian Salomon19eaf2d2018-03-19 16:06:44 -0400224
Emircan Uysaler23ca4e72019-06-24 10:53:09 -0400225 /**
Brian Salomondc0710f2019-07-01 14:59:32 -0400226 * Indicates whether surface supports GrGpu::readPixels, must be copied, or cannot be read.
Emircan Uysaler23ca4e72019-06-24 10:53:09 -0400227 */
Brian Salomondc0710f2019-07-01 14:59:32 -0400228 enum class SurfaceReadPixelsSupport {
229 /** GrGpu::readPixels is supported by the surface. */
230 kSupported,
231 /**
232 * GrGpu::readPixels is not supported by this surface but this surface can be drawn
233 * or copied to a Ganesh-created GrTextureType::kTexture2D and then that surface will be
234 * readable.
235 */
236 kCopyToTexture2D,
237 /**
238 * Not supported
239 */
240 kUnsupported,
Emircan Uysaler23ca4e72019-06-24 10:53:09 -0400241 };
Brian Salomon19eaf2d2018-03-19 16:06:44 -0400242 /**
Brian Salomondc0710f2019-07-01 14:59:32 -0400243 * Backends may have restrictions on what types of surfaces support GrGpu::readPixels(). We may
244 * either be able to read directly from the surface, read from a copy of the surface, or not
245 * read at all.
Brian Salomon19eaf2d2018-03-19 16:06:44 -0400246 */
Brian Salomondc0710f2019-07-01 14:59:32 -0400247 virtual SurfaceReadPixelsSupport surfaceSupportsReadPixels(const GrSurface*) const = 0;
Brian Salomon5f33a8c2018-02-26 14:32:39 -0500248
Brian Salomon42be09d2019-07-26 12:12:26 -0400249 struct SupportedWrite {
250 GrColorType fColorType;
251 // If the write is occurring using GrGpu::transferPixelsTo then this provides the
252 // minimum alignment of the offset into the transfer buffer.
253 size_t fOffsetAlignmentForTransferBuffer;
254 };
255
Brian Salomon5f33a8c2018-02-26 14:32:39 -0500256 /**
257 * Given a dst pixel config and a src color type what color type must the caller coax the
258 * the data into in order to use GrGpu::writePixels().
259 */
Brian Salomon01915c02019-08-02 09:57:21 -0400260 virtual SupportedWrite supportedWritePixelsColorType(GrColorType surfaceColorType,
261 const GrBackendFormat& surfaceFormat,
Brian Salomon42be09d2019-07-26 12:12:26 -0400262 GrColorType srcColorType) const = 0;
Brian Salomon5f33a8c2018-02-26 14:32:39 -0500263
Brian Salomonf30b1c12019-06-20 12:25:02 -0400264 struct SupportedRead {
Brian Salomonf30b1c12019-06-20 12:25:02 -0400265 GrColorType fColorType;
Brian Salomon42be09d2019-07-26 12:12:26 -0400266 // If the read is occurring using GrGpu::transferPixelsFrom then this provides the
267 // minimum alignment of the offset into the transfer buffer.
Greg Danielba88ab62019-07-26 09:14:01 -0400268 size_t fOffsetAlignmentForTransferBuffer;
Brian Salomonf30b1c12019-06-20 12:25:02 -0400269 };
270
Brian Salomon19eaf2d2018-03-19 16:06:44 -0400271 /**
Greg Daniel00fb7242019-07-18 14:28:01 -0400272 * 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 -0400273 * would like read into, this provides a legal color type that the caller may pass to
274 * GrGpu::readPixels(). The returned color type may differ from the passed dstColorType, in
275 * which case the caller must convert the read pixel data (see GrConvertPixels). When converting
276 * to dstColorType the swizzle in the returned struct should be applied. The caller must check
277 * the returned color type for kUnknown.
Brian Salomon19eaf2d2018-03-19 16:06:44 -0400278 */
Greg Danielba88ab62019-07-26 09:14:01 -0400279 SupportedRead supportedReadPixelsColorType(GrColorType srcColorType,
280 const GrBackendFormat& srcFormat,
281 GrColorType dstColorType) const;
Brian Salomon19eaf2d2018-03-19 16:06:44 -0400282
Brian Salomon1047a492019-07-02 12:25:21 -0400283 /**
284 * Do GrGpu::writePixels() and GrGpu::transferPixelsTo() support a src buffer where the row
285 * bytes is not equal to bpp * w?
286 */
287 bool writePixelsRowBytesSupport() const { return fWritePixelsRowBytesSupport; }
288 /**
289 * Does GrGpu::readPixels() support a dst buffer where the row bytes is not equal to bpp * w?
290 */
291 bool readPixelsRowBytesSupport() const { return fReadPixelsRowBytesSupport; }
292
Brian Salomonfb28c6f2020-01-10 13:04:45 -0500293 bool transferFromSurfaceToBufferSupport() const { return fTransferFromSurfaceToBufferSupport; }
294 bool transferFromBufferToTextureSupport() const { return fTransferFromBufferToTextureSupport; }
Brian Salomone05ba5a2019-04-08 11:59:07 -0400295
robertphillipscaef3452015-11-11 13:18:11 -0800296 bool suppressPrints() const { return fSuppressPrints; }
297
cdalton397536c2016-03-25 12:15:03 -0700298 size_t bufferMapThreshold() const {
299 SkASSERT(fBufferMapThreshold >= 0);
300 return fBufferMapThreshold;
joshualitt7224c862015-05-29 06:46:47 -0700301 }
bsalomon682c2692015-05-22 14:01:46 -0700302
Mike Kleinfc6c37b2016-09-27 09:34:10 -0400303 /** True in environments that will issue errors if memory uploaded to buffers
bsalomon7dea7b72015-08-19 08:26:51 -0700304 is not initialized (even if not read by draw calls). */
305 bool mustClearUploadedBufferData() const { return fMustClearUploadedBufferData; }
306
Kevin Lubick61a5f0a2019-03-28 09:47:15 -0400307 /** For some environments, there is a performance or safety concern to not
308 initializing textures. For example, with WebGL and Firefox, there is a large
309 performance hit to not doing it.
310 */
311 bool shouldInitializeTextures() const { return fShouldInitializeTextures; }
312
Greg Danielb2acf0a2018-09-12 09:17:11 -0400313 /** Returns true if the given backend supports importing AHardwareBuffers via the
314 * GrAHardwarebufferImageGenerator. This will only ever be supported on Android devices with API
315 * level >= 26.
316 * */
317 bool supportsAHardwareBufferImages() const { return fSupportsAHardwareBufferImages; }
318
Jim Van Verthfbdc0802017-05-02 16:15:53 -0400319 bool wireframeMode() const { return fWireframeMode; }
320
Brian Salomon9ff5acb2019-05-08 09:04:47 -0400321 /** Supports using GrFence. */
jvanverth84741b32016-09-30 08:39:02 -0700322 bool fenceSyncSupport() const { return fFenceSyncSupport; }
Brian Salomon9ff5acb2019-05-08 09:04:47 -0400323
324 /** Supports using GrSemaphore. */
325 bool semaphoreSupport() const { return fSemaphoreSupport; }
326
Brian Osman2c2bc112017-02-28 10:02:49 -0500327 bool crossContextTextureSupport() const { return fCrossContextTextureSupport; }
Brian Salomon467921e2017-03-06 16:17:12 -0500328 /**
Greg Daniel25af6712018-04-25 10:44:38 -0400329 * Returns whether or not we will be able to do a copy given the passed in params
330 */
Brian Salomonc67c31c2018-12-06 10:00:03 -0500331 bool canCopySurface(const GrSurfaceProxy* dst, const GrSurfaceProxy* src,
332 const SkIRect& srcRect, const SkIPoint& dstPoint) const;
Greg Daniel25af6712018-04-25 10:44:38 -0400333
Brian Salomonf7232642018-09-19 08:58:08 -0400334 bool dynamicStateArrayGeometryProcessorTextureSupport() const {
335 return fDynamicStateArrayGeometryProcessorTextureSupport;
336 }
337
Michael Ludwigc39d0c82019-01-15 10:03:43 -0500338 // Not all backends support clearing with a scissor test (e.g. Metal), this will always
339 // return true if performColorClearsAsDraws() returns true.
Michael Ludwiga21d1962019-01-11 15:26:22 -0500340 bool performPartialClearsAsDraws() const {
Michael Ludwigc39d0c82019-01-15 10:03:43 -0500341 return fPerformColorClearsAsDraws || fPerformPartialClearsAsDraws;
Michael Ludwiga21d1962019-01-11 15:26:22 -0500342 }
343
344 // Many drivers have issues with color clears.
Chris Daltona8fbeba2019-03-30 00:31:23 -0600345 bool performColorClearsAsDraws() const { return fPerformColorClearsAsDraws; }
Michael Ludwiga21d1962019-01-11 15:26:22 -0500346
Robert Phillips2f05a482019-11-25 09:54:43 -0500347 bool avoidLargeIndexBufferDraws() const { return fAvoidLargeIndexBufferDraws; }
348
Michael Ludwiga21d1962019-01-11 15:26:22 -0500349 /// Adreno 4xx devices experience an issue when there are a large number of stencil clip bit
350 /// clears. The minimal repro steps are not precisely known but drawing a rect with a stencil
351 /// op instead of using glClear seems to resolve the issue.
Chris Daltona8fbeba2019-03-30 00:31:23 -0600352 bool performStencilClearsAsDraws() const { return fPerformStencilClearsAsDraws; }
353
354 // Can we use coverage counting shortcuts to render paths? Coverage counting can cause artifacts
355 // along shared edges if care isn't taken to ensure both contours wind in the same direction.
356 bool allowCoverageCounting() const { return fAllowCoverageCounting; }
357
358 // Should we disable the CCPR code due to a faulty driver?
359 bool driverBlacklistCCPR() const { return fDriverBlacklistCCPR; }
Chris Dalton7c012082019-07-22 00:45:52 -0400360 bool driverBlacklistMSAACCPR() const { return fDriverBlacklistMSAACCPR; }
Ethan Nicholas56d19a52018-10-15 11:26:20 -0400361
Greg Daniel25af6712018-04-25 10:44:38 -0400362 /**
Brian Salomon1e03b6b12019-07-17 17:28:24 -0400363 * This is used to try to ensure a successful copy a dst in order to perform shader-based
364 * blending.
365 *
366 * fRectsMustMatch will be set to true if the copy operation must ensure that the src and dest
367 * rects are identical.
368 *
369 * fMustCopyWholeSrc will be set to true if copy rect must equal src's bounds.
370 *
371 * Caller will detect cases when copy cannot succeed and try copy-as-draw as a fallback.
Brian Salomon467921e2017-03-06 16:17:12 -0500372 */
Brian Salomon1e03b6b12019-07-17 17:28:24 -0400373 struct DstCopyRestrictions {
374 GrSurfaceProxy::RectsMustMatch fRectsMustMatch = GrSurfaceProxy::RectsMustMatch::kNo;
375 bool fMustCopyWholeSrc = false;
376 };
Greg Daniel0258c902019-08-01 13:08:33 -0400377 virtual DstCopyRestrictions getDstCopyRestrictions(const GrRenderTargetProxy* src,
378 GrColorType ct) const {
Brian Salomon1e03b6b12019-07-17 17:28:24 -0400379 return {};
380 }
Brian Salomon467921e2017-03-06 16:17:12 -0500381
Greg Daniel6fa62e22019-08-07 15:52:37 -0400382 bool validateSurfaceParams(const SkISize&, const GrBackendFormat&, GrPixelConfig,
383 GrRenderable renderable, int renderTargetSampleCnt,
384 GrMipMapped) const;
Brian Salomonbdecacf2018-02-02 20:32:49 -0500385
Greg Daniel627d0532019-07-08 16:48:14 -0400386 bool areColorTypeAndFormatCompatible(GrColorType grCT,
Robert Phillips1e2cb442019-07-02 15:51:28 -0400387 const GrBackendFormat& format) const {
Robert Phillips1e2cb442019-07-02 15:51:28 -0400388 if (GrColorType::kUnknown == grCT) {
389 return false;
390 }
391
Greg Daniel627d0532019-07-08 16:48:14 -0400392 return this->onAreColorTypeAndFormatCompatible(grCT, format);
Robert Phillips1e2cb442019-07-02 15:51:28 -0400393 }
Robert Phillipsc046ff02019-07-01 10:34:03 -0400394
Robert Phillipsfc711a22018-02-13 17:03:00 -0500395 // TODO: it seems like we could pass the full SkImageInfo and validate its colorSpace too
Brian Salomonf391d0f2018-12-14 09:18:50 -0500396 // Returns kUnknown if a valid config could not be determined.
Greg Daniel627d0532019-07-08 16:48:14 -0400397 GrPixelConfig getConfigFromBackendFormat(const GrBackendFormat& format,
398 GrColorType grCT) const {
399 if (GrColorType::kUnknown == grCT) {
400 return kUnknown_GrPixelConfig;
401 }
402
403 return this->onGetConfigFromBackendFormat(format, grCT);
404 }
Robert Phillipsdf6c7342019-12-16 13:40:51 -0500405 GrPixelConfig getConfigFromCompressedBackendFormat(const GrBackendFormat& format) const {
406 return this->onGetConfigFromCompressedBackendFormat(format);
407 }
Robert Phillipsfc711a22018-02-13 17:03:00 -0500408
Jim Van Verthb7f0b9c2018-10-22 14:12:03 -0400409 /**
Robert Phillips00c9f0d2019-08-02 17:17:35 -0400410 * Special method only for YUVA images. Returns a colortype that matches the backend format or
411 * kUnknown if a colortype could not be determined.
Jim Van Verth9bf81202018-10-30 15:53:36 -0400412 */
Robert Phillips00c9f0d2019-08-02 17:17:35 -0400413 virtual GrColorType getYUVAColorTypeFromBackendFormat(const GrBackendFormat&,
414 bool isAlphaChannel) const = 0;
Jim Van Verth9bf81202018-10-30 15:53:36 -0400415
Brian Salomonf391d0f2018-12-14 09:18:50 -0500416 /** These are used when creating a new texture internally. */
Robert Phillips0a15cc62019-07-30 12:49:10 -0400417 GrBackendFormat getDefaultBackendFormat(GrColorType, GrRenderable) const;
Greg Daniel4065d452018-11-16 15:43:41 -0500418
Brian Salomonbb8dde82019-06-27 10:52:13 -0400419 virtual GrBackendFormat getBackendFormatFromCompressionType(SkImage::CompressionType) const = 0;
420
Timothy Liang036fdfe2018-06-28 15:50:36 -0400421 /**
Michael Ludwigf23a1522018-12-10 11:36:13 -0500422 * The CLAMP_TO_BORDER wrap mode for texture coordinates was added to desktop GL in 1.3, and
423 * GLES 3.2, but is also available in extensions. Vulkan and Metal always have support.
424 */
425 bool clampToBorderSupport() const { return fClampToBorderSupport; }
426
Greg Danieleb4a8272019-05-16 16:52:55 -0400427 /**
Greg Daniel14b57212019-12-17 16:18:06 -0500428 * Returns the GrSwizzle to use when sampling or reading back from a texture with the passed in
429 * GrBackendFormat and GrColorType.
Greg Danieleb4a8272019-05-16 16:52:55 -0400430 */
Greg Daniel14b57212019-12-17 16:18:06 -0500431 virtual GrSwizzle getReadSwizzle(const GrBackendFormat&, GrColorType) const = 0;
Greg Danieleb4a8272019-05-16 16:52:55 -0400432
433 /**
434 * Returns the GrSwizzle to use when outputting to a render target with the passed in
435 * GrBackendFormat and GrColorType.
436 */
437 virtual GrSwizzle getOutputSwizzle(const GrBackendFormat&, GrColorType) const = 0;
438
Adrienne Walker3ed33992018-05-15 11:44:34 -0700439 const GrDriverBugWorkarounds& workarounds() const { return fDriverBugWorkarounds; }
440
Brian Salomon947efe22019-07-16 15:36:11 -0400441 /**
442 * Given a possibly generic GrPixelConfig and a backend format return a specific
443 * GrPixelConfig.
444 */
445 GrPixelConfig makeConfigSpecific(GrPixelConfig config, const GrBackendFormat& format) const {
446 auto ct = GrPixelConfigToColorType(config);
447 auto result = this->getConfigFromBackendFormat(format, ct);
448 SkASSERT(config == result || AreConfigsCompatible(config, result));
449 return result;
450 }
451
Robert Phillips323471e2019-11-11 11:33:37 -0500452 /**
453 * Adds fields to the key to represent the sampler that will be created for the passed
454 * in parameters. Currently this extra keying is only needed when building a vulkan pipeline
455 * with immutable samplers.
456 */
457 virtual void addExtraSamplerKey(GrProcessorKeyBuilder*,
Brian Salomonccb61422020-01-09 10:46:36 -0500458 GrSamplerState,
Robert Phillips323471e2019-11-11 11:33:37 -0500459 const GrBackendFormat&) const {}
460
Robert Phillips03e4c952019-11-26 16:20:22 -0500461 virtual GrProgramDesc makeDesc(const GrRenderTarget*, const GrProgramInfo&) const = 0;
462
Robert Phillips0902c982019-07-16 07:47:56 -0400463#ifdef SK_DEBUG
464 // This is just a debugging entry point until we're weaned off of GrPixelConfig. It
465 // should be used to verify that the pixel config from user-level code (the genericConfig)
466 // is compatible with a pixel config we've computed from scratch (the specificConfig).
467 static bool AreConfigsCompatible(GrPixelConfig genericConfig, GrPixelConfig specificConfig);
468#endif
469
Robert Phillipsffe27292019-08-01 10:08:07 -0400470#if GR_TEST_UTILS
471 struct TestFormatColorTypeCombination {
472 GrColorType fColorType;
473 GrBackendFormat fFormat;
474 };
475
476 virtual std::vector<TestFormatColorTypeCombination> getTestingCombinations() const = 0;
477#endif
478
bsalomon@google.comc26d94f2013-03-25 18:19:00 +0000479protected:
Chris Dalton8367e112019-11-13 12:43:21 -0700480 // Subclasses must call this at the end of their init method in order to do final processing on
481 // the caps (including overrides requested by the client).
482 // NOTE: this method will only reduce the caps, never expand them.
483 void finishInitialization(const GrContextOptions& options);
bsalomon4ee6bd82015-05-27 13:23:23 -0700484
bungeman6bd52842016-10-27 09:30:08 -0700485 sk_sp<GrShaderCaps> fShaderCaps;
jvanverthe9c0fc62015-04-29 11:18:05 -0700486
joshualitt83bc2292015-06-18 14:18:02 -0700487 bool fNPOTTextureTileSupport : 1;
488 bool fMipMapSupport : 1;
joshualitt83bc2292015-06-18 14:18:02 -0700489 bool fReuseScratchTextures : 1;
robertphillips1b8e1b52015-06-24 06:54:10 -0700490 bool fReuseScratchBuffers : 1;
joshualitt83bc2292015-06-18 14:18:02 -0700491 bool fGpuTracingSupport : 1;
joshualitt83bc2292015-06-18 14:18:02 -0700492 bool fOversizedStencilSupport : 1;
493 bool fTextureBarrierSupport : 1;
Robert Phillips7f861922018-01-30 13:13:42 +0000494 bool fSampleLocationsSupport : 1;
csmartdalton2b5f2cb2016-06-10 14:06:32 -0700495 bool fMultisampleDisableSupport : 1;
Chris Dalton1d616352017-05-31 12:51:23 -0600496 bool fInstanceAttribSupport : 1;
Chris Dalton6ce447a2019-06-23 18:07:38 -0600497 bool fMixedSamplesSupport : 1;
Chris Daltonce425af2019-12-16 10:39:03 -0700498 bool fConservativeRasterSupport : 1;
Chris Dalton1215cda2019-12-17 21:44:04 -0700499 bool fWireframeSupport : 1;
Chris Daltond5d8a642019-08-08 15:29:20 -0600500 bool fMSAAResolvesAutomatically : 1;
Chris Dalton27059d32018-01-23 14:06:50 -0700501 bool fUsePrimitiveRestart : 1;
csmartdalton485a1202016-07-13 10:16:32 -0700502 bool fPreferClientSideDynamicBuffers : 1;
Chris Dalton344e9032017-12-11 15:42:09 -0700503 bool fPreferFullscreenClears : 1;
bsalomon7dea7b72015-08-19 08:26:51 -0700504 bool fMustClearUploadedBufferData : 1;
Kevin Lubick61a5f0a2019-03-28 09:47:15 -0400505 bool fShouldInitializeTextures : 1;
Greg Danielb2acf0a2018-09-12 09:17:11 -0400506 bool fSupportsAHardwareBufferImages : 1;
Brian Osman499bf1a2018-09-17 11:32:42 -0400507 bool fHalfFloatVertexAttributeSupport : 1;
Michael Ludwigf23a1522018-12-10 11:36:13 -0500508 bool fClampToBorderSupport : 1;
Michael Ludwiga21d1962019-01-11 15:26:22 -0500509 bool fPerformPartialClearsAsDraws : 1;
510 bool fPerformColorClearsAsDraws : 1;
Robert Phillips2f05a482019-11-25 09:54:43 -0500511 bool fAvoidLargeIndexBufferDraws : 1;
Michael Ludwiga21d1962019-01-11 15:26:22 -0500512 bool fPerformStencilClearsAsDraws : 1;
Chris Daltona8fbeba2019-03-30 00:31:23 -0600513 bool fAllowCoverageCounting : 1;
Brian Salomonfb28c6f2020-01-10 13:04:45 -0500514 bool fTransferFromBufferToTextureSupport : 1;
515 bool fTransferFromSurfaceToBufferSupport : 1;
Brian Salomon1047a492019-07-02 12:25:21 -0400516 bool fWritePixelsRowBytesSupport : 1;
517 bool fReadPixelsRowBytesSupport : 1;
robertphillips1b8e1b52015-06-24 06:54:10 -0700518
bsalomon63b21962014-11-05 07:05:34 -0800519 // Driver workaround
Chris Daltona8fbeba2019-03-30 00:31:23 -0600520 bool fDriverBlacklistCCPR : 1;
Chris Dalton7c012082019-07-22 00:45:52 -0400521 bool fDriverBlacklistMSAACCPR : 1;
Eric Karl5c779752017-05-08 12:02:07 -0700522 bool fAvoidStencilBuffers : 1;
Greg Daniel4374e962018-09-28 15:09:47 -0400523 bool fAvoidWritePixelsFastPath : 1;
Chris Daltone1196c52019-12-28 14:31:09 -0700524 bool fRequiresManualFBBarrierAfterTessellatedStencilDraw : 1;
bsalomon63b21962014-11-05 07:05:34 -0800525
Brian Salomon01b476a2018-01-23 11:06:41 -0500526 // ANGLE performance workaround
robertphillips63926682015-08-20 09:39:02 -0700527 bool fPreferVRAMUseOverFlushes : 1;
528
Chris Dalton0dffbab2019-03-27 13:08:50 -0600529 // On some platforms it's better to make more triangles than to use the sample mask (MSAA only).
530 bool fPreferTrianglesOverSampleMask : 1;
531
jvanverth84741b32016-09-30 08:39:02 -0700532 bool fFenceSyncSupport : 1;
Brian Salomon9ff5acb2019-05-08 09:04:47 -0400533 bool fSemaphoreSupport : 1;
ethannicholas28ef4452016-03-25 09:26:03 -0700534
Brian Salomonf7232642018-09-19 08:58:08 -0400535 // Requires fence sync support in GL.
Brian Osman2c2bc112017-02-28 10:02:49 -0500536 bool fCrossContextTextureSupport : 1;
537
Brian Salomonf7232642018-09-19 08:58:08 -0400538 // Not (yet) implemented in VK backend.
539 bool fDynamicStateArrayGeometryProcessorTextureSupport : 1;
540
cdalton8917d622015-05-06 13:40:21 -0700541 BlendEquationSupport fBlendEquationSupport;
cdalton1dd05422015-06-12 09:01:18 -0700542 uint32_t fAdvBlendEqBlacklist;
Brian Salomon4dea72a2019-12-18 10:43:10 -0500543 static_assert(kLast_GrBlendEquation < 32);
cdalton1dd05422015-06-12 09:01:18 -0700544
commit-bot@chromium.org160b4782014-05-05 12:32:37 +0000545 uint32_t fMapBufferFlags;
cdalton397536c2016-03-25 12:15:03 -0700546 int fBufferMapThreshold;
commit-bot@chromium.org160b4782014-05-05 12:32:37 +0000547
bsalomon@google.comc26d94f2013-03-25 18:19:00 +0000548 int fMaxRenderTargetSize;
Chris Dalton2612bae2018-02-22 13:41:37 -0700549 int fMaxPreferredRenderTargetSize;
bsalomon7dbd45d2016-03-23 10:40:53 -0700550 int fMaxVertexAttributes;
bsalomon@google.comc26d94f2013-03-25 18:19:00 +0000551 int fMaxTextureSize;
bsalomon8c07b7a2015-11-02 11:36:52 -0800552 int fMaxTileSize;
csmartdalton9bc11872016-08-09 12:42:47 -0700553 int fMaxWindowRectangles;
Chris Daltona1638a52019-06-24 11:54:24 -0600554 int fInternalMultisampleCount;
bsalomon@google.comc26d94f2013-03-25 18:19:00 +0000555
Adrienne Walker68314842018-05-14 14:02:53 -0700556 GrDriverBugWorkarounds fDriverBugWorkarounds;
557
egdanielbc127a32014-09-19 12:07:43 -0700558private:
Chris Dalton8367e112019-11-13 12:43:21 -0700559 void applyOptionsOverrides(const GrContextOptions& options);
560
Mike Kleinfc6c37b2016-09-27 09:34:10 -0400561 virtual void onApplyOptionsOverrides(const GrContextOptions&) {}
Brian Osman71a18892017-08-10 10:23:25 -0400562 virtual void onDumpJSON(SkJSONWriter*) const {}
Brian Salomonc67c31c2018-12-06 10:00:03 -0500563 virtual bool onSurfaceSupportsWritePixels(const GrSurface*) const = 0;
564 virtual bool onCanCopySurface(const GrSurfaceProxy* dst, const GrSurfaceProxy* src,
565 const SkIRect& srcRect, const SkIPoint& dstPoint) const = 0;
Robert Phillips0a15cc62019-07-30 12:49:10 -0400566 virtual GrBackendFormat onGetDefaultBackendFormat(GrColorType, GrRenderable) const = 0;
egdanielb7e7d572015-11-04 04:23:53 -0800567
Greg Daniel2a303902018-02-20 10:25:54 -0500568 // Backends should implement this if they have any extra requirements for use of window
569 // rectangles for a specific GrBackendRenderTarget outside of basic support.
570 virtual bool onIsWindowRectanglesSupportedForRT(const GrBackendRenderTarget&) const {
571 return true;
572 }
573
Greg Daniel627d0532019-07-08 16:48:14 -0400574 virtual GrPixelConfig onGetConfigFromBackendFormat(const GrBackendFormat& format,
575 GrColorType ct) const = 0;
Robert Phillipsdf6c7342019-12-16 13:40:51 -0500576 virtual GrPixelConfig onGetConfigFromCompressedBackendFormat(const GrBackendFormat&) const = 0;
Greg Daniel627d0532019-07-08 16:48:14 -0400577
578 virtual bool onAreColorTypeAndFormatCompatible(GrColorType, const GrBackendFormat&) const = 0;
579
Greg Danielba88ab62019-07-26 09:14:01 -0400580 virtual SupportedRead onSupportedReadPixelsColorType(GrColorType srcColorType,
581 const GrBackendFormat& srcFormat,
582 GrColorType dstColorType) const = 0;
583
Greg Daniel627d0532019-07-08 16:48:14 -0400584
robertphillipscaef3452015-11-11 13:18:11 -0800585 bool fSuppressPrints : 1;
Jim Van Verthfbdc0802017-05-02 16:15:53 -0400586 bool fWireframeMode : 1;
bsalomon682c2692015-05-22 14:01:46 -0700587
bsalomon@google.comc26d94f2013-03-25 18:19:00 +0000588 typedef SkRefCnt INHERITED;
589};
590
591#endif