#include <GrAttachment.h>

Inheritance diagram for GrAttachment:

Public Types
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

Public Member Functions
	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

virtual GrBackendFormat	backendFormat () const =0

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 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
	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
size_t	onGpuMemorySize () const final

void	onSetLabel () override

void	computeScratchKey (skgpu::ScratchKey *) const final

const char *	getResourceType () const override

Detailed Description

This is a generic attachment class for out GrSurfaces. It always represents a single gpu allocation. It contains usage flags so that we know what the attachment can be used for.

TODO: Once we can pull out GrRenderTarget to be more of a framebuffer and break apart our texture render target diamond, we will merge this class with GrSurface. Until then this will act as the staging class for the new surface and framebuffer world.

Definition at line 25 of file GrAttachment.h.

Member Enumeration Documentation

◆ UsageFlags

enum class GrAttachment::UsageFlags : uint8_t

strong

Enumerator
kStencilAttachment
kColorAttachment
kTexture

Definition at line 27 of file GrAttachment.h.

                          : uint8_t {
        kStencilAttachment = 0x1,
        kColorAttachment   = 0x2,
        kTexture           = 0x4,
    };

Constructor & Destructor Documentation

◆ ~GrAttachment()

GrAttachment::~GrAttachment ( )

inlineoverride

Definition at line 34 of file GrAttachment.h.

34{}

◆ GrAttachment()

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

inlineprotected

Definition at line 73 of file GrAttachment.h.

            : INHERITED(gpu, dimensions, isProtected, label)
            , fSupportedUsages(supportedUsages)
            , fSampleCnt(sampleCnt)
            , fMipmapped(mipmapped)
            , fMemoryless(memoryless) {}

Member Function Documentation

◆ ComputeScratchKey()

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

static

Definition at line 81 of file GrAttachment.cpp.

                                                           {
    static const skgpu::ScratchKey::ResourceType kType = skgpu::ScratchKey::GenerateResourceType();
 
    skgpu::ScratchKey::Builder builder(key, kType, 5);
    build_key(&builder, caps, format, dimensions, requiredUsage, sampleCnt, mipmapped, isProtected,
              memoryless);
}

◆ computeScratchKey()

void GrAttachment::computeScratchKey ( skgpu::ScratchKey * ) const

finalprivatevirtual

Called by the registerWithCache if the resource is available to be used as scratch. Resource subclasses should override this if the instances should be recycled as scratch resources and populate the scratchKey with the key. By default resources are not recycled as scratch.

Reimplemented from GrGpuResource.

Definition at line 97 of file GrAttachment.cpp.

                                                               {
    // We do don't cache GrAttachments as scratch resources when used for stencils or textures. For
    // stencils we share/cache them with unique keys so that they can be shared. Textures are in a
    // weird place on the Vulkan backend. Currently, GrVkTexture contains a GrAttachment (GrVkImage)
    // that actually holds the VkImage. The GrVkTexture is cached as a scratch resource and is
    // responsible for tracking the gpuMemorySize. Thus we set the size of the texture GrVkImage,
    // above in onGpuMemorySize, to be zero. Therefore, we can't have the GrVkImage getting cached
    // separately on its own in the GrResourceCache or we may grow forever adding them thinking they
    // contatin a memory that's size 0 and never freeing the actual VkImages.
    if (!SkToBool(fSupportedUsages & UsageFlags::kStencilAttachment) &&
        !SkToBool(fSupportedUsages & UsageFlags::kTexture)) {
        auto isProtected = this->isProtected() ? GrProtected::kYes : GrProtected::kNo;
        ComputeScratchKey(*this->getGpu()->caps(),
                          this->backendFormat(),
                          this->dimensions(),
                          fSupportedUsages,
                          this->numSamples(),
                          this->mipmapped(),
                          isProtected,
                          fMemoryless,
                          key);
    }
}

◆ ComputeSharedAttachmentUniqueKey()

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

static

Definition at line 65 of file GrAttachment.cpp.

                                                                         {
    static const skgpu::UniqueKey::Domain kDomain = skgpu::UniqueKey::GenerateDomain();
 
    skgpu::UniqueKey::Builder builder(key, kDomain, 5);
    build_key(&builder, caps, format, dimensions, requiredUsage, sampleCnt, mipmapped, isProtected,
              memoryless);
}

