| OGRE 1.11.1 Object-Oriented Graphics Rendering Engine

Classes | Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
Ogre::D3D11HLSLProgram Class Reference

Specialization of HighLevelGpuProgram to provide support for D3D11 High-Level Shader Language (HLSL). More...

`#include <OgreD3D11HLSLProgram.h>`

Inheritance diagram for Ogre::D3D11HLSLProgram:
[legend]

## Classes
class | CmdColumnMajorMatrices
| Command object for setting matrix packing in column-major order. More...
class | CmdEnableBackwardsCompatibility
| Command object for setting backwards compatibility. More...
class | CmdEntryPoint
| Command object for setting entry point. More...
class | CmdPreprocessorDefines
| Command object for setting macro defines. More...
class | CmdTarget
| Command object for setting target assembler. More...

## Public Types
enum | LoadingFlags { LF_DEFAULT = 0, LF_INCLUDE_NON_RELOADABLE = 1, LF_ONLY_UNREFERENCED = 2, LF_ONLY_UNREFERENCED_INCLUDE_NON_RELOADABLE = 3, LF_PRESERVE_STATE = 4 }
| Enum that allow to choose subset of unloaded/reloaded resources and to adjust reloading behavior. More...
enum | LoadingState { LOADSTATE_UNLOADED, LOADSTATE_LOADING, LOADSTATE_LOADED, LOADSTATE_UNLOADING, LOADSTATE_PREPARED, LOADSTATE_PREPARING }
| Enum identifying the loading state of the resource. More...

