Defines a program which runs on the GPU such as a vertex or fragment program. More...

#include <OgreGpuProgram.h>

Inheritance diagram for Ogre::GpuProgram:

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
	GpuProgram (ResourceManager creator, const String &name, ResourceHandle handle, const String &group, bool isManual=false, ManualResourceLoader loader=0)

virtual	~GpuProgram ()

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 (void)
	Firing of unloading complete event.

virtual GpuProgram *	_getBindingDelegate (void)
	Returns the GpuProgram which should be bound to the pipeline.

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 size_t	calculateSize (void) const
	Calculate the size of a resource; this will only be called after 'load'.

virtual void	changeGroupOwnership (const String &newGroup)
	Change the resource group ownership of a Resource.

virtual void	copyParametersTo (StringInterface *dest) const
	Method for copying this object's parameters to another object.

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

virtual void	escalateLoading ()
	Escalates the loading of a background loaded resource.

bool	getBuildParametersFromReflection (void) const

virtual Vector3	getComputeGroupDimensions (void) const
	Returns the number of process groups dispatched by this compute program.

virtual const GpuNamedConstants &	getConstantDefinitions () const
	Get the full list of named constants.

virtual ResourceManager *	getCreator (void)
	Gets the manager which created this resource.

virtual GpuProgramParametersSharedPtr	getDefaultParameters (void)
	Get a reference to the default parameters which are to be used for all uses of this program.

virtual const String &	getGroup (void) const
	Gets the group which this resource is a member of.

virtual ResourceHandle	getHandle (void) const

virtual const String &	getLanguage (void) const
	Returns a string that specifies the language of the gpu programs as specified in a material script.

virtual LoadingState	getLoadingState () const
	Returns the current loading state.

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 const String &	getName (void) const
	Gets resource name.

virtual ushort	getNumberOfPosesIncluded (void) const
	Returns the number of simultaneous poses the vertex program can blend, for use in pose animation.

uint8	getNumClipDistances (void) const
	Retrieves the number of clip distances. See GpuProgram::setNumClipDistances.

virtual const String &	getOrigin (void) const
	Get the origin of this resource, e.g.

ParamDictionary *	getParamDictionary (void)
	Retrieves the parameter dictionary for this class.

const ParamDictionary *	getParamDictionary (void) const

virtual String	getParameter (const String &name) const
	Generic parameter retrieval method.

const ParameterList &	getParameters (void) const
	Retrieves a list of parameters valid for this object.

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)

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)

virtual bool	getPassTransformStates (void) const
	Returns whether a vertex program wants transform state 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 const String &	getSource (void) const
	Gets the assembler source for this program.

virtual const String &	getSourceFile (void) const
	Gets the name of the file used as source for this program.

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 const String &	getSyntaxCode (void) const
	Gets the syntax code for this program e.g.

virtual GpuProgramType	getType (void) const
	Get the program type.

virtual bool	hasCompileError (void) const
	Did this program encounter a compile error when loading?

virtual bool	hasDefaultParameters (void) const
	Returns true if default parameters have been set up.

virtual bool	isAdjacencyInfoRequired (void) const
	Returns whether this geometry program requires adjacency information from the input primitives.

virtual bool	isBackgroundLoaded (void) const
	Returns whether this Resource has been earmarked for background loading.

virtual bool	isLoaded (void) 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 (void) const
	Is this resource manually loaded?

virtual bool	isMorphAnimationIncluded (void) const
	Returns whether a vertex program includes the required instructions to perform morph animation.

virtual bool	isPoseAnimationIncluded (void) const
	Returns whether a vertex program includes the required instructions to perform pose animation.

virtual bool	isPrepared (void) const
	Returns true if the Resource has been prepared, false otherwise.

virtual bool	isReloadable (void) const
	Returns true if the Resource is reloadable, false otherwise.

virtual bool	isSkeletalAnimationIncluded (void) const
	Returns whether a vertex program includes the required instructions to perform skeletal animation.

virtual bool	isSupported (void) const
	Returns whether this program can be supported on the current renderer and hardware.

virtual bool	isVertexTextureFetchRequired (void) const
	Returns whether this vertex program requires support for vertex texture fetch from the hardware.

