Urho3D
Public Member Functions | Static Public Member Functions | Private Member Functions | Private Attributes
Urho3D::Shader Class Reference

Shader resource consisting of several shader variations. More...

#include <D3D9Shader.h>

Inheritance diagram for Urho3D::Shader:
Urho3D::Resource Urho3D::Object Urho3D::RefCounted

List of all members.

Public Member Functions

 Shader (Context *context)
 Construct.
virtual ~Shader ()
 Destruct.
virtual bool Load (Deserializer &source)
 Load resource. Return true if successful.
ShaderVariationGetVariation (ShaderType type, const String &name)
 Return a named variation. Return null if not found.
bool PrepareVariation (ShaderVariation *variation)
 Prepare a shader variation by either compiling it or loading the already compiled bytecode.
- Public Member Functions inherited from Urho3D::Resource
 Resource (Context *context)
 Construct.
virtual bool Save (Serializer &dest)
 Save resource. Return true if successful.
void SetName (const String &name)
 Set name.
void SetMemoryUse (unsigned size)
 Set memory use in bytes, possibly approximate.
void ResetUseTimer ()
 Reset last used timer.
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.
- Public Member Functions inherited from Urho3D::Object
 Object (Context *context)
 Construct.
virtual ~Object ()
 Destruct. Clean up self from event sender & receiver structures.
virtual ShortStringHash GetType () const =0
 Return type hash.
virtual const StringGetTypeName () const =0
 Return type name.
virtual void OnEvent (Object *sender, StringHash eventType, VariantMap &eventData)
 Handle event.
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 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.
ContextGetContext () const
 Return execution context.
ObjectGetSubsystem (ShortStringHash 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.
template<class T >
T * GetSubsystem () const
 Template version of returning a subsystem.
- 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.

Private Member Functions

 OBJECT (Shader)

Private Attributes

ShaderParser vsParser_
 Vertex shader variation parser.
ShaderParser psParser_
 Pixel shader variation parser.
HashMap< StringHash, SharedPtr
< ShaderVariation > > 
vsVariations_
 Vertex shader variations.
HashMap< StringHash, SharedPtr
< ShaderVariation > > 
psVariations_
 Pixel shader variations.
String fullFileName_
 Absolute filename of the shader description file.
String vsExtension_
 Compiled vertex shader file extension.
String psExtension_
 Compiled vertex shader file extension.
String subDir_
 Subdirectory for compiled shaders.
unsigned sourceModifiedTime_
 Shader source last modified time.

Detailed Description

Shader resource consisting of several shader variations.


Member Function Documentation

bool Urho3D::Shader::PrepareVariation ( ShaderVariation variation)

Prepare a shader variation by either compiling it or loading the already compiled bytecode.

Todo:
Check that shader type and model match

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