#include <GrMtlRenderTarget.h>

Inheritance diagram for GrMtlRenderTarget:

Public Member Functions
	~GrMtlRenderTarget () override

bool	canAttemptStencilAttachment (bool useMSAASurface) const override

GrMtlAttachment *	colorAttachment () const

id< MTLTexture >	colorMTLTexture () const

GrMtlAttachment *	resolveAttachment () const

id< MTLTexture >	resolveMTLTexture () const

GrMtlAttachment *	nonMSAAAttachment () const

GrBackendRenderTarget	getBackendRenderTarget () const override

GrBackendFormat	backendFormat () const override

const GrMtlFramebuffer *	getFramebuffer (bool withResolve, bool withStencil)

Public Member Functions inherited from GrRenderTarget
virtual bool	alwaysClearStencil () const

GrRenderTarget *	asRenderTarget () override

const GrRenderTarget *	asRenderTarget () const override

int	numSamples () const

GrAttachment *	getStencilAttachment (bool useMSAASurface) const

GrAttachment *	getStencilAttachment () const

void	attachStencilAttachment (sk_sp< GrAttachment > stencil, bool useMSAASurface)

int	numStencilBits (bool useMSAASurface) const

int	getSamplePatternKey ()

const skia_private::TArray< SkPoint > &	getSampleLocations ()

void	setRequiresManualMSAAResolve ()

bool	requiresManualMSAAResolve () const

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

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< GrMtlRenderTarget >	MakeWrappedRenderTarget (GrMtlGpu *, SkISize, int sampleCnt, id< MTLTexture >)

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
	GrMtlRenderTarget (GrMtlGpu *gpu, SkISize, sk_sp< GrMtlAttachment > colorAttachment, sk_sp< GrMtlAttachment > resolveAttachment, std::string_view label)

GrMtlGpu *	getMtlGpu () const

void	onAbandon () override

void	onRelease () override

size_t	onGpuMemorySize () const override

void	onSetLabel () override

Protected Member Functions inherited from GrRenderTarget
	GrRenderTarget (GrGpu *, const SkISize &, int sampleCount, GrProtected, std::string_view label, sk_sp< GrAttachment > stenicl=nullptr)

	~GrRenderTarget () override

void	onAbandon () override

void	onRelease () override

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

Protected Attributes
sk_sp< GrMtlAttachment >	fColorAttachment

sk_sp< GrMtlAttachment >	fResolveAttachment

Private Member Functions
bool	completeStencilAttachment (GrAttachment *stencil, bool useMSAASurface) override

Additional Inherited Members
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 22 of file GrMtlRenderTarget.h.

Constructor & Destructor Documentation

◆ ~GrMtlRenderTarget()

GrMtlRenderTarget::~GrMtlRenderTarget ( )

override

Definition at line 103 of file GrMtlRenderTarget.mm.

                                      {
    SkASSERT(nil == fColorAttachment);
    SkASSERT(nil == fResolveAttachment);
}

◆ GrMtlRenderTarget()

GrMtlRenderTarget::GrMtlRenderTarget	(	GrMtlGpu *	gpu,
		SkISize	dimensions,
		sk_sp< GrMtlAttachment >	colorAttachment,
		sk_sp< GrMtlAttachment >	resolveAttachment,
		std::string_view	label
	)

protected

Definition at line 38 of file GrMtlRenderTarget.mm.

        : GrSurface(gpu, dimensions, GrProtected::kNo, label)
        , GrRenderTarget(gpu, dimensions, colorAttachment->numSamples(), GrProtected::kNo, label)
        , fColorAttachment(std::move(colorAttachment))
        , fResolveAttachment(std::move(resolveAttachment)) {
}

Member Function Documentation

◆ backendFormat()

GrBackendFormat GrMtlRenderTarget::backendFormat ( ) const

overridevirtual

Implements GrSurface.

Reimplemented in GrMtlTextureRenderTarget.

Definition at line 114 of file GrMtlRenderTarget.mm.

                                                       {
    return GrBackendFormats::MakeMtl(fColorAttachment->mtlFormat());
}

◆ canAttemptStencilAttachment()

bool GrMtlRenderTarget::canAttemptStencilAttachment ( bool useMSAASurface ) const

inlineoverridevirtual

Implements GrRenderTarget.

Definition at line 33 of file GrMtlRenderTarget.h.

                                                                         {
        SkASSERT(useMSAASurface == (this->numSamples() > 1));
        return true;
    }

◆ colorAttachment()

GrMtlAttachment * GrMtlRenderTarget::colorAttachment ( ) const

inline

Definition at line 38 of file GrMtlRenderTarget.h.

38{ return fColorAttachment.get(); }

sk_sp::get

T * get() const

Definition SkRefCnt.h:303

