blob: 9d0dbaaa06a6be55a21e9c8b23a4e143985021f2 [file] [log] [blame]
bsalomon@google.comc26d94f2013-03-25 18:19:00 +00001
2/*
3 * Copyright 2013 Google Inc.
4 *
5 * Use of this source code is governed by a BSD-style license that can be
6 * found in the LICENSE file.
7 */
bsalomon4b91f762015-05-19 09:29:46 -07008#ifndef GrCaps_DEFINED
9#define GrCaps_DEFINED
bsalomon@google.comc26d94f2013-03-25 18:19:00 +000010
Mike Kleinc0bd9f92019-04-23 12:05:21 -050011#include "include/core/SkImageInfo.h"
12#include "include/core/SkRefCnt.h"
13#include "include/core/SkString.h"
Mike Kleinc0bd9f92019-04-23 12:05:21 -050014#include "include/gpu/GrDriverBugWorkarounds.h"
15#include "include/private/GrTypesPriv.h"
Greg Daniel01f278c2020-06-12 16:58:17 -040016#include "src/core/SkCompressedDataUtils.h"
Brian Salomon096b0912019-08-14 16:56:13 -040017#include "src/gpu/GrBlend.h"
Brian Salomonccb61422020-01-09 10:46:36 -050018#include "src/gpu/GrSamplerState.h"
Mike Kleinc0bd9f92019-04-23 12:05:21 -050019#include "src/gpu/GrShaderCaps.h"
Brian Salomon1e03b6b12019-07-17 17:28:24 -040020#include "src/gpu/GrSurfaceProxy.h"
commit-bot@chromium.org8b656c62013-11-21 15:23:15 +000021
Robert Phillipsfc711a22018-02-13 17:03:00 -050022class GrBackendFormat;
Greg Danielfaa095e2017-12-19 13:15:02 -050023class GrBackendRenderTarget;
Greg Danielf5d87582017-12-18 14:48:15 -050024class GrBackendTexture;
bsalomon682c2692015-05-22 14:01:46 -070025struct GrContextOptions;
Robert Phillips323471e2019-11-11 11:33:37 -050026class GrProcessorKeyBuilder;
Robert Phillips03e4c952019-11-26 16:20:22 -050027class GrProgramDesc;
28class GrProgramInfo;
Robert Phillipsbf25d432017-04-07 10:08:53 -040029class GrRenderTargetProxy;
Brian Salomon3d86a192018-02-27 16:46:11 -050030class GrSurface;
Brian Osman71a18892017-08-10 10:23:25 -040031class SkJSONWriter;
jvanverthe9c0fc62015-04-29 11:18:05 -070032
33/**
bsalomon4b91f762015-05-19 09:29:46 -070034 * Represents the capabilities of a GrContext.
jvanverthe9c0fc62015-04-29 11:18:05 -070035 */
bsalomon4b91f762015-05-19 09:29:46 -070036class GrCaps : public SkRefCnt {
jvanverthe9c0fc62015-04-29 11:18:05 -070037public:
bsalomon682c2692015-05-22 14:01:46 -070038 GrCaps(const GrContextOptions&);
bsalomon@google.comc26d94f2013-03-25 18:19:00 +000039
Brian Osman71a18892017-08-10 10:23:25 -040040 void dumpJSON(SkJSONWriter*) const;
41
Brian Salomon94efbf52016-11-29 13:43:05 -050042 const GrShaderCaps* shaderCaps() const { return fShaderCaps.get(); }
Robert Phillips7f11fb52019-12-03 13:35:19 -050043 sk_sp<const GrShaderCaps> refShaderCaps() const { return fShaderCaps; }
jvanverthe9c0fc62015-04-29 11:18:05 -070044
bsalomon@google.comc26d94f2013-03-25 18:19:00 +000045 bool npotTextureTileSupport() const { return fNPOTTextureTileSupport; }
commit-bot@chromium.org47442312013-12-19 16:18:01 +000046 /** To avoid as-yet-unnecessary complexity we don't allow any partial support of MIP Maps (e.g.
47 only for POT textures) */
Brian Salomon69100f02020-07-21 10:49:25 -040048 bool mipmapSupport() const { return fMipmapSupport; }
brianosman64d094d2016-03-25 06:01:59 -070049
commit-bot@chromium.orga3baf3b2014-02-21 18:45:30 +000050 bool gpuTracingSupport() const { return fGpuTracingSupport; }
Greg Danielc3e8a7e2021-05-14 12:53:48 -040051 bool oversizedAttachmentSupport() const { return fOversizedAttachmentSupport; }
cdaltonfd4167d2015-04-21 11:45:56 -070052 bool textureBarrierSupport() const { return fTextureBarrierSupport; }
Robert Phillips7f861922018-01-30 13:13:42 +000053 bool sampleLocationsSupport() const { return fSampleLocationsSupport; }
csmartdalton2b5f2cb2016-06-10 14:06:32 -070054 bool multisampleDisableSupport() const { return fMultisampleDisableSupport; }
Chris Daltona77cdee2020-04-03 14:50:43 -060055 bool drawInstancedSupport() const { return fDrawInstancedSupport; }
Chris Dalton03fdf6a2020-04-07 12:31:59 -060056 // Is there hardware support for indirect draws? (Ganesh always supports indirect draws as long
57 // as it can polyfill them with instanced calls, but this cap tells us if they are supported
58 // natively.)
59 bool nativeDrawIndirectSupport() const { return fNativeDrawIndirectSupport; }
Chris Daltonbde4bb72020-07-17 14:11:04 -060060 bool useClientSideIndirectBuffers() const {
61#ifdef SK_DEBUG
62 if (!fNativeDrawIndirectSupport || fNativeDrawIndexedIndirectIsBroken) {
63 // We might implement indirect draws with a polyfill, so the commands need to reside in
64 // CPU memory.
65 SkASSERT(fUseClientSideIndirectBuffers);
66 }
67#endif
68 return fUseClientSideIndirectBuffers;
69 }
Chris Daltonce425af2019-12-16 10:39:03 -070070 bool conservativeRasterSupport() const { return fConservativeRasterSupport; }
Chris Dalton1215cda2019-12-17 21:44:04 -070071 bool wireframeSupport() const { return fWireframeSupport; }
Chris Daltond5d8a642019-08-08 15:29:20 -060072 // This flag indicates that we never have to resolve MSAA. In practice, it means that we have
73 // an MSAA-render-to-texture extension: Any render target we create internally will use the
74 // extension, and any wrapped render target is the client's responsibility.
75 bool msaaResolvesAutomatically() const { return fMSAAResolvesAutomatically; }
Brian Osman499bf1a2018-09-17 11:32:42 -040076 bool halfFloatVertexAttributeSupport() const { return fHalfFloatVertexAttributeSupport; }
Chris Dalton27059d32018-01-23 14:06:50 -070077
78 // Primitive restart functionality is core in ES 3.0, but using it will cause slowdowns on some
79 // systems. This cap is only set if primitive restart will improve performance.
80 bool usePrimitiveRestart() const { return fUsePrimitiveRestart; }
81
csmartdalton485a1202016-07-13 10:16:32 -070082 bool preferClientSideDynamicBuffers() const { return fPreferClientSideDynamicBuffers; }
robertphillips@google.com2d2e5c42013-10-30 21:30:43 +000083
Chris Dalton344e9032017-12-11 15:42:09 -070084 // On tilers, an initial fullscreen clear is an OPTIMIZATION. It allows the hardware to
85 // initialize each tile with a constant value rather than loading each pixel from memory.
86 bool preferFullscreenClears() const { return fPreferFullscreenClears; }
87
Chris Dalton674f77a2019-09-30 20:49:39 -060088 // Should we discard stencil values after a render pass? (Tilers get better performance if we
89 // always load stencil buffers with a "clear" op, and then discard the content when finished.)
90 bool discardStencilValuesAfterRenderPass() const {
Chris Daltona8b16362020-07-17 17:38:54 -070091 // b/160958008
92 return false;
93#if 0
Chris Dalton674f77a2019-09-30 20:49:39 -060094 // This method is actually just a duplicate of preferFullscreenClears(), with a descriptive
95 // name for the sake of readability.
96 return this->preferFullscreenClears();
Chris Daltona8b16362020-07-17 17:38:54 -070097#endif
Chris Dalton674f77a2019-09-30 20:49:39 -060098 }
99
Chris Dalton3d28b6a2020-04-13 11:12:28 -0600100 // D3D does not allow the refs or masks to differ on a two-sided stencil draw.
101 bool twoSidedStencilRefsAndMasksMustMatch() const {
102 return fTwoSidedStencilRefsAndMasksMustMatch;
103 }
104
robertphillips63926682015-08-20 09:39:02 -0700105 bool preferVRAMUseOverFlushes() const { return fPreferVRAMUseOverFlushes; }
106
Eric Karl5c779752017-05-08 12:02:07 -0700107 bool avoidStencilBuffers() const { return fAvoidStencilBuffers; }
108
Greg Daniel4374e962018-09-28 15:09:47 -0400109 bool avoidWritePixelsFastPath() const { return fAvoidWritePixelsFastPath; }
110
Chris Daltone1196c52019-12-28 14:31:09 -0700111 // http://skbug.com/9739
112 bool requiresManualFBBarrierAfterTessellatedStencilDraw() const {
113 return fRequiresManualFBBarrierAfterTessellatedStencilDraw;
114 }
115
Chris Dalton03fdf6a2020-04-07 12:31:59 -0600116 // glDrawElementsIndirect fails GrMeshTest on every Win10 Intel bot.
117 bool nativeDrawIndexedIndirectIsBroken() const { return fNativeDrawIndexedIndirectIsBroken; }
118
csmartdaltone0d36292016-07-29 08:14:20 -0700119 /**
cdalton8917d622015-05-06 13:40:21 -0700120 * Indicates the capabilities of the fixed function blend unit.
121 */
122 enum BlendEquationSupport {
123 kBasic_BlendEquationSupport, //<! Support to select the operator that
124 // combines src and dst terms.
125 kAdvanced_BlendEquationSupport, //<! Additional fixed function support for specific
126 // SVG/PDF blend modes. Requires blend barriers.
127 kAdvancedCoherent_BlendEquationSupport, //<! Advanced blend equation support that does not
128 // require blend barriers, and permits overlap.
129
130 kLast_BlendEquationSupport = kAdvancedCoherent_BlendEquationSupport
131 };
132
133 BlendEquationSupport blendEquationSupport() const { return fBlendEquationSupport; }
134
135 bool advancedBlendEquationSupport() const {
136 return fBlendEquationSupport >= kAdvanced_BlendEquationSupport;
137 }
138
139 bool advancedCoherentBlendEquationSupport() const {
140 return kAdvancedCoherent_BlendEquationSupport == fBlendEquationSupport;
141 }
142
Jim Van Verth1bef9792020-07-09 08:09:13 -0400143 bool isAdvancedBlendEquationDisabled(GrBlendEquation equation) const {
cdalton1dd05422015-06-12 09:01:18 -0700144 SkASSERT(GrBlendEquationIsAdvanced(equation));
Chris Dalton302d5be2019-01-22 23:41:25 -0700145 SkASSERT(this->advancedBlendEquationSupport());
Jim Van Verth1bef9792020-07-09 08:09:13 -0400146 return SkToBool(fAdvBlendEqDisableFlags & (1 << equation));
cdalton1dd05422015-06-12 09:01:18 -0700147 }
148
Greg Danielf6d60d32020-01-08 13:39:16 -0500149 // On some GPUs it is a performance win to disable blending instead of doing src-over with a src
150 // alpha equal to 1. To disable blending we collapse src-over to src and the backends will
151 // handle the disabling of blending.
152 bool shouldCollapseSrcOverToSrcWhenAble() const {
153 return fShouldCollapseSrcOverToSrcWhenAble;
154 }
155
Greg Daniela89b4302021-01-29 10:48:40 -0500156 // When abandoning the GrDirectContext do we need to sync the GPU before we start abandoning
157 // resources.
158 bool mustSyncGpuDuringAbandon() const {
159 return fMustSyncGpuDuringAbandon;
160 }
161
Brian Salomone9f22652021-04-12 11:18:32 -0400162 // Shortcut for shaderCaps()->reducedShaderMode().
163 bool reducedShaderMode() const { return this->shaderCaps()->reducedShaderMode(); }
Brian Salomon91216d52021-04-09 11:57:59 -0400164
cdalton8917d622015-05-06 13:40:21 -0700165 /**
commit-bot@chromium.org160b4782014-05-05 12:32:37 +0000166 * Indicates whether GPU->CPU memory mapping for GPU resources such as vertex buffers and
167 * textures allows partial mappings or full mappings.
168 */
169 enum MapFlags {
Brian Salomon105d7c22019-04-16 13:46:14 -0400170 kNone_MapFlags = 0x0, //<! Cannot map the resource.
commit-bot@chromium.org160b4782014-05-05 12:32:37 +0000171
Brian Salomon105d7c22019-04-16 13:46:14 -0400172 kCanMap_MapFlag = 0x1, //<! The resource can be mapped. Must be set for any of
173 // the other flags to have meaning.
174 kSubset_MapFlag = 0x2, //<! The resource can be partially mapped.
Greg Daniel2d41d0d2019-08-26 11:08:51 -0400175 kAsyncRead_MapFlag = 0x4, //<! Are maps for reading asynchronous WRT GrOpsRenderPass
Brian Salomon105d7c22019-04-16 13:46:14 -0400176 // submitted to GrGpu.
commit-bot@chromium.org160b4782014-05-05 12:32:37 +0000177 };
178
Greg Daniel5af72c12021-02-08 13:52:08 -0500179 // This returns the general mapping support for the GPU. However, even if this returns a flag
180 // that says buffers can be mapped, it does NOT mean that every buffer will be mappable. Thus
181 // calls of map should still check to see if a valid pointer was returned from the map call and
182 // handle fallbacks appropriately. If this does return kNone_MapFlags then all calls to map() on
183 // any buffer will fail.
commit-bot@chromium.org160b4782014-05-05 12:32:37 +0000184 uint32_t mapBufferFlags() const { return fMapBufferFlags; }
185
robertphillips@google.com2d2e5c42013-10-30 21:30:43 +0000186 // Scratch textures not being reused means that those scratch textures
skia.committer@gmail.com7ed98df2013-10-31 07:01:53 +0000187 // that we upload to (i.e., don't have a render target) will not be
robertphillips@google.com2d2e5c42013-10-30 21:30:43 +0000188 // recycled in the texture cache. This is to prevent ghosting by drivers
189 // (in particular for deferred architectures).
commit-bot@chromium.orgb8356522013-07-18 22:26:39 +0000190 bool reuseScratchTextures() const { return fReuseScratchTextures; }
robertphillips1b8e1b52015-06-24 06:54:10 -0700191 bool reuseScratchBuffers() const { return fReuseScratchBuffers; }
bsalomon@google.comc26d94f2013-03-25 18:19:00 +0000192
bsalomon7dbd45d2016-03-23 10:40:53 -0700193 /// maximum number of attribute values per vertex
194 int maxVertexAttributes() const { return fMaxVertexAttributes; }
195
bsalomon@google.comc26d94f2013-03-25 18:19:00 +0000196 int maxRenderTargetSize() const { return fMaxRenderTargetSize; }
Chris Dalton2612bae2018-02-22 13:41:37 -0700197
198 /** This is the largest render target size that can be used without incurring extra perfomance
199 cost. It is usually the max RT size, unless larger render targets are known to be slower. */
200 int maxPreferredRenderTargetSize() const { return fMaxPreferredRenderTargetSize; }
201
bsalomon@google.comc26d94f2013-03-25 18:19:00 +0000202 int maxTextureSize() const { return fMaxTextureSize; }
Chris Dalton2612bae2018-02-22 13:41:37 -0700203
csmartdalton9bc11872016-08-09 12:42:47 -0700204 int maxWindowRectangles() const { return fMaxWindowRectangles; }
bsalomon@google.comc26d94f2013-03-25 18:19:00 +0000205
Chris Dalton57ab06c2021-04-22 12:57:28 -0600206 // Returns whether window rectangles are supported for the given backend render target.
Greg Daniel2a303902018-02-20 10:25:54 -0500207 bool isWindowRectanglesSupportedForRT(const GrBackendRenderTarget& rt) const {
208 return this->maxWindowRectangles() > 0 && this->onIsWindowRectanglesSupportedForRT(rt);
209 }
210
Jim Van Verth023f2e72020-10-09 15:38:58 -0400211 uint32_t maxPushConstantsSize() const { return fMaxPushConstantsSize; }
Jim Van Verth4b3d1f32020-10-08 15:46:36 -0400212
Robert Phillipsf209e882019-06-25 15:59:50 -0400213 virtual bool isFormatSRGB(const GrBackendFormat&) const = 0;
Greg Daniela00bcad2019-10-11 13:21:48 -0400214
Greg Daniel01f278c2020-06-12 16:58:17 -0400215 bool isFormatCompressed(const GrBackendFormat& format) const;
Robert Phillipsf209e882019-06-25 15:59:50 -0400216
Greg Daniel7bfc9132019-08-14 14:23:53 -0400217 // Can a texture be made with the GrBackendFormat, and then be bound and sampled in a shader.
218 virtual bool isFormatTexturable(const GrBackendFormat&) const = 0;
Brian Salomonbdecacf2018-02-02 20:32:49 -0500219
Greg Daniel6980c4e2019-07-30 16:18:18 -0400220 // Returns whether a texture of the given format can be copied to a texture of the same format.
221 virtual bool isFormatCopyable(const GrBackendFormat&) const = 0;
Brian Salomonbdecacf2018-02-02 20:32:49 -0500222
Greg Danieleadfac92019-08-02 09:03:53 -0400223 // Returns the maximum supported sample count for a format. 0 means the format is not renderable
Brian Salomon469046c2020-03-30 14:21:04 -0400224 // 1 means the format is renderable but doesn't support MSAA.
Greg Danieleadfac92019-08-02 09:03:53 -0400225 virtual int maxRenderTargetSampleCount(const GrBackendFormat&) const = 0;
Brian Salomonbdecacf2018-02-02 20:32:49 -0500226
Chris Dalton57ab06c2021-04-22 12:57:28 -0600227 // Returns the number of samples to use when performing draws to the given config with internal
228 // MSAA. If 0, Ganesh should not attempt to use internal multisampling.
Greg Danieleadfac92019-08-02 09:03:53 -0400229 int internalMultisampleCount(const GrBackendFormat& format) const {
Brian Osman788b9162020-02-07 10:36:46 -0500230 return std::min(fInternalMultisampleCount, this->maxRenderTargetSampleCount(format));
Chris Dalton1e6c5b82019-06-17 14:16:49 -0600231 }
232
Greg Daniel900583a2019-08-06 12:05:31 -0400233 virtual bool isFormatAsColorTypeRenderable(GrColorType ct, const GrBackendFormat& format,
234 int sampleCount = 1) const = 0;
235
236 virtual bool isFormatRenderable(const GrBackendFormat& format, int sampleCount) const = 0;
Brian Salomonbdecacf2018-02-02 20:32:49 -0500237
238 // Find a sample count greater than or equal to the requested count which is supported for a
Greg Daniel6fa62e22019-08-07 15:52:37 -0400239 // 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 -0500240 // sample count is 1 then 1 will be returned if non-MSAA rendering is supported, otherwise 0.
241 // For historical reasons requestedCount==0 is handled identically to requestedCount==1.
Greg Daniel6fa62e22019-08-07 15:52:37 -0400242 virtual int getRenderTargetSampleCount(int requestedCount, const GrBackendFormat&) const = 0;
commit-bot@chromium.org42dc8132014-05-27 19:26:59 +0000243
Brian Salomon5f33a8c2018-02-26 14:32:39 -0500244 /**
Brian Salomon3d86a192018-02-27 16:46:11 -0500245 * Backends may have restrictions on what types of surfaces support GrGpu::writePixels().
246 * If this returns false then the caller should implement a fallback where a temporary texture
247 * 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 -0500248 */
Brian Salomonc67c31c2018-12-06 10:00:03 -0500249 bool surfaceSupportsWritePixels(const GrSurface*) const;
Brian Salomon19eaf2d2018-03-19 16:06:44 -0400250
Emircan Uysaler23ca4e72019-06-24 10:53:09 -0400251 /**
Brian Salomondc0710f2019-07-01 14:59:32 -0400252 * Indicates whether surface supports GrGpu::readPixels, must be copied, or cannot be read.
Emircan Uysaler23ca4e72019-06-24 10:53:09 -0400253 */
Brian Salomondc0710f2019-07-01 14:59:32 -0400254 enum class SurfaceReadPixelsSupport {
255 /** GrGpu::readPixels is supported by the surface. */
256 kSupported,
257 /**
258 * GrGpu::readPixels is not supported by this surface but this surface can be drawn
259 * or copied to a Ganesh-created GrTextureType::kTexture2D and then that surface will be
260 * readable.
261 */
262 kCopyToTexture2D,
263 /**
264 * Not supported
265 */
266 kUnsupported,
Emircan Uysaler23ca4e72019-06-24 10:53:09 -0400267 };
Brian Salomon19eaf2d2018-03-19 16:06:44 -0400268 /**
Brian Salomondc0710f2019-07-01 14:59:32 -0400269 * Backends may have restrictions on what types of surfaces support GrGpu::readPixels(). We may
270 * either be able to read directly from the surface, read from a copy of the surface, or not
271 * read at all.
Brian Salomon19eaf2d2018-03-19 16:06:44 -0400272 */
Brian Salomondc0710f2019-07-01 14:59:32 -0400273 virtual SurfaceReadPixelsSupport surfaceSupportsReadPixels(const GrSurface*) const = 0;
Brian Salomon5f33a8c2018-02-26 14:32:39 -0500274
Brian Salomon42be09d2019-07-26 12:12:26 -0400275 struct SupportedWrite {
276 GrColorType fColorType;
277 // If the write is occurring using GrGpu::transferPixelsTo then this provides the
278 // minimum alignment of the offset into the transfer buffer.
279 size_t fOffsetAlignmentForTransferBuffer;
280 };
281
Brian Salomon5f33a8c2018-02-26 14:32:39 -0500282 /**
283 * Given a dst pixel config and a src color type what color type must the caller coax the
284 * the data into in order to use GrGpu::writePixels().
285 */
Brian Salomon01915c02019-08-02 09:57:21 -0400286 virtual SupportedWrite supportedWritePixelsColorType(GrColorType surfaceColorType,
287 const GrBackendFormat& surfaceFormat,
Brian Salomon42be09d2019-07-26 12:12:26 -0400288 GrColorType srcColorType) const = 0;
Brian Salomon5f33a8c2018-02-26 14:32:39 -0500289
Brian Salomonf30b1c12019-06-20 12:25:02 -0400290 struct SupportedRead {
Brian Salomonf30b1c12019-06-20 12:25:02 -0400291 GrColorType fColorType;
Brian Salomon42be09d2019-07-26 12:12:26 -0400292 // If the read is occurring using GrGpu::transferPixelsFrom then this provides the
293 // minimum alignment of the offset into the transfer buffer.
Greg Danielba88ab62019-07-26 09:14:01 -0400294 size_t fOffsetAlignmentForTransferBuffer;
Brian Salomonf30b1c12019-06-20 12:25:02 -0400295 };
296
Brian Salomon19eaf2d2018-03-19 16:06:44 -0400297 /**
Greg Daniel00fb7242019-07-18 14:28:01 -0400298 * 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 -0400299 * would like read into, this provides a legal color type that the caller may pass to
300 * GrGpu::readPixels(). The returned color type may differ from the passed dstColorType, in
301 * which case the caller must convert the read pixel data (see GrConvertPixels). When converting
302 * to dstColorType the swizzle in the returned struct should be applied. The caller must check
303 * the returned color type for kUnknown.
Brian Salomon19eaf2d2018-03-19 16:06:44 -0400304 */
Greg Danielba88ab62019-07-26 09:14:01 -0400305 SupportedRead supportedReadPixelsColorType(GrColorType srcColorType,
306 const GrBackendFormat& srcFormat,
307 GrColorType dstColorType) const;
Brian Salomon19eaf2d2018-03-19 16:06:44 -0400308
Brian Salomon1047a492019-07-02 12:25:21 -0400309 /**
310 * Do GrGpu::writePixels() and GrGpu::transferPixelsTo() support a src buffer where the row
311 * bytes is not equal to bpp * w?
312 */
313 bool writePixelsRowBytesSupport() const { return fWritePixelsRowBytesSupport; }
314 /**
315 * Does GrGpu::readPixels() support a dst buffer where the row bytes is not equal to bpp * w?
316 */
317 bool readPixelsRowBytesSupport() const { return fReadPixelsRowBytesSupport; }
318
Brian Salomonfb28c6f2020-01-10 13:04:45 -0500319 bool transferFromSurfaceToBufferSupport() const { return fTransferFromSurfaceToBufferSupport; }
320 bool transferFromBufferToTextureSupport() const { return fTransferFromBufferToTextureSupport; }
Brian Salomone05ba5a2019-04-08 11:59:07 -0400321
robertphillipscaef3452015-11-11 13:18:11 -0800322 bool suppressPrints() const { return fSuppressPrints; }
323
cdalton397536c2016-03-25 12:15:03 -0700324 size_t bufferMapThreshold() const {
325 SkASSERT(fBufferMapThreshold >= 0);
326 return fBufferMapThreshold;
joshualitt7224c862015-05-29 06:46:47 -0700327 }
bsalomon682c2692015-05-22 14:01:46 -0700328
Mike Kleinfc6c37b2016-09-27 09:34:10 -0400329 /** True in environments that will issue errors if memory uploaded to buffers
bsalomon7dea7b72015-08-19 08:26:51 -0700330 is not initialized (even if not read by draw calls). */
331 bool mustClearUploadedBufferData() const { return fMustClearUploadedBufferData; }
332
Kevin Lubick61a5f0a2019-03-28 09:47:15 -0400333 /** For some environments, there is a performance or safety concern to not
334 initializing textures. For example, with WebGL and Firefox, there is a large
335 performance hit to not doing it.
336 */
337 bool shouldInitializeTextures() const { return fShouldInitializeTextures; }
338
Greg Danielb2acf0a2018-09-12 09:17:11 -0400339 /** Returns true if the given backend supports importing AHardwareBuffers via the
340 * GrAHardwarebufferImageGenerator. This will only ever be supported on Android devices with API
341 * level >= 26.
342 * */
343 bool supportsAHardwareBufferImages() const { return fSupportsAHardwareBufferImages; }
344
Jim Van Verthfbdc0802017-05-02 16:15:53 -0400345 bool wireframeMode() const { return fWireframeMode; }
346
Brian Salomon9ff5acb2019-05-08 09:04:47 -0400347 /** Supports using GrFence. */
jvanverth84741b32016-09-30 08:39:02 -0700348 bool fenceSyncSupport() const { return fFenceSyncSupport; }
Brian Salomon9ff5acb2019-05-08 09:04:47 -0400349
350 /** Supports using GrSemaphore. */
351 bool semaphoreSupport() const { return fSemaphoreSupport; }
352
Brian Osman2c2bc112017-02-28 10:02:49 -0500353 bool crossContextTextureSupport() const { return fCrossContextTextureSupport; }
Brian Salomon467921e2017-03-06 16:17:12 -0500354 /**
Greg Daniel25af6712018-04-25 10:44:38 -0400355 * Returns whether or not we will be able to do a copy given the passed in params
356 */
Brian Salomonc67c31c2018-12-06 10:00:03 -0500357 bool canCopySurface(const GrSurfaceProxy* dst, const GrSurfaceProxy* src,
358 const SkIRect& srcRect, const SkIPoint& dstPoint) const;
Greg Daniel25af6712018-04-25 10:44:38 -0400359
Brian Salomonf7232642018-09-19 08:58:08 -0400360 bool dynamicStateArrayGeometryProcessorTextureSupport() const {
361 return fDynamicStateArrayGeometryProcessorTextureSupport;
362 }
363
Michael Ludwigc39d0c82019-01-15 10:03:43 -0500364 // Not all backends support clearing with a scissor test (e.g. Metal), this will always
365 // return true if performColorClearsAsDraws() returns true.
Michael Ludwiga21d1962019-01-11 15:26:22 -0500366 bool performPartialClearsAsDraws() const {
Michael Ludwigc39d0c82019-01-15 10:03:43 -0500367 return fPerformColorClearsAsDraws || fPerformPartialClearsAsDraws;
Michael Ludwiga21d1962019-01-11 15:26:22 -0500368 }
369
370 // Many drivers have issues with color clears.
Chris Daltona8fbeba2019-03-30 00:31:23 -0600371 bool performColorClearsAsDraws() const { return fPerformColorClearsAsDraws; }
Michael Ludwiga21d1962019-01-11 15:26:22 -0500372
Robert Phillips2f05a482019-11-25 09:54:43 -0500373 bool avoidLargeIndexBufferDraws() const { return fAvoidLargeIndexBufferDraws; }
374
Michael Ludwiga21d1962019-01-11 15:26:22 -0500375 /// Adreno 4xx devices experience an issue when there are a large number of stencil clip bit
376 /// clears. The minimal repro steps are not precisely known but drawing a rect with a stencil
377 /// op instead of using glClear seems to resolve the issue.
Chris Daltona8fbeba2019-03-30 00:31:23 -0600378 bool performStencilClearsAsDraws() const { return fPerformStencilClearsAsDraws; }
379
Chris Dalton94310792021-03-12 11:10:24 -0700380 // Should we disable the clip mask atlas due to a faulty driver?
381 bool driverDisableMSAAClipAtlas() const { return fDriverDisableMSAAClipAtlas; }
Ethan Nicholas56d19a52018-10-15 11:26:20 -0400382
Chris Daltoneae5c162020-12-29 10:18:21 -0700383 // Should we disable GrTessellationPathRenderer due to a faulty driver?
384 bool disableTessellationPathRenderer() const { return fDisableTessellationPathRenderer; }
385
Greg Danield358cbe2020-09-11 09:33:54 -0400386 // Returns how to sample the dst values for the passed in GrRenderTargetProxy.
387 GrDstSampleType getDstSampleTypeForProxy(const GrRenderTargetProxy*) const;
388
Greg Daniel25af6712018-04-25 10:44:38 -0400389 /**
Brian Salomon1e03b6b12019-07-17 17:28:24 -0400390 * This is used to try to ensure a successful copy a dst in order to perform shader-based
391 * blending.
392 *
393 * fRectsMustMatch will be set to true if the copy operation must ensure that the src and dest
394 * rects are identical.
395 *
396 * fMustCopyWholeSrc will be set to true if copy rect must equal src's bounds.
397 *
398 * Caller will detect cases when copy cannot succeed and try copy-as-draw as a fallback.
Brian Salomon467921e2017-03-06 16:17:12 -0500399 */
Brian Salomon1e03b6b12019-07-17 17:28:24 -0400400 struct DstCopyRestrictions {
401 GrSurfaceProxy::RectsMustMatch fRectsMustMatch = GrSurfaceProxy::RectsMustMatch::kNo;
402 bool fMustCopyWholeSrc = false;
403 };
Greg Daniel0258c902019-08-01 13:08:33 -0400404 virtual DstCopyRestrictions getDstCopyRestrictions(const GrRenderTargetProxy* src,
405 GrColorType ct) const {
Brian Salomon1e03b6b12019-07-17 17:28:24 -0400406 return {};
407 }
Brian Salomon467921e2017-03-06 16:17:12 -0500408
Greg Daniel9a48beb2020-01-16 16:57:16 -0500409 bool validateSurfaceParams(const SkISize&, const GrBackendFormat&, GrRenderable renderable,
Brian Salomon7e67dca2020-07-21 09:27:25 -0400410 int renderTargetSampleCnt, GrMipmapped) const;
Brian Salomonbdecacf2018-02-02 20:32:49 -0500411
Greg Daniel01f278c2020-06-12 16:58:17 -0400412 bool areColorTypeAndFormatCompatible(GrColorType grCT, const GrBackendFormat& format) const;
Robert Phillipsc046ff02019-07-01 10:34:03 -0400413
Brian Salomonf391d0f2018-12-14 09:18:50 -0500414 /** These are used when creating a new texture internally. */
Robert Phillips0a15cc62019-07-30 12:49:10 -0400415 GrBackendFormat getDefaultBackendFormat(GrColorType, GrRenderable) const;
Greg Daniel4065d452018-11-16 15:43:41 -0500416
Brian Salomonbb8dde82019-06-27 10:52:13 -0400417 virtual GrBackendFormat getBackendFormatFromCompressionType(SkImage::CompressionType) const = 0;
418
Timothy Liang036fdfe2018-06-28 15:50:36 -0400419 /**
Michael Ludwigf23a1522018-12-10 11:36:13 -0500420 * The CLAMP_TO_BORDER wrap mode for texture coordinates was added to desktop GL in 1.3, and
421 * GLES 3.2, but is also available in extensions. Vulkan and Metal always have support.
422 */
423 bool clampToBorderSupport() const { return fClampToBorderSupport; }
424
Greg Danieleb4a8272019-05-16 16:52:55 -0400425 /**
Greg Daniel14b57212019-12-17 16:18:06 -0500426 * Returns the GrSwizzle to use when sampling or reading back from a texture with the passed in
427 * GrBackendFormat and GrColorType.
Greg Danieleb4a8272019-05-16 16:52:55 -0400428 */
Greg Daniel01f278c2020-06-12 16:58:17 -0400429 GrSwizzle getReadSwizzle(const GrBackendFormat& format, GrColorType colorType) const;
Greg Danieleb4a8272019-05-16 16:52:55 -0400430
431 /**
Brian Salomon982f5462020-03-30 12:52:33 -0400432 * Returns the GrSwizzle to use when writing colors to a surface with the passed in
Greg Danieleb4a8272019-05-16 16:52:55 -0400433 * GrBackendFormat and GrColorType.
434 */
Brian Salomon982f5462020-03-30 12:52:33 -0400435 virtual GrSwizzle getWriteSwizzle(const GrBackendFormat&, GrColorType) const = 0;
Greg Danieleb4a8272019-05-16 16:52:55 -0400436
Greg Danield51fa2f2020-01-22 16:53:38 -0500437 virtual uint64_t computeFormatKey(const GrBackendFormat&) 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 /**
Robert Phillips323471e2019-11-11 11:33:37 -0500442 * Adds fields to the key to represent the sampler that will be created for the passed
443 * in parameters. Currently this extra keying is only needed when building a vulkan pipeline
444 * with immutable samplers.
445 */
446 virtual void addExtraSamplerKey(GrProcessorKeyBuilder*,
Brian Salomonccb61422020-01-09 10:46:36 -0500447 GrSamplerState,
Robert Phillips323471e2019-11-11 11:33:37 -0500448 const GrBackendFormat&) const {}
449
Greg Daniel91b37b12021-01-05 15:40:54 -0500450 enum class ProgramDescOverrideFlags {
451 kNone = 0,
452 // If using discardable msaa surfaces in vulkan, when we break up a render pass for an
453 // inline upload, we must do a load msaa subpass for the second render pass. However, if the
454 // original render pass did not have this load subpass (e.g. clear or discard load op), then
455 // all the GrProgramInfos for draws that end up in the second render pass will have been
456 // recorded thinking they will be in a render pass with only 1 subpass. Thus we add an
457 // override flag to the makeDesc call to force the actually VkPipeline that gets created to
458 // be created using a render pass with 2 subpasses. We do miss on the pre-compile with this
459 // approach, but inline uploads are very rare and already slow.
460 kVulkanHasResolveLoadSubpass = 0x1,
461 };
462 GR_DECL_BITFIELD_CLASS_OPS_FRIENDS(ProgramDescOverrideFlags);
463
464
465 virtual GrProgramDesc makeDesc(
466 GrRenderTarget*, const GrProgramInfo&,
467 ProgramDescOverrideFlags overrideFlags = ProgramDescOverrideFlags::kNone) const = 0;
Robert Phillips03e4c952019-11-26 16:20:22 -0500468
Greg Daniel638b2e82020-08-27 14:29:00 -0400469 // This method specifies, for each backend, the extra properties of a RT when Ganesh creates one
470 // internally. For example, for Vulkan, Ganesh always creates RTs that can be used as input
471 // attachments.
472 virtual GrInternalSurfaceFlags getExtraSurfaceFlagsForDeferredRT() const {
473 return GrInternalSurfaceFlags::kNone;
474 }
475
Chris Dalton710e1c92021-04-23 13:07:52 -0600476 bool supportsDynamicMSAA(const GrRenderTargetProxy*) const;
477
Adlai Holler75b43ce2021-05-03 11:37:24 -0400478 // skbug.com/11935. Task reordering is disabled for some GPUs on GL due to driver bugs.
479 bool avoidReorderingRenderTasks() const {
480 return fAvoidReorderingRenderTasks;
481 }
482
Robert Phillipsffe27292019-08-01 10:08:07 -0400483#if GR_TEST_UTILS
484 struct TestFormatColorTypeCombination {
485 GrColorType fColorType;
486 GrBackendFormat fFormat;
487 };
488
489 virtual std::vector<TestFormatColorTypeCombination> getTestingCombinations() const = 0;
490#endif
491
bsalomon@google.comc26d94f2013-03-25 18:19:00 +0000492protected:
Chris Dalton8367e112019-11-13 12:43:21 -0700493 // Subclasses must call this at the end of their init method in order to do final processing on
494 // the caps (including overrides requested by the client).
495 // NOTE: this method will only reduce the caps, never expand them.
496 void finishInitialization(const GrContextOptions& options);
bsalomon4ee6bd82015-05-27 13:23:23 -0700497
Chris Dalton710e1c92021-04-23 13:07:52 -0600498 virtual bool onSupportsDynamicMSAA(const GrRenderTargetProxy*) const { return false; }
499
bungeman6bd52842016-10-27 09:30:08 -0700500 sk_sp<GrShaderCaps> fShaderCaps;
jvanverthe9c0fc62015-04-29 11:18:05 -0700501
joshualitt83bc2292015-06-18 14:18:02 -0700502 bool fNPOTTextureTileSupport : 1;
Brian Salomon69100f02020-07-21 10:49:25 -0400503 bool fMipmapSupport : 1;
joshualitt83bc2292015-06-18 14:18:02 -0700504 bool fReuseScratchTextures : 1;
robertphillips1b8e1b52015-06-24 06:54:10 -0700505 bool fReuseScratchBuffers : 1;
joshualitt83bc2292015-06-18 14:18:02 -0700506 bool fGpuTracingSupport : 1;
Greg Danielc3e8a7e2021-05-14 12:53:48 -0400507 bool fOversizedAttachmentSupport : 1;
joshualitt83bc2292015-06-18 14:18:02 -0700508 bool fTextureBarrierSupport : 1;
Robert Phillips7f861922018-01-30 13:13:42 +0000509 bool fSampleLocationsSupport : 1;
csmartdalton2b5f2cb2016-06-10 14:06:32 -0700510 bool fMultisampleDisableSupport : 1;
Chris Daltona77cdee2020-04-03 14:50:43 -0600511 bool fDrawInstancedSupport : 1;
Chris Dalton03fdf6a2020-04-07 12:31:59 -0600512 bool fNativeDrawIndirectSupport : 1;
Chris Daltonbde4bb72020-07-17 14:11:04 -0600513 bool fUseClientSideIndirectBuffers : 1;
Chris Daltonce425af2019-12-16 10:39:03 -0700514 bool fConservativeRasterSupport : 1;
Chris Dalton1215cda2019-12-17 21:44:04 -0700515 bool fWireframeSupport : 1;
Chris Daltond5d8a642019-08-08 15:29:20 -0600516 bool fMSAAResolvesAutomatically : 1;
Chris Dalton27059d32018-01-23 14:06:50 -0700517 bool fUsePrimitiveRestart : 1;
csmartdalton485a1202016-07-13 10:16:32 -0700518 bool fPreferClientSideDynamicBuffers : 1;
Chris Dalton344e9032017-12-11 15:42:09 -0700519 bool fPreferFullscreenClears : 1;
Chris Dalton3d28b6a2020-04-13 11:12:28 -0600520 bool fTwoSidedStencilRefsAndMasksMustMatch : 1;
bsalomon7dea7b72015-08-19 08:26:51 -0700521 bool fMustClearUploadedBufferData : 1;
Kevin Lubick61a5f0a2019-03-28 09:47:15 -0400522 bool fShouldInitializeTextures : 1;
Greg Danielb2acf0a2018-09-12 09:17:11 -0400523 bool fSupportsAHardwareBufferImages : 1;
Brian Osman499bf1a2018-09-17 11:32:42 -0400524 bool fHalfFloatVertexAttributeSupport : 1;
Michael Ludwigf23a1522018-12-10 11:36:13 -0500525 bool fClampToBorderSupport : 1;
Michael Ludwiga21d1962019-01-11 15:26:22 -0500526 bool fPerformPartialClearsAsDraws : 1;
527 bool fPerformColorClearsAsDraws : 1;
Robert Phillips2f05a482019-11-25 09:54:43 -0500528 bool fAvoidLargeIndexBufferDraws : 1;
Michael Ludwiga21d1962019-01-11 15:26:22 -0500529 bool fPerformStencilClearsAsDraws : 1;
Brian Salomonfb28c6f2020-01-10 13:04:45 -0500530 bool fTransferFromBufferToTextureSupport : 1;
531 bool fTransferFromSurfaceToBufferSupport : 1;
Brian Salomon1047a492019-07-02 12:25:21 -0400532 bool fWritePixelsRowBytesSupport : 1;
533 bool fReadPixelsRowBytesSupport : 1;
Greg Danielf6d60d32020-01-08 13:39:16 -0500534 bool fShouldCollapseSrcOverToSrcWhenAble : 1;
Greg Daniela89b4302021-01-29 10:48:40 -0500535 bool fMustSyncGpuDuringAbandon : 1;
robertphillips1b8e1b52015-06-24 06:54:10 -0700536
bsalomon63b21962014-11-05 07:05:34 -0800537 // Driver workaround
Chris Dalton94310792021-03-12 11:10:24 -0700538 bool fDriverDisableMSAAClipAtlas : 1;
Chris Daltoneae5c162020-12-29 10:18:21 -0700539 bool fDisableTessellationPathRenderer : 1;
Eric Karl5c779752017-05-08 12:02:07 -0700540 bool fAvoidStencilBuffers : 1;
Greg Daniel4374e962018-09-28 15:09:47 -0400541 bool fAvoidWritePixelsFastPath : 1;
Chris Daltone1196c52019-12-28 14:31:09 -0700542 bool fRequiresManualFBBarrierAfterTessellatedStencilDraw : 1;
Chris Dalton03fdf6a2020-04-07 12:31:59 -0600543 bool fNativeDrawIndexedIndirectIsBroken : 1;
Adlai Holler75b43ce2021-05-03 11:37:24 -0400544 bool fAvoidReorderingRenderTasks : 1;
bsalomon63b21962014-11-05 07:05:34 -0800545
Brian Salomon01b476a2018-01-23 11:06:41 -0500546 // ANGLE performance workaround
robertphillips63926682015-08-20 09:39:02 -0700547 bool fPreferVRAMUseOverFlushes : 1;
548
jvanverth84741b32016-09-30 08:39:02 -0700549 bool fFenceSyncSupport : 1;
Brian Salomon9ff5acb2019-05-08 09:04:47 -0400550 bool fSemaphoreSupport : 1;
ethannicholas28ef4452016-03-25 09:26:03 -0700551
Brian Salomonf7232642018-09-19 08:58:08 -0400552 // Requires fence sync support in GL.
Brian Osman2c2bc112017-02-28 10:02:49 -0500553 bool fCrossContextTextureSupport : 1;
554
Brian Salomonf7232642018-09-19 08:58:08 -0400555 // Not (yet) implemented in VK backend.
556 bool fDynamicStateArrayGeometryProcessorTextureSupport : 1;
557
cdalton8917d622015-05-06 13:40:21 -0700558 BlendEquationSupport fBlendEquationSupport;
Jim Van Verth1bef9792020-07-09 08:09:13 -0400559 uint32_t fAdvBlendEqDisableFlags;
Brian Salomon4dea72a2019-12-18 10:43:10 -0500560 static_assert(kLast_GrBlendEquation < 32);
cdalton1dd05422015-06-12 09:01:18 -0700561
commit-bot@chromium.org160b4782014-05-05 12:32:37 +0000562 uint32_t fMapBufferFlags;
cdalton397536c2016-03-25 12:15:03 -0700563 int fBufferMapThreshold;
commit-bot@chromium.org160b4782014-05-05 12:32:37 +0000564
bsalomon@google.comc26d94f2013-03-25 18:19:00 +0000565 int fMaxRenderTargetSize;
Chris Dalton2612bae2018-02-22 13:41:37 -0700566 int fMaxPreferredRenderTargetSize;
bsalomon7dbd45d2016-03-23 10:40:53 -0700567 int fMaxVertexAttributes;
bsalomon@google.comc26d94f2013-03-25 18:19:00 +0000568 int fMaxTextureSize;
csmartdalton9bc11872016-08-09 12:42:47 -0700569 int fMaxWindowRectangles;
Chris Daltona1638a52019-06-24 11:54:24 -0600570 int fInternalMultisampleCount;
Jim Van Verth023f2e72020-10-09 15:38:58 -0400571 uint32_t fMaxPushConstantsSize = 0;
bsalomon@google.comc26d94f2013-03-25 18:19:00 +0000572
Adrienne Walker68314842018-05-14 14:02:53 -0700573 GrDriverBugWorkarounds fDriverBugWorkarounds;
574
egdanielbc127a32014-09-19 12:07:43 -0700575private:
Chris Dalton8367e112019-11-13 12:43:21 -0700576 void applyOptionsOverrides(const GrContextOptions& options);
577
Mike Kleinfc6c37b2016-09-27 09:34:10 -0400578 virtual void onApplyOptionsOverrides(const GrContextOptions&) {}
Brian Osman71a18892017-08-10 10:23:25 -0400579 virtual void onDumpJSON(SkJSONWriter*) const {}
Brian Salomonc67c31c2018-12-06 10:00:03 -0500580 virtual bool onSurfaceSupportsWritePixels(const GrSurface*) const = 0;
581 virtual bool onCanCopySurface(const GrSurfaceProxy* dst, const GrSurfaceProxy* src,
582 const SkIRect& srcRect, const SkIPoint& dstPoint) const = 0;
Brian Salomon469046c2020-03-30 14:21:04 -0400583 virtual GrBackendFormat onGetDefaultBackendFormat(GrColorType) const = 0;
egdanielb7e7d572015-11-04 04:23:53 -0800584
Greg Daniel2a303902018-02-20 10:25:54 -0500585 // Backends should implement this if they have any extra requirements for use of window
586 // rectangles for a specific GrBackendRenderTarget outside of basic support.
587 virtual bool onIsWindowRectanglesSupportedForRT(const GrBackendRenderTarget&) const {
588 return true;
589 }
590
Greg Daniel627d0532019-07-08 16:48:14 -0400591 virtual bool onAreColorTypeAndFormatCompatible(GrColorType, const GrBackendFormat&) const = 0;
592
Greg Danielba88ab62019-07-26 09:14:01 -0400593 virtual SupportedRead onSupportedReadPixelsColorType(GrColorType srcColorType,
594 const GrBackendFormat& srcFormat,
595 GrColorType dstColorType) const = 0;
596
Greg Daniel01f278c2020-06-12 16:58:17 -0400597 virtual GrSwizzle onGetReadSwizzle(const GrBackendFormat&, GrColorType) const = 0;
598
Greg Danield358cbe2020-09-11 09:33:54 -0400599 virtual GrDstSampleType onGetDstSampleTypeForProxy(const GrRenderTargetProxy*) const {
600 return GrDstSampleType::kAsTextureCopy;
601 }
Greg Daniel01f278c2020-06-12 16:58:17 -0400602
robertphillipscaef3452015-11-11 13:18:11 -0800603 bool fSuppressPrints : 1;
Jim Van Verthfbdc0802017-05-02 16:15:53 -0400604 bool fWireframeMode : 1;
bsalomon682c2692015-05-22 14:01:46 -0700605
John Stiles7571f9e2020-09-02 22:42:33 -0400606 using INHERITED = SkRefCnt;
bsalomon@google.comc26d94f2013-03-25 18:19:00 +0000607};
608
Greg Daniel91b37b12021-01-05 15:40:54 -0500609GR_MAKE_BITFIELD_CLASS_OPS(GrCaps::ProgramDescOverrideFlags);
610
bsalomon@google.comc26d94f2013-03-25 18:19:00 +0000611#endif