Open 3D Engine Atom Gem API Reference  22.10.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
Public Member Functions | Protected Attributes | List of all members
AZ::RHI::ImageView Class Reference

#include <ImageView.h>

Inherits AZ::RHI::ResourceView.

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 ImageViewDescriptorGetDescriptor () const
 Returns the view descriptor used at initialization time.
 
const ImageGetImage () 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::ResourceView
const ResourceGetResource () const
 Returns the resource associated with this view.
 
bool IsStale () const
 
 AZ_RTTI (ResourceView, "{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.
 
DeviceGetDevice () const
 
- Public Member Functions inherited from AZ::RHI::Object
 AZ_RTTI (Object, "{E43378F1-2331-4173-94B8-990ED20E6003}")
 
void SetName (const Name &name)
 
const Name & GetName () const
 

Protected Attributes

HashValue64 m_hash = HashValue64{ 0 }
 

Additional Inherited Members

- Protected Member Functions inherited from AZ::RHI::ResourceView
ResultCode Init (const Resource &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.
 

Detailed Description

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


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