◆ colorMTLTexture()

id< MTLTexture > GrMtlRenderTarget::colorMTLTexture ( ) const

inline

Definition at line 39 of file GrMtlRenderTarget.h.

39{ return fColorAttachment->mtlTexture(); }

GrMtlAttachment::mtlTexture

id< MTLTexture > mtlTexture() const

Definition GrMtlAttachment.h:52

◆ completeStencilAttachment()

bool GrMtlRenderTarget::completeStencilAttachment	(	GrAttachment *	stencil,
		bool	useMSAASurface
	)

overrideprivatevirtual

Implements GrRenderTarget.

Definition at line 168 of file GrMtlRenderTarget.mm.

                                                                                            {
    SkASSERT(useMSAASurface == (this->numSamples() > 1));
    return true;
}

◆ getBackendRenderTarget()

GrBackendRenderTarget GrMtlRenderTarget::getBackendRenderTarget ( ) const

overridevirtual

Implements GrRenderTarget.

Definition at line 108 of file GrMtlRenderTarget.mm.

                                                                      {
    GrMtlTextureInfo info;
    info.fTexture.reset(GrRetainPtrFromId(fColorAttachment->mtlTexture()));
    return GrBackendRenderTargets::MakeMtl(this->width(), this->height(), info);
}

◆ getFramebuffer()

const GrMtlFramebuffer * GrMtlRenderTarget::getFramebuffer	(	bool	withResolve,
		bool	withStencil
	)

Definition at line 129 of file GrMtlRenderTarget.mm.

                                                                            {
    int cacheIndex =
            renderpass_features_to_index(withResolve, withStencil);
    SkASSERT(cacheIndex < GrMtlRenderTarget::kNumCachedFramebuffers);
 
    if (fCachedFramebuffers[cacheIndex]) {
        return fCachedFramebuffers[cacheIndex].get();
    }
 
    GrMtlAttachment* resolve = withResolve ? this->resolveAttachment() : nullptr;
    GrMtlAttachment* colorAttachment = this->colorAttachment();
 
    // Stencil attachment view is stored in the base RT stencil attachment
    GrMtlAttachment* stencil =
            withStencil ? static_cast<GrMtlAttachment*>(this->getStencilAttachment())
                        : nullptr;
    fCachedFramebuffers[cacheIndex] =
            GrMtlFramebuffer::Make(colorAttachment, resolve, stencil);
    return fCachedFramebuffers[cacheIndex].get();
}

◆ getMtlGpu()

GrMtlGpu * GrMtlRenderTarget::getMtlGpu ( ) const

protected

Definition at line 151 of file GrMtlRenderTarget.mm.

                                             {
    SkASSERT(!this->wasDestroyed());
    return static_cast<GrMtlGpu*>(this->getGpu());
}

◆ MakeWrappedRenderTarget()

sk_sp< GrMtlRenderTarget > GrMtlRenderTarget::MakeWrappedRenderTarget	(	GrMtlGpu *	gpu,
		SkISize	dimensions,
		int	sampleCnt,
		id< MTLTexture >	texture
	)

static

Definition at line 49 of file GrMtlRenderTarget.mm.

                                                                                            {
    SkASSERT(nil != texture);
    SkASSERT(1 == texture.mipmapLevelCount);
    if (@available(macOS 10.11, iOS 9.0, tvOS 9.0, *)) {
        SkASSERT(MTLTextureUsageRenderTarget & texture.usage);
    }
 
    sk_sp<GrMtlAttachment> textureAttachment =
            GrMtlAttachment::MakeWrapped(gpu, dimensions, texture,
                                         GrAttachment::UsageFlags::kColorAttachment,
                                         GrWrapCacheable::kNo,
                                         /*label=*/"MtlAttachment_TextureAttachment");
 
    GrMtlRenderTarget* mtlRT;
    if (sampleCnt > 1) {
        if ([texture sampleCount] == 1) {
            MTLPixelFormat format = texture.pixelFormat;
            if (!gpu->mtlCaps().isFormatRenderable(format, sampleCnt)) {
                return nullptr;
            }
            auto rp = gpu->getContext()->priv().resourceProvider();
            sk_sp<GrAttachment> msaaAttachment =
                    rp->makeMSAAAttachment(dimensions,
                                           GrBackendFormats::MakeMtl(format),
                                           sampleCnt,
                                           GrProtected::kNo,
                                           GrMemoryless::kNo);
            if (!msaaAttachment) {
                return nullptr;
            }
            sk_sp<GrMtlAttachment> colorAttachment =
                    sk_sp<GrMtlAttachment>(static_cast<GrMtlAttachment*>(msaaAttachment.release()));
            mtlRT = new GrMtlRenderTarget(
                    gpu, dimensions, std::move(colorAttachment), std::move(textureAttachment),
                    kWrapped, /*label=*/"MakeWrappedRenderTargetWithOneTextureSampleCount");
            mtlRT->setRequiresManualMSAAResolve();
        } else {
            SkASSERT(sampleCnt == static_cast<int>([texture sampleCount]));
            mtlRT = new GrMtlRenderTarget(gpu, dimensions, std::move(textureAttachment), nil,
                                          kWrapped,
                                          /*label=*/"MakeWrappedRenderTargetWithManySampleCount");
        }
    } else {
        mtlRT = new GrMtlRenderTarget(gpu, dimensions, std::move(textureAttachment), nil,
                                      kWrapped,
                                      /*label=*/"MakeWrappedRenderTargetWithOneOrLessSampleCount");
    }
 
    return sk_sp<GrMtlRenderTarget>(mtlRT);
}

