OGRE  1.11.6
Object-Oriented Graphics Rendering Engine
Ogre::CgProgram Class Reference

Specialisation of HighLevelGpuProgram to provide support for nVidia's CG language. More...

#include <OgreCgProgram.h>

+ Inheritance diagram for Ogre::CgProgram:

Classes

class  CmdArgs
 Command object for setting compilation arguments. More...
 
class  CmdEntryPoint
 Command object for setting entry point. More...
 
class  CmdProfiles
 Command object for setting profiles. More...
 

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...
 

Public Member Functions

 CgProgram (ResourceManager *creator, const String &name, ResourceHandle handle, const String &group, bool isManual, ManualResourceLoader *loader, CGcontext context)
 
 ~CgProgram ()
 
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...
 
GpuProgram_getBindingDelegate ()
 Returns the GpuProgram which should be bound to the pipeline. More...
 
uint32 _getHash (uint32 seed=0) const
 internal method to get the microcode cache id 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...
 
virtual size_t calculateSize (void) const
 Calculate the size of a resource; this will only be called after 'load'. More...
 
virtual void changeGroupOwnership (const String &newGroup)
 Change the resource group ownership of a Resource. More...
 
void copyParametersTo (StringInterface *dest) const
 Method for copying this object's parameters to another object. More...
 
GpuProgramParametersSharedPtr createParameters ()
 Creates a new parameters object compatible with this program definition. More...
 
virtual void escalateLoading ()
 Escalates the loading of a background loaded resource. More...
 
virtual Vector3 getComputeGroupDimensions (void) const
 Returns the number of process groups dispatched by this compute program. More...
 
const GpuNamedConstantsgetConstantDefinitions () const
 Get the full list of GpuConstantDefinition instances. More...
 
ResourceManagergetCreator (void)
 Gets the manager which created this resource. More...
 
GpuProgramParametersSharedPtr getDefaultParameters (void)
 Get a reference to the default parameters which are to be used for all uses of this program. More...
 
const StringgetEntryPoint (void) const
 Gets the entry point defined for this program. More...
 
virtual const StringgetGroup (void) const
 Gets the group which this resource is a member of. More...
 
virtual ResourceHandle getHandle (void) const
 
const StringgetLanguage (void) const
 Overridden from GpuProgram. More...
 
virtual LoadingState getLoadingState () const
 Returns the current loading state. More...
 
const StringgetManualNamedConstantsFile () 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. More...
 
virtual const StringgetName (void) const
 Gets resource name. More...
 
virtual ushort getNumberOfPosesIncluded (void) const
 Returns the number of simultaneous poses the vertex program can blend, for use in pose animation. More...
 
const StringgetOrigin (void) const
 Get the origin of this resource, e.g. More...
 
ParamDictionarygetParamDictionary (void)
 Retrieves the parameter dictionary for this class. More...
 
const ParamDictionarygetParamDictionary (void) const
 
String getParameter (const String &name) const
 Generic parameter retrieval method. More...
 
const ParameterListgetParameters (void) const
 Retrieves a list of parameters valid for this object. More...
 
bool getPassFogStates (void) const
 Returns whether a fragment program wants fog state to be passed through fixed pipeline low level API rendering calls (default true, subclasses can override) More...
 
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 (default false, subclasses can override) More...
 
bool getPassTransformStates (void) const
 Returns whether a vertex program wants transform state to be passed through fixed pipeline low level API rendering calls. More...
 
const StringgetPreprocessorDefines (void) const
 Gets the preprocessor defines used to compile the program. More...
 
const StringVectorgetProfiles (void) const
 Gets the Cg profiles which can be supported by the program. More...
 
size_t getSize (void) const
 Retrieves info about the size of the resource. More...
 
const StringgetSource (void) const
 Gets the assembler source for this program. More...
 
const StringgetSourceFile (void) const
 Gets the name of the file used as source for this program. 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...
 
const StringgetSyntaxCode (void) const
 Gets the syntax code for this program e.g. More...
 
GpuProgramType getType (void) const
 Get the program type. More...
 
