Open 3D Engine AtomLyIntegration 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::EditorModeOutlinePass Class Reference

Pass for editor mode feedback outline effect. More...

#include <EditorModeOutlinePass.h>

Inherits AZ::Render::EditorModeFeedbackChildPassBase.

Public Types

enum class  OutlineStyle : AZ::u32 { Always , Visible }
 The outline syles supported by the outline effect. More...
 

Public Member Functions

 AZ_RTTI (EditorModeOutlinePass, "{5DEBA4FC-6BB3-417B-B052-7CB87EF15F84}", EditorModeFeedbackChildPassBase)
 
 AZ_CLASS_ALLOCATOR (EditorModeOutlinePass, SystemAllocator)
 
void SetLineThickness (float thickness)
 Sets the outline line thickness.
 
void SetLineColor (AZ::Color color)
 Sets the outline line color.
 
void SetOutlineStyle (OutlineStyle mode)
 Sets the outline mode.
 
- Public Member Functions inherited from AZ::Render::EditorModeFeedbackChildPassBase
 AZ_RTTI (EditorModeFeedbackChildPassBase, "{F1F345E3-1396-47F7-9CA4-9AC87A2E9829}", AZ::RPI::FullscreenTrianglePass)
 
 AZ_CLASS_ALLOCATOR (EditorModeFeedbackChildPassBase, SystemAllocator)
 
void SetMinDepthTransitionValue (float minValue)
 Sets the minimum blend amount that will be calculated through depth transitioning.
 
void SetDepthTransitionStart (float start)
 Sets the start of depth transtion for non-mask effect blending.
 
void SetDepthTransitionDuration (float duration)
 Sets the duration (depth) of the depth transition band (0.0 = no depth transitioning will be applied).
 
void SetFinalBlendAmount (float amount)
 Sets the final blend amount that is used to scale the calculated blend values.
 

Static Public Member Functions

static RPI::Ptr< EditorModeOutlinePassCreate (const RPI::PassDescriptor &descriptor)
 Creates a EditorModeOutlinePass.
 
- Static Public Member Functions inherited from AZ::Render::EditorModeFeedbackChildPassBase
static RPI::Ptr< EditorModeFeedbackChildPassBaseCreate (const RPI::PassDescriptor &descriptor)
 Creates a EditorModeFeedbackPassBase.
 

Protected Member Functions

 EditorModeOutlinePass (const RPI::PassDescriptor &descriptor)
 
- Protected Member Functions inherited from AZ::Render::EditorModeFeedbackChildPassBase
 EditorModeFeedbackChildPassBase (const RPI::PassDescriptor &descriptor, const DepthTransition &depthTransition, float finalBlendAmount)
 

Detailed Description

Pass for editor mode feedback outline effect.

Member Enumeration Documentation

◆ OutlineStyle

The outline syles supported by the outline effect.

Enumerator
Always 

Outlines both visible and occluded fragments of the entitites of interest.

Visible 

Outlines only the visible fragments of the entitites of interest.


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