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

#include <PipelineRenderSettings.h>

Public Member Functions

 AZ_TYPE_INFO (PipelineRenderSettings, "{2F794FB5-78E4-478A-AC1B-4A71AE172340}")
 

Static Public Member Functions

static void Reflect (AZ::ReflectContext *context)
 

Public Attributes

RHI::Size m_size
 
RHI::Format m_format = RHI::Format::Unknown
 
RHI::MultisampleState m_multisampleState
 

Detailed Description

A collection of render settings that passes can query from the pipeline. This allows the render pipeline to specify certain settings that can affect the underlying passes, for example the MSAA state or the render resolution of certain passes. Please note that settings these values doesn't have an automatic effect and the passes in question need to specify that they use source size/format/msaaState from the pipeline. See PassAttachment::Update and Pass::CreateAttachmentFromDesc for how settings are referenced

Member Data Documentation

◆ m_format

RHI::Format AZ::RPI::PipelineRenderSettings::m_format = RHI::Format::Unknown

The pipeline can specify a custom format that passes can then chose to query Example use case: choose whether to render at R8G8B8A8 or R16G16B16A16

◆ m_multisampleState

RHI::MultisampleState AZ::RPI::PipelineRenderSettings::m_multisampleState

The pipeline can specify a custom MSAA state that passes can then chose to query Example use case: choose whether to render at 2x MSAA, 4x, 8x or no MSAA

◆ m_size

RHI::Size AZ::RPI::PipelineRenderSettings::m_size

The pipeline can specify a custom size that passes can then chose to query Example use case: render at a fixed resolution regardless of swap chain size


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