◆ nonMSAAAttachment()

GrMtlAttachment * GrMtlRenderTarget::nonMSAAAttachment ( ) const

inline

Definition at line 45 of file GrMtlRenderTarget.h.

                                               {
        if (fColorAttachment->numSamples() == 1) {
            return fColorAttachment.get();
        } else {
            return fResolveAttachment.get();
        }
    }

◆ onAbandon()

void GrMtlRenderTarget::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.

Reimplemented in GrMtlTextureRenderTarget.

Definition at line 156 of file GrMtlRenderTarget.mm.

                                  {
    fColorAttachment = nil;
    fResolveAttachment = nil;
    INHERITED::onAbandon();
}

◆ onGpuMemorySize()

size_t GrMtlRenderTarget::onGpuMemorySize ( ) const

inlineoverrideprotectedvirtual

Implements GrGpuResource.

Reimplemented in GrMtlTextureRenderTarget.

Definition at line 73 of file GrMtlRenderTarget.h.

73{ return 0; }

◆ onRelease()

void GrMtlRenderTarget::onRelease ( )

overrideprotectedvirtual

Overridden to free GPU resources in the backend API.

Reimplemented from GrGpuResource.

Reimplemented in GrMtlTextureRenderTarget.

Definition at line 162 of file GrMtlRenderTarget.mm.

                                  {
    fColorAttachment = nil;
    fResolveAttachment = nil;
    INHERITED::onRelease();
}

◆ onSetLabel()

void GrMtlRenderTarget::onSetLabel ( )

overrideprotectedvirtual

Implements GrGpuResource.

Reimplemented in GrMtlTextureRenderTarget.

Definition at line 173 of file GrMtlRenderTarget.mm.

                                   {
    SkASSERT(fColorAttachment);
    if (!this->getLabel().empty()) {
        NSString* labelStr = @(this->getLabel().c_str());
        if (fResolveAttachment) {
            fColorAttachment->mtlTexture().label =
                    [@"_Skia_MSAA_" stringByAppendingString:labelStr];
            fResolveAttachment->mtlTexture().label =
                    [@"_Skia_Resolve_" stringByAppendingString:labelStr];
        } else {
            fColorAttachment->mtlTexture().label = [@"_Skia_" stringByAppendingString:labelStr];
        }
    }
}

◆ resolveAttachment()

GrMtlAttachment * GrMtlRenderTarget::resolveAttachment ( ) const

inline

Definition at line 40 of file GrMtlRenderTarget.h.

40{ return fResolveAttachment.get(); }

◆ resolveMTLTexture()

id< MTLTexture > GrMtlRenderTarget::resolveMTLTexture ( ) const

inline

Definition at line 41 of file GrMtlRenderTarget.h.

41{ return fResolveAttachment->mtlTexture(); }

Member Data Documentation

◆ fColorAttachment

sk_sp<GrMtlAttachment> GrMtlRenderTarget::fColorAttachment

protected

Definition at line 77 of file GrMtlRenderTarget.h.

◆ fResolveAttachment

sk_sp<GrMtlAttachment> GrMtlRenderTarget::fResolveAttachment

protected

Definition at line 78 of file GrMtlRenderTarget.h.

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

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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ~GrMtlRenderTarget()

◆ GrMtlRenderTarget()

Member Function Documentation

◆ backendFormat()

◆ canAttemptStencilAttachment()

◆ colorAttachment()

◆ colorMTLTexture()

◆ completeStencilAttachment()

◆ getBackendRenderTarget()

◆ getFramebuffer()

◆ getMtlGpu()

◆ MakeWrappedRenderTarget()

◆ nonMSAAAttachment()

◆ onAbandon()

◆ onGpuMemorySize()

◆ onRelease()

◆ onSetLabel()

◆ resolveAttachment()

◆ resolveMTLTexture()

Member Data Documentation

◆ fColorAttachment

◆ fResolveAttachment