skgpu::UniqueKey Class Reference

#include <ResourceKey.h>

Inheritance diagram for skgpu::UniqueKey:

Classes
class	Builder

Public Types
typedef uint32_t	Domain

Public Member Functions
	UniqueKey ()
	UniqueKey (const UniqueKey &that)
UniqueKey &	operator= (const UniqueKey &that)
bool	operator== (const UniqueKey &that) const
bool	operator!= (const UniqueKey &that) const
void	setCustomData (sk_sp< SkData > data)
SkData *	getCustomData () const
sk_sp< SkData >	refCustomData () const
const char *	tag () const
const uint32_t *	data () const
Public Member Functions inherited from skgpu::ResourceKey
uint32_t	hash () const
size_t	size () const
void	reset ()
bool	isValid () const

Static Public Member Functions
static Domain	GenerateDomain ()

Additional Inherited Members
Protected Member Functions inherited from skgpu::ResourceKey
	ResourceKey ()
bool	operator== (const ResourceKey &that) const
ResourceKey &	operator= (const ResourceKey &that)
uint32_t	domain () const
size_t	dataSize () const
const uint32_t *	data () const
Static Protected Attributes inherited from skgpu::ResourceKey
static const uint32_t	kInvalidDomain = 0

Detailed Description

A key that allows for exclusive use of a resource for a use case (AKA "domain"). There are three rules governing the use of unique keys:

• Only one resource can have a given unique key at a time. Hence, "unique".
• A resource can have at most one unique key at a time.
• Unlike scratch keys, multiple requests for a unique key will return the same resource even if the resource already has refs. This key type allows a code path to create cached resources for which it is the exclusive user. The code path creates a domain which it sets on its keys. This guarantees that there are no cross-domain collisions.

Unique keys preempt scratch keys. While a resource has a unique key it is inaccessible via its scratch key. It can become scratch again if the unique key is removed.

Definition at line 241 of file ResourceKey.h.

Member Typedef Documentation

Domain

typedef uint32_t skgpu::UniqueKey::Domain

Definition at line 243 of file ResourceKey.h.

Constructor & Destructor Documentation

UniqueKey() [1/2]

skgpu::UniqueKey::UniqueKey ( )

inline

Creates an invalid unique key. It must be initialized using a Builder object before use.

Definition at line 248 of file ResourceKey.h.

: fTag(nullptr) {}

UniqueKey() [2/2]

skgpu::UniqueKey::UniqueKey ( const UniqueKey &  that )

inline

Definition at line 250 of file ResourceKey.h.

{ *this = that; }

Member Function Documentation

data()

const uint32_t * skgpu::UniqueKey::data ( ) const

inline

Definition at line 268 of file ResourceKey.h.

{ return this->ResourceKey::data(); }

GenerateDomain()

UniqueKey::Domain skgpu::UniqueKey::GenerateDomain ( )

static

Generate a Domain for unique keys.

Definition at line 27 of file ResourceKey.cpp.

                                          {
    static std::atomic<int32_t> nextDomain{ResourceKey::kInvalidDomain + 1};
 
    int32_t domain = nextDomain.fetch_add(1, std::memory_order_relaxed);
    if (domain > SkTo<int32_t>(UINT16_MAX)) {
        SK_ABORT("Too many skgpu::UniqueKey Domains");
    }
 
    return static_cast<Domain>(domain);
}

getCustomData()

SkData * skgpu::UniqueKey::getCustomData ( ) const

inline

Definition at line 263 of file ResourceKey.h.

{ return fData.get(); }

operator!=()

bool skgpu::UniqueKey::operator!= ( const UniqueKey &  that ) const

inline

Definition at line 260 of file ResourceKey.h.

{ return !(*this == that); }

operator=()

UniqueKey & skgpu::UniqueKey::operator= ( const UniqueKey &  that )

inline

Definition at line 252 of file ResourceKey.h.

                                                {
        this->ResourceKey::operator=(that);
        this->setCustomData(sk_ref_sp(that.getCustomData()));
        fTag = that.fTag;
        return *this;
    }

operator==()

bool skgpu::UniqueKey::operator== ( const UniqueKey &  that ) const

inline

Definition at line 259 of file ResourceKey.h.

{ return this->ResourceKey::operator==(that); }

refCustomData()

sk_sp< SkData > skgpu::UniqueKey::refCustomData ( ) const

inline

Definition at line 264 of file ResourceKey.h.

{ return fData; }

setCustomData()

void skgpu::UniqueKey::setCustomData ( sk_sp< SkData >  data )

inline

Definition at line 262 of file ResourceKey.h.

{ fData = std::move(data); }

tag()

const char * skgpu::UniqueKey::tag ( ) const

inline

Definition at line 266 of file ResourceKey.h.

{ return fTag; }

---

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

• third_party/skia/src/gpu/ResourceKey.h
• third_party/skia/src/gpu/ResourceKey.cpp