OGRE-Next: Ogre::HighLevelGpuProgram Class Reference

| OGRE-Next 3.0.0 Object-Oriented Graphics Rendering Engine

Loading...
Searching...
No Matches
Ogre::HighLevelGpuProgram Class Referenceabstract
Core » Resources

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

`#include <OgreHighLevelGpuProgram.h>`

Inheritance diagram for Ogre::HighLevelGpuProgram:
[legend]

## Classes
class | CmdEnableIncludeHeader
| Command object for enabling include in shaders. More...
class | CmdUseHlmsParser
| Command object for using Hlms parser. More...

## Public Member Functions
| HighLevelGpuProgram (ResourceManager *creator, const String &name, ResourceHandle handle, const String &group, bool isManual=false, ManualResourceLoader *loader=0)
| Constructor, should be used only by factory classes.
| ~HighLevelGpuProgram () override
GpuProgram * | _getBindingDelegate () override
| Returns the GpuProgram which should be bound to the pipeline.
size_t | calculateSize () const override
| Calculate the size of a resource; this will only be called after 'load'.
GpuProgramParametersSharedPtr | createParameters () override
| Creates a new parameters object compatible with this program definition.
const GpuNamedConstants & | getConstantDefinitions () const override
| Get the full list of GpuConstantDefinition instances.
bool | getEnableIncludeHeader () const
bool | getUseHlmsParser () const
void | setEnableIncludeHeader (bool bEnable)
| Whether we should parse the source code looking for include files and embedding the file.
void | setUseHlmsParser (bool bUse)
| Whether we should run the shader through the Hlms parser.
Public Member Functions inherited from Ogre::GpuProgram
| GpuProgram (ResourceManager *creator, const String &name, ResourceHandle handle, const String &group, bool isManual=false, ManualResourceLoader *loader=0)
| ~GpuProgram () override
bool | getBuildParametersFromReflection () const
virtual Vector3 | getComputeGroupDimensions () const
| Returns the number of process groups dispatched by this compute program.
virtual GpuProgramParametersSharedPtr | getDefaultParameters ()
| Get a reference to the default parameters which are to be used for all uses of this program.
virtual const String & | getLanguage () const
| Returns a string that specifies the language of the gpu programs as specified in a material script.
virtual 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.
virtual ushort | getNumberOfPosesIncluded () const
| Returns the number of simultaneous poses the vertex program can blend, for use in pose animation.
uint8 | getNumClipDistances () const
| Retrieves the number of clip distances. See GpuProgram::setNumClipDistances.
virtual bool | getPassFogStates () 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).
virtual bool | getPassSurfaceAndLightStates () 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).
virtual bool | getPassTransformStates () const
| Returns whether a vertex program wants transform state to be passed through fixed pipeline low level API rendering calls.
virtual const String & | getSource () const
| Gets the assembler source for this program.
virtual const String & | getSourceFile () const
| Gets the name of the file used as source for this program.
virtual const String & | getSyntaxCode () const
| Gets the syntax code for this program e.g.
virtual GpuProgramType | getType () const
| Get the program type.
virtual bool | hasCompileError () const
| Did this program encounter a compile error when loading?
virtual bool | hasDefaultParameters () const
| Returns true if default parameters have been set up.
virtual bool | isAdjacencyInfoRequired () const
| Returns whether this geometry program requires adjacency information from the input primitives.
virtual bool | isMorphAnimationIncluded () const
| Returns whether a vertex program includes the required instructions to perform morph animation.
virtual bool | isPoseAnimationIncluded () const
| Returns whether a vertex program includes the required instructions to perform pose animation.
virtual bool | isSkeletalAnimationIncluded () const
| Returns whether a vertex program includes the required instructions to perform skeletal animation.
virtual bool | isSupported () const
| Returns whether this program can be supported on the current renderer and hardware.
virtual bool | isVertexTextureFetchRequired () const
| Returns whether this vertex program requires support for vertex texture fetch from the hardware.
virtual bool | isVpAndRtArrayIndexFromAnyShaderRequired () const
| Returns whether this program requires support for choosing viewport or render target index in any program or only geometry one.
virtual void | resetCompileError ()
| Reset a compile error if it occurred, allowing the load to be retried.
virtual void | setAdjacencyInfoRequired (bool r)
| Sets whether this geometry program requires adjacency information from the input primitives.
virtual void | setAutoReflectArrayBindingsInRootLayout (bool bReflectArrayRootLayouts)
| Set to true to reflects the shader looking for array bindings (e.g.
void | setBuildParametersFromReflection (bool buildParams)
virtual void | setComputeGroupDimensions (Vector3 dimensions)
| Sets the number of process groups dispatched by this compute program.
virtual 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.
virtual 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.
virtual void | setMorphAnimationIncluded (bool included)
| Sets whether a vertex program includes the required instructions to perform morph animation.
void | setNumClipDistances (const uint8 numClipDistances)
| Sets the number of clip distances this shader uses.
virtual void | setPoseAnimationIncluded (ushort poseCount)
| Sets whether a vertex program includes the required instructions to perform pose animation.
void | setPrefabRootLayout (const PrefabRootLayout::PrefabRootLayout &prefab)
| Sets a prefab root layout, mostly meant for low level materials (e.g.
virtual void | setReplaceVersionMacro (bool bReplace)
| When true:
virtual void | setRootLayout (GpuProgramType t, const RootLayout &rootLayout)
| Sets a RootLayout programmatically, thus the shader source won't be parsed looking for one We will call validate().
virtual void | setSkeletalAnimationIncluded (bool included)
| Sets whether a vertex program includes the required instructions to perform skeletal animation.
virtual void | setSource (const String &source)
| Sets the source assembly for this program from an in-memory string.
virtual void | setSource (const String &source, const String &debugFilename)
| Sets the source assembly for this program from an in-memory string, while providing a path to a file, which can be needed/useful for debugging shaders (i.e.
virtual void | setSourceFile (const String &filename)
| Sets the filename of the source assembly for this program.
virtual void | setSyntaxCode (const String &syntax)
| Sets the syntax code for this program e.g.
virtual void | setType (GpuProgramType t)
| Set the program type (only valid before load).
virtual void | setUniformBlockBinding (const char *blockName, uint32 bindingSlot)
| For GL only. Program must be bound when calling.
virtual void | setVertexTextureFetchRequired (bool r)
| Sets whether this vertex program requires support for vertex texture fetch from the hardware.
virtual void | setVpAndRtArrayIndexFromAnyShaderRequired (bool r)
| Sets whether this program requires support for choosing viewport or render target index in any program or only geometry one.
virtual void | unsetRootLayout ()
Public Member Functions inherited from Ogre::Resource
| Resource (ResourceManager *creator, const String &name, ResourceHandle handle, const String &group, bool isManual=false, ManualResourceLoader *loader=0)
| Standard constructor.
virtual | ~Resource ()
| Virtual destructor.
virtual void | _dirtyState ()
| Manually mark the state of this resource as having been changed.
virtual void | _fireLoadingComplete (bool wasBackgroundLoaded)
| Firing of loading complete event.
virtual void | _firePreparingComplete (bool wasBackgroundLoaded)
| Firing of preparing complete event.
virtual void | _fireUnloadingComplete ()
| Firing of unloading complete event.
virtual void | _notifyOrigin (const String &origin)
| Notify this resource of it's origin.
virtual void | addListener (Listener *lis)
| Register a listener on this resource.
virtual void | changeGroupOwnership (const String &newGroup)
| Change the resource group ownership of a Resource.
virtual void | escalateLoading ()
| Escalates the loading of a background loaded resource.
virtual ResourceManager * | getCreator ()
| Gets the manager which created this resource.
virtual const String & | getGroup () const
| Gets the group which this resource is a member of.
virtual ResourceHandle | getHandle () const
virtual LoadingState | getLoadingState () const
| Returns the current loading state.
virtual const String & | getName () const
| Gets resource name.
virtual const String & | getOrigin () const
| Get the origin of this resource, e.g.
virtual size_t | getSize () const
| Retrieves info about the size of the resource.
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.
virtual bool | isBackgroundLoaded () const
| Returns whether this Resource has been earmarked for background loading.
virtual bool | isLoaded () const
| Returns true if the Resource has been loaded, false otherwise.
virtual bool | isLoading () const
| Returns whether the resource is currently in the process of background loading.
virtual bool | isManuallyLoaded () const
| Is this resource manually loaded?
virtual bool | isPrepared () const
| Returns true if the Resource has been prepared, false otherwise.
virtual bool | isReloadable () const
| Returns true if the Resource is reloadable, false otherwise.
virtual void | load (bool backgroundThread=false)
| Loads the resource, if it is not already.
bool | markForReload ()
virtual void | prepare (bool backgroundThread=false)
| Prepares the resource for load, if it is not already.
virtual void | reload (LoadingFlags flags=LF_DEFAULT)
| Reloads the resource, if it is already loaded.
virtual void | removeListener (Listener *lis)
| Remove a listener on this resource.
virtual void | setBackgroundLoaded (bool bl)
| Tells the resource whether it is background loaded or not.
virtual void | setManuallyLoaded (bool isManual)
| Set "Is this resource manually loaded?".
virtual void | setToLoaded ()
| Change the Resource loading state to loaded.
virtual void | touch ()
| 'Touches' the resource to indicate it has been used.
virtual void | unload ()
| Unloads the resource; this is not permanent, the resource can be reloaded later if required.
Public Member Functions inherited from Ogre::StringInterface
| StringInterface ()
virtual | ~StringInterface ()
| Virtual destructor, see Effective C++.
virtual void | copyParametersTo (StringInterface *dest) const
| Method for copying this object's parameters to another object.
ParamDictionary * | getParamDictionary ()
| Retrieves the parameter dictionary for this class.
const ParamDictionary * | getParamDictionary () const
virtual String | getParameter (const String &name) const
| Generic parameter retrieval method.
const ParameterList & | getParameters () const
| Retrieves a list of parameters valid for this object.
virtual bool | setParameter (const String &name, const String &value)
| Generic parameter setting method.
virtual void | setParameterList (const NameValuePairList &paramList)
| Generic multiple parameter setting method.

## Static Public Attributes
static CmdEnableIncludeHeader | msEnableIncludeHeaderCmd
static CmdUseHlmsParser | msUseHlmsParser

## Additional Inherited Members
Public Types inherited from Ogre::Resource
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 , LF_MARKED_FOR_RELOAD = 8 }
| 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 , LOADSTATE_UNLOADED_MARKED_FOR_RELOAD }
| Enum identifying the loading state of the resource. More...
Static Public Member Functions inherited from Ogre::StringInterface
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.
Public Attributes inherited from Ogre::Resource
| OGRE_AUTO_MUTEX

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

## Constructor & Destructor Documentation

## ◆ HighLevelGpuProgram()

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

Constructor, should be used only by factory classes.

## ◆ ~HighLevelGpuProgram()

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

## Member Function Documentation

## ◆ _getBindingDelegate()

GpuProgram * Ogre::HighLevelGpuProgram::_getBindingDelegate | ( |  | ) |
| inlineoverridevirtual

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

References Ogre::GpuProgram::GpuProgram().

## ◆ calculateSize()

size_t Ogre::HighLevelGpuProgram::calculateSize | ( |  | ) | const
| overridevirtual

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

Reimplemented from Ogre::GpuProgram.

Reimplemented in Ogre::UnifiedHighLevelGpuProgram.

References calculateSize().

Referenced by calculateSize().

## ◆ createParameters()

GpuProgramParametersSharedPtr Ogre::HighLevelGpuProgram::createParameters | ( |  | ) |
| overridevirtual

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::MetalProgram, Ogre::UnifiedHighLevelGpuProgram, and Ogre::VulkanProgram.

## ◆ getConstantDefinitions()

const GpuNamedConstants & Ogre::HighLevelGpuProgram::getConstantDefinitions | ( |  | ) | const
| overridevirtual

Get the full list of GpuConstantDefinition instances.

Note
  Only available if this parameters object has named parameters.

Reimplemented from Ogre::GpuProgram.

References getConstantDefinitions().

Referenced by getConstantDefinitions().

## ◆ getEnableIncludeHeader()

bool Ogre::HighLevelGpuProgram::getEnableIncludeHeader | ( |  | ) | const

References getEnableIncludeHeader(), and setEnableIncludeHeader().

Referenced by getEnableIncludeHeader().

## ◆ getUseHlmsParser()

bool Ogre::HighLevelGpuProgram::getUseHlmsParser | ( |  | ) | const

References getUseHlmsParser(), and setUseHlmsParser().

Referenced by getUseHlmsParser().

## ◆ setEnableIncludeHeader()

void Ogre::HighLevelGpuProgram::setEnableIncludeHeader | ( | bool | bEnable | ) |

Whether we should parse the source code looking for include files and embedding the file.

Disabled by default to avoid slowing down when #include is not used. Not needed if the API natively supports it (D3D11).

Remarks
  Single line comments are supported:
  // #include "MyFile.h" --> won't be included.
  Block comment lines are not supported, but may not matter if the included file does not close the block:
  /*
  #include "MyFile.h" --> file will be included anyway.
  */
  Preprocessor macros are not supported, but should not matter:
  #if SOME_MACRO
  #include "MyFile.h" --> file will be included anyway.
  #endif
  Recursive includes are supported (e.g. header includes a header)
  Beware included files mess up error reporting (wrong lines)

Parameters

  bEnable | True to support #include. Must be toggled before loading the source file.

Referenced by getEnableIncludeHeader().

## ◆ setUseHlmsParser()

void Ogre::HighLevelGpuProgram::setUseHlmsParser | ( | bool | bUse | ) |

Whether we should run the shader through the Hlms parser.

This parser doesn't yet have access to the entire PSO (i.e. Pixel Shader can't see Vertex Shader).

However it's still useful, specially @foreach()

Remarks
  This is run after setEnableIncludeHeader

  Beware included files mess up error reporting (wrong lines)

Parameters

  bUse | True to run source code through Hlms parser. Must be toggled before loading the source file.

Referenced by getUseHlmsParser().

## Member Data Documentation

## ◆ msEnableIncludeHeaderCmd

CmdEnableIncludeHeader Ogre::HighLevelGpuProgram::msEnableIncludeHeaderCmd
| static

## ◆ msUseHlmsParser

CmdUseHlmsParser Ogre::HighLevelGpuProgram::msUseHlmsParser
| static

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

- OgreHighLevelGpuProgram.h