Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | File Members | Related Pages

Ogre::UnifiedHighLevelGpuProgram Class Reference

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:

Inheritance graph
[legend]
List of all members.

Public Types

enum  LoadingState { LOADSTATE_UNLOADED, LOADSTATE_LOADING, LOADSTATE_LOADED, LOADSTATE_UNLOADING }
 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.
 ~UnifiedHighLevelGpuProgram ()
void addDelegateProgram (const String &name)
 Adds a new delegate program to the list.
void clearDelegatePrograms ()
 Remove all delegate programs.
const HighLevelGpuProgramPtr_getDelegate () const
 Get the chosen delegate.
const StringgetLanguage (void) const
 ie: asm, cg, hlsl, glsl
GpuProgramParametersSharedPtr createParameters (void)
 Creates a new parameters object compatible with this program definition.
GpuProgram_getBindingDelegate (void)
 
bool isSupported (void) const
 
bool isSkeletalAnimationIncluded (void) const
 
Remarks:
If this returns true, OGRE will not blend the geometry according to skeletal animation, it will expect the vertex program to do it.

bool isMorphAnimationIncluded (void) const
 Returns whether a vertex program includes the required instructions to perform morph animation.
bool isPoseAnimationIncluded (void) const
 Returns whether a vertex program includes the required instructions to perform pose animation.
bool isVertexTextureFetchRequired (void) const
 Returns whether this vertex program requires support for vertex texture fetch from the hardware.
GpuProgramParametersSharedPtr getDefaultParameters (void)
 Get a reference to the default parameters which are to be used for all uses of this program.
bool hasDefaultParameters (void) const
 Returns true if default parameters have been set up.
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.
bool hasCompileError (void) const
 Did this program encounter a compile error when loading?
void resetCompileError (void)
 Reset a compile error if it occurred, allowing the load to be retried.
void load (bool backgroundThread=false)
 Loads the resource, if it is not already.
void reload (void)
 Reloads the resource, if it is already loaded.
bool isReloadable (void) const
 Returns true if the Resource is reloadable, false otherwise.
bool isLoaded (void) const
 Returns true if the Resource has been loaded, false otherwise.
LoadingState isLoading () const
 Returns whether the resource is currently in the process of background loading.
LoadingState getLoadingState () const
 Returns the current loading state.
void unload (void)
 Unloads the resource; this is not permanent, the resource can be reloaded later if required.
size_t getSize (void) const
 Retrieves info about the size of the resource.
void touch (void)
 'Touches' the resource to indicate it has been used.
bool isBackgroundLoaded (void) const
 Returns whether this Resource has been earmarked for background loading.
void setBackgroundLoaded (bool bl)
 Tells the resource whether it is background loaded or not.
void escalateLoading ()
 Escalates the loading of a background loaded resource.
void addListener (Listener *lis)
 Register a listener on this resource.
void removeListener (Listener *lis)
 Remove a listener on this resource.
const GpuNamedConstantsgetConstantDefinitions () const
 Get the full list of GpuConstantDefinition instances.
virtual void setSourceFile (const String &filename)
 Sets the filename of the source assembly for this program.
virtual void setSource (const String &source)
 Sets the source assembly for this program from an in-memory string.
virtual const StringgetSyntaxCode (void) const
 Gets the syntax code for this program e.g.
virtual void setSyntaxCode (const String &syntax)
 Sets the syntax code for this program e.g.
virtual const StringgetSourceFile (void) const
 Gets the name of the file used as source for this program.
virtual const StringgetSource (void) const
 Gets the assembler source for this program.
virtual void setType (GpuProgramType t)
 Set the program type (only valid before load).
virtual GpuProgramType getType (void) const
 Get the program type.
virtual void setSkeletalAnimationIncluded (bool included)
 Sets whether a vertex program includes the required instructions to perform skeletal animation.
virtual void setMorphAnimationIncluded (bool included)
 Sets whether a vertex program includes the required instructions to perform morph animation.
