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

Ogre::GpuProgram Class Reference

Defines a program which runs on the GPU such as a vertex or fragment program. More...

#include <OgreGpuProgram.h>

Inheritance diagram for Ogre::GpuProgram:

Ogre::Resource Ogre::StringInterface Ogre::D3D7GpuProgram Ogre::D3D9GpuProgram Ogre::GLGpuProgram Ogre::HighLevelGpuProgram Ogre::D3D9GpuFragmentProgram Ogre::D3D9GpuVertexProgram Ogre::GLArbGpuProgram Ogre::GLGpuNvparseProgram Ogre::GLSLGpuProgram Ogre::CgProgram Ogre::D3D9HLSLProgram Ogre::GLSLProgram List of all members.

Public Member Functions

 GpuProgram (ResourceManager *creator, const String &name, ResourceHandle handle, const String &group, bool isManual=false, ManualResourceLoader *loader=0)
virtual ~GpuProgram ()
virtual void setSourceFile (const String &filename)
 Sets the filename of the source assembly for this program.

virtual void setSource (const String &source)
 Sets the source assembly for this program from an in-memory string.

virtual const String & getSyntaxCode (void) const
 Gets the syntax code for this program e.g.

virtual void setSyntaxCode (const String &syntax)
 Sets the syntax code for this program e.g.

virtual const String & getSourceFile (void) const
 Gets the name of the file used as source for this program.

virtual const String & getSource (void) const
 Gets the assembler source for this program.

virtual void setType (GpuProgramType t)
 Set the program type (only valid before load).

virtual GpuProgramType getType (void) const
 Get the program type.

virtual GpuProgram * _getBindingDelegate (void)
 Returns the GpuProgram which should be bound to the pipeline.

virtual bool isSupported (void) const
 Returns whether this program can be supported on the current renderer and hardware.

virtual GpuProgramParametersSharedPtr createParameters (void)
 Creates a new parameters object compatible with this program definition.

virtual void setSkeletalAnimationIncluded (bool included)
 Sets whether a vertex program includes the required instructions to perform skeletal animation.

virtual bool isSkeletalAnimationIncluded (void) const
 Returns whether a vertex program includes the required instructions to perform skeletal animation.

virtual GpuProgramParametersSharedPtr getDefaultParameters (void)
 Get a reference to the default parameters which are to be used for all uses of this program.

virtual void setSurfaceAndPassLightStates (bool state)
 Sets whether a vertex program requires light and material states to be passed to through fixed pipeline low level API rendering calls.

virtual bool getPassSurfaceAndLightStates (void) const
 Returns whether a vertex program wants light and material states to be passed through fixed pipeline low level API rendering calls.

virtual void load (void)
 Loads the resource, if it is not already.

virtual void reload (void)
 Reloads the resource, if it is already loaded.

bool isReloadable (void) const
 Returns true if the Resource is reloadable, false otherwise.

bool isManuallyLoaded (void) const
 Is this resource manually loaded?

virtual void unload (void)
 Unloads the resource; this is not permanent, the resource can be reloaded later if required.

size_t getSize (void) const
 Retrieves info about the size of the resource.

virtual void touch (void)
 'Touches' the resource to indicate it has been used.

const String & getName (void) const
 Gets resource name.

ResourceHandle getHandle (void) const
bool isLoaded (void) const
 Returns true if the Resource has been loaded, false otherwise.

const String & getGroup (void)
 Gets the group which this resource is a member of.

ResourceManager * getCreator (void)
 Gets the manager which created this resource.

const String & getOrigin (void) const
 Get the origin of this resource, e.g.

void _notifyOrigin (const String &origin)
 Notify this resource of it's origin.

ParamDictionary * getParamDictionary (void)
 Retrieves the parameter dictionary for this class.

const ParamDictionary * getParamDictionary (void) const
const ParameterList & getParameters (void) const
 Retrieves a list of parameters valid for this object.

virtual bool setParameter (const String &name, const String &value)
 Generic parameter setting method.

