#include <GrMtlCaps.h>

Inheritance diagram for GrMtlCaps:

Public Member Functions
	GrMtlCaps (const GrContextOptions &contextOptions, id< MTLDevice > device)

bool	isFormatSRGB (const GrBackendFormat &) const override

bool	isFormatTexturable (const GrBackendFormat &, GrTextureType) const override

bool	isFormatTexturable (MTLPixelFormat) const

bool	isFormatCopyable (const GrBackendFormat &) const override

bool	isFormatAsColorTypeRenderable (GrColorType ct, const GrBackendFormat &format, int sampleCount=1) const override

bool	isFormatRenderable (const GrBackendFormat &format, int sampleCount) const override

bool	isFormatRenderable (MTLPixelFormat, int sampleCount) const

int	getRenderTargetSampleCount (int requestedCount, const GrBackendFormat &) const override

int	getRenderTargetSampleCount (int requestedCount, MTLPixelFormat) const

int	maxRenderTargetSampleCount (const GrBackendFormat &) const override

int	maxRenderTargetSampleCount (MTLPixelFormat) const

SupportedWrite	supportedWritePixelsColorType (GrColorType surfaceColorType, const GrBackendFormat &surfaceFormat, GrColorType srcColorType) const override

SurfaceReadPixelsSupport	surfaceSupportsReadPixels (const GrSurface *) const override

DstCopyRestrictions	getDstCopyRestrictions (const GrRenderTargetProxy *src, GrColorType ct) const override

MTLPixelFormat	preferredStencilFormat () const

bool	canCopyAsBlit (MTLPixelFormat dstFormat, int dstSampleCount, MTLPixelFormat srcFormat, int srcSampleCount, const SkIRect &srcRect, const SkIPoint &dstPoint, bool areDstSrcSameObj) const

bool	canCopyAsResolve (MTLPixelFormat dstFormat, int dstSampleCount, MTLPixelFormat srcFormat, int srcSampleCount, bool srcIsRenderTarget, const SkISize srcDimensions, const SkIRect &srcRect, const SkIPoint &dstPoint, bool areDstSrcSameObj) const

GrBackendFormat	getBackendFormatFromCompressionType (SkTextureCompressionType) const override

MTLPixelFormat	getFormatFromColorType (GrColorType colorType) const

skgpu::Swizzle	getWriteSwizzle (const GrBackendFormat &, GrColorType) const override

uint64_t	computeFormatKey (const GrBackendFormat &) const override

GrProgramDesc	makeDesc (GrRenderTarget *, const GrProgramInfo &, ProgramDescOverrideFlags) const override

MTLPixelFormat	getStencilPixelFormat (const GrProgramDesc &desc) const

bool	isMac () const

bool	isApple () const

size_t	getMinBufferAlignment () const

bool	storeAndMultisampleResolveSupport () const

bool	renderTargetSupportsDiscardableMSAA (const GrMtlRenderTarget *) const

void	onDumpJSON (SkJSONWriter *) const override

Public Member Functions inherited from GrCaps
	GrCaps (const GrContextOptions &)

void	dumpJSON (SkJSONWriter *) const

const GrShaderCaps *	shaderCaps () const

bool	npotTextureTileSupport () const

bool	mipmapSupport () const

bool	anisoSupport () const

bool	gpuTracingSupport () const

bool	oversizedStencilSupport () const

bool	textureBarrierSupport () const

bool	sampleLocationsSupport () const

bool	drawInstancedSupport () const

bool	nativeDrawIndirectSupport () const

bool	useClientSideIndirectBuffers () const

bool	conservativeRasterSupport () const

bool	wireframeSupport () const

bool	msaaResolvesAutomatically () const

bool	preferDiscardableMSAAAttachment () const

bool	halfFloatVertexAttributeSupport () const

bool	usePrimitiveRestart () const

bool	preferClientSideDynamicBuffers () const

bool	preferFullscreenClears () const

bool	discardStencilValuesAfterRenderPass () const

bool	twoSidedStencilRefsAndMasksMustMatch () const

bool	preferVRAMUseOverFlushes () const

bool	avoidStencilBuffers () const

bool	avoidWritePixelsFastPath () const

bool	nativeDrawIndexedIndirectIsBroken () const

BlendEquationSupport	blendEquationSupport () const

bool	advancedBlendEquationSupport () const

bool	advancedCoherentBlendEquationSupport () const

bool	isAdvancedBlendEquationDisabled (skgpu::BlendEquation equation) const

bool	shouldCollapseSrcOverToSrcWhenAble () const

bool	mustSyncGpuDuringAbandon () const

bool	reducedShaderMode () const

uint32_t	mapBufferFlags () const

bool	reuseScratchTextures () const

bool	reuseScratchBuffers () const

int	maxVertexAttributes () const
	maximum number of attribute values per vertex

int	maxRenderTargetSize () const

int	maxPreferredRenderTargetSize () const

int	maxTextureSize () const

int	maxWindowRectangles () const

bool	isWindowRectanglesSupportedForRT (const GrBackendRenderTarget &rt) const

uint32_t	maxPushConstantsSize () const

size_t	transferBufferRowBytesAlignment () const

