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::Render::SMAAFeatureProcessor Class Referencefinal

SMAAFeatureProcessor implementation. More...

#include <SMAAFeatureProcessor.h>

Inherits AZ::Render::SMAAFeatureProcessorInterface.

Public Member Functions

 AZ_RTTI (AZ::Render::SMAAFeatureProcessor, "55E360D5-4810-4932-A782-7EA9104E9374", AZ::Render::SMAAFeatureProcessorInterface)
 
void Activate () override
 Perform any necessary activation and gives access to owning Scene.
 
void Deactivate () override
 Perform any necessary deactivation.
 
void Simulate (const SimulatePacket &packet) override
 
void Render (const RenderPacket &packet) override
 
void SetEnable (bool enable) override
 
void SetQualityByPreset (SMAAQualityPreset preset) override
 
void SetEdgeDetectionMode (SMAAEdgeDetectionMode mode) override
 
void SetOutputMode (SMAAOutputMode mode) override
 
void SetChromaThreshold (float threshold) override
 
void SetDepthThreshold (float threshold) override
 
void SetLocalContrastAdaptationFactor (float factor) override
 
void SetPredicationEnable (bool enable) override
 
void SetPredicationThreshold (float threshold) override
 
void SetPredicationScale (float scale) override
 
void SetPredicationStrength (float strength) override
 
void SetMaxSearchSteps (int steps) override
 
void SetMaxSearchStepsDiagonal (int steps) override
 
void SetCornerRounding (int cornerRounding) override
 
void SetDiagonalDetectionEnable (bool enable) override
 
void SetCornerDetectionEnable (bool enable) override
 
const SMAADataGetSettings () const override
 
- Public Member Functions inherited from AZ::Render::SMAAFeatureProcessorInterface
 AZ_RTTI (AZ::Render::SMAAFeatureProcessorInterface, "{7E6A9FB5-E42C-41C3-8F84-40A1D4433A94}", AZ::RPI::FeatureProcessor)
 
virtual void SetEnable (bool enable)=0
 
virtual void SetQualityByPreset (SMAAQualityPreset preset)=0
 
virtual void SetEdgeDetectionMode (SMAAEdgeDetectionMode mode)=0
 
virtual void SetOutputMode (SMAAOutputMode mode)=0
 
virtual void SetChromaThreshold (float threshold)=0
 
virtual void SetDepthThreshold (float threshold)=0
 
virtual void SetLocalContrastAdaptationFactor (float factor)=0
 
virtual void SetPredicationEnable (bool enable)=0
 
virtual void SetPredicationThreshold (float threshold)=0
 
virtual void SetPredicationScale (float scale)=0
 
virtual void SetPredicationStrength (float strength)=0
 
virtual void SetMaxSearchSteps (int steps)=0
 
virtual void SetMaxSearchStepsDiagonal (int steps)=0
 
virtual void SetCornerRounding (int cornerRounding)=0
 
virtual void SetDiagonalDetectionEnable (bool enable)=0
 
virtual void SetCornerDetectionEnable (bool enable)=0
 
virtual const SMAADataGetSettings () const =0
 
- Public Member Functions inherited from AZ::RPI::FeatureProcessor
 AZ_RTTI (FeatureProcessor, "{B8027170-C65C-4237-964D-B557FC9D7575}")
 
 AZ_CLASS_ALLOCATOR (FeatureProcessor, AZ::SystemAllocator)
 
SceneGetParentScene () 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)
 

Additional Inherited Members

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

Detailed Description

SMAAFeatureProcessor implementation.

Member Function Documentation

◆ Activate()

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

Perform any necessary activation and gives access to owning Scene.

Reimplemented from AZ::RPI::FeatureProcessor.

◆ Deactivate()

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

Perform any necessary deactivation.

Reimplemented from AZ::RPI::FeatureProcessor.

◆ GetSettings()

const SMAAData & AZ::Render::SMAAFeatureProcessor::GetSettings ( ) const
overridevirtual

Gets the current settings for SMAA feature.

Returns
A SMAAData currently used.

Implements AZ::Render::SMAAFeatureProcessorInterface.

◆ Render()

void AZ::Render::SMAAFeatureProcessor::Render ( const RenderPacket )
overridevirtual

The feature processor should enqueue draw packets to relevant draw lists.

  • This is called every frame.
  • This may be called in parallel with other feature processors.
  • This may be called in parallel with culling

Reimplemented from AZ::RPI::FeatureProcessor.

◆ SetChromaThreshold()

void AZ::Render::SMAAFeatureProcessor::SetChromaThreshold ( float  threshold)
overridevirtual

Sets the luma/chroma threshold value which is used by edge detection.

Parameters
thresholdThreshold value for edge detection sensitivity. For details please check comment related to SMAA_THRESHOLD in SMAA.azsli.

Implements AZ::Render::SMAAFeatureProcessorInterface.

◆ SetCornerDetectionEnable()

void AZ::Render::SMAAFeatureProcessor::SetCornerDetectionEnable ( bool  enable)
overridevirtual

Enable/disable the corner detection which is used by the sharp geometric feature.

Parameters
enableFlag for sharp corner feature. For details please check comment related to SMAA_DISABLE_CORNER_DETECTION in SMAA.azsli.

Implements AZ::Render::SMAAFeatureProcessorInterface.

◆ SetCornerRounding()

void AZ::Render::SMAAFeatureProcessor::SetCornerRounding ( int  cornerRounding)
overridevirtual

Sets the corner rounding value which is used by the sharp geometric feature.

