OGRE  13.6
Object-Oriented Graphics Rendering Engine
Ogre::UnifiedHighLevelGpuProgram Class Referencefinal

Specialisation of HighLevelGpuProgram which just delegates its implementation to one other GpuProgram, allowing a single program definition to represent one supported program from a number of options. More...

#include <OgreUnifiedHighLevelGpuProgram.h>

+ Inheritance diagram for Ogre::UnifiedHighLevelGpuProgram:

Public Member Functions

 UnifiedHighLevelGpuProgram (ResourceManager *creator, const String &name, ResourceHandle handle, const String &group, bool isManual=false, ManualResourceLoader *loader=0)
 Constructor, should be used only by factory classes. More...
 
 ~UnifiedHighLevelGpuProgram ()
 
GpuProgram_getBindingDelegate (void) override
 Returns the GpuProgram which should be bound to the pipeline. More...
 
const GpuProgramPtr_getDelegate () const
 Get the chosen delegate. More...
 
void addDelegateProgram (const String &name)
 Adds a new delegate program to the list. More...
 
void addListener (Listener *lis) override
 Register a listener on this resource. More...
 
size_t calculateSize (void) const override
 Calculate the size of a resource; this will only be called after 'load'. More...
 
void clearDelegatePrograms ()
 Remove all delegate programs. More...
 
GpuProgramParametersSharedPtr createParameters (void) override
 Creates a new parameters object compatible with this program definition. More...
 
void escalateLoading () override
 Escalates the loading of a background loaded resource. More...
 
const GpuProgramParametersPtrgetDefaultParameters (void) override
 Get a reference to the default parameters which are to be used for all uses of this program. More...
 
const StringgetLanguage (void) const override
 Returns a string that specifies the language of the gpu programs as specified in a material script. More...
 
LoadingState getLoadingState () const
 
ushort getNumberOfPosesIncluded (void) const override
 Returns the number of simultaneous poses the vertex program can blend, for use in pose animation. More...
 
bool getPassFogStates (void) const override
 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...
 
bool getPassSurfaceAndLightStates (void) const override
 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...
 
bool getPassTransformStates (void) const override
 Returns whether a vertex program wants transform state to be passed through fixed pipeline low level API rendering calls. More...
 
size_t getSize (void) const
 
const StringgetSource (void) const override
 Gets the assembler source for this program. More...
 
bool hasCompileError (void) const override
 Did this program encounter a compile error when loading? More...
 
bool hasDefaultParameters (void) const override
 Returns true if default parameters have been set up. More...
 
bool isBackgroundLoaded (void) const
 
bool isLoaded (void) const
 
bool isLoading () const
 
bool isMorphAnimationIncluded (void) const override
 Returns whether a vertex program can do morph animation. More...
 
bool isPoseAnimationIncluded (void) const override
 Returns whether a vertex program can do pose animation. More...
 
bool isReloadable (void) const
 
bool isSkeletalAnimationIncluded (void) const override
 Returns whether a vertex program can do skeletal animation. More...
 
bool isSupported (void) const override
 Returns whether this program can be supported on the current renderer and hardware. More...
 
bool isVertexTextureFetchRequired (void) const override
 Returns whether this vertex program requires support for vertex texture fetch from the hardware. More...
 
void load (bool backgroundThread=false) override
 Loads the resource, if it is not already. More...
 
void reload (LoadingFlags flags=LF_DEFAULT) override
 Reloads the resource, if it is already loaded. More...
 
void removeListener (Listener *lis) override
 Remove a listener on this resource. More...
 
void resetCompileError (void) override
 Reset a compile error if it occurred, allowing the load to be retried. More...
 
void setBackgroundLoaded (bool bl)
 
void touch (void) override
 'Touches' the resource to indicate it has been used. More...
 
void unload (void) override
 Unloads the resource; this is not permanent, the resource can be reloaded later if required. More...
 
- Public Member Functions inherited from Ogre::GpuProgram
 GpuProgram (ResourceManager *creator, const String &name, ResourceHandle handle, const String &group, bool isManual=false, ManualResourceLoader *loader=0)
 
