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

A descriptor used to create a render pipeline. More...

#include <RenderPipelineDescriptor.h>

Public Member Functions

 AZ_TYPE_INFO (RenderPipelineDescriptor, "{B1A5CF41-AC8D-440E-A1E9-3544D7F3445B}")
 

Static Public Member Functions

static void Reflect (AZ::ReflectContext *context)
 

Public Attributes

AZStd::string m_rootPassTemplate
 The root pass template name.
 
AZStd::string m_mainViewTagName = "MainCamera"
 
AZStd::string m_name
 
PipelineRenderSettings m_renderSettings
 Render settings that can be queried by passes to set things like MSAA on attachments.
 
bool m_executeOnce = false
 Flag indicating if this pipeline should execute one time and then be removed.
 
bool m_allowModification = false
 Flag indicating if this pipeline can accept modifications from scene's feature processors.
 

Detailed Description

A descriptor used to create a render pipeline.

Member Data Documentation

◆ m_mainViewTagName

AZStd::string AZ::RPI::RenderPipelineDescriptor::m_mainViewTagName = "MainCamera"

The name string of the pipeline view tag we want to use as default view tag. The view associated to this view tag should be persistent. Some passes in this pipeline should use this view tag

◆ m_name

AZStd::string AZ::RPI::RenderPipelineDescriptor::m_name

Render Pipeline's name. This name will be used to identify the render pipeline when it's added to a scene. Render pipelines in the same scene won't have same name.


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