#include <GrMtlAttachment.h>

Inheritance diagram for GrMtlAttachment:

Public Member Functions
	~GrMtlAttachment () override

GrBackendFormat	backendFormat () const override

MTLPixelFormat	mtlFormat () const

id< MTLTexture >	mtlTexture () const

unsigned int	sampleCount () const

bool	framebufferOnly () const

Public Member Functions inherited from GrAttachment
	GR_DECL_BITFIELD_CLASS_OPS_FRIENDS (UsageFlags)

	~GrAttachment () override

UsageFlags	supportedUsages () const

int	numSamples () const

skgpu::Mipmapped	mipmapped () const

bool	hasPerformedInitialClear () const

void	markHasPerformedInitialClear ()

Public Member Functions inherited from GrSurface
SkISize	dimensions () const

int	width () const

int	height () const

SkRect	getBoundsRect () const

void	setRelease (sk_sp< skgpu::RefCntedCallback > releaseHelper)

void	setRelease (ReleaseProc proc, ReleaseCtx ctx)

virtual GrTexture *	asTexture ()

virtual const GrTexture *	asTexture () const

virtual GrRenderTarget *	asRenderTarget ()

virtual const GrRenderTarget *	asRenderTarget () const

GrInternalSurfaceFlags	flags () const

bool	readOnly () const

bool	framebufferOnly () const

bool	isProtected () const

void	setFramebufferOnly ()

Public Member Functions inherited from GrGpuResource
bool	wasDestroyed () const

const GrDirectContext *	getContext () const

GrDirectContext *	getContext ()

size_t	gpuMemorySize () const

UniqueID	uniqueID () const

const skgpu::UniqueKey &	getUniqueKey () const

std::string	getLabel () const

void	setLabel (std::string_view label)

CacheAccess	cacheAccess ()

const CacheAccess	cacheAccess () const

ProxyAccess	proxyAccess ()

ResourcePriv	resourcePriv ()

const ResourcePriv	resourcePriv () const

virtual void	dumpMemoryStatistics (SkTraceMemoryDump *traceMemoryDump) const

Public Member Functions inherited from GrIORef< GrGpuResource >
bool	unique () const

void	ref () const

void	unref () const

void	refCommandBuffer () const

void	unrefCommandBuffer () const

Public Member Functions inherited from SkNoncopyable
	SkNoncopyable ()=default

	SkNoncopyable (SkNoncopyable &&)=default

SkNoncopyable &	operator= (SkNoncopyable &&)=default

Static Public Member Functions
static sk_sp< GrMtlAttachment >	MakeStencil (GrMtlGpu *gpu, SkISize dimensions, int sampleCnt, MTLPixelFormat format)

static sk_sp< GrMtlAttachment >	MakeMSAA (GrMtlGpu *gpu, SkISize dimensions, int sampleCnt, MTLPixelFormat format)

static sk_sp< GrMtlAttachment >	MakeTexture (GrMtlGpu *gpu, SkISize dimensions, MTLPixelFormat format, uint32_t mipLevels, GrRenderable renderable, int numSamples, skgpu::Budgeted budgeted)

static sk_sp< GrMtlAttachment >	MakeWrapped (GrMtlGpu *gpu, SkISize dimensions, id< MTLTexture >, UsageFlags attachmentUsages, GrWrapCacheable, std::string_view label)

Static Public Member Functions inherited from GrAttachment
static void	ComputeSharedAttachmentUniqueKey (const GrCaps &caps, const GrBackendFormat &format, SkISize dimensions, UsageFlags requiredUsage, int sampleCnt, skgpu::Mipmapped mipmapped, GrProtected isProtected, GrMemoryless memoryless, skgpu::UniqueKey *key)

static void	ComputeScratchKey (const GrCaps &caps, const GrBackendFormat &format, SkISize dimensions, UsageFlags requiredUsage, int sampleCnt, skgpu::Mipmapped mipmapped, GrProtected, GrMemoryless, skgpu::ScratchKey *key)

Static Public Member Functions inherited from GrSurface
static size_t	ComputeSize (const GrBackendFormat &, SkISize dimensions, int colorSamplesPerPixel, skgpu::Mipmapped, bool binSize=false)

Static Public Member Functions inherited from GrGpuResource
static uint32_t	CreateUniqueID ()

Protected Member Functions
void	onRelease () override

void	onAbandon () override