virtual void	load (bool backgroundThread=false)
	Loads the resource, if it is not already.

void	operator delete (void *ptr)

void	operator delete (void ptr, const char , int, const char *)

void	operator delete (void ptr, void )

void	operator delete[] (void *ptr)

void	operator delete[] (void ptr, const char , int, const char *)

void *	operator new (size_t sz)

void *	operator new (size_t sz, const char file, int line, const char func)
	operator new, with debug line info

void *	operator new (size_t sz, void *ptr)
	placement operator new

void *	operator new[] (size_t sz)

void *	operator new[] (size_t sz, const char file, int line, const char func)
	array operator new, with debug line info

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	resetCompileError (void)
	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	setBackgroundLoaded (bool bl)
	Tells the resource whether it is background loaded or not.

void	setBuildParametersFromReflection (bool buildParams)

virtual void	setComputeGroupDimensions (Vector3 dimensions)
	Sets the number of process groups dispatched by this compute program.

virtual void	setManuallyLoaded (bool isManual)
	Set "Is this resource manually loaded?".

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 bool	setParameter (const String &name, const String &value)
	Generic parameter setting method.

virtual void	setParameterList (const NameValuePairList &paramList)
	Generic multiple parameter setting method.

virtual void	setPoseAnimationIncluded (ushort poseCount)
	Sets whether a vertex program includes the required instructions to perform pose animation.

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	setToLoaded (void)
	Change the Resource loading state to loaded.

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	touch (void)
	'Touches' the resource to indicate it has been used.

virtual void	unload (void)
	Unloads the resource; this is not permanent, the resource can be reloaded later if required.

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.

Public Attributes
	OGRE_AUTO_MUTEX

Detailed Description

Defines a program which runs on the GPU such as a vertex or fragment program.

Remarks: This class defines the low-level program in assembler code, the sort used to directly assemble into machine instructions for the GPU to execute. By nature, this means that the assembler source is rendersystem specific, which is why this is an abstract class - real instances are created through the RenderSystem. If you wish to use higher level shading languages like HLSL and Cg, you need to use the HighLevelGpuProgram class instead.

Member Enumeration Documentation

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

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

Constructor & Destructor Documentation

◆ GpuProgram()

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

◆ ~GpuProgram()

virtual Ogre::GpuProgram::~GpuProgram ( )

inlinevirtual

Member Function Documentation

◆ _dirtyState()

virtual void Ogre::Resource::_dirtyState ( )

virtualinherited

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

virtual void Ogre::Resource::_fireLoadingComplete ( bool wasBackgroundLoaded )

virtualinherited

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

virtual void Ogre::Resource::_firePreparingComplete ( bool wasBackgroundLoaded )

virtualinherited

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

virtual void Ogre::Resource::_fireUnloadingComplete ( void )

virtualinherited

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.

◆ _getBindingDelegate()

virtual GpuProgram * Ogre::GpuProgram::_getBindingDelegate ( void )

inlinevirtual

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 in Ogre::CgProgram, Ogre::HighLevelGpuProgram, Ogre::UnifiedHighLevelGpuProgram, and Ogre::GLSLShader.

◆ _notifyOrigin()

virtual void Ogre::Resource::_notifyOrigin ( const String & origin )

inlinevirtualinherited

Notify this resource of it's origin.

◆ addListener()

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

virtualinherited

Register a listener on this resource.

See also: Resource::Listener

Reimplemented in Ogre::UnifiedHighLevelGpuProgram.

◆ calculateSize()

virtual size_t Ogre::GpuProgram::calculateSize ( void ) const

virtual

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

Reimplemented from Ogre::Resource.

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

◆ changeGroupOwnership()

virtual void Ogre::Resource::changeGroupOwnership ( const String & newGroup )

virtualinherited

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

◆ cleanupDictionary()

static void Ogre::StringInterface::cleanupDictionary ( )

staticinherited

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.

◆ copyParametersTo()

virtual void Ogre::StringInterface::copyParametersTo ( StringInterface * dest ) const

inlinevirtualinherited

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.

◆ createParameters()