virtual void setPoseAnimationIncluded (ushort poseCount)
 Sets whether a vertex program includes the required instructions to perform pose animation.
virtual ushort getNumberOfPosesIncluded (void) const
 Returns the number of simultaneous poses the vertex program can blend, for use in pose animation.
virtual void setVertexTextureFetchRequired (bool r)
 Sets whether this vertex program requires support for vertex texture fetch from the hardware.
virtual void setSurfaceAndPassLightStates (bool state)
 Sets whether a vertex program requires light and material states to be passed to through fixed pipeline low level API rendering calls.
bool isManuallyLoaded (void) const
 Is this resource manually loaded?
const StringgetName (void) const
 Gets resource name.
ResourceHandle getHandle (void) const
const StringgetGroup (void)
 Gets the group which this resource is a member of.
void changeGroupOwnership (const String &newGroup)
 Change the resource group ownership of a Resource.
ResourceManagergetCreator (void)
 Gets the manager which created this resource.
const StringgetOrigin (void) const
 Get the origin of this resource, e.g.
void _notifyOrigin (const String &origin)
 Notify this resource of it's origin.
ParamDictionarygetParamDictionary (void)
 Retrieves the parameter dictionary for this class.
const ParamDictionarygetParamDictionary (void) const
const ParameterListgetParameters (void) const
 Retrieves a list of parameters valid for this object.
virtual bool setParameter (const String &name, const String &value)
 Generic parameter setting method.
virtual void setParameterList (const NameValuePairList &paramList)
 Generic multiple parameter setting method.
virtual String getParameter (const String &name) const
 Generic parameter retrieval method.
virtual void copyParametersTo (StringInterface *dest) const
 Method for copying this object's parameters to another object.

Static Public Member Functions

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

Protected Types

typedef std::list< Listener * > ListenerList

Protected Member Functions

void chooseDelegate () const
 Choose the delegate to use.
void createLowLevelImpl (void)
 Internal method for creating an appropriate low-level program from this high-level program, must be implemented by subclasses.
void unloadHighLevelImpl (void)
 Internal unload implementation, must be implemented by subclasses.
void buildConstantDefinitions () const
 Build the constant definition map, must be overridden.
void loadFromSource (void)
 Virtual method which must be implemented by subclasses, load from mSource.
virtual void loadHighLevel (void)
 Internal load high-level portion if not loaded.
virtual void unloadHighLevel (void)
 Internal unload high-level portion if loaded.
virtual void loadHighLevelImpl (void)
 Internal load implementation, loads just the high-level portion, enough to get parameters.
virtual void populateParameterNames (GpuProgramParametersSharedPtr params)
 Populate the passed parameters with name->index map.
void loadImpl ()
 
void unloadImpl ()
 
void setupBaseParamDictionary (void)
 Internal method for setting up the basic parameter definitions for a subclass.
bool isRequiredCapabilitiesSupported (void) const
 Internal method returns whether required capabilities for this program is supported.
size_t calculateSize (void) const
 
virtual void preLoadImpl (void)
 Internal hook to perform actions before the load process, but after the resource has been marked as 'loading'.
virtual void postLoadImpl (void)
 Internal hook to perform actions after the load process, but before the resource has been marked as fully loaded.
virtual void preUnloadImpl (void)
 Internal hook to perform actions before the unload process.
virtual void postUnloadImpl (void)
 Internal hook to perform actions after the unload process, but before the resource has been marked as fully unloaded.
virtual void queueFireBackgroundLoadingComplete (void)
 Queue the firing of background loading complete event.
bool createParamDictionary (const String &className)
 Internal method for creating a parameter dictionary for the class, if it does not already exist.

Protected Attributes

StringVector mDelegateNames
 Ordered list of potential delegates.
HighLevelGpuProgramPtr mChosenDelegate
 The chosen delegate.