virtual void setParameterList (const NameValuePairList &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

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 Member Functions

void setupBaseParamDictionary (void)
 Internal method for setting up the basic parameter definitions for a subclass.

size_t calculateSize (void) const
 

void loadImpl (void)
 

virtual void loadFromSource (void)=0
 Virtual method which must be implemented by subclasses, load from mSource.

virtual void unloadImpl (void)=0
 Internal implementation of the 'unload' action; called regardless of whether this resource is being loaded from a ManualResourceLoader.

bool createParamDictionary (const String &className)
 Internal method for creating a parameter dictionary for the class, if it does not already exist.


Protected Attributes

GpuProgramType mType
 The type of the program.

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

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

bool mLoadFromFile
 Whether we need to load source from file or not.

String mSyntaxCode
 Syntax code eg arbvp1, vs_2_0 etc.

bool mSkeletalAnimation
 Does this (vertex) program include skeletal animation?

GpuProgramParametersSharedPtr mDefaultParams
 The default parameters for use with this object.

bool mPassSurfaceAndLightStates
 Does this program want light states passed through fixed pipeline.

ResourceManager * mCreator
 Creator.

String mName
 Unique name of the resource.

String mGroup
 The name of the resource group.

ResourceHandle mHandle
 Numeric handle for more efficient look up than name.

bool mIsLoaded
 Is the resource currently loaded?

size_t mSize
 The size of the resource in bytes.

bool mIsManual
 Is this file manually loaded?

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

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

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


Static Protected Attributes

CmdType msTypeCmd
CmdSyntax msSyntaxCmd
CmdSkeletal msSkeletalCmd
ParamDictionaryMap msDictionary
 Dictionary of parameters.

Detailed Description

Defines a program which runs on the GPU such as a vertex or fragment program.

Remarks:
This class defines the low-level program in assembler code, the sort used to directly assemble into machine instructions for the GPU to execute. By nature, this means that the assembler source is rendersystem specific, which is why this is an abstract class - real instances are created through the RenderSystem. If you wish to use higher level shading languages like HLSL and Cg, you need to use the HighLevelGpuProgram class instead.

Definition at line 709 of file OgreGpuProgram.h.

Constructor & Destructor Documentation

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

virtual Ogre::GpuProgram::~GpuProgram (   )  [virtual]
 

Definition at line 773 of file OgreGpuProgram.h.

References Ogre::String.

Member Function Documentation

virtual GpuProgram* Ogre::GpuProgram::_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 in Ogre::HighLevelGpuProgram.

Definition at line 806 of file OgreGpuProgram.h.

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

Notify this resource of it's origin.

Definition at line 214 of file OgreResource.h.

References Ogre::String.

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

Implements Ogre::Resource.

Definition at line 764 of file OgreGpuProgram.h.

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.

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

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

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

References Ogre::String.

virtual GpuProgramParametersSharedPtr Ogre::GpuProgram::createParameters (  void   )  [virtual]
 

Creates a new parameters object compatible with this program definition.

Remarks:
It is recommended that you use this method of creating parameters objects rather than going direct to GpuProgramManager, because this method will populate any implementation-specific extras (like named parameters) where they are appropriate.

Reimplemented in Ogre::HighLevelGpuProgram, and Ogre::D3D9HLSLProgram.

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

Gets the manager which created this resource.

Definition at line 205 of file OgreResource.h.

virtual GpuProgramParametersSharedPtr Ogre::GpuProgram::getDefaultParameters (  void   )  [virtual]
 

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

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.

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

Gets the group which this resource is a member of.

Definition at line 202 of file OgreResource.h.

References Ogre::String.

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

Definition at line 188 of file OgreResource.h.

References Ogre::ResourceHandle.

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

Gets resource name.

Definition at line 183 of file OgreResource.h.

References Ogre::String.

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

References Ogre::String.

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

Definition at line 209 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 196 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 265 of file OgreStringInterface.h.

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

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.

virtual bool Ogre::GpuProgram::getPassSurfaceAndLightStates (  void   )  const [virtual]
 

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

Definition at line 863 of file OgreGpuProgram.h.

size_t Ogre::Resource::getSize (  void   )  const [inherited]
 

Retrieves info about the size of the resource.

Definition at line 172 of file OgreResource.h.

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

Gets the assembler source for this program.

Definition at line 796 of file OgreGpuProgram.h.

References Ogre::String.

virtual const String& Ogre::GpuProgram::getSourceFile (  void   )  const [virtual]
 

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

Definition at line 794 of file OgreGpuProgram.h.

virtual const String& Ogre::GpuProgram::getSyntaxCode (  void   )  const [virtual]
 

Gets the syntax code for this program e.g.

arbvp1, fp20, vs_1_1 etc

Definition at line 788 of file OgreGpuProgram.h.

References Ogre::String.

virtual GpuProgramType Ogre::GpuProgram::getType (  void   )  const [virtual]
 

Get the program type.

Definition at line 800 of file OgreGpuProgram.h.

References Ogre::GpuProgramType.

bool Ogre::Resource::isLoaded (  void   )  const [inherited]
 

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

Definition at line 195 of file OgreResource.h.

References OGRE_LOCK_AUTO_MUTEX.

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

Is this resource manually loaded?

Definition at line 160 of file OgreResource.h.

bool Ogre::Resource::isReloadable (  void   )  const [inherited]
 

Returns true if the Resource is reloadable, false otherwise.

Definition at line 153 of file OgreResource.h.

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

Definition at line 835 of file OgreGpuProgram.h.

virtual bool Ogre::GpuProgram::isSupported (  void   )  const [virtual]
 

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

Reimplemented in Ogre::CgProgram, and Ogre::D3D9HLSLProgram.

virtual void Ogre::Resource::load (  void   )  [virtual, inherited]
 

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

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

virtual void Ogre::GpuProgram::loadFromSource (  void   )  [protected, pure virtual]
 

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

Implemented in Ogre::CgProgram, Ogre::D3D7GpuProgram, Ogre::D3D9GpuProgram, Ogre::D3D9HLSLProgram, Ogre::GLGpuNvparseProgram, Ogre::GLGpuProgram, Ogre::GLArbGpuProgram, Ogre::GLSLGpuProgram, and Ogre::GLSLProgram.

void Ogre::GpuProgram::loadImpl (  void   )  [protected, virtual]
 

Implements Ogre::Resource.

Reimplemented in Ogre::HighLevelGpuProgram, and Ogre::D3D9GpuProgram.

virtual void Ogre::Resource::reload (  void   )  [virtual, inherited]
 

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.

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

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::setSkeletalAnimationIncluded (  bool  included  )  [virtual]
 

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

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

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]
 

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]
 

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

