#include <OgreGpuProgram.h>
Public Types | |
enum | LoadingState { LOADSTATE_UNLOADED, LOADSTATE_LOADING, LOADSTATE_LOADED, LOADSTATE_UNLOADING } |
Enum identifying the loading state of the resource. More... | |
Public Member Functions | |
GpuProgram (ResourceManager *creator, const String &name, ResourceHandle handle, const String &group, bool isManual=false, ManualResourceLoader *loader=0) | |
virtual | ~GpuProgram () |
virtual void | setSourceFile (const String &filename) |
Sets the filename of the source assembly for this program. | |
virtual void | setSource (const String &source) |
Sets the source assembly for this program from an in-memory string. | |
virtual const String & | getSyntaxCode (void) const |
Gets the syntax code for this program e.g. | |
virtual void | setSyntaxCode (const String &syntax) |
Sets the syntax code for this program e.g. | |
virtual const String & | getSourceFile (void) const |
Gets the name of the file used as source for this program. | |
virtual const String & | getSource (void) const |
Gets the assembler source for this program. | |
virtual void | setType (GpuProgramType t) |
Set the program type (only valid before load). | |
virtual GpuProgramType | getType (void) const |
Get the program type. | |
virtual GpuProgram * | _getBindingDelegate (void) |
Returns the GpuProgram which should be bound to the pipeline. | |
virtual bool | isSupported (void) const |
Returns whether this program can be supported on the current renderer and hardware. | |
virtual GpuProgramParametersSharedPtr | createParameters (void) |
Creates a new parameters object compatible with this program definition. | |
virtual void | setSkeletalAnimationIncluded (bool included) |
Sets whether a vertex program includes the required instructions to perform skeletal animation. | |
virtual bool | isSkeletalAnimationIncluded (void) const |
Returns whether a vertex program includes the required instructions to perform skeletal animation. | |
virtual void | setMorphAnimationIncluded (bool included) |
Sets whether a vertex program includes the required instructions to perform morph animation. | |
virtual void | setPoseAnimationIncluded (ushort poseCount) |
Sets whether a vertex program includes the required instructions to perform pose animation. | |
virtual bool | isMorphAnimationIncluded (void) const |
Returns whether a vertex program includes the required instructions to perform morph animation. | |
virtual bool | isPoseAnimationIncluded (void) const |
Returns whether a vertex program includes the required instructions to perform pose animation. | |
virtual ushort | getNumberOfPosesIncluded (void) const |
Returns the number of simultaneous poses the vertex program can blend, for use in pose animation. | |
virtual void | setVertexTextureFetchRequired (bool r) |
Sets whether this vertex program requires support for vertex texture fetch from the hardware. | |
virtual bool | isVertexTextureFetchRequired (void) const |
Returns whether this vertex program requires support for vertex texture fetch from the hardware. | |
virtual GpuProgramParametersSharedPtr | getDefaultParameters (void) |
Get a reference to the default parameters which are to be used for all uses of this program. | |
virtual bool | hasDefaultParameters (void) const |
Returns true if default parameters have been set up. | |
virtual void | setSurfaceAndPassLightStates (bool state) |
Sets whether a vertex program requires light and material states to be passed to through fixed pipeline low level API rendering calls. | |
virtual bool | getPassSurfaceAndLightStates (void) const |
Returns whether a vertex program wants light and material states to be passed through fixed pipeline low level API rendering calls. | |
virtual const String & | getLanguage (void) const |
Returns a string that specifies the language of the gpu programs as specified in a material script. | |
virtual bool | hasCompileError (void) const |
Did this program encounter a compile error when loading? | |
virtual void | resetCompileError (void) |
Reset a compile error if it occurred, allowing the load to be retried. | |
virtual void | load (bool backgroundThread=false) |
Loads the resource, if it is not already. | |
virtual void | reload (void) |
Reloads the resource, if it is already loaded. | |
bool | isReloadable (void) const |
Returns true if the Resource is reloadable, false otherwise. | |
bool | isManuallyLoaded (void) const |
Is this resource manually loaded? | |
virtual void | unload (void) |
Unloads the resource; this is not permanent, the resource can be reloaded later if required. | |
size_t | getSize (void) const |
Retrieves info about the size of the resource. | |
virtual void | touch (void) |
'Touches' the resource to indicate it has been used. | |
const String & | getName (void) const |
Gets resource name. | |
ResourceHandle | getHandle (void) const |
bool | isLoaded (void) const |
Returns true if the Resource has been loaded, false otherwise. | |
LoadingState | isLoading () const |
Returns whether the resource is currently in the process of background loading. | |
LoadingState | getLoadingState () const |
Returns the current loading state. | |
bool | isBackgroundLoaded (void) const |
Returns whether this Resource has been earmarked for background loading. | |
void | setBackgroundLoaded (bool bl) |
Tells the resource whether it is background loaded or not. | |
void | escalateLoading () |
Escalates the loading of a background loaded resource. | |
void | addListener (Listener *lis) |
Register a listener on this resource. | |
void | removeListener (Listener *lis) |
Remove a listener on this resource. | |
const String & | getGroup (void) |
Gets the group which this resource is a member of. | |
void | changeGroupOwnership (const String &newGroup) |
Change the resource group ownership of a Resource. | |
ResourceManager * | getCreator (void) |
Gets the manager which created this resource. | |
const String & | getOrigin (void) const |
Get the origin of this resource, e.g. | |
void | _notifyOrigin (const String &origin) |
Notify this resource of it's origin. | |
virtual void | _fireBackgroundLoadingComplete (void) |
Firing of background loading complete event. | |
ParamDictionary * | getParamDictionary (void) |
Retrieves the parameter dictionary for this class. | |
const ParamDictionary * | getParamDictionary (void) const |
const ParameterList & | getParameters (void) const |
Retrieves a list of parameters valid for this object. | |
virtual bool | setParameter (const String &name, const String &value) |
Generic parameter setting method. | |
virtual void | setParameterList (const NameValuePairList ¶mList) |
Generic multiple parameter setting method. | |
virtual String | getParameter (const String &name) const |
Generic parameter retrieval method. | |
virtual void | copyParametersTo (StringInterface *dest) const |
Method for copying this object's parameters to another object. | |
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. | |
Protected Types | |
typedef std::list < Listener * > | ListenerList |
Protected Member Functions | |
void | setupBaseParamDictionary (void) |
Internal method for setting up the basic parameter definitions for a subclass. | |
bool | isRequiredCapabilitiesSupported (void) const |
Internal method returns whether required capabilities for this program is supported. | |
size_t | calculateSize (void) const |
Calculate the size of a resource; this will only be called after 'load'. | |
void | loadImpl (void) |
Internal implementation of the meat of the 'load' action, only called if this resource is not being loaded from a ManualResourceLoader. | |
virtual void | loadFromSource (void)=0 |
Virtual method which must be implemented by subclasses, load from mSource. | |
virtual void | preLoadImpl (void) |
Internal hook to perform actions before the load process, but after the resource has been marked as 'loading'. | |
virtual void | postLoadImpl (void) |
Internal hook to perform actions after the load process, but before the resource has been marked as fully loaded. | |
virtual void | preUnloadImpl (void) |
Internal hook to perform actions before the unload process. | |
virtual void | postUnloadImpl (void) |
Internal hook to perform actions after the unload process, but before the resource has been marked as fully unloaded. | |
virtual void | unloadImpl (void)=0 |
Internal implementation of the 'unload' action; called regardless of whether this resource is being loaded from a ManualResourceLoader. | |
virtual void | queueFireBackgroundLoadingComplete (void) |
Queue the firing of background loading complete event. | |
bool | createParamDictionary (const String &className) |
Internal method for creating a parameter dictionary for the class, if it does not already exist. | |
Protected Attributes | |
GpuProgramType | mType |
The type of the program. | |
String | mFilename |
The name of the file to load source from (may be blank). | |
String | mSource |
The assembler source of the program (may be blank until file loaded). | |
bool | mLoadFromFile |
Whether we need to load source from file or not. | |
String | mSyntaxCode |
Syntax code eg arbvp1, vs_2_0 etc. | |
bool | mSkeletalAnimation |
Does this (vertex) program include skeletal animation? | |
bool | mMorphAnimation |
Does this (vertex) program include morph animation? | |
ushort | mPoseAnimation |
Does this (vertex) program include pose animation (count of number of poses supported). | |
bool | mVertexTextureFetch |
Does this (vertex) program require support for vertex texture fetch? | |
GpuProgramParametersSharedPtr | mDefaultParams |
The default parameters for use with this object. | |
bool | mPassSurfaceAndLightStates |
Does this program want light states passed through fixed pipeline. | |
bool | mCompileError |
Did we encounter a compilation error? | |
GpuLogicalBufferStruct | mFloatLogicalToPhysical |
Record of logical to physical buffer maps. | |
GpuLogicalBufferStruct | mIntLogicalToPhysical |
Record of logical to physical buffer maps. | |
ResourceManager * | mCreator |
Creator. | |
String | mName |
Unique name of the resource. | |
String | mGroup |
The name of the resource group. | |
ResourceHandle | mHandle |
Numeric handle for more efficient look up than name. | |
volatile LoadingState | mLoadingState |
Is the resource currently loaded? | |
volatile bool | mIsBackgroundLoaded |
Is this resource going to be background loaded? Only applicable for multithreaded. | |
size_t | mSize |
Mutex to cover the status of loading. | |
bool | mIsManual |
Is this file manually loaded? | |
String | mOrigin |
Origin of this resource (e.g. script name) - optional. | |
ManualResourceLoader * | mLoader |
Optional manual loader; if provided, data is loaded from here instead of a file. | |
ListenerList | mListenerList |
String | mParamDictName |
Class name for this instance to be used as a lookup (must be initialised by subclasses). | |
Static Protected Attributes | |
static CmdType | msTypeCmd |
static CmdSyntax | msSyntaxCmd |
static CmdSkeletal | msSkeletalCmd |
static CmdMorph | msMorphCmd |
static CmdPose | msPoseCmd |
static CmdVTF | msVTFCmd |
static ParamDictionaryMap | msDictionary |
Dictionary of parameters. | |
Classes | |
class | CmdMorph |
class | CmdPose |
class | CmdSkeletal |
class | CmdSyntax |
class | CmdType |
Command object - see ParamCommand. More... | |
class | CmdVTF |
Definition at line 1308 of file OgreGpuProgram.h.
typedef std::list<Listener*> Ogre::Resource::ListenerList [protected, inherited] |
Definition at line 131 of file OgreResource.h.
enum Ogre::Resource::LoadingState [inherited] |
Enum identifying the loading state of the resource.
LOADSTATE_UNLOADED | Not loaded. |
LOADSTATE_LOADING | Loading is in progress. |
LOADSTATE_LOADED | Fully loaded. |
LOADSTATE_UNLOADING | Currently unloading. |
Definition at line 96 of file OgreResource.h.
Ogre::GpuProgram::GpuProgram | ( | ResourceManager * | creator, | |
const String & | name, | |||
ResourceHandle | handle, | |||
const String & | group, | |||
bool | isManual = false , |
|||
ManualResourceLoader * | loader = 0 | |||
) |
virtual Ogre::GpuProgram::~GpuProgram | ( | ) | [virtual] |
Definition at line 1411 of file OgreGpuProgram.h.
void Ogre::GpuProgram::setupBaseParamDictionary | ( | void | ) | [protected] |
Internal method for setting up the basic parameter definitions for a subclass.
bool Ogre::GpuProgram::isRequiredCapabilitiesSupported | ( | void | ) | const [protected] |
Internal method returns whether required capabilities for this program is supported.
size_t Ogre::GpuProgram::calculateSize | ( | void | ) | const [protected, virtual] |
Calculate the size of a resource; this will only be called after 'load'.
Implements Ogre::Resource.
Definition at line 1402 of file OgreGpuProgram.h.
void Ogre::GpuProgram::loadImpl | ( | void | ) | [protected, virtual] |
Internal implementation of the meat of the 'load' action, only called if this resource is not being loaded from a ManualResourceLoader.
Implements Ogre::Resource.
Reimplemented in Ogre::HighLevelGpuProgram.
virtual void Ogre::GpuProgram::setSourceFile | ( | const String & | filename | ) | [virtual] |
Sets the filename of the source assembly for this program.
virtual void Ogre::GpuProgram::setSource | ( | const String & | source | ) | [virtual] |
Sets the source assembly for this program from an in-memory string.
virtual const String& Ogre::GpuProgram::getSyntaxCode | ( | void | ) | const [virtual] |
Gets the syntax code for this program e.g.
arbvp1, fp20, vs_1_1 etc
Definition at line 1426 of file OgreGpuProgram.h.
virtual void Ogre::GpuProgram::setSyntaxCode | ( | const String & | syntax | ) | [virtual] |
Sets the syntax code for this program e.g.
arbvp1, fp20, vs_1_1 etc
virtual const String& Ogre::GpuProgram::getSourceFile | ( | void | ) | const [virtual] |
Gets the name of the file used as source for this program.
Definition at line 1432 of file OgreGpuProgram.h.
virtual const String& Ogre::GpuProgram::getSource | ( | void | ) | const [virtual] |
virtual void Ogre::GpuProgram::setType | ( | GpuProgramType | t | ) | [virtual] |
Set the program type (only valid before load).
virtual GpuProgramType Ogre::GpuProgram::getType | ( | void | ) | const [virtual] |
virtual GpuProgram* Ogre::GpuProgram::_getBindingDelegate | ( | void | ) | [virtual] |
Returns the GpuProgram which should be bound to the pipeline.
Reimplemented in Ogre::HighLevelGpuProgram, and Ogre::UnifiedHighLevelGpuProgram.
Definition at line 1444 of file OgreGpuProgram.h.
virtual bool Ogre::GpuProgram::isSupported | ( | void | ) | const [virtual] |
Returns whether this program can be supported on the current renderer and hardware.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram.
virtual GpuProgramParametersSharedPtr Ogre::GpuProgram::createParameters | ( | void | ) | [virtual] |
Creates a new parameters object compatible with this program definition.
Reimplemented in Ogre::HighLevelGpuProgram, and Ogre::UnifiedHighLevelGpuProgram.
virtual void Ogre::GpuProgram::setSkeletalAnimationIncluded | ( | bool | included | ) | [virtual] |
Sets whether a vertex program includes the required instructions to perform skeletal animation.
Definition at line 1464 of file OgreGpuProgram.h.
virtual bool Ogre::GpuProgram::isSkeletalAnimationIncluded | ( | void | ) | const [virtual] |
Returns whether a vertex program includes the required instructions to perform skeletal animation.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram.
Definition at line 1473 of file OgreGpuProgram.h.
virtual void Ogre::GpuProgram::setMorphAnimationIncluded | ( | bool | included | ) | [virtual] |
Sets whether a vertex program includes the required instructions to perform morph animation.
Definition at line 1481 of file OgreGpuProgram.h.
virtual void Ogre::GpuProgram::setPoseAnimationIncluded | ( | ushort | poseCount | ) | [virtual] |
Sets whether a vertex program includes the required instructions to perform pose animation.
poseCount | The number of simultaneous poses the program can blend |
Definition at line 1491 of file OgreGpuProgram.h.
virtual bool Ogre::GpuProgram::isMorphAnimationIncluded | ( | void | ) | const [virtual] |
Returns whether a vertex program includes the required instructions to perform morph animation.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram.
Definition at line 1500 of file OgreGpuProgram.h.
virtual bool Ogre::GpuProgram::isPoseAnimationIncluded | ( | void | ) | const [virtual] |
Returns whether a vertex program includes the required instructions to perform pose animation.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram.
Definition at line 1508 of file OgreGpuProgram.h.
virtual ushort Ogre::GpuProgram::getNumberOfPosesIncluded | ( | void | ) | const [virtual] |
Returns the number of simultaneous poses the vertex program can blend, for use in pose animation.
Definition at line 1512 of file OgreGpuProgram.h.
virtual void Ogre::GpuProgram::setVertexTextureFetchRequired | ( | bool | r | ) | [virtual] |
Sets whether this vertex program requires support for vertex texture fetch from the hardware.
Definition at line 1516 of file OgreGpuProgram.h.
virtual bool Ogre::GpuProgram::isVertexTextureFetchRequired | ( | void | ) | const [virtual] |
Returns whether this vertex program requires support for vertex texture fetch from the hardware.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram.
Definition at line 1520 of file OgreGpuProgram.h.
virtual GpuProgramParametersSharedPtr Ogre::GpuProgram::getDefaultParameters | ( | void | ) | [virtual] |
Get a reference to the default parameters which are to be used for all uses of this program.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram.
virtual bool Ogre::GpuProgram::hasDefaultParameters | ( | void | ) | const [virtual] |
Returns true if default parameters have been set up.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram.
Definition at line 1536 of file OgreGpuProgram.h.
virtual void Ogre::GpuProgram::setSurfaceAndPassLightStates | ( | bool | state | ) | [virtual] |
Sets whether a vertex program requires light and material states to be passed to through fixed pipeline low level API rendering calls.
Definition at line 1546 of file OgreGpuProgram.h.
virtual bool Ogre::GpuProgram::getPassSurfaceAndLightStates | ( | void | ) | const [virtual] |
Returns whether a vertex program wants light and material states to be passed through fixed pipeline low level API rendering calls.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram.
Definition at line 1552 of file OgreGpuProgram.h.
virtual const String& Ogre::GpuProgram::getLanguage | ( | void | ) | const [virtual] |
Returns a string that specifies the language of the gpu programs as specified in a material script.
ie: asm, cg, hlsl, glsl
Reimplemented in Ogre::UnifiedHighLevelGpuProgram.
virtual bool Ogre::GpuProgram::hasCompileError | ( | void | ) | const [virtual] |
Did this program encounter a compile error when loading?
Reimplemented in Ogre::UnifiedHighLevelGpuProgram.
Definition at line 1561 of file OgreGpuProgram.h.
virtual void Ogre::GpuProgram::resetCompileError | ( | void | ) | [virtual] |
Reset a compile error if it occurred, allowing the load to be retried.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram.
Definition at line 1565 of file OgreGpuProgram.h.
virtual void Ogre::GpuProgram::loadFromSource | ( | void | ) | [protected, pure virtual] |
Virtual method which must be implemented by subclasses, load from mSource.
Implemented in Ogre::UnifiedHighLevelGpuProgram.
virtual void Ogre::Resource::preLoadImpl | ( | void | ) | [protected, virtual, inherited] |
Internal hook to perform actions before the load process, but after the resource has been marked as 'loading'.
Definition at line 149 of file OgreResource.h.
virtual void Ogre::Resource::postLoadImpl | ( | void | ) | [protected, virtual, inherited] |
Internal hook to perform actions after the load process, but before the resource has been marked as fully loaded.
Reimplemented in Ogre::Mesh.
Definition at line 156 of file OgreResource.h.
virtual void Ogre::Resource::preUnloadImpl | ( | void | ) | [protected, virtual, inherited] |
Internal hook to perform actions before the unload process.
Definition at line 161 of file OgreResource.h.
virtual void Ogre::Resource::postUnloadImpl | ( | void | ) | [protected, virtual, inherited] |
Internal hook to perform actions after the unload process, but before the resource has been marked as fully unloaded.
Definition at line 166 of file OgreResource.h.
virtual void Ogre::Resource::unloadImpl | ( | void | ) | [protected, pure virtual, inherited] |
Internal implementation of the 'unload' action; called regardless of whether this resource is being loaded from a ManualResourceLoader.
Implemented in Ogre::Compositor, Ogre::Font, Ogre::HighLevelGpuProgram, Ogre::Material, Ogre::Mesh, Ogre::Skeleton, Ogre::SkeletonInstance, and Ogre::Texture.
virtual void Ogre::Resource::queueFireBackgroundLoadingComplete | ( | void | ) | [protected, virtual, inherited] |
Queue the firing of background loading complete event.
virtual void Ogre::Resource::load | ( | bool | backgroundThread = false |
) | [virtual, inherited] |
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.
virtual void Ogre::Resource::reload | ( | void | ) | [virtual, inherited] |
Reloads the resource, if it is already loaded.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram.
bool Ogre::Resource::isReloadable | ( | void | ) | const [inherited] |
Returns true if the Resource is reloadable, false otherwise.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram.
Definition at line 228 of file OgreResource.h.
bool Ogre::Resource::isManuallyLoaded | ( | void | ) | const [inherited] |
virtual void Ogre::Resource::unload | ( | void | ) | [virtual, inherited] |
Unloads the resource; this is not permanent, the resource can be reloaded later if required.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram.
size_t Ogre::Resource::getSize | ( | void | ) | const [inherited] |
Retrieves info about the size of the resource.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram.
Definition at line 247 of file OgreResource.h.
virtual void Ogre::Resource::touch | ( | void | ) | [virtual, inherited] |
'Touches' the resource to indicate it has been used.
Reimplemented in Ogre::Material, and Ogre::UnifiedHighLevelGpuProgram.
Referenced by Ogre::Material::touch().
const String& Ogre::Resource::getName | ( | void | ) | const [inherited] |
Gets resource name.
Reimplemented in Ogre::SkeletonInstance.
Definition at line 258 of file OgreResource.h.
ResourceHandle Ogre::Resource::getHandle | ( | void | ) | const [inherited] |
bool Ogre::Resource::isLoaded | ( | void | ) | const [inherited] |
Returns true if the Resource has been loaded, false otherwise.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram.
Definition at line 270 of file OgreResource.h.
LoadingState Ogre::Resource::isLoading | ( | ) | const [inherited] |
Returns whether the resource is currently in the process of background loading.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram.
Definition at line 279 of file OgreResource.h.
LoadingState Ogre::Resource::getLoadingState | ( | ) | const [inherited] |
Returns the current loading state.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram.
Definition at line 286 of file OgreResource.h.
bool Ogre::Resource::isBackgroundLoaded | ( | void | ) | const [inherited] |
Returns whether this Resource has been earmarked for background loading.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram.
Definition at line 303 of file OgreResource.h.
void Ogre::Resource::setBackgroundLoaded | ( | bool | bl | ) | [inherited] |
Tells the resource whether it is background loaded or not.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram.
Definition at line 313 of file OgreResource.h.
void Ogre::Resource::escalateLoading | ( | ) | [inherited] |
Escalates the loading of a background loaded resource.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram.
void Ogre::Resource::addListener | ( | Listener * | lis | ) | [inherited] |
void Ogre::Resource::removeListener | ( | Listener * | lis | ) | [inherited] |
const String& Ogre::Resource::getGroup | ( | void | ) | [inherited] |
Gets the group which this resource is a member of.
Reimplemented in Ogre::SkeletonInstance.
Definition at line 337 of file OgreResource.h.
void Ogre::Resource::changeGroupOwnership | ( | const String & | newGroup | ) | [inherited] |
Change the resource group ownership of a Resource.
newGroup | Name of the new group |
ResourceManager* Ogre::Resource::getCreator | ( | void | ) | [inherited] |
const String& Ogre::Resource::getOrigin | ( | void | ) | const [inherited] |
Get the origin of this resource, e.g.
a script file name.
Definition at line 356 of file OgreResource.h.
void Ogre::Resource::_notifyOrigin | ( | const String & | origin | ) | [inherited] |
virtual void Ogre::Resource::_fireBackgroundLoadingComplete | ( | void | ) | [virtual, inherited] |
Firing of background loading complete event.
bool Ogre::StringInterface::createParamDictionary | ( | const String & | className | ) | [protected, inherited] |
Internal method for creating a parameter dictionary for the class, if it does not already exist.
className | the name of the class using the dictionary |
Definition at line 176 of file OgreStringInterface.h.
ParamDictionary* Ogre::StringInterface::getParamDictionary | ( | void | ) | [inherited] |
Retrieves the parameter dictionary for this class.
Definition at line 200 of file OgreStringInterface.h.
const ParamDictionary* Ogre::StringInterface::getParamDictionary | ( | void | ) | const [inherited] |
Definition at line 213 of file OgreStringInterface.h.
const ParameterList& Ogre::StringInterface::getParameters | ( | void | ) | const [inherited] |
Retrieves a list of parameters valid for this object.
virtual bool Ogre::StringInterface::setParameter | ( | const String & | name, | |
const String & | value | |||
) | [virtual, inherited] |
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().
virtual void Ogre::StringInterface::setParameterList | ( | const NameValuePairList & | paramList | ) | [virtual, inherited] |
Generic multiple parameter setting method.
paramList | Name/value pair list |
virtual String Ogre::StringInterface::getParameter | ( | const String & | name | ) | const [virtual, inherited] |
Generic parameter retrieval method.
name | The name of the parameter to get |
Definition at line 269 of file OgreStringInterface.h.
References Ogre::ParamCommand::doGet(), and Ogre::ParamDictionary::getParamCommand().
virtual void Ogre::StringInterface::copyParametersTo | ( | StringInterface * | dest | ) | const [virtual, inherited] |
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. |
Definition at line 300 of file OgreStringInterface.h.
References Ogre::ParamDictionary::mParamDefs, and Ogre::StringInterface::setParameter().
static void Ogre::StringInterface::cleanupDictionary | ( | ) | [static, inherited] |
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.
CmdType Ogre::GpuProgram::msTypeCmd [static, protected] |
Definition at line 1349 of file OgreGpuProgram.h.
CmdSyntax Ogre::GpuProgram::msSyntaxCmd [static, protected] |
Definition at line 1350 of file OgreGpuProgram.h.
CmdSkeletal Ogre::GpuProgram::msSkeletalCmd [static, protected] |
Definition at line 1351 of file OgreGpuProgram.h.
CmdMorph Ogre::GpuProgram::msMorphCmd [static, protected] |
Definition at line 1352 of file OgreGpuProgram.h.
CmdPose Ogre::GpuProgram::msPoseCmd [static, protected] |
Definition at line 1353 of file OgreGpuProgram.h.
CmdVTF Ogre::GpuProgram::msVTFCmd [static, protected] |
Definition at line 1354 of file OgreGpuProgram.h.
GpuProgramType Ogre::GpuProgram::mType [protected] |
String Ogre::GpuProgram::mFilename [protected] |
The name of the file to load source from (may be blank).
Definition at line 1359 of file OgreGpuProgram.h.
String Ogre::GpuProgram::mSource [protected] |
The assembler source of the program (may be blank until file loaded).
Definition at line 1361 of file OgreGpuProgram.h.
bool Ogre::GpuProgram::mLoadFromFile [protected] |
String Ogre::GpuProgram::mSyntaxCode [protected] |
bool Ogre::GpuProgram::mSkeletalAnimation [protected] |
Does this (vertex) program include skeletal animation?
Definition at line 1367 of file OgreGpuProgram.h.
bool Ogre::GpuProgram::mMorphAnimation [protected] |
Does this (vertex) program include morph animation?
Definition at line 1369 of file OgreGpuProgram.h.
ushort Ogre::GpuProgram::mPoseAnimation [protected] |
Does this (vertex) program include pose animation (count of number of poses supported).
Definition at line 1371 of file OgreGpuProgram.h.
bool Ogre::GpuProgram::mVertexTextureFetch [protected] |
Does this (vertex) program require support for vertex texture fetch?
Definition at line 1373 of file OgreGpuProgram.h.
bool Ogre::GpuProgram::mPassSurfaceAndLightStates [protected] |
Does this program want light states passed through fixed pipeline.
Definition at line 1377 of file OgreGpuProgram.h.
bool Ogre::GpuProgram::mCompileError [protected] |
GpuLogicalBufferStruct Ogre::GpuProgram::mFloatLogicalToPhysical [mutable, protected] |
Record of logical to physical buffer maps.
Mandatory for low-level programs or high-level programs which set their params the same way.
Definition at line 1382 of file OgreGpuProgram.h.
GpuLogicalBufferStruct Ogre::GpuProgram::mIntLogicalToPhysical [mutable, protected] |
Record of logical to physical buffer maps.
Mandatory for low-level programs or high-level programs which set their params the same way.
Definition at line 1385 of file OgreGpuProgram.h.
ResourceManager* Ogre::Resource::mCreator [protected, inherited] |
String Ogre::Resource::mName [protected, inherited] |
String Ogre::Resource::mGroup [protected, inherited] |
ResourceHandle Ogre::Resource::mHandle [protected, inherited] |
volatile LoadingState Ogre::Resource::mLoadingState [protected, inherited] |
volatile bool Ogre::Resource::mIsBackgroundLoaded [protected, inherited] |
Is this resource going to be background loaded? Only applicable for multithreaded.
Definition at line 119 of file OgreResource.h.
size_t Ogre::Resource::mSize [protected, inherited] |
Mutex to cover the status of loading.
The size of the resource in bytes
Definition at line 123 of file OgreResource.h.
bool Ogre::Resource::mIsManual [protected, inherited] |
String Ogre::Resource::mOrigin [protected, inherited] |
Origin of this resource (e.g. script name) - optional.
Definition at line 127 of file OgreResource.h.
ManualResourceLoader* Ogre::Resource::mLoader [protected, inherited] |
Optional manual loader; if provided, data is loaded from here instead of a file.
Definition at line 129 of file OgreResource.h.
ListenerList Ogre::Resource::mListenerList [protected, inherited] |
Definition at line 132 of file OgreResource.h.
ParamDictionaryMap Ogre::StringInterface::msDictionary [static, protected, inherited] |
String Ogre::StringInterface::mParamDictName [protected, inherited] |
Class name for this instance to be used as a lookup (must be initialised by subclasses).
Definition at line 164 of file OgreStringInterface.h.
Copyright © 2000-2005 by The OGRE Team
This work is licensed under a Creative Commons Attribution-ShareAlike 2.5 License.
Last modified Mon Jun 16 12:49:51 2008