bool mHighLevelLoaded
 Whether the high-level program (and it's parameter defs) is loaded.
GpuProgramPtr mAssemblerProgram
 The underlying assembler program.
bool mConstantDefsBuilt
 Have we built the name->index parameter map yet?
GpuNamedConstants mConstantDefs
 Parameter name -> ConstantDefinition map, shared instance used by all parameter objects.
GpuProgramType mType
 The type of the program.
String mFilename
 The name of the file to load source from (may be blank).
String mSource
 The assembler source of the program (may be blank until file loaded).
bool mLoadFromFile
 Whether we need to load source from file or not.
String mSyntaxCode
 Syntax code eg arbvp1, vs_2_0 etc.
bool mSkeletalAnimation
 Does this (vertex) program include skeletal animation?
bool mMorphAnimation
 Does this (vertex) program include morph animation?
ushort mPoseAnimation
 Does this (vertex) program include pose animation (count of number of poses supported).
bool mVertexTextureFetch
 Does this (vertex) program require support for vertex texture fetch?
GpuProgramParametersSharedPtr mDefaultParams
 The default parameters for use with this object.
bool mPassSurfaceAndLightStates
 Does this program want light states passed through fixed pipeline.
bool mCompileError
 Did we encounter a compilation error?
GpuLogicalBufferStruct mFloatLogicalToPhysical
 Record of logical to physical buffer maps.
GpuLogicalBufferStruct mIntLogicalToPhysical
 Record of logical to physical buffer maps.
ResourceManagermCreator
 Creator.
String mName
 Unique name of the resource.
String mGroup
 The name of the resource group.
ResourceHandle mHandle
 Numeric handle for more efficient look up than name.
volatile LoadingState mLoadingState
 Is the resource currently loaded?
volatile bool mIsBackgroundLoaded
 Is this resource going to be background loaded? Only applicable for multithreaded.
size_t mSize
 Mutex to cover the status of loading The size of the resource in bytes.
bool mIsManual
 Is this file manually loaded?
String mOrigin
 Origin of this resource (e.g. script name) - optional.
ManualResourceLoadermLoader
 Optional manual loader; if provided, data is loaded from here instead of a file.
ListenerList mListenerList
String mParamDictName
 Class name for this instance to be used as a lookup (must be initialised by subclasses).

Static Protected Attributes

static CmdDelegate msCmdDelegate
static CmdType msTypeCmd
static CmdSyntax msSyntaxCmd
static CmdSkeletal msSkeletalCmd
static CmdMorph msMorphCmd
static CmdPose msPoseCmd
static CmdVTF msVTFCmd
static ParamDictionaryMap msDictionary
 Dictionary of parameters.

Classes

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

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 55 of file OgreUnifiedHighLevelGpuProgram.h.


Member Typedef Documentation

typedef std::list<Listener*> Ogre::Resource::ListenerList [protected, inherited]
 

Definition at line 131 of file OgreResource.h.


Member Enumeration Documentation

enum Ogre::Resource::LoadingState [inherited]
 

Enum identifying the loading state of the resource.

Enumeration values:
LOADSTATE_UNLOADED  Not loaded.
LOADSTATE_LOADING  Loading is in progress.
LOADSTATE_LOADED  Fully loaded.
LOADSTATE_UNLOADING  Currently unloading.

Definition at line 96 of file OgreResource.h.


Constructor & Destructor Documentation

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.

Ogre::UnifiedHighLevelGpuProgram::~UnifiedHighLevelGpuProgram  ) 
 


Member Function Documentation

GpuProgram* Ogre::UnifiedHighLevelGpuProgram::_getBindingDelegate void   )  [virtual]
 

Reimplemented from Ogre::HighLevelGpuProgram.

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

Get the chosen delegate.

void Ogre::Resource::_notifyOrigin const String origin  )  [inherited]
 

Notify this resource of it's origin.

Definition at line 357 of file OgreResource.h.

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.

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

Register a listener on this resource.

See also:
Resource::Listener