virtual ~GpuProgram ()
 
uint32 _getHash (uint32 seed=0) const
 internal method to get the microcode cache id More...
 
virtual const GpuNamedConstantsgetConstantDefinitions ()
 Get the full list of named constants. More...
 
const StringgetManualNamedConstantsFile () 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 StringgetSourceFile (void) const
 Gets the name of the file used as source for this program. More...
 
const StringgetSyntaxCode (void) const
 Gets the syntax code for this program e.g. More...
 
GpuProgramType getType (void) const
 Get the program type. More...
 
virtual bool isAdjacencyInfoRequired (void) const
 
virtual void setAdjacencyInfoRequired (bool r)
 
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...
 
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 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...
 
void setInstancingIncluded (bool included)
 Sets whether a vertex program can do instancing. More...
 
bool isInstancingIncluded (void) const
 Returns whether a vertex program can do instancing. More...
 
virtual void setSkeletalAnimationIncluded (bool included)
 Sets whether a vertex program can do skeletal animation. More...
 
virtual void setMorphAnimationIncluded (bool included)
 Sets whether a vertex program can do morph animation. More...
 
virtual void setPoseAnimationIncluded (ushort poseCount)
 Sets whether a vertex program can do pose animation. More...
 
- 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. More...
 
virtual ~Resource ()
 Virtual destructor. More...
 
virtual void _dirtyState ()
 Manually mark the state of this resource as having been changed. More...
 
void _fireLoadingComplete (bool unused=false)
 Firing of loading complete event. More...
 
void _firePreparingComplete (bool unused=false)
 Firing of preparing complete event. More...
 
void _fireUnloadingComplete (void)
 Firing of unloading complete event. More...
 
void _notifyOrigin (const String &origin)
 Notify this resource of it's origin. More...
 
virtual void changeGroupOwnership (const String &newGroup)
 Change the resource group ownership of a Resource. More...
 
ResourceManagergetCreator (void)
 Gets the manager which created this resource. More...
 
const StringgetGroup (void) const
 Gets the group which this resource is a member of. More...
 
ResourceHandle getHandle (void) const
 
LoadingState getLoadingState () const
 Returns the current loading state. More...
 
const StringgetName (void) const
 Gets resource name. More...
 
const StringgetOrigin (void) const
 Get the origin of this resource, e.g. More...
 
size_t getSize (void) const
 Retrieves info about the size of the resource. 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...
 
bool isBackgroundLoaded (void) const
 Returns whether this Resource has been earmarked for background loading. More...
 
bool isLoaded (void) const
 Returns true if the Resource has been loaded, false otherwise. More...
 
bool isLoading () const
 Returns whether the resource is currently in the process of background loading. More...
 
bool isManuallyLoaded (void) const
 Is this resource manually loaded? More...
 
bool isPrepared (void) const
 Returns true if the Resource has been prepared, false otherwise. More...
 
bool isReloadable (void) const
 Returns true if the Resource is reloadable, false otherwise. More...
 
virtual void prepare (bool backgroundThread=false)
 Prepares the resource for load, if it is not already. More...
 
void setBackgroundLoaded (bool bl)
 Tells the resource whether it is background loaded or not. More...
 
- Public Member Functions inherited from Ogre::StringInterface
 StringInterface ()
 
virtual ~StringInterface ()
 Virtual destructor, see Effective C++. More...
 
void copyParametersTo (StringInterface *dest) const
 Method for copying this object's parameters to another object. More...
 
ParamDictionarygetParamDictionary (void)
 Retrieves the parameter dictionary for this class. More...
 
const ParamDictionarygetParamDictionary (void) const
 
String getParameter (const String &name) const
 Generic parameter retrieval method. More...
 
const ParameterListgetParameters (void) const
 Retrieves a list of parameters valid for this object. 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...
 

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
}
 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...
 
- Static Public Member Functions inherited from Ogre::GpuProgram
static const String getProgramTypeName (GpuProgramType programType)
 
