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

# Ogre::HighLevelGpuProgram Class Reference

Abstract base class representing a high-level program (a vertex or fragment program). More...

`#include <OgreHighLevelGpuProgram.h>`

Inheritance diagram for Ogre::HighLevelGpuProgram:

[legend]
List of all members.

## Public Methods

| HighLevelGpuProgram (const String &name, GpuProgramType gpType, const String &language)
| Constructor, should be used only by factory classes.
| ~HighLevelGpuProgram ()
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
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 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 String & | getSyntaxCode (void) const
| Gets 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 GpuProgramType | getType (void) const
| Get the program type.
virtual bool | isSupported (void) const
| Returns whether this program can be supported on the current renderer and hardware.
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 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 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.
virtual void | destroy ()
| A method to make the resource delete itself.

## Static Public Methods

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 Methods

virtual void | loadHighLevelImpl (void)
| Internal load implementation, loads just the high-level portion, enough to get parameters.
virtual void | createLowLevelImpl (void)=0
| Internal method for creating an appropriate low-level program from this high-level program, must be implemented by subclasses.
virtual void | unloadImpl (void)=0
| Internal unload implementation, must be implemented by subclasses.
virtual void | populateParameterNames (GpuProgramParametersSharedPtr params)=0
| Populate the passed parameters with name->index map, must be overridden.
bool | createParamDictionary (const String &className)
| Internal method for creating a parameter dictionary for the class, if it does not already exist.
virtual void | loadFromSource (void)=0
| Virtual method which must be implemented by subclasses, load from mSource.

## Protected Attributes

bool | mHighLevelLoaded
| Whether the high-level program (and it's parameter defs) is loaded.
GpuProgram * | mAssemblerProgram
| 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?
GpuProgramParametersSharedPtr | mDefaultParams
| The default parameters for use with this object.
bool | mPassSurfaceAndLightStates
| Does this program want light states passed through fixed pipeline.
String | mName
ResourceHandle | mHandle
bool | mIsLoaded
time_t | mLastAccess
size_t | mSize

## Static Protected Attributes

ParamDictionaryMap | msDictionary
| Dictionary of parameters.

## Detailed Description

Abstract base class representing a high-level program (a vertex or fragment program).

Remarks:
  High-level programs are vertex and fragment programs written in a high-level language such as Cg or HLSL, and as such do not require you to write assembler code like GpuProgram does. However, the high-level program does eventually get converted (compiled) into assembler and then eventually microcode which is what runs on the GPU. As well as the convenience, some high-level languages like Cg allow you to write a program which will operate under both Direct3D and OpenGL, something which you cannot do with just GpuProgram (which requires you to write 2 programs and use each in a Technique to provide cross-API compatibility). Ogre will be creating a GpuProgram for you based on the high-level program, which is compiled specifically for the API being used at the time, but this process is transparent.

  You cannot create high-level programs direct - use HighLevelGpuProgramManager instead. Plugins can register new implementations of HighLevelGpuProgramFactory in order to add support for new languages without requiring changes to the core Ogre API. To allow custom parameters to be set, this class extends StringInterface - the application can query on the available custom parameters and get/set them without having to link specifically with it.

Definition at line 55 of file OgreHighLevelGpuProgram.h.

## Constructor & Destructor Documentation

Ogre::HighLevelGpuProgram::HighLevelGpuProgram | ( | const String & | name,
|  | GpuProgramType | gpType,
|  | const String & | language
| ) |

| Constructor, should be used only by factory classes. Definition at line 34 of file OgreHighLevelGpuProgram.cpp. References Ogre::GpuProgramType, and Ogre::String.

Ogre::HighLevelGpuProgram::~HighLevelGpuProgram | ( |  | ) |

| Definition at line 66 of file OgreHighLevelGpuProgram.cpp.

## Member Function Documentation

GpuProgram* Ogre::HighLevelGpuProgram::_getBindingDelegate | ( | void |  | ) | `[virtual]`

| @copydoc GpuProgram::getBindingDelegate Reimplemented from Ogre::GpuProgram. Definition at line 93 of file OgreHighLevelGpuProgram.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. Definition at line 53 of file OgreStringInterface.cpp. References Ogre::StringInterface::msDictionary.

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

virtual void Ogre::HighLevelGpuProgram::createLowLevelImpl | ( | void |  | ) | `[protected, pure virtual]`

| Internal method for creating an appropriate low-level program from this high-level program, must be implemented by subclasses. Implemented in Ogre::CgProgram, Ogre::D3D9HLSLProgram, and Ogre::GLSLProgram. Referenced by load().

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.

References Ogre::String.

Referenced by Ogre::ExternalTextureSource::addBaseParams(), Ogre::BorderButtonGuiElement::BorderButtonGuiElement(), Ogre::BorderPanelGuiElement::BorderPanelGuiElement(), Ogre::ButtonGuiElement::ButtonGuiElement(), Ogre::CgProgram::CgProgram(), Ogre::ColourFaderAffector::ColourFaderAffector(), Ogre::ColourFaderAffector2::ColourFaderAffector2(), Ogre::ColourImageAffector::ColourImageAffector(), Ogre::ColourInterpolatorAffector::ColourInterpolatorAffector(), Ogre::CursorGuiElement::CursorGuiElement(), Ogre::D3D9HLSLProgram::D3D9HLSLProgram(), Ogre::GLSLProgram::GLSLProgram(), 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]`

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(), loadHighLevelImpl(), Ogre::GpuProgram::mDefaultParams, params, and 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.

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.

Definition at line 107 of file OgreGpuProgram.cpp.

References Ogre::GpuProgram::createParameters(), Ogre::GpuProgramParametersSharedPtr, and Ogre::GpuProgram::mDefaultParams.

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

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.

References Ogre::String.

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::readMeshLodInfo(), 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(), Ogre::CgProgram::CgProgram(), Ogre::ColourFaderAffector::ColourFaderAffector(), Ogre::ColourFaderAffector2::ColourFaderAffector2(), Ogre::ColourImageAffector::ColourImageAffector(), Ogre::ColourInterpolatorAffector::ColourInterpolatorAffector(), Ogre::D3D9HLSLProgram::D3D9HLSLProgram(), Ogre::GLSLProgram::GLSLProgram(), 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(), 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.

Definition at line 224 of file OgreStringInterface.h.

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

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 607 of file OgreGpuProgram.h. Referenced by Ogre::SceneManager::setPass().

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 540 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 538 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 535 of file OgreGpuProgram.h. References Ogre::String. Referenced by Ogre::GLSLProgram::attachChildShader().

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

| Get the program type. Definition at line 542 of file OgreGpuProgram.h. References Ogre::String. 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 579 of file OgreGpuProgram.h.

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

bool Ogre::GpuProgram::isSupported | ( | void |  | ) | const`[virtual, inherited]`

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

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

Definition at line 83 of file OgreGpuProgram.cpp.

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

Referenced by Ogre::Technique::_compile(), Ogre::GLSLProgram::attachChildShader(), createParameters(), Ogre::MaterialSerializer::finishProgramDefinition(), Ogre::GLSLProgram::GLSLProgram(), Ogre::parseFragmentProgramRef(), Ogre::parseParamIndexed(), Ogre::parseParamIndexedAuto(), Ogre::parseParamNamed(), Ogre::parseParamNamedAuto(), Ogre::parseShadowCasterVertexProgramRef(), Ogre::parseShadowReceiverVertexProgramRef(), Ogre::parseVertexProgramRef(), and Ogre::GLSLProgram::unloadImpl().

void Ogre::HighLevelGpuProgram::load | ( |  | ) | `[virtual]`

| @copydoc Resource::unload Reimplemented from Ogre::GpuProgram. Definition at line 40 of file OgreHighLevelGpuProgram.cpp. References createLowLevelImpl(), Ogre::GpuProgram::load(), loadHighLevelImpl(), mAssemblerProgram, Ogre::Resource::mIsLoaded, and unload().

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

| 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. Referenced by Ogre::GpuProgram::load(), and loadHighLevelImpl().

void Ogre::HighLevelGpuProgram::loadHighLevelImpl | ( | void |  | ) | `[protected, virtual]`

| Internal load implementation, loads just the high-level portion, enough to get parameters. Definition at line 87 of file OgreHighLevelGpuProgram.cpp. References Ogre::DataChunk::getAsString(), Ogre::GpuProgram::loadFromSource(), Ogre::GpuProgram::mFilename, mHighLevelLoaded, and Ogre::GpuProgram::mSource. Referenced by Ogre::GLSLProgram::attachChildShader(), createParameters(), and load().

virtual void Ogre::HighLevelGpuProgram::populateParameterNames | ( | GpuProgramParametersSharedPtr | params | ) | `[protected, pure virtual]`

| Populate the passed parameters with name->index map, must be overridden. Implemented in Ogre::CgProgram, Ogre::D3D9HLSLProgram, and Ogre::GLSLProgram. Referenced by createParameters().

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(), Ogre::StringInterface::getParamDictionary(), and Ogre::String.

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

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 570 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 55 of file OgreGpuProgram.cpp.

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

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 48 of file OgreGpuProgram.cpp.

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

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

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

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]`