Reimplemented from Ogre::Resource.

void Ogre::UnifiedHighLevelGpuProgram::buildConstantDefinitions  )  const [protected, virtual]
 

Build the constant definition map, must be overridden.

Note:
The implementation must fill in the 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.

size_t Ogre::GpuProgram::calculateSize void   )  const [protected, virtual, inherited]
 

Implements Ogre::Resource.

Definition at line 1402 of file OgreGpuProgram.h.

void Ogre::Resource::changeGroupOwnership const String newGroup  )  [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

void Ogre::UnifiedHighLevelGpuProgram::chooseDelegate  )  const [protected]
 

Choose the delegate to use.

static void Ogre::StringInterface::cleanupDictionary  )  [static, inherited]
 

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

MaterialManager) initializes.

void Ogre::UnifiedHighLevelGpuProgram::clearDelegatePrograms  ) 
 

Remove all delegate programs.

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 300 of file OgreStringInterface.h.

References Ogre::ParamDictionary::mParamDefs.

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.

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 176 of file OgreStringInterface.h.

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.

void Ogre::UnifiedHighLevelGpuProgram::escalateLoading  ) 
 

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.

const GpuNamedConstants& Ogre::HighLevelGpuProgram::getConstantDefinitions  )  const [inherited]
 

Get the full list of GpuConstantDefinition instances.

Note:
Only available if this parameters object has named parameters.

ResourceManager* Ogre::Resource::getCreator void   )  [inherited]
 

Gets the manager which created this resource.

Definition at line 348 of file OgreResource.h.

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.

const String& Ogre::Resource::getGroup void   )  [inherited]
 

Gets the group which this resource is a member of.

Reimplemented in Ogre::SkeletonInstance.

Definition at line 336 of file OgreResource.h.

ResourceHandle Ogre::Resource::getHandle void   )  const [inherited]
 

Reimplemented in Ogre::SkeletonInstance.

Definition at line 262 of file OgreResource.h.

const String& Ogre::UnifiedHighLevelGpuProgram::getLanguage void   )  const [virtual]
 

ie: asm, cg, hlsl, glsl

Reimplemented from Ogre::GpuProgram.

LoadingState Ogre::UnifiedHighLevelGpuProgram::getLoadingState  )  const
 

Returns the current loading state.

Reimplemented from Ogre::Resource.

const String& Ogre::Resource::getName void   )  const [inherited]
 

Gets resource name.

Reimplemented in Ogre::SkeletonInstance.

Definition at line 257 of file OgreResource.h.

virtual ushort Ogre::GpuProgram::getNumberOfPosesIncluded void   )  const [virtual, inherited]
 

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

Definition at line 1512 of file OgreGpuProgram.h.

const String& Ogre::Resource::getOrigin void   )  const [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 355 of file OgreResource.h.

const ParamDictionary* Ogre::StringInterface::getParamDictionary void   )  const [inherited]
 

Definition at line 213 of file OgreStringInterface.h.

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 200 of file OgreStringInterface.h.

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 269 of file OgreStringInterface.h.

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

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.

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.

Reimplemented from Ogre::GpuProgram.

size_t Ogre::UnifiedHighLevelGpuProgram::getSize void   )  const
 

Retrieves info about the size of the resource.

Reimplemented from Ogre::Resource.

virtual const String& Ogre::GpuProgram::getSource void   )  const [virtual, inherited]
 

Gets the assembler source for this program.

Definition at line 1434 of file OgreGpuProgram.h.

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

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

virtual GpuProgramType Ogre::GpuProgram::getType void   )  const [virtual, inherited]
 

Get the program type.

Definition at line 1438 of file OgreGpuProgram.h.

bool Ogre::UnifiedHighLevelGpuProgram::hasCompileError void   )  const [virtual]
 

Did this program encounter a compile error when loading?

Reimplemented from Ogre::GpuProgram.

bool Ogre::UnifiedHighLevelGpuProgram::hasDefaultParameters void   )  const [virtual]
 

