OGRE
1.11.6
Object-Oriented Graphics Rendering Engine
|
Class encapsulates rendering properties of an object. More...
#include <OgreMaterial.h>
Public Types | |
enum | LoadingFlags { LF_DEFAULT = 0, LF_INCLUDE_NON_RELOADABLE = 1, LF_ONLY_UNREFERENCED = 2, LF_ONLY_UNREFERENCED_INCLUDE_NON_RELOADABLE = 3, LF_PRESERVE_STATE = 4 } |
Enum that allow to choose subset of unloaded/reloaded resources and to adjust reloading behavior. More... | |
enum | LoadingState { LOADSTATE_UNLOADED, LOADSTATE_LOADING, LOADSTATE_LOADED, LOADSTATE_UNLOADING, LOADSTATE_PREPARED, LOADSTATE_PREPARING } |
Enum identifying the loading state of the resource. More... | |
typedef ConstVectorIterator< LodValueList > | LodValueIterator |
typedef std::vector< Real > | LodValueList |
distance list used to specify LOD More... | |
typedef VectorIterator< Techniques > | TechniqueIterator |
typedef std::vector< Technique * > | Techniques |
Public Member Functions | |
Material (ResourceManager *creator, const String &name, ResourceHandle handle, const String &group, bool isManual=false, ManualResourceLoader *loader=0) | |
Constructor - use resource manager's create method rather than this. More... | |
~Material () | |
virtual void | _dirtyState () |
Manually mark the state of this resource as having been changed. More... | |
void | _fireLoadingComplete (bool wasBackgroundLoaded) |
Firing of loading complete event. More... | |
void | _firePreparingComplete (bool wasBackgroundLoaded) |
Firing of preparing complete event. More... | |
void | _fireUnloadingComplete (void) |
Firing of unloading complete event. More... | |
void | _notifyNeedsRecompile (void) |
Tells the material that it needs recompilation. More... | |
void | _notifyOrigin (const String &origin) |
Notify this resource of it's origin. More... | |
virtual void | addListener (Listener *lis) |
Register a listener on this resource. More... | |
bool | applyTextureAliases (const AliasTextureNamePairList &aliasList, const bool apply=true) const |
Applies texture names to Texture Unit State with matching texture name aliases. More... | |
virtual void | changeGroupOwnership (const String &newGroup) |
Change the resource group ownership of a Resource. More... | |
MaterialPtr | clone (const String &newName, bool changeGroup=false, const String &newGroup=BLANKSTRING) const |
Creates a new copy of this material with the same settings but a new name. More... | |
void | compile (bool autoManageTextureUnits=true) |
'Compiles' this Material. More... | |
void | copyDetailsTo (MaterialPtr &mat) const |
Copies the details of this material into another, preserving the target's handle and name (unlike operator=) but copying everything else. More... | |
void | copyParametersTo (StringInterface *dest) const |
Method for copying this object's parameters to another object. More... | |
Technique * | createTechnique (void) |
Creates a new Technique for this Material. More... | |
virtual void | escalateLoading () |
Escalates the loading of a background loaded resource. More... | |
Technique * | getBestTechnique (unsigned short lodIndex=0, const Renderable *rend=0) |
Gets the best supported technique. More... | |
bool | getCompilationRequired () const |
Gets the compilation status of the material. More... | |
ResourceManager * | getCreator (void) |
Gets the manager which created this resource. More... | |
virtual const String & | getGroup (void) const |
Gets the group which this resource is a member of. More... | |
virtual ResourceHandle | getHandle (void) const |
virtual LoadingState | getLoadingState () const |
Returns the current loading state. More... | |
ushort | getLodIndex (Real value) const |
Gets the LOD index to use at the given value. More... | |
const LodStrategy * | getLodStrategy () const |
Get LOD strategy used by this material. More... | |
LodValueIterator | getLodValueIterator (void) const |
const LodValueList & | getLodValues (void) const |
Gets the list of values transformed by the LodStrategy at which each LOD comes into effect. More... | |
virtual const String & | getName (void) const |
Gets resource name. More... | |
unsigned short | getNumLodLevels (unsigned short schemeIndex) const |
Gets the number of levels-of-detail this material has in the given scheme, based on Technique::setLodIndex. More... | |
unsigned short | getNumLodLevels (const String &schemeName) const |
Gets the number of levels-of-detail this material has in the given scheme, based on Technique::setLodIndex. More... | |
unsigned short | getNumSupportedTechniques (void) const |
Retrieves the number of supported techniques. More... | |
unsigned short | getNumTechniques (void) const |
Retrieves the number of techniques. More... | |
const String & | getOrigin (void) const |
Get the origin of this resource, e.g. More... | |
ParamDictionary * | getParamDictionary (void) |
Retrieves the parameter dictionary for this class. More... | |
const ParamDictionary * | getParamDictionary (void) const |
String | getParameter (const String &name) const |
Generic parameter retrieval method. More... | |
const ParameterList & | getParameters (void) const |
Retrieves a list of parameters valid for this object. More... | |
bool | getReceiveShadows (void) const |
Returns whether or not objects using this material will receive shadows. More... | |
virtual size_t | getSize (void) const |
Retrieves info about the size of the resource. More... | |
virtual size_t | getStateCount () const |
Returns the number of times this resource has changed state, which generally means the number of times it has been loaded. More... | |
Technique * | getSupportedTechnique (unsigned short index) |
Gets the indexed supported technique. More... | |
TechniqueIterator | getSupportedTechniqueIterator (void) |
const Techniques & | getSupportedTechniques (void) const |
Gets all the Techniques which are supported by the current card. More... | |
Technique * | getTechnique (unsigned short index) const |
Gets the indexed technique. More... | |
Technique * | getTechnique (const String &name) const |
searches for the named technique. More... | |
TechniqueIterator | getTechniqueIterator (void) |
Get an iterator over the Techniques in this Material. More... | |
const Techniques & | getTechniques (void) const |
Get the Techniques in this Material. More... | |
bool | getTransparencyCastsShadows (void) const |
Returns whether or not objects using this material be classified as opaque to the shadow caster system. More... | |
const String & | getUnsupportedTechniquesExplanation () const |
Gets a string explaining why any techniques are not supported. More... | |
LodValueIterator | getUserLodValueIterator (void) const |
const LodValueList & | getUserLodValues (void) const |
Gets the user-defined list of values which are internally transfomed by the LodStrategy. More... | |
virtual bool | isBackgroundLoaded (void) const |
Returns whether this Resource has been earmarked for background loading. More... | |
virtual bool | isLoaded (void) const |
Returns true if the Resource has been loaded, false otherwise. More... | |
virtual bool | isLoading () const |
Returns whether the resource is currently in the process of background loading. More... | |
virtual bool | isManuallyLoaded (void) const |
Is this resource manually loaded? More... | |
virtual bool | isPrepared (void) const |
Returns true if the Resource has been prepared, false otherwise. More... | |
virtual bool | isReloadable (void) const |
Returns true if the Resource is reloadable, false otherwise. More... | |
bool | isTransparent (void) const |
Determines if the material has any transparency with the rest of the scene (derived from whether any Techniques say they involve transparency). More... | |
virtual void | load (bool backgroundThread=false) |
Loads the resource, if it is not already. More... | |
Material & | operator= (const Material &rhs) |
Assignment operator to allow easy copying between materials. More... | |
virtual void | prepare (bool backgroundThread=false) |
Prepares the resource for load, if it is not already. More... | |
virtual void | reload (LoadingFlags flags=LF_DEFAULT) |
Reloads the resource, if it is already loaded. More... | |
void | removeAllTechniques (void) |
Removes all the techniques in this Material. More... | |
virtual void | removeListener (Listener *lis) |
Remove a listener on this resource. More... | |
void | removeTechnique (unsigned short index) |
Removes the technique at the given index. More... | |
void | setAmbient (float red, float green, float blue) |
Sets the ambient colour reflectance properties for every Pass in every Technique. More... | |
void | setAmbient (const ColourValue &ambient) |
virtual void | setBackgroundLoaded (bool bl) |
Tells the resource whether it is background loaded or not. More... | |
void | setColourWriteEnabled (bool enabled) |
Sets whether or not colour buffer writing is enabled for each Pass. More... | |
void | setColourWriteEnabled (bool red, bool green, bool blue, bool alpha) |
Sets which colour buffer channels are enabled for writing for each Pass. More... | |
void | setCullingMode (CullingMode mode) |
Sets the culling mode for each pass based on the 'vertex winding'. More... | |
void | setDepthBias (float constantBias, float slopeScaleBias) |
Sets the depth bias to be used for each Pass. More... | |
void | setDepthCheckEnabled (bool enabled) |
Sets whether or not each Pass renders with depth-buffer checking on or not. More... | |
void | setDepthFunction (CompareFunction func) |
Sets the function used to compare depth values when depth checking is on. More... | |
void | setDepthWriteEnabled (bool enabled) |
Sets whether or not each Pass renders with depth-buffer writing on or not. More... | |
void | setDiffuse (float red, float green, float blue, float alpha) |
Sets the diffuse colour reflectance properties of every Pass in every Technique. More... | |
void | setDiffuse (const ColourValue &diffuse) |
void | setFog (bool overrideScene, FogMode mode=FOG_NONE, const ColourValue &colour=ColourValue::White, Real expDensity=0.001f, Real linearStart=0.0f, Real linearEnd=1.0f) |
Sets the fogging mode applied to each pass. More... | |
void | setLightingEnabled (bool enabled) |
Sets whether or not dynamic lighting is enabled for every Pass. More... | |
void | setLodLevels (const LodValueList &lodValues) |
Sets the distance at which level-of-detail (LOD) levels come into effect. More... | |
void | setLodStrategy (LodStrategy *lodStrategy) |
Set the LOD strategy used by this material. More... | |
void | setManualCullingMode (ManualCullingMode mode) |
Sets the manual culling mode, performed by CPU rather than hardware. More... | |
bool | setParameter (const String &name, const String &value) |
Generic parameter setting method. More... | |
void | setParameterList (const NameValuePairList ¶mList) |
Generic multiple parameter setting method. More... | |
void | setPointSize (Real ps) |
Sets the point size properties for every Pass in every Technique. More... | |
void | setReceiveShadows (bool enabled) |
Sets whether objects using this material will receive shadows. More... | |
void | setSceneBlending (const SceneBlendType sbt) |
Sets the kind of blending every pass has with the existing contents of the scene. More... | |
void | setSceneBlending (const SceneBlendFactor sourceFactor, const SceneBlendFactor destFactor) |
Allows very fine control of blending every Pass with the existing contents of the scene. More... | |
void | setSelfIllumination (float red, float green, float blue) |
Sets the amount of self-illumination of every Pass in every Technique. More... | |
void | setSelfIllumination (const ColourValue &selfIllum) |
void | setSeparateSceneBlending (const SceneBlendType sbt, const SceneBlendType sbta) |
Sets the kind of blending every pass has with the existing contents of the scene, using individual factors for color and alpha channels. More... | |
void | setSeparateSceneBlending (const SceneBlendFactor sourceFactor, const SceneBlendFactor destFactor, const SceneBlendFactor sourceFactorAlpha, const SceneBlendFactor destFactorAlpha) |
Allows very fine control of blending every Pass with the existing contents of the scene, using individual factors for color and alpha channels. More... | |
void | setShadingMode (ShadeOptions mode) |
Sets the type of light shading required. More... | |
void | setShininess (Real val) |
Sets the shininess properties of every Pass in every Technique. More... | |
void | setSpecular (float red, float green, float blue, float alpha) |
Sets the specular colour reflectance properties of every Pass in every Technique. More... | |
void | setSpecular (const ColourValue &specular) |
void | setTextureAnisotropy (int maxAniso) |
Sets the anisotropy level to be used for all textures. More... | |
void | setTextureFiltering (TextureFilterOptions filterType) |
Set texture filtering for every texture unit in every Technique and Pass. More... | |
void | setTransparencyCastsShadows (bool enabled) |
Sets whether objects using this material be classified as opaque to the shadow caster system. More... | |
void | touch (void) |
'Touches' the resource to indicate it has been used. More... | |
virtual void | unload (void) |
Unloads the resource; this is not permanent, the resource can be reloaded later if required. More... | |
Static Public Member Functions | |
static void | cleanupDictionary () |
Cleans up the static 'msDictionary' required to reset Ogre, otherwise the containers are left with invalid pointers, which will lead to a crash as soon as one of the ResourceManager implementers (e.g. More... | |
Public Attributes | |
OGRE_AUTO_MUTEX | |
Friends | |
class | MaterialManager |
class | SceneManager |
Class encapsulates rendering properties of an object.
Ogre's material class encapsulates all aspects of the visual appearance, of an object. It also includes other flags which might not be traditionally thought of as material properties such as culling modes and depth buffer settings, but these affect the appearance of the rendered object and are convenient to attach to the material since it keeps all the settings in one place. This is different to Direct3D which treats a material as just the colour components (diffuse, specular) and not texture maps etc. An Ogre Material can be thought of as equivalent to a 'Shader'.
A Material can be rendered in multiple different ways depending on the hardware available. You may configure a Material to use high-complexity fragment shaders, but these won't work on every card; therefore a Technique is an approach to creating the visual effect you are looking for. You are advised to create fallback techniques with lower hardware requirements if you decide to use advanced features. In addition, you also might want lower-detail techniques for distant geometry.
Each Technique can be made up of multiple passes. A fixed-function Pass may combine multiple texture layers using multitexturing, but Ogre can break that into multiple passes automatically if the active card cannot handle that many simultaneous textures. Programmable passes, however, cannot be split down automatically, so if the active graphics card cannot handle the technique which contains these passes, OGRE will try to find another technique which the card can do. If, at the end of the day, the card cannot handle any of the techniques which are listed for the material, the engine will render the geometry plain white, which should alert you to the problem.
Ogre comes configured with a number of default settings for a newly created material. These can be changed if you wish by retrieving the default material settings through MaterialManager::getDefaultSettings. Any changes you make to the Material returned from this method will apply to any materials created from this point onward.
typedef std::vector<Real> Ogre::Material::LodValueList |
distance list used to specify LOD
typedef std::vector<Technique*> Ogre::Material::Techniques |
|
inherited |
|
inherited |
Enum that allow to choose subset of unloaded/reloaded resources and to adjust reloading behavior.
Ogre::Material::Material | ( | ResourceManager * | creator, |
const String & | name, | ||
ResourceHandle | handle, | ||
const String & | group, | ||
bool | isManual = false , |
||
ManualResourceLoader * | loader = 0 |
||
) |
Constructor - use resource manager's create method rather than this.
Ogre::Material::~Material | ( | ) |
Assignment operator to allow easy copying between materials.
bool Ogre::Material::isTransparent | ( | void | ) | const |
Determines if the material has any transparency with the rest of the scene (derived from whether any Techniques say they involve transparency).
|
inline |
Sets whether objects using this material will receive shadows.
|
inline |
Returns whether or not objects using this material will receive shadows.
|
inline |
Sets whether objects using this material be classified as opaque to the shadow caster system.
|
inline |
Returns whether or not objects using this material be classified as opaque to the shadow caster system.
Technique* Ogre::Material::createTechnique | ( | void | ) |
Creates a new Technique for this Material.
Technique* Ogre::Material::getTechnique | ( | unsigned short | index | ) | const |
Gets the indexed technique.
searches for the named technique.
Return 0 if technique with name is not found
unsigned short Ogre::Material::getNumTechniques | ( | void | ) | const |
Retrieves the number of techniques.
void Ogre::Material::removeTechnique | ( | unsigned short | index | ) |
Removes the technique at the given index.
void Ogre::Material::removeAllTechniques | ( | void | ) |
Removes all the techniques in this Material.
TechniqueIterator Ogre::Material::getTechniqueIterator | ( | void | ) |
Get an iterator over the Techniques in this Material.
|
inline |
Get the Techniques in this Material.
|
inline |
Gets all the Techniques which are supported by the current card.
TechniqueIterator Ogre::Material::getSupportedTechniqueIterator | ( | void | ) |
Technique* Ogre::Material::getSupportedTechnique | ( | unsigned short | index | ) |
Gets the indexed supported technique.
unsigned short Ogre::Material::getNumSupportedTechniques | ( | void | ) | const |
Retrieves the number of supported techniques.
|
inline |
Gets a string explaining why any techniques are not supported.
References Ogre::BLANKSTRING, Ogre::FOG_NONE, and Ogre::ColourValue::White.
unsigned short Ogre::Material::getNumLodLevels | ( | unsigned short | schemeIndex | ) | const |
Gets the number of levels-of-detail this material has in the given scheme, based on Technique::setLodIndex.
unsigned short Ogre::Material::getNumLodLevels | ( | const String & | schemeName | ) | const |
Gets the number of levels-of-detail this material has in the given scheme, based on Technique::setLodIndex.
Technique* Ogre::Material::getBestTechnique | ( | unsigned short | lodIndex = 0 , |
const Renderable * | rend = 0 |
||
) |
Gets the best supported technique.
lodIndex | The material LOD index to use |
rend | Optional parameter specifying the Renderable that is requesting this technique. Only used if no valid technique for the active material scheme is found, at which point it is passed to MaterialManager::Listener::handleSchemeNotFound as information. |
MaterialPtr Ogre::Material::clone | ( | const String & | newName, |
bool | changeGroup = false , |
||
const String & | newGroup = BLANKSTRING |
||
) | const |
Creates a new copy of this material with the same settings but a new name.
newName | The name for the cloned material |
changeGroup | If true, the resource group of the clone is changed |
newGroup | Only required if changeGroup is true; the new group to assign |
void Ogre::Material::copyDetailsTo | ( | MaterialPtr & | mat | ) | const |
Copies the details of this material into another, preserving the target's handle and name (unlike operator=) but copying everything else.
mat | Weak reference to material which will receive this material's settings. |
void Ogre::Material::compile | ( | bool | autoManageTextureUnits = true | ) |
'Compiles' this Material.
autoManageTextureUnits | If true, when a fixed function pass has too many TextureUnitState entries than the card has texture units, the Pass in question will be split into more than one Pass in order to emulate the Pass. If you set this to false and this situation arises, an Exception will be thrown. |
void Ogre::Material::setPointSize | ( | Real | ps | ) |
Sets the point size properties for every Pass in every Technique.
void Ogre::Material::setAmbient | ( | float | red, |
float | green, | ||
float | blue | ||
) |
Sets the ambient colour reflectance properties for every Pass in every Technique.
void Ogre::Material::setAmbient | ( | const ColourValue & | ambient | ) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
void Ogre::Material::setDiffuse | ( | float | red, |
float | green, | ||
float | blue, | ||
float | alpha | ||
) |
Sets the diffuse colour reflectance properties of every Pass in every Technique.
void Ogre::Material::setDiffuse | ( | const ColourValue & | diffuse | ) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
void Ogre::Material::setSpecular | ( | float | red, |
float | green, | ||
float | blue, | ||
float | alpha | ||
) |
Sets the specular colour reflectance properties of every Pass in every Technique.
void Ogre::Material::setSpecular | ( | const ColourValue & | specular | ) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
void Ogre::Material::setShininess | ( | Real | val | ) |
Sets the shininess properties of every Pass in every Technique.
void Ogre::Material::setSelfIllumination | ( | float | red, |
float | green, | ||
float | blue | ||
) |
Sets the amount of self-illumination of every Pass in every Technique.
void Ogre::Material::setSelfIllumination | ( | const ColourValue & | selfIllum | ) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
void Ogre::Material::setDepthCheckEnabled | ( | bool | enabled | ) |
Sets whether or not each Pass renders with depth-buffer checking on or not.
void Ogre::Material::setDepthWriteEnabled | ( | bool | enabled | ) |
Sets whether or not each Pass renders with depth-buffer writing on or not.
void Ogre::Material::setDepthFunction | ( | CompareFunction | func | ) |
Sets the function used to compare depth values when depth checking is on.
void Ogre::Material::setColourWriteEnabled | ( | bool | enabled | ) |
Sets whether or not colour buffer writing is enabled for each Pass.
void Ogre::Material::setColourWriteEnabled | ( | bool | red, |
bool | green, | ||
bool | blue, | ||
bool | alpha | ||
) |
Sets which colour buffer channels are enabled for writing for each Pass.
void Ogre::Material::setCullingMode | ( | CullingMode | mode | ) |
Sets the culling mode for each pass based on the 'vertex winding'.
void Ogre::Material::setManualCullingMode | ( | ManualCullingMode | mode | ) |
Sets the manual culling mode, performed by CPU rather than hardware.
void Ogre::Material::setLightingEnabled | ( | bool | enabled | ) |
Sets whether or not dynamic lighting is enabled for every Pass.
void Ogre::Material::setShadingMode | ( | ShadeOptions | mode | ) |
Sets the type of light shading required.
void Ogre::Material::setFog | ( | bool | overrideScene, |
FogMode | mode = FOG_NONE , |
||
const ColourValue & | colour = ColourValue::White , |
||
Real | expDensity = 0.001f , |
||
Real | linearStart = 0.0f , |
||
Real | linearEnd = 1.0f |
||
) |
Sets the fogging mode applied to each pass.
void Ogre::Material::setDepthBias | ( | float | constantBias, |
float | slopeScaleBias | ||
) |
Sets the depth bias to be used for each Pass.
void Ogre::Material::setTextureFiltering | ( | TextureFilterOptions | filterType | ) |
Set texture filtering for every texture unit in every Technique and Pass.
void Ogre::Material::setTextureAnisotropy | ( | int | maxAniso | ) |
Sets the anisotropy level to be used for all textures.
void Ogre::Material::setSceneBlending | ( | const SceneBlendType | sbt | ) |
Sets the kind of blending every pass has with the existing contents of the scene.
void Ogre::Material::setSeparateSceneBlending | ( | const SceneBlendType | sbt, |
const SceneBlendType | sbta | ||
) |
Sets the kind of blending every pass has with the existing contents of the scene, using individual factors for color and alpha channels.
void Ogre::Material::setSceneBlending | ( | const SceneBlendFactor | sourceFactor, |
const SceneBlendFactor | destFactor | ||
) |
Allows very fine control of blending every Pass with the existing contents of the scene.
void Ogre::Material::setSeparateSceneBlending | ( | const SceneBlendFactor | sourceFactor, |
const SceneBlendFactor | destFactor, | ||
const SceneBlendFactor | sourceFactorAlpha, | ||
const SceneBlendFactor | destFactorAlpha | ||
) |
Allows very fine control of blending every Pass with the existing contents of the scene, using individual factors for color and alpha channels.
void Ogre::Material::_notifyNeedsRecompile | ( | void | ) |
Tells the material that it needs recompilation.
void Ogre::Material::setLodLevels | ( | const LodValueList & | lodValues | ) |
Sets the distance at which level-of-detail (LOD) levels come into effect.
lodValues | A vector of Reals which indicate the LOD value at which to switch to lower details. They are listed in LOD index order, starting at index 1 (ie the first level down from the highest level 0, which automatically applies from a value of 0). These are 'user values', before being potentially transformed by the strategy, so for the distance strategy this is an unsquared distance for example. |
|
inline |
Gets the list of values transformed by the LodStrategy at which each LOD comes into effect.
LodValueIterator Ogre::Material::getLodValueIterator | ( | void | ) | const |
|
inline |
Gets the user-defined list of values which are internally transfomed by the LodStrategy.
LodValueIterator Ogre::Material::getUserLodValueIterator | ( | void | ) | const |
Gets the LOD index to use at the given value.
const LodStrategy* Ogre::Material::getLodStrategy | ( | ) | const |
Get LOD strategy used by this material.
void Ogre::Material::setLodStrategy | ( | LodStrategy * | lodStrategy | ) |
Set the LOD strategy used by this material.
|
inlinevirtual |
'Touches' the resource to indicate it has been used.
Reimplemented from Ogre::Resource.
References Ogre::Resource::touch().
bool Ogre::Material::applyTextureAliases | ( | const AliasTextureNamePairList & | aliasList, |
const bool | apply = true |
||
) | const |
Applies texture names to Texture Unit State with matching texture name aliases.
All techniques, passes, and Texture Unit States within the material are checked. If matching texture aliases are found then true is returned.
aliasList | is a map container of texture alias, texture name pairs |
apply | set true to apply the texture aliases else just test to see if texture alias matches are found. |
|
inline |
Gets the compilation status of the material.
|
virtualinherited |
Prepares the resource for load, if it is not already.
One can call prepare() before load(), but this is not required as load() will call prepare() itself, if needed. When OGRE_THREAD_SUPPORT==1 both load() and prepare() are thread-safe. When OGRE_THREAD_SUPPORT==2 however, only prepare() is thread-safe. The reason for this function is to allow a background thread to do some of the loading work, without requiring the whole render system to be thread-safe. The background thread would call prepare() while the main render loop would later call load(). So long as prepare() remains thread-safe, subclasses can arbitrarily split the work of loading a resource between load() and prepare(). It is best to try and do as much work in prepare(), however, since this will leave less work for the main render thread to do and thus increase FPS.
backgroundThread | Whether this is occurring in a background thread |
|
virtualinherited |
Loads the resource, if it is not already.
backgroundThread | Indicates whether the caller of this method is the background resource loading thread. |
Reimplemented in Ogre::UnifiedHighLevelGpuProgram.
|
virtualinherited |
Reloads the resource, if it is already loaded.
Reimplemented in Ogre::Mesh, and Ogre::UnifiedHighLevelGpuProgram.
|
inlinevirtualinherited |
Returns true if the Resource is reloadable, false otherwise.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram.
|
inlinevirtualinherited |
Is this resource manually loaded?
|
virtualinherited |
Unloads the resource; this is not permanent, the resource can be reloaded later if required.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram.
|
inlinevirtualinherited |
Retrieves info about the size of the resource.
Reimplemented in Ogre::CgProgram, and Ogre::UnifiedHighLevelGpuProgram.
|
inlinevirtualinherited |
Gets resource name.
Reimplemented in Ogre::SkeletonInstance.
Referenced by Ogre::GpuProgramUsage::getProgramName(), and OgreBites::TrayManager::resourceLoadStarted().
|
inlinevirtualinherited |
Reimplemented in Ogre::SkeletonInstance.
|
inlinevirtualinherited |
Returns true if the Resource has been prepared, false otherwise.
|
inlinevirtualinherited |
Returns true if the Resource has been loaded, false otherwise.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram.
|
inlinevirtualinherited |
Returns whether the resource is currently in the process of background loading.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram.
|
inlinevirtualinherited |
Returns the current loading state.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram.
|
inlinevirtualinherited |
Returns whether this Resource has been earmarked for background loading.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram.
|
inlinevirtualinherited |
Tells the resource whether it is background loaded or not.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram.
|
virtualinherited |
Escalates the loading of a background loaded resource.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram.
|
virtualinherited |
Register a listener on this resource.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram.
|
virtualinherited |
Remove a listener on this resource.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram.
|
inlinevirtualinherited |
Gets the group which this resource is a member of.
Reimplemented in Ogre::SkeletonInstance.
|
virtualinherited |
Change the resource group ownership of a Resource.
newGroup | Name of the new group |
|
inlineinherited |
Gets the manager which created this resource.
|
inlineinherited |
Get the origin of this resource, e.g.
a script file name.
|
inlineinherited |
Notify this resource of it's origin.
|
inlinevirtualinherited |
Returns the number of times this resource has changed state, which generally means the number of times it has been loaded.
Objects that build derived data based on the resource can check this value against a copy they kept last time they built this derived data, in order to know whether it needs rebuilding. This is a nice way of monitoring changes without having a tightly-bound callback.
|
virtualinherited |
Manually mark the state of this resource as having been changed.
|
inherited |
Firing of loading complete event.
wasBackgroundLoaded | Whether this was a background loaded event |
|
inherited |
Firing of preparing complete event.
wasBackgroundLoaded | Whether this was a background loaded event |
|
inherited |
Firing of unloading complete event.
|
inlineinherited |
Retrieves the parameter dictionary for this class.
|
inlineinherited |
|
inherited |
Retrieves a list of parameters valid for this object.
Generic parameter setting method.
name | The name of the parameter to set |
value | String value. Must be in the right format for the type specified in the parameter definition. See the StringConverter class for more information. |
Referenced by Ogre::StringInterface::copyParametersTo().
|
inherited |
Generic multiple parameter setting method.
paramList | Name/value pair list |
Generic parameter retrieval method.
name | The name of the parameter to get |
References Ogre::ParamCommand::doGet().
|
inlineinherited |
Method for copying this object's parameters to another object.
dest | Pointer to object to have it's parameters set the same as this object. |
References Ogre::StringInterface::setParameter().
|
staticinherited |
Cleans up the static 'msDictionary' required to reset Ogre, otherwise the containers are left with invalid pointers, which will lead to a crash as soon as one of the ResourceManager implementers (e.g.
MaterialManager) initializes.
|
friend |
|
friend |
|
inherited |