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

#include <Urho3D/Graphics/Technique.h>

Inheritance diagram for Urho3D::Technique:
[legend]
Collaboration diagram for Urho3D::Technique:
[legend]

Public Member Functions

 Technique (Context *context)
 Construct.
 
virtual ~Technique () override
 Destruct.
 
virtual bool BeginLoad (Deserializer &source) override
 Load resource from stream. May be called from a worker thread. Return true if successful.
 
void SetIsDesktop (bool enable)
 Set whether requires desktop level hardware.
 
PassCreatePass (const String &passName)
 Create a new pass.
 
void RemovePass (const String &passName)
 Remove a pass.
 
void ReleaseShaders ()
 Reset shader pointers in all passes.
 
SharedPtr< TechniqueClone (const String &cloneName=String::EMPTY) const
 Clone the technique. Passes will be deep copied to allow independent modification.
 
bool IsDesktop () const
 Return whether requires desktop level hardware.
 
bool IsSupported () const
 Return whether technique is supported by the current hardware.
 
bool HasPass (unsigned passIndex) const
 Return whether has a pass.
 
bool HasPass (const String &passName) 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.
 
PassGetPass (unsigned passIndex) const
 Return a pass, or null if not found.
 
PassGetPass (const String &passName) 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.
 
PassGetSupportedPass (unsigned passIndex) const
 Return a pass that is supported for rendering, or null if not found.
 
PassGetSupportedPass (const String &passName) const
 Return a supported pass by name. This overload should not be called in time-critical rendering loops; use a pre-acquired pass index instead.
 
unsigned GetNumPasses () const
 Return number of passes.
 
Vector< StringGetPassNames () const
 Return all pass names.
 
PODVector< Pass * > GetPasses () const
 Return all passes.
 
SharedPtr< TechniqueCloneWithDefines (const String &vsDefines, const 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 String &fileName)
 Load resource from file.
 
virtual bool SaveFile (const String &fileName) const
 Save resource to file.
 
void SetName (const String &name)
 Set 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.
 
const StringGetName () const
 Return name.
 
StringHash GetNameHash () const
 Return name hash.
 
unsigned GetMemoryUse () const
 Return memory use in bytes, possibly approximate.
 
unsigned GetUseTimer ()
 Return time since last use in milliseconds. If referred to elsewhere than in the resource cache, returns always zero.
 
AsyncLoadState GetAsyncLoadState () const
 Return the asynchronous loading state.
 
- Public Member Functions inherited from Urho3D::Object
 Object (Context *context)
 Construct.
 
virtual ~Object () override
 Destruct. Clean up self from event sender & receiver structures.
 
virtual StringHash GetType () const =0
 Return type hash.
 
virtual const StringGetTypeName () const =0
 Return type name.
 
virtual const TypeInfoGetTypeInfo () const =0
 Return type info.
 
virtual void OnEvent (Object *sender, StringHash eventType, VariantMap &eventData)
 Handle event.
 
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.
 
void SubscribeToEvent (StringHash eventType, EventHandler *handler)
 Subscribe to an event that can be sent by any sender.
 
void SubscribeToEvent (Object *sender, StringHash eventType, EventHandler *handler)
 Subscribe to a specific sender's event.
 
void SubscribeToEvent (StringHash eventType, const std::function< void(StringHash, VariantMap &)> &function, void *userData=nullptr)
 Subscribe to an event that can be sent by any sender.
 
void SubscribeToEvent (Object *sender, StringHash eventType, const std::function< void(StringHash, VariantMap &)> &function, void *userData=nullptr)
 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 PODVector< StringHash > &exceptions, bool onlyUserData)
 Unsubscribe from all events except those listed, and optionally only those with userdata (script registered events.)
 
void SendEvent (StringHash eventType)
 Send event to all subscribers.
 
void SendEvent (StringHash eventType, VariantMap &eventData)
 Send event with parameters to all subscribers.
 
VariantMapGetEventDataMap () 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, Args...args)
 Send event with variadic parameter pairs to all subscribers. The parameter pairs is a list of paramID and paramValue separated by comma, one pair after another.
 
ContextGetContext () const
 Return execution context.
 
const VariantGetGlobalVar (StringHash key) const
 Return global variable based on key.
 
const VariantMapGetGlobalVars () const
 Return all global variables.
 
void SetGlobalVar (StringHash key, const Variant &value)
 Set global variable with the respective key and value.
 
ObjectGetSubsystem (StringHash type) const
 Return subsystem by type.
 
ObjectGetEventSender () const
 Return active event sender. Null outside event handling.
 
EventHandlerGetEventHandler () 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 StringGetCategory () const
 Return object category. Categories are (optionally) registered along with the object factory. Return an empty string if the object category is not registered.
 
- 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.
 
void AddRef ()
 Increment reference count. Can also be called outside of a SharedPtr for traditional reference counting.
 
void ReleaseRef ()
 Decrement reference count and delete self if no more references. Can also be called outside of a SharedPtr for traditional reference counting.
 
int Refs () const
 Return reference count.
 
int WeakRefs () const
 Return weak reference count.
 
RefCountRefCountPtr ()
 Return pointer to the reference count structure.
 

Static Public Member Functions

static void RegisterObject (Context *context)
 Register object factory.
 
static unsigned GetPassIndex (const String &passName)
 Return a pass type index by name. Allocate new if not used yet.
 
- Static Public Member Functions inherited from Urho3D::Object
static const TypeInfoGetTypeInfoStatic ()
 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.
 

Private Member Functions

 URHO3D_OBJECT (Technique, Resource)
 

Private Attributes

bool isDesktop_
 Require desktop GPU flag.
 
bool desktopSupport_
 Cached desktop GPU support flag.
 
Vector< SharedPtr< Pass > > passes_
 Passes.
 
HashMap< Pair< StringHash,
StringHash >, SharedPtr
< Technique > > 
cloneTechniques_
 Cached clones with added shader compilation defines.
 

Static Private Attributes

static HashMap< String, unsigned > passIndices
 Pass index assignments.
 

Friends

class Renderer
 

Additional Inherited Members

- Protected Attributes inherited from Urho3D::Object
Contextcontext_
 Execution context.
 

Detailed Description

Material technique. Consists of several passes.


The documentation for this class was generated from the following files:
  • Source/Urho3D/Graphics/Technique.h
  • Source/Urho3D/Graphics/Technique.cpp