size_t	transferFromBufferToBufferAlignment () const

size_t	bufferUpdateDataPreserveAlignment () const

bool	isFormatCompressed (const GrBackendFormat &format) const

int	internalMultisampleCount (const GrBackendFormat &format) const

bool	surfaceSupportsWritePixels (const GrSurface *) const

SupportedRead	supportedReadPixelsColorType (GrColorType srcColorType, const GrBackendFormat &srcFormat, GrColorType dstColorType) const

bool	writePixelsRowBytesSupport () const

bool	transferPixelsToRowBytesSupport () const

bool	readPixelsRowBytesSupport () const

bool	transferFromSurfaceToBufferSupport () const

bool	transferFromBufferToTextureSupport () const

bool	transferFromBufferToBufferSupport () const

bool	suppressPrints () const

size_t	bufferMapThreshold () const

bool	mustClearUploadedBufferData () const

bool	shouldInitializeTextures () const

bool	buffersAreInitiallyZero () const

bool	supportsAHardwareBufferImages () const

bool	wireframeMode () const

bool	semaphoreSupport () const

bool	backendSemaphoreSupport () const

bool	finishedProcAsyncCallbackSupport () const

bool	crossContextTextureSupport () const

bool	canCopySurface (const GrSurfaceProxy dst, const SkIRect &dstRect, const GrSurfaceProxy src, const SkIRect &srcRect) const

bool	dynamicStateArrayGeometryProcessorTextureSupport () const

bool	supportsProtectedContent () const

bool	performPartialClearsAsDraws () const

bool	performColorClearsAsDraws () const

bool	avoidLargeIndexBufferDraws () const

bool	performStencilClearsAsDraws () const

bool	disableTessellationPathRenderer () const

GrDstSampleFlags	getDstSampleFlagsForProxy (const GrRenderTargetProxy *, bool drawUsesMSAA) const

bool	validateSurfaceParams (const SkISize &, const GrBackendFormat &, GrRenderable renderable, int renderTargetSampleCnt, skgpu::Mipmapped, GrTextureType) const

bool	areColorTypeAndFormatCompatible (GrColorType grCT, const GrBackendFormat &format) const

GrBackendFormat	getDefaultBackendFormat (GrColorType, GrRenderable) const

bool	clampToBorderSupport () const

skgpu::Swizzle	getReadSwizzle (const GrBackendFormat &format, GrColorType colorType) const

const GrDriverBugWorkarounds &	workarounds () const

virtual void	addExtraSamplerKey (skgpu::KeyBuilder *, GrSamplerState, const GrBackendFormat &) const

	GR_DECL_BITFIELD_CLASS_OPS_FRIENDS (ProgramDescOverrideFlags)

virtual GrInternalSurfaceFlags	getExtraSurfaceFlagsForDeferredRT () const

bool	supportsDynamicMSAA (const GrRenderTargetProxy *) const

virtual bool	dmsaaResolveCanBeUsedAsTextureInSameRenderPass () const

bool	avoidReorderingRenderTasks () const

bool	avoidDithering () const

bool	disablePerspectiveSDFText () const

bool	avoidLineDraws () const

std::tuple< GrColorType, GrBackendFormat >	getFallbackColorTypeAndFormat (GrColorType, int sampleCount) const

Public Member Functions inherited from SkCapabilities
SkSL::Version	skslVersion () const

Public Member Functions inherited from SkRefCntBase
	SkRefCntBase ()

virtual	~SkRefCntBase ()

bool	unique () const

void	ref () const

void	unref () const

Private Member Functions
bool	onSurfaceSupportsWritePixels (const GrSurface *) const override

bool	onCanCopySurface (const GrSurfaceProxy dst, const SkIRect &dstRect, const GrSurfaceProxy src, const SkIRect &srcRect) const override

GrBackendFormat	onGetDefaultBackendFormat (GrColorType) const override

bool	onAreColorTypeAndFormatCompatible (GrColorType, const GrBackendFormat &) const override

SupportedRead	onSupportedReadPixelsColorType (GrColorType, const GrBackendFormat &, GrColorType) const override

skgpu::Swizzle	onGetReadSwizzle (const GrBackendFormat &, GrColorType) const override

Additional Inherited Members
Public Types inherited from GrCaps
enum	BlendEquationSupport { kBasic_BlendEquationSupport , kAdvanced_BlendEquationSupport , kAdvancedCoherent_BlendEquationSupport , kLast_BlendEquationSupport = kAdvancedCoherent_BlendEquationSupport }

enum	MapFlags { kNone_MapFlags = 0x0 , kCanMap_MapFlag = 0x1 , kSubset_MapFlag = 0x2 , kAsyncRead_MapFlag = 0x4 }

enum class	SurfaceReadPixelsSupport { kSupported , kCopyToTexture2D , kUnsupported }

enum class	ProgramDescOverrideFlags { kNone = 0 , kVulkanHasResolveLoadSubpass = 0x1 }

Static Public Member Functions inherited from SkCapabilities
static sk_sp< const SkCapabilities >	RasterBackend ()

Protected Member Functions inherited from GrCaps
void	finishInitialization (const GrContextOptions &options)