virtual void Ogre::GpuProgram::setSyntaxCode (  const String &  syntax  )  [virtual]
 

Sets the syntax code for this program e.g.

arbvp1, fp20, vs_1_1 etc

virtual void Ogre::GpuProgram::setType (  GpuProgramType  t  )  [virtual]
 

Set the program type (only valid before load).

Reimplemented in Ogre::GLArbGpuProgram.

void Ogre::GpuProgram::setupBaseParamDictionary (  void   )  [protected]
 

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::Resource::touch (  void   )  [virtual, inherited]
 

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

Reimplemented in Ogre::Material.

virtual void Ogre::Resource::unload (  void   )  [virtual, inherited]
 

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

Reimplemented in Ogre::GLSLGpuProgram.

virtual void Ogre::Resource::unloadImpl (  void   )  [protected, pure virtual, inherited]
 

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

Implemented in Ogre::Font, Ogre::HighLevelGpuProgram, Ogre::Material, Ogre::Mesh, Ogre::Skeleton, Ogre::SkeletonInstance, Ogre::Texture, Ogre::BspLevel, Ogre::D3D7GpuProgram, Ogre::D3D9GpuVertexProgram, Ogre::D3D9GpuFragmentProgram, Ogre::GLGpuNvparseProgram, Ogre::GLGpuProgram, and Ogre::GLArbGpuProgram.

Member Data Documentation

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

Creator.

Definition at line 73 of file OgreResource.h.

GpuProgramParametersSharedPtr Ogre::GpuProgram::mDefaultParams [protected]
 

The default parameters for use with this object.

Definition at line 749 of file OgreGpuProgram.h.

String Ogre::GpuProgram::mFilename [protected]
 

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

Definition at line 739 of file OgreGpuProgram.h.

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

The name of the resource group.

Definition at line 77 of file OgreResource.h.

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

Numeric handle for more efficient look up than name.

Definition at line 79 of file OgreResource.h.

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

Is the resource currently loaded?

Definition at line 81 of file OgreResource.h.

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

Is this file manually loaded?

Definition at line 85 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 89 of file OgreResource.h.

bool Ogre::GpuProgram::mLoadFromFile [protected]
 

Whether we need to load source from file or not.

Definition at line 743 of file OgreGpuProgram.h.

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

Unique name of the resource.

Definition at line 75 of file OgreResource.h.

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

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

Definition at line 87 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 160 of file OgreStringInterface.h.

bool Ogre::GpuProgram::mPassSurfaceAndLightStates [protected]
 

Does this program want light states passed through fixed pipeline.

Definition at line 751 of file OgreGpuProgram.h.

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

Dictionary of parameters.

Definition at line 157 of file OgreStringInterface.h.

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

The size of the resource in bytes.

Definition at line 83 of file OgreResource.h.

bool Ogre::GpuProgram::mSkeletalAnimation [protected]
 

Does this (vertex) program include skeletal animation?

Definition at line 747 of file OgreGpuProgram.h.

String Ogre::GpuProgram::mSource [protected]
 

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

Definition at line 741 of file OgreGpuProgram.h.

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

Definition at line 734 of file OgreGpuProgram.h.

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

Definition at line 733 of file OgreGpuProgram.h.

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

Definition at line 732 of file OgreGpuProgram.h.

String Ogre::GpuProgram::mSyntaxCode [protected]
 

Syntax code eg arbvp1, vs_2_0 etc.

Definition at line 745 of file OgreGpuProgram.h.

GpuProgramType Ogre::GpuProgram::mType [protected]
 

The type of the program.

Definition at line 737 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 Feb 12 13:00:36 2006