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

Public Attributes

Name m_imageName
 The name of this image. It will be used as RHI object name (for gpu debug).
 
bool m_isUniqueName = false
 
RHI::ImageDescriptor m_imageDescriptor
 The ImageDescriptor for this AttachmentImage.
 
const AttachmentImagePoolm_imagePool = nullptr
 
const RHI::ClearValuem_optimizedClearValue = nullptr
 
const RHI::ImageViewDescriptorm_imageViewDescriptor = nullptr
 (Optional) The imageViewDescriptor for this image which overides the default ImageViewDescriptor.
 

Member Data Documentation

◆ m_imagePool

const AttachmentImagePool* AZ::RPI::CreateAttachmentImageRequest::m_imagePool = nullptr

The attachment image pool which the AttachmentImage is created from. A default system attachment image pool will be used if it's set to nullptr

◆ m_isUniqueName

bool AZ::RPI::CreateAttachmentImageRequest::m_isUniqueName = false

If true, the AttachmentImage create function may fail if the attachment image with same name already exist. The m_imageName will be used as the attachment id of the created attachment image. The attachment image can be found by its name (same as its attachment id). If false, a random generated uuid will be used for instance id as well as attachment id.


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