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::PassDescriptor Struct Reference

#include <PassDescriptor.h>

Public Member Functions

 AZ_TYPE_INFO (PassDescriptor, "{71E0E3D4-58FC-4254-BA7B-5A7ADFE15FE7}")
 PassDescriptor (Name name, const AZStd::shared_ptr< const PassTemplate > passTemplate=nullptr, const PassRequest *passRequest=nullptr)

Public Attributes

Name m_passName
 Required: Every PassDescriptor must have a valid name before being used as an input for Pass construction.
AZStd::shared_ptr< const PassTemplatem_passTemplate = nullptr
 Optional: The PassTemplate used to construct a Pass.
const PassRequestm_passRequest = nullptr
AZStd::shared_ptr< PassDatam_passData = nullptr

Detailed Description

Single struct that serves as the input for pass constructors. A PassDescriptor must always have a valid name. It has optional pointers to a PassTemplate and a PassRequest If the PassRequest is valid then the PassTemplate must also be valid and point to the PassTemplate used by the PassRequest.

Member Data Documentation

◆ m_passData

AZStd::shared_ptr<PassData> AZ::RPI::PassDescriptor::m_passData = nullptr

Optional: Custom data used for pass initialization. This data usually comes from the pass template or pass request. Only use this if you are initializing a pass without either of those.

◆ m_passRequest

const PassRequest* AZ::RPI::PassDescriptor::m_passRequest = nullptr

Optional: The PassRequest used to construct a Pass. If this is valid then m_passTemplate cannot be null and m_passTemplate must point to the same template used by the PassRequest.

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