Batch compositor for single scene pass. More...

#include <Urho3D/RenderPipeline/BatchCompositor.h>

Inheritance diagram for Urho3D::BatchCompositorPass:

Public Member Functions
	BatchCompositorPass (RenderPipelineInterface renderPipeline, DrawableProcessor drawableProcessor, BatchStateCacheCallback *callback, DrawableProcessorPassFlags flags, unsigned deferredPassIndex, unsigned unlitBasePassIndex, unsigned litBasePassIndex, unsigned lightPassIndex)

virtual bool	CreatePipelineState (GraphicsPipelineStateDesc &desc, PipelineStateBuilder *builder, const BatchStateCreateKey &key, const BatchStateCreateContext &ctx)
	Callback for pipeline state initialization.

void	SetForwardOutputDesc (const PipelineStateOutputDesc &desc)

void	SetDeferredOutputDesc (const PipelineStateOutputDesc &desc)

void	ComposeBatches ()

bool	HasBatches () const

Public Member Functions inherited from Urho3D::DrawableProcessorPass
	DrawableProcessorPass (RenderPipelineInterface *renderPipeline, DrawableProcessorPassFlags flags, unsigned deferredPassIndex, unsigned unlitBasePassIndex, unsigned litBasePassIndex, unsigned lightPassIndex)

void	SetEnabled (bool enabled)

bool	IsEnabled () const

virtual AddBatchResult	AddCustomBatch (unsigned threadIndex, Drawable drawable, unsigned sourceBatchIndex, Technique technique)
	Custom callback for adding batches.

AddBatchResult	AddBatch (unsigned threadIndex, Drawable drawable, unsigned sourceBatchIndex, Technique technique)

DrawableProcessorPassFlags	GetFlags () const

bool	IsFlagSet (DrawableProcessorPassFlags flag) const

bool	HasLightPass () 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.

Protected Member Functions
virtual void	OnBatchesReady ()
	Called when batches are ready.


void	OnUpdateBegin (const CommonFrameInfo &frameInfo) override

virtual void	OnPipelineStatesInvalidated ()

Protected Attributes
WorkQueueVector< PipelineBatch >	deferredBatches_

WorkQueueVector< PipelineBatch >	baseBatches_

WorkQueueVector< PipelineBatch >	lightBatches_

WorkQueueVector< PipelineBatch >	negativeLightBatches_


WorkQueue *	workQueue_ {}

Material *	defaultMaterial_ {}

DrawableProcessor *	drawableProcessor_ {}

BatchStateCacheCallback *	batchStateCacheCallback_ {}

Protected Attributes inherited from Urho3D::DrawableProcessorPass
RenderPipelineInterface *const	renderPipeline_ {}

WorkQueueVector< GeometryBatch >	geometryBatches_

bool	linearColorSpace_ {}

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

Private Member Functions
	URHO3D_OBJECT (BatchCompositorPass, DrawableProcessorPass)

bool	PreparePipelineBatch (PipelineBatchDesc &key, const GeometryBatch &geometryBatch) const

void	ProcessGeometryBatch (const GeometryBatch &geometryBatch)

void	ResolveDelayedBatches (BatchCompositorSubpass subpass, const WorkQueueVector< PipelineBatchDesc > &delayedBatches, BatchStateCache &cache, WorkQueueVector< PipelineBatch > &batches)

void	AddPipelineBatch (const PipelineBatchDesc &desc, BatchStateCache &cache, WorkQueueVector< PipelineBatch > &batches, WorkQueueVector< PipelineBatchDesc > &delayedBatches)

PipelineState *	GetPlaceholderPipelineState (BatchStateCache &cache, PipelineState *original)

Private Attributes

BatchStateCache	deferredCache_

BatchStateCache	unlitBaseCache_

BatchStateCache	litBaseCache_

BatchStateCache	lightCache_


WorkQueueVector< PipelineBatchDesc >	delayedDeferredBatches_

WorkQueueVector< PipelineBatchDesc >	delayedUnlitBaseBatches_

WorkQueueVector< PipelineBatchDesc >	delayedLitBaseBatches_

WorkQueueVector< PipelineBatchDesc >	delayedLightBatches_

WorkQueueVector< PipelineBatchDesc >	delayedNegativeLightBatches_

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 {}

Detailed Description

Batch compositor for single scene pass.

Member Function Documentation

◆ OnUpdateBegin()

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

overrideprotectedvirtual

Callbacks from RenderPipeline

Reimplemented from Urho3D::DrawableProcessorPass.

Member Data Documentation

◆ deferredCache_

BatchStateCache Urho3D::BatchCompositorPass::deferredCache_

private

Pipeline state caches

◆ delayedDeferredBatches_

WorkQueueVector<PipelineBatchDesc> Urho3D::BatchCompositorPass::delayedDeferredBatches_

private

Batches whose processing is delayed due to missing pipeline state

◆ workQueue_

WorkQueue* Urho3D::BatchCompositorPass::workQueue_ {}

protected

External dependencies

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

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

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes