Ogre::CgProgram Class Reference

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

#include <OgreCgProgram.h>

Inheritance diagram for Ogre::CgProgram:

List of all members.


Public Member Functions
	CgProgram (ResourceManager creator, const String &name, ResourceHandle handle, const String &group, bool isManual, ManualResourceLoader loader, CGcontext context)
	~CgProgram ()
void	setEntryPoint (const String &entryPoint)
	Sets the entry point for this program ie the first method called.
const String &	getEntryPoint (void) const
	Gets the entry point defined for this program.
void	setProfiles (const StringVector &profiles)
	Sets the Cg profiles which can be supported by the program.
const StringVector &	getProfiles (void) const
	Gets the Cg profiles which can be supported by the program.
void	setCompileArguments (const String &args)
	Sets the compilation arguments for this program ie the first method called.
const String &	getCompileArguments (void) const
	Gets the entry point defined for this program.
bool	isSupported (void) const
	Overridden from GpuProgram.
const String &	getLanguage (void) const
	Overridden from GpuProgram.
GpuProgramParametersSharedPtr	createParameters (void)
	Creates a new parameters object compatible with this program definition.
GpuProgram *	_getBindingDelegate (void)

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 void	setSkeletalAnimationIncluded (bool included)
	Sets whether a vertex program includes the required instructions to perform skeletal animation.
virtual bool	isSkeletalAnimationIncluded (void) const
	Returns whether a vertex program includes the required instructions to perform skeletal animation.
virtual void	setMorphAnimationIncluded (bool included)
	Sets whether a vertex program includes the required instructions to perform morph animation.
virtual void	setPoseAnimationIncluded (ushort poseCount)
	Sets whether a vertex program includes the required instructions to perform pose animation.
virtual bool	isMorphAnimationIncluded (void) const
	Returns whether a vertex program includes the required instructions to perform morph animation.
virtual bool	isPoseAnimationIncluded (void) const
	Returns whether a vertex program includes the required instructions to perform pose animation.
virtual ushort	getNumberOfPosesIncluded (void) const
	Returns the number of simultaneous poses the vertex program can blend, for use in pose animation.
virtual GpuProgramParametersSharedPtr	getDefaultParameters (void)
	Get a reference to the default parameters which are to be used for all uses of this program.
virtual bool	hasDefaultParameters (void) const
	Returns true if default parameters have been set up.
virtual void	setSurfaceAndPassLightStates (bool state)
	Sets whether a vertex program requires light and material states to be passed to through fixed pipeline low level API rendering calls.
virtual bool	getPassSurfaceAndLightStates (void) const
	Returns whether a vertex program wants light and material states to be passed through fixed pipeline low level API rendering calls.
virtual 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.
void	changeGroupOwnership (const String &newGroup)
	Change the resource group ownership of a Resource.
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	loadFromSource (void)
	Internal load implementation, must be implemented by subclasses.
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	populateParameterNames (GpuProgramParametersSharedPtr params)
	Populate the passed parameters with name->index map, must be overridden.
void	selectProfile (void)
	Internal method which works out which profile to use for this program.
void	buildArgs (void)
	Internal method which merges manual and automatic compile arguments.
void	freeCgArgs (void)
	Releases memory for the horrible Cg char**.
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.
void	loadImpl ()

void	unloadImpl ()

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

bool	createParamDictionary (const String &className)
	Internal method for creating a parameter dictionary for the class, if it does not already exist.
Protected Attributes
CGcontext	mCgContext
	The CG context to use, passed in by factory.
CGprogram	mCgProgram
	Program handle.