virtual GpuProgramParametersSharedPtr Ogre::GpuProgram::createParameters ( void )

virtual

Creates a new parameters object compatible with this program definition.

Remarks: It is recommended that you use this method of creating parameters objects rather than going direct to GpuProgramManager, because this method will populate any implementation-specific extras (like named parameters) where they are appropriate.

Reimplemented in Ogre::CgProgram, Ogre::HighLevelGpuProgram, Ogre::UnifiedHighLevelGpuProgram, Ogre::D3D11HLSLProgram, Ogre::D3D9HLSLProgram, Ogre::GLSLShader, and Ogre::MetalProgram.

◆ escalateLoading()

virtual void Ogre::Resource::escalateLoading ( )

virtualinherited

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.

◆ getBuildParametersFromReflection()

bool Ogre::GpuProgram::getBuildParametersFromReflection ( void ) const

inline

◆ getComputeGroupDimensions()

virtual Vector3 Ogre::GpuProgram::getComputeGroupDimensions ( void ) const

inlinevirtual

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

◆ getConstantDefinitions()

virtual const GpuNamedConstants & Ogre::GpuProgram::getConstantDefinitions ( ) const

inlinevirtual

Get the full list of named constants.

Note: Only available if this parameters object has named parameters, which means either a high-level program which loads them, or a low-level program which has them specified manually.

Reimplemented in Ogre::HighLevelGpuProgram.

References Ogre::SharedPtr< T >::get().

◆ getCreator()

virtual ResourceManager * Ogre::Resource::getCreator ( void )

inlinevirtualinherited

Gets the manager which created this resource.

◆ getDefaultParameters()

virtual GpuProgramParametersSharedPtr Ogre::GpuProgram::getDefaultParameters ( void )

virtual

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

◆ getGroup()

virtual const String & Ogre::Resource::getGroup ( void ) const

inlinevirtualinherited

Gets the group which this resource is a member of.

Reimplemented in Ogre::v1::OldSkeletonInstance.

◆ getHandle()

virtual ResourceHandle Ogre::Resource::getHandle ( void ) const

inlinevirtualinherited

Reimplemented in Ogre::v1::OldSkeletonInstance.

◆ getLanguage()

virtual const String & Ogre::GpuProgram::getLanguage ( void ) const

virtual

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

ie: asm, cg, hlsl, glsl

Reimplemented in Ogre::UnifiedHighLevelGpuProgram, Ogre::CgProgram, Ogre::D3D11HLSLProgram, Ogre::D3D9HLSLProgram, Ogre::GLSLShader, and Ogre::MetalProgram.

◆ getLoadingState()

virtual LoadingState Ogre::Resource::getLoadingState ( ) const

inlinevirtualinherited

Returns the current loading state.

Reimplemented in Ogre::UnifiedHighLevelGpuProgram.

◆ getManualNamedConstantsFile()

virtual const String & Ogre::GpuProgram::getManualNamedConstantsFile ( ) const

inlinevirtual

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.

◆ getName()

virtual const String & Ogre::Resource::getName ( void ) const

inlinevirtualinherited

Gets resource name.

Reimplemented in Ogre::v1::OldSkeletonInstance.

Referenced by Ogre::GpuProgramUsage::getProgramName().

◆ getNumberOfPosesIncluded()

virtual ushort Ogre::GpuProgram::getNumberOfPosesIncluded ( void ) const

inlinevirtual

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

Reimplemented in Ogre::UnifiedHighLevelGpuProgram.

◆ getNumClipDistances()

uint8 Ogre::GpuProgram::getNumClipDistances ( void ) const

inline

Retrieves the number of clip distances. See GpuProgram::setNumClipDistances.

◆ getOrigin()

virtual const String & Ogre::Resource::getOrigin ( void ) const

inlinevirtualinherited

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.

◆ getParamDictionary() [1/2]

ParamDictionary * Ogre::StringInterface::getParamDictionary ( void )

inlineinherited

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

inlineinherited

◆ getParameter()

virtual String Ogre::StringInterface::getParameter ( const String & name ) const

inlinevirtualinherited

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

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

◆ getPassFogStates()

