Open 3D Engine Atom Gem API Reference
23.05.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
|
#include <ImageView.h>
Inherits AZ::RHI::ResourceView.
Inherited by AZ::DX12::ImageView, AZ::Metal::ImageView, AZ::Null::ImageView, and AZ::Vulkan::ImageView.
Public Member Functions | |
AZ_RTTI (ImageView,"{F2BDEE1F-DEFD-4443-9012-A28AED028D7B}", ResourceView) | |
ResultCode | Init (const Image &image, const ImageViewDescriptor &viewDescriptor) |
Initializes the image view. | |
const ImageViewDescriptor & | GetDescriptor () const |
Returns the view descriptor used at initialization time. | |
const Image & | GetImage () const |
Returns the image associated with this view. | |
bool | IsFullView () const overridefinal |
Returns whether the view covers the entire image (i.e. isn't just a subset). | |
HashValue64 | GetHash () const |
Returns the hash of the view. | |
virtual uint32_t | GetBindlessReadIndex () const |
virtual uint32_t | GetBindlessReadWriteIndex () const |
![]() | |
const Resource & | GetResource () const |
Returns the resource associated with this view. | |
bool | IsStale () const |
AZ_RTTI (ResourceView,"{7F50934E-A2F3-4989-BB8C-F3AFE33BEBDD}", Object) | |
![]() | |
AZ_RTTI (DeviceObject,"{17D34F71-944C-4AF5-9823-627474C4C0A6}", Object) | |
bool | IsInitialized () const |
Returns whether the device object is initialized. | |
Device & | GetDevice () const |
![]() | |
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 Attributes | |
static constexpr uint32_t | InvalidBindlessIndex = 0xFFFFFFFF |
Protected Attributes | |
HashValue64 | m_hash = HashValue64{ 0 } |
![]() | |
AZStd::atomic_int | m_useCount = 0 |
Additional Inherited Members | |
![]() | |
ResultCode | Init (const Resource &resource) |
The derived class should call this method at Init time. | |
![]() | |
void | Init (Device &device) |
The derived class should call this method to assign the device. | |
![]() | |
void | add_ref () const |
void | release () const |
ImageView contains a platform-specific descriptor mapping to a sub-region of an image resource. It associates 1-to-1 with a ImageViewDescriptor. Image views map to a subset of image sub-resources (mip levels / array slices). They can additionally override the base format of the image