Ogre::HighLevelGpuProgram Class Reference

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

#include <OgreHighLevelGpuProgram.h>

Inheritance diagram for Ogre::HighLevelGpuProgram:

[legend]

List of all members.

Public Types
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
	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 ()
GpuProgramParametersSharedPtr	createParameters (void)
	Creates a new parameters object compatible with this program definition.
GpuProgram *	_getBindingDelegate (void)
const GpuNamedConstants &	getConstantDefinitions () const
	Get the full list of GpuConstantDefinition instances.
const GpuNamedConstants &	getNamedConstants () const
	Override GpuProgram::getNamedConstants to ensure built.
virtual void	setSourceFile (const String &filename)
	Sets the filename of the source assembly for this program.
virtual void	setSource (const String &source)
	Sets the source assembly for this program from an in-memory string.
virtual const String &	getSyntaxCode (void) const
	Gets the syntax code for this program e.g.
virtual void	setSyntaxCode (const String &syntax)
	Sets the syntax code for this program e.g.
virtual const String &	getSourceFile (void) const
	Gets the name of the file used as source for this program.
virtual const String &	getSource (void) const
	Gets the assembler source for this program.
virtual void	setType (GpuProgramType t)
	Set the program type (only valid before load).
virtual GpuProgramType	getType (void) const
	Get the program type.
virtual bool	isSupported (void) const
	Returns whether this program can be supported on the current renderer and hardware.
virtual void	setSkeletalAnimationIncluded (bool included)
	Sets whether a vertex program includes the required instructions to perform skeletal animation.
virtual bool	isSkeletalAnimationIncluded (void) const
	Returns whether a vertex program includes the required instructions to perform skeletal animation.
virtual void	setMorphAnimationIncluded (bool included)
	Sets whether a vertex program includes the required instructions to perform morph animation.
virtual void	setPoseAnimationIncluded (ushort poseCount)
	Sets whether a vertex program includes the required instructions to perform pose animation.
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 ushort	getNumberOfPosesIncluded (void) const
	Returns the number of simultaneous poses the vertex program can blend, for use in pose animation.
virtual void	setVertexTextureFetchRequired (bool r)
	Sets whether this vertex program requires support for vertex texture fetch from the hardware.
virtual bool	isVertexTextureFetchRequired (void) const
	Returns whether this vertex program requires support for vertex texture fetch from the hardware.
virtual void	setAdjacencyInfoRequired (bool r)
	Sets whether this geometry program requires adjacency information from the input primitives.
virtual bool	isAdjacencyInfoRequired (void) const
	Returns whether this geometry program requires adjacency information from the input primitives.
virtual GpuProgramParametersSharedPtr	getDefaultParameters (void)
	Get a reference to the default parameters which are to be used for all uses of this program.
virtual bool	hasDefaultParameters (void) const
	Returns true if default parameters have been set up.
virtual void	setSurfaceAndPassLightStates (bool state)
	Sets whether a vertex program requires light and material states to be passed to through fixed pipeline low level API rendering calls.
virtual bool	getPassSurfaceAndLightStates (void) const
	Returns whether a vertex program wants light and material states to be passed through fixed pipeline low level API rendering calls.
virtual const String &	getLanguage (void) const
	Returns a string that specifies the language of the gpu programs as specified in a material script.
virtual bool	hasCompileError (void) const
	Did this program encounter a compile error when loading?
virtual void	resetCompileError (void)
	Reset a compile error if it occurred, allowing the load to be retried.
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 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 void	prepare ()
	Prepares the resource for load, if it is not already.
virtual void	load (bool backgroundThread=false)
	Loads the resource, if it is not already.
virtual void	reload (void)
	Reloads the resource, if it is already loaded.
virtual bool	isReloadable (void) const
	Returns true if the Resource is reloadable, false otherwise.
virtual bool	isManuallyLoaded (void) const
	Is this resource manually loaded?
virtual void	unload (void)
	Unloads the resource; this is not permanent, the resource can be reloaded later if required.
virtual size_t	getSize (void) const
	Retrieves info about the size of the resource.
virtual void	touch (void)
	'Touches' the resource to indicate it has been used.
virtual const String &	getName (void) const
	Gets resource name.
virtual ResourceHandle	getHandle (void) const
virtual bool	isPrepared (void) const
	Returns true if the Resource has been prepared, false otherwise.
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 LoadingState	getLoadingState () const
	Returns the current loading state.
virtual bool	isBackgroundLoaded (void) const
	Returns whether this Resource has been earmarked for background loading.
