AZ::RPI::Image Class Reference

A base class for images providing access to common image information. More...

#include <Image.h>

Inherits Data::InstanceData.

Inherited by AZ::RPI::AttachmentImage, and AZ::RPI::StreamingImage.

Public Member Functions
	AZ_INSTANCE_DATA (Image, "{4E4B1092-1BEE-4DC4-BE4B-8FBC83B0F48C}")
	AZ_CLASS_ALLOCATOR (Image, AZ::SystemAllocator)
bool	IsInitialized () const
	Returns whether Image is currently initialized.
RHI::Image *	GetRHIImage ()
	Returns the mutable GPU image instance initialized at asset load time.
const RHI::Image *	GetRHIImage () const
	Returns the immutable GPU image instance initialized at asset load time.
const RHI::ImageView *	GetImageView () const
	Returns the default image view instance, mapping the full (resident) image.
const RHI::ImageDescriptor &	GetDescriptor () const
	Returns the image descriptor which contains some image information.
uint16_t	GetMipLevelCount ()
	Returns the number of mip levels of this image.
virtual RHI::ResultCode	UpdateImageContents (const RHI::ImageUpdateRequest &request)
	Updates content of a single sub-resource in the image from the CPU.

Protected Attributes
RHI::Ptr< RHI::Image >	m_image
RHI::Ptr< RHI::ImageView >	m_imageView

Friends
class	ImageSystem

Detailed Description

A base class for images providing access to common image information.

---

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

• Gems/Atom/RPI/Code/Include/Atom/RPI.Reflect/Image/Image.h