virtual bool	onSupportsDynamicMSAA (const GrRenderTargetProxy *) const

Protected Member Functions inherited from SkCapabilities
	SkCapabilities ()=default

void	initSkCaps (const SkSL::ShaderCaps *)

Protected Attributes inherited from GrCaps
std::unique_ptr< GrShaderCaps >	fShaderCaps

bool	fNPOTTextureTileSupport: 1

bool	fMipmapSupport: 1

bool	fAnisoSupport: 1

bool	fReuseScratchTextures: 1

bool	fReuseScratchBuffers: 1

bool	fGpuTracingSupport: 1

bool	fOversizedStencilSupport: 1

bool	fTextureBarrierSupport: 1

bool	fSampleLocationsSupport: 1

bool	fDrawInstancedSupport: 1

bool	fNativeDrawIndirectSupport: 1

bool	fUseClientSideIndirectBuffers: 1

bool	fConservativeRasterSupport: 1

bool	fWireframeSupport: 1

bool	fMSAAResolvesAutomatically: 1

bool	fPreferDiscardableMSAAAttachment: 1

bool	fUsePrimitiveRestart: 1

bool	fPreferClientSideDynamicBuffers: 1

bool	fPreferFullscreenClears: 1

bool	fTwoSidedStencilRefsAndMasksMustMatch: 1

bool	fMustClearUploadedBufferData: 1

bool	fBuffersAreInitiallyZero: 1

bool	fShouldInitializeTextures: 1

bool	fSupportsAHardwareBufferImages: 1

bool	fHalfFloatVertexAttributeSupport: 1

bool	fClampToBorderSupport: 1

bool	fPerformPartialClearsAsDraws: 1

bool	fPerformColorClearsAsDraws: 1

bool	fAvoidLargeIndexBufferDraws: 1

bool	fPerformStencilClearsAsDraws: 1

bool	fTransferFromBufferToTextureSupport: 1

bool	fTransferFromSurfaceToBufferSupport: 1

bool	fTransferFromBufferToBufferSupport: 1

bool	fWritePixelsRowBytesSupport: 1

bool	fTransferPixelsToRowBytesSupport: 1

bool	fReadPixelsRowBytesSupport: 1

bool	fShouldCollapseSrcOverToSrcWhenAble: 1

bool	fMustSyncGpuDuringAbandon: 1

bool	fDisableTessellationPathRenderer: 1

bool	fAvoidStencilBuffers: 1

bool	fAvoidWritePixelsFastPath: 1

bool	fNativeDrawIndexedIndirectIsBroken: 1

bool	fAvoidReorderingRenderTasks: 1

bool	fAvoidDithering: 1

bool	fDisablePerspectiveSDFText: 1

bool	fAvoidLineDraws: 1

bool	fPreferVRAMUseOverFlushes: 1

bool	fSemaphoreSupport: 1

bool	fBackendSemaphoreSupport: 1

bool	fFinishedProcAsyncCallbackSupport: 1

bool	fCrossContextTextureSupport: 1

bool	fDynamicStateArrayGeometryProcessorTextureSupport: 1

bool	fSupportsProtectedContent: 1

BlendEquationSupport	fBlendEquationSupport

uint32_t	fAdvBlendEqDisableFlags

uint32_t	fMapBufferFlags

int	fBufferMapThreshold

int	fMaxRenderTargetSize

int	fMaxPreferredRenderTargetSize

int	fMaxVertexAttributes

int	fMaxTextureSize

int	fMaxWindowRectangles

int	fInternalMultisampleCount

uint32_t	fMaxPushConstantsSize = 0

size_t	fTransferBufferRowBytesAlignment = 1

size_t	fTransferFromBufferToBufferAlignment = 1

size_t	fBufferUpdateDataPreserveAlignment = 1

GrDriverBugWorkarounds	fDriverBugWorkarounds

Protected Attributes inherited from SkCapabilities
SkSL::Version	fSkSLVersion = SkSL::Version::k100

Detailed Description

Stores some capabilities of a Mtl backend.

Definition at line 23 of file GrMtlCaps.h.

Constructor & Destructor Documentation

◆ GrMtlCaps()

GR_NORETAIN_BEGIN GrMtlCaps::GrMtlCaps	(	const GrContextOptions &	contextOptions,
		id< MTLDevice >	device
	)

Definition at line 40 of file GrMtlCaps.mm.

        : INHERITED(contextOptions) {
    fShaderCaps = std::make_unique<GrShaderCaps>();
 
    this->initGPUFamily(device);
    this->initGrCaps(device);
    this->initShaderCaps();
    if (!contextOptions.fDisableDriverCorrectnessWorkarounds) {
        this->applyDriverCorrectnessWorkarounds(contextOptions, device);
    }
 
    this->initFormatTable();
    this->initStencilFormat(device);
 
    // TODO: appears to be slow with Mac msaa8, disabled for now
    fStoreAndMultisampleResolveSupport = (fGPUFamily == GPUFamily::kApple &&
                                          fFamilyGroup >= 3);
    // Also slow with non-Apple silicon
    fPreferDiscardableMSAAAttachment = (fGPUFamily == GPUFamily::kApple);
 
    this->finishInitialization(contextOptions);
}

