AZ::RHI::ImageProperty< T > Class Template Reference

#include <ImageProperty.h>

Classes
struct	PropertyRange
	Describes the property value of one image subresource range. More...

Public Member Functions
void	Init (const ImageDescriptor &descriptor)
	Initialize the ImageProperty with the descriptor of the image.
bool	IsInitialized () const
	Returns if has been initialized.
void	Set (const ImageSubresourceRange &range, const T &property)
	Sets a new property value for an image subresource range.
AZStd::vector< PropertyRange >	Get (const ImageSubresourceRange &range) const
void	Reset ()
	Removes all property values that were previously set.

Detailed Description

template<class T>
class AZ::RHI::ImageProperty< T >

Utility class to track a property value of the subresources of an image. This class will keep track of the values that each subresource has and will merge continuous ranges that have the same property value. This is compatible with the way graphic APIs handle image properties. One possible use could be to keep track of layout states of an image to properly add barriers between image state transitions.

Member Function Documentation

Get()

template<class T >

AZStd::vector< typename ImageProperty< T >::PropertyRange > AZ::RHI::ImageProperty< T >::Get

(

const ImageSubresourceRange &

range

)

const

Returns a list with all the property values over an image subresource range. Continuous ranges that have the same property will be group together.

---

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

• Gems/Atom/RHI/Code/Include/Atom/RHI/ImageProperty.h