#include <ForwardRenderPass.h>

Inheritance diagram for ezForwardRenderPass:

[legend]

Public Member Functions
	ezForwardRenderPass (const char *szName="ForwardRenderPass")

virtual bool	GetRenderTargetDescriptions (const ezView &view, const ezArrayPtr< ezGALTextureCreationDescription *const > inputs, ezArrayPtr< ezGALTextureCreationDescription > outputs) override
	For a given input pin configuration, provide the output configuration of this node. Outputs is already resized to the number of output pins.

virtual void	Execute (const ezRenderViewContext &renderViewContext, const ezArrayPtr< ezRenderPipelinePassConnection const > inputs, const ezArrayPtr< ezRenderPipelinePassConnection const > outputs) override
	Render into outputs. Both inputs and outputs are passed in with actual texture handles. Disconnected pins have a nullptr value in the passed in arrays. You can now create views and render target setups on the fly and fill the output targets with data.

virtual ezResult	Serialize (ezStreamWriter &inout_stream) const override

virtual ezResult	Deserialize (ezStreamReader &inout_stream) override

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.

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

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

virtual void	InitRenderPipelinePass (const ezArrayPtr< ezRenderPipelinePassConnection const > inputs, const ezArrayPtr< ezRenderPipelinePassConnection const > outputs)
	After GetRenderTargetDescriptions was called successfully for each pass, this function is called with the inputs and outputs for review. Disconnected pins have a nullptr value in the passed in arrays. This is the time to create additional resources that are not covered by the pins automatically, e.g. a picking texture or eye adaptation buffer.

virtual void	ExecuteInactive (const ezRenderViewContext &renderViewContext, const ezArrayPtr< ezRenderPipelinePassConnection const > inputs, const ezArrayPtr< ezRenderPipelinePassConnection const > outputs)

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

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

EZ_ALWAYS_INLINE ezRenderPipeline *	GetPipeline ()

EZ_ALWAYS_INLINE const ezRenderPipeline *	GetPipeline () const

Public Member Functions inherited from ezRenderPipelineNode
void	InitializePins ()

ezHashedString	GetPinName (const ezRenderPipelineNodePin *pPin) const

const ezRenderPipelineNodePin *	GetPinByName (const char *szName) const

const ezRenderPipelineNodePin *	GetPinByName (ezHashedString 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
virtual void	SetupResources (ezGALCommandEncoder pCommandEncoder, const ezRenderViewContext &renderViewContext, const ezArrayPtr< ezRenderPipelinePassConnection const > inputs, const ezArrayPtr< ezRenderPipelinePassConnection *const > outputs)
	Binds input textures and sets up shader resources.

virtual void	SetupPermutationVars (const ezRenderViewContext &renderViewContext)
	Configures shader permutation variables based on render settings.

virtual void	SetupLighting (const ezRenderViewContext &renderViewContext)
	Binds lighting data for the current view.

virtual void	RenderObjects (const ezRenderViewContext &renderViewContext)=0
	Renders the objects for this pass. Must be implemented by derived classes.

Protected Attributes
ezRenderPipelineNodePassThroughPin	m_PinColor
	Color target for rendering.

ezRenderPipelineNodePassThroughPin	m_PinDepthStencil
	Depth-stencil target.

ezEnum< ezForwardRenderShadingQuality >	m_ShadingQuality
	Quality level for shading calculations.

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

Detailed Description

Base class for forward rendering passes.

Forward rendering evaluates lighting for each rendered object during the geometry pass. Derived classes implement specific object filtering (opaque, transparent, etc.).

Member Function Documentation

◆ Deserialize()

ezResult ezForwardRenderPass::Deserialize ( ezStreamReader & inout_stream )

overridevirtual

Reimplemented from ezRenderPipelinePass.

◆ Execute()

void ezForwardRenderPass::Execute	(	const ezRenderViewContext &	renderViewContext,
		const ezArrayPtr< ezRenderPipelinePassConnection *const >	inputs,
		const ezArrayPtr< ezRenderPipelinePassConnection *const >	outputs
	)

overridevirtual

Render into outputs. Both inputs and outputs are passed in with actual texture handles. Disconnected pins have a nullptr value in the passed in arrays. You can now create views and render target setups on the fly and fill the output targets with data.

Implements ezRenderPipelinePass.

Reimplemented in ezTransparentForwardRenderPass.

◆ GetRenderTargetDescriptions()

bool ezForwardRenderPass::GetRenderTargetDescriptions	(	const ezView &	view,
		const ezArrayPtr< ezGALTextureCreationDescription *const >	inputs,
		ezArrayPtr< ezGALTextureCreationDescription >	outputs
	)

overridevirtual

For a given input pin configuration, provide the output configuration of this node. Outputs is already resized to the number of output pins.

Implements ezRenderPipelinePass.

Reimplemented in ezOpaqueForwardRenderPass.

◆ RenderObjects()

virtual void ezForwardRenderPass::RenderObjects ( const ezRenderViewContext & renderViewContext )

protectedpure virtual

Renders the objects for this pass. Must be implemented by derived classes.

Implemented in ezOpaqueForwardRenderPass, ezSkyRenderPass, and ezTransparentForwardRenderPass.

◆ Serialize()

ezResult ezForwardRenderPass::Serialize ( ezStreamWriter & inout_stream ) const

overridevirtual

Reimplemented from ezRenderPipelinePass.

◆ SetupPermutationVars()

void ezForwardRenderPass::SetupPermutationVars ( const ezRenderViewContext & renderViewContext )

protectedvirtual

Configures shader permutation variables based on render settings.

Reimplemented in ezOpaqueForwardRenderPass.

◆ SetupResources()

void ezForwardRenderPass::SetupResources	(	ezGALCommandEncoder *	pCommandEncoder,
		const ezRenderViewContext &	renderViewContext,
		const ezArrayPtr< ezRenderPipelinePassConnection *const >	inputs,
		const ezArrayPtr< ezRenderPipelinePassConnection *const >	outputs
	)

protectedvirtual

Binds input textures and sets up shader resources.

Reimplemented in ezOpaqueForwardRenderPass, and ezTransparentForwardRenderPass.

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

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

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ Deserialize()

◆ Execute()

◆ GetRenderTargetDescriptions()

◆ RenderObjects()

◆ Serialize()

◆ SetupPermutationVars()

◆ SetupResources()