AZ::RPI::StreamingImagePoolAsset Class Reference

#include <StreamingImagePoolAsset.h>

Inherits AZ::Data::AssetData.

Public Member Functions
	AZ_RTTI (StreamingImagePoolAsset, "{877B2DA2-BBE7-42E7-AED3-F571929820FE}", Data::AssetData)
	AZ_CLASS_ALLOCATOR (StreamingImagePoolAsset, SystemAllocator)
const RHI::StreamingImagePoolDescriptor &	GetPoolDescriptor () const
AZStd::string_view	GetPoolName () const
	Returns the name of the pool.

Static Public Member Functions
static void	Reflect (AZ::ReflectContext *context)

Static Public Attributes
static constexpr const char *	DisplayName { "StreamingImagePool" }
static constexpr const char *	Group { "Image" }
static constexpr const char *	Extension { "streamingimagepool" }

Friends
class	StreamingImagePoolAssetCreator
class	StreamingImagePoolAssetTester

Detailed Description

Flat data used to instantiate a streaming image pool instance at runtime. The streaming image pool asset contains configuration data used to instantiate both a pool instance and a controller instance. Each pool asset is able to spawn a unique streaming controller implementation with its own platform-specific configuration data. Similarly, the pool descriptor may also be platform-specific. To accomplish this, each descriptor has its own override.

• The pool descriptor may be overridden with a platform-specific derived version. Do this to communicate platform-specific details directly to the platform under the RHI.
• The controller descriptor is completely abstract, so it must be overridden to communicate configuration data to the underlying controller implementation. Both of these overrides should be assigned at asset build time for the specific platform. This is an immutable, serialized asset. It can be either serialized-in or created dynamically using StreamingImagePoolAssetCreator. See RPI::StreamingImagePool for runtime features based on this asset.

Member Function Documentation

GetPoolDescriptor()

const RHI::StreamingImagePoolDescriptor & AZ::RPI::StreamingImagePoolAsset::GetPoolDescriptor

(

)

const

Returns the RHI streaming image pool descriptor used to initialize a runtime instance. This is a heap-allocated shared base-class pointer. It may be a RHI backend-specific derived class type. This is determined by the asset builder.

---

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

• Gems/Atom/RPI/Code/Include/Atom/RPI.Reflect/Image/StreamingImagePoolAsset.h