Returns true if default parameters have been set up.

Reimplemented from Ogre::GpuProgram.

bool Ogre::UnifiedHighLevelGpuProgram::isBackgroundLoaded void   )  const
 

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.

bool Ogre::UnifiedHighLevelGpuProgram::isLoaded void   )  const
 

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

Reimplemented from Ogre::Resource.

LoadingState Ogre::UnifiedHighLevelGpuProgram::isLoading  )  const
 

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

Reimplemented from Ogre::Resource.

bool Ogre::Resource::isManuallyLoaded void   )  const [inherited]
 

Is this resource manually loaded?

Definition at line 234 of file OgreResource.h.

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.

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.

bool Ogre::UnifiedHighLevelGpuProgram::isReloadable void   )  const
 

Returns true if the Resource is reloadable, false otherwise.

Reimplemented from Ogre::Resource.

bool Ogre::GpuProgram::isRequiredCapabilitiesSupported void   )  const [protected, inherited]
 

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

bool Ogre::UnifiedHighLevelGpuProgram::isSkeletalAnimationIncluded void   )  const [virtual]
 

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.

bool Ogre::UnifiedHighLevelGpuProgram::isSupported void   )  const [virtual]
 

Reimplemented from Ogre::GpuProgram.

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.

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.

void Ogre::UnifiedHighLevelGpuProgram::loadFromSource void   )  [protected, virtual]
 

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

Implements Ogre::GpuProgram.

virtual void Ogre::HighLevelGpuProgram::loadHighLevel void   )  [protected, virtual, inherited]
 

Internal load high-level portion if not loaded.

virtual void Ogre::HighLevelGpuProgram::loadHighLevelImpl void   )  [protected, virtual, inherited]
 

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

void Ogre::HighLevelGpuProgram::loadImpl  )  [protected, virtual, inherited]
 

Reimplemented from Ogre::GpuProgram.

virtual void Ogre::HighLevelGpuProgram::populateParameterNames GpuProgramParametersSharedPtr  params  )  [protected, virtual, inherited]
 

Populate the passed parameters with name->index map.

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

virtual void Ogre::Resource::postUnloadImpl void   )  [protected, virtual, inherited]
 

Internal hook to perform actions after the unload process, but before the resource has been marked as fully unloaded.

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

Definition at line 165 of file OgreResource.h.

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

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

virtual void Ogre::Resource::queueFireBackgroundLoadingComplete void   )  [protected, virtual, inherited]
 

Queue the firing of background loading complete event.

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.

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

Remove a listener on this resource.

See also:
Resource::Listener

Reimplemented from Ogre::Resource.

void Ogre::UnifiedHighLevelGpuProgram::resetCompileError void   )  [virtual]
 

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

Reimplemented from Ogre::GpuProgram.

void Ogre::UnifiedHighLevelGpuProgram::setBackgroundLoaded bool  bl  ) 
 

Tells the resource whether it is background loaded or not.

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

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

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)

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

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

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

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.

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.

virtual void Ogre::GpuProgram::setSurfaceAndPassLightStates bool  state  )  [virtual, inherited]
 

Sets whether a vertex program requires light and material states to be passed to through fixed pipeline low level API rendering calls.

Remarks:
If this is set to true, OGRE will pass all active light states to the fixed function pipeline. This is useful for high level shaders like GLSL that can read the OpenGL light and material states. This way the user does not have to use autoparameters to pass light position, color etc.

Definition at line 1546 of file OgreGpuProgram.h.

virtual void Ogre::GpuProgram::setSyntaxCode const String syntax  )  [virtual, inherited]
 

Sets the syntax code for this program e.g.

arbvp1, fp20, vs_1_1 etc

virtual void Ogre::GpuProgram::setType GpuProgramType  t  )  [virtual, inherited]
 

Set the program type (only valid before load).

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.

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

void Ogre::UnifiedHighLevelGpuProgram::touch void   )  [virtual]
 

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