bool hasCompileError (void) const
 Did this program encounter a compile error when loading? More...
 
bool hasDefaultParameters (void) const
 Returns true if default parameters have been set up. More...
 
virtual bool isAdjacencyInfoRequired (void) const
 
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...
 
bool isMorphAnimationIncluded (void) const
 Returns whether a vertex program includes the required instructions to perform morph animation. More...
 
bool isPoseAnimationIncluded (void) const
 Returns whether a vertex program includes the required instructions to perform pose animation. 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 isSkeletalAnimationIncluded (void) const
 Returns whether a vertex program includes the required instructions to perform skeletal animation. More...
 
bool isSupported (void) const
 Overridden from GpuProgram. More...
 
bool isVertexTextureFetchRequired (void) const
 Returns whether this vertex program requires support for vertex texture fetch from the hardware. More...
 
virtual void load (bool backgroundThread=false)
 Loads the resource, if it is not already. 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...
 
virtual void removeListener (Listener *lis)
 Remove a listener on this resource. More...
 
void resetCompileError (void)
 Reset a compile error if it occurred, allowing the load to be retried. More...
 
virtual void setAdjacencyInfoRequired (bool r)
 
virtual void setBackgroundLoaded (bool bl)
 Tells the resource whether it is background loaded or not. More...
 
virtual void setComputeGroupDimensions (Vector3 dimensions)
 Sets the number of process groups dispatched by this compute program. More...
 
void setEntryPoint (const String &entryPoint)
 Sets the entry point for this program ie the first method called. More...
 
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. More...
 
void setManualNamedConstantsFile (const String &paramDefFile)
 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. More...
 
virtual void setMorphAnimationIncluded (bool included)
 Sets whether a vertex program includes the required instructions to perform morph animation. More...
 
bool setParameter (const String &name, const String &value)
 Generic parameter setting method. More...
 
void setParameterList (const NameValuePairList &paramList)
 Generic multiple parameter setting method. More...
 
virtual void setPoseAnimationIncluded (ushort poseCount)
 Sets whether a vertex program includes the required instructions to perform pose animation. More...
 
void setPreprocessorDefines (const String &defines)
 Sets the preprocessor defines used to compile the program. More...
 
void setProfiles (const StringVector &profiles)
 Sets the Cg profiles which can be supported by the program. More...
 
virtual void setSkeletalAnimationIncluded (bool included)
 Sets whether a vertex program includes the required instructions to perform skeletal animation. More...
 
void setSource (const String &source)
 Sets the source assembly for this program from an in-memory string. More...
 
void setSourceFile (const String &filename)
 Sets the filename of the source assembly for this program. More...
 
void setSyntaxCode (const String &syntax)
 Sets the syntax code for this program e.g. More...
 
void setType (GpuProgramType t)
 Set the program type (only valid before load) More...
 
virtual void setVertexTextureFetchRequired (bool r)
 Sets whether this vertex program requires support for vertex texture fetch from the hardware. 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 String _resolveIncludes (const String &source, Resource *resourceBeingLoaded, const String &fileName)
 Scan the source for #include and replace with contents from OGRE resources. More...
 
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...
 
static const String getProgramTypeName (GpuProgramType programType)
 

Public Attributes

 OGRE_AUTO_MUTEX
 

Detailed Description

Specialisation of HighLevelGpuProgram to provide support for nVidia's CG language.

Remarks
Cg can be used to compile common, high-level, C-like code down to assembler language for both GL and Direct3D, for multiple graphics cards. You must supply a list of profiles which your program must support using setProfiles() before the program is loaded in order for this to work. The program will then negotiate with the renderer to compile the appropriate program for the API and graphics card capabilities.

Member Enumeration Documentation

◆ LoadingState

Enum identifying the loading state of the resource.

Enumerator
LOADSTATE_UNLOADED 

Not loaded.

LOADSTATE_LOADING 

Loading is in progress.

LOADSTATE_LOADED 

Fully loaded.

LOADSTATE_UNLOADING 

Currently unloading.

LOADSTATE_PREPARED 

Fully prepared.

LOADSTATE_PREPARING 