virtual void	setBackgroundLoaded (bool bl)
	Tells the resource whether it is background loaded or not.
virtual void	escalateLoading ()
	Escalates the loading of a background loaded resource.
virtual void	addListener (Listener *lis)
	Register a listener on this resource.
virtual void	removeListener (Listener *lis)
	Remove a listener on this resource.
virtual const String &	getGroup (void)
	Gets the group which this resource is a member of.
virtual void	changeGroupOwnership (const String &newGroup)
	Change the resource group ownership of a Resource.
virtual ResourceManager *	getCreator (void)
	Gets the manager which created this resource.
virtual const String &	getOrigin (void) const
	Get the origin of this resource, e.g.
virtual void	_notifyOrigin (const String &origin)
	Notify this resource of it's origin.
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 void	_dirtyState ()
	Manually mark the state of this resource as having been changed.
virtual void	_fireBackgroundLoadingComplete (void)
	Firing of background loading complete event.
virtual void	_fireBackgroundPreparingComplete (void)
	Firing of background preparing complete event.
ParamDictionary *	getParamDictionary (void)
	Retrieves the parameter dictionary for this class.
const ParamDictionary *	getParamDictionary (void) const
const ParameterList &	getParameters (void) const
	Retrieves a list of parameters valid for this object.
virtual bool	setParameter (const String &name, const String &value)
	Generic parameter setting method.
virtual void	setParameterList (const NameValuePairList &paramList)
	Generic multiple parameter setting method.
virtual String	getParameter (const String &name) const
	Generic parameter retrieval method.
virtual void	copyParametersTo (StringInterface *dest) const
	Method for copying this object's parameters to another object.
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 *	operator new (size_t sz, void *ptr)
	placement operator new
void *	operator new[] (size_t sz, const char *file, int line, const char *func)
	array operator new, with debug line info
void *	operator new[] (size_t sz)
void	operator delete (void *ptr)
void	operator delete (void *ptr, const char *, int, const char *)
void	operator delete[] (void *ptr)
void	operator delete[] (void *ptr, const char *, int, const char *)
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.
Protected Types
typedef std::list < Listener * >	ListenerList
Protected Member Functions
virtual void	loadHighLevel (void)
	Internal load high-level portion if not loaded.
virtual void	unloadHighLevel (void)
	Internal unload high-level portion if loaded.
virtual void	loadHighLevelImpl (void)
	Internal load implementation, loads just the high-level portion, enough to get parameters.
virtual void	createLowLevelImpl (void)=0
	Internal method for creating an appropriate low-level program from this high-level program, must be implemented by subclasses.
virtual void	unloadHighLevelImpl (void)=0
	Internal unload implementation, must be implemented by subclasses.
virtual void	populateParameterNames (GpuProgramParametersSharedPtr params)
	Populate the passed parameters with name->index map.
virtual void	buildConstantDefinitions () const =0
	Build the constant definition map, must be overridden.
void	loadImpl ()
	Internal implementation of the meat of the 'load' action, only called if this resource is not being loaded from a ManualResourceLoader.
void	unloadImpl ()
	Internal implementation of the 'unload' action; called regardless of whether this resource is being loaded from a ManualResourceLoader.
void	setupBaseParamDictionary (void)
	Internal method for setting up the basic parameter definitions for a subclass.
bool	isRequiredCapabilitiesSupported (void) const
	Internal method returns whether required capabilities for this program is supported.
size_t	calculateSize (void) const
	Calculate the size of a resource; this will only be called after 'load'.
virtual void	loadFromSource (void)=0
	Virtual method which must be implemented by subclasses, load from mSource.
virtual void	preLoadImpl (void)
	Internal hook to perform actions before the load process, but after the resource has been marked as 'loading'.
virtual void	postLoadImpl (void)
	Internal hook to perform actions after the load process, but before the resource has been marked as fully loaded.
virtual void	preUnloadImpl (void)
	Internal hook to perform actions before the unload process.
virtual void	postUnloadImpl (void)
	Internal hook to perform actions after the unload process, but before the resource has been marked as fully unloaded.
virtual void	prepareImpl (void)
	Internal implementation of the meat of the 'prepare' action.
virtual void	unprepareImpl (void)
	Internal function for undoing the 'prepare' action.
virtual void	queueFireBackgroundLoadingComplete (void)
	Queue the firing of background loading complete event.
virtual void	queueFireBackgroundPreparingComplete (void)
	Queue the firing of background preparing complete event.
bool	createParamDictionary (const String &className)
	Internal method for creating a parameter dictionary for the class, if it does not already exist.