Protected Member Functions inherited from GrAttachment
	GrAttachment (GrGpu *gpu, SkISize dimensions, UsageFlags supportedUsages, int sampleCnt, skgpu::Mipmapped mipmapped, GrProtected isProtected, std::string_view label, GrMemoryless memoryless=GrMemoryless::kNo)

Protected Member Functions inherited from GrSurface
void	setGLRTFBOIDIs0 ()

bool	glRTFBOIDis0 () const

void	setRequiresManualMSAAResolve ()

bool	requiresManualMSAAResolve () const

void	setReadOnly ()

void	setVkRTSupportsInputAttachment ()

	GrSurface (GrGpu *gpu, const SkISize &dimensions, skgpu::Protected isProtected, std::string_view label)

	~GrSurface () override

void	onRelease () override

void	onAbandon () override

Protected Member Functions inherited from GrGpuResource
void	registerWithCache (skgpu::Budgeted)

void	registerWithCacheWrapped (GrWrapCacheable)

	GrGpuResource (GrGpu *, std::string_view label)

virtual	~GrGpuResource ()

GrGpu *	getGpu () const

virtual void	setMemoryBacking (SkTraceMemoryDump *, const SkString &) const

SkString	getResourceName () const

void	dumpMemoryStatisticsPriv (SkTraceMemoryDump traceMemoryDump, const SkString &resourceName, const char type, size_t size) const

Protected Member Functions inherited from GrIORef< GrGpuResource >
	GrIORef ()

bool	internalHasRef () const

bool	internalHasNoCommandBufferUsages () const

void	addInitialRef () const

Private Member Functions
void	onSetLabel () override

Additional Inherited Members
Public Types inherited from GrAttachment
enum class	UsageFlags : uint8_t { kStencilAttachment = 0x1 , kColorAttachment = 0x2 , kTexture = 0x4 }

Public Types inherited from GrSurface
typedef void *	ReleaseCtx

typedef void(*	ReleaseProc) (ReleaseCtx)

Public Types inherited from GrIORef< GrGpuResource >
enum	LastRemovedRef

Detailed Description

Definition at line 19 of file GrMtlAttachment.h.

Constructor & Destructor Documentation

◆ ~GrMtlAttachment()

GrMtlAttachment::~GrMtlAttachment ( )

override

Definition at line 174 of file GrMtlAttachment.mm.

                                  {
    // should have been released or abandoned first
    SkASSERT(!fTexture);
}

Member Function Documentation

◆ backendFormat()

GrBackendFormat GrMtlAttachment::backendFormat ( ) const

overridevirtual

Implements GrSurface.

Definition at line 179 of file GrMtlAttachment.mm.

                                                     {
    return GrBackendFormats::MakeMtl(SkToU32(fTexture.pixelFormat));
}

◆ framebufferOnly()

bool GrMtlAttachment::framebufferOnly ( ) const

inline

Definition at line 56 of file GrMtlAttachment.h.

56{ return fTexture.framebufferOnly; }

◆ MakeMSAA()

sk_sp< GrMtlAttachment > GrMtlAttachment::MakeMSAA	(	GrMtlGpu *	gpu,
		SkISize	dimensions,
		int	sampleCnt,
		MTLPixelFormat	format
	)

static

Definition at line 72 of file GrMtlAttachment.mm.

                                                                        {
    int textureUsage = 0;
    int storageMode = 0;
    if (@available(macOS 10.11, iOS 9.0, tvOS 9.0, *)) {
        textureUsage = MTLTextureUsageShaderRead | MTLTextureUsageRenderTarget;
        storageMode = MTLStorageModePrivate;
    }
    return GrMtlAttachment::Make(gpu, dimensions, UsageFlags::kColorAttachment, sampleCnt, format,
                                 /*mipLevels=*/1, textureUsage, storageMode, skgpu::Budgeted::kYes);
}

◆ MakeStencil()

sk_sp< GrMtlAttachment > GrMtlAttachment::MakeStencil	(	GrMtlGpu *	gpu,
		SkISize	dimensions,
		int	sampleCnt,
		MTLPixelFormat	format
	)

static

