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

Ogre::CgProgram Class Reference

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

#include <OgreCgProgram.h>

Inheritance diagram for Ogre::CgProgram:

Inheritance graph
[legend]
List of all members.

Public Methods

 CgProgram (const String &name, GpuProgramType gpType, const String &language, CGcontext context)
 ~CgProgram ()
void setEntryPoint (const String &entryPoint)
 Sets the entry point for this program ie the first method called.

const StringgetEntryPoint (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 StringVectorgetProfiles (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 StringgetCompileArguments (void) const
 Gets the entry point defined for this program.

bool isSupported (void) const
 Overridden from GpuProgram.

void load ()
 @copydoc Resource::unload

void unload ()
 @copydoc Resource::unload

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

GpuProgram_getBindingDelegate (void)
 @copydoc GpuProgram::getBindingDelegate

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

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

time_t getLastAccess (void) const
 Gets the last time the resource was 'touched'.

const StringgetName (void) const
 Gets resource name.

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

virtual void destroy ()
 A method to make the resource delete itself.


Protected Methods

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 unloadImpl (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 loadHighLevelImpl (void)
 Internal load implementation, loads just the high-level portion, enough to get parameters.

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.

GpuProgrammAssemblerProgram
 The underlying assembler program.

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

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?

String mName
ResourceHandle mHandle
bool mIsLoaded
time_t mLastAccess
size_t mSize

Static Protected Attributes

CmdEntryPoint msCmdEntryPoint
CmdProfiles msCmdProfiles
CmdArgs msCmdArgs
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 41 of file OgreCgProgram.h.


Constructor & Destructor Documentation

Ogre::CgProgram::CgProgram const String   name,
GpuProgramType    gpType,
const String   language,
CGcontext    context
 

Definition at line 219 of file OgreCgProgram.cpp.

References Ogre::ParamDictionary::addParameter(), Ogre::StringInterface::createParamDictionary(), Ogre::StringInterface::getParamDictionary(), Ogre::GpuProgramType, msCmdArgs, msCmdEntryPoint, msCmdProfiles, and Ogre::PT_STRING.

Ogre::CgProgram::~CgProgram  
 

Definition at line 241 of file OgreCgProgram.cpp.

References freeCgArgs().


Member Function Documentation

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

@copydoc GpuProgram::getBindingDelegate

Reimplemented from Ogre::GpuProgram.

Definition at line 94 of file OgreHighLevelGpuProgram.h.

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

Internal method which merges manual and automatic compile arguments.

Definition at line 60 of file OgreCgProgram.cpp.

References freeCgArgs(), mCgArguments, mCompileArgs, mSelectedCgProfile, Ogre::String::split(), and Ogre::StringVector.

Referenced by loadFromSource().

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

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

Referenced by Ogre::GuiElement::clone(), Ogre::GuiElement::copyFromTemplate(), Ogre::GuiContainer::copyFromTemplate(), and Ogre::ParticleSystem::operator=().

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.

Definition at line 133 of file OgreCgProgram.cpp.

References Ogre::HighLevelGpuProgram::mAssemblerProgram, mCgProgram, Ogre::Resource::mName, mSelectedProfile, and Ogre::GpuProgram::mType.

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

Referenced by Ogre::ExternalTextureSource::addBaseParams(), Ogre::BorderButtonGuiElement::BorderButtonGuiElement(), Ogre::BorderPanelGuiElement::BorderPanelGuiElement(), Ogre::ButtonGuiElement::ButtonGuiElement(), CgProgram(), Ogre::ColourFaderAffector::ColourFaderAffector(), Ogre::ColourFaderAffector2::ColourFaderAffector2(), Ogre::ColourImageAffector::ColourImageAffector(), Ogre::ColourInterpolatorAffector::ColourInterpolatorAffector(), Ogre::CursorGuiElement::CursorGuiElement(), Ogre::D3D9HLSLProgram::D3D9HLSLProgram(), Ogre::AreaEmitter::initDefaults(), Ogre::ParticleSystem::initParameters(), Ogre::LinearForceAffector::LinearForceAffector(), Ogre::ListGuiElement::ListGuiElement(), Ogre::PanelGuiElement::PanelGuiElement(), Ogre::PointEmitter::PointEmitter(), Ogre::PopupMenuGuiElement::PopupMenuGuiElement(), Ogre::RotationAffector::RotationAffector(), Ogre::ScaleAffector::ScaleAffector(), Ogre::ScrollBarGuiElement::ScrollBarGuiElement(), Ogre::TextAreaGuiElement::TextAreaGuiElement(), Ogre::TextBoxGuiElement::TextBoxGuiElement(), and Ogre::TTYGuiElement::TTYGuiElement().

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.

Definition at line 71 of file OgreHighLevelGpuProgram.cpp.

References Ogre::GpuProgramParametersSharedPtr, Ogre::GpuProgram::isSupported(), Ogre::HighLevelGpuProgram::loadHighLevelImpl(), params, and Ogre::HighLevelGpuProgram::populateParameterNames().

virtual void Ogre::Resource::destroy void    [virtual, inherited]
 

A method to make the resource delete itself.

Note:
This exists because Resource objects could be created in other processes, and they need to be destroyed in the process that created them.

Definition at line 137 of file OgreResource.h.

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

Releases memory for the horrible Cg char**.

Definition at line 100 of file OgreCgProgram.cpp.

References mCgArguments.

Referenced by buildArgs(), and ~CgProgram().

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

Gets the entry point defined for this program.

Definition at line 120 of file OgreCgProgram.h.

const String& Ogre::CgProgram::getEntryPoint void    const
 

Gets the entry point defined for this program.

Definition at line 112 of file OgreCgProgram.h.

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

Definition at line 120 of file OgreResource.h.

References Ogre::ResourceHandle.

Referenced by Ogre::Material::clone(), Ogre::BspLevel::loadQuake3Level(), and Ogre::ResourceManager::unload().

time_t Ogre::Resource::getLastAccess void    const [inherited]
 

Gets the last time the resource was 'touched'.

Definition at line 108 of file OgreResource.h.

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

Gets resource name.

Reimplemented in Ogre::Material, and Ogre::Overlay.

Definition at line 115 of file OgreResource.h.

Referenced by Ogre::D3D9Texture::_loadCubeTex(), Ogre::Mesh::_notifySkeleton(), Ogre::ResourceManager::add(), Ogre::PopupMenuGuiElement::addListItem(), Ogre::ListGuiElement::addListItem(), Ogre::PopupMenuGuiElement::addMenuItem(), Ogre::MeshManager::createPrefabPlane(), Ogre::TTYGuiElement::getFontName(), Ogre::TextAreaGuiElement::getFontName(), Ogre::PopupMenuGuiElement::getListItemName(), Ogre::ListGuiElement::getListItemName(), Ogre::GpuProgramUsage::getProgramName(), Ogre::MeshSerializer::importMesh(), Ogre::GLTexture::load(), Ogre::TextureManager::loadImage(), Ogre::TextureManager::loadRawData(), Ogre::FontManager::logBadAttrib(), Ogre::MeshSerializerImpl_v1::readMaterial(), Ogre::MeshSerializerImpl::readMeshLodInfo(), Ogre::MeshSerializerImpl_v1::readMeshLodUsageGenerated(), Ogre::MeshSerializerImpl::readMeshLodUsageGenerated(), Ogre::MeshSerializerImpl::readMeshLodUsageManual(), Ogre::PopupMenuGuiElement::removeListItem(), Ogre::ListGuiElement::removeListItem(), Ogre::SceneManager::setSkyBox(), Ogre::SceneManager::setSkyDome(), and Ogre::ResourceManager::unload().

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

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

Referenced by Ogre::TTYGuiElement::addBaseParameters(), Ogre::TextBoxGuiElement::addBaseParameters(), Ogre::TextAreaGuiElement::addBaseParameters(), Ogre::ScrollBarGuiElement::addBaseParameters(), Ogre::PopupMenuGuiElement::addBaseParameters(), Ogre::ParticleEmitter::addBaseParameters(), Ogre::PanelGuiElement::addBaseParameters(), Ogre::ListGuiElement::addBaseParameters(), Ogre::GuiElement::addBaseParameters(), Ogre::CursorGuiElement::addBaseParameters(), Ogre::ButtonGuiElement::addBaseParameters(), Ogre::BorderPanelGuiElement::addBaseParameters(), Ogre::BorderButtonGuiElement::addBaseParameters(), Ogre::ExternalTextureSource::addBaseParams(), CgProgram(), Ogre::ColourFaderAffector::ColourFaderAffector(), Ogre::ColourFaderAffector2::ColourFaderAffector2(), Ogre::ColourImageAffector::ColourImageAffector(), Ogre::ColourInterpolatorAffector::ColourInterpolatorAffector(), Ogre::D3D9HLSLProgram::D3D9HLSLProgram(), Ogre::HollowEllipsoidEmitter::HollowEllipsoidEmitter(), Ogre::AreaEmitter::initDefaults(), Ogre::ParticleSystem::initParameters(), Ogre::LinearForceAffector::LinearForceAffector(), Ogre::RingEmitter::RingEmitter(), Ogre::RotationAffector::RotationAffector(), Ogre::ScaleAffector::ScaleAffector(), and Ogre::StringInterface::setParameter().

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

Definition at line 224 of file OgreStringInterface.h.

References Ogre::ParamDictionary::getParameters(), and Ogre::ParameterList.

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

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

Definition at line 116 of file OgreCgProgram.h.

References mProfiles, and Ogre::StringVector.

Referenced by Ogre::CgProgram::CmdProfiles::doGet().

virtual size_t Ogre::Resource::getSize void    const [virtual, inherited]
 

Retrieves info about the size of the resource.

Definition at line 93 of file OgreResource.h.

Referenced by Ogre::ResourceManager::unload().

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

Gets the assembler source for this program.

Definition at line 494 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 492 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 489 of file OgreGpuProgram.h.

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

Get the program type.

Definition at line 496 of file OgreGpuProgram.h.

Referenced by Ogre::GLRenderSystem::bindGpuProgram(), and Ogre::D3D9RenderSystem::bindGpuProgram().

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

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

Definition at line 127 of file OgreResource.h.

Referenced by Ogre::GpuProgramUsage::_load(), Ogre::SceneManager::deriveShadowCasterPass(), Ogre::SceneManager::deriveShadowReceiverPass(), Ogre::Technique::isLoaded(), Ogre::D3D9Texture::load(), Ogre::D3D9Texture::unload(), and Ogre::D3D9Texture::~D3D9Texture().

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

Referenced by Ogre::GpuProgram::isSupported(), Ogre::D3D9HLSLProgram::isSupported(), isSupported(), and Ogre::Entity::reevaluateVertexProcessing().

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

Overridden from GpuProgram.

Reimplemented from Ogre::GpuProgram.

Definition at line 247 of file OgreCgProgram.cpp.

References Ogre::GpuProgram::isSkeletalAnimationIncluded(), mProfiles, and Ogre::RSC_VERTEX_FORMAT_UBYTE4.

void Ogre::HighLevelGpuProgram::load   [virtual, inherited]
 

@copydoc Resource::unload

Reimplemented from Ogre::GpuProgram.

Definition at line 40 of file OgreHighLevelGpuProgram.cpp.

References Ogre::HighLevelGpuProgram::createLowLevelImpl(), Ogre::GpuProgram::load(), Ogre::HighLevelGpuProgram::loadHighLevelImpl(), Ogre::HighLevelGpuProgram::mAssemblerProgram, Ogre::Resource::mIsLoaded, and Ogre::HighLevelGpuProgram::unload().

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

Internal load implementation, must be implemented by subclasses.

Implements Ogre::GpuProgram.

Definition at line 116 of file OgreCgProgram.cpp.

References buildArgs(), Ogre::checkForCgError(), mCgContext, mCgProgram, mEntryPoint, Ogre::Resource::mName, mSelectedCgProfile, Ogre::GpuProgram::mSource, and selectProfile().

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

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

Definition at line 84 of file OgreHighLevelGpuProgram.cpp.

References Ogre::DataChunk::getAsString(), Ogre::GpuProgram::loadFromSource(), Ogre::GpuProgram::mFilename, Ogre::HighLevelGpuProgram::mHighLevelLoaded, and Ogre::GpuProgram::mSource.

Referenced by Ogre::HighLevelGpuProgram::createParameters(), and Ogre::HighLevelGpuProgram::load().

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

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

Implements Ogre::HighLevelGpuProgram.

Definition at line 159 of file OgreCgProgram.cpp.

References Ogre::GpuProgramParametersSharedPtr, mCgProgram, and params.

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

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

Definition at line 38 of file OgreCgProgram.cpp.

References Ogre::checkForCgError(), Ogre::GpuProgramManager::isSyntaxSupported(), mCgContext, Ogre::Resource::mName, mProfiles, mSelectedCgProfile, and mSelectedProfile.

Referenced by loadFromSource().

void Ogre::CgProgram::setCompileArguments const String   args
 

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

Definition at line 118 of file OgreCgProgram.h.

void Ogre::CgProgram::setEntryPoint const String   entryPoint
 

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

Definition at line 110 of file OgreCgProgram.h.

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)

Definition at line 33 of file OgreStringInterface.cpp.

References Ogre::ParamCommand::doSet(), Ogre::ParamDictionary::getParamCommand(), and Ogre::StringInterface::getParamDictionary().

Referenced by Ogre::StringInterface::copyParametersTo(), Ogre::Profiler::createContainer(), Ogre::Profiler::createTextArea(), Ogre::MaterialSerializer::finishProgramDefinition(), Ogre::ParticleSystemManager::parseAffectorAttrib(), Ogre::ParticleSystemManager::parseAttrib(), Ogre::OverlayManager::parseElementAttrib(), and Ogre::ParticleSystemManager::parseEmitterAttrib().

void Ogre::CgProgram::setProfiles const StringVector   profiles
 

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

Definition at line 271 of file OgreCgProgram.cpp.

References mProfiles, and Ogre::StringVector.

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

Referenced by Ogre::MaterialSerializer::finishProgramDefinition().

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.

Definition at line 54 of file OgreGpuProgram.cpp.

References Ogre::GpuProgram::mFilename, Ogre::GpuProgram::mLoadFromFile, and Ogre::GpuProgram::mSource.

Referenced by Ogre::GpuProgramManager::createProgramFromString(), and Ogre::GpuProgramManager::loadFromString().

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.

Definition at line 47 of file OgreGpuProgram.cpp.

References Ogre::GpuProgram::mFilename, Ogre::GpuProgram::mLoadFromFile, and Ogre::GpuProgram::mSource.

Referenced by Ogre::GpuProgramManager::createProgram(), Ogre::MaterialSerializer::finishProgramDefinition(), and Ogre::GpuProgramManager::load().

virtual void Ogre::Resource::touch void    [virtual, inherited]
 

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

Reimplemented in Ogre::Material.

Definition at line 100 of file OgreResource.h.

Referenced by Ogre::Mesh::clone(), Ogre::MeshManager::createCurvedIllusionPlane(), Ogre::MeshManager::createCurvedPlane(), Ogre::MeshManager::createPlane(), and Ogre::ResourceManager::load().

void Ogre::HighLevelGpuProgram::unload   [virtual, inherited]
 

@copydoc Resource::unload

Reimplemented from Ogre::Resource.

Definition at line 58 of file OgreHighLevelGpuProgram.cpp.

References Ogre::HighLevelGpuProgram::mAssemblerProgram, Ogre::Resource::mIsLoaded, Ogre::Resource::unload(), and Ogre::HighLevelGpuProgram::unloadImpl().

Referenced by Ogre::HighLevelGpuProgram::load().

void Ogre::CgProgram::unloadImpl void    [protected, virtual]
 

Internal unload implementation, must be implemented by subclasses.

Implements Ogre::HighLevelGpuProgram.

Definition at line 145 of file OgreCgProgram.cpp.

References Ogre::checkForCgError(), mCgContext, mCgProgram, and Ogre::Resource::mName.


Member Data Documentation

GpuProgram* Ogre::HighLevelGpuProgram::mAssemblerProgram [protected, inherited]
 

The underlying assembler program.

Definition at line 62 of file OgreHighLevelGpuProgram.h.

Referenced by Ogre::D3D9HLSLProgram::createLowLevelImpl(), createLowLevelImpl(), Ogre::HighLevelGpuProgram::load(), and Ogre::HighLevelGpuProgram::unload().

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

Definition at line 94 of file OgreCgProgram.h.

Referenced by buildArgs(), and freeCgArgs().

CGcontext Ogre::CgProgram::mCgContext [protected]
 

The CG context to use, passed in by factory.

Definition at line 73 of file OgreCgProgram.h.

Referenced by loadFromSource(), selectProfile(), and unloadImpl().

CGprogram Ogre::CgProgram::mCgProgram [protected]
 

Program handle.

Definition at line 75 of file OgreCgProgram.h.

Referenced by createLowLevelImpl(), loadFromSource(), populateParameterNames(), and unloadImpl().

String Ogre::CgProgram::mCompileArgs [protected]
 

Definition at line 91 of file OgreCgProgram.h.

Referenced by buildArgs().

String Ogre::CgProgram::mEntryPoint [protected]
 

Definition at line 88 of file OgreCgProgram.h.

Referenced by loadFromSource().

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

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

Definition at line 461 of file OgreGpuProgram.h.

Referenced by Ogre::GpuProgram::load(), Ogre::D3D9GpuProgram::load(), Ogre::HighLevelGpuProgram::loadHighLevelImpl(), Ogre::GpuProgram::setSource(), and Ogre::GpuProgram::setSourceFile().

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

Definition at line 57 of file OgreResource.h.

Referenced by Ogre::ResourceManager::add(), Ogre::Material::clone(), Ogre::Material::copyDetailsTo(), and Ogre::Material::operator=().

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

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

Definition at line 60 of file OgreHighLevelGpuProgram.h.

Referenced by Ogre::HighLevelGpuProgram::loadHighLevelImpl().

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

Definition at line 58 of file OgreResource.h.

Referenced by Ogre::D3D9Texture::_initMembers(), Ogre::D3D9Texture::_loadCubeTex(), Ogre::D3D9Texture::_loadNormTex(), Ogre::D3D9Texture::_loadVolumeTex(), Ogre::Material::_notifyNeedsRecompile(), Ogre::Material::clone(), Ogre::D3DTexture::createSurface2D(), Ogre::D3DTexture::createSurface3D(), Ogre::D3D9Texture::D3D9Texture(), Ogre::D3DTexture::D3DTexture(), Ogre::DynLib::DynLib(), Ogre::Zip::load(), Ogre::SkeletonInstance::load(), Ogre::Skeleton::load(), Ogre::PatchMesh::load(), Ogre::Mesh::load(), Ogre::Material::load(), Ogre::HighLevelGpuProgram::load(), Ogre::GpuProgram::load(), Ogre::GLTexture::load(), Ogre::Font::load(), Ogre::DynLib::load(), Ogre::D3D9Texture::load(), Ogre::D3D9GpuProgram::load(), Ogre::D3DTexture::load(), Ogre::BspLevel::load(), Ogre::D3D9Texture::loadImage(), Ogre::D3DTexture::loadImage(), Ogre::D3DTexture::loadImage3D(), Ogre::GLTexture::loadImages(), Ogre::Material::Material(), Ogre::Material::operator=(), Ogre::Skeleton::unload(), Ogre::Mesh::unload(), Ogre::Material::unload(), Ogre::HighLevelGpuProgram::unload(), Ogre::GLTexture::unload(), Ogre::Font::unload(), Ogre::DynLib::unload(), Ogre::D3D9Texture::unload(), Ogre::D3DTexture::unload(), and Ogre::BspLevel::~BspLevel().

time_t Ogre::Resource::mLastAccess [protected, inherited]
 

Definition at line 59 of file OgreResource.h.

Referenced by Ogre::Material::operator=().

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

Whether we need to load source from file or not.

Definition at line 465 of file OgreGpuProgram.h.

Referenced by Ogre::GpuProgram::setSource(), and Ogre::GpuProgram::setSourceFile().

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

Definition at line 56 of file OgreResource.h.

Referenced by Ogre::Skeleton::_dumpContents(), Ogre::Mesh::_rationaliseBoneAssignments(), Ogre::BspLevel::BspLevel(), Ogre::Mesh::buildEdgeList(), Ogre::Mesh::buildTangentVectors(), Ogre::Material::clone(), Ogre::Material::compile(), Ogre::Material::copyDetailsTo(), Ogre::Quake3Shader::createAsMaterial(), Ogre::D3D9HLSLProgram::createLowLevelImpl(), createLowLevelImpl(), Ogre::Font::createTextureFromFont(), Ogre::D3D9Texture::D3D9Texture(), Ogre::D3DTexture::D3DTexture(), Ogre::DynLib::DynLib(), Ogre::Font::Font(), Ogre::Mesh::generateLodLevels(), Ogre::Material::getBestTechnique(), Ogre::Overlay::getName(), Ogre::Material::getName(), Ogre::GLTexture::GLTexture(), Ogre::GpuProgram::GpuProgram(), Ogre::Zip::load(), Ogre::Skeleton::load(), Ogre::Mesh::load(), Ogre::GLTexture::load(), Ogre::Font::load(), Ogre::DynLib::load(), Ogre::D3DTexture::load(), Ogre::BspLevel::load(), Ogre::D3D9GpuFragmentProgram::loadFromMicrocode(), Ogre::D3D9GpuVertexProgram::loadFromMicrocode(), Ogre::GLArbGpuProgram::loadFromSource(), Ogre::D3D9HLSLProgram::loadFromSource(), Ogre::D3D9GpuProgram::loadFromSource(), loadFromSource(), Ogre::GLTexture::loadImages(), Ogre::Material::Material(), Ogre::Mesh::Mesh(), Ogre::Material::operator=(), Ogre::Overlay::Overlay(), Ogre::Quake3Shader::Quake3Shader(), selectProfile(), Ogre::Mesh::setSkeletonName(), Ogre::Skeleton::Skeleton(), Ogre::StringResource::StringResource(), Ogre::Zip::unload(), Ogre::DynLib::unload(), unloadImpl(), and Ogre::Zip::Zip().

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

StringVector Ogre::CgProgram::mProfiles [protected]
 

Definition at line 87 of file OgreCgProgram.h.

Referenced by getProfiles(), isSupported(), selectProfile(), and setProfiles().

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

Definition at line 36 of file OgreCgProgram.cpp.

Referenced by CgProgram().

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

Definition at line 34 of file OgreCgProgram.cpp.

Referenced by CgProgram().

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

Definition at line 35 of file OgreCgProgram.cpp.

Referenced by CgProgram().

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

Dictionary of parameters.

Definition at line 30 of file OgreStringInterface.cpp.

CGprofile Ogre::CgProgram::mSelectedCgProfile [protected]
 

Definition at line 90 of file OgreCgProgram.h.

Referenced by buildArgs(), loadFromSource(), and selectProfile().

String Ogre::CgProgram::mSelectedProfile [protected]
 

Definition at line 89 of file OgreCgProgram.h.

Referenced by createLowLevelImpl(), and selectProfile().

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

Definition at line 60 of file OgreResource.h.

Referenced by Ogre::D3D9Texture::_setFinalAttributes(), Ogre::D3DTexture::loadImage(), Ogre::D3DTexture::loadImage3D(), Ogre::GLTexture::loadImages(), and Ogre::Material::operator=().

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

Does this (vertex) program include skeletal animation?

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

Referenced by Ogre::GpuProgram::load(), Ogre::D3D9GpuProgram::load(), Ogre::GLArbGpuProgram::loadFromSource(), Ogre::GLGpuNvparseProgram::loadFromSource(), Ogre::D3D9HLSLProgram::loadFromSource(), Ogre::D3D9GpuProgram::loadFromSource(), loadFromSource(), Ogre::HighLevelGpuProgram::loadHighLevelImpl(), Ogre::GpuProgram::setSource(), and Ogre::GpuProgram::setSourceFile().

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

Syntax code eg arbvp1, vs_2_0 etc.

Definition at line 467 of file OgreGpuProgram.h.

Referenced by Ogre::GpuProgram::isSupported().

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

The type of the program.

Definition at line 459 of file OgreGpuProgram.h.

Referenced by Ogre::GLArbGpuProgram::bindProgramParameters(), Ogre::D3D9HLSLProgram::createLowLevelImpl(), and createLowLevelImpl().


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

Copyright © 2002-2003 by The OGRE Team
Last modified Fri May 14 23:23:32 2004