- 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. More...
 

Detailed Description

Specialisation of HighLevelGpuProgram which just delegates its implementation to one other GpuProgram, allowing a single program definition to represent one supported program from a number of options.

Remarks
Whilst you can use Technique to implement several ways to render an object depending on hardware support, if the only reason to need multiple paths is because of the shader language supported, this can be cumbersome. For example you might want to implement the same shader in HLSL and GLSL for portability but apart from the implementation detail, the shaders do the same thing and take the same parameters. If the materials in question are complex, duplicating the techniques just to switch language is not optimal, so instead you can define high-level programs with a syntax of 'unified', and list the actual implementations in order of preference via repeated use of the 'delegate' parameter, which just points at another program name. The first one which has a supported syntax will be used.

Constructor & Destructor Documentation

◆ UnifiedHighLevelGpuProgram()

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

Constructor, should be used only by factory classes.

◆ ~UnifiedHighLevelGpuProgram()

Ogre::UnifiedHighLevelGpuProgram::~UnifiedHighLevelGpuProgram ( )

Member Function Documentation

◆ calculateSize()

size_t Ogre::UnifiedHighLevelGpuProgram::calculateSize ( void  ) const
overridevirtual

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

Reimplemented from Ogre::GpuProgram.

◆ addDelegateProgram()

void Ogre::UnifiedHighLevelGpuProgram::addDelegateProgram ( const String name)

Adds a new delegate program to the list.

Remarks
Delegates are tested in order so earlier ones are preferred.

◆ clearDelegatePrograms()

void Ogre::UnifiedHighLevelGpuProgram::clearDelegatePrograms ( )

Remove all delegate programs.

◆ _getDelegate()

const GpuProgramPtr& Ogre::UnifiedHighLevelGpuProgram::_getDelegate ( ) const

Get the chosen delegate.

◆ getLanguage()

const String& Ogre::UnifiedHighLevelGpuProgram::getLanguage ( void  ) const
overridevirtual

Returns a string that specifies the language of the gpu programs as specified in a material script.

ie: asm, cg, hlsl, glsl

Reimplemented from Ogre::GpuProgram.

◆ createParameters()

GpuProgramParametersSharedPtr Ogre::UnifiedHighLevelGpuProgram::createParameters ( void  )
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.

◆ _getBindingDelegate()

GpuProgram* Ogre::UnifiedHighLevelGpuProgram::_getBindingDelegate ( void  )
overridevirtual

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.

◆ isSupported()

bool Ogre::UnifiedHighLevelGpuProgram::isSupported ( void  ) const
overridevirtual

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

Reimplemented from Ogre::GpuProgram.

◆ getSource()

const String& Ogre::UnifiedHighLevelGpuProgram::getSource ( void  ) const
inlineoverridevirtual

Gets the assembler source for this program.

Reimplemented from Ogre::GpuProgram.

References Ogre::BLANKSTRING.

◆ isSkeletalAnimationIncluded()

bool Ogre::UnifiedHighLevelGpuProgram::isSkeletalAnimationIncluded ( void  ) const
overridevirtual

Returns whether a vertex program can do skeletal animation.

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

Reimplemented from Ogre::GpuProgram.

◆ isMorphAnimationIncluded()

bool Ogre::UnifiedHighLevelGpuProgram::isMorphAnimationIncluded ( void  ) const
overridevirtual

Returns whether a vertex program can do morph animation.

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

Reimplemented from Ogre::GpuProgram.

◆ isPoseAnimationIncluded()

bool Ogre::UnifiedHighLevelGpuProgram::isPoseAnimationIncluded ( void  ) const
overridevirtual

Returns whether a vertex program can do pose animation.

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

Reimplemented from Ogre::GpuProgram.

◆ getNumberOfPosesIncluded()

ushort Ogre::UnifiedHighLevelGpuProgram::getNumberOfPosesIncluded ( void  ) const
overridevirtual

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

Reimplemented from Ogre::GpuProgram.

◆ isVertexTextureFetchRequired()