Preparing is in progress.

◆ LoadingFlags

Enum that allow to choose subset of unloaded/reloaded resources and to adjust reloading behavior.

Enumerator
LF_DEFAULT 

Only reloadable resources are processed, reload restores initial state.

LF_INCLUDE_NON_RELOADABLE 

Process non-reloadable resources too.

LF_ONLY_UNREFERENCED 

Process only resources which are not referenced by any other object. Usefull to reduce resource consumption.

LF_ONLY_UNREFERENCED_INCLUDE_NON_RELOADABLE 

Combination of LF_ONLY_UNREFERENCED and LF_INCLUDE_NON_RELOADABLE.

LF_PRESERVE_STATE 

Preserve some states during reloading, for example stencil shadows prepareness for Meshes.

Constructor & Destructor Documentation

◆ CgProgram()

Ogre::CgProgram::CgProgram ( ResourceManager creator,
const String name,
ResourceHandle  handle,
const String group,
bool  isManual,
ManualResourceLoader loader,
CGcontext  context 
)

◆ ~CgProgram()

Ogre::CgProgram::~CgProgram ( )

Member Function Documentation

◆ setEntryPoint()

void Ogre::CgProgram::setEntryPoint ( const String entryPoint)
inline

Sets the entry point for this program ie the first method called.

◆ getEntryPoint()

const String& Ogre::CgProgram::getEntryPoint ( void  ) const
inline

Gets the entry point defined for this program.

References setProfiles().

◆ setProfiles()

void Ogre::CgProgram::setProfiles ( const StringVector profiles)

Sets the Cg profiles which can be supported by the program.

Referenced by getEntryPoint().

◆ getProfiles()

◆ isSupported()

bool Ogre::CgProgram::isSupported ( void  ) const
virtual

Overridden from GpuProgram.

Reimplemented from Ogre::GpuProgram.

Referenced by getProfiles().

◆ getLanguage()

const String& Ogre::CgProgram::getLanguage ( void  ) const
virtual

Overridden from GpuProgram.

Reimplemented from Ogre::GpuProgram.

Referenced by getProfiles().

◆ createParameters()

GpuProgramParametersSharedPtr Ogre::CgProgram::createParameters ( )
virtual

Creates a new parameters object compatible with this program definition.

Remarks
Unlike low-level assembly programs, parameters objects are specific to the program and therefore must be created from it rather than by the HighLevelGpuProgramManager. This method creates a new instance of a parameters object containing the definition of the parameters this program understands.

Reimplemented from Ogre::HighLevelGpuProgram.

Referenced by getProfiles().

◆ _getBindingDelegate()

GpuProgram* Ogre::CgProgram::_getBindingDelegate ( void  )
virtual

Returns the GpuProgram which should be bound to the pipeline.

Remarks
This method is simply to allow some subclasses of GpuProgram to delegate the program which is bound to the pipeline to a delegate, if required.

Reimplemented from Ogre::HighLevelGpuProgram.

Referenced by getProfiles().

◆ isSkeletalAnimationIncluded()

bool Ogre::CgProgram::isSkeletalAnimationIncluded ( void  ) const
virtual

Returns whether a vertex program includes the required instructions to perform skeletal animation.

Remarks
If this returns true, OGRE will not blend the geometry according to skeletal animation, it will expect the vertex program to do it.

Reimplemented from Ogre::GpuProgram.

Referenced by getProfiles().

◆ isMorphAnimationIncluded()

bool Ogre::CgProgram::isMorphAnimationIncluded ( void  ) const
virtual

Returns whether a vertex program includes the required instructions to perform morph animation.

Remarks
If this returns true, OGRE will not blend the geometry according to morph animation, it will expect the vertex program to do it.

Reimplemented from Ogre::GpuProgram.

Referenced by getProfiles().

◆ isPoseAnimationIncluded()

bool Ogre::CgProgram::isPoseAnimationIncluded ( void  ) const
virtual

Returns whether a vertex program includes the required instructions to perform pose animation.

Remarks
If this returns true, OGRE will not blend the geometry according to pose animation, it will expect the vertex program to do it.