virtual bool Ogre::GpuProgram::getPassFogStates ( void ) const

inlinevirtual

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

◆ getPassSurfaceAndLightStates()

virtual bool Ogre::GpuProgram::getPassSurfaceAndLightStates ( void ) const

inlinevirtual

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

◆ getPassTransformStates()

virtual bool Ogre::GpuProgram::getPassTransformStates ( void ) const

inlinevirtual

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

◆ getSize()

virtual size_t Ogre::Resource::getSize ( void ) const

inlinevirtualinherited

Retrieves info about the size of the resource.

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

◆ getSource()

virtual const String & Ogre::GpuProgram::getSource ( void ) const

inlinevirtual

Gets the assembler source for this program.

◆ getSourceFile()

virtual const String & Ogre::GpuProgram::getSourceFile ( void ) const

inlinevirtual

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

◆ getStateCount()

virtual size_t Ogre::Resource::getStateCount ( ) const

inlinevirtualinherited

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.

◆ getSyntaxCode()

virtual const String & Ogre::GpuProgram::getSyntaxCode ( void ) const

inlinevirtual

Gets the syntax code for this program e.g.

arbvp1, fp20, vs_1_1 etc

◆ getType()

virtual GpuProgramType Ogre::GpuProgram::getType ( void ) const

inlinevirtual

Get the program type.

◆ hasCompileError()

virtual bool Ogre::GpuProgram::hasCompileError ( void ) const

inlinevirtual

Did this program encounter a compile error when loading?

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

◆ hasDefaultParameters()

virtual bool Ogre::GpuProgram::hasDefaultParameters ( void ) const

inlinevirtual

Returns true if default parameters have been set up.

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

References Ogre::SharedPtr< T >::isNull().

◆ isAdjacencyInfoRequired()

virtual bool Ogre::GpuProgram::isAdjacencyInfoRequired ( void ) const

inlinevirtual

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

◆ isBackgroundLoaded()

virtual bool Ogre::Resource::isBackgroundLoaded ( void ) const

inlinevirtualinherited

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.

◆ isLoaded()

virtual bool Ogre::Resource::isLoaded ( void ) const

inlinevirtualinherited

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

Reimplemented in Ogre::UnifiedHighLevelGpuProgram.

◆ isLoading()

virtual bool Ogre::Resource::isLoading ( ) const

inlinevirtualinherited

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

Reimplemented in Ogre::UnifiedHighLevelGpuProgram.

◆ isManuallyLoaded()

virtual bool Ogre::Resource::isManuallyLoaded ( void ) const

inlinevirtualinherited

Is this resource manually loaded?

◆ isMorphAnimationIncluded()

virtual bool Ogre::GpuProgram::isMorphAnimationIncluded ( void ) const

inlinevirtual

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

◆ isPoseAnimationIncluded()

virtual bool Ogre::GpuProgram::isPoseAnimationIncluded ( void ) const

inlinevirtual

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

◆ isPrepared()

virtual bool Ogre::Resource::isPrepared ( void ) const

inlinevirtualinherited

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

◆ isReloadable()

virtual bool Ogre::Resource::isReloadable ( void ) const

inlinevirtualinherited

Returns true if the Resource is reloadable, false otherwise.

Reimplemented in Ogre::UnifiedHighLevelGpuProgram.

◆ isSkeletalAnimationIncluded()

virtual bool Ogre::GpuProgram::isSkeletalAnimationIncluded ( void ) const

inlinevirtual

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

◆ isSupported()

virtual bool Ogre::GpuProgram::isSupported ( void ) const

virtual

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

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

◆ isVertexTextureFetchRequired()

virtual bool Ogre::GpuProgram::isVertexTextureFetchRequired ( void ) const

inlinevirtual

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

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

◆ load()

virtual void Ogre::Resource::load ( bool backgroundThread = false )

virtualinherited

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.

◆ operator delete() [1/3]

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete ( void * ptr )

inlineinherited

◆ operator delete() [2/3]

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete	(	void *	ptr,
		const char *	,
		int	,
		const char *
	)

inlineinherited

◆ operator delete() [3/3]

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete	(	void *	ptr,
		void *
	)