Reimplemented from Ogre::Resource.

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.

virtual void Ogre::HighLevelGpuProgram::unloadHighLevel void   )  [protected, virtual, inherited]
 

Internal unload high-level portion if loaded.

void Ogre::UnifiedHighLevelGpuProgram::unloadHighLevelImpl void   )  [protected, virtual]
 

Internal unload implementation, must be implemented by subclasses.

Implements Ogre::HighLevelGpuProgram.

void Ogre::HighLevelGpuProgram::unloadImpl  )  [protected, virtual, inherited]
 

Implements Ogre::Resource.


Member Data Documentation

GpuProgramPtr Ogre::HighLevelGpuProgram::mAssemblerProgram [protected, inherited]
 

The underlying assembler program.

Definition at line 64 of file OgreHighLevelGpuProgram.h.

HighLevelGpuProgramPtr Ogre::UnifiedHighLevelGpuProgram::mChosenDelegate [mutable, protected]
 

The chosen delegate.

Definition at line 72 of file OgreUnifiedHighLevelGpuProgram.h.

bool Ogre::GpuProgram::mCompileError [protected, inherited]
 

Did we encounter a compilation error?

Definition at line 1379 of file OgreGpuProgram.h.

GpuNamedConstants Ogre::HighLevelGpuProgram::mConstantDefs [mutable, protected, inherited]
 

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

Definition at line 68 of file OgreHighLevelGpuProgram.h.

bool Ogre::HighLevelGpuProgram::mConstantDefsBuilt [mutable, protected, inherited]
 

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

Definition at line 66 of file OgreHighLevelGpuProgram.h.

ResourceManager* Ogre::Resource::mCreator [protected, inherited]
 

Creator.

Definition at line 109 of file OgreResource.h.

GpuProgramParametersSharedPtr Ogre::GpuProgram::mDefaultParams [protected, inherited]
 

The default parameters for use with this object.

Definition at line 1375 of file OgreGpuProgram.h.

StringVector Ogre::UnifiedHighLevelGpuProgram::mDelegateNames [protected]
 

Ordered list of potential delegates.

Definition at line 70 of file OgreUnifiedHighLevelGpuProgram.h.

String Ogre::GpuProgram::mFilename [protected, inherited]
 

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

Definition at line 1359 of file OgreGpuProgram.h.

GpuLogicalBufferStruct Ogre::GpuProgram::mFloatLogicalToPhysical [mutable, protected, inherited]
 

Record of logical to physical buffer maps.

Mandatory for low-level programs or high-level programs which set their params the same way.

Definition at line 1382 of file OgreGpuProgram.h.

String Ogre::Resource::mGroup [protected, inherited]
 

The name of the resource group.

Definition at line 113 of file OgreResource.h.

ResourceHandle Ogre::Resource::mHandle [protected, inherited]
 

Numeric handle for more efficient look up than name.

Definition at line 115 of file OgreResource.h.

bool Ogre::HighLevelGpuProgram::mHighLevelLoaded [protected, inherited]
 

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

Definition at line 62 of file OgreHighLevelGpuProgram.h.

GpuLogicalBufferStruct Ogre::GpuProgram::mIntLogicalToPhysical [mutable, protected, inherited]
 

Record of logical to physical buffer maps.

Mandatory for low-level programs or high-level programs which set their params the same way.

Definition at line 1385 of file OgreGpuProgram.h.

volatile bool Ogre::Resource::mIsBackgroundLoaded [protected, inherited]
 

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

Definition at line 119 of file OgreResource.h.

bool Ogre::Resource::mIsManual [protected, inherited]
 

Is this file manually loaded?

Definition at line 125 of file OgreResource.h.

ListenerList Ogre::Resource::mListenerList [protected, inherited]
 

Definition at line 132 of file OgreResource.h.

ManualResourceLoader* Ogre::Resource::mLoader [protected, inherited]
 

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

