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

#include <PostProcessSettings.h>

Inherits AZ::Render::PostProcessSettingsInterface, and AZ::Render::PostProcessBase.

Public Member Functions

 AZ_RTTI (AZ::Render::PostProcessSettings, "{E4BD5945-F4C6-4B68-B1D3-28700BD2BF88}", AZ::Render::PostProcessSettingsInterface, AZ::Render::PostProcessBase)
 
 AZ_CLASS_ALLOCATOR (PostProcessSettings, SystemAllocator)
 
 PostProcessSettings (PostProcessFeatureProcessor *featureProcessor)
 
void OnConfigChanged () override
 To be called when config settings have been changed.
 
int GetLayerCategoryValue () const
 
void SetLayerCategoryValue (int layerCategoryValue) override
 Setter for PostFx setting's layer represented by an integer.
 
void CopyViewToBlendWeightSettings (const ViewBlendWeightMap &perViewBlendWeights) override
 Function to import blend weight settings.
 
float GetBlendWeightForView (AZ::RPI::View *view) const
 
- Public Member Functions inherited from AZ::Render::PostProcessSettingsInterface
 AZ_RTTI (AZ::Render::PostProcessSettingsInterface, "{22949C39-B56B-4920-94FA-6FDFA8273A2C}")
 
- Public Member Functions inherited from AZ::Render::PostProcessBase
 AZ_RTTI (AZ::Render::PostProcessBase, "{DDA620D0-12AB-471A-82F8-701BCD1A00D8}")
 
 AZ_CLASS_ALLOCATOR (PostProcessBase, SystemAllocator)
 
 PostProcessBase (PostProcessFeatureProcessor *featureProcessor)
 

Friends

class PostProcessFeatureProcessor
 

Additional Inherited Members

- Public Types inherited from AZ::Render::PostProcessSettingsInterface
using ViewBlendWeightMap = AZStd::unordered_map< AZ::RPI::View *, float >
 
- Static Public Attributes inherited from AZ::Render::PostProcessSettingsInterface
static constexpr float defaultBlendWeight = 1.0f
 
- Protected Member Functions inherited from AZ::Render::PostProcessBase
RPI::ShaderResourceGroup * GetSceneSrg () const
 
RPI::Scene * GetParentScene () const
 
AZ::Data::Instance< AZ::RPI::ShaderResourceGroup > GetDefaultViewSrg () const
 
- Protected Attributes inherited from AZ::Render::PostProcessBase
PostProcessFeatureProcessor * m_featureProcessor = nullptr
 

Detailed Description

A collection of post process settings This class is responsible for managing and blending sub-settings classes for post effects like depth of field, anti-aliasing, SSAO, etc.

Member Function Documentation

◆ CopyViewToBlendWeightSettings()

void AZ::Render::PostProcessSettings::CopyViewToBlendWeightSettings ( const ViewBlendWeightMap &  perCameraBlendWeights)
overridevirtual

Function to import blend weight settings.

Implements AZ::Render::PostProcessSettingsInterface.

◆ OnConfigChanged()

void AZ::Render::PostProcessSettings::OnConfigChanged ( )
overridevirtual

To be called when config settings have been changed.

Implements AZ::Render::PostProcessSettingsInterface.

◆ SetLayerCategoryValue()

void AZ::Render::PostProcessSettings::SetLayerCategoryValue ( int  layerCategoryValue)
inlineoverridevirtual

Setter for PostFx setting's layer represented by an integer.

Implements AZ::Render::PostProcessSettingsInterface.

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