Parameters
cornerRoundingTweak value for the sharp corner feature. For details please check comment related to SMAA_CORNER_ROUNDING in SMAA.azsli.

Implements AZ::Render::SMAAFeatureProcessorInterface.

◆ SetDepthThreshold()

void AZ::Render::SMAAFeatureProcessor::SetDepthThreshold ( float  threshold)
overridevirtual

Sets the depth threshold value which is used by edge detection.

Parameters
thresholdThreshold value for depth edge detection sensitivity. For details please check comment related to SMAA_DEPTH_THRESHOLD in SMAA.azsli.

Implements AZ::Render::SMAAFeatureProcessorInterface.

◆ SetDiagonalDetectionEnable()

void AZ::Render::SMAAFeatureProcessor::SetDiagonalDetectionEnable ( bool  enable)
overridevirtual

Enable/disable the diagonal edge detection process.

Parameters
enableFlag for diagonal edge detection feature. For details please check comment related to SMAA_DISABLE_DIAG_DETECTION in SMAA.azsli.

Implements AZ::Render::SMAAFeatureProcessorInterface.

◆ SetEdgeDetectionMode()

void AZ::Render::SMAAFeatureProcessor::SetEdgeDetectionMode ( SMAAEdgeDetectionMode  mode)
overridevirtual

Sets the edge detection mode.

Parameters
modeEdge detection mode.

Implements AZ::Render::SMAAFeatureProcessorInterface.

◆ SetEnable()

void AZ::Render::SMAAFeatureProcessor::SetEnable ( bool  enable)
overridevirtual

Enable/disable SMAA feature.

Parameters
enableFlag for SMAA feature.

Implements AZ::Render::SMAAFeatureProcessorInterface.

◆ SetLocalContrastAdaptationFactor()

void AZ::Render::SMAAFeatureProcessor::SetLocalContrastAdaptationFactor ( float  factor)
overridevirtual

Sets the local contrast adaptation factor.

Parameters
factorTweak value for the local contrast adaptation feature. For details please check comment related to SMAA_LOCAL_CONTRAST_ADAPTATION_FACTOR in SMAA.azsli.

Implements AZ::Render::SMAAFeatureProcessorInterface.

◆ SetMaxSearchSteps()

void AZ::Render::SMAAFeatureProcessor::SetMaxSearchSteps ( int  steps)
overridevirtual

Sets the search step value in edge search process.

Parameters
stepsNumber of steps to search edge. For details please check comment related to SMAA_MAX_SEARCH_STEPS in SMAA.azsli.

Implements AZ::Render::SMAAFeatureProcessorInterface.

◆ SetMaxSearchStepsDiagonal()

void AZ::Render::SMAAFeatureProcessor::SetMaxSearchStepsDiagonal ( int  steps)
overridevirtual

Sets the search step value in diagonal search process.

Parameters
stepsNumber of steps to search diagonal edge. For details please check comment related to SMAA_MAX_SEARCH_STEPS_DIAG in SMAA.azsli.

Implements AZ::Render::SMAAFeatureProcessorInterface.

◆ SetOutputMode()

void AZ::Render::SMAAFeatureProcessor::SetOutputMode ( SMAAOutputMode  mode)
overridevirtual

Sets the output mode.

Parameters
modeOutput mode.

Implements AZ::Render::SMAAFeatureProcessorInterface.

◆ SetPredicationEnable()

void AZ::Render::SMAAFeatureProcessor::SetPredicationEnable ( bool  enable)
overridevirtual

Enable/disable the predication feature.

Parameters
enableFlag for predication feature. For details please check comment related to SMAA_PREDICATION in SMAA.azsli.

Implements AZ::Render::SMAAFeatureProcessorInterface.

◆ SetPredicationScale()

void AZ::Render::SMAAFeatureProcessor::SetPredicationScale ( float  scale)
overridevirtual

Sets the predication scale value.

Parameters
scaleTweak value for predication feature. For details please check comment related to SMAA_PREDICATION_SCALE in SMAA.azsli.

Implements AZ::Render::SMAAFeatureProcessorInterface.

◆ SetPredicationStrength()

void AZ::Render::SMAAFeatureProcessor::SetPredicationStrength ( float  strength)
overridevirtual

Sets the predication strength value.

Parameters
strengthTweak value for predication feature. For details please check comment related to SMAA_PREDICATION_STRENGTH in SMAA.azsli.

Implements AZ::Render::SMAAFeatureProcessorInterface.

◆ SetPredicationThreshold()

void AZ::Render::SMAAFeatureProcessor::SetPredicationThreshold ( float  threshold)
overridevirtual

Sets the predication threshold value.

Parameters
thresholdThreshold value for predication feature. For details please check comment related to SMAA_PREDICATION_THRESHOLD in SMAA.azsli.

Implements AZ::Render::SMAAFeatureProcessorInterface.

◆ SetQualityByPreset()

void AZ::Render::SMAAFeatureProcessor::SetQualityByPreset ( SMAAQualityPreset  preset)
overridevirtual

Sets SMAA quality using preset parameters.

Parameters
presetPreset value for performance and quality of SMAA.

Implements AZ::Render::SMAAFeatureProcessorInterface.

◆ Simulate()

void AZ::Render::SMAAFeatureProcessor::Simulate ( const SimulatePacket )
overridevirtual

The feature processor should perform any internal simulation at this point - For instance, updating a particle system or animation. Not every feature processor will need to implement this.

  • This may not be called every frame.
  • This may be called in parallel with other feature processors.

Reimplemented from AZ::RPI::FeatureProcessor.


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