StringVector	mProfiles
String	mEntryPoint
String	mSelectedProfile
CGprofile	mSelectedCgProfile
String	mCompileArgs
char **	mCgArguments
bool	mHighLevelLoaded
	Whether the high-level program (and it's parameter defs) is loaded.
GpuProgramPtr	mAssemblerProgram
	The underlying assembler program.
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).
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
CmdEntryPoint	msCmdEntryPoint
CmdProfiles	msCmdProfiles
CmdArgs	msCmdArgs
CmdType	msTypeCmd
CmdSyntax	msSyntaxCmd
CmdSkeletal	msSkeletalCmd
ParamDictionaryMap	msDictionary
	Dictionary of parameters.

Detailed Description

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

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

Definition at line 42 of file OgreCgProgram.h.

Constructor & Destructor Documentation

Ogre::CgProgram::CgProgram ( ResourceManager * creator,

const String & name,

ResourceHandle handle,

const String & group,

bool isManual,

ManualResourceLoader * loader,

CGcontext context

)

Ogre::CgProgram::~CgProgram ( )

Member Function Documentation

GpuProgram* Ogre::HighLevelGpuProgram::_getBindingDelegate ( void ) [virtual, inherited]

Reimplemented from Ogre::GpuProgram.
Definition at line 97 of file OgreHighLevelGpuProgram.h.

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

Notify this resource of it's origin.

Definition at line 223 of file OgreResource.h.
References Ogre::String.

void Ogre::CgProgram::buildArgs ( void ) [protected]

Internal method which merges manual and automatic compile arguments.

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

Implements Ogre::Resource.
Definition at line 968 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::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().

void Ogre::CgProgram::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 172 of file OgreStringInterface.h.
References Ogre::String.

GpuProgramParametersSharedPtr Ogre::HighLevelGpuProgram::createParameters ( void ) [virtual, inherited]

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::GpuProgram.
Reimplemented in Ogre::D3D9HLSLProgram.

void Ogre::CgProgram::freeCgArgs ( void ) [protected]

Releases memory for the horrible Cg char**.

const String& Ogre::CgProgram::getCompileArguments ( void ) const

Gets the entry point defined for this program.

Definition at line 122 of file OgreCgProgram.h.
References mCompileArgs, and Ogre::String.

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

Gets the manager which created this resource.

Definition at line 214 of file OgreResource.h.

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

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

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::CgProgram::getEntryPoint ( void ) const

Gets the entry point defined for this program.

Definition at line 114 of file OgreCgProgram.h.
References mEntryPoint, and Ogre::String.

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::CgProgram::getLanguage ( void ) const [virtual]

Overridden from GpuProgram.

Reimplemented from Ogre::GpuProgram.

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

Gets resource name.

Definition at line 183 of file OgreResource.h.
References Ogre::String.

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 1078 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 221 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, inherited]

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

Definition at line 1110 of file OgreGpuProgram.h.

const StringVector& Ogre::CgProgram::getProfiles ( void ) const

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

Definition at line 118 of file OgreCgProgram.h.
References Ogre::StringVector.

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, inherited]

Gets the assembler source for this program.

Definition at line 1000 of file OgreGpuProgram.h.
References Ogre::String.

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 998 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 992 of file OgreGpuProgram.h.
References Ogre::String.

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

Get the program type.

Definition at line 1004 of file OgreGpuProgram.h.
References Ogre::GpuProgramType.

virtual bool Ogre::GpuProgram::hasDefaultParameters ( void ) const [virtual, inherited]

Returns true if default parameters have been set up.

Definition at line 1094 of file OgreGpuProgram.h.

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.

virtual bool Ogre::GpuProgram::isMorphAnimationIncluded ( void ) const [virtual, inherited]

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.

Definition at line 1066 of file OgreGpuProgram.h.

virtual bool Ogre::GpuProgram::isPoseAnimationIncluded ( void ) const [virtual, inherited]

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

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

Definition at line 1074 of file OgreGpuProgram.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, inherited]

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

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

Overridden from GpuProgram.

Reimplemented from Ogre::GpuProgram.

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.

void Ogre::CgProgram::loadFromSource ( void ) [protected, virtual]

Internal load implementation, must be implemented by subclasses.

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.