| @copydoc Resource::unload Reimplemented from Ogre::Resource. Definition at line 58 of file OgreHighLevelGpuProgram.cpp. References mAssemblerProgram, Ogre::Resource::mIsLoaded, Ogre::Resource::unload(), and unloadImpl(). Referenced by load().

virtual void Ogre::HighLevelGpuProgram::unloadImpl | ( | void |  | ) | `[protected, pure virtual]`

| Internal unload implementation, must be implemented by subclasses. Implemented in Ogre::CgProgram, Ogre::D3D9HLSLProgram, and Ogre::GLSLProgram. Referenced by unload().

## Member Data Documentation

GpuProgram* Ogre::HighLevelGpuProgram::mAssemblerProgram`[protected]`

| The underlying assembler program. Definition at line 61 of file OgreHighLevelGpuProgram.h. Referenced by Ogre::GLSLProgram::createLowLevelImpl(), Ogre::D3D9HLSLProgram::createLowLevelImpl(), Ogre::CgProgram::createLowLevelImpl(), load(), unload(), and Ogre::GLSLProgram::unloadImpl().

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

| The default parameters for use with this object. Definition at line 513 of file OgreGpuProgram.h. Referenced by createParameters(), Ogre::GpuProgram::createParameters(), and Ogre::GpuProgram::getDefaultParameters().

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

| The name of the file to load source from (may be blank). Definition at line 503 of file OgreGpuProgram.h. Referenced by Ogre::GpuProgram::load(), Ogre::D3D9GpuProgram::load(), 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]`

| Whether the high-level program (and it's parameter defs) is loaded. Definition at line 59 of file OgreHighLevelGpuProgram.h. Referenced by 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(), load(), Ogre::GpuProgram::load(), Ogre::GLTexture::load(), Ogre::GLSLGpuProgram::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(), 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 507 of file OgreGpuProgram.h. Referenced by Ogre::GLSLGpuProgram::GLSLGpuProgram(), 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::GLSLProgram::attachToProgramObject(), Ogre::BspLevel::BspLevel(), Ogre::Mesh::buildEdgeList(), Ogre::Mesh::buildTangentVectors(), Ogre::Material::clone(), Ogre::Material::compile(), Ogre::GLSLProgram::compile(), Ogre::Material::copyDetailsTo(), Ogre::Quake3Shader::createAsMaterial(), Ogre::D3D9HLSLProgram::createLowLevelImpl(), Ogre::CgProgram::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::GLSLProgram::loadFromSource(), Ogre::GLArbGpuProgram::loadFromSource(), Ogre::D3D9HLSLProgram::loadFromSource(), Ogre::D3D9GpuProgram::loadFromSource(), Ogre::CgProgram::loadFromSource(), Ogre::GLTexture::loadImages(), Ogre::Material::Material(), Ogre::Mesh::Mesh(), Ogre::Material::operator=(), Ogre::Overlay::Overlay(), Ogre::Quake3Shader::Quake3Shader(), Ogre::CgProgram::selectProfile(), Ogre::Mesh::setSkeletonName(), Ogre::Skeleton::Skeleton(), Ogre::StringResource::StringResource(), Ogre::Texture::Texture(), Ogre::Zip::unload(), Ogre::DynLib::unload(), Ogre::CgProgram::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.

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

| Does this program want light states passed through fixed pipeline. Definition at line 515 of file OgreGpuProgram.h. Referenced by Ogre::GLSLProgram::GLSLProgram().

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

| Dictionary of parameters. Definition at line 30 of file OgreStringInterface.cpp. Referenced by Ogre::StringInterface::cleanupDictionary().

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

Referenced by Ogre::GpuProgram::load(), Ogre::D3D9GpuProgram::load(), Ogre::GLSLProgram::loadFromSource(), Ogre::GLArbGpuProgram::loadFromSource(), Ogre::GLGpuNvparseProgram::loadFromSource(), Ogre::D3D9HLSLProgram::loadFromSource(), Ogre::D3D9GpuProgram::loadFromSource(), Ogre::CgProgram::loadFromSource(), 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 509 of file OgreGpuProgram.h. Referenced by Ogre::GpuProgram::isSupported().

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

| The type of the program. Definition at line 501 of file OgreGpuProgram.h. Referenced by Ogre::GLSLGpuProgram::bindProgram(), Ogre::GLArbGpuProgram::bindProgramParameters(), Ogre::D3D9HLSLProgram::createLowLevelImpl(), Ogre::CgProgram::createLowLevelImpl(), and Ogre::GLSLGpuProgram::unbindProgram().

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

- OgreHighLevelGpuProgram.h
- OgreHighLevelGpuProgram.cpp

Copyright © 2002-2003 by The OGRE Team
Last modified Sun Nov 28 19:51:05 2004