## Public Member Functions
| D3D11HLSLProgram (ResourceManager *creator, const String &name, ResourceHandle handle, const String &group, bool isManual, ManualResourceLoader *loader, D3D11Device &device)
| ~D3D11HLSLProgram ()
virtual void | _dirtyState ()
| Manually mark the state of this resource as having been changed. More...
void | _fireLoadingComplete (bool wasBackgroundLoaded)
| Firing of loading complete event. More...
void | _firePreparingComplete (bool wasBackgroundLoaded)
| Firing of preparing complete event. More...
void | _fireUnloadingComplete (void)
| Firing of unloading complete event. More...
GpuProgram * | _getBindingDelegate (void)
| Returns the GpuProgram which should be bound to the pipeline. More...
void | _notifyOrigin (const String &origin)
| Notify this resource of it's origin. More...
virtual void | addListener (Listener *lis)
| Register a listener on this resource. More...
virtual void | buildConstantDefinitions () const
| Build the constant definition map, must be overridden. More...
virtual size_t | calculateSize (void) const
| Calculate the size of a resource; this will only be called after 'load'. More...
virtual void | changeGroupOwnership (const String &newGroup)
| Change the resource group ownership of a Resource. More...
void | copyParametersTo (StringInterface *dest) const
| Method for copying this object's parameters to another object. More...
void | CreateComputeShader ()
void | CreateDomainShader ()
void | CreateGeometryShader ()
void | CreateHullShader ()
GpuProgramParametersSharedPtr | createParameters (void)
| Overridden from GpuProgram. More...
void | CreatePixelShader ()
void | CreateVertexShader ()
virtual void | escalateLoading ()
| Escalates the loading of a background loaded resource. More...
bool | getColumnMajorMatrices (void) const
| Gets whether matrix packed in column-major order. More...
const String & | getCompatibleTarget (void) const
| Gets the shader target promoted to the first compatible, e.g. More...
virtual Vector3 | getComputeGroupDimensions (void) const
| Returns the number of process groups dispatched by this compute program. More...
ID3D11ComputeShader * | getComputeShader (void) const
ID3D11Buffer * | getConstantBuffer (GpuProgramParametersSharedPtr params, uint16 variabilityMask)
void | getConstantBuffers (ID3D11Buffer **buffers, unsigned int &numBuffers, ID3D11ClassInstance **classes, unsigned int &numInstances, GpuProgramParametersSharedPtr params, uint16 variabilityMask)
const GpuNamedConstants & | getConstantDefinitions () const
| Get the full list of GpuConstantDefinition instances. More...
ResourceManager * | getCreator (void)
| Gets the manager which created this resource. More...
virtual GpuProgramParametersSharedPtr | getDefaultParameters (void)
| Get a reference to the default parameters which are to be used for all uses of this program. More...
ID3D11DomainShader * | getDomainShader (void) const
bool | getEnableBackwardsCompatibility (void) const
| Gets whether backwards compatibility is enabled. More...
const String & | getEntryPoint (void) const
| Gets the entry point defined for this program. More...
ID3D11GeometryShader * | getGeometryShader (void) const
virtual const String & | getGroup (void) const
| Gets the group which this resource is a member of. More...
virtual ResourceHandle | getHandle (void) const
ID3D11HullShader * | getHullShader (void) const
const D3D11_SIGNATURE_PARAMETER_DESC & | getInputParamDesc (unsigned int index) const
const String & | getLanguage (void) const
| Overridden from GpuProgram. More...
virtual LoadingState | getLoadingState () const
| Returns the current loading state. More...
const String & | getManualNamedConstantsFile () const
| Gets the name of a file from which to load named parameters mapping for a program which would not be able to derive named parameters itself. More...
const MicroCode & | getMicroCode (void) const
virtual const String & | getName (void) const
| Gets resource name. More...
String | getNameForMicrocodeCache ()
virtual ushort | getNumberOfPosesIncluded (void) const
| Returns the number of simultaneous poses the vertex program can blend, for use in pose animation. More...
unsigned int | getNumInputs (void) const
unsigned int | getNumOutputs (void) const
const String & | getOrigin (void) const
| Get the origin of this resource, e.g. More...
const D3D11_SIGNATURE_PARAMETER_DESC & | getOutputParamDesc (unsigned int index) const
ParamDictionary * | getParamDictionary (void)
| Retrieves the parameter dictionary for this class. More...
const ParamDictionary * | getParamDictionary (void) const
String | getParameter (const String &name) const
| Generic parameter retrieval method. More...
const ParameterList & | getParameters (void) const
| Retrieves a list of parameters valid for this object. More...
virtual bool | getPassFogStates (void) const
| Returns whether a fragment program wants fog state to be passed through fixed pipeline low level API rendering calls (default true, subclasses can override) More...
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 (default false, subclasses can override) More...
virtual bool | getPassTransformStates (void) const
| Returns whether a vertex program wants transform state to be passed through fixed pipeline low level API rendering calls. More...
ID3D11PixelShader * | getPixelShader (void) const
const String & | getPreprocessorDefines (void) const
| Gets the preprocessor defines used to compile the program. More...
virtual size_t | getSize (void) const
| Retrieves info about the size of the resource. More...
const String & | getSource (void) const
| Gets the assembler source for this program. More...
const String & | getSourceFile (void) const
| Gets the name of the file used as source for this program. More...
virtual size_t | getStateCount () const
| Returns the number of times this resource has changed state, which generally means the number of times it has been loaded. More...
unsigned int | getSubroutineSlot (const String &subroutineSlotName) const
const String & | getSyntaxCode (void) const
| Gets the syntax code for this program e.g. More...
const String & | getTarget (void) const
| Gets the shader target to compile down to, e.g. More...
GpuProgramType | getType (void) const
| Get the program type. More...
ID3D11VertexShader * | getVertexShader (void) const
virtual bool | hasCompileError (void) const
| Did this program encounter a compile error when loading? More...
virtual bool | hasDefaultParameters (void) const
| Returns true if default parameters have been set up. More...
virtual bool | isAdjacencyInfoRequired (void) const
| Returns whether this geometry program requires adjacency information from the input primitives. More...
virtual bool | isBackgroundLoaded (void) const
| Returns whether this Resource has been earmarked for background loading. More...
virtual bool | isLoaded (void) const
| Returns true if the Resource has been loaded, false otherwise. More...
virtual bool | isLoading () const
| Returns whether the resource is currently in the process of background loading. More...
virtual bool | isManuallyLoaded (void) const
| Is this resource manually loaded? More...
virtual bool | isMorphAnimationIncluded (void) const
| Returns whether a vertex program includes the required instructions to perform morph animation. More...
virtual bool | isPoseAnimationIncluded (void) const
| Returns whether a vertex program includes the required instructions to perform pose animation. More...
virtual bool | isPrepared (void) const
| Returns true if the Resource has been prepared, false otherwise. More...
virtual bool | isReloadable (void) const
| Returns true if the Resource is reloadable, false otherwise. More...
virtual bool | isSkeletalAnimationIncluded (void) const
| Returns whether a vertex program includes the required instructions to perform skeletal animation. More...
bool | isSupported (void) const
| Overridden from GpuProgram. More...
virtual bool | isVertexTextureFetchRequired (void) const
| Returns whether this vertex program requires support for vertex texture fetch from the hardware. More...
virtual void | load (bool backgroundThread=false)
| Loads the resource, if it is not already. More...
void | loadFromSource (void)
| Internal load implementation, must be implemented by subclasses. More...
virtual void | prepare (bool backgroundThread=false)
| Prepares the resource for load, if it is not already. More...
void | reinterpretGSForStreamOut (void)
virtual void | reload (LoadingFlags flags=LF_DEFAULT)
| Reloads the resource, if it is already loaded. More...
virtual void | removeListener (Listener *lis)
| Remove a listener on this resource. More...
virtual void | resetCompileError (void)
| Reset a compile error if it occurred, allowing the load to be retried. More...
virtual void | setAdjacencyInfoRequired (bool r)
| Sets whether this geometry program requires adjacency information from the input primitives. More...
virtual void | setBackgroundLoaded (bool bl)
| Tells the resource whether it is background loaded or not. More...
void | setColumnMajorMatrices (bool columnMajor)
| Sets whether matrix packing in column-major order. More...
virtual void | setComputeGroupDimensions (Vector3 dimensions)
| Sets the number of process groups dispatched by this compute program. More...
void | setEnableBackwardsCompatibility (bool enableBackwardsCompatibility)
| Sets whether backwards compatibility is enabled. More...
void | setEntryPoint (const String &entryPoint)
| Sets the entry point for this program ie the first method called. More...
void | setManualNamedConstants (const GpuNamedConstants &namedConstants)
| Allows you to manually provide a set of named parameter mappings to a program which would not be able to derive named parameters itself. More...
void | setManualNamedConstantsFile (const String &paramDefFile)
| Specifies the name of a file from which to load named parameters mapping for a program which would not be able to derive named parameters itself. More...
virtual void | setMorphAnimationIncluded (bool included)
| Sets whether a vertex program includes the required instructions to perform morph animation. More...
bool | setParameter (const String &name, const String &value)
| Generic parameter setting method. More...
void | setParameterList (const NameValuePairList &paramList)
| Generic multiple parameter setting method. More...
virtual void | setPoseAnimationIncluded (ushort poseCount)
| Sets whether a vertex program includes the required instructions to perform pose animation. More...
void | setPreprocessorDefines (const String &defines)
| Sets the preprocessor defines used to compile the program. More...
void | setShaderMacros (D3D_SHADER_MACRO *shaderMacros)
| Sets shader macros created manually. More...
virtual void | setSkeletalAnimationIncluded (bool included)
| Sets whether a vertex program includes the required instructions to perform skeletal animation. More...
void | setSource (const String &source)
| Sets the source assembly for this program from an in-memory string. More...
void | setSourceFile (const String &filename)
| Sets the filename of the source assembly for this program. More...
void | setSyntaxCode (const String &syntax)
| Sets the syntax code for this program e.g. More...
void | setTarget (const String &target)
| Sets the shader target to compile down to, e.g. More...
void | setType (GpuProgramType t)
| Set the program type (only valid before load) More...
virtual void | setVertexTextureFetchRequired (bool r)
| Sets whether this vertex program requires support for vertex texture fetch from the hardware. More...
virtual void | touch (void)
| 'Touches' the resource to indicate it has been used. More...
virtual void | unload (void)
| Unloads the resource; this is not permanent, the resource can be reloaded later if required. More...