Definition at line 129 of file OgreResource.h.

bool Ogre::GpuProgram::mLoadFromFile [protected, inherited]
 

Whether we need to load source from file or not.

Definition at line 1363 of file OgreGpuProgram.h.

volatile LoadingState Ogre::Resource::mLoadingState [protected, inherited]
 

Is the resource currently loaded?

Definition at line 117 of file OgreResource.h.

bool Ogre::GpuProgram::mMorphAnimation [protected, inherited]
 

Does this (vertex) program include morph animation?

Definition at line 1369 of file OgreGpuProgram.h.

String Ogre::Resource::mName [protected, inherited]
 

Unique name of the resource.

Definition at line 111 of file OgreResource.h.

String Ogre::Resource::mOrigin [protected, inherited]
 

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

Definition at line 127 of file OgreResource.h.

String Ogre::StringInterface::mParamDictName [protected, inherited]
 

Class name for this instance to be used as a lookup (must be initialised by subclasses).

Definition at line 164 of file OgreStringInterface.h.

bool Ogre::GpuProgram::mPassSurfaceAndLightStates [protected, inherited]
 

Does this program want light states passed through fixed pipeline.

Definition at line 1377 of file OgreGpuProgram.h.

ushort Ogre::GpuProgram::mPoseAnimation [protected, inherited]
 

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

Definition at line 1371 of file OgreGpuProgram.h.

CmdDelegate Ogre::UnifiedHighLevelGpuProgram::msCmdDelegate [static, protected]
 

Definition at line 67 of file OgreUnifiedHighLevelGpuProgram.h.

ParamDictionaryMap Ogre::StringInterface::msDictionary [static, protected, inherited]
 

Dictionary of parameters.

Definition at line 161 of file OgreStringInterface.h.

size_t Ogre::Resource::mSize [protected, inherited]
 

Mutex to cover the status of loading The size of the resource in bytes.

Definition at line 123 of file OgreResource.h.

bool Ogre::GpuProgram::mSkeletalAnimation [protected, inherited]
 

Does this (vertex) program include skeletal animation?

Definition at line 1367 of file OgreGpuProgram.h.

CmdMorph Ogre::GpuProgram::msMorphCmd [static, protected, inherited]
 

Definition at line 1352 of file OgreGpuProgram.h.

String Ogre::GpuProgram::mSource [protected, inherited]
 

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

Definition at line 1361 of file OgreGpuProgram.h.

CmdPose Ogre::GpuProgram::msPoseCmd [static, protected, inherited]
 

Definition at line 1353 of file OgreGpuProgram.h.

CmdSkeletal Ogre::GpuProgram::msSkeletalCmd [static, protected, inherited]
 

Definition at line 1351 of file OgreGpuProgram.h.

CmdSyntax Ogre::GpuProgram::msSyntaxCmd [static, protected, inherited]
 

Definition at line 1350 of file OgreGpuProgram.h.

CmdType Ogre::GpuProgram::msTypeCmd [static, protected, inherited]
 

Definition at line 1349 of file OgreGpuProgram.h.

CmdVTF Ogre::GpuProgram::msVTFCmd [static, protected, inherited]
 

Definition at line 1354 of file OgreGpuProgram.h.

String Ogre::GpuProgram::mSyntaxCode [protected, inherited]
 

Syntax code eg arbvp1, vs_2_0 etc.

Definition at line 1365 of file OgreGpuProgram.h.

GpuProgramType Ogre::GpuProgram::mType [protected, inherited]
 

The type of the program.

Definition at line 1357 of file OgreGpuProgram.h.

bool Ogre::GpuProgram::mVertexTextureFetch [protected, inherited]
 

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

Definition at line 1373 of file OgreGpuProgram.h.


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

Copyright © 2000-2005 by The OGRE Team
Creative Commons License
This work is licensed under a Creative Commons Attribution-ShareAlike 2.5 License.
Last modified Sun Jul 8 15:25:39 2007