◆ getResourceType()

const char * GrAttachment::getResourceType ( ) const

inlineoverrideprivatevirtual

Describes the type of gpu resource that is represented by the implementing class (e.g. texture, buffer object, stencil). This data is used for diagnostic purposes by dumpMemoryStatistics().

The value returned is expected to be long lived and will not be copied by the caller.

Implements GrGpuResource.

Definition at line 94 of file GrAttachment.h.

                                                 {
        if (fSupportedUsages == UsageFlags::kStencilAttachment) {
            return "StencilAttachment";
        }
 
        // This is a general grouping of all textures and color attachments.
        return "Surface";
    }

◆ GR_DECL_BITFIELD_CLASS_OPS_FRIENDS()

GrAttachment::GR_DECL_BITFIELD_CLASS_OPS_FRIENDS ( UsageFlags )

◆ hasPerformedInitialClear()

bool GrAttachment::hasPerformedInitialClear ( ) const

inline

Definition at line 42 of file GrAttachment.h.

42{ return fHasPerformedInitialClear; }

◆ markHasPerformedInitialClear()

void GrAttachment::markHasPerformedInitialClear ( )

inline

Definition at line 43 of file GrAttachment.h.

43{ fHasPerformedInitialClear = true; }

◆ mipmapped()

skgpu::Mipmapped GrAttachment::mipmapped ( ) const

inline

Definition at line 40 of file GrAttachment.h.

40{ return fMipmapped; }

◆ numSamples()

int GrAttachment::numSamples ( ) const

inline

Definition at line 38 of file GrAttachment.h.

38{ return fSampleCnt; }

◆ onGpuMemorySize()

size_t GrAttachment::onGpuMemorySize ( ) const

finalprivatevirtual

Implements GrGpuResource.

Definition at line 17 of file GrAttachment.cpp.

                                           {
    // The GrTexture[RenderTarget] is built up by a bunch of attachments each of which are their
    // own GrGpuResource. Ideally the GrRenderTarget would not be a GrGpuResource and the GrTexture
    // would just merge with the new GrSurface/Attachment world. Then we could just depend on each
    // attachment to give its own size since we don't have GrGpuResources owning other
    // GrGpuResources. Until we get to that point we need to live in some hybrid world. We will let
    // the msaa and stencil attachments track their own size because they do get cached separately.
    // For all GrTexture* based things we will continue to to use the GrTexture* to report size and
    // the owned attachments will have no size and be uncached.
    if (!(fSupportedUsages & UsageFlags::kTexture) && fMemoryless == GrMemoryless::kNo) {
        GrBackendFormat format = this->backendFormat();
        SkTextureCompressionType compression = GrBackendFormatToCompressionType(format);
 
        uint64_t size = skgpu::NumCompressedBlocks(compression, this->dimensions());
        size *= GrBackendFormatBytesPerBlock(this->backendFormat());
        size *= this->numSamples();
        return size;
    }
    return 0;
}

◆ onSetLabel()

void GrAttachment::onSetLabel ( )

inlineoverrideprivatevirtual

Implements GrGpuResource.

Reimplemented in GrD3DAttachment, GrGLAttachment, and GrMtlAttachment.

Definition at line 90 of file GrAttachment.h.

90{}

◆ supportedUsages()

UsageFlags GrAttachment::supportedUsages ( ) const

inline

Definition at line 36 of file GrAttachment.h.

36{ return fSupportedUsages; }

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

third_party/skia/src/gpu/ganesh/GrAttachment.h
third_party/skia/src/gpu/ganesh/GrAttachment.cpp

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Member Functions

Detailed Description

Member Enumeration Documentation

◆ UsageFlags

Constructor & Destructor Documentation

◆ ~GrAttachment()

◆ GrAttachment()

Member Function Documentation

◆ ComputeScratchKey()

◆ computeScratchKey()

◆ ComputeSharedAttachmentUniqueKey()

◆ getResourceType()

◆ GR_DECL_BITFIELD_CLASS_OPS_FRIENDS()

◆ hasPerformedInitialClear()

◆ markHasPerformedInitialClear()

◆ mipmapped()

◆ numSamples()

◆ onGpuMemorySize()

◆ onSetLabel()

◆ supportedUsages()