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::PassRequest Struct Referencefinal

#include <PassRequest.h>

Public Member Functions

 AZ_TYPE_INFO (PassRequest, "{C43802D1-8501-4D7A-B642-85F8646DF46D}")
 
 AZ_CLASS_ALLOCATOR (PassRequest, SystemAllocator, 0)
 
void AddInputConnection (PassConnection inputConnection)
 Add a pass connection to the list of input connections.
 

Static Public Member Functions

static void Reflect (ReflectContext *context)
 

Public Attributes

Name m_passName
 Name of the pass this request will instantiate.
 
Name m_templateName
 Name of the template from which the pass will be created.
 
AZStd::vector< Name > m_executeAfterPasses
 Names of Passes that this Pass should execute after.
 
AZStd::vector< Name > m_executeBeforePasses
 Names of Passes that this Pass should execute before.
 
PassConnectionList m_connections
 
PassImageAttachmentDescList m_imageAttachmentOverrides
 
PassBufferAttachmentDescList m_bufferAttachmentOverrides
 
AZStd::shared_ptr< PassDatam_passData = nullptr
 Optional data to be used during pass initialization.
 
bool m_passEnabled = true
 Initial state of the pass when created (enabled/disabled)
 

Detailed Description

This class represents a request for a Pass to be instantiated from a PassTemplate It also contains a list of inputs for the instantiated pass

Member Data Documentation

◆ m_bufferAttachmentOverrides

PassBufferAttachmentDescList AZ::RPI::PassRequest::m_bufferAttachmentOverrides

List of descriptors for the buffer attachments the PassRequest will create If the pass template already specifies an attachment with the same name, the PassRequest will override that attachment

◆ m_connections

PassConnectionList AZ::RPI::PassRequest::m_connections

Connections for the instantiated Pass Most of the time these will be input connections that point to outputs of other passes Cases where you would want to specify output connections are to connect to image or buffer attachment overrides in the lists below

◆ m_imageAttachmentOverrides

PassImageAttachmentDescList AZ::RPI::PassRequest::m_imageAttachmentOverrides

List of descriptors for the image attachments the PassRequest will create If the pass template already specifies an attachment with the same name, the PassRequest will override that attachment


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