Member Function Documentation

◆ canCopyAsBlit()

bool GrMtlCaps::canCopyAsBlit	(	MTLPixelFormat	dstFormat,
		int	dstSampleCount,
		MTLPixelFormat	srcFormat,
		int	srcSampleCount,
		const SkIRect &	srcRect,
		const SkIPoint &	dstPoint,
		bool	areDstSrcSameObj
	)		const

Definition at line 268 of file GrMtlCaps.mm.

                                                           {
    if (!dstFormat || dstFormat != srcFormat) {
        return false;
    }
    if ((dstSampleCount > 1 || srcSampleCount > 1) && (dstSampleCount != srcSampleCount)) {
        return false;
    }
    if (areDstSrcSameObj) {
        SkIRect dstRect = SkIRect::MakeXYWH(dstPoint.x(), dstPoint.y(),
                                            srcRect.width(), srcRect.height());
        if (dstRect.intersect(srcRect)) {
            return false;
        }
    }
    return true;
}

◆ canCopyAsResolve()

bool GrMtlCaps::canCopyAsResolve	(	MTLPixelFormat	dstFormat,
		int	dstSampleCount,
		MTLPixelFormat	srcFormat,
		int	srcSampleCount,
		bool	srcIsRenderTarget,
		const SkISize	srcDimensions,
		const SkIRect &	srcRect,
		const SkIPoint &	dstPoint,
		bool	areDstSrcSameObj
	)		const

Definition at line 288 of file GrMtlCaps.mm.

                                                              {
    if (areDstSrcSameObj) {
        return false;
    }
    if (dstFormat != srcFormat) {
        return false;
    }
    if (dstSampleCount > 1 || srcSampleCount == 1 || !srcIsRenderTarget) {
        return false;
    }
 
    // TODO: Support copying subrectangles
    if (dstPoint != SkIPoint::Make(0, 0)) {
        return false;
    }
    if (srcRect != SkIRect::MakeSize(srcDimensions)) {
        return false;
    }
 
    return true;
}

◆ computeFormatKey()

uint64_t GrMtlCaps::computeFormatKey ( const GrBackendFormat & format ) const

overridevirtual

Implements GrCaps.

Definition at line 1147 of file GrMtlCaps.mm.

                                                                        {
    MTLPixelFormat mtlFormat = GrBackendFormatAsMTLPixelFormat(format);
    SkASSERT(mtlFormat != MTLPixelFormatInvalid);
    // A MTLPixelFormat is an NSUInteger type which is documented to be 32 bits in 32 bit
    // applications and 64 bits in 64 bit applications. So it should fit in an uint64_t, but adding
    // the assert heere to make sure.
    static_assert(sizeof(MTLPixelFormat) <= sizeof(uint64_t));
    return (uint64_t)mtlFormat;
}

◆ getBackendFormatFromCompressionType()

GrBackendFormat GrMtlCaps::getBackendFormatFromCompressionType ( SkTextureCompressionType compressionType ) const

overridevirtual

Implements GrCaps.

Definition at line 1082 of file GrMtlCaps.mm.

                                                        {
    switch (compressionType) {
        case SkTextureCompressionType::kNone:
            return {};
        case SkTextureCompressionType::kETC2_RGB8_UNORM:
            if (@available(macOS 11.0, *)) {
                if (this->isApple()) {
                    return GrBackendFormats::MakeMtl(MTLPixelFormatETC2_RGB8);
                } else {
                    return {};
                }
            } else {
                return {};
            }
        case SkTextureCompressionType::kBC1_RGB8_UNORM:
            // Metal only supports the RGBA BC1 variant (see following)
            return {};
        case SkTextureCompressionType::kBC1_RGBA8_UNORM:
#ifdef SK_BUILD_FOR_MAC
            if (this->isMac()) {
                return GrBackendFormats::MakeMtl(MTLPixelFormatBC1_RGBA);
            } else {
                return {};
            }
#else
            return {};
#endif
 
    }
    SK_ABORT("Invalid compression type");
}

◆ getDstCopyRestrictions()

GrCaps::DstCopyRestrictions GrMtlCaps::getDstCopyRestrictions	(	const GrRenderTargetProxy *	src,
		GrColorType	ct
	)		const

overridevirtual

Reimplemented from GrCaps.

Definition at line 1046 of file GrMtlCaps.mm.

                                                                                    {
    // If the src is a MSAA RT then the only supported copy action (not considering falling back
    // to a draw) is to resolve from the MSAA src to the non-MSAA dst. Currently we only support
    // resolving the entire texture to a resolve buffer of the same size.
    DstCopyRestrictions restrictions = {};
    if (auto rtProxy = src->asRenderTargetProxy()) {
        if (rtProxy->numSamples() > 1) {
            restrictions.fMustCopyWholeSrc = true;
            restrictions.fRectsMustMatch = GrSurfaceProxy::RectsMustMatch::kYes;
        }
    }
    return restrictions;
}

◆ getFormatFromColorType()

MTLPixelFormat GrMtlCaps::getFormatFromColorType ( GrColorType colorType ) const

inline

