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::SMAAFeatureProcessorInterface Class Referenceabstract

#include <SMAAFeatureProcessorInterface.h>

Inherits AZ::RPI::FeatureProcessor.

Inherited by AZ::Render::SMAAFeatureProcessor.

Public Member Functions

 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 ()
 

Additional Inherited Members

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

Detailed Description

SMAAFeatureProcessorInterface provides an interface to SMAA feature. This is necessary for code outside of the Atom features gem to communicate with the SMAAFeatureProcessor.

Member Function Documentation

◆ GetSettings()

virtual const SMAAData & AZ::Render::SMAAFeatureProcessorInterface::GetSettings ( ) const
pure virtual

Gets the current settings for SMAA feature.

Returns
A SMAAData currently used.

Implemented in AZ::Render::SMAAFeatureProcessor.

◆ SetChromaThreshold()

virtual void AZ::Render::SMAAFeatureProcessorInterface::SetChromaThreshold ( float  threshold)
pure virtual

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.

Implemented in AZ::Render::SMAAFeatureProcessor.

◆ SetCornerDetectionEnable()

virtual void AZ::Render::SMAAFeatureProcessorInterface::SetCornerDetectionEnable ( bool  enable)
pure virtual

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.

Implemented in AZ::Render::SMAAFeatureProcessor.

◆ SetCornerRounding()

virtual void AZ::Render::SMAAFeatureProcessorInterface::SetCornerRounding ( int  cornerRounding)
pure virtual

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.

Implemented in AZ::Render::SMAAFeatureProcessor.

◆ SetDepthThreshold()

virtual void AZ::Render::SMAAFeatureProcessorInterface::SetDepthThreshold ( float  threshold)
pure virtual

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.

Implemented in AZ::Render::SMAAFeatureProcessor.

◆ SetDiagonalDetectionEnable()

virtual void AZ::Render::SMAAFeatureProcessorInterface::SetDiagonalDetectionEnable ( bool  enable)
pure virtual

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.

Implemented in AZ::Render::SMAAFeatureProcessor.

◆ SetEdgeDetectionMode()

virtual void AZ::Render::SMAAFeatureProcessorInterface::SetEdgeDetectionMode ( SMAAEdgeDetectionMode  mode)
pure virtual

Sets the edge detection mode.

Parameters
modeEdge detection mode.

Implemented in AZ::Render::SMAAFeatureProcessor.

◆ SetEnable()

virtual void AZ::Render::SMAAFeatureProcessorInterface::SetEnable ( bool  enable)
pure virtual

Enable/disable SMAA feature.

Parameters
enableFlag for SMAA feature.

Implemented in AZ::Render::SMAAFeatureProcessor.

◆ SetLocalContrastAdaptationFactor()

virtual void AZ::Render::SMAAFeatureProcessorInterface::SetLocalContrastAdaptationFactor ( float  factor)
pure virtual

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.

Implemented in AZ::Render::SMAAFeatureProcessor.

◆ SetMaxSearchSteps()

virtual void AZ::Render::SMAAFeatureProcessorInterface::SetMaxSearchSteps ( int  steps)
pure virtual

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.

Implemented in AZ::Render::SMAAFeatureProcessor.

◆ SetMaxSearchStepsDiagonal()

virtual void AZ::Render::SMAAFeatureProcessorInterface::SetMaxSearchStepsDiagonal ( int  steps)
pure virtual

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.

Implemented in AZ::Render::SMAAFeatureProcessor.

◆ SetOutputMode()

virtual void AZ::Render::SMAAFeatureProcessorInterface::SetOutputMode ( SMAAOutputMode  mode)
pure virtual

Sets the output mode.

Parameters
modeOutput mode.

Implemented in AZ::Render::SMAAFeatureProcessor.

◆ SetPredicationEnable()

virtual void AZ::Render::SMAAFeatureProcessorInterface::SetPredicationEnable ( bool  enable)
pure virtual

Enable/disable the predication feature.

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

Implemented in AZ::Render::SMAAFeatureProcessor.

◆ SetPredicationScale()

virtual void AZ::Render::SMAAFeatureProcessorInterface::SetPredicationScale ( float  scale)
pure virtual

Sets the predication scale value.

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

Implemented in AZ::Render::SMAAFeatureProcessor.

◆ SetPredicationStrength()

virtual void AZ::Render::SMAAFeatureProcessorInterface::SetPredicationStrength ( float  strength)
pure virtual

Sets the predication strength value.

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

Implemented in AZ::Render::SMAAFeatureProcessor.

◆ SetPredicationThreshold()

virtual void AZ::Render::SMAAFeatureProcessorInterface::SetPredicationThreshold ( float  threshold)
pure virtual

Sets the predication threshold value.

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

Implemented in AZ::Render::SMAAFeatureProcessor.

◆ SetQualityByPreset()

virtual void AZ::Render::SMAAFeatureProcessorInterface::SetQualityByPreset ( SMAAQualityPreset  preset)
pure virtual

Sets SMAA quality using preset parameters.

Parameters
presetPreset value for performance and quality of SMAA.

Implemented in AZ::Render::SMAAFeatureProcessor.


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