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 | Static Public Member Functions | Public Attributes | List of all members
AZ::RPI::PassImageAttachmentDesc Struct Referencefinal

A PassAttachmentDesc used for images. More...

#include <PassAttachmentReflect.h>

Inherits AZ::RPI::PassAttachmentDesc.

Public Member Functions

 AZ_TYPE_INFO (PassImageAttachmentDesc, "{FA075E02-6A2E-4899-B888-B22DD052FCCC}")
 
- Public Member Functions inherited from AZ::RPI::PassAttachmentDesc
 AZ_TYPE_INFO (PassAttachmentDesc, "{79942700-3E86-48AC-8851-2148AFAFF8B7}")
 

Static Public Member Functions

static void Reflect (AZ::ReflectContext *context)
 
- Static Public Member Functions inherited from AZ::RPI::PassAttachmentDesc
static void Reflect (AZ::ReflectContext *context)
 

Public Attributes

RHI::ImageDescriptor m_imageDescriptor
 The image descriptor for the attachment.
 
bool m_generateFullMipChain = false
 
AZStd::vector< RHI::Format > m_formatFallbacks
 List of formats to fallback to if the format specified in the image descriptor is not supported by the device.
 
- Public Attributes inherited from AZ::RPI::PassAttachmentDesc
Name m_name
 The name of the pass attachment.
 
RHI::AttachmentLifetimeType m_lifetime = RHI::AttachmentLifetimeType::Transient
 Whether the attachment is transient or not.
 
PassAttachmentSizeSource m_sizeSource
 Used to data drive the size of the attachment from a specified source attachment.
 
PassAttachmentRef m_arraySizeSource
 Used to data drive the array size of the attachment from a specified source attachment.
 
PassAttachmentRef m_formatSource
 Used to data drive the format of the attachment from a specified source attachment.
 
PassAttachmentRef m_multisampleSource
 Used to data drive the multi-sample state of the attachment from a specified source attachment.
 
AssetReference m_assetRef
 Reference to an external attachment asset, which used for imported attachment.
 

Detailed Description

A PassAttachmentDesc used for images.

Member Data Documentation

◆ m_generateFullMipChain

bool AZ::RPI::PassImageAttachmentDesc::m_generateFullMipChain = false

Whether to auto generate the number of mips based on the attachment so that we get a full mip chain with the smallest mip being 1x1 in size


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