#include <GrTexture.h>

Inheritance diagram for GrTexture:

Public Member Functions
GrTexture *	asTexture () override

const GrTexture *	asTexture () const override

virtual GrBackendTexture	getBackendTexture () const =0

virtual void	textureParamsModified ()=0

GrTextureType	textureType () const

bool	hasRestrictedSampling () const

void	markMipmapsDirty ()

void	markMipmapsClean ()

skgpu::Mipmapped	mipmapped () const

bool	mipmapsAreDirty () const

GrMipmapStatus	mipmapStatus () const

int	maxMipmapLevel () const

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 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 bool	StealBackendTexture (sk_sp< GrTexture >, GrBackendTexture , SkImages::BackendTextureReleaseProc )

static void	ComputeScratchKey (const GrCaps &caps, const GrBackendFormat &format, SkISize dimensions, GrRenderable, int sampleCnt, skgpu::Mipmapped, GrProtected, 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
	GrTexture (GrGpu *, const SkISize &, GrProtected, GrTextureType, GrMipmapStatus, std::string_view label)

virtual bool	onStealBackendTexture (GrBackendTexture , SkImages::BackendTextureReleaseProc )=0

void	computeScratchKey (skgpu::ScratchKey *) const 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

Private Member Functions
size_t	onGpuMemorySize () const override

Friends
class	GrTextureResource

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 31 of file GrTexture.h.

Constructor & Destructor Documentation

◆ GrTexture()

GrTexture::GrTexture	(	GrGpu *	gpu,
		const SkISize &	dimensions,
		GrProtected	isProtected,
		GrTextureType	textureType,
		GrMipmapStatus	mipmapStatus,
		std::string_view	label
	)

protected

Definition at line 42 of file GrTexture.cpp.

        : GrSurface(gpu, dimensions, isProtected, label)
        , fTextureType(textureType)
        , fMipmapStatus(mipmapStatus) {
    if (fMipmapStatus == GrMipmapStatus::kNotAllocated) {
        fMaxMipmapLevel = 0;
    } else {
        fMaxMipmapLevel = SkMipmap::ComputeLevelCount(this->width(), this->height());
    }
    if (textureType == GrTextureType::kExternal) {
        this->setReadOnly();
    }
}

Member Function Documentation

◆ asTexture() [1/2]

const GrTexture * GrTexture::asTexture ( ) const

inlineoverridevirtual

Reimplemented from GrSurface.

Definition at line 34 of file GrTexture.h.

34{ return this; }

◆ asTexture() [2/2]

GrTexture * GrTexture::asTexture ( )

inlineoverridevirtual

Returns: the texture associated with the surface, may be null.

Reimplemented from GrSurface.

Definition at line 33 of file GrTexture.h.

33{ return this; }

◆ ComputeScratchKey()

void GrTexture::ComputeScratchKey	(	const GrCaps &	caps,
		const GrBackendFormat &	format,
		SkISize	dimensions,
		GrRenderable	renderable,
		int	sampleCnt,
		skgpu::Mipmapped	mipmapped,
		GrProtected	isProtected,
		skgpu::ScratchKey *	key
	)

static

Definition at line 105 of file GrTexture.cpp.

                                                        {
    static const skgpu::ScratchKey::ResourceType kType = skgpu::ScratchKey::GenerateResourceType();
    SkASSERT(!dimensions.isEmpty());
    SkASSERT(sampleCnt > 0);
    SkASSERT(1 == sampleCnt || renderable == GrRenderable::kYes);
 
    SkASSERT(static_cast<uint32_t>(mipmapped) <= 1);
    SkASSERT(static_cast<uint32_t>(isProtected) <= 1);
    SkASSERT(static_cast<uint32_t>(renderable) <= 1);
    SkASSERT(static_cast<uint32_t>(sampleCnt) < (1 << (32 - 3)));
 
    uint64_t formatKey = caps.computeFormatKey(format);
 
    skgpu::ScratchKey::Builder builder(key, kType, 5);
    builder[0] = dimensions.width();
    builder[1] = dimensions.height();
    builder[2] = formatKey & 0xFFFFFFFF;
    builder[3] = (formatKey >> 32) & 0xFFFFFFFF;
    builder[4] = (static_cast<uint32_t>(mipmapped)   << 0)
               | (static_cast<uint32_t>(isProtected) << 1)
               | (static_cast<uint32_t>(renderable)  << 2)
               | (static_cast<uint32_t>(sampleCnt)   << 3);
}

◆ computeScratchKey()

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

overrideprotectedvirtual

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 91 of file GrTexture.cpp.

                                                            {
    if (!this->getGpu()->caps()->isFormatCompressed(this->backendFormat())) {
        int sampleCount = 1;
        GrRenderable renderable = GrRenderable::kNo;
        if (const auto* rt = this->asRenderTarget()) {
            sampleCount = rt->numSamples();
            renderable = GrRenderable::kYes;
        }
        auto isProtected = this->isProtected() ? GrProtected::kYes : GrProtected::kNo;
        ComputeScratchKey(*this->getGpu()->caps(), this->backendFormat(), this->dimensions(),
                          renderable, sampleCount, this->mipmapped(), isProtected, key);
    }
}

◆ getBackendTexture()

virtual GrBackendTexture GrTexture::getBackendTexture ( ) const

pure virtual

Implemented in GrD3DTexture, GrGLTexture, GrMockTexture, GrMtlTexture, and GrVkTexture.

◆ hasRestrictedSampling()

bool GrTexture::hasRestrictedSampling ( ) const

inline

Definition at line 56 of file GrTexture.h.

                                       {
        return GrTextureTypeHasRestrictedSampling(this->textureType());
    }

◆ markMipmapsClean()

void GrTexture::markMipmapsClean ( )

Definition at line 31 of file GrTexture.cpp.

                                 {
    SkASSERT(GrMipmapStatus::kNotAllocated != fMipmapStatus);
    fMipmapStatus = GrMipmapStatus::kValid;
}

◆ markMipmapsDirty()

void GrTexture::markMipmapsDirty ( )

Definition at line 25 of file GrTexture.cpp.

                                 {
    if (GrMipmapStatus::kValid == fMipmapStatus) {
        fMipmapStatus = GrMipmapStatus::kDirty;
    }
}

◆ maxMipmapLevel()

int GrTexture::maxMipmapLevel ( ) const

inline

Definition at line 67 of file GrTexture.h.

67{ return fMaxMipmapLevel; }

◆ mipmapped()

skgpu::Mipmapped GrTexture::mipmapped ( ) const

inline

Definition at line 62 of file GrTexture.h.

                                     {
        return skgpu::Mipmapped(fMipmapStatus != GrMipmapStatus::kNotAllocated);
    }

◆ mipmapsAreDirty()

bool GrTexture::mipmapsAreDirty ( ) const

inline

Definition at line 65 of file GrTexture.h.

65{ return fMipmapStatus != GrMipmapStatus::kValid; }

◆ mipmapStatus()

GrMipmapStatus GrTexture::mipmapStatus ( ) const

inline

Definition at line 66 of file GrTexture.h.

66{ return fMipmapStatus; }

◆ onGpuMemorySize()

size_t GrTexture::onGpuMemorySize ( ) const

overrideprivatevirtual

Implements GrGpuResource.

Reimplemented in GrVkTextureRenderTarget.

Definition at line 36 of file GrTexture.cpp.

                                        {
    return GrSurface::ComputeSize(this->backendFormat(), this->dimensions(),
                                  /*colorSamplesPerPixel=*/1, this->mipmapped());
}

◆ onStealBackendTexture()

virtual bool GrTexture::onStealBackendTexture	(	GrBackendTexture *	,
		SkImages::BackendTextureReleaseProc *
	)

protectedpure virtual

Implemented in GrD3DTexture, GrGLTexture, GrMockTexture, GrMtlTexture, and GrVkTexture.

◆ StealBackendTexture()

bool GrTexture::StealBackendTexture	(	sk_sp< GrTexture >	texture,
		GrBackendTexture *	backendTexture,
		SkImages::BackendTextureReleaseProc *	releaseProc
	)

static

This function steals the backend texture from a uniquely owned GrTexture with no pending IO, passing it out to the caller. The GrTexture is deleted in the process.

Note that if the GrTexture is not uniquely owned (no other refs), or has pending IO, this function will fail.

Definition at line 61 of file GrTexture.cpp.

                                                                                    {
    if (!texture->unique()) {
        return false;
    }
 
    if (!texture->onStealBackendTexture(backendTexture, releaseProc)) {
        return false;
    }
#ifdef SK_DEBUG
    GrResourceCache* cache = texture->getContext()->priv().getResourceCache();
    int preCount = cache->getResourceCount();
#endif
    // Ensure that the texture will be released by the cache when we drop the last ref.
    // A texture that has no refs and no keys should be immediately removed.
    if (texture->getUniqueKey().isValid()) {
        texture->resourcePriv().removeUniqueKey();
    }
    if (texture->resourcePriv().getScratchKey().isValid()) {
        texture->resourcePriv().removeScratchKey();
    }
#ifdef SK_DEBUG
    texture.reset();
    int postCount = cache->getResourceCount();
    SkASSERT(postCount < preCount);
#endif
    return true;
}

◆ textureParamsModified()

virtual void GrTexture::textureParamsModified ( )

pure virtual

This function indicates that the texture parameters (wrap mode, filtering, ...) have been changed externally to Skia.

Implemented in GrD3DTexture, GrGLTexture, GrMockTexture, GrMtlTexture, and GrVkTexture.

◆ textureType()

GrTextureType GrTexture::textureType ( ) const

inline

Definition at line 55 of file GrTexture.h.

55{ return fTextureType; }

Friends And Related Symbol Documentation

◆ GrTextureResource

friend class GrTextureResource

friend

Definition at line 96 of file GrTexture.h.

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

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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Member Functions

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ GrTexture()

Member Function Documentation

◆ asTexture() [1/2]

◆ asTexture() [2/2]

◆ ComputeScratchKey()

◆ computeScratchKey()

◆ getBackendTexture()

◆ hasRestrictedSampling()

◆ markMipmapsClean()

◆ markMipmapsDirty()

◆ maxMipmapLevel()

◆ mipmapped()

◆ mipmapsAreDirty()

◆ mipmapStatus()

◆ onGpuMemorySize()

◆ onStealBackendTexture()

◆ StealBackendTexture()

◆ textureParamsModified()

◆ textureType()

Friends And Related Symbol Documentation

◆ GrTextureResource