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

#include <PassTemplate.h>

Public Member Functions

 AZ_RTTI (PassTemplate, "{BF485F6D-02EC-4BAD-94BA-519248F59D14}")
 
 AZ_CLASS_ALLOCATOR (PassTemplate, SystemAllocator, 0)
 
AZStd::shared_ptr< PassTemplateClone () const
 
AZStd::unique_ptr< PassTemplateCloneUnique () const
 
const PassRequestFindPassRequest (const Name &passName) const
 Find a pass request by name in m_passRequests.
 
void AddSlot (PassSlot passSlot)
 Adds a slot to the PassTemplate.
 
void AddOutputConnection (PassConnection connection)
 Adds an output connection to the PassTemplate.
 
void AddImageAttachment (PassImageAttachmentDesc imageAttachment)
 Adds an image descriptor to the PassTemplate.
 
void AddBufferAttachment (PassBufferAttachmentDesc bufferAttachment)
 Adds an image descriptor to the PassTemplate.
 
void AddPassRequest (PassRequest passRequest)
 Adds a pass request to the PassTemplate.
 

Static Public Member Functions

static void Reflect (ReflectContext *context)
 

Public Attributes

Name m_name
 
Name m_passClass
 Name of the pass class to instantiate.
 
PassSlotList m_slots
 Lists of inputs, outputs and input/outputs.
 
PassConnectionList m_connections
 
PassFallbackConnectionList m_fallbackConnections
 
PassImageAttachmentDescList m_imageAttachments
 List of descriptors for the image attachments the Pass will own.
 
PassBufferAttachmentDescList m_bufferAttachments
 List of descriptors for the buffer attachments the Pass will own.
 
PassRequestList m_passRequests
 List of requests to create child passes.
 
AZStd::shared_ptr< PassDatam_passData = nullptr
 Optional data to be used during pass initialization.
 

Friends

class PassAsset
 

Detailed Description

Used to data drive passes in the pass system. Contains lists of input and output attachment slots as well as requests to instantiate child passes.

Member Data Documentation

◆ m_connections

PassConnectionList AZ::RPI::PassTemplate::m_connections

Connections for the Pass. Most of the time these will be output connections (which often point to attachments owned by the pass), since input connections should be specified by the PassRequest (inputs are generally hooked up to other passes). Cases where you would want to specify input connections on the PassTemplate are images imported as assets.

◆ m_fallbackConnections

PassFallbackConnectionList AZ::RPI::PassTemplate::m_fallbackConnections

Fallback connections for the Pass's outputs. These connections will hook up to inputs of the pass and provide a fallback attachment for when the pass is disabled.


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