Loading...
Searching...
No Matches
Public Types | Public Member Functions | List of all members
ArThreadLocalScopedCache< CachedType > Class Template Reference

Utility class for custom resolver implementations. More...

#include <threadLocalScopedCache.h>

Public Types

using CachePtr = std::shared_ptr<CachedType>
 

Public Member Functions

void BeginCacheScope (VtValue *cacheScopeData)
 
void EndCacheScope (VtValue *cacheScopeData)
 
CachePtr GetCurrentCache ()
 

Detailed Description

template<class CachedType>
class ArThreadLocalScopedCache< CachedType >

Utility class for custom resolver implementations.

This class wraps up a common pattern for implementing thread-local scoped caches for ArResolver::BeginCacheScope and ArResolver::EndCacheScope.

class MyResolver : public ArResolver {
using ResolveCache = ArThreadLocalScopedCache<...>;
ResolveCache _cache;
void BeginCacheScope(VtValue* data) { _cache.BeginCacheScope(data); }
void EndCacheScope(VtValue* data) { _cache.EndCacheScope(data); }
void Resolve(...) {
// If caching is active in this thread, retrieve the current
// cache and use it to lookup/store values.
if (ResolveCache::CachePtr cache = _cache.GetCurrentCache()) {
// ...
}
// Otherwise, caching is not active
// ...
}
};
ArResolver
Interface for the asset resolution system.
Definition resolver.h:43
ArResolver::Resolve
AR_API ArResolvedPath Resolve(const std::string &assetPath) const
Returns the resolved path for the asset identified by the given assetPath if it exists.
ArResolver::EndCacheScope
AR_API void EndCacheScope(VtValue *cacheScopeData)
Mark the end of a resolution caching scope.
ArResolver::BeginCacheScope
AR_API void BeginCacheScope(VtValue *cacheScopeData)
Mark the start of a resolution caching scope.
ArThreadLocalScopedCache
Utility class for custom resolver implementations.
Definition threadLocalScopedCache.h:50
VtValue
Provides a container which may hold any type, and provides introspection and iteration over array typ...
Definition value.h:90
See also
Scoped Resolution Cache

Definition at line 49 of file threadLocalScopedCache.h.

Member Typedef Documentation

◆ CachePtr

template<class CachedType >
using CachePtr = std::shared_ptr<CachedType>

Definition at line 52 of file threadLocalScopedCache.h.

Member Function Documentation

◆ BeginCacheScope()

template<class CachedType >
void BeginCacheScope ( VtValue * cacheScopeData)
inline

Definition at line 54 of file threadLocalScopedCache.h.

◆ EndCacheScope()

template<class CachedType >
void EndCacheScope ( VtValue * cacheScopeData)
inline

Definition at line 81 of file threadLocalScopedCache.h.

◆ GetCurrentCache()

template<class CachedType >
CachePtr GetCurrentCache ( )
inline

Definition at line 89 of file threadLocalScopedCache.h.

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