bool Ogre::UnifiedHighLevelGpuProgram::isVertexTextureFetchRequired ( void  ) const
overridevirtual

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

Reimplemented from Ogre::GpuProgram.

◆ getDefaultParameters()

const GpuProgramParametersPtr& Ogre::UnifiedHighLevelGpuProgram::getDefaultParameters ( void  )
overridevirtual

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 from Ogre::GpuProgram.

◆ hasDefaultParameters()

bool Ogre::UnifiedHighLevelGpuProgram::hasDefaultParameters ( void  ) const
overridevirtual

Returns true if default parameters have been set up.

Reimplemented from Ogre::GpuProgram.

◆ getPassSurfaceAndLightStates()

bool Ogre::UnifiedHighLevelGpuProgram::getPassSurfaceAndLightStates ( void  ) const
overridevirtual

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 from Ogre::GpuProgram.

◆ getPassFogStates()

bool Ogre::UnifiedHighLevelGpuProgram::getPassFogStates ( void  ) const
overridevirtual

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 from Ogre::GpuProgram.

◆ getPassTransformStates()

bool Ogre::UnifiedHighLevelGpuProgram::getPassTransformStates ( void  ) const
overridevirtual

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 from Ogre::GpuProgram.

◆ hasCompileError()

bool Ogre::UnifiedHighLevelGpuProgram::hasCompileError ( void  ) const
overridevirtual

Did this program encounter a compile error when loading?

Reimplemented from Ogre::GpuProgram.

◆ resetCompileError()

void Ogre::UnifiedHighLevelGpuProgram::resetCompileError ( void  )
overridevirtual

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

Reimplemented from Ogre::GpuProgram.

◆ load()

void Ogre::UnifiedHighLevelGpuProgram::load ( bool  backgroundThread = false)
overridevirtual

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
backgroundThreadIndicates whether the caller of this method is the background resource loading thread.

Reimplemented from Ogre::Resource.

◆ reload()

void Ogre::UnifiedHighLevelGpuProgram::reload ( LoadingFlags  flags = LF_DEFAULT)
overridevirtual

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 from Ogre::Resource.

◆ isReloadable()

bool Ogre::UnifiedHighLevelGpuProgram::isReloadable ( void  ) const

◆ isLoaded()

bool Ogre::UnifiedHighLevelGpuProgram::isLoaded ( void  ) const

◆ isLoading()

bool Ogre::UnifiedHighLevelGpuProgram::isLoading ( ) const

◆ getLoadingState()

LoadingState Ogre::UnifiedHighLevelGpuProgram::getLoadingState ( ) const

◆ unload()

void Ogre::UnifiedHighLevelGpuProgram::unload ( void  )
overridevirtual

Unloads the resource; this is not permanent, the resource can be reloaded later if required.

Reimplemented from Ogre::Resource.

◆ getSize()

size_t Ogre::UnifiedHighLevelGpuProgram::getSize ( void  ) const

◆ touch()

void Ogre::UnifiedHighLevelGpuProgram::touch ( void  )
overridevirtual

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

Reimplemented from Ogre::Resource.

◆ isBackgroundLoaded()

bool Ogre::UnifiedHighLevelGpuProgram::isBackgroundLoaded ( void  ) const

◆ setBackgroundLoaded()

void Ogre::UnifiedHighLevelGpuProgram::setBackgroundLoaded ( bool  bl)

◆ escalateLoading()

void Ogre::UnifiedHighLevelGpuProgram::escalateLoading ( )
overridevirtual

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 from Ogre::Resource.

◆ addListener()

void Ogre::UnifiedHighLevelGpuProgram::addListener ( Listener lis)
overridevirtual

Register a listener on this resource.

See also
Resource::Listener

Reimplemented from Ogre::Resource.

◆ removeListener()

void Ogre::UnifiedHighLevelGpuProgram::removeListener ( Listener lis)
overridevirtual

Remove a listener on this resource.

See also
Resource::Listener

Reimplemented from Ogre::Resource.


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