Material technique. Consists of several passes. More...

#include <Urho3D/Graphics/Technique.h>

Inheritance diagram for Urho3D::Technique:

Public Member Functions
	Technique (Context *context)
	Construct.

	~Technique () override
	Destruct.

bool	BeginLoad (Deserializer &source) override
	Load resource from stream. May be called from a worker thread. Return true if successful.

Pass *	CreatePass (const ea::string &name)
	Create a new pass.

void	RemovePass (const ea::string &name)
	Remove a pass.

void	ReleaseShaders ()
	Reset shader pointers in all passes.

SharedPtr< Technique >	Clone (const ea::string &cloneName=EMPTY_STRING) const
	Clone the technique. Passes will be deep copied to allow independent modification.

bool	HasPass (unsigned passIndex) const
	Return whether has a pass.

bool	HasPass (const ea::string &name) const
	Return whether has a pass by name. This overload should not be called in time-critical rendering loops; use a pre-acquired pass index instead.

Pass *	GetPass (unsigned passIndex) const
	Return a pass, or null if not found.

Pass *	GetPass (const ea::string &name) const
	Return a pass by name, or null if not found. This overload should not be called in time-critical rendering loops; use a pre-acquired pass index instead.

unsigned	GetNumPasses () const

ea::vector< ea::string >	GetPassNames () const

ea::vector< Pass * >	GetPasses () const

SharedPtr< Technique >	CloneWithDefines (const ea::string &vsDefines, const ea::string &psDefines)
	Return a clone with added shader compilation defines. Called internally by Material.

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

bool	Load (Deserializer &source)
	Load resource synchronously. Call both BeginLoad() & EndLoad() and return true if both succeeded.

virtual bool	EndLoad ()
	Finish resource loading. Always called from the main thread. Return true if successful.

virtual bool	Save (Serializer &dest) const
	Save resource. Return true if successful.

bool	LoadFile (const FileIdentifier &fileName)
	Load resource from file.

virtual bool	SaveFile (const FileIdentifier &fileName) const
	Save resource to file.

void	SetName (const ea::string &name)

void	SetMemoryUse (unsigned size)
	Set memory use in bytes, possibly approximate.

void	ResetUseTimer ()
	Reset last used timer.

void	SetAsyncLoadState (AsyncLoadState newState)
	Set the asynchronous loading state. Called by ResourceCache. Resources in the middle of asynchronous loading are not normally returned to user.

void	SetAbsoluteFileName (const ea::string &fileName)
	Set absolute file name.

const ea::string &	GetName () const

StringHash	GetNameHash () const
	Return name hash.

unsigned	GetMemoryUse () const

unsigned	GetUseTimer ()

AsyncLoadState	GetAsyncLoadState () const
	Return the asynchronous loading state.

const ea::string &	GetAbsoluteFileName () const
	Return absolute file name.

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.

Static Public Member Functions
static void	RegisterObject (Context *context)

static unsigned	GetPassIndex (const ea::string &passName)
	Return a pass type index by name. Allocate new if not used yet.

Static Public Member Functions inherited from Urho3D::Resource
static Resource *	LoadFromCache (Context *context, StringHash type, const ea::string &name)
	Load resource by reference.

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

Static Public Attributes
static unsigned	basePassIndex = 0
	Index for base pass. Initialized once GetPassIndex() has been called for the first time.

static unsigned	alphaPassIndex = 0
	Index for alpha pass. Initialized once GetPassIndex() has been called for the first time.

static unsigned	materialPassIndex = 0
	Index for prepass material pass. Initialized once GetPassIndex() has been called for the first time.

static unsigned	deferredPassIndex = 0
	Index for deferred G-buffer pass. Initialized once GetPassIndex() has been called for the first time.

static unsigned	lightPassIndex = 0
	Index for per-pixel light pass. Initialized once GetPassIndex() has been called for the first time.

static unsigned	litBasePassIndex = 0
	Index for lit base pass. Initialized once GetPassIndex() has been called for the first time.

static unsigned	litAlphaPassIndex = 0
	Index for lit alpha pass. Initialized once GetPassIndex() has been called for the first time.

static unsigned	shadowPassIndex = 0
	Index for shadow pass. Initialized once GetPassIndex() has been called for the first time.

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

Private Member Functions
	URHO3D_OBJECT (Technique, Resource)

Private Attributes
ea::vector< SharedPtr< Pass > >	passes_
	Passes.

ea::unordered_map< ea::pair< StringHash, StringHash >, SharedPtr< Technique > >	cloneTechniques_
	Cached clones with added shader compilation defines.

Static Private Attributes
static ea::unordered_map< ea::string, unsigned >	passIndices
	Pass index assignments.

Friends
class	Renderer

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

Detailed Description

Material technique. Consists of several passes.

Member Function Documentation

◆ GetNumPasses()

unsigned Urho3D::Technique::GetNumPasses ( ) const

Return number of passes.

◆ GetPasses()

ea::vector< Pass * > Urho3D::Technique::GetPasses ( ) const

Return all passes.

◆ GetPassNames()

ea::vector< ea::string > Urho3D::Technique::GetPassNames ( ) const

Return all pass names.

◆ RegisterObject()

void Urho3D::Technique::RegisterObject ( Context * context )

static

Register object factory.

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

Urho3D/Graphics/Technique.h
Urho3D/Graphics/Technique.cpp

Public Member Functions

Static Public Member Functions

Static Public Attributes

Private Member Functions

Private Attributes

Static Private Attributes