Definition at line 75 of file GrMtlCaps.h.

                                                                       {
        int idx = static_cast<int>(colorType);
        return fColorTypeToFormatTable[idx];
    }

◆ getMinBufferAlignment()

size_t GrMtlCaps::getMinBufferAlignment ( ) const

inline

Definition at line 92 of file GrMtlCaps.h.

92{ return this->isMac() ? 4 : 1; }

◆ getRenderTargetSampleCount() [1/2]

int GrMtlCaps::getRenderTargetSampleCount	(	int	requestedCount,
		const GrBackendFormat &	format
	)		const

overridevirtual

Implements GrCaps.

Definition at line 512 of file GrMtlCaps.mm.

                                                                               {
    MTLPixelFormat mtlFormat = GrBackendFormatAsMTLPixelFormat(format);
 
    return this->getRenderTargetSampleCount(requestedCount, mtlFormat);
}

◆ getRenderTargetSampleCount() [2/2]

int GrMtlCaps::getRenderTargetSampleCount	(	int	requestedCount,
		MTLPixelFormat	format
	)		const

Definition at line 519 of file GrMtlCaps.mm.

                                                                                         {
    requestedCount = std::max(requestedCount, 1);
    const FormatInfo& formatInfo = this->getFormatInfo(format);
    if (!(formatInfo.fFlags & FormatInfo::kRenderable_Flag)) {
        return 0;
    }
    if (formatInfo.fFlags & FormatInfo::kMSAA_Flag) {
        int count = fSampleCounts.size();
        for (int i = 0; i < count; ++i) {
            if (fSampleCounts[i] >= requestedCount) {
                return fSampleCounts[i];
            }
        }
    }
    return 1 == requestedCount ? 1 : 0;
}

◆ getStencilPixelFormat()

MTLPixelFormat GrMtlCaps::getStencilPixelFormat ( const GrProgramDesc & desc ) const

Definition at line 1239 of file GrMtlCaps.mm.

                                                                               {
    // Set up read buffer to point to platform-dependent part of the key
    SkReadBuffer readBuffer(desc.asKey() + desc.initialKeyLength()/sizeof(uint32_t),
                            desc.keyLength() - desc.initialKeyLength());
    // skip backend format
    readBuffer.readUInt();
    // skip raster samples
    readBuffer.readUInt();
 
    return (MTLPixelFormat) readBuffer.readUInt();
}

◆ getWriteSwizzle()

skgpu::Swizzle GrMtlCaps::getWriteSwizzle	(	const GrBackendFormat &	,
		GrColorType
	)		const

overridevirtual

Returns the skgpu::Swizzle to use when writing colors to a surface with the passed in GrBackendFormat and GrColorType.

Implements GrCaps.

Definition at line 1131 of file GrMtlCaps.mm.

                                                                       {
    MTLPixelFormat mtlFormat = GrBackendFormatAsMTLPixelFormat(format);
    SkASSERT(mtlFormat != MTLPixelFormatInvalid);
    const auto& info = this->getFormatInfo(mtlFormat);
    for (int i = 0; i < info.fColorTypeInfoCount; ++i) {
        const auto& ctInfo = info.fColorTypeInfos[i];
        if (ctInfo.fColorType == colorType) {
            return ctInfo.fWriteSwizzle;
        }
    }
    SkDEBUGFAILF("Illegal color type (%d) and format (%d) combination.", (int)colorType,
                 static_cast<int>(mtlFormat));
    return {};
}

◆ isApple()

bool GrMtlCaps::isApple ( ) const

inline

Definition at line 90 of file GrMtlCaps.h.

90{ return fGPUFamily == GPUFamily::kApple; }

◆ isFormatAsColorTypeRenderable()

bool GrMtlCaps::isFormatAsColorTypeRenderable	(	GrColorType	ct,
		const GrBackendFormat &	format,
		int	sampleCount = `1`
	)		const

overridevirtual

Implements GrCaps.

Definition at line 476 of file GrMtlCaps.mm.

                                                                     {
    if (!this->isFormatRenderable(format, sampleCount)) {
        return false;
    }
    MTLPixelFormat mtlFormat = GrBackendFormatAsMTLPixelFormat(format);
    SkASSERT(mtlFormat != MTLPixelFormatInvalid);
    const auto& info = this->getFormatInfo(mtlFormat);
    if (!SkToBool(info.colorTypeFlags(ct) & ColorTypeInfo::kRenderable_Flag)) {
        return false;
    }
    return true;
}

◆ isFormatCopyable()

bool GrMtlCaps::isFormatCopyable ( const GrBackendFormat & ) const

inlineoverridevirtual

Implements GrCaps.

Definition at line 32 of file GrMtlCaps.h.

32{ return true; }

◆ isFormatRenderable() [1/2]

bool GrMtlCaps::isFormatRenderable	(	const GrBackendFormat &	format,
		int	sampleCount
	)		const

overridevirtual

Implements GrCaps.

Definition at line 490 of file GrMtlCaps.mm.

                                                                                       {
    return this->isFormatRenderable(GrBackendFormatAsMTLPixelFormat(format), sampleCount);
}

◆ isFormatRenderable() [2/2]

bool GrMtlCaps::isFormatRenderable	(	MTLPixelFormat	format,
		int	sampleCount
	)		const

