Open 3D Engine Atom Gem API Reference 26.05.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
AZ::Vulkan::ImageView Class Referencefinal

Inherits AZ::RHI::DeviceImageView.

Public Types

using ResourceType = Image
 

Public Member Functions

 AZ_CLASS_ALLOCATOR (ImageView, AZ::ThreadPoolAllocator)
 
 AZ_RTTI (ImageView, "0BDF7F84-BBC8-40C7-BC9A-686E22099643", Base)
 
VkImageView GetNativeImageView () const
 
RHI::Format GetFormat () const
 
RHI::ImageAspectFlags GetAspectFlags () const
 
const RHI::ImageSubresourceRange & GetImageSubresourceRange () const
 
const VkImageSubresourceRange & GetVkImageSubresourceRange () const
 
uint32_t GetBindlessReadIndex () const override
 
uint32_t GetBindlessReadWriteIndex () const override
 
- Public Member Functions inherited from AZ::RHI::DeviceImageView
 AZ_RTTI (DeviceImageView, "{F2BDEE1F-DEFD-4443-9012-A28AED028D7B}", DeviceResourceView)
 
ResultCode Init (const DeviceImage &image, const ImageViewDescriptor &viewDescriptor)
 Initializes the image view.
 
const ImageViewDescriptor & GetDescriptor () const
 Returns the view descriptor used at initialization time.
 
const DeviceImage & GetImage () const
 Returns the image associated with this view.
 
bool IsFullView () const override final
 Returns whether the view covers the entire image (i.e. isn't just a subset).
 
HashValue64 GetHash () const
 Returns the hash of the view.
 
- Public Member Functions inherited from AZ::RHI::DeviceResourceView
const DeviceResource & GetResource () const
 Returns the resource associated with this view.
 
bool IsStale () const
 
 AZ_RTTI (DeviceResourceView, "{7F50934E-A2F3-4989-BB8C-F3AFE33BEBDD}", Object)
 
- 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< ImageView > Create ()
 

Additional Inherited Members

- Static Public Attributes inherited from AZ::RHI::DeviceImageView
static constexpr uint32_t InvalidBindlessIndex = 0xFFFFFFFF
 
- Protected Member Functions inherited from AZ::RHI::DeviceResourceView
ResultCode Init (const DeviceResource &resource)
 The derived class should call this method at Init time.
 
- Protected Member Functions inherited from AZ::RHI::DeviceObject
void Init (Device &device)
 The derived class should call this method to assign the device.
 
- Protected Member Functions inherited from AZ::RHI::Object
void add_ref () const
 
void release () const
 
- Protected Attributes inherited from AZ::RHI::DeviceImageView
HashValue64 m_hash = HashValue64{ 0 }
 
- Protected Attributes inherited from AZ::RHI::Object
AZStd::atomic_int m_useCount = 0
 

Member Function Documentation

◆ GetBindlessReadIndex()

uint32_t AZ::Vulkan::ImageView::GetBindlessReadIndex ( ) const
overridevirtual

Reimplemented from AZ::RHI::DeviceImageView.

◆ GetBindlessReadWriteIndex()

uint32_t AZ::Vulkan::ImageView::GetBindlessReadWriteIndex ( ) const
overridevirtual

Reimplemented from AZ::RHI::DeviceImageView.


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