Definition at line 58 of file GrMtlAttachment.mm.

                                                                           {
    int textureUsage = 0;
    int storageMode = 0;
    if (@available(macOS 10.11, iOS 9.0, tvOS 9.0, *)) {
        textureUsage = MTLTextureUsageRenderTarget;
        storageMode = MTLStorageModePrivate;
    }
    return GrMtlAttachment::Make(gpu, dimensions, UsageFlags::kStencilAttachment, sampleCnt, format,
                                 /*mipLevels=*/1, textureUsage, storageMode, skgpu::Budgeted::kYes);
}

◆ MakeTexture()

sk_sp< GrMtlAttachment > GrMtlAttachment::MakeTexture	(	GrMtlGpu *	gpu,
		SkISize	dimensions,
		MTLPixelFormat	format,
		uint32_t	mipLevels,
		GrRenderable	renderable,
		int	numSamples,
		skgpu::Budgeted	budgeted
	)

static

Definition at line 86 of file GrMtlAttachment.mm.

                                                                            {
    int textureUsage = 0;
    int storageMode = 0;
    if (@available(macOS 10.11, iOS 9.0, tvOS 9.0, *)) {
        textureUsage = MTLTextureUsageShaderRead;
        storageMode = MTLStorageModePrivate;
    }
    UsageFlags usageFlags = UsageFlags::kTexture;
    if (renderable == GrRenderable::kYes) {
        usageFlags |= UsageFlags::kColorAttachment;
        if (@available(macOS 10.11, iOS 9.0, tvOS 9.0, *)) {
            textureUsage |= MTLTextureUsageRenderTarget;
        }
    }
 
    return GrMtlAttachment::Make(gpu, dimensions, usageFlags, numSamples, format, mipLevels,
                                 textureUsage, storageMode, budgeted);
}

◆ MakeWrapped()

sk_sp< GrMtlAttachment > GrMtlAttachment::MakeWrapped	(	GrMtlGpu *	gpu,
		SkISize	dimensions,
		id< MTLTexture >	texture,
		UsageFlags	attachmentUsages,
		GrWrapCacheable	cacheable,
		std::string_view	label
	)

static

Definition at line 162 of file GrMtlAttachment.mm.

                              {
 
    return sk_sp<GrMtlAttachment>(new GrMtlAttachment(gpu, dimensions, attachmentUsages, texture,
                                                      cacheable, label));
}

◆ mtlFormat()

MTLPixelFormat GrMtlAttachment::mtlFormat ( ) const

inline

Definition at line 50 of file GrMtlAttachment.h.

50{ return fTexture.pixelFormat; }

◆ mtlTexture()

id< MTLTexture > GrMtlAttachment::mtlTexture ( ) const

inline

Definition at line 52 of file GrMtlAttachment.h.

52{ return fTexture; }

◆ onAbandon()

void GrMtlAttachment::onAbandon ( )

overrideprotectedvirtual

Overridden to abandon any internal handles, ptrs, etc to backend API resources. This may be called when the underlying 3D context is no longer valid and so no backend API calls should be made.

Reimplemented from GrGpuResource.

Definition at line 188 of file GrMtlAttachment.mm.

                                {
    fTexture = nil;
    GrAttachment::onAbandon();
}

◆ onRelease()

void GrMtlAttachment::onRelease ( )

overrideprotectedvirtual

Overridden to free GPU resources in the backend API.

Reimplemented from GrGpuResource.

Definition at line 183 of file GrMtlAttachment.mm.

                                {
    fTexture = nil;
    GrAttachment::onRelease();
}

◆ onSetLabel()

void GrMtlAttachment::onSetLabel ( )

overrideprivatevirtual

Reimplemented from GrAttachment.

Definition at line 198 of file GrMtlAttachment.mm.

                                 {
    SkASSERT(fTexture);
    if (!this->getLabel().empty()) {
        NSString* labelStr = @(this->getLabel().c_str());
        fTexture.label = [@"_Skia_" stringByAppendingString:labelStr];
    }
}

◆ sampleCount()

unsigned int GrMtlAttachment::sampleCount ( ) const

inline

Definition at line 54 of file GrMtlAttachment.h.

54{ return SkToU32(fTexture.sampleCount); }

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

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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ~GrMtlAttachment()

Member Function Documentation

◆ backendFormat()

◆ framebufferOnly()

◆ MakeMSAA()

◆ MakeStencil()

◆ MakeTexture()

◆ MakeWrapped()

◆ mtlFormat()

◆ mtlTexture()

◆ onAbandon()

◆ onRelease()

◆ onSetLabel()

◆ sampleCount()