skgpu::graphite::ScratchResourceManager Class Reference

#include <ScratchResourceManager.h>

Classes
class	PendingUseListener

Public Member Functions
	ScratchResourceManager (ResourceProvider *resourceProvider, std::unique_ptr< ProxyReadCountMap >)
	~ScratchResourceManager ()
sk_sp< Texture >	getScratchTexture (SkISize, const TextureInfo &, std::string_view label)
void	returnTexture (sk_sp< Texture >)
void	pushScope ()
void	popScope ()
void	notifyResourcesConsumed ()
void	markResourceInUse (PendingUseListener *listener)
int	pendingReadCount (const TextureProxy *proxy) const
bool	removePendingRead (const TextureProxy *proxy)

Detailed Description

ScratchResourceManager helps coordinate the reuse of resources within a Recording that would not otherwise be returned from the ResourceProvider/Cache because the Recorder is holds usage refs on the resources and they are typically not Shareable.

A ScratchResourceManager maintains a pool of resources that have been handed out for some use case and then been explicitly returned by the original holder. It is up to the callers to return resources in an optimal manner (for best reuse) and not use them after they've been returned for a later task's use. To help callers manage when they can return resources, the manager maintains a stack that corresponds with the depth-first traversal of the tasks during prepareResources() and provides hooks to register listeners that are invoked when tasks read or sample resources.

Once all uninstantiated resources are assigned and prepareResources() succeeds, the ScratchResourceManager can be discarded. The reuse within a Recording's task graph is fixed at that point and remains valid even if the recording is replayed.

Definition at line 75 of file ScratchResourceManager.h.

Constructor & Destructor Documentation

ScratchResourceManager()

skgpu::graphite::ScratchResourceManager::ScratchResourceManager	(	ResourceProvider *	resourceProvider,
		std::unique_ptr< ProxyReadCountMap >	proxyCounts
	)

Definition at line 17 of file ScratchResourceManager.cpp.

        : fResourceProvider(resourceProvider)
        , fProxyReadCounts(std::move(proxyCounts)) {
    SkASSERT(resourceProvider);
    SkASSERT(fProxyReadCounts);
}

~ScratchResourceManager()

skgpu::graphite::ScratchResourceManager::~ScratchResourceManager ( )

default

Member Function Documentation

getScratchTexture()

sk_sp< Texture > skgpu::graphite::ScratchResourceManager::getScratchTexture	(	SkISize	dimensions,
		const TextureInfo &	info,
		std::string_view	label
	)

Definition at line 27 of file ScratchResourceManager.cpp.

                                                                               {
    for (ScratchTexture& st : fScratchTextures) {
        if (st.fAvailable &&
            st.fTexture->dimensions() == dimensions &&
            st.fTexture->textureInfo() == info) {
            // An exact match, reuse it.
            st.fAvailable = false;
            return st.fTexture;
        }
    }
 
    // No texture was available so go out to the resource provider, which will hopefully find a
    // cached resource that was freed up from a previous recording (or create a new one, if not).
    // TODO(b/339496039): Always start with a fixed label like "ScratchTexture" and then concatenate
    // the proxy label that's passed in onto the texture's label, including when reusing a texture.
    sk_sp<Texture> newScratchTexture = fResourceProvider->findOrCreateScratchTexture(
            dimensions, info, std::move(label), Budgeted::kYes);
    if (newScratchTexture) {
        fScratchTextures.push_back({newScratchTexture, /*fAvailable=*/false});
    }
    return newScratchTexture;
}

markResourceInUse()

void skgpu::graphite::ScratchResourceManager::markResourceInUse

(

PendingUseListener *

listener

)

Definition at line 102 of file ScratchResourceManager.cpp.

                                                                           {
    // Should only be called inside a scope
    SkASSERT(!fListenerStack.empty());
    fListenerStack.push_back(listener);
}

notifyResourcesConsumed()

void skgpu::graphite::ScratchResourceManager::notifyResourcesConsumed

(

)

Definition at line 85 of file ScratchResourceManager.cpp.

                                                     {
    // Should only be called inside a scope
    SkASSERT(!fListenerStack.empty());
 
    int n = 0;
    while (PendingUseListener* listener = fListenerStack.fromBack(n)) {
        listener->onUseCompleted(this);
        n++;
    }
    SkASSERT(n < fListenerStack.size() && fListenerStack.fromBack(n) == nullptr);
    // Remove all non-null listeners that were just invoked, but do not remove the null entry that
    // marks the start of this scope boundary.
    if (n > 0) {
        fListenerStack.pop_back_n(n);
    }
}

pendingReadCount()

int skgpu::graphite::ScratchResourceManager::pendingReadCount ( const TextureProxy *  proxy ) const

inline

Definition at line 164 of file ScratchResourceManager.h.

                                                          {
        return fProxyReadCounts->get(proxy);
    }

popScope()

void skgpu::graphite::ScratchResourceManager::popScope

(

)

Definition at line 69 of file ScratchResourceManager.cpp.

                                      {
    // Must have at least the null element to start the scope being popped
    SkASSERT(!fListenerStack.empty());
 
    // TODO: Assert that the current sublist is empty (i.e. the back element is a null pointer) but
    // for now skip over them and leave them un-invoked to keep the unconsumed scratch resources
    // out of the pool so they remain valid in later recordings.
    int n = 0;
    while (fListenerStack.fromBack(n)) {
        n++;
    }
    SkASSERT(n < fListenerStack.size() && fListenerStack.fromBack(n) == nullptr);
    // Remove all non-null listeners after the most recent null entry AND the null entry
    fListenerStack.pop_back_n(n + 1);
}

pushScope()

void skgpu::graphite::ScratchResourceManager::pushScope

(

)

Definition at line 64 of file ScratchResourceManager.cpp.

                                       {
    // Push a null pointer to mark the beginning of the list of listeners in the next depth
    fListenerStack.push_back(nullptr);
}

removePendingRead()

bool skgpu::graphite::ScratchResourceManager::removePendingRead ( const TextureProxy *  proxy )

inline

Definition at line 169 of file ScratchResourceManager.h.

                                                      {
        return fProxyReadCounts->decrement(proxy);
    }

returnTexture()

void skgpu::graphite::ScratchResourceManager::returnTexture

(

sk_sp< Texture >

texture

)

Definition at line 52 of file ScratchResourceManager.cpp.

                                                                 {
    for (ScratchTexture& st : fScratchTextures) {
        if (st.fTexture.get() == texture.get()) {
            SkASSERT(!st.fAvailable);
            st.fAvailable = true;
            return;
        }
    }
    // Trying to return a resource that didn't come from getScratchTexture().
    SkASSERT(false);
}

---

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

• third_party/skia/src/gpu/graphite/ScratchResourceManager.h
• third_party/skia/src/gpu/graphite/ScratchResourceManager.cpp