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.
Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
AZ::RHI::RenderAttachmentConfiguration Struct Reference

#include <RenderAttachmentLayout.h>

Public Member Functions

 AZ_TYPE_INFO (RenderAttachmentConfiguration, "{037F27A5-B568-439B-81D4-928DFA3A74F2}")
 
HashValue64 GetHash () const
 
bool operator== (const RenderAttachmentConfiguration &other) const
 
Format GetRenderTargetFormat (uint32_t index) const
 Returns the format of a render target in the subpass being used.
 
Format GetSubpassInputFormat (uint32_t index) const
 Returns the format of a subpass input in the subpass being used.
 
Format GetRenderTargetResolveFormat (uint32_t index) const
 Returns the format of resolve attachment in the subpass being used.
 
Format GetDepthStencilFormat () const
 
uint32_t GetRenderTargetCount () const
 Returns the number of render targets in the subpass being used.
 
uint32_t GetSubpassInputCount () const
 Returns the number of subpass inputs in the subpass being used.
 
bool DoesRenderTargetResolve (uint32_t index) const
 Returns true if the render target is resolving in the subpass being used.
 

Static Public Member Functions

static void Reflect (ReflectContext *context)
 

Public Attributes

RenderAttachmentLayout m_renderAttachmentLayout
 Layout of the render target attachments.
 
uint32_t m_subpassIndex = 0
 Index of the subpass being used.
 

Detailed Description

Describes the layout of a collection of subpasses and it defines which of the subpasses this configuration will be using.

Member Function Documentation

◆ GetDepthStencilFormat()

Format AZ::RHI::RenderAttachmentConfiguration::GetDepthStencilFormat ( ) const

Returns the format of a depth/stencil in the subpass being used. Will return Format::Unkwon if the depth/stencil is not being used.

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