Reimplemented from Ogre::GpuProgram.

Referenced by getProfiles().

◆ isVertexTextureFetchRequired()

bool Ogre::CgProgram::isVertexTextureFetchRequired ( void  ) const
virtual

Returns whether this vertex program requires support for vertex texture fetch from the hardware.

Reimplemented from Ogre::GpuProgram.

Referenced by getProfiles().

◆ getDefaultParameters()

GpuProgramParametersSharedPtr Ogre::CgProgram::getDefaultParameters ( void  )
virtual

Get a reference to the default parameters which are to be used for all uses of this program.

Remarks
A program can be set up with a list of default parameters, which can save time when using a program many times in a material with roughly the same settings. By retrieving the default parameters and populating it with the most used options, any new parameter objects created from this program afterwards will automatically include the default parameters; thus users of the program need only change the parameters which are unique to their own usage of the program.

Reimplemented from Ogre::GpuProgram.

Referenced by getProfiles().

◆ hasDefaultParameters()

bool Ogre::CgProgram::hasDefaultParameters ( void  ) const
virtual

Returns true if default parameters have been set up.

Reimplemented from Ogre::GpuProgram.

Referenced by getProfiles().

◆ getPassSurfaceAndLightStates()

bool Ogre::CgProgram::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 (default false, subclasses can override)

Remarks
Most vertex programs do not need this material information, however GLSL shaders can refer to this material and lighting state so enable this option

Reimplemented from Ogre::GpuProgram.

Referenced by getProfiles().

◆ getPassFogStates()

bool Ogre::CgProgram::getPassFogStates ( void  ) const
virtual

Returns whether a fragment program wants fog state to be passed through fixed pipeline low level API rendering calls (default true, subclasses can override)

Remarks
On DirectX, shader model 2 and earlier continues to have fixed-function fog applied to it, so fog state is still passed (you should disable fog on the pass if you want to perform fog in the shader). In OpenGL it is also common to be able to access the fixed-function fog state inside the shader.

Reimplemented from Ogre::GpuProgram.

Referenced by getProfiles().

◆ getPassTransformStates()

bool Ogre::CgProgram::getPassTransformStates ( void  ) const
virtual

Returns whether a vertex program wants transform state to be passed through fixed pipeline low level API rendering calls.

Remarks
Most vertex programs do not need fixed-function transform information, however GLSL shaders can refer to this state so enable this option

Reimplemented from Ogre::GpuProgram.

Referenced by getProfiles().

◆ hasCompileError()

bool Ogre::CgProgram::hasCompileError ( void  ) const
virtual

Did this program encounter a compile error when loading?

Reimplemented from Ogre::GpuProgram.

Referenced by getProfiles().

◆ resetCompileError()

void Ogre::CgProgram::resetCompileError ( void  )
virtual

Reset a compile error if it occurred, allowing the load to be retried.

Reimplemented from Ogre::GpuProgram.

Referenced by getProfiles().

◆ getSize()

size_t Ogre::CgProgram::getSize ( void  ) const
virtual

Retrieves info about the size of the resource.

Reimplemented from Ogre::Resource.

Referenced by getProfiles().

◆ touch()

void Ogre::CgProgram::touch ( void  )
virtual

'Touches' the resource to indicate it has been used.

Reimplemented from Ogre::Resource.

Referenced by getProfiles().

◆ getConstantDefinitions()

const GpuNamedConstants& Ogre::HighLevelGpuProgram::getConstantDefinitions ( ) const
virtualinherited

Get the full list of GpuConstantDefinition instances.

Note
Only available if this parameters object has named parameters.

Reimplemented from Ogre::GpuProgram.

◆ calculateSize()

virtual size_t Ogre::HighLevelGpuProgram::calculateSize ( void  ) const
virtualinherited

Calculate the size of a resource; this will only be called after 'load'.

Reimplemented from Ogre::GpuProgram.

Reimplemented in Ogre::GLSLESProgram, Ogre::UnifiedHighLevelGpuProgram, and Ogre::GLSLShader.

◆ setPreprocessorDefines()

void Ogre::HighLevelGpuProgram::setPreprocessorDefines ( const String defines)
inlineinherited

Sets the preprocessor defines used to compile the program.

◆ getPreprocessorDefines()

const String& Ogre::HighLevelGpuProgram::getPreprocessorDefines ( void  ) const
inlineinherited

Gets the preprocessor defines used to compile the program.

◆ _resolveIncludes()

static String Ogre::HighLevelGpuProgram::_resolveIncludes ( const String source,
Resource resourceBeingLoaded,
const String fileName 
)
staticinherited

Scan the source for #include and replace with contents from OGRE resources.

◆ getProgramTypeName()

static const String Ogre::GpuProgram::getProgramTypeName ( GpuProgramType  programType)
staticinherited

◆ setSourceFile()

void Ogre::GpuProgram::setSourceFile ( const String filename)
inherited

Sets the filename of the source assembly for this program.

Remarks
Setting this will have no effect until you (re)load the program.

◆ setSource()

void Ogre::GpuProgram::setSource ( const String source)
inherited

Sets the source assembly for this program from an in-memory string.

Remarks
Setting this will have no effect until you (re)load the program.

◆ getSyntaxCode()

const String& Ogre::GpuProgram::getSyntaxCode ( void  ) const
inlineinherited

Gets the syntax code for this program e.g.

arbvp1, fp20, vs_1_1 etc

◆ setSyntaxCode()

void Ogre::GpuProgram::setSyntaxCode ( const String syntax)
inherited

Sets the syntax code for this program e.g.

arbvp1, fp20, vs_1_1 etc

◆ getSourceFile()

const String& Ogre::GpuProgram::getSourceFile ( void  ) const
inlineinherited

Gets the name of the file used as source for this program.

◆ getSource()

const String& Ogre::GpuProgram::getSource ( void  ) const
inlineinherited

Gets the assembler source for this program.

◆ setType()

void Ogre::GpuProgram::setType ( GpuProgramType  t)
inherited

Set the program type (only valid before load)

◆ getType()

GpuProgramType Ogre::GpuProgram::getType ( void  ) const
inlineinherited

Get the program type.

◆ setSkeletalAnimationIncluded()

virtual void Ogre::GpuProgram::setSkeletalAnimationIncluded ( bool  included)
inlinevirtualinherited

Sets whether a vertex program includes the required instructions to perform skeletal animation.

Remarks
If this is set to true, OGRE will not blend the geometry according to skeletal animation, it will expect the vertex program to do it.

◆ setMorphAnimationIncluded()

virtual void Ogre::GpuProgram::setMorphAnimationIncluded ( bool  included)
inlinevirtualinherited

Sets whether a vertex program includes the required instructions to perform morph animation.

Remarks
If this is set to true, OGRE will not blend the geometry according to morph animation, it will expect the vertex program to do it.

◆ setPoseAnimationIncluded()

virtual void Ogre::GpuProgram::setPoseAnimationIncluded ( ushort  poseCount)
inlinevirtualinherited

Sets whether a vertex program includes the required instructions to perform pose animation.

Remarks
If this is set to true, OGRE will not blend the geometry according to pose animation, it will expect the vertex program to do it.
Parameters
poseCountThe number of simultaneous poses the program can blend

◆ getNumberOfPosesIncluded()

virtual ushort Ogre::GpuProgram::getNumberOfPosesIncluded ( void  ) const
inlinevirtualinherited

Returns the number of simultaneous poses the vertex program can blend, for use in pose animation.

Reimplemented in Ogre::UnifiedHighLevelGpuProgram.

◆ setVertexTextureFetchRequired()

virtual void Ogre::GpuProgram::setVertexTextureFetchRequired ( bool  r)
inlinevirtualinherited

Sets whether this vertex program requires support for vertex texture fetch from the hardware.

◆ setAdjacencyInfoRequired()

virtual void Ogre::GpuProgram::setAdjacencyInfoRequired ( bool  r)
inlinevirtualinherited

◆ isAdjacencyInfoRequired()