Definition at line 494 of file GrMtlCaps.mm.

                                                                               {
    return sampleCount <= this->maxRenderTargetSampleCount(format);
}

◆ isFormatSRGB()

bool GrMtlCaps::isFormatSRGB ( const GrBackendFormat & format ) const

overridevirtual

Implements GrCaps.

Definition at line 462 of file GrMtlCaps.mm.

                                                                {
    return format_is_srgb(GrBackendFormatAsMTLPixelFormat(format));
}

◆ isFormatTexturable() [1/2]

bool GrMtlCaps::isFormatTexturable	(	const GrBackendFormat &	format,
		GrTextureType
	)		const

overridevirtual

Implements GrCaps.

Definition at line 466 of file GrMtlCaps.mm.

                                                                                     {
    MTLPixelFormat mtlFormat = GrBackendFormatAsMTLPixelFormat(format);
    return this->isFormatTexturable(mtlFormat);
}

◆ isFormatTexturable() [2/2]

bool GrMtlCaps::isFormatTexturable ( MTLPixelFormat format ) const

Definition at line 471 of file GrMtlCaps.mm.

                                                              {
    const FormatInfo& formatInfo = this->getFormatInfo(format);
    return SkToBool(FormatInfo::kTexturable_Flag & formatInfo.fFlags);
}

◆ isMac()

bool GrMtlCaps::isMac ( ) const

inline

Definition at line 89 of file GrMtlCaps.h.

89{ return fGPUFamily == GPUFamily::kMac; }

◆ makeDesc()

GrProgramDesc GrMtlCaps::makeDesc	(	GrRenderTarget *	,
		const GrProgramInfo &	programInfo,
		ProgramDescOverrideFlags	overrideFlags
	)		const

overridevirtual

For Metal we want to cache the entire pipeline for reuse of draws. The Desc here holds all the information needed to differentiate one pipeline from another.

The GrProgramDesc contains all the information need to create the actual shaders for the pipeline.

For Metal we need to add to the GrProgramDesc to include the rest of the state on the pipeline. This includes blending information and primitive type. The pipeline is immutable so any remaining dynamic state is set via the MtlRenderCmdEncoder.

Implements GrCaps.

Definition at line 1214 of file GrMtlCaps.mm.

                                                                                {
    SkASSERT(overrideFlags == ProgramDescOverrideFlags::kNone);
    GrProgramDesc desc;
    GrProgramDesc::Build(&desc, programInfo, *this);
 
    skgpu::KeyBuilder b(desc.key());
 
    // If ordering here is changed, update getStencilPixelFormat() below
    b.add32(GrBackendFormats::AsMtlFormat(programInfo.backendFormat()));
 
    b.add32(programInfo.numSamples());
 
    b.add32(programInfo.needsStencil() ? this->preferredStencilFormat() : MTLPixelFormatInvalid);
    b.add32((uint32_t)programInfo.isStencilEnabled());
    // Stencil samples don't seem to be tracked in the MTLRenderPipeline
 
    programInfo.pipeline().genKey(&b, *this);
 
    b.add32(programInfo.primitiveTypeKey());
 
    b.flush();
    return desc;
}

◆ maxRenderTargetSampleCount() [1/2]

int GrMtlCaps::maxRenderTargetSampleCount ( const GrBackendFormat & format ) const

overridevirtual

Implements GrCaps.

Definition at line 498 of file GrMtlCaps.mm.

                                                                             {
    return this->maxRenderTargetSampleCount(GrBackendFormatAsMTLPixelFormat(format));
}

◆ maxRenderTargetSampleCount() [2/2]

int GrMtlCaps::maxRenderTargetSampleCount ( MTLPixelFormat format ) const

Definition at line 502 of file GrMtlCaps.mm.

                                                                     {
    const FormatInfo& formatInfo = this->getFormatInfo(format);
    if (formatInfo.fFlags & FormatInfo::kMSAA_Flag) {
        return fSampleCounts[fSampleCounts.size() - 1];
    } else if (formatInfo.fFlags & FormatInfo::kRenderable_Flag) {
        return 1;
    }
    return 0;
}

◆ onAreColorTypeAndFormatCompatible()

bool GrMtlCaps::onAreColorTypeAndFormatCompatible	(	GrColorType	ct,
		const GrBackendFormat &	format
	)		const

overrideprivatevirtual

Implements GrCaps.

Definition at line 1061 of file GrMtlCaps.mm.

                                                                                       {
    MTLPixelFormat mtlFormat = GrBackendFormatAsMTLPixelFormat(format);
 
    const auto& info = this->getFormatInfo(mtlFormat);
    for (int i = 0; i < info.fColorTypeInfoCount; ++i) {
        if (info.fColorTypeInfos[i].fColorType == ct) {
            return true;
        }
    }
    return false;
}

◆ onCanCopySurface()

bool GrMtlCaps::onCanCopySurface	(	const GrSurfaceProxy *	dst,
		const SkIRect &	dstRect,
		const GrSurfaceProxy *	src,
		const SkIRect &	srcRect
	)		const

overrideprivatevirtual

Implements GrCaps.