Protected Attributes
bool	mHighLevelLoaded
	Whether the high-level program (and it's parameter defs) is loaded.
GpuProgramPtr	mAssemblerProgram
	The underlying assembler program.
bool	mConstantDefsBuilt
	Have we built the name->index parameter map yet?
GpuProgramType	mType
	The type of the program.
String	mFilename
	The name of the file to load source from (may be blank).
String	mSource
	The assembler source of the program (may be blank until file loaded).
bool	mLoadFromFile
	Whether we need to load source from file or not.
String	mSyntaxCode
	Syntax code e.g. arbvp1, vs_2_0 etc.
bool	mSkeletalAnimation
	Does this (vertex) program include skeletal animation?
bool	mMorphAnimation
	Does this (vertex) program include morph animation?
ushort	mPoseAnimation
	Does this (vertex) program include pose animation (count of number of poses supported).
bool	mVertexTextureFetch
	Does this (vertex) program require support for vertex texture fetch?
bool	mNeedsAdjacencyInfo
	Does this (geometry) program require adjacency information?
GpuProgramParametersSharedPtr	mDefaultParams
	The default parameters for use with this object.
bool	mPassSurfaceAndLightStates
	Does this program want light states passed through fixed pipeline.
bool	mCompileError
	Did we encounter a compilation error?
GpuLogicalBufferStruct	mFloatLogicalToPhysical
	Record of logical to physical buffer maps.
GpuLogicalBufferStruct	mIntLogicalToPhysical
	Record of logical to physical buffer maps.
GpuNamedConstants	mConstantDefs
	Parameter name -> ConstantDefinition map, shared instance used by all parameter objects.
String	mManualNamedConstantsFile
	File from which to load named constants manually.
bool	mLoadedManualNamedConstants
ResourceManager *	mCreator
	Creator.
String	mName
	Unique name of the resource.
String	mGroup
	The name of the resource group.
ResourceHandle	mHandle
	Numeric handle for more efficient look up than name.
AtomicScalar < LoadingState >	mLoadingState
	Is the resource currently loaded?
volatile bool	mIsBackgroundLoaded
	Is this resource going to be background loaded? Only applicable for multithreaded.
size_t	mSize
	The size of the resource in bytes.
bool	mIsManual
	Is this file manually loaded?
String	mOrigin
	Origin of this resource (e.g. script name) - optional.
ManualResourceLoader *	mLoader
	Optional manual loader; if provided, data is loaded from here instead of a file.
size_t	mStateCount
	State count, the number of times this resource has changed state.
ListenerList	mListenerList
String	mParamDictName
	Class name for this instance to be used as a lookup (must be initialised by subclasses).
Static Protected Attributes
static CmdType	msTypeCmd
static CmdSyntax	msSyntaxCmd
static CmdSkeletal	msSkeletalCmd
static CmdMorph	msMorphCmd
static CmdPose	msPoseCmd
static CmdVTF	msVTFCmd
static CmdManualNamedConstsFile	msManNamedConstsFileCmd
static CmdAdjacency	msAdjacencyCmd
static ParamDictionaryMap	msDictionary
	Dictionary of parameters.

---

Detailed Description

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

Remarks:

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

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

Definition at line 58 of file OgreHighLevelGpuProgram.h.

---

Member Typedef Documentation

typedef std::list<Listener*> Ogre::Resource::ListenerList [protected, inherited]

Definition at line 148 of file OgreResource.h.

---

Member Enumeration Documentation

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.

Definition at line 109 of file OgreResource.h.

---

Constructor & Destructor Documentation

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.

Ogre::HighLevelGpuProgram::~HighLevelGpuProgram

(

)

---

Member Function Documentation

virtual void Ogre::HighLevelGpuProgram::loadHighLevel

(

void

)

[protected, virtual]

Internal load high-level portion if not loaded.

virtual void Ogre::HighLevelGpuProgram::unloadHighLevel

(

void

)

[protected, virtual]

Internal unload high-level portion if loaded.

virtual void Ogre::HighLevelGpuProgram::loadHighLevelImpl

(

void

)

[protected, virtual]

Internal load implementation, loads just the high-level portion, enough to get parameters.

virtual void Ogre::HighLevelGpuProgram::createLowLevelImpl

(

void

)

[protected, pure virtual]

Internal method for creating an appropriate low-level program from this high-level program, must be implemented by subclasses.

Implemented in Ogre::UnifiedHighLevelGpuProgram.

virtual void Ogre::HighLevelGpuProgram::unloadHighLevelImpl

(

void

)

[protected, pure virtual]

Internal unload implementation, must be implemented by subclasses.

Implemented in Ogre::UnifiedHighLevelGpuProgram.

virtual void Ogre::HighLevelGpuProgram::populateParameterNames

(

GpuProgramParametersSharedPtr

params

)

[protected, virtual]

Populate the passed parameters with name->index map.

virtual void Ogre::HighLevelGpuProgram::buildConstantDefinitions

(

)

const [protected, pure 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.

Implemented in Ogre::UnifiedHighLevelGpuProgram.

void Ogre::HighLevelGpuProgram::loadImpl

(

)

[protected, virtual]

Internal implementation of the meat of the 'load' action, only called if this resource is not being loaded from a ManualResourceLoader.

Reimplemented from Ogre::GpuProgram.

void Ogre::HighLevelGpuProgram::unloadImpl

(

)

[protected, virtual]

Internal implementation of the 'unload' action; called regardless of whether this resource is being loaded from a ManualResourceLoader.

Implements Ogre::Resource.

GpuProgramParametersSharedPtr Ogre::HighLevelGpuProgram::createParameters

(

void

)

[virtual]

Creates a new parameters object compatible with this program definition.

Remarks:

Unlike low-level assembly programs, parameters objects are specific to the program and therefore must be created from it rather than by the HighLevelGpuProgramManager. This method creates a new instance of a parameters object containing the definition of the parameters this program understands.

Reimplemented from Ogre::GpuProgram.

Reimplemented in Ogre::UnifiedHighLevelGpuProgram.

GpuProgram* Ogre::HighLevelGpuProgram::_getBindingDelegate

(

void

)

[virtual]

Reimplemented from Ogre::GpuProgram.

Reimplemented in Ogre::UnifiedHighLevelGpuProgram.

Definition at line 111 of file OgreHighLevelGpuProgram.h.

const GpuNamedConstants& Ogre::HighLevelGpuProgram::getConstantDefinitions

(

)

const [virtual]

Get the full list of GpuConstantDefinition instances.

Note:

Only available if this parameters object has named parameters.

Reimplemented from Ogre::GpuProgram.

const GpuNamedConstants& Ogre::HighLevelGpuProgram::getNamedConstants

(

)

const [virtual]

Override GpuProgram::getNamedConstants to ensure built.

Reimplemented from Ogre::GpuProgram.

Definition at line 120 of file OgreHighLevelGpuProgram.h.

void Ogre::GpuProgram::setupBaseParamDictionary

(

void

)

[protected, inherited]

Internal method for setting up the basic parameter definitions for a subclass.

Remarks:

Because StringInterface holds a dictionary of parameters per class, subclasses need to call this to ask the base class to add it's parameters to their dictionary as well. Can't do this in the constructor because that runs in a non-virtual context.

The subclass must have called it's own createParamDictionary before calling this method.

bool Ogre::GpuProgram::isRequiredCapabilitiesSupported

(

void

)

const [protected, inherited]

Internal method returns whether required capabilities for this program is supported.

size_t Ogre::GpuProgram::calculateSize

(

void

)

const [protected, virtual, inherited]

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

Implements Ogre::Resource.

Definition at line 1522 of file OgreGpuProgram.h.

virtual void Ogre::GpuProgram::setSourceFile

(

const String &

filename

)

[virtual, inherited]

Sets the filename of the source assembly for this program.

Remarks:

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

virtual void Ogre::GpuProgram::setSource

(

const String &

source

)

[virtual, inherited]

Sets the source assembly for this program from an in-memory string.

Remarks:

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

virtual const String& Ogre::GpuProgram::getSyntaxCode

(

void

)

const [virtual, inherited]

Gets the syntax code for this program e.g.

arbvp1, fp20, vs_1_1 etc

Definition at line 1546 of file OgreGpuProgram.h.

virtual void Ogre::GpuProgram::setSyntaxCode

(

const String &

syntax

)

[virtual, inherited]

Sets the syntax code for this program e.g.

arbvp1, fp20, vs_1_1 etc

virtual const String& Ogre::GpuProgram::getSourceFile

(

void

)

const [virtual, inherited]

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

Definition at line 1552 of file OgreGpuProgram.h.

virtual const String& Ogre::GpuProgram::getSource

(

void

)

const [virtual, inherited]

Gets the assembler source for this program.

Definition at line 1554 of file OgreGpuProgram.h.

virtual void Ogre::GpuProgram::setType

(

GpuProgramType

t

)

[virtual, inherited]

Set the program type (only valid before load).

virtual GpuProgramType Ogre::GpuProgram::getType

(

void

)

const [virtual, inherited]

Get the program type.

Definition at line 1558 of file OgreGpuProgram.h.

virtual bool Ogre::GpuProgram::isSupported

(

void

)

const [virtual, inherited]

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

Reimplemented in Ogre::UnifiedHighLevelGpuProgram.

virtual void Ogre::GpuProgram::setSkeletalAnimationIncluded

(

bool

included

)

[virtual, inherited]

Sets whether a vertex program includes the required instructions to perform skeletal animation.

Remarks:

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

Definition at line 1584 of file OgreGpuProgram.h.

virtual bool Ogre::GpuProgram::isSkeletalAnimationIncluded

(

void

)

const [virtual, inherited]

Returns whether a vertex program includes the required instructions to perform skeletal animation.

Remarks:

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

Reimplemented in Ogre::UnifiedHighLevelGpuProgram.

Definition at line 1593 of file OgreGpuProgram.h.

virtual void Ogre::GpuProgram::setMorphAnimationIncluded

(

bool

included

)

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

Definition at line 1601 of file OgreGpuProgram.h.

virtual void Ogre::GpuProgram::setPoseAnimationIncluded

(

ushort

poseCount

)

[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

Definition at line 1611 of file OgreGpuProgram.h.

virtual bool Ogre::GpuProgram::isMorphAnimationIncluded

(

void

)

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

Definition at line 1620 of file OgreGpuProgram.h.

virtual bool Ogre::GpuProgram::isPoseAnimationIncluded

(

void

)

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

Definition at line 1628 of file OgreGpuProgram.h.

virtual ushort Ogre::GpuProgram::getNumberOfPosesIncluded

(

void

)

const [virtual, inherited]

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

Definition at line 1632 of file OgreGpuProgram.h.

virtual void Ogre::GpuProgram::setVertexTextureFetchRequired

(

bool

r

)

[virtual, inherited]

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

Definition at line 1636 of file OgreGpuProgram.h.

virtual bool Ogre::GpuProgram::isVertexTextureFetchRequired

(

void

)

const [virtual, inherited]

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

Reimplemented in Ogre::UnifiedHighLevelGpuProgram.

Definition at line 1640 of file OgreGpuProgram.h.

virtual void Ogre::GpuProgram::setAdjacencyInfoRequired

(

bool

r

)

[virtual, inherited]

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

Definition at line 1645 of file OgreGpuProgram.h.

virtual bool Ogre::GpuProgram::isAdjacencyInfoRequired

(

void

)

const [virtual, inherited]

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

Definition at line 1649 of file OgreGpuProgram.h.

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

virtual bool Ogre::GpuProgram::hasDefaultParameters

(

void

)

const [virtual, inherited]

Returns true if default parameters have been set up.

Reimplemented in Ogre::UnifiedHighLevelGpuProgram.

Definition at line 1665 of file OgreGpuProgram.h.

virtual void Ogre::GpuProgram::setSurfaceAndPassLightStates

(

bool

state

)

[virtual, inherited]

Sets whether a vertex program requires light and material states to be passed to through fixed pipeline low level API rendering calls.

Remarks:

If this is set to true, OGRE will pass all active light states to the fixed function pipeline. This is useful for high level shaders like GLSL that can read the OpenGL light and material states. This way the user does not have to use autoparameters to pass light position, color etc.

Definition at line 1675 of file OgreGpuProgram.h.

virtual bool Ogre::GpuProgram::getPassSurfaceAndLightStates

(

void

)

const [virtual, inherited]

Returns whether a vertex program wants light and material states to be passed through fixed pipeline low level API rendering calls.

Reimplemented in Ogre::UnifiedHighLevelGpuProgram.

Definition at line 1681 of file OgreGpuProgram.h.

virtual const String& Ogre::GpuProgram::getLanguage

(

void

)

const [virtual, inherited]

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.

virtual bool Ogre::GpuProgram::hasCompileError

(

void

)

const [virtual, inherited]

Did this program encounter a compile error when loading?

Reimplemented in Ogre::UnifiedHighLevelGpuProgram.

Definition at line 1690 of file OgreGpuProgram.h.

virtual void Ogre::GpuProgram::resetCompileError

(

void

)

[virtual, inherited]

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

Reimplemented in Ogre::UnifiedHighLevelGpuProgram.

Definition at line 1694 of file OgreGpuProgram.h.

virtual void Ogre::GpuProgram::setManualNamedConstants

(

const GpuNamedConstants &

namedConstants

)

[virtual, 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

virtual void Ogre::GpuProgram::setManualNamedConstantsFile

(

const String &

paramDefFile

)

[virtual, 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 wa