inlineinherited

◆ operator delete[]() [1/2]

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete[] ( void * ptr )

inlineinherited

◆ operator delete[]() [2/2]

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete[]	(	void *	ptr,
		const char *	,
		int	,
		const char *
	)

inlineinherited

◆ operator new() [1/3]

template<class Alloc >

void * Ogre::AllocatedObject< Alloc >::operator new ( size_t sz )

inlineinherited

◆ operator new() [2/3]

template<class Alloc >

void * Ogre::AllocatedObject< Alloc >::operator new	(	size_t	sz,
		const char *	file,
		int	line,
		const char *	func
	)

inlineinherited

operator new, with debug line info

◆ operator new() [3/3]

template<class Alloc >

void * Ogre::AllocatedObject< Alloc >::operator new	(	size_t	sz,
		void *	ptr
	)

inlineinherited

placement operator new

◆ operator new[]() [1/2]

template<class Alloc >

void * Ogre::AllocatedObject< Alloc >::operator new[] ( size_t sz )

inlineinherited

◆ operator new[]() [2/2]

template<class Alloc >

void * Ogre::AllocatedObject< Alloc >::operator new[]	(	size_t	sz,
		const char *	file,
		int	line,
		const char *	func
	)

inlineinherited

array operator new, with debug line info

◆ prepare()

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

virtualinherited

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

◆ reload()

virtual void Ogre::Resource::reload ( LoadingFlags flags = LF_DEFAULT )

virtualinherited

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::v1::Mesh, and Ogre::UnifiedHighLevelGpuProgram.

◆ removeListener()

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

virtualinherited

Remove a listener on this resource.

See also: Resource::Listener

Reimplemented in Ogre::UnifiedHighLevelGpuProgram.

◆ resetCompileError()

virtual void Ogre::GpuProgram::resetCompileError ( void )

inlinevirtual

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

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

◆ setAdjacencyInfoRequired()

virtual void Ogre::GpuProgram::setAdjacencyInfoRequired ( bool r )

inlinevirtual

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

◆ setBackgroundLoaded()

virtual void Ogre::Resource::setBackgroundLoaded ( bool bl )

inlinevirtualinherited

Tells the resource whether it is background loaded or not.

Remarks

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.

◆ setBuildParametersFromReflection()

void Ogre::GpuProgram::setBuildParametersFromReflection ( bool buildParams )

inline

◆ setComputeGroupDimensions()

virtual void Ogre::GpuProgram::setComputeGroupDimensions ( Vector3 dimensions )

inlinevirtual

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

◆ setManuallyLoaded()

virtual void Ogre::Resource::setManuallyLoaded ( bool isManual )

inlinevirtualinherited

Set "Is this resource manually loaded?".

◆ setManualNamedConstants()

virtual void Ogre::GpuProgram::setManualNamedConstants ( const GpuNamedConstants & namedConstants )

virtual

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

virtual void Ogre::GpuProgram::setManualNamedConstantsFile ( const String & paramDefFile )

virtual

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.

◆ setMorphAnimationIncluded()

virtual void Ogre::GpuProgram::setMorphAnimationIncluded ( bool included )

inlinevirtual

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.

◆ setNumClipDistances()

void Ogre::GpuProgram::setNumClipDistances ( const uint8 numClipDistances )

Sets the number of clip distances this shader uses.

Only valid for vertex shaders. Default is 0

◆ setParameter()

virtual bool Ogre::StringInterface::setParameter	(	const String &	name,
		const String &	value
	)

virtualinherited

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)

◆ setParameterList()

virtual void Ogre::StringInterface::setParameterList ( const NameValuePairList & paramList )

virtualinherited

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

◆ setPoseAnimationIncluded()

virtual void Ogre::GpuProgram::setPoseAnimationIncluded ( ushort poseCount )

inlinevirtual

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

◆ setSkeletalAnimationIncluded()

virtual void Ogre::GpuProgram::setSkeletalAnimationIncluded ( bool included )

inlinevirtual

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.

◆ setSource() [1/2]

virtual void Ogre::GpuProgram::setSource ( const String & source )