Definition at line 315 of file GrMtlCaps.mm.

                                                                                          {
    // Metal does not support scaling copies
    if (srcRect.size() != dstRect.size()) {
        return false;
    }
 
    int dstSampleCnt = 1;
    int srcSampleCnt = 1;
    if (const GrRenderTargetProxy* rtProxy = dst->asRenderTargetProxy()) {
        dstSampleCnt = rtProxy->numSamples();
    }
    if (const GrRenderTargetProxy* rtProxy = src->asRenderTargetProxy()) {
        srcSampleCnt = rtProxy->numSamples();
    }
 
    // TODO: need some way to detect whether the proxy is framebufferOnly
 
    const SkIPoint dstPoint = dstRect.topLeft();
    if (this->canCopyAsBlit(GrBackendFormatAsMTLPixelFormat(dst->backendFormat()), dstSampleCnt,
                            GrBackendFormatAsMTLPixelFormat(src->backendFormat()), srcSampleCnt,
                            srcRect, dstPoint, dst == src)) {
        return true;
    }
    bool srcIsRenderTarget = src->asRenderTargetProxy();
    MTLPixelFormat dstFormat = GrBackendFormatAsMTLPixelFormat(dst->backendFormat());
    MTLPixelFormat srcFormat = GrBackendFormatAsMTLPixelFormat(src->backendFormat());
    return this->canCopyAsResolve(dstFormat, dstSampleCnt,
                                  srcFormat, srcSampleCnt,
                                  srcIsRenderTarget, src->backingStoreDimensions(), srcRect,
                                  dstPoint,
                                  dst == src);
}

◆ onDumpJSON()

void GrMtlCaps::onDumpJSON ( SkJSONWriter * writer ) const

overridevirtual

Reimplemented from GrCaps.

Definition at line 1324 of file GrMtlCaps.mm.

1324{ }

◆ onGetDefaultBackendFormat()

GrBackendFormat GrMtlCaps::onGetDefaultBackendFormat ( GrColorType ct ) const

overrideprivatevirtual

Implements GrCaps.

Definition at line 1074 of file GrMtlCaps.mm.

                                                                         {
    MTLPixelFormat format = this->getFormatFromColorType(ct);
    if (!format) {
        return {};
    }
    return GrBackendFormats::MakeMtl(format);
}

◆ onGetReadSwizzle()

skgpu::Swizzle GrMtlCaps::onGetReadSwizzle	(	const GrBackendFormat &	format,
		GrColorType	colorType
	)		const

overrideprivatevirtual

Implements GrCaps.

Definition at line 1115 of file GrMtlCaps.mm.

                                                                        {
    MTLPixelFormat mtlFormat = GrBackendFormatAsMTLPixelFormat(format);
    SkASSERT(mtlFormat != MTLPixelFormatInvalid);
    const auto& info = this->getFormatInfo(mtlFormat);
    for (int i = 0; i < info.fColorTypeInfoCount; ++i) {
        const auto& ctInfo = info.fColorTypeInfos[i];
        if (ctInfo.fColorType == colorType) {
            return ctInfo.fReadSwizzle;
        }
    }
    SkDEBUGFAILF("Illegal color type (%d) and format (%d) combination.", (int)colorType,
                 static_cast<int>(mtlFormat));
    return {};
}

◆ onSupportedReadPixelsColorType()

GrCaps::SupportedRead GrMtlCaps::onSupportedReadPixelsColorType	(	GrColorType	srcColorType,
		const GrBackendFormat &	srcBackendFormat,
		GrColorType	dstColorType
	)		const

overrideprivatevirtual

Implements GrCaps.

Definition at line 1174 of file GrMtlCaps.mm.

                                        {
    SkTextureCompressionType compression = GrBackendFormatToCompressionType(srcBackendFormat);
    if (compression != SkTextureCompressionType::kNone) {
#ifdef SK_BUILD_FOR_IOS
        // Reading back to kRGB_888x doesn't work on Metal/iOS (skbug.com/9839)
        return { GrColorType::kUnknown, 0 };
#else
        return { SkTextureCompressionTypeIsOpaque(compression) ? GrColorType::kRGB_888x
                                                        : GrColorType::kRGBA_8888, 0 };
#endif
    }
 
    // Metal requires the destination offset for copyFromTexture to be a multiple of the textures
    // pixels size.
    size_t offsetAlignment = GrColorTypeBytesPerPixel(srcColorType);
    MTLPixelFormat mtlFormat = GrBackendFormatAsMTLPixelFormat(srcBackendFormat);
 
    const auto& info = this->getFormatInfo(mtlFormat);
    for (int i = 0; i < info.fColorTypeInfoCount; ++i) {
        const auto& ctInfo = info.fColorTypeInfos[i];
        if (ctInfo.fColorType == srcColorType) {
            return {srcColorType, offsetAlignment};
        }
    }
    return {GrColorType::kUnknown, 0};
}

◆ onSurfaceSupportsWritePixels()

bool GrMtlCaps::onSurfaceSupportsWritePixels ( const GrSurface * surface ) const

overrideprivatevirtual

Implements GrCaps.