void Ogre::CgProgram::populateParameterNames ( GpuProgramParametersSharedPtr params ) [protected, virtual]

Populate the passed parameters with name->index map, must be overridden.

Implements Ogre::HighLevelGpuProgram.

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.

void Ogre::CgProgram::selectProfile ( void ) [protected]

Internal method which works out which profile to use for this program.

void Ogre::CgProgram::setCompileArguments ( const String & args )

Sets the compilation arguments for this program ie the first method called.

Definition at line 120 of file OgreCgProgram.h.
References mCompileArgs, and Ogre::String.

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

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

Definition at line 112 of file OgreCgProgram.h.
References mEntryPoint, and Ogre::String.

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

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

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

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

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 1030 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 1104 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).

Reimplemented in Ogre::GLArbGpuProgram.

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::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::HighLevelGpuProgram::unloadHighLevel ( void ) [protected, virtual, inherited]

Internal unload high-level portion if loaded.

void Ogre::CgProgram::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 60 of file OgreHighLevelGpuProgram.h.

char** Ogre::CgProgram::mCgArguments [protected]

Definition at line 95 of file OgreCgProgram.h.

CGcontext Ogre::CgProgram::mCgContext [protected]

The CG context to use, passed in by factory.

Definition at line 74 of file OgreCgProgram.h.

CGprogram Ogre::CgProgram::mCgProgram [protected]

Program handle.

Definition at line 76 of file OgreCgProgram.h.

String Ogre::CgProgram::mCompileArgs [protected]

Definition at line 92 of file OgreCgProgram.h.
Referenced by getCompileArguments(), and setCompileArguments().

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

Creator.

Definition at line 73 of file OgreResource.h.

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

The default parameters for use with this object.

Definition at line 953 of file OgreGpuProgram.h.

String Ogre::CgProgram::mEntryPoint [protected]

Definition at line 89 of file OgreCgProgram.h.
Referenced by getEntryPoint(), and setEntryPoint().

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

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

Definition at line 939 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::HighLevelGpuProgram::mHighLevelLoaded [protected, inherited]

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

Definition at line 58 of file OgreHighLevelGpuProgram.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, inherited]

Whether we need to load source from file or not.

Definition at line 943 of file OgreGpuProgram.h.

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

Does this (vertex) program include morph animation?

Definition at line 949 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, inherited]

Does this program want light states passed through fixed pipeline.

Definition at line 955 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 951 of file OgreGpuProgram.h.

StringVector Ogre::CgProgram::mProfiles [protected]

Definition at line 88 of file OgreCgProgram.h.

CmdArgs Ogre::CgProgram::msCmdArgs [static, protected]

Definition at line 71 of file OgreCgProgram.h.

CmdEntryPoint Ogre::CgProgram::msCmdEntryPoint [static, protected]

Definition at line 69 of file OgreCgProgram.h.

CmdProfiles Ogre::CgProgram::msCmdProfiles [static, protected]

Definition at line 70 of file OgreCgProgram.h.

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

Dictionary of parameters.

Definition at line 157 of file OgreStringInterface.h.

CGprofile Ogre::CgProgram::mSelectedCgProfile [protected]

Definition at line 91 of file OgreCgProgram.h.

String Ogre::CgProgram::mSelectedProfile [protected]

Definition at line 90 of file OgreCgProgram.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, inherited]

Does this (vertex) program include skeletal animation?

Definition at line 947 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 941 of file OgreGpuProgram.h.

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

Definition at line 934 of file OgreGpuProgram.h.

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

Definition at line 933 of file OgreGpuProgram.h.

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

Definition at line 932 of file OgreGpuProgram.h.

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

Syntax code eg arbvp1, vs_2_0 etc.

Definition at line 945 of file OgreGpuProgram.h.

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

The type of the program.

Definition at line 937 of file OgreGpuProgram.h.

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

OgreCgProgram.h

Ogre::CgProgram Class Reference

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation