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

Describes how to render 3D geometries. More...

#include <Material.h>

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

List of all members.

Public Member Functions

 Material (Context *context)
 Construct.
 ~Material ()
 Destruct.
virtual bool Load (Deserializer &source)
 Load resource. Return true if successful.
virtual bool Save (Serializer &dest)
 Save resource. Return true if successful.
void SetNumTechniques (unsigned num)
 Set number of techniques.
void SetTechnique (unsigned index, Technique *tech, unsigned qualityLevel=0, float lodDistance=0.0f)
 Set technique.
void SetShaderParameter (const String &name, const Vector4 &value)
 Set shader parameter.
void SetTexture (TextureUnit unit, Texture *texture)
 Set texture.
void SetUVTransform (const Vector2 &offset, float rotation, const Vector2 &repeat)
 Set texture coordinate transform.
void SetUVTransform (const Vector2 &offset, float rotation, float repeat)
 Set texture coordinate transform.
void SetCullMode (CullMode mode)
 Set culling mode.
void SetShadowCullMode (CullMode mode)
 Set culling mode for shadows.
void SetDepthBias (const BiasParameters &parameters)
 Set depth bias.
void RemoveShaderParameter (const String &name)
 Remove shader parameter.
void ReleaseShaders ()
 Reset all shader pointers.
SharedPtr< MaterialClone (const String &cloneName=String()) const
 Clone material.
void MarkForAuxView (unsigned frameNumber)
 Mark material for auxiliary view rendering.
unsigned GetNumTechniques () const
 Return number of techniques.
const Vector< TechniqueEntry > & GetTechniques () const
 Return all techniques.
const TechniqueEntryGetTechniqueEntry (unsigned index) const
 Return technique entry by index.
TechniqueGetTechnique (unsigned index) const
 Return technique by index.
PassGetPass (unsigned index, StringHash passType) const
 Return pass by technique index and pass type.
TextureGetTexture (TextureUnit unit) const
 Return texture by unit.
const SharedPtr< Texture > * GetTextures () const
 Return all textures.
const Vector4GetShaderParameter (const String &name) const
 Return shader parameter.
const HashMap< StringHash,
MaterialShaderParameter > & 
GetShaderParameters () const
 Return all shader parameters.
CullMode GetCullMode () const
 Return normal culling mode.
CullMode GetShadowCullMode () const
 Return culling mode for shadows.
const BiasParametersGetDepthBias () const
 Return depth bias.
unsigned GetAuxViewFrameNumber () const
 Return last auxiliary view rendered frame number.
bool GetOcclusion () const
 Return whether should render occlusion.
bool GetSpecular () const
 Return whether should render specular.
- Public Member Functions inherited from Urho3D::Resource
 Resource (Context *context)
 Construct.
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.
static const StringGetTextureUnitName (TextureUnit unit)
 Return name for texture unit.

Private Member Functions

 OBJECT (Material)
void CheckOcclusion ()
 Re-evaluate occlusion rendering.

Private Attributes

Vector< TechniqueEntrytechniques_
 Techniques.
SharedPtr< Texturetextures_ [MAX_MATERIAL_TEXTURE_UNITS]
 Textures.
HashMap< StringHash,
MaterialShaderParameter
shaderParameters_
 Shader parameters.
CullMode cullMode_
 Normal culling mode.
CullMode shadowCullMode_
 Culling mode for shadow rendering.
BiasParameters depthBias_
 Depth bias parameters.
unsigned auxViewFrameNumber_
 Last auxiliary view rendered frame number.
bool occlusion_
 Render occlusion flag.
bool specular_
 Specular lighting flag.

Detailed Description

Describes how to render 3D geometries.


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