Open 3D Engine Atom Gem API Reference  2205.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 | Friends | List of all members
AZ::RPI::Image Class Reference

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

#include <Image.h>

Inherits 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, 0)
 
bool IsInitialized () const
 Returns whether Image is currently initialized.
 
RHI::ImageGetRHIImage ()
 Returns the mutable GPU image instance initialized at asset load time.
 
const RHI::ImageGetRHIImage () const
 Returns the immutable GPU image instance initialized at asset load time.
 
const RHI::ImageViewGetImageView () const
 Returns the default image view instance, mapping the full (resident) image.
 
const RHI::ImageDescriptorGetDescriptor () 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::Imagem_image
 
RHI::Ptr< RHI::ImageViewm_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: