#include <LightShaftsPass.h>

Inheritance diagram for ezLightShaftsPass:

[legend]

Public Member Functions
virtual ezStatus	AddRenderPasses (const ezViewData &viewData, const ezCamera &camera, ezRenderGraph &ref_graph, const ezArrayPtr< const ezRenderPipelinePinConnection > inputs, ezArrayPtr< ezRenderPipelinePinConnection > outputs) override
	Called by the render pipeline when this pass is active. The pass declares its render-graph passes and writes the resulting transient handles into the `outputs` array.

virtual ezResult	Serialize (ezStreamWriter &inout_stream) const override

virtual ezResult	Deserialize (ezStreamReader &inout_stream) override

void	SetDownsampleFactor (ezUInt32 uiFactor)

ezUInt32	GetDownsampleFactor () const

void	SetNumBlurPasses (ezUInt32 uiPasses)

ezUInt32	GetNumBlurPasses () const

void	SetNumSamples (ezUInt32 uiSamples)

ezUInt32	GetNumSamples () const

void	SetMaxBlurDistance (float fDistance)

float	GetMaxBlurDistance () const

Public Member Functions inherited from ezRenderPipelinePass
	ezRenderPipelinePass (const char *szName, bool bIsStereoAware=false)

void	SetName (const char *szName)
	Sets the name of the pass.

const char *	GetName () const
	returns the name of the pass.

EZ_ALWAYS_INLINE bool	IsStereoAware () const
	True if the render pipeline pass can handle stereo cameras correctly.

virtual void	ReadBackProperties (ezView *pView)
	Allows for the pass to write data back using ezView::SetRenderPassReadBackProperty. E.g. picking results etc.

void	DeclareRendererDependenciesForCategory (ezRenderData::Category category, ezRenderGraph &ref_graph, ezRenderGraphPassBuilder &ref_passBuilder)

void	RenderDataWithCategory (const ezRenderViewContext &renderViewContext, ezRenderData::Category category)

EZ_ALWAYS_INLINE ezRenderPipeline *	GetPipeline ()

EZ_ALWAYS_INLINE const ezRenderPipeline *	GetPipeline () const

virtual ezStatus	AddRenderPassesInactive (const ezViewData &viewData, const ezCamera &camera, ezRenderGraph &ref_graph, const ezArrayPtr< const ezRenderPipelinePinConnection > inputs, ezArrayPtr< ezRenderPipelinePinConnection > outputs)
	Called by the render pipeline when this pass is inactive instead of AddRenderPasses. The default implementation does nothing; passes that produce outputs must override this and at minimum write the same output handles they would in AddRenderPasses (typically by adding a clear pass) so downstream passes still see a valid resource.

virtual ezGALTextureHandle	QueryTextureProvider (const ezRenderPipelineNodePin *pPin, const ezGALTextureCreationDescription &desc)

Public Member Functions inherited from ezRenderPipelineNode
void	InitializePins ()

ezHashedString	GetPinName (const ezRenderPipelineNodePin *pPin) const

const ezRenderPipelineNodePin *	GetPinByName (ezTempHashedString sName) const

const ezArrayPtr< const ezRenderPipelineNodePin *const >	GetInputPins () const

const ezArrayPtr< const ezRenderPipelineNodePin *const >	GetOutputPins () const

Public Member Functions inherited from ezReflectedClass
virtual const ezRTTI *	GetDynamicRTTI () const

bool	IsInstanceOf (const ezRTTI *pType) const
	Returns whether the type of this instance is of the given type or derived from it.

template<typename T >
EZ_ALWAYS_INLINE bool	IsInstanceOf () const
	Returns whether the type of this instance is of the given type or derived from it.

Protected Member Functions
ezVec4	CalculateOriginUVs (const ezVec3 &vLightDirection, const ezViewData &viewData, const ezCamera &camera) const

void	UpdateConstantBuffer (const ezClusteredDataCPU &clusteredData, const ezVec2 &vLightOriginUVs, float fBlurStep)

Protected Member Functions inherited from ezRenderPipelinePass
void	SetReadBackProperty (ezView *pView, ezStringView sPropertyName, const ezVariant &value)

Protected Attributes
ezRenderPipelineNodePassThroughPin	m_PinColor

ezRenderPipelineNodeInputPin	m_PinDepthInput

ezConstantBufferStorageHandle	m_hConstantBuffer

ezShaderResourceHandle	m_hMaskShader

ezShaderResourceHandle	m_hRadialBlurShader

ezShaderResourceHandle	m_hApplyShader

ezEnum< ezGALResourceFormat >	m_TextureFormat

ezUInt8	m_uiDownsampleFactor = 3

ezUInt8	m_uiNumBlurPasses = 3

ezUInt8	m_uiNumSamples = 12

float	m_fMaxBlurDistance = 1.0f

Additional Inherited Members
Static Public Member Functions inherited from ezNoBase
static const ezRTTI *	GetStaticRTTI ()

Detailed Description

Screen-space light shafts (crepuscular rays) post-processing pass.

Generates volumetric light shaft effects from the brightest directional light by building a mask from the depth buffer and applying a radial blur toward the projected light position. The result is additively composited into the scene color.

Member Function Documentation

◆ AddRenderPasses()

ezStatus ezLightShaftsPass::AddRenderPasses	(	const ezViewData &	viewData,
		const ezCamera &	camera,
		ezRenderGraph &	ref_graph,
		const ezArrayPtr< const ezRenderPipelinePinConnection >	inputs,
		ezArrayPtr< ezRenderPipelinePinConnection >	outputs
	)

overridevirtual

Called by the render pipeline when this pass is active. The pass declares its render-graph passes and writes the resulting transient handles into the outputs array.

Reimplemented from ezRenderPipelinePass.

◆ Deserialize()

ezResult ezLightShaftsPass::Deserialize ( ezStreamReader & inout_stream )

overridevirtual

Reimplemented from ezRenderPipelinePass.

◆ Serialize()

ezResult ezLightShaftsPass::Serialize ( ezStreamWriter & inout_stream ) const

overridevirtual

Reimplemented from ezRenderPipelinePass.

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

/home/runner/work/ezEngine/ezEngine/Code/Engine/RendererCore/Pipeline/Passes/LightShaftsPass.h
/home/runner/work/ezEngine/ezEngine/Code/Engine/RendererCore/Pipeline/Implementation/Passes/LightShaftsPass.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ AddRenderPasses()

◆ Deserialize()

◆ Serialize()