#include <OgreHighLevelGpuProgram.h>
Public Types | |
enum | LoadingState { LOADSTATE_UNLOADED, LOADSTATE_LOADING, LOADSTATE_LOADED, LOADSTATE_UNLOADING, LOADSTATE_PREPARED, LOADSTATE_PREPARING } |
Enum identifying the loading state of the resource. More... | |
Public Member Functions | |
HighLevelGpuProgram (ResourceManager *creator, const String &name, ResourceHandle handle, const String &group, bool isManual=false, ManualResourceLoader *loader=0) | |
Constructor, should be used only by factory classes. | |
~HighLevelGpuProgram () | |
GpuProgramParametersSharedPtr | createParameters (void) |
Creates a new parameters object compatible with this program definition. | |
GpuProgram * | _getBindingDelegate (void) |
| |
const GpuNamedConstants & | getConstantDefinitions () const |
Get the full list of GpuConstantDefinition instances. | |
const GpuNamedConstants & | getNamedConstants () const |
Override GpuProgram::getNamedConstants to ensure built. | |
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 bool | isSupported (void) const |
Returns whether this program can be supported on the current renderer and hardware. | |
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 void | setAdjacencyInfoRequired (bool r) |
Sets whether this geometry program requires adjacency information from the input primitives. | |
virtual bool | isAdjacencyInfoRequired (void) const |
Returns whether this geometry program requires adjacency information from the input primitives. | |
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 | setManualNamedConstants (const GpuNamedConstants &namedConstants) |
Allows you to manually provide a set of named parameter mappings to a program which would not be able to derive named parameters itself. | |
virtual void | setManualNamedConstantsFile (const String ¶mDefFile) |
Specifies the name of a file from which to load named parameters mapping for a program which would not be able to derive named parameters itself. | |
virtual const String & | getManualNamedConstantsFile () const |
Gets the name of a file from which to load named parameters mapping for a program which would not be able to derive named parameters itself. | |
virtual void | prepare () |
Prepares the resource for load, if it is not already. | |
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. | |
virtual bool | isReloadable (void) const |
Returns true if the Resource is reloadable, false otherwise. | |
virtual 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. | |
virtual 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. | |
virtual const String & | getName (void) const |
Gets resource name. | |
virtual ResourceHandle | getHandle (void) const |
virtual bool | isPrepared (void) const |
Returns true if the Resource has been prepared, false otherwise. | |
virtual bool | isLoaded (void) const |
Returns true if the Resource has been loaded, false otherwise. | |
virtual bool | isLoading () const |
Returns whether the resource is currently in the process of background loading. | |
virtual LoadingState | getLoadingState () const |
Returns the current loading state. | |
virtual bool | isBackgroundLoaded (void) const |
Returns whether this Resource has been earmarked for background loading. | |
virtual void | setBackgroundLoaded (bool bl) |
Tells the resource whether it is background loaded or not. | |
virtual void | escalateLoading () |
Escalates the loading of a background loaded resource. | |
virtual void | addListener (Listener *lis) |
Register a listener on this resource. | |
virtual void | removeListener (Listener *lis) |
Remove a listener on this resource. | |
virtual const String & | getGroup (void) |
Gets the group which this resource is a member of. | |
virtual void | changeGroupOwnership (const String &newGroup) |
Change the resource group ownership of a Resource. | |
virtual ResourceManager * | getCreator (void) |
Gets the manager which created this resource. | |
virtual const String & | getOrigin (void) const |
Get the origin of this resource, e.g. | |
virtual void | _notifyOrigin (const String &origin) |
Notify this resource of it's origin. | |
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. | |
virtual void | _dirtyState () |
Manually mark the state of this resource as having been changed. | |
virtual void | _fireBackgroundLoadingComplete (void) |
Firing of background loading complete event. | |
virtual void | _fireBackgroundPreparingComplete (void) |
Firing of background preparing 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. | |
void * | operator new (size_t sz, const char *file, int line, const char *func) |
operator new, with debug line info | |
void * | operator new (size_t sz) |
void * | operator new (size_t sz, void *ptr) |
placement operator new | |
void * | operator new[] (size_t sz, const char *file, int line, const char *func) |
array operator new, with debug line info | |
void * | operator new[] (size_t sz) |
void | operator delete (void *ptr) |
void | operator delete (void *ptr, void *) |
void | operator delete (void *ptr, const char *, int, const char *) |
void | operator delete[] (void *ptr) |
void | operator delete[] (void *ptr, const char *, int, const char *) |
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 | |
virtual void | loadHighLevel (void) |
Internal load high-level portion if not loaded. | |
virtual void | unloadHighLevel (void) |
Internal unload high-level portion if loaded. | |
virtual void | loadHighLevelImpl (void) |
Internal load implementation, loads just the high-level portion, enough to get parameters. | |
virtual void | createLowLevelImpl (void)=0 |
Internal method for creating an appropriate low-level program from this high-level program, must be implemented by subclasses. | |
virtual void | unloadHighLevelImpl (void)=0 |
Internal unload implementation, must be implemented by subclasses. | |
virtual void | populateParameterNames (GpuProgramParametersSharedPtr params) |
Populate the passed parameters with name->index map. | |
virtual void | buildConstantDefinitions () const =0 |
Build the constant definition map, must be overridden. | |
void | loadImpl () |
Internal implementation of the meat of the 'load' action, only called if this resource is not being loaded from a ManualResourceLoader. | |
void | unloadImpl () |
Internal implementation of the 'unload' action; called regardless of whether this resource is being loaded from a ManualResourceLoader. | |
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'. | |
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 | prepareImpl (void) |
Internal implementation of the meat of the 'prepare' action. | |
virtual void | unprepareImpl (void) |
Internal function for undoing the 'prepare' action. | |
virtual void | queueFireBackgroundLoadingComplete (void) |
Queue the firing of background loading complete event. | |
virtual void | queueFireBackgroundPreparingComplete (void) |
Queue the firing of background preparing 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 | |
bool | mHighLevelLoaded |
Whether the high-level program (and it's parameter defs) is loaded. | |
GpuProgramPtr | mAssemblerProgram |
The underlying assembler program. | |
bool | mConstantDefsBuilt |
Have we built the name->index parameter map yet? | |
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 e.g. 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? | |
bool | mNeedsAdjacencyInfo |
Does this (geometry) program require adjacency information? | |
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. | |
GpuNamedConstants | mConstantDefs |
Parameter name -> ConstantDefinition map, shared instance used by all parameter objects. | |
String | mManualNamedConstantsFile |
File from which to load named constants manually. | |
bool | mLoadedManualNamedConstants |
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. | |
AtomicScalar< 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 |
The size of the resource in bytes. | |
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. | |
size_t | mStateCount |
State count, the number of times this resource has changed state. | |
ListenerList | mListenerList |
Static Protected Attributes | |
static CmdType | msTypeCmd |
static CmdSyntax | msSyntaxCmd |
static CmdSkeletal | msSkeletalCmd |
static CmdMorph | msMorphCmd |
static CmdPose | msPoseCmd |
static CmdVTF | msVTFCmd |
static CmdManualNamedConstsFile | msManNamedConstsFileCmd |
static CmdAdjacency | msAdjacencyCmd |
Definition at line 58 of file OgreHighLevelGpuProgram.h.
typedef std::list<Listener*> Ogre::Resource::ListenerList [protected, inherited] |
Definition at line 148 of file OgreResource.h.
enum Ogre::Resource::LoadingState [inherited] |
Enum identifying the loading state of the resource.
Definition at line 109 of file OgreResource.h.
Ogre::HighLevelGpuProgram::HighLevelGpuProgram | ( | ResourceManager * | creator, | |
const String & | name, | |||
ResourceHandle | handle, | |||
const String & | group, | |||
bool | isManual = false , |
|||
ManualResourceLoader * | loader = 0 | |||
) |
Constructor, should be used only by factory classes.
Ogre::HighLevelGpuProgram::~HighLevelGpuProgram | ( | ) |
virtual void Ogre::HighLevelGpuProgram::loadHighLevel | ( | void | ) | [protected, virtual] |
Internal load high-level portion if not loaded.
virtual void Ogre::HighLevelGpuProgram::unloadHighLevel | ( | void | ) | [protected, virtual] |
Internal unload high-level portion if loaded.
virtual void Ogre::HighLevelGpuProgram::loadHighLevelImpl | ( | void | ) | [protected, virtual] |
Internal load implementation, loads just the high-level portion, enough to get parameters.
virtual void Ogre::HighLevelGpuProgram::createLowLevelImpl | ( | void | ) | [protected, pure virtual] |
Internal method for creating an appropriate low-level program from this high-level program, must be implemented by subclasses.
Implemented in Ogre::UnifiedHighLevelGpuProgram.
virtual void Ogre::HighLevelGpuProgram::unloadHighLevelImpl | ( | void | ) | [protected, pure virtual] |
Internal unload implementation, must be implemented by subclasses.
Implemented in Ogre::UnifiedHighLevelGpuProgram.
virtual void Ogre::HighLevelGpuProgram::populateParameterNames | ( | GpuProgramParametersSharedPtr | params | ) | [protected, virtual] |
Populate the passed parameters with name->index map.
virtual void Ogre::HighLevelGpuProgram::buildConstantDefinitions | ( | ) | const [protected, pure virtual] |
Build the constant definition map, must be overridden.
Implemented in Ogre::UnifiedHighLevelGpuProgram.
void Ogre::HighLevelGpuProgram::loadImpl | ( | ) | [protected, virtual] |
Internal implementation of the meat of the 'load' action, only called if this resource is not being loaded from a ManualResourceLoader.
Reimplemented from Ogre::GpuProgram.
void Ogre::HighLevelGpuProgram::unloadImpl | ( | ) | [protected, virtual] |
Internal implementation of the 'unload' action; called regardless of whether this resource is being loaded from a ManualResourceLoader.
Implements Ogre::Resource.
GpuProgramParametersSharedPtr Ogre::HighLevelGpuProgram::createParameters | ( | void | ) | [virtual] |
Creates a new parameters object compatible with this program definition.
Reimplemented from Ogre::GpuProgram.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram.
GpuProgram* Ogre::HighLevelGpuProgram::_getBindingDelegate | ( | void | ) | [virtual] |
Reimplemented from Ogre::GpuProgram.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram.
Definition at line 111 of file OgreHighLevelGpuProgram.h.
const GpuNamedConstants& Ogre::HighLevelGpuProgram::getConstantDefinitions | ( | ) | const [virtual] |
Get the full list of GpuConstantDefinition instances.
Reimplemented from Ogre::GpuProgram.
const GpuNamedConstants& Ogre::HighLevelGpuProgram::getNamedConstants | ( | ) | const [virtual] |
Override GpuProgram::getNamedConstants to ensure built.
Reimplemented from Ogre::GpuProgram.
Definition at line 120 of file OgreHighLevelGpuProgram.h.
void Ogre::GpuProgram::setupBaseParamDictionary | ( | void | ) | [protected, inherited] |
Internal method for setting up the basic parameter definitions for a subclass.
bool Ogre::GpuProgram::isRequiredCapabilitiesSupported | ( | void | ) | const [protected, inherited] |
Internal method returns whether required capabilities for this program is supported.
size_t Ogre::GpuProgram::calculateSize | ( | void | ) | const [protected, virtual, inherited] |
Calculate the size of a resource; this will only be called after 'load'.
Implements Ogre::Resource.
Definition at line 1523 of file OgreGpuProgram.h.
virtual void Ogre::GpuProgram::setSourceFile | ( | const String & | filename | ) | [virtual, inherited] |
Sets the filename of the source assembly for this program.
virtual void Ogre::GpuProgram::setSource | ( | const String & | source | ) | [virtual, inherited] |
Sets the source assembly for this program from an in-memory string.
virtual const String& Ogre::GpuProgram::getSyntaxCode | ( | void | ) | const [virtual, inherited] |
Gets the syntax code for this program e.g.
arbvp1, fp20, vs_1_1 etc
Definition at line 1547 of file OgreGpuProgram.h.
virtual void Ogre::GpuProgram::setSyntaxCode | ( | const String & | syntax | ) | [virtual, inherited] |
Sets the syntax code for this program e.g.
arbvp1, fp20, vs_1_1 etc
virtual const String& Ogre::GpuProgram::getSourceFile | ( | void | ) | const [virtual, inherited] |
Gets the name of the file used as source for this program.
Definition at line 1553 of file OgreGpuProgram.h.
virtual const String& Ogre::GpuProgram::getSource | ( | void | ) | const [virtual, inherited] |
virtual void Ogre::GpuProgram::setType | ( | GpuProgramType | t | ) | [virtual, inherited] |
Set the program type (only valid before load).
virtual GpuProgramType Ogre::GpuProgram::getType | ( | void | ) | const [virtual, inherited] |
virtual bool Ogre::GpuProgram::isSupported | ( | void | ) | const [virtual, inherited] |
Returns whether this program can be supported on the current renderer and hardware.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram.
virtual void Ogre::GpuProgram::setSkeletalAnimationIncluded | ( | bool | included | ) | [virtual, inherited] |
Sets whether a vertex program includes the required instructions to perform skeletal animation.
Definition at line 1585 of file OgreGpuProgram.h.
virtual bool Ogre::GpuProgram::isSkeletalAnimationIncluded | ( | void | ) | const [virtual, inherited] |
Returns whether a vertex program includes the required instructions to perform skeletal animation.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram.
Definition at line 1594 of file OgreGpuProgram.h.
virtual void Ogre::GpuProgram::setMorphAnimationIncluded | ( | bool | included | ) | [virtual, inherited] |
Sets whether a vertex program includes the required instructions to perform morph animation.
Definition at line 1602 of file OgreGpuProgram.h.
virtual void Ogre::GpuProgram::setPoseAnimationIncluded | ( | ushort | poseCount | ) | [virtual, inherited] |
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 1612 of file OgreGpuProgram.h.
virtual bool Ogre::GpuProgram::isMorphAnimationIncluded | ( | void | ) | const [virtual, inherited] |
Returns whether a vertex program includes the required instructions to perform morph animation.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram.
Definition at line 1621 of file OgreGpuProgram.h.
virtual bool Ogre::GpuProgram::isPoseAnimationIncluded | ( | void | ) | const [virtual, inherited] |
Returns whether a vertex program includes the required instructions to perform pose animation.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram.
Definition at line 1629 of file OgreGpuProgram.h.
virtual ushort Ogre::GpuProgram::getNumberOfPosesIncluded | ( | void | ) | const [virtual, inherited] |
Returns the number of simultaneous poses the vertex program can blend, for use in pose animation.
Definition at line 1633 of file OgreGpuProgram.h.
virtual void Ogre::GpuProgram::setVertexTextureFetchRequired | ( | bool | r | ) | [virtual, inherited] |
Sets whether this vertex program requires support for vertex texture fetch from the hardware.
Definition at line 1637 of file OgreGpuProgram.h.
virtual bool Ogre::GpuProgram::isVertexTextureFetchRequired | ( | void | ) | const [virtual, inherited] |
Returns whether this vertex program requires support for vertex texture fetch from the hardware.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram.
Definition at line 1641 of file OgreGpuProgram.h.
virtual void Ogre::GpuProgram::setAdjacencyInfoRequired | ( | bool | r | ) | [virtual, inherited] |
Sets whether this geometry program requires adjacency information from the input primitives.
Definition at line 1646 of file OgreGpuProgram.h.
virtual bool Ogre::GpuProgram::isAdjacencyInfoRequired | ( | void | ) | const [virtual, inherited] |
Returns whether this geometry program requires adjacency information from the input primitives.
Definition at line 1650 of file OgreGpuProgram.h.
virtual GpuProgramParametersSharedPtr Ogre::GpuProgram::getDefaultParameters | ( | void | ) | [virtual, inherited] |
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, inherited] |
Returns true if default parameters have been set up.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram.
Definition at line 1666 of file OgreGpuProgram.h.
virtual void Ogre::GpuProgram::setSurfaceAndPassLightStates | ( | bool | state | ) | [virtual, inherited] |
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 1676 of file OgreGpuProgram.h.
virtual bool Ogre::GpuProgram::getPassSurfaceAndLightStates | ( | void | ) | const [virtual, inherited] |
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 1682 of file OgreGpuProgram.h.
virtual const String& Ogre::GpuProgram::getLanguage | ( | void | ) | const [virtual, inherited] |
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, inherited] |
Did this program encounter a compile error when loading?
Reimplemented in Ogre::UnifiedHighLevelGpuProgram.
Definition at line 1691 of file OgreGpuProgram.h.
virtual void Ogre::GpuProgram::resetCompileError | ( | void | ) | [virtual, inherited] |
Reset a compile error if it occurred, allowing the load to be retried.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram.
Definition at line 1695 of file OgreGpuProgram.h.
virtual void Ogre::GpuProgram::setManualNamedConstants | ( | const GpuNamedConstants & | namedConstants | ) | [virtual, inherited] |
Allows you to manually provide a set of named parameter mappings to a program which would not be able to derive named parameters itself.
virtual void Ogre::GpuProgram::setManualNamedConstantsFile | ( | const String & | paramDefFile | ) | [virtual, inherited] |
Specifies the name of a file from which to load named parameters mapping for a program which would not be able to derive named parameters itself.
virtual const String& Ogre::GpuProgram::getManualNamedConstantsFile | ( | ) | const [virtual, inherited] |
Gets the name of a file from which to load named parameters mapping for a program which would not be able to derive named parameters itself.
Definition at line 1725 of file OgreGpuProgram.h.
virtual void Ogre::GpuProgram::loadFromSource | ( | void | ) | [protected, pure virtual, inherited] |
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 166 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 173 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 178 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 183 of file OgreResource.h.
virtual void Ogre::Resource::prepareImpl | ( | void | ) | [protected, virtual, inherited] |
Internal implementation of the meat of the 'prepare' action.
Reimplemented in Ogre::Material, Ogre::Mesh, and Ogre::PatchMesh.
Definition at line 187 of file OgreResource.h.
virtual void Ogre::Resource::unprepareImpl | ( | void | ) | [protected, virtual, inherited] |
Internal function for undoing the 'prepare' action.
Called when the load is completed, and when resources are unloaded when they are prepared but not yet loaded.
Reimplemented in Ogre::Material, and Ogre::Mesh.
Definition at line 192 of file OgreResource.h.
virtual void Ogre::Resource::queueFireBackgroundLoadingComplete | ( | void | ) | [protected, virtual, inherited] |
Queue the firing of background loading complete event.
virtual void Ogre::Resource::queueFireBackgroundPreparingComplete | ( | void | ) | [protected, virtual, inherited] |
Queue the firing of background preparing complete event.
virtual void Ogre::Resource::prepare | ( | ) | [virtual, inherited] |
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.
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.
virtual bool Ogre::Resource::isReloadable | ( | void | ) | const [virtual, inherited] |
Returns true if the Resource is reloadable, false otherwise.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram.
Definition at line 271 of file OgreResource.h.
virtual bool Ogre::Resource::isManuallyLoaded | ( | void | ) | const [virtual, 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.
virtual size_t Ogre::Resource::getSize | ( | void | ) | const [virtual, inherited] |
Retrieves info about the size of the resource.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram.
Definition at line 290 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().
virtual const String& Ogre::Resource::getName | ( | void | ) | const [virtual, inherited] |
Gets resource name.
Reimplemented in Ogre::SkeletonInstance.
Definition at line 301 of file OgreResource.h.
virtual ResourceHandle Ogre::Resource::getHandle | ( | void | ) | const [virtual, inherited] |
virtual bool Ogre::Resource::isPrepared | ( | void | ) | const [virtual, inherited] |
Returns true if the Resource has been prepared, false otherwise.
Definition at line 313 of file OgreResource.h.
virtual bool Ogre::Resource::isLoaded | ( | void | ) | const [virtual, inherited] |
Returns true if the Resource has been loaded, false otherwise.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram.
Definition at line 321 of file OgreResource.h.
virtual bool Ogre::Resource::isLoading | ( | ) | const [virtual, inherited] |
Returns whether the resource is currently in the process of background loading.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram.
Definition at line 330 of file OgreResource.h.
virtual LoadingState Ogre::Resource::getLoadingState | ( | ) | const [virtual, inherited] |
Returns the current loading state.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram.
Definition at line 337 of file OgreResource.h.
virtual bool Ogre::Resource::isBackgroundLoaded | ( | void | ) | const [virtual, inherited] |
Returns whether this Resource has been earmarked for background loading.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram.
Definition at line 354 of file OgreResource.h.
virtual void Ogre::Resource::setBackgroundLoaded | ( | bool | bl | ) | [virtual, inherited] |
Tells the resource whether it is background loaded or not.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram.
Definition at line 364 of file OgreResource.h.
virtual void Ogre::Resource::escalateLoading | ( | ) | [virtual, inherited] |
Escalates the loading of a background loaded resource.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram.
virtual void Ogre::Resource::addListener | ( | Listener * | lis | ) | [virtual, inherited] |
Register a listener on this resource.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram.
virtual void Ogre::Resource::removeListener | ( | Listener * | lis | ) | [virtual, inherited] |
Remove a listener on this resource.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram.
virtual const String& Ogre::Resource::getGroup | ( | void | ) | [virtual, inherited] |
Gets the group which this resource is a member of.
Reimplemented in Ogre::SkeletonInstance.
Definition at line 388 of file OgreResource.h.
virtual void Ogre::Resource::changeGroupOwnership | ( | const String & | newGroup | ) | [virtual, inherited] |
Change the resource group ownership of a Resource.
newGroup | Name of the new group |
virtual ResourceManager* Ogre::Resource::getCreator | ( | void | ) | [virtual, inherited] |
virtual const String& Ogre::Resource::getOrigin | ( | void | ) | const [virtual, inherited] |
Get the origin of this resource, e.g.
a script file name.
Definition at line 407 of file OgreResource.h.
virtual void Ogre::Resource::_notifyOrigin | ( | const String & | origin | ) | [virtual, inherited] |
virtual size_t Ogre::Resource::getStateCount | ( | ) | const [virtual, inherited] |
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.
Definition at line 418 of file OgreResource.h.
virtual void Ogre::Resource::_dirtyState | ( | ) | [virtual, inherited] |
Manually mark the state of this resource as having been changed.
virtual void Ogre::Resource::_fireBackgroundLoadingComplete | ( | void | ) | [virtual, inherited] |
Firing of background loading complete event.
virtual void Ogre::Resource::_fireBackgroundPreparingComplete | ( | void | ) | [virtual, inherited] |
Firing of background preparing 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 179 of file OgreStringInterface.h.
References OGRE_LOCK_MUTEX.
ParamDictionary* Ogre::StringInterface::getParamDictionary | ( | void | ) | [inherited] |
Retrieves the parameter dictionary for this class.
Definition at line 212 of file OgreStringInterface.h.
const ParamDictionary* Ogre::StringInterface::getParamDictionary | ( | void | ) | const [inherited] |
Definition at line 217 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 265 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 296 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.
void* Ogre::AllocatedObject< Alloc >::operator new | ( | size_t | sz, | |
const char * | file, | |||
int | line, | |||
const char * | func | |||
) | [inherited] |
void* Ogre::AllocatedObject< Alloc >::operator new | ( | size_t | sz | ) | [inherited] |
Definition at line 67 of file OgreMemoryAllocatedObject.h.
void* Ogre::AllocatedObject< Alloc >::operator new | ( | size_t | sz, | |
void * | ptr | |||
) | [inherited] |
void* Ogre::AllocatedObject< Alloc >::operator new[] | ( | size_t | sz, | |
const char * | file, | |||
int | line, | |||
const char * | func | |||
) | [inherited] |
void* Ogre::AllocatedObject< Alloc >::operator new[] | ( | size_t | sz | ) | [inherited] |
Definition at line 84 of file OgreMemoryAllocatedObject.h.
void Ogre::AllocatedObject< Alloc >::operator delete | ( | void * | ptr | ) | [inherited] |
Definition at line 89 of file OgreMemoryAllocatedObject.h.
void Ogre::AllocatedObject< Alloc >::operator delete | ( | void * | ptr, | |
void * | ||||
) | [inherited] |
Definition at line 95 of file OgreMemoryAllocatedObject.h.
void Ogre::AllocatedObject< Alloc >::operator delete | ( | void * | ptr, | |
const char * | , | |||
int | , | |||
const char * | ||||
) | [inherited] |
Definition at line 101 of file OgreMemoryAllocatedObject.h.
void Ogre::AllocatedObject< Alloc >::operator delete[] | ( | void * | ptr | ) | [inherited] |
Definition at line 106 of file OgreMemoryAllocatedObject.h.
void Ogre::AllocatedObject< Alloc >::operator delete[] | ( | void * | ptr, | |
const char * | , | |||
int | , | |||
const char * | ||||
) | [inherited] |
Definition at line 112 of file OgreMemoryAllocatedObject.h.
bool Ogre::HighLevelGpuProgram::mHighLevelLoaded [protected] |
Whether the high-level program (and it's parameter defs) is loaded.
Definition at line 62 of file OgreHighLevelGpuProgram.h.
bool Ogre::HighLevelGpuProgram::mConstantDefsBuilt [mutable, protected] |
Have we built the name->index parameter map yet?
Definition at line 66 of file OgreHighLevelGpuProgram.h.
CmdType Ogre::GpuProgram::msTypeCmd [static, protected, inherited] |
Definition at line 1461 of file OgreGpuProgram.h.
CmdSyntax Ogre::GpuProgram::msSyntaxCmd [static, protected, inherited] |
Definition at line 1462 of file OgreGpuProgram.h.
CmdSkeletal Ogre::GpuProgram::msSkeletalCmd [static, protected, inherited] |
Definition at line 1463 of file OgreGpuProgram.h.
CmdMorph Ogre::GpuProgram::msMorphCmd [static, protected, inherited] |
Definition at line 1464 of file OgreGpuProgram.h.
CmdPose Ogre::GpuProgram::msPoseCmd [static, protected, inherited] |
Definition at line 1465 of file OgreGpuProgram.h.
CmdVTF Ogre::GpuProgram::msVTFCmd [static, protected, inherited] |
Definition at line 1466 of file OgreGpuProgram.h.
CmdManualNamedConstsFile Ogre::GpuProgram::msManNamedConstsFileCmd [static, protected, inherited] |
Definition at line 1467 of file OgreGpuProgram.h.
CmdAdjacency Ogre::GpuProgram::msAdjacencyCmd [static, protected, inherited] |
Definition at line 1468 of file OgreGpuProgram.h.
GpuProgramType Ogre::GpuProgram::mType [protected, inherited] |
String Ogre::GpuProgram::mFilename [protected, inherited] |
The name of the file to load source from (may be blank).
Definition at line 1472 of file OgreGpuProgram.h.
String Ogre::GpuProgram::mSource [protected, inherited] |
The assembler source of the program (may be blank until file loaded).
Definition at line 1474 of file OgreGpuProgram.h.
bool Ogre::GpuProgram::mLoadFromFile [protected, inherited] |
String Ogre::GpuProgram::mSyntaxCode [protected, inherited] |
bool Ogre::GpuProgram::mSkeletalAnimation [protected, inherited] |
Does this (vertex) program include skeletal animation?
Definition at line 1480 of file OgreGpuProgram.h.
bool Ogre::GpuProgram::mMorphAnimation [protected, inherited] |
Does this (vertex) program include morph animation?
Definition at line 1482 of file OgreGpuProgram.h.
ushort Ogre::GpuProgram::mPoseAnimation [protected, inherited] |
Does this (vertex) program include pose animation (count of number of poses supported).
Definition at line 1484 of file OgreGpuProgram.h.
bool Ogre::GpuProgram::mVertexTextureFetch [protected, inherited] |
Does this (vertex) program require support for vertex texture fetch?
Definition at line 1486 of file OgreGpuProgram.h.
bool Ogre::GpuProgram::mNeedsAdjacencyInfo [protected, inherited] |
Does this (geometry) program require adjacency information?
Definition at line 1488 of file OgreGpuProgram.h.
GpuProgramParametersSharedPtr Ogre::GpuProgram::mDefaultParams [protected, inherited] |
bool Ogre::GpuProgram::mPassSurfaceAndLightStates [protected, inherited] |
Does this program want light states passed through fixed pipeline.
Definition at line 1492 of file OgreGpuProgram.h.
bool Ogre::GpuProgram::mCompileError [protected, inherited] |
GpuLogicalBufferStruct Ogre::GpuProgram::mFloatLogicalToPhysical [mutable, protected, inherited] |
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 1497 of file OgreGpuProgram.h.
GpuLogicalBufferStruct Ogre::GpuProgram::mIntLogicalToPhysical [mutable, protected, inherited] |
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 1500 of file OgreGpuProgram.h.
GpuNamedConstants Ogre::GpuProgram::mConstantDefs [mutable, protected, inherited] |
Parameter name -> ConstantDefinition map, shared instance used by all parameter objects.
Definition at line 1502 of file OgreGpuProgram.h.
String Ogre::GpuProgram::mManualNamedConstantsFile [protected, inherited] |
bool Ogre::GpuProgram::mLoadedManualNamedConstants [protected, inherited] |
Definition at line 1505 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] |
AtomicScalar<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 136 of file OgreResource.h.
size_t Ogre::Resource::mSize [protected, inherited] |
bool Ogre::Resource::mIsManual [protected, inherited] |
String Ogre::Resource::mOrigin [protected, inherited] |
Origin of this resource (e.g. script name) - optional.
Definition at line 142 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 144 of file OgreResource.h.
size_t Ogre::Resource::mStateCount [protected, inherited] |
State count, the number of times this resource has changed state.
Definition at line 146 of file OgreResource.h.
ListenerList Ogre::Resource::mListenerList [protected, inherited] |
Definition at line 149 of file OgreResource.h.
Copyright © 2008 Torus Knot Software Ltd
This work is licensed under a Creative Commons Attribution-ShareAlike 2.5 License.
Last modified Sun Sep 27 22:03:40 2009