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

#include <ImageView.h>

Inherits AZ::RHI::ResourceView.

Public Member Functions

 AZ_RTTI (ImageView, "{AB366B8F-F1B7-45C6-A0D8-475D4834FAD2}", ResourceView)
 
 ImageView (const RHI::Image *image, ImageViewDescriptor descriptor, MultiDevice::DeviceMask deviceMask)
 
const RHI::Ptr< RHI::DeviceImageViewGetDeviceImageView (int deviceIndex) const
 Given a device index, return the corresponding DeviceImageView for the selected device.
 
const RHI::ImageGetImage () const
 Return the contained multi-device image.
 
const ImageViewDescriptorGetDescriptor () const
 Return the contained ImageViewDescriptor.
 
AZStd::unordered_map< int, uint32_t > GetBindlessReadIndex () const
 
const DeviceResourceViewGetDeviceResourceView (int deviceIndex) const override
 Interface for the two derived classes to return a DeviceResourceView.
 
- Public Member Functions inherited from AZ::RHI::ResourceView
 AZ_RTTI (ResourceView, "{D7442960-531D-4DCC-B60D-FD26FF75BE51}", Object)
 
 ResourceView (const RHI::Resource *resource, MultiDevice::DeviceMask deviceMask)
 
const ResourceGetResource () const
 Returns the resource associated with this view.
 
- 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.
 

Additional Inherited Members

- Protected Member Functions inherited from AZ::RHI::ResourceView
template<typename View , typename ViewDescriptor >
const RHI::Ptr< View > GetDeviceResourceView (int deviceIndex, const ViewDescriptor &viewDescriptor) const
 
- Protected Member Functions inherited from AZ::RHI::Object
void add_ref () const
 
void release () const
 
- Protected Attributes inherited from AZ::RHI::Object
AZStd::atomic_int m_useCount = 0
 

Detailed Description

A ImageView is a light-weight representation of a view onto a multi-device image. It holds a ConstPtr to a multi-device image as well as an ImageViewDescriptor Using both, single-device ImageViews can be retrieved

Member Function Documentation

◆ GetDeviceResourceView()

const DeviceResourceView * AZ::RHI::ImageView::GetDeviceResourceView ( int  deviceIndex) const
inlineoverridevirtual

Interface for the two derived classes to return a DeviceResourceView.

Implements AZ::RHI::ResourceView.


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