Batch composition manager. More...

#include <Urho3D/RenderPipeline/BatchCompositor.h>

Inheritance diagram for Urho3D::BatchCompositor:

Public Types
enum	: unsigned { ShadowSubpass = 0, LitVolumeSubpass }
	Subpass indices.

Public Member Functions
	BatchCompositor (RenderPipelineInterface renderPipeline, const DrawableProcessor drawableProcessor, BatchStateCacheCallback *callback, unsigned shadowPassIndex)

void	SetPasses (ea::vector< SharedPtr< BatchCompositorPass >> passes)

void	SetShadowMaterialQuality (MaterialQuality materialQuality)

void	SetShadowOutputDesc (const PipelineStateOutputDesc &desc)

void	SetLightVolumesOutputDesc (const PipelineStateOutputDesc &desc)

const auto &	GetLightVolumeBatches () const
	Return sorted light volume batches.


void	ComposeShadowBatches ()

void	ComposeSceneBatches ()

void	ComposeLightVolumeBatches ()

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 void	OnEvent (Object *sender, StringHash eventType, VariantMap &eventData)
	Handle event.

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

bool	IsInstanceOf (StringHash type) const
	Check current instance is type of specified type.

bool	IsInstanceOf (const TypeInfo *typeInfo) const
	Check current instance is type of specified type.

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.

Static Public Member Functions
template<class T , class ... U>
static void	FillSortKeys (ea::vector< T > &sortedBatches, const U &... pipelineBatches)
	Prepare vector of sorted batches w/o actual sorting.

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

Protected Member Functions
void	BeginShadowBatchesComposition (unsigned lightIndex, ShadowSplitProcessor *splitProcessor)
	Safe to call from worker thread.

void	FinalizeShadowBatchesComposition ()
	Should be called from main thread.


virtual void	OnUpdateBegin (const CommonFrameInfo &frameInfo)

virtual void	OnPipelineStatesInvalidated ()

Private Member Functions
	URHO3D_OBJECT (BatchCompositor, Object)

Private Attributes
const unsigned	shadowPassIndex_

WorkQueueVector< ea::pair< ShadowSplitProcessor *, PipelineBatchDesc > >	delayedShadowBatches_

ea::vector< PipelineBatch >	lightVolumeBatches_

ea::vector< PipelineBatchByState >	sortedLightVolumeBatches_


WorkQueue *	workQueue_ {}

Renderer *	renderer_ {}

const DrawableProcessor *	drawableProcessor_ {}

Material *	defaultMaterial_ {}

BatchStateCacheCallback *	batchStateCacheCallback_ {}


ea::vector< SharedPtr< BatchCompositorPass > >	allPasses_

ea::vector< BatchCompositorPass * >	passes_

MaterialQuality	shadowMaterialQuality_ {}

SharedPtr< Material >	lightVolumeMaterial_

SharedPtr< Material >	negativeLightVolumeMaterial_

SharedPtr< Pass >	lightVolumePass_

BatchStateCache	shadowCache_

BatchStateCache	lightVolumeCache_

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

Detailed Description

Batch composition manager.

Member Function Documentation

◆ ComposeShadowBatches()

void Urho3D::BatchCompositor::ComposeShadowBatches ( )

Compose batches

◆ OnUpdateBegin()

void Urho3D::BatchCompositor::OnUpdateBegin ( const CommonFrameInfo & frameInfo )

protectedvirtual

Callbacks from RenderPipeline

Member Data Documentation

◆ allPasses_

ea::vector<SharedPtr<BatchCompositorPass> > Urho3D::BatchCompositor::allPasses_

private

Cached between frames

◆ workQueue_

WorkQueue* Urho3D::BatchCompositor::workQueue_ {}

private

External dependencies

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

Urho3D/RenderPipeline/BatchCompositor.h
Urho3D/RenderPipeline/BatchCompositor.cpp

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes