Ogre::UnifiedHighLevelGpuProgram Class Reference
Core » Resources

Specialisation of HighLevelGpuProgram which just delegates its implementation to one other high level program, allowing a single program definition to represent one supported program from a number of options. More...

`#include <OgreUnifiedHighLevelGpuProgram.h>`

Inheritance diagram for Ogre::UnifiedHighLevelGpuProgram:
[legend]

## Classes

class | CmdDelegate
| Command object for setting delegate (can set more than once) More...

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

| UnifiedHighLevelGpuProgram (ResourceManager *creator, const String &name, ResourceHandle handle, const String &group, bool isManual=false, ManualResourceLoader *loader=0)
| Constructor, should be used only by factory classes. More...
| ~UnifiedHighLevelGpuProgram ()
virtual void | _dirtyState ()
| Manually mark the state of this resource as having been changed. More...
virtual void | _fireLoadingComplete (bool wasBackgroundLoaded)
| Firing of loading complete event. More...
virtual void | _firePreparingComplete (bool wasBackgroundLoaded)
| Firing of preparing complete event. More...
virtual void | _fireUnloadingComplete (void)
| Firing of unloading complete event. More...
GpuProgram * | _getBindingDelegate (void)
| Returns the GpuProgram which should be bound to the pipeline. More...
const HighLevelGpuProgramPtr & | _getDelegate () const
| Get the chosen delegate. More...
virtual void | _notifyOrigin (const String &origin)
| Notify this resource of it's origin. More...
void | addDelegateProgram (const String &name)
| Adds a new delegate program to the list. More...
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 | clearDelegatePrograms ()
| Remove all delegate programs. More...
virtual void | copyParametersTo (StringInterface *dest) const
| Method for copying this object's parameters to another object. More...
GpuProgramParametersSharedPtr | createParameters (void)
| Creates a new parameters object compatible with this program definition. More...
void | escalateLoading ()
| Escalates the loading of a background loaded resource. More...
const GpuNamedConstants & | getConstantDefinitions () const
| Get the full list of GpuConstantDefinition instances. More...
virtual ResourceManager * | getCreator (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...
virtual const String & | getGroup (void) const
| Gets the group which this resource is a member of. More...
virtual ResourceHandle | getHandle (void) const
const String & | getLanguage (void) const
| Returns a string that specifies the language of the gpu programs as specified in a material script. More...
LoadingState | getLoadingState () const
| Returns the current loading state. More...
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. More...
virtual const String & | getName (void) const
| Gets resource name. More...
const GpuNamedConstants & | getNamedConstants () const
| Override GpuProgram::getNamedConstants to ensure built. More...
virtual ushort | getNumberOfPosesIncluded (void) const
| Returns the number of simultaneous poses the vertex program can blend, for use in pose animation. More...
virtual const String & | getOrigin (void) const
| Get the origin of this resource, e.g. More...
ParamDictionary * | getParamDictionary (void)
| Retrieves the parameter dictionary for this class. More...
const ParamDictionary * | getParamDictionary (void) const
virtual String | getParameter (const String &name) const
| Generic parameter retrieval method. More...
const ParameterList & | getParameters (void) const
| Retrieves a list of parameters valid for this object. More...
bool | 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...
size_t | getSize (void) const
| Retrieves info about the size of the resource. More...
virtual const String & | getSource (void) const
| Gets the assembler source for this program. More...
virtual const String & | getSourceFile (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...
virtual const String & | getSyntaxCode (void) const
| Gets the syntax code for this program e.g. More...
virtual 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
| Returns whether this geometry program requires adjacency information from the input primitives. More...
bool | isBackgroundLoaded (void) const
| Returns whether this Resource has been earmarked for background loading. More...
bool | isLoaded (void) const
| Returns true if the Resource has been loaded, false otherwise. More...
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...
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
| Returns whether this program can be supported on the current renderer and hardware. More...
bool | isVertexTextureFetchRequired (void) const
| Returns whether this vertex program requires support for vertex texture fetch from the hardware. More...
void | load (bool backgroundThread=false)
| Loads the resource, if it is not already. More...
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 *)
void * | operator new (size_t sz, const char *file, int line, const char *func)
| operator new, with debug line info More...
void * | operator new (size_t sz)
void * | operator new (size_t sz, void *ptr)
| placement operator new More...
void * | operator new[] (size_t sz, const char *file, int line, const char *func)
| array operator new, with debug line info More...
void * | operator new[] (size_t sz)
virtual void | prepare (bool backgroundThread=false)
| Prepares the resource for load, if it is not already. More...
void | reload (void)
| Reloads the resource, if it is already loaded. More...
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)
| Sets whether this geometry program requires adjacency information from the input primitives. More...
void | setBackgroundLoaded (bool bl)
| Tells the resource whether it is background loaded or not. More...
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. More...
virtual 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...
virtual bool | setParameter (const String &name, const String &value)
| Generic parameter setting method. More...
virtual 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...
virtual void | setSkeletalAnimationIncluded (bool included)
| Sets whether a vertex program includes the required instructions to perform skeletal animation. More...
virtual void | setSource (const String &source)
| Sets the source assembly for this program from an in-memory string. More...
virtual void | setSourceFile (const String &filename)
| Sets the filename of the source assembly for this program. More...
virtual void | setSyntaxCode (const String &syntax)
| Sets the syntax code for this program e.g. More...
virtual 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...
void | unload (void)
| Unloads the resource; this is not permanent, the resource can be reloaded later if required. More...

## Static Public Member Functions

static void | cleanupDictionary ()
| Cleans up the static 'msDictionary' required to reset Ogre, otherwise the containers are left with invalid pointers, which will lead to a crash as soon as one of the ResourceManager implementers (e.g. More...

## Public Attributes

| OGRE_AUTO_MUTEX

## Protected Types

typedef set< Listener * >::type | ListenerList

## Protected Member Functions

void | buildConstantDefinitions () const
| Build the constant definition map, must be overridden. More...
void | chooseDelegate () const
| Choose the delegate to use. More...
void | createLogicalParameterMappingStructures (bool recreateIfExists=true) const
| Create the internal params logical mapping structures. More...
void | createLowLevelImpl (void)
| Internal method for creating an appropriate low-level program from this high-level program, must be implemented by subclasses. More...
void | createNamedParameterMappingStructures (bool recreateIfExists=true) const
| Create the internal params named mapping structures. More...
bool | createParamDictionary (const String &className)
| Internal method for creating a parameter dictionary for the class, if it does not already exist. More...
void | createParameterMappingStructures (bool recreateIfExists=true) const
| Create the internal params logical & named mapping structures. More...
bool | isRequiredCapabilitiesSupported (void) const
| Internal method returns whether required capabilities for this program is supported. More...
void | loadFromSource (void)
| Virtual method which must be implemented by subclasses, load from mSource. More...
virtual void | loadHighLevel (void)
| Internal load high-level portion if not loaded. More...
virtual void | loadHighLevelImpl (void)
| Internal load implementation, loads just the high-level portion, enough to get parameters. More...
void | loadImpl ()
| Internal implementation of the meat of the 'load' action, only called if this resource is not being loaded from a ManualResourceLoader. More...
| OGRE_MUTEX (mListenerListMutex)
virtual void | populateParameterNames (GpuProgramParametersSharedPtr params)
| Populate the passed parameters with name->index map. More...
virtual void | postLoadImpl (void)
| Internal hook to perform actions after the load process, but before the resource has been marked as fully loaded. More...
virtual void | postUnloadImpl (void)
| Internal hook to perform actions after the unload process, but before the resource has been marked as fully unloaded. More...
virtual void | preLoadImpl (void)
| Internal hook to perform actions before the load process, but after the resource has been marked as 'loading'. More...
virtual void | prepareImpl (void)
| Internal implementation of the meat of the 'prepare' action. More...
virtual void | preUnloadImpl (void)
| Internal hook to perform actions before the unload process. More...
void | setupBaseParamDictionary (void)
| Internal method for setting up the basic parameter definitions for a subclass. More...
virtual void | unloadHighLevel (void)
| Internal unload high-level portion if loaded. More...
void | unloadHighLevelImpl (void)
| Internal unload implementation, must be implemented by subclasses. More...
void | unloadImpl ()
| Internal implementation of the 'unload' action; called regardless of whether this resource is being loaded from a ManualResourceLoader. More...
virtual void | unprepareImpl (void)
| Internal function for undoing the 'prepare' action. More...

## Protected Attributes

GpuProgramPtr | mAssemblerProgram
| The underlying assembler program. More...
HighLevelGpuProgramPtr | mChosenDelegate
| The chosen delegate. More...
bool | mCompileError
| Did we encounter a compilation error? More...
GpuNamedConstantsPtr | mConstantDefs
| Parameter name -> ConstantDefinition map, shared instance used by all parameter objects. More...
bool | mConstantDefsBuilt
| Have we built the name->index parameter map yet? More...
ResourceManager * | mCreator
| Creator. More...
GpuProgramParametersSharedPtr | mDefaultParams
| The default parameters for use with this object. More...
StringVector | mDelegateNames
| Ordered list of potential delegates. More...
GpuLogicalBufferStructPtr | mDoubleLogicalToPhysical
| Record of logical to physical buffer maps. More...
String | mFilename
| The name of the file to load source from (may be blank) More...
GpuLogicalBufferStructPtr | mFloatLogicalToPhysical
| Record of logical to physical buffer maps. More...
String | mGroup
| The name of the resource group. More...
ResourceHandle | mHandle
| Numeric handle for more efficient look up than name. More...
bool | mHighLevelLoaded
| Whether the high-level program (and it's parameter defs) is loaded. More...
GpuLogicalBufferStructPtr | mIntLogicalToPhysical
| Record of logical to physical buffer maps. More...
volatile bool | mIsBackgroundLoaded
| Is this resource going to be background loaded? Only applicable for multithreaded. More...
bool | mIsManual
| Is this file manually loaded? More...
ListenerList | mListenerList
bool | mLoadedManualNamedConstants
ManualResourceLoader * | mLoader
| Optional manual loader; if provided, data is loaded from here instead of a file. More...
bool | mLoadFromFile
| Whether we need to load source from file or not. More...
AtomicScalar< LoadingState > | mLoadingState
| Is the resource currently loaded? More...
String | mManualNamedConstantsFile
| File from which to load named constants manually. More...
bool | mMorphAnimation
| Does this (vertex) program include morph animation? More...
String | mName
| Unique name of the resource. More...
bool | mNeedsAdjacencyInfo
| Does this (geometry) program require adjacency information? More...
String | mOrigin
| Origin of this resource (e.g. script name) - optional. More...
ushort | mPoseAnimation
| Does this (vertex) program include pose animation (count of number of poses supported) More...
size_t | mSize
| The size of the resource in bytes. More...
bool | mSkeletalAnimation
| Does this (vertex) program include skeletal animation? More...
String | mSource
| The assembler source of the program (may be blank until file loaded) More...
size_t | mStateCount
| State count, the number of times this resource has changed state. More...
String | mSyntaxCode
| Syntax code e.g. arbvp1, vs_2_0 etc. More...
GpuProgramType | mType
| The type of the program. More...
bool | mVertexTextureFetch
| Does this (vertex) program require support for vertex texture fetch? More...

## Static Protected Attributes

static CmdAdjacency | msAdjacencyCmd
static CmdDelegate | msCmdDelegate
static CmdManualNamedConstsFile | msManNamedConstsFileCmd
static CmdMorph | msMorphCmd
static CmdPose | msPoseCmd
static CmdSkeletal | msSkeletalCmd
static CmdSyntax | msSyntaxCmd
static CmdType | msTypeCmd
static CmdVTF | msVTFCmd

## Detailed Description

Specialisation of HighLevelGpuProgram which just delegates its implementation to one other high level program, allowing a single program definition to represent one supported program from a number of options.

Remarks
  Whilst you can use Technique to implement several ways to render an object depending on hardware support, if the only reason to need multiple paths is because of the high-level shader language supported, this can be cumbersome. For example you might want to implement the same shader in HLSL and GLSL for portability but apart from the implementation detail, the shaders do the same thing and take the same parameters. If the materials in question are complex, duplicating the techniques just to switch language is not optimal, so instead you can define high-level programs with a syntax of 'unified', and list the actual implementations in order of preference via repeated use of the 'delegate' parameter, which just points at another program name. The first one which has a supported syntax will be used.

Definition at line 60 of file OgreUnifiedHighLevelGpuProgram.h.

## Member Typedef Documentation

## ListenerList

typedef set<Listener*>::type Ogre::Resource::ListenerList

protected inherited

Definition at line 166 of file OgreResource.h.

## Member Enumeration Documentation

## LoadingState

enum Ogre::Resource::LoadingState

inherited

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.

Definition at line 127 of file OgreResource.h.

## Constructor & Destructor Documentation

## UnifiedHighLevelGpuProgram()

Ogre::UnifiedHighLevelGpuProgram::UnifiedHighLevelGpuProgram | ( | ResourceManager * | creator,
|  | const String & | name,
|  | ResourceHandle | handle,
|  | const String & | group,
|  | bool | isManual = `false`,
|  | ManualResourceLoader * | loader = `0`
| ) |  |

Constructor, should be used only by factory classes.

## ~UnifiedHighLevelGpuProgram()

Ogre::UnifiedHighLevelGpuProgram::~UnifiedHighLevelGpuProgram | ( |  | ) |

## Member Function Documentation

## _dirtyState()

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

virtual inherited

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()

virtual void Ogre::Resource::_fireLoadingComplete | ( | bool | wasBackgroundLoaded | ) |

virtual 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

  wasBackgroundLoaded | Whether this was a background loaded event

## _firePreparingComplete()

virtual void Ogre::Resource::_firePreparingComplete | ( | bool | wasBackgroundLoaded | ) |

virtual 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

  wasBackgroundLoaded | Whether this was a background loaded event

## _fireUnloadingComplete()

virtual void Ogre::Resource::_fireUnloadingComplete | ( | void |  | ) |

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

## _getBindingDelegate()

GpuProgram* Ogre::UnifiedHighLevelGpuProgram::_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.

## _getDelegate()

const HighLevelGpuProgramPtr& Ogre::UnifiedHighLevelGpuProgram::_getDelegate | ( |  | ) | const

Get the chosen delegate.

## _notifyOrigin()

virtual void Ogre::Resource::_notifyOrigin | ( | const String & | origin | ) |

virtual inherited

Notify this resource of it's origin.

Definition at line 420 of file OgreResource.h.

## addDelegateProgram()

void Ogre::UnifiedHighLevelGpuProgram::addDelegateProgram | ( | const String & | name | ) |

Adds a new delegate program to the list.

Remarks
  Delegates are tested in order so earlier ones are preferred.

## addListener()

void Ogre::UnifiedHighLevelGpuProgram::addListener | ( | Listener * | lis | ) |

virtual

Register a listener on this resource.

See also
  Resource::Listener

Reimplemented from Ogre::Resource.

## buildConstantDefinitions()

void Ogre::UnifiedHighLevelGpuProgram::buildConstantDefinitions | ( |  | ) | const

protected virtual

Build the constant definition map, must be overridden.

Note
  The implementation must fill in the (inherited) mConstantDefs field at a minimum, and if the program requires that parameters are bound using logical parameter indexes then the mFloatLogicalToPhysical and mIntLogicalToPhysical maps must also be populated.

Implements Ogre::HighLevelGpuProgram.

## calculateSize()

virtual size_t Ogre::UnifiedHighLevelGpuProgram::calculateSize | ( | void |  | ) | const

virtual

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

Reimplemented from Ogre::HighLevelGpuProgram.

## changeGroupOwnership()

virtual void Ogre::Resource::changeGroupOwnership | ( | const String & | newGroup | ) |

virtual inherited

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

  newGroup | Name of the new group

## chooseDelegate()

void Ogre::UnifiedHighLevelGpuProgram::chooseDelegate | ( |  | ) | const

protected

Choose the delegate to use.

## cleanupDictionary()

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.

## clearDelegatePrograms()

void Ogre::UnifiedHighLevelGpuProgram::clearDelegatePrograms | ( |  | ) |

Remove all delegate programs.

## copyParametersTo()

virtual void Ogre::StringInterface::copyParametersTo | ( | StringInterface * | dest | ) | const

virtual inherited

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

  dest | Pointer to object to have it's parameters set the same as this object.

Definition at line 303 of file OgreStringInterface.h.

References Ogre::ParamDictionary::mParamDefs, and Ogre::StringInterface::setParameter().

## createLogicalParameterMappingStructures()

void Ogre::GpuProgram::createLogicalParameterMappingStructures | ( | bool | recreateIfExists = `true` | ) | const

protected inherited

Create the internal params logical mapping structures.

## createLowLevelImpl()

void Ogre::UnifiedHighLevelGpuProgram::createLowLevelImpl | ( | void |  | ) |

protected virtual

Internal method for creating an appropriate low-level program from this high-level program, must be implemented by subclasses.

Implements Ogre::HighLevelGpuProgram.

## createNamedParameterMappingStructures()

void Ogre::GpuProgram::createNamedParameterMappingStructures | ( | bool | recreateIfExists = `true` | ) | const

protected inherited

Create the internal params named mapping structures.

## createParamDictionary()

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.

Remarks
  This method will check to see if a parameter dictionary exist for this class yet, and if not will create one. NB you must supply the name of the class (RTTI is not used or performance).

Parameters

  className | the name of the class using the dictionary

Returns
  true if a new dictionary was created, false if it was already there

Definition at line 186 of file OgreStringInterface.h.

References OGRE_LOCK_MUTEX.

## createParameterMappingStructures()

void Ogre::GpuProgram::createParameterMappingStructures | ( | bool | recreateIfExists = `true` | ) | const

protected inherited

Create the internal params logical & named mapping structures.

## createParameters()

GpuProgramParametersSharedPtr Ogre::UnifiedHighLevelGpuProgram::createParameters | ( | void |  | ) |

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.

## escalateLoading()

void Ogre::UnifiedHighLevelGpuProgram::escalateLoading | ( |  | ) |

virtual

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 from Ogre::Resource.

## getConstantDefinitions()

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

virtual inherited

Get the full list of GpuConstantDefinition instances.

Note
  Only available if this parameters object has named parameters.

Reimplemented from Ogre::GpuProgram.

## getCreator()

virtual ResourceManager* Ogre::Resource::getCreator | ( | void |  | ) |

virtual inherited

Gets the manager which created this resource.

Definition at line 411 of file OgreResource.h.

## getDefaultParameters()

GpuProgramParametersSharedPtr Ogre::UnifiedHighLevelGpuProgram::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.

## getGroup()

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

virtual inherited

Gets the group which this resource is a member of.

Definition at line 399 of file OgreResource.h.

## getHandle()

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

virtual inherited

Reimplemented in Ogre::SkeletonInstance.

Definition at line 317 of file OgreResource.h.

## getLanguage()

const String& Ogre::UnifiedHighLevelGpuProgram::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 from Ogre::GpuProgram.

## getLoadingState()

LoadingState Ogre::UnifiedHighLevelGpuProgram::getLoadingState | ( |  | ) | const

virtual

Returns the current loading state.

Reimplemented from Ogre::Resource.

## getManualNamedConstantsFile()

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 411 of file OgreGpuProgram.h.

## getName()

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

virtual inherited

Gets resource name.

Reimplemented in Ogre::SkeletonInstance.

Definition at line 312 of file OgreResource.h.

Referenced by Ogre::GpuProgramUsage::getProgramName().

## getNamedConstants()

const GpuNamedConstants& Ogre::HighLevelGpuProgram::getNamedConstants | ( |  | ) | const

virtual inherited

Override GpuProgram::getNamedConstants to ensure built.

Reimplemented from Ogre::GpuProgram.

Definition at line 125 of file OgreHighLevelGpuProgram.h.

## getNumberOfPosesIncluded()

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 309 of file OgreGpuProgram.h.

## getOrigin()

virtual const String& Ogre::Resource::getOrigin | ( | void |  | ) | const

virtual inherited

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.

Definition at line 418 of file OgreResource.h.

## getParamDictionary() [1/2]

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

inherited

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.

Definition at line 219 of file OgreStringInterface.h.

## getParamDictionary() [2/2]

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

inherited

Definition at line 224 of file OgreStringInterface.h.

## getParameter()

virtual String Ogre::StringInterface::getParameter | ( | const String & | name | ) | const

virtual inherited

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

  name | The name of the parameter to get

Returns
  String value of parameter, blank if not found

Definition at line 272 of file OgreStringInterface.h.

References Ogre::ParamCommand::doGet(), and Ogre::ParamDictionary::getParamCommand().

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

## getPassFogStates()

bool Ogre::UnifiedHighLevelGpuProgram::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.

## getPassSurfaceAndLightStates()

bool Ogre::UnifiedHighLevelGpuProgram::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.

## getPassTransformStates()

bool Ogre::UnifiedHighLevelGpuProgram::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.

## getSize()

size_t Ogre::UnifiedHighLevelGpuProgram::getSize | ( | void |  | ) | const

virtual

Retrieves info about the size of the resource.

Reimplemented from Ogre::Resource.

## getSource()

virtual const String& Ogre::GpuProgram::getSource | ( | void |  | ) | const

virtual inherited

Gets the assembler source for this program.

Definition at line 231 of file OgreGpuProgram.h.

## getSourceFile()

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 229 of file OgreGpuProgram.h.

## getStateCount()

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 429 of file OgreResource.h.

## getSyntaxCode()

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 223 of file OgreGpuProgram.h.

## getType()

virtual GpuProgramType Ogre::GpuProgram::getType | ( | void |  | ) | const

virtual inherited

Get the program type.

Definition at line 235 of file OgreGpuProgram.h.

## hasCompileError()

bool Ogre::UnifiedHighLevelGpuProgram::hasCompileError | ( | void |  | ) | const

virtual

Did this program encounter a compile error when loading?

Reimplemented from Ogre::GpuProgram.

## hasDefaultParameters()

bool Ogre::UnifiedHighLevelGpuProgram::hasDefaultParameters | ( | void |  | ) | const

virtual

Returns true if default parameters have been set up.

Reimplemented from Ogre::GpuProgram.

## isAdjacencyInfoRequired()

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

virtual inherited

Returns whether this geometry program requires adjacency information from the input primitives.

Definition at line 326 of file OgreGpuProgram.h.

## isBackgroundLoaded()

bool Ogre::UnifiedHighLevelGpuProgram::isBackgroundLoaded | ( | void |  | ) | const

virtual

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 from Ogre::Resource.

## isLoaded()

bool Ogre::UnifiedHighLevelGpuProgram::isLoaded | ( | void |  | ) | const

virtual

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

Reimplemented from Ogre::Resource.

## isLoading()

bool Ogre::UnifiedHighLevelGpuProgram::isLoading | ( |  | ) | const

virtual

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

Reimplemented from Ogre::Resource.

## isManuallyLoaded()

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

virtual inherited

Is this resource manually loaded?

Definition at line 289 of file OgreResource.h.

## isMorphAnimationIncluded()

bool Ogre::UnifiedHighLevelGpuProgram::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.

## isPoseAnimationIncluded()

bool Ogre::UnifiedHighLevelGpuProgram::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.

## isPrepared()

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

virtual inherited

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

Definition at line 324 of file OgreResource.h.

References Ogre::AtomicScalar< T >::get().

## isReloadable()

bool Ogre::UnifiedHighLevelGpuProgram::isReloadable | ( | void |  | ) | const

virtual

Returns true if the Resource is reloadable, false otherwise.

Reimplemented from Ogre::Resource.

## isRequiredCapabilitiesSupported()

bool Ogre::GpuProgram::isRequiredCapabilitiesSupported | ( | void |  | ) | const

protected inherited

Internal method returns whether required capabilities for this program is supported.

## isSkeletalAnimationIncluded()

bool Ogre::UnifiedHighLevelGpuProgram::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.

## isSupported()

bool Ogre::UnifiedHighLevelGpuProgram::isSupported | ( | void |  | ) | const

virtual

Returns whether this program can be supported on the current renderer and hardware.

Reimplemented from Ogre::GpuProgram.

## isVertexTextureFetchRequired()

bool Ogre::UnifiedHighLevelGpuProgram::isVertexTextureFetchRequired | ( | void |  | ) | const

virtual

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

Reimplemented from Ogre::GpuProgram.

## load()

void Ogre::UnifiedHighLevelGpuProgram::load | ( | bool | backgroundThread = `false` | ) |

virtual

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

  backgroundThread | Indicates whether the caller of this method is the background resource loading thread.

Reimplemented from Ogre::Resource.

## loadFromSource()

void Ogre::UnifiedHighLevelGpuProgram::loadFromSource | ( | void |  | ) |

protected virtual

Virtual method which must be implemented by subclasses, load from mSource.

Implements Ogre::GpuProgram.

## loadHighLevel()

virtual void Ogre::HighLevelGpuProgram::loadHighLevel | ( | void |  | ) |

protected virtual inherited

Internal load high-level portion if not loaded.

## loadHighLevelImpl()

virtual void Ogre::HighLevelGpuProgram::loadHighLevelImpl | ( | void |  | ) |

protected virtual inherited

Internal load implementation, loads just the high-level portion, enough to get parameters.

## loadImpl()

void Ogre::HighLevelGpuProgram::loadImpl | ( |  | ) |

protected virtual inherited

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.

## OGRE_MUTEX()

Ogre::Resource::OGRE_MUTEX | ( | mListenerListMutex |  | ) |

protected inherited

## operator delete() [1/3]

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete | ( | void * | ptr | ) |

inherited

Definition at line 96 of file OgreMemoryAllocatedObject.h.

## operator delete() [2/3]

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete | ( | void * | ptr,
|  | void * |
| ) |  |

inherited

Definition at line 102 of file OgreMemoryAllocatedObject.h.

## operator delete() [3/3]

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete | ( | void * | ptr,
|  | const char * | ,
|  | int | ,
|  | const char * |
| ) |  |

inherited

Definition at line 108 of file OgreMemoryAllocatedObject.h.

## operator delete[]() [1/2]

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete[] | ( | void * | ptr | ) |

inherited

Definition at line 113 of file OgreMemoryAllocatedObject.h.

## operator delete[]() [2/2]

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete[] | ( | void * | ptr,
|  | const char * | ,
|  | int | ,
|  | const char * |
| ) |  |

inherited

Definition at line 119 of file OgreMemoryAllocatedObject.h.

## operator new() [1/3]

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new | ( | size_t | sz,
|  | const char * | file,
|  | int | line,
|  | const char * | func
| ) |  |

inherited

operator new, with debug line info

Definition at line 68 of file OgreMemoryAllocatedObject.h.

## operator new() [2/3]

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new | ( | size_t | sz | ) |

inherited

Definition at line 73 of file OgreMemoryAllocatedObject.h.

## operator new() [3/3]

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new | ( | size_t | sz,
|  | void * | ptr
| ) |  |

inherited

placement operator new

Definition at line 79 of file OgreMemoryAllocatedObject.h.

## operator new[]() [1/2]

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new[] | ( | size_t | sz,
|  | const char * | file,
|  | int | line,
|  | const char * | func
| ) |  |

inherited

array operator new, with debug line info

Definition at line 86 of file OgreMemoryAllocatedObject.h.

## operator new[]() [2/2]

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new[] | ( | size_t | sz | ) |

inherited

Definition at line 91 of file OgreMemoryAllocatedObject.h.

## populateParameterNames()

virtual void Ogre::HighLevelGpuProgram::populateParameterNames | ( | GpuProgramParametersSharedPtr | params | ) |

protected virtual inherited

Populate the passed parameters with name->index map.

## postLoadImpl()

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.

Note
  Mutex will have already been acquired by the loading thread. Also, this call will occur even when using a ManualResourceLoader (when loadImpl is not actually called)

Reimplemented in Ogre::Mesh.

Definition at line 191 of file OgreResource.h.

## postUnloadImpl()

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.

Note
  Mutex will have already been acquired by the unloading thread.

Definition at line 201 of file OgreResource.h.

## preLoadImpl()

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

Note
  Mutex will have already been acquired by the loading thread. Also, this call will occur even when using a ManualResourceLoader (when loadImpl is not actually called)

Definition at line 184 of file OgreResource.h.

## prepare()

virtual void Ogre::Resource::prepare | ( | bool | backgroundThread = `false` | ) |

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.

Parameters

  backgroundThread | Whether this is occurring in a background thread

## prepareImpl()

virtual void Ogre::Resource::prepareImpl | ( | void |  | ) |

protected virtual inherited

Internal implementation of the meat of the 'prepare' action.

Reimplemented in Ogre::Mesh, Ogre::Material, and Ogre::PatchMesh.

Definition at line 205 of file OgreResource.h.

## preUnloadImpl()

virtual void Ogre::Resource::preUnloadImpl | ( | void |  | ) |

protected virtual inherited

Internal hook to perform actions before the unload process.

Note
  Mutex will have already been acquired by the unloading thread.

Definition at line 196 of file OgreResource.h.

## reload()

void Ogre::UnifiedHighLevelGpuProgram::reload | ( | void |  | ) |

virtual

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 from Ogre::Resource.

## removeListener()

void Ogre::UnifiedHighLevelGpuProgram::removeListener | ( | Listener * | lis | ) |

virtual

Remove a listener on this resource.

See also
  Resource::Listener

Reimplemented from Ogre::Resource.

## resetCompileError()

void Ogre::UnifiedHighLevelGpuProgram::resetCompileError | ( | void |  | ) |

virtual

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

Reimplemented from Ogre::GpuProgram.

## setAdjacencyInfoRequired()

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

virtual inherited

Sets whether this geometry program requires adjacency information from the input primitives.

Definition at line 322 of file OgreGpuProgram.h.

## setBackgroundLoaded()

void Ogre::UnifiedHighLevelGpuProgram::setBackgroundLoaded | ( | bool | bl | ) |

virtual

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 from Ogre::Resource.

## setManualNamedConstants()

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.

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()

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.

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.

## setMorphAnimationIncluded()

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

virtual inherited

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.

Definition at line 278 of file OgreGpuProgram.h.

## setParameter()

virtual bool Ogre::StringInterface::setParameter | ( | const String & | name,
|  | const String & | value
| ) |  |

virtual 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

  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.

Returns
  true if set was successful, false otherwise (NB no exceptions thrown - tolerant method)

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

## setParameterList()

virtual void Ogre::StringInterface::setParameterList | ( | const NameValuePairList & | paramList | ) |

virtual 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

  paramList | Name/value pair list

## setPoseAnimationIncluded()

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

virtual inherited

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

  poseCount | The number of simultaneous poses the program can blend

Definition at line 288 of file OgreGpuProgram.h.

## setSkeletalAnimationIncluded()

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

virtual inherited

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.

Definition at line 261 of file OgreGpuProgram.h.

## setSource()

virtual void Ogre::GpuProgram::setSource | ( | const String & | source | ) |

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

## setSourceFile()

virtual void Ogre::GpuProgram::setSourceFile | ( | const String & | filename | ) |

virtual inherited

Sets the filename of the source assembly for this program.

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

## setSyntaxCode()

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

## setType()

virtual void Ogre::GpuProgram::setType | ( | GpuProgramType | t | ) |

virtual inherited

Set the program type (only valid before load)

## setupBaseParamDictionary()

void Ogre::GpuProgram::setupBaseParamDictionary | ( | void |  | ) |

protected inherited

Internal method for setting up the basic parameter definitions for a subclass.

Remarks
  Because StringInterface holds a dictionary of parameters per class, subclasses need to call this to ask the base class to add it's parameters to their dictionary as well. Can't do this in the constructor because that runs in a non-virtual context.

  The subclass must have called it's own createParamDictionary before calling this method.

## setVertexTextureFetchRequired()

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 313 of file OgreGpuProgram.h.

## touch()

void Ogre::UnifiedHighLevelGpuProgram::touch | ( | void |  | ) |

virtual

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

Reimplemented from Ogre::Resource.

## unload()

void Ogre::UnifiedHighLevelGpuProgram::unload | ( | void |  | ) |

virtual

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

Reimplemented from Ogre::Resource.

## unloadHighLevel()

virtual void Ogre::HighLevelGpuProgram::unloadHighLevel | ( | void |  | ) |

protected virtual inherited

Internal unload high-level portion if loaded.

## unloadHighLevelImpl()

void Ogre::UnifiedHighLevelGpuProgram::unloadHighLevelImpl | ( | void |  | ) |

protected virtual

Internal unload implementation, must be implemented by subclasses.

Implements Ogre::HighLevelGpuProgram.

## unloadImpl()

void Ogre::HighLevelGpuProgram::unloadImpl | ( |  | ) |

protected virtual inherited

Internal implementation of the 'unload' action; called regardless of whether this resource is being loaded from a ManualResourceLoader.

Implements Ogre::Resource.

## unprepareImpl()

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::Mesh, and Ogre::Material.

Definition at line 210 of file OgreResource.h.

## Member Data Documentation

## mAssemblerProgram

GpuProgramPtr Ogre::HighLevelGpuProgram::mAssemblerProgram

protected inherited

The underlying assembler program.

Definition at line 69 of file OgreHighLevelGpuProgram.h.

## mChosenDelegate

HighLevelGpuProgramPtr Ogre::UnifiedHighLevelGpuProgram::mChosenDelegate

mutable protected

The chosen delegate.

Definition at line 77 of file OgreUnifiedHighLevelGpuProgram.h.

## mCompileError

bool Ogre::GpuProgram::mCompileError

protected inherited

Did we encounter a compilation error?

Definition at line 153 of file OgreGpuProgram.h.

## mConstantDefs

GpuNamedConstantsPtr Ogre::GpuProgram::mConstantDefs

mutable protected inherited

Parameter name -> ConstantDefinition map, shared instance used by all parameter objects.

This is a shared pointer because if the program is recompiled and the parameters change, this definition will alter, but previous params may reference the old def.

Definition at line 173 of file OgreGpuProgram.h.

## mConstantDefsBuilt

bool Ogre::HighLevelGpuProgram::mConstantDefsBuilt

mutable protected inherited

Have we built the name->index parameter map yet?

Definition at line 71 of file OgreHighLevelGpuProgram.h.

## mCreator

ResourceManager* Ogre::Resource::mCreator

protected inherited

Creator.

Definition at line 144 of file OgreResource.h.

## mDefaultParams

GpuProgramParametersSharedPtr Ogre::GpuProgram::mDefaultParams

protected inherited

The default parameters for use with this object.

Definition at line 151 of file OgreGpuProgram.h.

## mDelegateNames

StringVector Ogre::UnifiedHighLevelGpuProgram::mDelegateNames

protected

Ordered list of potential delegates.

Definition at line 75 of file OgreUnifiedHighLevelGpuProgram.h.

## mDoubleLogicalToPhysical

GpuLogicalBufferStructPtr Ogre::GpuProgram::mDoubleLogicalToPhysical

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. This is a shared pointer because if the program is recompiled and the parameters change, this definition will alter, but previous params may reference the old def.

Definition at line 163 of file OgreGpuProgram.h.

## mFilename

String Ogre::GpuProgram::mFilename

protected inherited

The name of the file to load source from (may be blank)

Definition at line 133 of file OgreGpuProgram.h.

## mFloatLogicalToPhysical

GpuLogicalBufferStructPtr 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. This is a shared pointer because if the program is recompiled and the parameters change, this definition will alter, but previous params may reference the old def.

Definition at line 158 of file OgreGpuProgram.h.

## mGroup

String Ogre::Resource::mGroup

protected inherited

The name of the resource group.

Definition at line 148 of file OgreResource.h.

## mHandle

ResourceHandle Ogre::Resource::mHandle

protected inherited

Numeric handle for more efficient look up than name.

Definition at line 150 of file OgreResource.h.

## mHighLevelLoaded

bool Ogre::HighLevelGpuProgram::mHighLevelLoaded

protected inherited

Whether the high-level program (and it's parameter defs) is loaded.

Definition at line 67 of file OgreHighLevelGpuProgram.h.

## mIntLogicalToPhysical

GpuLogicalBufferStructPtr 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. This is a shared pointer because if the program is recompiled and the parameters change, this definition will alter, but previous params may reference the old def.

Definition at line 168 of file OgreGpuProgram.h.

## mIsBackgroundLoaded

volatile bool Ogre::Resource::mIsBackgroundLoaded

protected inherited

Is this resource going to be background loaded? Only applicable for multithreaded.

Definition at line 154 of file OgreResource.h.

## mIsManual

bool Ogre::Resource::mIsManual

protected inherited

Is this file manually loaded?

Definition at line 158 of file OgreResource.h.

## mListenerList

ListenerList Ogre::Resource::mListenerList

protected inherited

Definition at line 167 of file OgreResource.h.

## mLoadedManualNamedConstants

bool Ogre::GpuProgram::mLoadedManualNamedConstants

protected inherited

Definition at line 176 of file OgreGpuProgram.h.

## mLoader

ManualResourceLoader* Ogre::Resource::mLoader

protected inherited

Optional manual loader; if provided, data is loaded from here instead of a file.

Definition at line 162 of file OgreResource.h.

## mLoadFromFile

bool Ogre::GpuProgram::mLoadFromFile

protected inherited

Whether we need to load source from file or not.

Definition at line 137 of file OgreGpuProgram.h.

## mLoadingState

AtomicScalar<LoadingState> Ogre::Resource::mLoadingState

protected inherited

Is the resource currently loaded?

Definition at line 152 of file OgreResource.h.

## mManualNamedConstantsFile

String Ogre::GpuProgram::mManualNamedConstantsFile

protected inherited

File from which to load named constants manually.

Definition at line 175 of file OgreGpuProgram.h.

## mMorphAnimation

bool Ogre::GpuProgram::mMorphAnimation

protected inherited

Does this (vertex) program include morph animation?

Definition at line 143 of file OgreGpuProgram.h.

## mName

String Ogre::Resource::mName

protected inherited

Unique name of the resource.

Definition at line 146 of file OgreResource.h.

## mNeedsAdjacencyInfo

bool Ogre::GpuProgram::mNeedsAdjacencyInfo

protected inherited

Does this (geometry) program require adjacency information?

Definition at line 149 of file OgreGpuProgram.h.

## mOrigin

String Ogre::Resource::mOrigin

protected inherited

Origin of this resource (e.g. script name) - optional.

Definition at line 160 of file OgreResource.h.

## mPoseAnimation

ushort Ogre::GpuProgram::mPoseAnimation

protected inherited

Does this (vertex) program include pose animation (count of number of poses supported)

Definition at line 145 of file OgreGpuProgram.h.

## msAdjacencyCmd

CmdAdjacency Ogre::GpuProgram::msAdjacencyCmd

static protected inherited

Definition at line 129 of file OgreGpuProgram.h.

## msCmdDelegate

CmdDelegate Ogre::UnifiedHighLevelGpuProgram::msCmdDelegate

static protected

Definition at line 72 of file OgreUnifiedHighLevelGpuProgram.h.

## mSize

size_t Ogre::Resource::mSize

protected inherited

The size of the resource in bytes.

Definition at line 156 of file OgreResource.h.

## mSkeletalAnimation

bool Ogre::GpuProgram::mSkeletalAnimation

protected inherited

Does this (vertex) program include skeletal animation?

Definition at line 141 of file OgreGpuProgram.h.

## msManNamedConstsFileCmd

CmdManualNamedConstsFile Ogre::GpuProgram::msManNamedConstsFileCmd

static protected inherited

Definition at line 128 of file OgreGpuProgram.h.

## msMorphCmd

CmdMorph Ogre::GpuProgram::msMorphCmd

static protected inherited

Definition at line 125 of file OgreGpuProgram.h.

## mSource

String Ogre::GpuProgram::mSource

protected inherited

The assembler source of the program (may be blank until file loaded)

Definition at line 135 of file OgreGpuProgram.h.

## msPoseCmd

CmdPose Ogre::GpuProgram::msPoseCmd

static protected inherited

Definition at line 126 of file OgreGpuProgram.h.

## msSkeletalCmd

CmdSkeletal Ogre::GpuProgram::msSkeletalCmd

static protected inherited

Definition at line 124 of file OgreGpuProgram.h.

## msSyntaxCmd

CmdSyntax Ogre::GpuProgram::msSyntaxCmd

static protected inherited

Definition at line 123 of file OgreGpuProgram.h.

## mStateCount

size_t Ogre::Resource::mStateCount

protected inherited

State count, the number of times this resource has changed state.

Definition at line 164 of file OgreResource.h.

## msTypeCmd

CmdType Ogre::GpuProgram::msTypeCmd

static protected inherited

Definition at line 122 of file OgreGpuProgram.h.

## msVTFCmd

CmdVTF Ogre::GpuProgram::msVTFCmd

static protected inherited

Definition at line 127 of file OgreGpuProgram.h.

## mSyntaxCode

String Ogre::GpuProgram::mSyntaxCode

protected inherited

Syntax code e.g. arbvp1, vs_2_0 etc.

Definition at line 139 of file OgreGpuProgram.h.

## mType

GpuProgramType Ogre::GpuProgram::mType

protected inherited

The type of the program.

Definition at line 131 of file OgreGpuProgram.h.

## mVertexTextureFetch

bool Ogre::GpuProgram::mVertexTextureFetch

protected inherited

Does this (vertex) program require support for vertex texture fetch?

Definition at line 147 of file OgreGpuProgram.h.

## OGRE_AUTO_MUTEX

Ogre::Resource::OGRE_AUTO_MUTEX

inherited

Definition at line 82 of file OgreResource.h.

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

- OgreUnifiedHighLevelGpuProgram.h

Copyright © 2012 Torus Knot Software Ltd
This work is licensed under a Creative Commons Attribution-ShareAlike 3.0 Unported License.