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.
Public Types | Public Member Functions | Static Public Member Functions | List of all members
AZ::Render::AcesDisplayMapperFeatureProcessor Class Referencefinal

#include <AcesDisplayMapperFeatureProcessor.h>

Inherits AZ::Render::DisplayMapperFeatureProcessorInterface.

Public Types

enum  OutputDeviceTransformFlags { AlterSurround = 0x1 , ApplyDesaturation = 0x2 , ApplyCATD60toD65 = 0x4 }
 

Public Member Functions

 AZ_RTTI (AZ::Render::AcesDisplayMapperFeatureProcessor, "{995C2B93-8B08-4313-89B0-02394F90F1B8}", AZ::Render::DisplayMapperFeatureProcessorInterface)
 
void Activate () override
 Perform any necessary activation and gives access to owning Scene.
 
void Deactivate () override
 Perform any necessary deactivation.
 
void Simulate (const FeatureProcessor::SimulatePacket &packet) override
 
void Render (const FeatureProcessor::RenderPacket &packet) override
 
void GetOwnedLut (DisplayMapperLut &displayMapperLut, const AZ::Name &lutName) override
 
void GetDisplayMapperLut (DisplayMapperLut &displayMapperLut) override
 
void GetLutFromAssetLocation (DisplayMapperAssetLut &displayMapperAssetLut, const AZStd::string &assetPath) override
 
void GetLutFromAssetId (DisplayMapperAssetLut &displayMapperAssetLut, const AZ::Data::AssetId) override
 
void RegisterDisplayMapperConfiguration (const DisplayMapperConfigurationDescriptor &config) override
 
DisplayMapperConfigurationDescriptor GetDisplayMapperConfiguration () override
 
- Public Member Functions inherited from AZ::Render::DisplayMapperFeatureProcessorInterface
 AZ_RTTI (AZ::Render::DisplayMapperFeatureProcessorInterface, "{FA57793A-1C7B-4B44-88C4-02AA431C468F}", AZ::RPI::FeatureProcessor)
 
virtual void GetOwnedLut (DisplayMapperLut &displayMapperLut, const AZ::Name &lutName)=0
 
virtual void GetDisplayMapperLut (DisplayMapperLut &displayMapperLut)=0
 
virtual void GetLutFromAssetLocation (DisplayMapperAssetLut &displayMapperAssetLut, const AZStd::string &assetPath)=0
 
virtual void GetLutFromAssetId (DisplayMapperAssetLut &displayMapperAssetLut, const AZ::Data::AssetId)=0
 
virtual void RegisterDisplayMapperConfiguration (const DisplayMapperConfigurationDescriptor &config)=0
 
virtual DisplayMapperConfigurationDescriptor GetDisplayMapperConfiguration ()=0
 
- Public Member Functions inherited from AZ::RPI::FeatureProcessor
 AZ_RTTI (FeatureProcessor, "{B8027170-C65C-4237-964D-B557FC9D7575}")
 
 AZ_CLASS_ALLOCATOR (FeatureProcessor, AZ::SystemAllocator)
 
Scene * GetParentScene () const
 
virtual void Activate ()
 Perform any necessary activation and gives access to owning Scene.
 
virtual void Deactivate ()
 Perform any necessary deactivation.
 
virtual void ApplyRenderPipelineChange (RenderPipeline *pipeline)
 
virtual void AddRenderPasses (RenderPipeline *pipeline)
 
virtual void PrepareViews (const PrepareViewsPacket &, AZStd::vector< AZStd::pair< PipelineViewTag, ViewPtr > > &)
 
virtual void Simulate (const SimulatePacket &)
 
virtual void Render (const RenderPacket &)
 
virtual void OnEndCulling (const RenderPacket &)
 
virtual void OnRenderEnd ()
 

Static Public Member Functions

static void Reflect (AZ::ReflectContext *context)
 
static OutputDeviceTransformType GetOutputDeviceTransformType (RHI::Format bufferFormat)
 
static void GetAcesDisplayMapperParameters (DisplayMapperParameters *displayMapperParameters, OutputDeviceTransformType odtType)
 
static ShaperParams GetShaperParameters (ShaperPresetType shaperPreset, float customMinEv=0.0f, float customMaxEv=0.0f)
 
static void GetDefaultDisplayMapperConfiguration (DisplayMapperConfigurationDescriptor &config)
 

Additional Inherited Members

- Protected Member Functions inherited from AZ::RPI::FeatureProcessor
void EnableSceneNotification ()
 
void DisableSceneNotification ()
 

Detailed Description

The ACES display mapper feature processor. This class create display mapper shader input parameters by using the ACES reference implementation.

Member Function Documentation

◆ Activate()

void AZ::Render::AcesDisplayMapperFeatureProcessor::Activate ( )
overridevirtual

Perform any necessary activation and gives access to owning Scene.

Reimplemented from AZ::RPI::FeatureProcessor.

◆ Deactivate()

void AZ::Render::AcesDisplayMapperFeatureProcessor::Deactivate ( )
overridevirtual

Perform any necessary deactivation.

Reimplemented from AZ::RPI::FeatureProcessor.

◆ GetDisplayMapperConfiguration()

DisplayMapperConfigurationDescriptor AZ::Render::AcesDisplayMapperFeatureProcessor::GetDisplayMapperConfiguration ( )
overridevirtual

Implements AZ::Render::DisplayMapperFeatureProcessorInterface.

◆ GetDisplayMapperLut()

void AZ::Render::AcesDisplayMapperFeatureProcessor::GetDisplayMapperLut ( DisplayMapperLut &  displayMapperLut)
overridevirtual

Implements AZ::Render::DisplayMapperFeatureProcessorInterface.

◆ GetLutFromAssetId()

void AZ::Render::AcesDisplayMapperFeatureProcessor::GetLutFromAssetId ( DisplayMapperAssetLut &  displayMapperAssetLut,
const AZ::Data::AssetId   
)
overridevirtual

Implements AZ::Render::DisplayMapperFeatureProcessorInterface.

◆ GetLutFromAssetLocation()

void AZ::Render::AcesDisplayMapperFeatureProcessor::GetLutFromAssetLocation ( DisplayMapperAssetLut &  displayMapperAssetLut,
const AZStd::string &  assetPath 
)
overridevirtual

Implements AZ::Render::DisplayMapperFeatureProcessorInterface.

◆ GetOwnedLut()

void AZ::Render::AcesDisplayMapperFeatureProcessor::GetOwnedLut ( DisplayMapperLut &  displayMapperLut,
const AZ::Name &  lutName 
)
overridevirtual

Implements AZ::Render::DisplayMapperFeatureProcessorInterface.

◆ RegisterDisplayMapperConfiguration()

void AZ::Render::AcesDisplayMapperFeatureProcessor::RegisterDisplayMapperConfiguration ( const DisplayMapperConfigurationDescriptor &  config)
overridevirtual

Implements AZ::Render::DisplayMapperFeatureProcessorInterface.

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