virtual bool Ogre::GpuProgram::isAdjacencyInfoRequired ( void  ) const
inlinevirtualinherited

◆ setComputeGroupDimensions()

virtual void Ogre::GpuProgram::setComputeGroupDimensions ( Vector3  dimensions)
inlinevirtualinherited

Sets the number of process groups dispatched by this compute program.

◆ getComputeGroupDimensions()

virtual Vector3 Ogre::GpuProgram::getComputeGroupDimensions ( void  ) const
inlinevirtualinherited

Returns the number of process groups dispatched by this compute program.

◆ setManualNamedConstants()

void Ogre::GpuProgram::setManualNamedConstants ( const GpuNamedConstants namedConstants)
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.

Remarks
You may wish to use this if you have assembler programs that were compiled from a high-level source, and want the convenience of still being able to use the named parameters from the original high-level source.
See also
setManualNamedConstantsFile

◆ setManualNamedConstantsFile()

void Ogre::GpuProgram::setManualNamedConstantsFile ( const String paramDefFile)
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.

Remarks
You may wish to use this if you have assembler programs that were compiled from a high-level source, and want the convenience of still being able to use the named parameters from the original high-level source. This method will make a low-level program search in the resource group of the program for the named file from which to load parameter names from. The file must be in the format produced by GpuNamedConstants::save.

◆ getManualNamedConstantsFile()

const String& Ogre::GpuProgram::getManualNamedConstantsFile ( ) const
inlineinherited

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.

◆ _getHash()

uint32 Ogre::GpuProgram::_getHash ( uint32  seed = 0) const
inherited

internal method to get the microcode cache id

◆ prepare()

virtual void Ogre::Resource::prepare ( bool  backgroundThread = false)
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.

Parameters
backgroundThreadWhether this is occurring in a background thread

◆ load()

virtual void Ogre::Resource::load ( bool  backgroundThread = false)
virtualinherited

Loads the resource, if it is not already.

Remarks
If the resource is loaded from a file, loading is automatic. If not, if for example this resource gained it's data from procedural calls rather than loading from a file, then this resource will not reload on it's own.
Parameters
backgroundThreadIndicates whether the caller of this method is the background resource loading thread.

Reimplemented in Ogre::UnifiedHighLevelGpuProgram.

◆ reload()

virtual void Ogre::Resource::reload ( LoadingFlags  flags = LF_DEFAULT)
virtualinherited

Reloads the resource, if it is already loaded.

Remarks
Calls unload() and then load() again, if the resource is already loaded. If it is not loaded already, then nothing happens.

Reimplemented in Ogre::Mesh, and Ogre::UnifiedHighLevelGpuProgram.

◆ isReloadable()

virtual bool Ogre::Resource::isReloadable ( void  ) const
inlinevirtualinherited

Returns true if the Resource is reloadable, false otherwise.

Reimplemented in Ogre::UnifiedHighLevelGpuProgram.

◆ isManuallyLoaded()

virtual bool Ogre::Resource::isManuallyLoaded ( void  ) const
inlinevirtualinherited

Is this resource manually loaded?

◆ unload()

virtual void Ogre::Resource::unload ( void  )
virtualinherited

Unloads the resource; this is not permanent, the resource can be reloaded later if required.

Reimplemented in Ogre::UnifiedHighLevelGpuProgram.

◆ getName()

virtual const String& Ogre::Resource::getName ( void  ) const
inlinevirtualinherited

◆ getHandle()

virtual ResourceHandle Ogre::Resource::getHandle ( void  ) const
inlinevirtualinherited

Reimplemented in Ogre::SkeletonInstance.

◆ isPrepared()

virtual bool Ogre::Resource::isPrepared ( void  ) const
inlinevirtualinherited

Returns true if the Resource has been prepared, false otherwise.

◆ isLoaded()

virtual bool Ogre::Resource::isLoaded ( void  ) const
inlinevirtualinherited

Returns true if the Resource has been loaded, false otherwise.

Reimplemented in Ogre::UnifiedHighLevelGpuProgram.

◆ isLoading()