virtual

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.

◆ setSource() [2/2]

virtual void Ogre::GpuProgram::setSource	(	const String &	source,
		const String &	debugFilename
	)

virtual

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.

Visual Studio Graphics Debugger)

Parameters

source	Shader source code
debugFilename	Optional Path to this file. Can be left blank.

◆ setSourceFile()

virtual void Ogre::GpuProgram::setSourceFile ( const String & filename )

virtual

Sets the filename of the source assembly for this program.

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

◆ setSyntaxCode()

virtual void Ogre::GpuProgram::setSyntaxCode ( const String & syntax )

virtual

Sets the syntax code for this program e.g.

arbvp1, fp20, vs_1_1 etc

◆ setToLoaded()

virtual void Ogre::Resource::setToLoaded ( void )

inlinevirtualinherited

Change the Resource loading state to loaded.

◆ setType()

virtual void Ogre::GpuProgram::setType ( GpuProgramType t )

virtual

Set the program type (only valid before load)

◆ setUniformBlockBinding()

virtual void Ogre::GpuProgram::setUniformBlockBinding	(	const char *	blockName,
		uint32	bindingSlot
	)

inlinevirtual

For GL only. Program must be bound when calling.

◆ setVertexTextureFetchRequired()

virtual void Ogre::GpuProgram::setVertexTextureFetchRequired ( bool r )

inlinevirtual

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

◆ touch()

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

virtualinherited

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

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

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

◆ unload()

virtual void Ogre::Resource::unload ( void )

virtualinherited

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

Reimplemented in Ogre::UnifiedHighLevelGpuProgram.

Member Data Documentation

◆ OGRE_AUTO_MUTEX

Ogre::Resource::OGRE_AUTO_MUTEX

inherited

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

OgreGpuProgram.h

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Detailed Description

Member Enumeration Documentation

◆ LoadingFlags

◆ LoadingState

Constructor & Destructor Documentation

◆ GpuProgram()

◆ ~GpuProgram()

Member Function Documentation

◆ _dirtyState()

◆ _fireLoadingComplete()

◆ _firePreparingComplete()

◆ _fireUnloadingComplete()

◆ _getBindingDelegate()

◆ _notifyOrigin()

◆ addListener()

◆ calculateSize()

◆ changeGroupOwnership()

◆ cleanupDictionary()

◆ copyParametersTo()

◆ createParameters()

◆ escalateLoading()

◆ getBuildParametersFromReflection()

◆ getComputeGroupDimensions()

◆ getConstantDefinitions()

◆ getCreator()

◆ getDefaultParameters()

◆ getGroup()

◆ getHandle()

◆ getLanguage()

◆ getLoadingState()

◆ getManualNamedConstantsFile()

◆ getName()

◆ getNumberOfPosesIncluded()

◆ getNumClipDistances()

◆ getOrigin()

◆ getParamDictionary() [1/2]

◆ getParamDictionary() [2/2]

◆ getParameter()

◆ getParameters()

◆ getPassFogStates()

◆ getPassSurfaceAndLightStates()

◆ getPassTransformStates()

◆ getSize()

◆ getSource()

◆ getSourceFile()

◆ getStateCount()

◆ getSyntaxCode()

◆ getType()

◆ hasCompileError()

◆ hasDefaultParameters()

◆ isAdjacencyInfoRequired()

◆ isBackgroundLoaded()

◆ isLoaded()

◆ isLoading()

◆ isManuallyLoaded()

◆ isMorphAnimationIncluded()

◆ isPoseAnimationIncluded()

◆ isPrepared()

◆ isReloadable()

◆ isSkeletalAnimationIncluded()

◆ isSupported()

◆ isVertexTextureFetchRequired()

◆ load()

◆ operator delete() [1/3]

◆ operator delete() [2/3]

◆ operator delete() [3/3]

◆ operator delete[]() [1/2]

◆ operator delete[]() [2/2]

◆ operator new() [1/3]

◆ operator new() [2/3]

◆ operator new() [3/3]

◆ operator new[]() [1/2]

◆ operator new[]() [2/2]

◆ prepare()

◆ reload()

◆ removeListener()