Definition at line 1022 of file GrMtlCaps.mm.

                                                                           {
    if (auto rt = surface->asRenderTarget()) {
        return rt->numSamples() <= 1 && SkToBool(surface->asTexture());
    }
    return true;
}

◆ preferredStencilFormat()

MTLPixelFormat GrMtlCaps::preferredStencilFormat ( ) const

inline

Returns both a supported and most prefered stencil format to use in draws.

Definition at line 57 of file GrMtlCaps.h.

                                                  {
        return fPreferredStencilFormat;
    }

◆ renderTargetSupportsDiscardableMSAA()

bool GrMtlCaps::renderTargetSupportsDiscardableMSAA ( const GrMtlRenderTarget * rt ) const

Definition at line 1251 of file GrMtlCaps.mm.

                                                                                     {
    return rt->resolveAttachment() &&
           !rt->resolveAttachment()->framebufferOnly() &&
           (rt->numSamples() > 1 && this->preferDiscardableMSAAAttachment());
}

◆ storeAndMultisampleResolveSupport()

bool GrMtlCaps::storeAndMultisampleResolveSupport ( ) const

inline

Definition at line 95 of file GrMtlCaps.h.

95{ return fStoreAndMultisampleResolveSupport; }

◆ supportedWritePixelsColorType()

GrCaps::SupportedWrite GrMtlCaps::supportedWritePixelsColorType	(	GrColorType	surfaceColorType,
		const GrBackendFormat &	surfaceFormat,
		GrColorType	srcColorType
	)		const

overridevirtual

Given a dst pixel config and a src color type what color type must the caller coax the the data into in order to use GrGpu::writePixels().

Implements GrCaps.

Definition at line 1157 of file GrMtlCaps.mm.

                                        {
    // Metal requires the destination offset for copyFromTexture to be a multiple of the textures
    // pixels size.
    size_t offsetAlignment = GrColorTypeBytesPerPixel(surfaceColorType);
 
    const auto& info = this->getFormatInfo(GrBackendFormatAsMTLPixelFormat(surfaceFormat));
    for (int i = 0; i < info.fColorTypeInfoCount; ++i) {
        const auto& ctInfo = info.fColorTypeInfos[i];
        if (ctInfo.fColorType == surfaceColorType) {
            return {surfaceColorType, offsetAlignment};
        }
    }
    return {GrColorType::kUnknown, 0};
}

◆ surfaceSupportsReadPixels()

GrCaps::SurfaceReadPixelsSupport GrMtlCaps::surfaceSupportsReadPixels ( const GrSurface * ) const

overridevirtual

Backends may have restrictions on what types of surfaces support GrGpu::readPixels(). We may either be able to read directly from the surface, read from a copy of the surface, or not read at all.

Implements GrCaps.

Definition at line 1029 of file GrMtlCaps.mm.

                                        {
    if (auto tex = static_cast<const GrMtlTexture*>(surface->asTexture())) {
        // We disallow reading back directly from compressed textures.
        if (skgpu::MtlFormatIsCompressed(tex->attachment()->mtlFormat())) {
            return SurfaceReadPixelsSupport::kCopyToTexture2D;
        }
    }
 
    if (auto mtlRT = static_cast<const GrMtlRenderTarget*>(surface->asRenderTarget())) {
        if (mtlRT->numSamples() > 1 && !mtlRT->resolveAttachment()) {
            return SurfaceReadPixelsSupport::kCopyToTexture2D;
        }
    }
    return SurfaceReadPixelsSupport::kSupported;
}

The documentation for this class was generated from the following files:

third_party/skia/src/gpu/ganesh/mtl/GrMtlCaps.h
third_party/skia/src/gpu/ganesh/mtl/GrMtlCaps.mm

Public Member Functions

Private Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ GrMtlCaps()

Member Function Documentation

◆ canCopyAsBlit()

◆ canCopyAsResolve()

◆ computeFormatKey()

◆ getBackendFormatFromCompressionType()

◆ getDstCopyRestrictions()

◆ getFormatFromColorType()

◆ getMinBufferAlignment()

◆ getRenderTargetSampleCount() [1/2]

◆ getRenderTargetSampleCount() [2/2]

◆ getStencilPixelFormat()

◆ getWriteSwizzle()

◆ isApple()

◆ isFormatAsColorTypeRenderable()

◆ isFormatCopyable()

◆ isFormatRenderable() [1/2]

◆ isFormatRenderable() [2/2]

◆ isFormatSRGB()

◆ isFormatTexturable() [1/2]

◆ isFormatTexturable() [2/2]

◆ isMac()

◆ makeDesc()

◆ maxRenderTargetSampleCount() [1/2]

◆ maxRenderTargetSampleCount() [2/2]

◆ onAreColorTypeAndFormatCompatible()

◆ onCanCopySurface()

◆ onDumpJSON()

◆ onGetDefaultBackendFormat()

◆ onGetReadSwizzle()

◆ onSupportedReadPixelsColorType()

◆ onSurfaceSupportsWritePixels()

◆ preferredStencilFormat()

◆ renderTargetSupportsDiscardableMSAA()

◆ storeAndMultisampleResolveSupport()

◆ supportedWritePixelsColorType()

◆ surfaceSupportsReadPixels()