virtual bool Ogre::Resource::isLoading ( ) const
inlinevirtualinherited

Returns whether the resource is currently in the process of background loading.

Reimplemented in Ogre::UnifiedHighLevelGpuProgram.

◆ getLoadingState()

virtual LoadingState Ogre::Resource::getLoadingState ( ) const
inlinevirtualinherited

Returns the current loading state.

Reimplemented in Ogre::UnifiedHighLevelGpuProgram.

◆ isBackgroundLoaded()

virtual bool Ogre::Resource::isBackgroundLoaded ( void  ) const
inlinevirtualinherited

Returns whether this Resource has been earmarked for background loading.

Remarks
This option only makes sense when you have built Ogre with thread support (OGRE_THREAD_SUPPORT). If a resource has been marked for background loading, then it won't load on demand like normal when load() is called. Instead, it will ignore request to load() except if the caller indicates it is the background loader. Any other users of this resource should check isLoaded(), and if that returns false, don't use the resource and come back later.

Reimplemented in Ogre::UnifiedHighLevelGpuProgram.

◆ setBackgroundLoaded()

virtual void Ogre::Resource::setBackgroundLoaded ( bool  bl)
inlinevirtualinherited

Tells the resource whether it is background loaded or not.

See also
Resource::isBackgroundLoaded. Note that calling this only defers the normal on-demand loading behaviour of a resource, it does not actually set up a thread to make sure the resource gets loaded in the background. You should use ResourceBackgroundLoadingQueue to manage the actual loading (which will call this method itself).

Reimplemented in Ogre::UnifiedHighLevelGpuProgram.

◆ escalateLoading()

virtual void Ogre::Resource::escalateLoading ( )
virtualinherited

Escalates the loading of a background loaded resource.

Remarks
If a resource is set to load in the background, but something needs it before it's been loaded, there could be a problem. If the user of this resource really can't wait, they can escalate the loading which basically pulls the loading into the current thread immediately. If the resource is already being loaded but just hasn't quite finished then this method will simply wait until the background load is complete.

Reimplemented in Ogre::UnifiedHighLevelGpuProgram.

◆ addListener()

virtual void Ogre::Resource::addListener ( Listener lis)
virtualinherited

Register a listener on this resource.

See also
Resource::Listener

Reimplemented in Ogre::UnifiedHighLevelGpuProgram.

◆ removeListener()

virtual void Ogre::Resource::removeListener ( Listener lis)
virtualinherited

Remove a listener on this resource.

See also
Resource::Listener

Reimplemented in Ogre::UnifiedHighLevelGpuProgram.

◆ getGroup()

virtual const String& Ogre::Resource::getGroup ( void  ) const
inlinevirtualinherited

Gets the group which this resource is a member of.

Reimplemented in Ogre::SkeletonInstance.

◆ changeGroupOwnership()

virtual void Ogre::Resource::changeGroupOwnership ( const String newGroup)
virtualinherited

Change the resource group ownership of a Resource.

Remarks
This method is generally reserved for internal use, although if you really know what you're doing you can use it to move this resource from one group to another.
Parameters
newGroupName of the new group

◆ getCreator()

ResourceManager* Ogre::Resource::getCreator ( void  )
inlineinherited

Gets the manager which created this resource.

◆ getOrigin()

const String& Ogre::Resource::getOrigin ( void  ) const
inlineinherited

Get the origin of this resource, e.g.

a script file name.

Remarks
This property will only contain something if the creator of this resource chose to populate it. Script loaders are advised to populate it.

◆ _notifyOrigin()

void Ogre::Resource::_notifyOrigin ( const String origin)
inlineinherited

Notify this resource of it's origin.

◆ getStateCount()

virtual size_t Ogre::Resource::getStateCount ( ) const
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.

◆ _dirtyState()

virtual void Ogre::Resource::_dirtyState ( )
virtualinherited

Manually mark the state of this resource as having been changed.

Remarks
You only need to call this from outside if you explicitly want derived objects to think this object has changed.
See also
getStateCount.

◆ _fireLoadingComplete()

void Ogre::Resource::_fireLoadingComplete ( bool  wasBackgroundLoaded)
inherited

