Generates shader program descritpions for scene and light volume batches. More...

#include <Urho3D/RenderPipeline/ShaderProgramCompositor.h>

Inheritance diagram for Urho3D::ShaderProgramCompositor:

Public Member Functions
	ShaderProgramCompositor (Context *context)

void	SetSettings (const ShaderProgramCompositorSettings &settings)

void	SetFrameSettings (const CameraProcessor *cameraProcessor, bool linearColorSpace)


void	ProcessUserBatch (ShaderProgramDesc &result, const DrawableProcessorPassFlags flags, Drawable drawable, Geometry geometry, GeometryType geometryType, Material material, Pass pass, Light *light, bool hasShadow, BatchCompositorSubpass subpass)

void	ProcessShadowBatch (ShaderProgramDesc &result, Geometry geometry, GeometryType geometryType, Material material, Pass pass, Light light)

void	ProcessLightVolumeBatch (ShaderProgramDesc &result, Geometry geometry, GeometryType geometryType, Pass pass, Light *light, bool hasShadow)

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.

Private Member Functions
	URHO3D_OBJECT (ShaderProgramCompositor, Object)

bool	IsInstancingUsed (DrawableProcessorPassFlags flags, Geometry *geometry, GeometryType geometryType) const

ea::pair< bool, bool >	IsNormalAndTangentAvailable (GeometryType geometryType, VertexBuffer *vertexBuffer) const


void	SetupShaders (ShaderProgramDesc &result, Pass *pass)

void	ApplyCommonDefines (ShaderProgramDesc &result, DrawableProcessorPassFlags flags, Pass *pass) const

void	ApplyGeometryVertexDefines (ShaderProgramDesc &result, DrawableProcessorPassFlags flags, Geometry *geometry, GeometryType geometryType) const

void	ApplyPixelLightPixelAndCommonDefines (ShaderProgramDesc &result, Light *light, bool hasShadow, bool materialHasSpecular) const

void	ApplyNormalTangentSpaceDefines (ShaderProgramDesc &result, GeometryType geometryType, VertexBuffer *vertexBuffer) const


void	ApplyLayoutVertexAndCommonDefinesForUserPass (ShaderProgramDesc &result, VertexBuffer *vertexBuffer) const

void	ApplyMaterialPixelDefinesForUserPass (ShaderProgramDesc &result, Material material, Pass pass) const

void	ApplyAmbientLightingVertexAndCommonDefinesForUserPass (ShaderProgramDesc &result, Drawable *drawable, bool isGeometryBufferPass) const


void	ApplyDefinesForShadowPass (ShaderProgramDesc &result, Light light, VertexBuffer vertexBuffer, Material material, Pass pass) const

void	ApplyDefinesForLightVolumePass (ShaderProgramDesc &result) const

Private Attributes

ShaderProgramCompositorSettings	settings_

bool	isCameraOrthographic_ {}

bool	isCameraClipped_ {}

bool	isCameraReversed_ {}

bool	linearColorSpace_ {}

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

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

Detailed Description

Generates shader program descritpions for scene and light volume batches.

Member Function Documentation

◆ ApplyDefinesForShadowPass()

void Urho3D::ShaderProgramCompositor::ApplyDefinesForShadowPass	(	ShaderProgramDesc &	result,
		Light *	light,
		VertexBuffer *	vertexBuffer,
		Material *	material,
		Pass *	pass
	)		const

private

Apply internal pass defines

◆ ApplyLayoutVertexAndCommonDefinesForUserPass()

void Urho3D::ShaderProgramCompositor::ApplyLayoutVertexAndCommonDefinesForUserPass	(	ShaderProgramDesc &	result,
		VertexBuffer *	vertexBuffer
	)		const

private

Apply user pass defines

◆ ProcessUserBatch()

void Urho3D::ShaderProgramCompositor::ProcessUserBatch	(	ShaderProgramDesc &	result,
		const DrawableProcessorPassFlags	flags,
		Drawable *	drawable,
		Geometry *	geometry,
		GeometryType	geometryType,
		Material *	material,
		Pass *	pass,
		Light *	light,
		bool	hasShadow,
		BatchCompositorSubpass	subpass
	)

Process batches

◆ SetupShaders()

void Urho3D::ShaderProgramCompositor::SetupShaders	(	ShaderProgramDesc &	result,
		Pass *	pass
	)

private

Apply common defines

Member Data Documentation

◆ settings_

ShaderProgramCompositorSettings Urho3D::ShaderProgramCompositor::settings_

private

External configuration

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

Urho3D/RenderPipeline/ShaderProgramCompositor.h
Urho3D/RenderPipeline/ShaderProgramCompositor.cpp

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ ApplyDefinesForShadowPass()

◆ ApplyLayoutVertexAndCommonDefinesForUserPass()

◆ ProcessUserBatch()

◆ SetupShaders()

Member Data Documentation

◆ settings_