Inherits AZ::RHI::StreamingImagePool.

Public Member Functions
	AZ_CLASS_ALLOCATOR (StreamingImagePool, AZ::SystemAllocator)

	AZ_RTTI (StreamingImagePool, "{15688218-739F-40B2-9753-70AD2A432C3A}", Base)

Public Member Functions inherited from AZ::RHI::StreamingImagePool
	AZ_RTTI (StreamingImagePool, "{C9F1E40E-D852-4515-ADCC-E2D3AB4B56AB}", ImagePoolBase)

ResultCode	Init (Device &device, const StreamingImagePoolDescriptor &descriptor)
	Initializes the pool. The pool must be initialized before images can be registered with it.

ResultCode	InitImage (const StreamingImageInitRequest &request)
	Initializes the backing resources of an image.

ResultCode	ExpandImage (const StreamingImageExpandRequest &request)

ResultCode	TrimImage (Image &image, uint32_t targetMipLevel)

const StreamingImagePoolDescriptor &	GetDescriptor () const override final
	Returns the resource pool descriptor.

void	SetLowMemoryCallback (LowMemoryCallback callback)

bool	SetMemoryBudget (size_t newBudget)

bool	SupportTiledImage () const
	Return if it supports tiled image feature.

Public Member Functions inherited from AZ::RHI::ImagePoolBase
	AZ_RTTI (ImagePoolBase, "{6353E390-C5D2-42FF-8AA9-9AFCD1F2F1B5}", ResourcePool)

Public Member Functions inherited from AZ::RHI::ResourcePool
	AZ_RTTI (ResourcePool, "{757EB674-25DC-4D00-9808-D3DAF33A4EFE}", DeviceObject)

void	Shutdown () override final
	Shuts down the pool. This method will shutdown all resources associated with the pool.

template<typename ResourceType >
void	ForEach (AZStd::function< void(ResourceType &)> callback)

template<typename ResourceType >
void	ForEach (AZStd::function< void(const ResourceType &)> callback) const

uint32_t	GetResourceCount () const
	Returns the number of resources in the pool.

ResourcePoolResolver *	GetResolver ()
	Returns the resolver for this pool.

const ResourcePoolResolver *	GetResolver () const

virtual const ResourcePoolDescriptor &	GetDescriptor () const =0
	Returns the resource pool descriptor.

const HeapMemoryUsage &	GetHeapMemoryUsage (HeapMemoryLevel heapMemoryLevel) const
	Returns the memory used by this pool for a specific heap type.

const PoolMemoryUsage &	GetMemoryUsage () const
	Returns the memory used by this pool.

Public Member Functions inherited from AZ::RHI::DeviceObject
	AZ_RTTI (DeviceObject, "{17D34F71-944C-4AF5-9823-627474C4C0A6}", Object)

bool	IsInitialized () const
	Returns whether the device object is initialized.

Device &	GetDevice () const

Public Member Functions inherited from AZ::RHI::Object
	AZ_RTTI (Object, "{E43378F1-2331-4173-94B8-990ED20E6003}")

void	SetName (const Name &name)
	Sets the name of the object.

const Name &	GetName () const
	Returns the name set on the object by SetName.

uint32_t	use_count ()
	Returns the current use count of the object.

Static Public Member Functions
static RHI::Ptr< StreamingImagePool >	Create ()

Additional Inherited Members
Public Types inherited from AZ::RHI::StreamingImagePool
using	LowMemoryCallback = AZStd::function< bool(size_t targetMemoryUsage)>

Static Public Attributes inherited from AZ::RHI::StreamingImagePool
static const uint64_t	ImagePoolMininumSizeInBytes = 16ul * 1024 * 1024

Protected Types inherited from AZ::RHI::ResourcePool
using	PlatformMethod = AZStd::function< RHI::ResultCode()>
	A simple functor that returns a result code.

Protected Member Functions inherited from AZ::RHI::ImagePoolBase
ResultCode	InitImage (Image *image, const ImageDescriptor &descriptor, PlatformMethod platformInitResourceMethod)

Protected Member Functions inherited from AZ::RHI::ResourcePool
void	OnFrameBegin () override

void	OnFrameCompile () override

void	OnFrameEnd () override

void	SetResolver (AZStd::unique_ptr< ResourcePoolResolver > &&resolvePolicy)

virtual void	ComputeFragmentation () const =0

ResultCode	Init (Device &device, const ResourcePoolDescriptor &descriptor, const PlatformMethod &initMethod)

ResultCode	InitResource (Resource *resource, const PlatformMethod &initResourceMethod)

bool	ValidateIsRegistered (const Resource *resource) const

bool	ValidateIsUnregistered (const Resource *resource) const

bool	ValidateIsInitialized () const
	Validates that the resource pool is initialized and ready to service requests.

bool	ValidateNotProcessingFrame () const
	Validates that we are not in the frame processing phase.

Protected Member Functions inherited from AZ::RHI::DeviceObject
void	Init (Device &device)
	The derived class should call this method to assign the device.

void	Shutdown () override
	Clears the current bound device to null.

Protected Member Functions inherited from AZ::RHI::Object
void	add_ref () const

void	release () const

Protected Attributes inherited from AZ::RHI::StreamingImagePool
LowMemoryCallback	m_memoryReleaseCallback = nullptr

Protected Attributes inherited from AZ::RHI::ResourcePool
PoolMemoryUsage	m_memoryUsage

Protected Attributes inherited from AZ::RHI::Object
AZStd::atomic_int	m_useCount = 0

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

Gems/Atom/RHI/Null/Code/Source/RHI/StreamingImagePool.h

Public Member Functions

Static Public Member Functions

Additional Inherited Members