Utility to build pipeline states for RenderPipeline. More...

#include <Urho3D/RenderPipeline/PipelineStateBuilder.h>

Inheritance diagram for Urho3D::PipelineStateBuilder:

Public Member Functions
	PipelineStateBuilder (Context context, const SceneProcessor sceneProcessor, const CameraProcessor cameraProcessor, const ShadowMapAllocator shadowMapAllocator, const InstancingBuffer *instancingBuffer)

void	SetSettings (const ShaderProgramCompositorSettings &settings)

void	UpdateFrameSettings (bool linearColorSpace)

ShaderProgramCompositor *	GetShaderProgramCompositor () const


SharedPtr< PipelineState >	CreateBatchPipelineState (const BatchStateCreateKey &key, const BatchStateCreateContext &ctx, const PipelineStateOutputDesc &outputDesc) override

SharedPtr< PipelineState >	CreateBatchPipelineStatePlaceholder (unsigned vertexStride, const PipelineStateOutputDesc &outputDesc) override
	Create placeholder pipeline state when actual pipeline state creation fails.


void	SetupInputLayoutAndPrimitiveType (GraphicsPipelineStateDesc &pipelineStateDesc, const ShaderProgramDesc &shaderProgramDesc, const Geometry *geometry, bool isStereoPass) const

void	SetupShaders (GraphicsPipelineStateDesc &pipelineStateDesc, ShaderProgramDesc &shaderProgramDesc) const

Public Member Functions inherited from Urho3D::Object
	Object (Context *context)
	Construct.

	~Object () override
	Destruct. Clean up self from event sender & receiver structures.

virtual StringHash	GetType () const =0

virtual const ea::string &	GetTypeName () const =0

virtual const TypeInfo *	GetTypeInfo () const =0
	Return type info.

virtual bool	IsInstanceOf (StringHash type) const =0
	Check whether current instance implements specified type.

virtual void	OnEvent (Object *sender, StringHash eventType, VariantMap &eventData)
	Handle event.

virtual void	SerializeInBlock (Archive &archive)
	Serialize content from/to archive. May throw ArchiveException.

template<typename T >
bool	IsInstanceOf () const
	Check current instance is type of specified class.

template<typename T >
T *	Cast ()
	Cast the object to specified most derived class.

template<typename T >
const T *	Cast () const
	Cast the object to specified most derived class.

void	SubscribeToEventManual (StringHash eventType, EventHandler *handler)
	Subscribe to an event that can be sent by any sender.

void	SubscribeToEventManual (Object sender, StringHash eventType, EventHandler handler)
	Subscribe to a specific sender's event.

template<class T >
void	SubscribeToEvent (StringHash eventType, T handler)
	Subscribe to an event that can be sent by any sender.

template<class T >
void	SubscribeToEvent (Object *sender, StringHash eventType, T handler)
	Subscribe to a specific sender's event.

void	UnsubscribeFromEvent (StringHash eventType)
	Unsubscribe from an event.

void	UnsubscribeFromEvent (Object *sender, StringHash eventType)
	Unsubscribe from a specific sender's event.

void	UnsubscribeFromEvents (Object *sender)
	Unsubscribe from a specific sender's events.

void	UnsubscribeFromAllEvents ()
	Unsubscribe from all events.

void	UnsubscribeFromAllEventsExcept (const ea::vector< StringHash > &exceptions)
	Unsubscribe from all events except those listed.

void	UnsubscribeFromAllEventsExcept (const ea::vector< Object * > &exceptions)
	Unsubscribe from all events except those with listed senders.

void	SendEvent (StringHash eventType)
	Send event to all subscribers.

void	SendEvent (StringHash eventType, VariantMap &eventData)
	Send event with parameters to all subscribers.

VariantMap &	GetEventDataMap () const
	Return a preallocated map for event data. Used for optimization to avoid constant re-allocation of event data maps.

template<typename... Args>
void	SendEvent (StringHash eventType, const Args &... args)
	Send event with variadic parameter pairs to all subscribers. The parameters are (paramID, paramValue) pairs.

Context *	GetContext () const
	Return execution context.

const Variant &	GetGlobalVar (StringHash key) const

const VariantMap &	GetGlobalVars () const

void	SetGlobalVar (StringHash key, const Variant &value)

Object *	GetSubsystem (StringHash type) const
	Return subsystem by type.

Object *	GetEventSender () const
	Return active event sender. Null outside event handling.

EventHandler *	GetEventHandler () const
	Return active event handler. Null outside event handling.

bool	HasSubscribedToEvent (StringHash eventType) const
	Return whether has subscribed to an event without specific sender.

bool	HasSubscribedToEvent (Object *sender, StringHash eventType) const
	Return whether has subscribed to a specific sender's event.