Firing of loading complete event.

Remarks
You should call this from the thread that runs the main frame loop to avoid having to make the receivers of this event thread-safe. If you use Ogre's built in frame loop you don't need to call this yourself.
Parameters
wasBackgroundLoadedWhether this was a background loaded event

◆ _firePreparingComplete()

void Ogre::Resource::_firePreparingComplete ( bool  wasBackgroundLoaded)
inherited

Firing of preparing complete event.

Remarks
You should call this from the thread that runs the main frame loop to avoid having to make the receivers of this event thread-safe. If you use Ogre's built in frame loop you don't need to call this yourself.
Parameters
wasBackgroundLoadedWhether this was a background loaded event

◆ _fireUnloadingComplete()

void Ogre::Resource::_fireUnloadingComplete ( void  )
inherited

Firing of unloading complete event.

Remarks
You should call this from the thread that runs the main frame loop to avoid having to make the receivers of this event thread-safe. If you use Ogre's built in frame loop you don't need to call this yourself.

◆ getParamDictionary() [1/2]

ParamDictionary* Ogre::StringInterface::getParamDictionary ( void  )
inlineinherited

Retrieves the parameter dictionary for this class.

Remarks
Only valid to call this after createParamDictionary.
Returns
Pointer to ParamDictionary shared by all instances of this class which you can add parameters to, retrieve parameters etc.

◆ getParamDictionary() [2/2]

const ParamDictionary* Ogre::StringInterface::getParamDictionary ( void  ) const
inlineinherited

◆ getParameters()

const ParameterList& Ogre::StringInterface::getParameters ( void  ) const
inherited

Retrieves a list of parameters valid for this object.

Returns
A reference to a static list of ParameterDef objects.

◆ setParameter()

bool Ogre::StringInterface::setParameter ( const String name,
const String value 
)
inherited

Generic parameter setting method.

Remarks
Call this method with the name of a parameter and a string version of the value to set. The implementor will convert the string to a native type internally. If in doubt, check the parameter definition in the list returned from StringInterface::getParameters.
Parameters
nameThe name of the parameter to set
valueString value. Must be in the right format for the type specified in the parameter definition. See the StringConverter class for more information.
Returns
true if set was successful, false otherwise (NB no exceptions thrown - tolerant method)

Referenced by Ogre::StringInterface::copyParametersTo().

◆ setParameterList()

void Ogre::StringInterface::setParameterList ( const NameValuePairList paramList)
inherited

Generic multiple parameter setting method.

Remarks
Call this method with a list of name / value pairs to set. The implementor will convert the string to a native type internally. If in doubt, check the parameter definition in the list returned from StringInterface::getParameters.
Parameters
paramListName/value pair list

◆ getParameter()

String Ogre::StringInterface::getParameter ( const String name) const
inlineinherited

Generic parameter retrieval method.

Remarks
Call this method with the name of a parameter to retrieve a string-format value of the parameter in question. If in doubt, check the parameter definition in the list returned from getParameters for the type of this parameter. If you like you can use StringConverter to convert this string back into a native type.
Parameters
nameThe name of the parameter to get
Returns
String value of parameter, blank if not found

References Ogre::ParamCommand::doGet().

◆ copyParametersTo()

void Ogre::StringInterface::copyParametersTo ( StringInterface dest) const
inlineinherited

Method for copying this object's parameters to another object.

Remarks
This method takes the values of all the object's parameters and tries to set the same values on the destination object. This provides a completely type independent way to copy parameters to other objects. Note that because of the String manipulation involved, this should not be regarded as an efficient process and should be saved for times outside of the rendering loop.
Any unrecognised parameters will be ignored as with setParameter method.
Parameters
destPointer to object to have it's parameters set the same as this object.

References Ogre::StringInterface::setParameter().

◆ cleanupDictionary()

static void Ogre::StringInterface::cleanupDictionary ( )
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.

Member Data Documentation

◆ OGRE_AUTO_MUTEX

Ogre::Resource::OGRE_AUTO_MUTEX
inherited

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