## Static Public Member Functions
static void | cleanupDictionary ()
| Cleans up the static 'msDictionary' required to reset Ogre, otherwise the containers are left with invalid pointers, which will lead to a crash as soon as one of the ResourceManager implementers (e.g. More...
static const String | getProgramTypeName (GpuProgramType programType)

## Public Attributes
bool | mReinterpretingGS
| OGRE_AUTO_MUTEX

## Detailed Description

Specialization of HighLevelGpuProgram to provide support for D3D11 High-Level Shader Language (HLSL).

Remarks
  Note that the syntax of D3D11 HLSL is identical to nVidia's Cg language, therefore unless you know you will only ever be deploying on Direct3D, or you have some specific reason for not wanting to use the Cg plugin, I suggest you use Cg instead since that can produce programs for OpenGL too.

## Member Enumeration Documentation

## ◆ LoadingState

enum Ogre::Resource::LoadingState
| inherited

Enum identifying the loading state of the resource.

Enumerator
LOADSTATE_UNLOADED | Not loaded.
LOADSTATE_LOADING | Loading is in progress.
LOADSTATE_LOADED | Fully loaded.
LOADSTATE_UNLOADING | Currently unloading.
LOADSTATE_PREPARED | Fully prepared.
LOADSTATE_PREPARING | Preparing is in progress.

## ◆ LoadingFlags

enum Ogre::Resource::LoadingFlags
| inherited

Enum that allow to choose subset of unloaded/reloaded resources and to adjust reloading behavior.

Enumerator
LF_DEFAULT | Only reloadable resources are processed, reload restores initial state.
LF_INCLUDE_NON_RELOADABLE | Process non-reloadable resources too.
LF_ONLY_UNREFERENCED | Process only resources which are not referenced by any other object. Usefull to reduce resource consumption.
LF_ONLY_UNREFERENCED_INCLUDE_NON_RELOADABLE | Combination of LF_ONLY_UNREFERENCED and LF_INCLUDE_NON_RELOADABLE.
LF_PRESERVE_STATE | Preserve some states during reloading, for example stencil shadows prepareness for Meshes.

## Constructor & Destructor Documentation

## ◆ D3D11HLSLProgram()

Ogre::D3D11HLSLProgram::D3D11HLSLProgram | ( | ResourceManager * | creator,
|  | const String & | name,
|  | ResourceHandle | handle,
|  | const String & | group,
|  | bool | isManual,
|  | ManualResourceLoader * | loader,
|  | D3D11Device & | device
| ) |  |

## ◆ ~D3D11HLSLProgram()

Ogre::D3D11HLSLProgram::~D3D11HLSLProgram | ( |  | ) |

## Member Function Documentation

## ◆ setEntryPoint()

void Ogre::D3D11HLSLProgram::setEntryPoint | ( | const String & | entryPoint | ) |
| inline

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

## ◆ getEntryPoint()

const String& Ogre::D3D11HLSLProgram::getEntryPoint | ( | void |  | ) | const
| inline

Gets the entry point defined for this program.

## ◆ setTarget()

void Ogre::D3D11HLSLProgram::setTarget | ( | const String & | target | ) |

Sets the shader target to compile down to, e.g.

'vs_1_1'.

## ◆ getTarget()

const String& Ogre::D3D11HLSLProgram::getTarget | ( | void |  | ) | const
| inline

Gets the shader target to compile down to, e.g.

'vs_1_1'.

## ◆ getCompatibleTarget()

const String& Ogre::D3D11HLSLProgram::getCompatibleTarget | ( | void |  | ) | const

Gets the shader target promoted to the first compatible, e.g.

'vs_4_0' or 'ps_4_0' if backward compatibility is enabled.

## ◆ setShaderMacros()

void Ogre::D3D11HLSLProgram::setShaderMacros | ( | D3D_SHADER_MACRO * | shaderMacros | ) |

Sets shader macros created manually.

## ◆ setColumnMajorMatrices()

void Ogre::D3D11HLSLProgram::setColumnMajorMatrices | ( | bool | columnMajor | ) |
| inline

Sets whether matrix packing in column-major order.

## ◆ getColumnMajorMatrices()

bool Ogre::D3D11HLSLProgram::getColumnMajorMatrices | ( | void |  | ) | const
| inline

Gets whether matrix packed in column-major order.

## ◆ setEnableBackwardsCompatibility()

void Ogre::D3D11HLSLProgram::setEnableBackwardsCompatibility | ( | bool | enableBackwardsCompatibility | ) |
| inline

Sets whether backwards compatibility is enabled.

## ◆ getEnableBackwardsCompatibility()

bool Ogre::D3D11HLSLProgram::getEnableBackwardsCompatibility | ( | void |  | ) | const
| inline

Gets whether backwards compatibility is enabled.

## ◆ isSupported()

bool Ogre::D3D11HLSLProgram::isSupported | ( | void |  | ) | const
| virtual

Overridden from GpuProgram.

Reimplemented from Ogre::GpuProgram.

## ◆ createParameters()

GpuProgramParametersSharedPtr Ogre::D3D11HLSLProgram::createParameters | ( | void |  | ) |
| virtual

Overridden from GpuProgram.

Reimplemented from Ogre::HighLevelGpuProgram.

## ◆ getLanguage()

const String& Ogre::D3D11HLSLProgram::getLanguage | ( | void |  | ) | const
| virtual

Overridden from GpuProgram.

Reimplemented from Ogre::GpuProgram.

## ◆ buildConstantDefinitions()

virtual void Ogre::D3D11HLSLProgram::buildConstantDefinitions | ( |  | ) | const
| virtual

Build the constant definition map, must be overridden.

Note
  The implementation must fill in the (inherited) mConstantDefs field at a minimum, and if the program requires that parameters are bound using logical parameter indexes then the mFloatLogicalToPhysical and mIntLogicalToPhysical maps must also be populated.

Implements Ogre::HighLevelGpuProgram.

## ◆ getVertexShader()

ID3D11VertexShader* Ogre::D3D11HLSLProgram::getVertexShader | ( | void |  | ) | const

## ◆ getPixelShader()

ID3D11PixelShader* Ogre::D3D11HLSLProgram::getPixelShader | ( | void |  | ) | const

## ◆ getGeometryShader()

ID3D11GeometryShader* Ogre::D3D11HLSLProgram::getGeometryShader | ( | void |  | ) | const

## ◆ getDomainShader()

ID3D11DomainShader* Ogre::D3D11HLSLProgram::getDomainShader | ( | void |  | ) | const

## ◆ getHullShader()

ID3D11HullShader* Ogre::D3D11HLSLProgram::getHullShader | ( | void |  | ) | const

## ◆ getComputeShader()

ID3D11ComputeShader* Ogre::D3D11HLSLProgram::getComputeShader | ( | void |  | ) | const

## ◆ getMicroCode()

const MicroCode& Ogre::D3D11HLSLProgram::getMicroCode | ( | void |  | ) | const

## ◆ getConstantBuffer()

ID3D11Buffer* Ogre::D3D11HLSLProgram::getConstantBuffer | ( | GpuProgramParametersSharedPtr | params,
|  | uint16 | variabilityMask
| ) |  |

## ◆ getConstantBuffers()

void Ogre::D3D11HLSLProgram::getConstantBuffers | ( | ID3D11Buffer ** | buffers,
|  | unsigned int & | numBuffers,
|  | ID3D11ClassInstance ** | classes,
|  | unsigned int & | numInstances,
|  | GpuProgramParametersSharedPtr | params,
|  | uint16 | variabilityMask
| ) |  |

## ◆ getSubroutineSlot()

unsigned int Ogre::D3D11HLSLProgram::getSubroutineSlot | ( | const String & | subroutineSlotName | ) | const

## ◆ CreateVertexShader()

void Ogre::D3D11HLSLProgram::CreateVertexShader | ( |  | ) |

## ◆ CreatePixelShader()

void Ogre::D3D11HLSLProgram::CreatePixelShader | ( |  | ) |

## ◆ CreateGeometryShader()

void Ogre::D3D11HLSLProgram::CreateGeometryShader | ( |  | ) |

## ◆ CreateDomainShader()

void Ogre::D3D11HLSLProgram::CreateDomainShader | ( |  | ) |

## ◆ CreateHullShader()

void Ogre::D3D11HLSLProgram::CreateHullShader | ( |  | ) |

## ◆ CreateComputeShader()

void Ogre::D3D11HLSLProgram::CreateComputeShader | ( |  | ) |

## ◆ loadFromSource()

void Ogre::D3D11HLSLProgram::loadFromSource | ( | void |  | ) |
| virtual

Internal load implementation, must be implemented by subclasses.

Implements Ogre::GpuProgram.

## ◆ reinterpretGSForStreamOut()

void Ogre::D3D11HLSLProgram::reinterpretGSForStreamOut | ( | void |  | ) |

## ◆ getNumInputs()

unsigned int Ogre::D3D11HLSLProgram::getNumInputs | ( | void |  | ) | const

## ◆ getNumOutputs()

unsigned int Ogre::D3D11HLSLProgram::getNumOutputs | ( | void |  | ) | const

## ◆ getNameForMicrocodeCache()

String Ogre::D3D11HLSLProgram::getNameForMicrocodeCache | ( |  | ) |

## ◆ getInputParamDesc()

const D3D11_SIGNATURE_PARAMETER_DESC& Ogre::D3D11HLSLProgram::getInputParamDesc | ( | unsigned int | index | ) | const

## ◆ getOutputParamDesc()

const D3D11_SIGNATURE_PARAMETER_DESC& Ogre::D3D11HLSLProgram::getOutputParamDesc | ( | unsigned int | index | ) | const

## ◆ _getBindingDelegate()

GpuProgram* Ogre::HighLevelGpuProgram::_getBindingDelegate | ( | void |  | ) |
| inline virtual inherited

Returns the GpuProgram which should be bound to the pipeline.

Remarks
  This method is simply to allow some subclasses of GpuProgram to delegate the program which is bound to the pipeline to a delegate, if required.

Reimplemented from Ogre::GpuProgram.

Reimplemented in Ogre::CgProgram, Ogre::UnifiedHighLevelGpuProgram, Ogre::GLSLShader, and Ogre::GLSLESProgram.

## ◆ getConstantDefinitions()

const GpuNamedConstants& Ogre::HighLevelGpuProgram::getConstantDefinitions | ( |  | ) | const
| virtual inherited

Get the full list of GpuConstantDefinition instances.

Note
  Only available if this parameters object has named parameters.

Reimplemented from Ogre::GpuProgram.

## ◆ calculateSize()

virtual size_t Ogre::HighLevelGpuProgram::calculateSize | ( | void |  | ) | const
| virtual inherited

Calculate the size of a resource; this will only be called after 'load'.

Reimplemented from Ogre::GpuProgram.

Reimplemented in Ogre::GLSLESProgram, Ogre::UnifiedHighLevelGpuProgram, and Ogre::GLSLShader.

## ◆ setPreprocessorDefines()

void Ogre::HighLevelGpuProgram::setPreprocessorDefines | ( | const String & | defines | ) |
| inline inherited

Sets the preprocessor defines used to compile the program.

## ◆ getPreprocessorDefines()

const String& Ogre::HighLevelGpuProgram::getPreprocessorDefines | ( | void |  | ) | const
| inline inherited

Gets the preprocessor defines used to compile the program.

## ◆ getProgramTypeName()

static const String Ogre::GpuProgram::getProgramTypeName | ( | GpuProgramType | programType | ) |
| static inherited

## ◆ setSourceFile()

void Ogre::GpuProgram::setSourceFile | ( | const String & | filename | ) |
| inherited

Sets the filename of the source assembly for this program.

Remarks
  Setting this will have no effect until you (re)load the program.

## ◆ setSource()

void Ogre::GpuProgram::setSource | ( | const String & | source | ) |
| 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.

## ◆ getSyntaxCode()

const String& Ogre::GpuProgram::getSyntaxCode | ( | void |  | ) | const
| inline inherited

Gets the syntax code for this program e.g.

arbvp1, fp20, vs_1_1 etc

## ◆ setSyntaxCode()

void Ogre::GpuProgram::setSyntaxCode | ( | const String & | syntax | ) |
| inherited

Sets the syntax code for this program e.g.

arbvp1, fp20, vs_1_1 etc

## ◆ getSourceFile()

const String& Ogre::GpuProgram::getSourceFile | ( | void |  | ) | const
| inline inherited

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

## ◆ getSource()

const String& Ogre::GpuProgram::getSource | ( | void |  | ) | const
| inline inherited

Gets the assembler source for this program.

## ◆ setType()

void Ogre::GpuProgram::setType | ( | GpuProgramType | t | ) |
| inherited

Set the program type (only valid before load)

## ◆ getType()

GpuProgramType Ogre::GpuProgram::getType | ( | void |  | ) | const
| inline inherited

Get the program type.

## ◆ setSkeletalAnimationIncluded()

virtual void Ogre::GpuProgram::setSkeletalAnimationIncluded | ( | bool | included | ) |
| inline 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.

## ◆ isSkeletalAnimationIncluded()

virtual bool Ogre::GpuProgram::isSkeletalAnimationIncluded | ( | void |  | ) | const
| inline 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.

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

## ◆ setMorphAnimationIncluded()

virtual void Ogre::GpuProgram::setMorphAnimationIncluded | ( | bool | included | ) |
| inline 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.

## ◆ setPoseAnimationIncluded()

virtual void Ogre::GpuProgram::setPoseAnimationIncluded | ( | ushort | poseCount | ) |
| inline 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

## ◆ isMorphAnimationIncluded()

virtual bool Ogre::GpuProgram::isMorphAnimationIncluded | ( | void |  | ) | const
| inline 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.

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

## ◆ isPoseAnimationIncluded()

virtual bool Ogre::GpuProgram::isPoseAnimationIncluded | ( | void |  | ) | const
| inline 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.

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

## ◆ getNumberOfPosesIncluded()

virtual ushort Ogre::GpuProgram::getNumberOfPosesIncluded | ( | void |  | ) | const
| inline virtual inherited

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

Reimplemented in Ogre::UnifiedHighLevelGpuProgram.

## ◆ setVertexTextureFetchRequired()

virtual void Ogre::GpuProgram::setVertexTextureFetchRequired | ( | bool | r | ) |
| inline virtual inherited

Sets whether this vertex program requires support for vertex texture fetch from the hardware.

## ◆ isVertexTextureFetchRequired()

virtual bool Ogre::GpuProgram::isVertexTextureFetchRequired | ( | void |  | ) | const
| inline virtual inherited

Returns whether this vertex program requires support for vertex texture fetch from the hardware.

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

## ◆ setAdjacencyInfoRequired()

virtual void Ogre::GpuProgram::setAdjacencyInfoRequired | ( | bool | r | ) |
| inline virtual inherited

Sets whether this geometry program requires adjacency information from the input primitives.

## ◆ isAdjacencyInfoRequired()

virtual bool Ogre::GpuProgram::isAdjacencyInfoRequired | ( | void |  | ) | const
| inline virtual inherited

Returns whether this geometry program requires adjacency information from the input primitives.

## ◆ setComputeGroupDimensions()

virtual void Ogre::GpuProgram::setComputeGroupDimensions | ( | Vector3 | dimensions | ) |
| inline virtual inherited

Sets the number of process groups dispatched by this compute program.

## ◆ getComputeGroupDimensions()

virtual Vector3 Ogre::GpuProgram::getComputeGroupDimensions | ( | void |  | ) | const
| inline virtual inherited

Returns the number of process groups dispatched by this compute program.

## ◆ getDefaultParameters()

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.

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

## ◆ hasDefaultParameters()

virtual bool Ogre::GpuProgram::hasDefaultParameters | ( | void |  | ) | const
| inline virtual inherited

Returns true if default parameters have been set up.

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

## ◆ getPassSurfaceAndLightStates()

virtual bool Ogre::GpuProgram::getPassSurfaceAndLightStates | ( | void |  | ) | const
| inline virtual inherited

Returns whether a vertex program wants light and material states to be passed through fixed pipeline low level API rendering calls (default false, subclasses can override)

Remarks
  Most vertex programs do not need this material information, however GLSL shaders can refer to this material and lighting state so enable this option

Reimplemented in Ogre::CgProgram, Ogre::UnifiedHighLevelGpuProgram, and Ogre::GLSLShaderCommon.

## ◆ getPassFogStates()

virtual bool Ogre::GpuProgram::getPassFogStates | ( | void |  | ) | const
| inline virtual inherited

Returns whether a fragment program wants fog state to be passed through fixed pipeline low level API rendering calls (default true, subclasses can override)

Remarks
  On DirectX, shader model 2 and earlier continues to have fixed-function fog applied to it, so fog state is still passed (you should disable fog on the pass if you want to perform fog in the shader). In OpenGL it is also common to be able to access the fixed-function fog state inside the shader.

Reimplemented in Ogre::CgProgram, Ogre::UnifiedHighLevelGpuProgram, and Ogre::GLSLShaderCommon.

## ◆ getPassTransformStates()

virtual bool Ogre::GpuProgram::getPassTransformStates | ( | void |  | ) | const
| inline virtual inherited

Returns whether a vertex program wants transform state to be passed through fixed pipeline low level API rendering calls.

Remarks
  Most vertex programs do not need fixed-function transform information, however GLSL shaders can refer to this state so enable this option

Reimplemented in Ogre::CgProgram, Ogre::UnifiedHighLevelGpuProgram, and Ogre::GLSLShaderCommon.

## ◆ hasCompileError()

virtual bool Ogre::GpuProgram::hasCompileError | ( | void |  | ) | const
| inline virtual inherited

Did this program encounter a compile error when loading?

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

## ◆ resetCompileError()

virtual void Ogre::GpuProgram::resetCompileError | ( | void |  | ) |
| inline virtual inherited

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

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

## ◆ setManualNamedConstants()

void Ogre::GpuProgram::setManualNamedConstants | ( | const GpuNamedConstants & | namedConstants | ) |
| inherited

Allows you to manually provide a set of named parameter mappings to a program which would not be able to derive named parameters itself.

Remarks
  You may wish to use this if you have assembler programs that were compiled from a high-level source, and want the convenience of still being able to use the named parameters from the original high-level source.

See also
  setManualNamedConstantsFile

## ◆ setManualNamedConstantsFile()

void Ogre::GpuProgram::setManualNamedConstantsFile | ( | const String & | paramDefFile | ) |
| inherited

Specifies the name of a file from which to load named parameters mapping for a program which would not be able to derive named parameters itself.

Remarks
  You may wish to use this if you have assembler programs that were compiled from a high-level source, and want the convenience of still being able to use the named parameters from the original high-level source. This method will make a low-level program search in the resource group of the program for the named file from which to load parameter names from. The file must be in the format produced by GpuNamedConstants::save.

## ◆ getManualNamedConstantsFile()

const String& Ogre::GpuProgram::getManualNamedConstantsFile | ( |  | ) | const
| inline inherited

Gets the name of a file from which to load named parameters mapping for a program which would not be able to derive named parameters itself.

## ◆ prepare()

virtual void Ogre::Resource::prepare | ( | bool | backgroundThread = `false` | ) |
| virtual inherited

Prepares the resource for load, if it is not already.

One can call prepare() before load(), but this is not required as load() will call prepare() itself, if needed. When OGRE_THREAD_SUPPORT==1 both load() and prepare() are thread-safe. When OGRE_THREAD_SUPPORT==2 however, only prepare() is thread-safe. The reason for this function is to allow a background thread to do some of the loading work, without requiring the whole render system to be thread-safe. The background thread would call prepare() while the main render loop would later call load(). So long as prepare() remains thread-safe, subclasses can arbitrarily split the work of loading a resource between load() and prepare(). It is best to try and do as much work in prepare(), however, since this will leave less work for the main render thread to do and thus increase FPS.

Parameters

  backgroundThread | Whether this is occurring in a background thread

## ◆ load()

virtual void Ogre::Resource::load | ( | bool | backgroundThread = `false` | ) |
| 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.

Parameters

  backgroundThread | Indicates whether the caller of this method is the background resource loading thread.

Reimplemented in Ogre::UnifiedHighLevelGpuProgram.

## ◆ reload()

virtual void Ogre::Resource::reload | ( | LoadingFlags | flags = `LF_DEFAULT` | ) |
| 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.

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

## ◆ isReloadable()

virtual bool Ogre::Resource::isReloadable | ( | void |  | ) | const
| inline virtual inherited

Returns true if the Resource is reloadable, false otherwise.

Reimplemented in Ogre::UnifiedHighLevelGpuProgram.

## ◆ isManuallyLoaded()

virtual bool Ogre::Resource::isManuallyLoaded | ( | void |  | ) | const
| inline virtual inherited

Is this resource manually loaded?

## ◆ unload()

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

## ◆ getSize()

virtual size_t Ogre::Resource::getSize | ( | void |  | ) | const
| inline virtual inherited

Retrieves info about the size of the resource.

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

## ◆ touch()

virtual void Ogre::Resource::touch | ( | void |  | ) |
| virtual inherited

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

Reimplemented in Ogre::Material, Ogre::CgProgram, and Ogre::UnifiedHighLevelGpuProgram.

Referenced by Ogre::Material::touch().

## ◆ getName()

virtual const String& Ogre::Resource::getName | ( | void |  | ) | const
| inline virtual inherited

Gets resource name.

Reimplemented in Ogre::SkeletonInstance.

Referenced by Ogre::GpuProgramUsage::getProgramName(), and OgreBites::TrayManager::resourceLoadStarted().

## ◆ getHandle()

virtual ResourceHandle Ogre::Resource::getHandle | ( | void |  | ) | const
| inline virtual inherited

Reimplemented in Ogre::SkeletonInstance.

## ◆ isPrepared()

virtual bool Ogre::Resource::isPrepared | ( | void |  | ) | const
| inline virtual inherited

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

## ◆ isLoaded()

virtual bool Ogre::Resource::isLoaded | ( | void |  | ) | const
| inline virtual inherited

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

Reimplemented in Ogre::UnifiedHighLevelGpuProgram.

## ◆ isLoading()

virtual bool Ogre::Resource::isLoading | ( |  | ) | const
| inline virtual inherited

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

Reimplemented in Ogre::UnifiedHighLevelGpuProgram.

## ◆ getLoadingState()

virtual LoadingState Ogre::Resource::getLoadingState | ( |  | ) | const
| inline virtual inherited

Returns the current loading state.

Reimplemented in Ogre::UnifiedHighLevelGpuProgram.

## ◆ isBackgroundLoaded()

virtual bool Ogre::Resource::isBackgroundLoaded | ( | void |  | ) | const
| inline virtual inherited

Returns whether this Resource has been earmarked for background loading.

Remarks
  This option only makes sense when you have built Ogre with thread support (OGRE_THREAD_SUPPORT). If a resource has been marked for background loading, then it won't load on demand like normal when load() is called. Instead, it will ignore request to load() except if the caller indicates it is the background loader. Any other users of this resource should check isLoaded(), and if that returns false, don't use the resource and come back later.

Reimplemented in Ogre::UnifiedHighLevelGpuProgram.

## ◆ setBackgroundLoaded()

virtual void Ogre::Resource::setBackgroundLoaded | ( | bool | bl | ) |
| inline virtual inherited

Tells the resource whether it is background loaded or not.

See also
  Resource::isBackgroundLoaded. Note that calling this only defers the normal on-demand loading behaviour of a resource, it does not actually set up a thread to make sure the resource gets loaded in the background. You should use ResourceBackgroundLoadingQueue to manage the actual loading (which will call this method itself).

Reimplemented in Ogre::UnifiedHighLevelGpuProgram.

## ◆ escalateLoading()

virtual void Ogre::Resource::escalateLoading | ( |  | ) |
| virtual inherited

Escalates the loading of a background loaded resource.

Remarks
  If a resource is set to load in the background, but something needs it before it's been loaded, there could be a problem. If the user of this resource really can't wait, they can escalate the loading which basically pulls the loading into the current thread immediately. If the resource is already being loaded but just hasn't quite finished then this method will simply wait until the background load is complete.

Reimplemented in Ogre::UnifiedHighLevelGpuProgram.

## ◆ addListener()

virtual void Ogre::Resource::addListener | ( | Listener * | lis | ) |
| virtual inherited

Register a listener on this resource.

See also
  Resource::Listener

Reimplemented in Ogre::UnifiedHighLevelGpuProgram.

## ◆ removeListener()

virtual void Ogre::Resource::removeListener | ( | Listener * | lis | ) |
| virtual inherited

Remove a listener on this resource.

See also
  Resource::Listener

Reimplemented in Ogre::UnifiedHighLevelGpuProgram.

## ◆ getGroup()

virtual const String& Ogre::Resource::getGroup | ( | void |  | ) | const
| inline virtual inherited

Gets the group which this resource is a member of.

Reimplemented in Ogre::SkeletonInstance.

## ◆ changeGroupOwnership()

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

## ◆ getCreator()

ResourceManager* Ogre::Resource::getCreator | ( | void |  | ) |
| inline inherited

Gets the manager which created this resource.

## ◆ getOrigin()

const String& Ogre::Resource::getOrigin | ( | void |  | ) | const
| inline 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.

## ◆ _notifyOrigin()

void Ogre::Resource::_notifyOrigin | ( | const String & | origin | ) |
| inline inherited

Notify this resource of it's origin.

## ◆ getStateCount()

virtual size_t Ogre::Resource::getStateCount | ( |  | ) | const
| inline virtual inherited

Returns the number of times this resource has changed state, which generally means the number of times it has been loaded.

Objects that build derived data based on the resource can check this value against a copy they kept last time they built this derived data, in order to know whether it needs rebuilding. This is a nice way of monitoring changes without having a tightly-bound callback.

## ◆ _dirtyState()

virtual void Ogre::Resource::_dirtyState | ( |  | ) |
| virtual inherited

Manually mark the state of this resource as having been changed.

Remarks
  You only need to call this from outside if you explicitly want derived objects to think this object has changed.

See also
  getStateCount.

## ◆ _fireLoadingComplete()

void Ogre::Resource::_fireLoadingComplete | ( | bool | wasBackgroundLoaded | ) |
| inherited

Firing of loading complete event.

Remarks
  You should call this from the thread that runs the main frame loop to avoid having to make the receivers of this event thread-safe. If you use Ogre's built in frame loop you don't need to call this yourself.

Parameters

  wasBackgroundLoaded | Whether this was a background loaded event

## ◆ _firePreparingComplete()

void Ogre::Resource::_firePreparingComplete | ( | bool | wasBackgroundLoaded | ) |
| inherited

Firing of preparing complete event.

Remarks
  You should call this from the thread that runs the main frame loop to avoid having to make the receivers of this event thread-safe. If you use Ogre's built in frame loop you don't need to call this yourself.

Parameters

  wasBackgroundLoaded | Whether this was a background loaded event

## ◆ _fireUnloadingComplete()

void Ogre::Resource::_fireUnloadingComplete | ( | void |  | ) |
| inherited

Firing of unloading complete event.

Remarks
  You should call this from the thread that runs the main frame loop to avoid having to make the receivers of this event thread-safe. If you use Ogre's built in frame loop you don't need to call this yourself.

## ◆ getParamDictionary() [1/2]

ParamDictionary* Ogre::StringInterface::getParamDictionary | ( | void |  | ) |
| inline 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.

## ◆ getParamDictionary() [2/2]

const ParamDictionary* Ogre::StringInterface::getParamDictionary | ( | void |  | ) | const
| inline inherited

## ◆ getParameters()

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.

## ◆ setParameter()

bool Ogre::StringInterface::setParameter | ( | const String & | name,
|  | const String & | value
| ) |  |
| 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().

## ◆ setParameterList()

void Ogre::StringInterface::setParameterList | ( | const NameValuePairList & | paramList | ) |
| 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

## ◆ getParameter()

String Ogre::StringInterface::getParameter | ( | const String & | name | ) | const
| inline 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

References Ogre::ParamCommand::doGet().

## ◆ copyParametersTo()

void Ogre::StringInterface::copyParametersTo | ( | StringInterface * | dest | ) | const
| inline 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.

References Ogre::StringInterface::setParameter().

## ◆ cleanupDictionary()

static void Ogre::StringInterface::cleanupDictionary | ( |  | ) |
| static inherited

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

MaterialManager) initializes.

## Member Data Documentation

## ◆ mReinterpretingGS

bool Ogre::D3D11HLSLProgram::mReinterpretingGS

## ◆ OGRE_AUTO_MUTEX

Ogre::Resource::OGRE_AUTO_MUTEX
| inherited

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

- OgreD3D11HLSLProgram.h