bool	HasEventHandlers () const
	Return whether has subscribed to any event.

template<class T >
T *	GetSubsystem () const
	Template version of returning a subsystem.

const ea::string &	GetCategory () const

void	SendEvent (StringHash eventType, const VariantMap &eventData)
	Send event with parameters to all subscribers.

void	SetBlockEvents (bool block)
	Block object from sending and receiving events.

bool	GetBlockEvents () const
	Return sending and receiving events blocking status.

Public Member Functions inherited from Urho3D::RefCounted
	RefCounted ()
	Construct. Allocate the reference count structure and set an initial self weak reference.

virtual	~RefCounted ()
	Destruct. Mark as expired and also delete the reference count structure if no outside weak references exist.

	RefCounted (const RefCounted &rhs)=delete
	Prevent copy construction.

RefCounted &	operator= (const RefCounted &rhs)=delete
	Prevent assignment.

int	AddRef ()

int	ReleaseRef ()

int	Refs () const

int	WeakRefs () const

RefCount *	RefCountPtr () const
	Return pointer to the reference count structure.

bool	HasScriptObject () const
	Return true if script runtime object wrapping this native object exists.

bool	IsScriptStrongRef () const
	Return true if script reference is strong.

Public Member Functions inherited from Urho3D::BatchStateCacheCallback
virtual	~BatchStateCacheCallback ()
	Destruct.

Private Member Functions
	URHO3D_OBJECT (PipelineStateBuilder, Object)


void	ClearState ()

void	SetupUserPassState (const Drawable drawable, const Material material, const Pass *pass, bool lightMaskToStencil)

void	SetupLightVolumePassState (const LightProcessor *lightProcessor)

void	SetupShadowPassState (unsigned splitIndex, const LightProcessor lightProcessor, const Material material, const Pass *pass)

void	SetupLightSamplers (const LightProcessor *lightProcessor)

void	SetupSamplersForUserOrShadowPass (const Material *material, bool hasLightmap, bool hasAmbient, bool isRefractionPass)

void	SetupGeometryBufferSamplers ()

Private Attributes
Graphics *	graphics_ {}

RenderDevice *	renderDevice_ {}

PipelineStateCache *	pipelineStateCache_ {}

SharedPtr< ShaderProgramCompositor >	compositor_


const SceneProcessor *const	sceneProcessor_ {}

const CameraProcessor *	cameraProcessor_ {}

const ShadowMapAllocator *const	shadowMapAllocator_ {}

const InstancingBuffer *const	instancingBuffer_ {}


GraphicsPipelineStateDesc	pipelineStateDesc_

ShaderProgramDesc	shaderProgramDesc_

Additional Inherited Members
Static Public Member Functions inherited from Urho3D::Object
static const TypeInfo *	GetTypeInfoStatic ()
	Return type info static.

Static Public Attributes inherited from Urho3D::Object
static constexpr ea::array< StringHash, 0 >	TypeHierarchy {}

Protected Attributes inherited from Urho3D::Object
WeakPtr< Context >	context_
	Execution context.

Detailed Description

Utility to build pipeline states for RenderPipeline.

Member Function Documentation

◆ ClearState()

void Urho3D::PipelineStateBuilder::ClearState ( )

private

State builder

◆ CreateBatchPipelineState()

SharedPtr< PipelineState > Urho3D::PipelineStateBuilder::CreateBatchPipelineState	(	const BatchStateCreateKey &	key,
		const BatchStateCreateContext &	ctx,
		const PipelineStateOutputDesc &	outputDesc
	)

overridevirtual

Implement BatchStateCacheCallback

Implements Urho3D::BatchStateCacheCallback.

◆ SetupInputLayoutAndPrimitiveType()

void Urho3D::PipelineStateBuilder::SetupInputLayoutAndPrimitiveType	(	GraphicsPipelineStateDesc &	pipelineStateDesc,
		const ShaderProgramDesc &	shaderProgramDesc,
		const Geometry *	geometry,
		bool	isStereoPass
	)		const

Helpers for passes that override pipeline state creation.

Member Data Documentation

◆ pipelineStateDesc_

GraphicsPipelineStateDesc Urho3D::PipelineStateBuilder::pipelineStateDesc_

private

Re-used objects

◆ sceneProcessor_

const SceneProcessor* const Urho3D::PipelineStateBuilder::sceneProcessor_ {}

private

Objects whose settings contribute to pipeline states. Pipeline states should be invalidated if any of those changes.

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

Urho3D/RenderPipeline/PipelineStateBuilder.h
Urho3D/RenderPipeline/PipelineStateBuilder.cpp

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ ClearState()

◆ CreateBatchPipelineState()

◆ SetupInputLayoutAndPrimitiveType()

Member Data Documentation

◆ pipelineStateDesc_

◆ sceneProcessor_