All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
PcpLayerPrefetchRequest Class Reference

PcpLayerPrefetchRequest represents a request to pre-fetch and retain a set of layers in memory. More...

Public Member Functions

PCP_API void RequestSublayerStack (const SdfLayerRefPtr &layer, const SdfLayer::FileFormatArguments &args)
 Enqueue a request to pre-fetch of the sublayers of layer. More...
 
PCP_API void Run (const Pcp_MutedLayers &mutedLayers)
 Run the queued requests, returning when complete. More...
 

Detailed Description

PcpLayerPrefetchRequest represents a request to pre-fetch and retain a set of layers in memory.

It performs the fetch as a parallel operation using a thread pool. Fetched layers are retained by the request to keep them alive until the client can decide what to do with them.

Definition at line 46 of file layerPrefetchRequest.h.

Member Function Documentation

PCP_API void RequestSublayerStack ( const SdfLayerRefPtr layer,
const SdfLayer::FileFormatArguments args 
)

Enqueue a request to pre-fetch of the sublayers of layer.

This recursively includes any nested sublayers. Arguments in args will be passed to Sdf when finding or opening sublayers.

PCP_API void Run ( const Pcp_MutedLayers &  mutedLayers)

Run the queued requests, returning when complete.


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