OGRE  2.0
Object-Oriented Graphics Rendering Engine
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Ogre::CgProgram Class Reference

Specialisation of HighLevelGpuProgram to provide support for nVidia's CG language. More...

#include <OgreCgProgram.h>

+ Inheritance diagram for Ogre::CgProgram:
+ Collaboration diagram for Ogre::CgProgram:

Classes

class  CmdArgs
 Command object for setting compilation arguments. More...
 
class  CmdEntryPoint
 Command object for setting entry point. More...
 
class  CmdProfiles
 Command object for setting profiles. More...
 

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

 CgProgram (ResourceManager *creator, const String &name, ResourceHandle handle, const String &group, bool isManual, ManualResourceLoader *loader, CGcontext context)
 
 ~CgProgram ()
 
virtual void _dirtyState ()
 Manually mark the state of this resource as having been changed. More...
 
virtual void _fireLoadingComplete (bool wasBackgroundLoaded)
 Firing of loading complete event. More...
 
virtual void _firePreparingComplete (bool wasBackgroundLoaded)
 Firing of preparing complete event. More...
 
virtual void _fireUnloadingComplete (void)
 Firing of unloading complete event. More...
 
GpuProgram_getBindingDelegate ()
 Returns the GpuProgram which should be bound to the pipeline. More...
 
virtual void _notifyOrigin (const String &origin)
 Notify this resource of it's origin. More...
 
virtual void addListener (Listener *lis)
 Register a listener on this resource. More...
 
virtual size_t calculateSize (void) const
 Calculate the size of a resource; this will only be called after 'load'. More...
 
virtual void changeGroupOwnership (const String &newGroup)
 Change the resource group ownership of a Resource. More...
 
virtual void copyParametersTo (StringInterface *dest) const
 Method for copying this object's parameters to another object. More...
 
GpuProgramParametersSharedPtr createParameters ()
 Creates a new parameters object compatible with this program definition. More...
 
virtual void escalateLoading ()
 Escalates the loading of a background loaded resource. More...
 
const StringgetCompileArguments (void) const
 Gets the entry point defined for this program. More...
 
virtual Vector3 getComputeGroupDimensions (void) const
 Returns the number of process groups dispatched by this compute program. More...
 
const GpuNamedConstantsgetConstantDefinitions () const
 Get the full list of GpuConstantDefinition instances. More...
 
virtual ResourceManagergetCreator (void)
 Gets the manager which created this resource. More...
 
GpuProgramParametersSharedPtr getDefaultParameters (void)
 Get a reference to the default parameters which are to be used for all uses of this program. More...
 
const StringgetEntryPoint (void) const
 Gets the entry point defined for this program. More...
 
virtual const StringgetGroup (void) const
 Gets the group which this resource is a member of. More...
 
virtual ResourceHandle getHandle (void) const
 
const StringgetLanguage (void) const
 Overridden from GpuProgram. More...
 
virtual LoadingState getLoadingState () const
 Returns the current loading state. More...
 
virtual 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...
 
virtual const StringgetName (void) const
 Gets resource name. More...
 
virtual ushort getNumberOfPosesIncluded (void) const
 Returns the number of simultaneous poses the vertex program can blend, for use in pose animation. More...
 
virtual const StringgetOrigin (void) const
 Get the origin of this resource, e.g. More...
 
ParamDictionarygetParamDictionary (void)
 Retrieves the parameter dictionary for this class. More...
 
const ParamDictionarygetParamDictionary (void) const
 
virtual 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 getPassFogStates (void) const
 Returns whether a fragment program wants fog state to be passed through fixed pipeline low level API rendering calls (default true, subclasses can override) More...
 
bool getPassSurfaceAndLightStates (void) const
 Returns whether a vertex program wants light and material states to be passed through fixed pipeline low level API rendering calls (default false, subclasses can override) More...
 
bool getPassTransformStates (void) const
 Returns whether a vertex program wants transform state to be passed through fixed pipeline low level API rendering calls. More...
 
const StringVectorgetProfiles (void) const
 Gets the Cg profiles which can be supported by the program. More...
 
size_t getSize (void) const
 Retrieves info about the size of the resource. More...
 
virtual const StringgetSource (void) const
 Gets the assembler source for this program. More...
 
virtual const StringgetSourceFile (void) const
 Gets the name of the file used as source for this program. More...
 
virtual size_t getStateCount () const
 Returns the number of times this resource has changed state, which generally means the number of times it has been loaded. More...
 
virtual const StringgetSyntaxCode (void) const
 Gets the syntax code for this program e.g. More...
 
virtual GpuProgramType getType (void) const
 Get the program type. More...
 
bool hasCompileError (void) const
 Did this program encounter a compile error when loading? More...
 
bool hasDefaultParameters (void) const
 Returns true if default parameters have been set up. More...
 
virtual bool isAdjacencyInfoRequired (void) const
 Returns whether this geometry program requires adjacency information from the input primitives. More...
 
virtual bool isBackgroundLoaded (void) const
 Returns whether this Resource has been earmarked for background loading. More...
 
virtual bool isLoaded (void) const
 Returns true if the Resource has been loaded, false otherwise. More...
 
virtual bool isLoading () const
 Returns whether the resource is currently in the process of background loading. More...
 
virtual bool isManuallyLoaded (void) const
 Is this resource manually loaded? More...
 
bool isMorphAnimationIncluded (void) const
 Returns whether a vertex program includes the required instructions to perform morph animation. More...
 
bool isPoseAnimationIncluded (void) const
 Returns whether a vertex program includes the required instructions to perform pose animation. More...
 
virtual bool isPrepared (void) const
 Returns true if the Resource has been prepared, false otherwise. More...
 
virtual bool isReloadable (void) const
 Returns true if the Resource is reloadable, false otherwise. More...
 
bool isSkeletalAnimationIncluded (void) const
 Returns whether a vertex program includes the required instructions to perform skeletal animation. More...
 
bool isSupported (void) const
 Overridden from GpuProgram. More...
 
bool isVertexTextureFetchRequired (void) const
 Returns whether this vertex program requires support for vertex texture fetch from the hardware. More...
 
virtual void load (bool backgroundThread=false)
 Loads the resource, if it is not already. More...
 
void operator delete (void *ptr)
 
void operator delete (void *ptr, void *)
 
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 *)
 
void * operator new (size_t sz, const char *file, int line, const char *func)
 operator new, with debug line info More...
 
void * operator new (size_t sz)
 
void * operator new (size_t sz, void *ptr)
 placement operator new More...
 
void * operator new[] (size_t sz, const char *file, int line, const char *func)
 array operator new, with debug line info More...
 
void * operator new[] (size_t sz)
 
virtual void prepare (bool backgroundThread=false)
 Prepares the resource for load, if it is not already. More...
 
virtual void reload (void)
 Reloads the resource, if it is already loaded. More...
 
virtual void removeListener (Listener *lis)
 Remove a listener on this resource. More...
 
void resetCompileError (void)
 Reset a compile error if it occurred, allowing the load to be retried. More...
 
virtual void setAdjacencyInfoRequired (bool r)
 Sets whether this geometry program requires adjacency information from the input primitives. More...
 
virtual void setBackgroundLoaded (bool bl)
 Tells the resource whether it is background loaded or not. More...
 
void setCompileArguments (const String &args)
 Sets the compilation arguments for this program ie the first method called. More...
 
virtual void setComputeGroupDimensions (Vector3 dimensions)
 Sets the number of process groups dispatched by this compute program. More...
 
void setEntryPoint (const String &entryPoint)
 Sets the entry point for this program ie the first method called. More...
 
virtual void setManuallyLoaded (bool isManual)
 Set "Is this resource manually loaded?". More...
 
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. More...
 
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. More...
 
virtual void setMorphAnimationIncluded (bool included)
 Sets whether a vertex program includes the required instructions to perform morph animation. More...
 
virtual bool setParameter (const String &name, const String &value)
 Generic parameter setting method. More...
 
virtual void setParameterList (const NameValuePairList &paramList)
 Generic multiple parameter setting method. More...
 
virtual void setPoseAnimationIncluded (ushort poseCount)
 Sets whether a vertex program includes the required instructions to perform pose animation. More...
 
void setProfiles (const StringVector &profiles)
 Sets the Cg profiles which can be supported by the program. More...
 
virtual void setSkeletalAnimationIncluded (bool included)
 Sets whether a vertex program includes the required instructions to perform skeletal animation. More...
 
virtual void setSource (const String &source)
 Sets the source assembly for this program from an in-memory string. More...
 
virtual void setSourceFile (const String &filename)
 Sets the filename of the source assembly for this program. More...
 
virtual void setSyntaxCode (const String &syntax)
 Sets the syntax code for this program e.g. More...
 
virtual void setToLoaded (void)
 Change the Resource loading state to loaded. More...
 
virtual 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 touch (void)
 'Touches' the resource to indicate it has been used. More...
 
virtual void unload (void)
 Unloads the resource; this is not permanent, the resource can be reloaded later if required. More...
 

Static Public Member Functions

static void cleanupDictionary ()
 Cleans up the static 'msDictionary' required to reset Ogre, otherwise the containers are left with invalid pointers, which will lead to a crash as soon as one of the ResourceManager implementers (e.g. More...
 
static String resolveCgIncludes (const String &source, Resource *resourceBeingLoaded, const String &fileName)
 Scan the file for #include and replace with source from the OGRE resources. More...
 

Public Attributes

 OGRE_AUTO_MUTEX
 

Protected Types

typedef set< Listener * >::type ListenerList
 

Protected Member Functions

void addMicrocodeToCache ()
 
void buildArgs (void)
 Internal method which merges manual and automatic compile arguments. More...
 
void buildConstantDefinitions () const
 Populate the passed parameters with name->index map, must be overridden. More...
 
void compileMicrocode (void)
 
void createLogicalParameterMappingStructures (bool recreateIfExists=true) const
 Create the internal params logical mapping structures. More...
 
void createLowLevelImpl (void)
 Internal method for creating an appropriate low-level program from this high-level program, must be implemented by subclasses. More...
 
void createNamedParameterMappingStructures (bool recreateIfExists=true) const
 Create the internal params named mapping structures. More...
 
bool createParamDictionary (const String &className)
 Internal method for creating a parameter dictionary for the class, if it does not already exist. More...
 
void createParameterMappingStructures (bool recreateIfExists=true) const
 Create the internal params logical & named mapping structures. More...
 
void freeCgArgs (void)
 Releases memory for the horrible Cg char**. More...
 
void getMicrocodeFromCache (void)
 
bool isRequiredCapabilitiesSupported (void) const
 Internal method returns whether required capabilities for this program is supported. More...
 
void loadFromSource (void)
 Internal load implementation, must be implemented by subclasses. More...
 
virtual void loadHighLevel (void)
 Internal load high-level portion if not loaded. More...
 
virtual void loadHighLevelImpl (void)
 Internal load implementation, loads just the high-level portion, enough to get parameters. More...
 
void loadHighLevelSafe ()
 Load the high-level part in a thread-safe way, required for delegate functionality. More...
 
void loadImpl ()
 Internal implementation of the meat of the 'load' action, only called if this resource is not being loaded from a ManualResourceLoader. More...
 
void mapTypeAndElementSize (CGtype cgType, bool isRegisterCombiner, GpuConstantDefinition &def) const
 Turn a Cg type into a GpuConstantType and number of elements. More...
 
 OGRE_MUTEX (mListenerListMutex)
 
virtual void populateParameterNames (GpuProgramParametersSharedPtr params)
 Populate the passed parameters with name->index map. More...
 
virtual void postLoadImpl (void)
 Internal hook to perform actions after the load process, but before the resource has been marked as fully loaded. More...
 
virtual void postUnloadImpl (void)
 Internal hook to perform actions after the unload process, but before the resource has been marked as fully unloaded. More...
 
virtual void preLoadImpl (void)
 Internal hook to perform actions before the load process, but after the resource has been marked as 'loading'. More...
 
virtual void prepareImpl (void)
 Internal implementation of the meat of the 'prepare' action. More...
 
virtual void preUnloadImpl (void)
 Internal hook to perform actions before the unload process. More...
 
void recurseParams (CGparameter param, size_t contextArraySize=1)
 Recurse down structures getting data on parameters. More...
 
void selectProfile (void)
 Internal method which works out which profile to use for this program. More...
 
void setupBaseParamDictionary (void)
 Internal method for setting up the basic parameter definitions for a subclass. More...
 
virtual void unloadHighLevel (void)
 Internal unload high-level portion if loaded. More...
 
void unloadHighLevelImpl (void)
 Internal unload implementation, must be implemented by subclasses. More...
 
void unloadImpl ()
 Internal implementation of the 'unload' action; called regardless of whether this resource is being loaded from a ManualResourceLoader. More...
 
virtual void unprepareImpl (void)
 Internal function for undoing the 'prepare' action. More...
 

Protected Attributes

GpuProgramPtr mAssemblerProgram
 The underlying assembler program. More...
 
GpuLogicalBufferStructPtr mBoolLogicalToPhysical
 Record of logical to physical buffer maps. More...
 
char ** mCgArguments
 
CGcontext mCgContext
 The CG context to use, passed in by factory. More...
 
String mCompileArgs
 
bool mCompileError
 Did we encounter a compilation error? More...
 
Vector3 mComputeGroupDimensions
 The number of process groups dispatched by this (compute) program. More...
 
GpuNamedConstantsPtr mConstantDefs
 Parameter name -> ConstantDefinition map, shared instance used by all parameter objects. More...
 
bool mConstantDefsBuilt
 Have we built the name->index parameter map yet? More...
 
ResourceManagermCreator
 Creator. More...
 
GpuProgramParametersSharedPtr mDefaultParams
 The default parameters for use with this object. More...
 
GpuLogicalBufferStructPtr mDoubleLogicalToPhysical
 Record of logical to physical buffer maps. More...
 
String mEntryPoint
 
String mFilename
 The name of the file to load source from (may be blank) More...
 
GpuLogicalBufferStructPtr mFloatLogicalToPhysical
 Record of logical to physical buffer maps. More...
 
String mGroup
 The name of the resource group. More...
 
ResourceHandle mHandle
 Numeric handle for more efficient look up than name. More...
 
bool mHighLevelLoaded
 Whether the high-level program (and it's parameter defs) is loaded. More...
 
CGenum mInputOp
 
GpuLogicalBufferStructPtr mIntLogicalToPhysical
 Record of logical to physical buffer maps. More...
 
volatile bool mIsBackgroundLoaded
 Is this resource going to be background loaded? Only applicable for multithreaded. More...
 
bool mIsManual
 Is this file manually loaded? More...
 
ListenerList mListenerList
 
bool mLoadedManualNamedConstants
 
ManualResourceLoadermLoader
 Optional manual loader; if provided, data is loaded from here instead of a file. More...
 
bool mLoadFromFile
 Whether we need to load source from file or not. More...
 
AtomicScalar< LoadingStatemLoadingState
 Is the resource currently loaded? More...
 
String mManualNamedConstantsFile
 File from which to load named constants manually. More...
 
bool mMorphAnimation
 Does this (vertex) program include morph animation? More...
 
String mName
 Unique name of the resource. More...
 
bool mNeedsAdjacencyInfo
 Does this (geometry) program require adjacency information? More...
 
String mOrigin
 Origin of this resource (e.g. script name) - optional. More...
 
CGenum mOutputOp
 
GpuConstantDefinitionMap mParametersMap
 
size_t mParametersMapSizeAsBuffer
 
ushort mPoseAnimation
 Does this (vertex) program include pose animation (count of number of poses supported) More...
 
StringVector mProfiles
 
String mProgramString
 
map< String, int >::type mSamplerRegisterMap
 
CGprofile mSelectedCgProfile
 
String mSelectedProfile
 
size_t mSize
 The size of the resource in bytes. More...
 
bool mSkeletalAnimation
 Does this (vertex) program include skeletal animation? More...
 
String mSource
 The assembler source of the program (may be blank until file loaded) More...
 
size_t mStateCount
 State count, the number of times this resource has changed state. More...
 
String mSyntaxCode
 Syntax code e.g. arbvp1, vs_2_0 etc. More...
 
GpuProgramType mType
 The type of the program. More...
 
GpuLogicalBufferStructPtr mUIntLogicalToPhysical
 Record of logical to physical buffer maps. More...
 
bool mVertexTextureFetch
 Does this (vertex) program require support for vertex texture fetch? More...
 

Static Protected Attributes

static CmdAdjacency msAdjacencyCmd
 
static CmdArgs msCmdArgs
 
static CmdEntryPoint msCmdEntryPoint
 
static CmdProfiles msCmdProfiles
 
static CmdComputeGroupDims msComputeGroupDimsCmd
 
static CmdManualNamedConstsFile msManNamedConstsFileCmd
 
static CmdMorph msMorphCmd
 
static CmdPose msPoseCmd
 
static CmdSkeletal msSkeletalCmd
 
static CmdSyntax msSyntaxCmd
 
static CmdType msTypeCmd
 
static CmdVTF msVTFCmd
 

Private Member Functions

void fixHighLevelOutput (String &hlSource)
 
String getHighLevelLanguage () const
 
String getHighLevelTarget () const
 

Private Attributes

HighLevelGpuProgramPtr mDelegate
 

Detailed Description

Specialisation of HighLevelGpuProgram to provide support for nVidia's CG language.

Remarks
Cg can be used to compile common, high-level, C-like code down to assembler language for both GL and Direct3D, for multiple graphics cards. You must supply a list of profiles which your program must support using setProfiles() before the program is loaded in order for this to work. The program will then negotiate with the renderer to compile the appropriate program for the API and graphics card capabilities.

Definition at line 45 of file OgreCgProgram.h.

Member Typedef Documentation

typedef set<Listener*>::type Ogre::Resource::ListenerList
protectedinherited

Definition at line 154 of file OgreResource.h.

Member Enumeration Documentation

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 115 of file OgreResource.h.

Constructor & Destructor Documentation

Ogre::CgProgram::CgProgram ( ResourceManager creator,
const String name,
ResourceHandle  handle,
const String group,
bool  isManual,
ManualResourceLoader loader,
CGcontext  context 
)
Ogre::CgProgram::~CgProgram ( )

Member Function Documentation

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.
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
wasBackgroundLoadedWhether this was a background loaded event
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
wasBackgroundLoadedWhether this was a background loaded event
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.
GpuProgram* Ogre::CgProgram::_getBindingDelegate ( void  )
virtual

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

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

Notify this resource of it's origin.

Definition at line 424 of file OgreResource.h.

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

Register a listener on this resource.

See also
Resource::Listener

Reimplemented in Ogre::UnifiedHighLevelGpuProgram.

void Ogre::CgProgram::addMicrocodeToCache ( )
protected
void Ogre::CgProgram::buildArgs ( void  )
protected

Internal method which merges manual and automatic compile arguments.

void Ogre::CgProgram::buildConstantDefinitions ( ) const
protectedvirtual

Populate the passed parameters with name->index map, must be overridden.

Implements Ogre::HighLevelGpuProgram.

virtual size_t Ogre::HighLevelGpuProgram::calculateSize ( void  ) const
virtualinherited

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

Reimplemented from Ogre::GpuProgram.

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

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
newGroupName of the new group
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.

void Ogre::CgProgram::compileMicrocode ( void  )
protected
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
destPointer to object to have it's parameters set the same as this object.

Definition at line 302 of file OgreStringInterface.h.

References Ogre::ParamDictionary::mParamDefs, and Ogre::StringInterface::setParameter().

void Ogre::GpuProgram::createLogicalParameterMappingStructures ( bool  recreateIfExists = true) const
protectedinherited

Create the internal params logical mapping structures.

void Ogre::CgProgram::createLowLevelImpl ( void  )
protectedvirtual

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

Implements Ogre::HighLevelGpuProgram.

void Ogre::GpuProgram::createNamedParameterMappingStructures ( bool  recreateIfExists = true) const
protectedinherited

Create the internal params named mapping structures.

bool Ogre::StringInterface::createParamDictionary ( const String className)
inlineprotectedinherited

Internal method for creating a parameter dictionary for the class, if it does not already exist.

Remarks
This method will check to see if a parameter dictionary exist for this class yet, and if not will create one. NB you must supply the name of the class (RTTI is not used or performance).
Parameters
classNamethe name of the class using the dictionary
Returns
true if a new dictionary was created, false if it was already there

Definition at line 185 of file OgreStringInterface.h.

References OGRE_LOCK_MUTEX.

void Ogre::GpuProgram::createParameterMappingStructures ( bool  recreateIfExists = true) const
protectedinherited

Create the internal params logical & named mapping structures.

GpuProgramParametersSharedPtr Ogre::CgProgram::createParameters ( )
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::HighLevelGpuProgram.

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.

void Ogre::CgProgram::fixHighLevelOutput ( String hlSource)
private
void Ogre::CgProgram::freeCgArgs ( void  )
protected

Releases memory for the horrible Cg char**.

const String& Ogre::CgProgram::getCompileArguments ( void  ) const
inline

Gets the entry point defined for this program.

Definition at line 147 of file OgreCgProgram.h.

References mCompileArgs.

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

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

Definition at line 350 of file OgreGpuProgram.h.

const GpuNamedConstants& Ogre::HighLevelGpuProgram::getConstantDefinitions ( ) const
virtualinherited

Get the full list of GpuConstantDefinition instances.

Note
Only available if this parameters object has named parameters.

Reimplemented from Ogre::GpuProgram.

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

Gets the manager which created this resource.

Definition at line 415 of file OgreResource.h.

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

const String& Ogre::CgProgram::getEntryPoint ( void  ) const
inline

Gets the entry point defined for this program.

Definition at line 139 of file OgreCgProgram.h.

References mEntryPoint.

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

Gets the group which this resource is a member of.

Definition at line 403 of file OgreResource.h.

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

Reimplemented in Ogre::OldSkeletonInstance.

Definition at line 313 of file OgreResource.h.

String Ogre::CgProgram::getHighLevelLanguage ( ) const
private
String Ogre::CgProgram::getHighLevelTarget ( ) const
private
const String& Ogre::CgProgram::getLanguage ( void  ) const
virtual

Overridden from GpuProgram.

Reimplemented from Ogre::GpuProgram.

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

Returns the current loading state.

Reimplemented in Ogre::UnifiedHighLevelGpuProgram.

Definition at line 352 of file OgreResource.h.

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

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.

Definition at line 432 of file OgreGpuProgram.h.

void Ogre::CgProgram::getMicrocodeFromCache ( void  )
protected
virtual const String& Ogre::Resource::getName ( void  ) const
inlinevirtualinherited

Gets resource name.

Reimplemented in Ogre::OldSkeletonInstance.

Definition at line 308 of file OgreResource.h.

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

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

Definition at line 325 of file OgreGpuProgram.h.

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.

Definition at line 422 of file OgreResource.h.

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.

Definition at line 218 of file OgreStringInterface.h.

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

Definition at line 223 of file OgreStringInterface.h.

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
nameThe name of the parameter to get
Returns
String value of parameter, blank if not found

Definition at line 271 of file OgreStringInterface.h.

References Ogre::ParamCommand::doGet(), and Ogre::ParamDictionary::getParamCommand().

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.
bool Ogre::CgProgram::getPassFogStates ( void  ) const
virtual

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.

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

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.

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

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.

const StringVector& Ogre::CgProgram::getProfiles ( void  ) const
inline

Gets the Cg profiles which can be supported by the program.

Definition at line 143 of file OgreCgProgram.h.

References mProfiles.

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

Retrieves info about the size of the resource.

Reimplemented from Ogre::Resource.

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

Gets the assembler source for this program.

Definition at line 247 of file OgreGpuProgram.h.

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

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

Definition at line 245 of file OgreGpuProgram.h.

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.

Definition at line 433 of file OgreResource.h.

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

Gets the syntax code for this program e.g.

arbvp1, fp20, vs_1_1 etc

Definition at line 239 of file OgreGpuProgram.h.

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

Get the program type.

Definition at line 251 of file OgreGpuProgram.h.

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

Did this program encounter a compile error when loading?

Reimplemented from Ogre::GpuProgram.

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

Returns true if default parameters have been set up.

Reimplemented from Ogre::GpuProgram.

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

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

Definition at line 342 of file OgreGpuProgram.h.

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.

Definition at line 369 of file OgreResource.h.

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

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

Reimplemented in Ogre::UnifiedHighLevelGpuProgram.

Definition at line 328 of file OgreResource.h.

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

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

Reimplemented in Ogre::UnifiedHighLevelGpuProgram.

Definition at line 345 of file OgreResource.h.

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

Is this resource manually loaded?

Definition at line 277 of file OgreResource.h.

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

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

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

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

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

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

Definition at line 320 of file OgreResource.h.

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

Returns true if the Resource is reloadable, false otherwise.

Reimplemented in Ogre::UnifiedHighLevelGpuProgram.

Definition at line 270 of file OgreResource.h.

bool Ogre::GpuProgram::isRequiredCapabilitiesSupported ( void  ) const
protectedinherited

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

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

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

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

Overridden from GpuProgram.

Reimplemented from Ogre::GpuProgram.

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

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

Reimplemented from Ogre::GpuProgram.

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

Reimplemented in Ogre::UnifiedHighLevelGpuProgram.

void Ogre::CgProgram::loadFromSource ( void  )
protectedvirtual

Internal load implementation, must be implemented by subclasses.

Implements Ogre::GpuProgram.

virtual void Ogre::HighLevelGpuProgram::loadHighLevel ( void  )
protectedvirtualinherited

Internal load high-level portion if not loaded.

virtual void Ogre::HighLevelGpuProgram::loadHighLevelImpl ( void  )
protectedvirtualinherited

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

void Ogre::CgProgram::loadHighLevelSafe ( )
protected

Load the high-level part in a thread-safe way, required for delegate functionality.

void Ogre::HighLevelGpuProgram::loadImpl ( )
protectedvirtualinherited

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::CgProgram::mapTypeAndElementSize ( CGtype  cgType,
bool  isRegisterCombiner,
GpuConstantDefinition def 
) const
protected

Turn a Cg type into a GpuConstantType and number of elements.

Ogre::Resource::OGRE_MUTEX ( mListenerListMutex  )
protectedinherited
template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete ( void *  ptr)
inlineinherited

Definition at line 96 of file OgreMemoryAllocatedObject.h.

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

Definition at line 102 of file OgreMemoryAllocatedObject.h.

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

Definition at line 108 of file OgreMemoryAllocatedObject.h.

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

Definition at line 113 of file OgreMemoryAllocatedObject.h.

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

Definition at line 119 of file OgreMemoryAllocatedObject.h.

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

Definition at line 68 of file OgreMemoryAllocatedObject.h.

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

Definition at line 73 of file OgreMemoryAllocatedObject.h.

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

placement operator new

Definition at line 79 of file OgreMemoryAllocatedObject.h.

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

Definition at line 86 of file OgreMemoryAllocatedObject.h.

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

Definition at line 91 of file OgreMemoryAllocatedObject.h.

virtual void Ogre::HighLevelGpuProgram::populateParameterNames ( GpuProgramParametersSharedPtr  params)
protectedvirtualinherited

Populate the passed parameters with name->index map.

Reimplemented in Ogre::GLSLShader, Ogre::GLSLProgram, Ogre::GLSL::GLSLProgram, and Ogre::D3D11HLSLProgram.

virtual void Ogre::Resource::postLoadImpl ( void  )
inlineprotectedvirtualinherited

Internal hook to perform actions after the load process, but before the resource has been marked as fully loaded.

Note
Mutex will have already been acquired by the loading thread. Also, this call will occur even when using a ManualResourceLoader (when loadImpl is not actually called)

Reimplemented in Ogre::Mesh, Ogre::D3D9Texture, and Ogre::D3D11Texture.

Definition at line 179 of file OgreResource.h.

virtual void Ogre::Resource::postUnloadImpl ( void  )
inlineprotectedvirtualinherited

Internal hook to perform actions after the unload process, but before the resource has been marked as fully unloaded.

Note
Mutex will have already been acquired by the unloading thread.

Definition at line 189 of file OgreResource.h.

virtual void Ogre::Resource::preLoadImpl ( void  )
inlineprotectedvirtualinherited

Internal hook to perform actions before the load process, but after the resource has been marked as 'loading'.

Note
Mutex will have already been acquired by the loading thread. Also, this call will occur even when using a ManualResourceLoader (when loadImpl is not actually called)

Definition at line 172 of file OgreResource.h.

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
backgroundThreadWhether this is occurring in a background thread
virtual void Ogre::Resource::prepareImpl ( void  )
inlineprotectedvirtualinherited

Internal implementation of the meat of the 'prepare' action.

Reimplemented in Ogre::Mesh, Ogre::D3D9Texture, Ogre::D3D11Texture, Ogre::Material, Ogre::GL3PlusTexture, Ogre::GLTexture, and Ogre::PatchMesh.

Definition at line 193 of file OgreResource.h.

virtual void Ogre::Resource::preUnloadImpl ( void  )
inlineprotectedvirtualinherited

Internal hook to perform actions before the unload process.

Note
Mutex will have already been acquired by the unloading thread.

Definition at line 184 of file OgreResource.h.

void Ogre::CgProgram::recurseParams ( CGparameter  param,
size_t  contextArraySize = 1 
)
protected

Recurse down structures getting data on parameters.

virtual void Ogre::Resource::reload ( void  )
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::UnifiedHighLevelGpuProgram.

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

Remove a listener on this resource.

See also
Resource::Listener

Reimplemented in Ogre::UnifiedHighLevelGpuProgram.

void Ogre::CgProgram::resetCompileError ( void  )
virtual

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

Reimplemented from Ogre::GpuProgram.

static String Ogre::CgProgram::resolveCgIncludes ( const String source,
Resource resourceBeingLoaded,
const String fileName 
)
static

Scan the file for #include and replace with source from the OGRE resources.

void Ogre::CgProgram::selectProfile ( void  )
protected

Internal method which works out which profile to use for this program.

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

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

Definition at line 338 of file OgreGpuProgram.h.

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.

Definition at line 379 of file OgreResource.h.

void Ogre::CgProgram::setCompileArguments ( const String args)
inline

Sets the compilation arguments for this program ie the first method called.

Definition at line 145 of file OgreCgProgram.h.

References mCompileArgs.

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

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

Definition at line 346 of file OgreGpuProgram.h.

void Ogre::CgProgram::setEntryPoint ( const String entryPoint)
inline

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

Definition at line 137 of file OgreCgProgram.h.

References mEntryPoint.

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

Set "Is this resource manually loaded?".

Definition at line 284 of file OgreResource.h.

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

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

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

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 294 of file OgreGpuProgram.h.

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
nameThe name of the parameter to set
valueString value. Must be in the right format for the type specified in the parameter definition. See the StringConverter class for more information.
Returns
true if set was successful, false otherwise (NB no exceptions thrown - tolerant method)

Referenced by Ogre::StringInterface::copyParametersTo().

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
paramListName/value pair list
virtual void Ogre::GpuProgram::setPoseAnimationIncluded ( ushort  poseCount)
inlinevirtualinherited

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
poseCountThe number of simultaneous poses the program can blend

Definition at line 304 of file OgreGpuProgram.h.

void Ogre::CgProgram::setProfiles ( const StringVector profiles)

Sets the Cg profiles which can be supported by the program.

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

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.

Reimplemented in Ogre::GLSLProgram.

Definition at line 277 of file OgreGpuProgram.h.

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

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 void Ogre::GpuProgram::setSourceFile ( const String filename)
virtualinherited

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::setSyntaxCode ( const String syntax)
virtualinherited

Sets the syntax code for this program e.g.

arbvp1, fp20, vs_1_1 etc

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

Change the Resource loading state to loaded.

Definition at line 336 of file OgreResource.h.

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

Set the program type (only valid before load)

Reimplemented in Ogre::GLArbGpuProgram.

void Ogre::GpuProgram::setupBaseParamDictionary ( void  )
protectedinherited

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.
virtual void Ogre::GpuProgram::setVertexTextureFetchRequired ( bool  r)
inlinevirtualinherited

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

Definition at line 329 of file OgreGpuProgram.h.

void Ogre::CgProgram::touch ( void  )
virtual

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

Reimplemented from Ogre::Resource.

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.

virtual void Ogre::HighLevelGpuProgram::unloadHighLevel ( void  )
protectedvirtualinherited

Internal unload high-level portion if loaded.

void Ogre::CgProgram::unloadHighLevelImpl ( void  )
protectedvirtual

Internal unload implementation, must be implemented by subclasses.

Implements Ogre::HighLevelGpuProgram.

void Ogre::HighLevelGpuProgram::unloadImpl ( )
protectedvirtualinherited

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

Implements Ogre::Resource.

Reimplemented in Ogre::GLSLShader, Ogre::GLSLProgram, and Ogre::GLSL::GLSLProgram.

virtual void Ogre::Resource::unprepareImpl ( void  )
inlineprotectedvirtualinherited

Internal function for undoing the 'prepare' action.

Called when the load is completed, and when resources are unloaded when they are prepared but not yet loaded.

Reimplemented in Ogre::Mesh, Ogre::D3D9Texture, Ogre::D3D11Texture, Ogre::Material, Ogre::GL3PlusTexture, and Ogre::GLTexture.

Definition at line 198 of file OgreResource.h.

Member Data Documentation

GpuProgramPtr Ogre::HighLevelGpuProgram::mAssemblerProgram
protectedinherited

The underlying assembler program.

Definition at line 69 of file OgreHighLevelGpuProgram.h.

GpuLogicalBufferStructPtr Ogre::GpuProgram::mBoolLogicalToPhysical
mutableprotectedinherited

Record of logical to physical buffer maps.

Mandatory for low-level programs or high-level programs which set their params the same way. This is a shared pointer because if the program is recompiled and the parameters change, this definition will alter, but previous params may reference the old def.

Definition at line 184 of file OgreGpuProgram.h.

char** Ogre::CgProgram::mCgArguments
protected

Definition at line 105 of file OgreCgProgram.h.

CGcontext Ogre::CgProgram::mCgContext
protected

The CG context to use, passed in by factory.

Definition at line 77 of file OgreCgProgram.h.

String Ogre::CgProgram::mCompileArgs
protected

Definition at line 102 of file OgreCgProgram.h.

Referenced by getCompileArguments(), and setCompileArguments().

bool Ogre::GpuProgram::mCompileError
protectedinherited

Did we encounter a compilation error?

Definition at line 159 of file OgreGpuProgram.h.

Vector3 Ogre::GpuProgram::mComputeGroupDimensions
protectedinherited

The number of process groups dispatched by this (compute) program.

Definition at line 155 of file OgreGpuProgram.h.

GpuNamedConstantsPtr Ogre::GpuProgram::mConstantDefs
mutableprotectedinherited

Parameter name -> ConstantDefinition map, shared instance used by all parameter objects.

This is a shared pointer because if the program is recompiled and the parameters change, this definition will alter, but previous params may reference the old def.

Definition at line 189 of file OgreGpuProgram.h.

bool Ogre::HighLevelGpuProgram::mConstantDefsBuilt
mutableprotectedinherited

Have we built the name->index parameter map yet?

Definition at line 71 of file OgreHighLevelGpuProgram.h.

ResourceManager* Ogre::Resource::mCreator
protectedinherited

Creator.

Definition at line 132 of file OgreResource.h.

GpuProgramParametersSharedPtr Ogre::GpuProgram::mDefaultParams
protectedinherited

The default parameters for use with this object.

Definition at line 157 of file OgreGpuProgram.h.

HighLevelGpuProgramPtr Ogre::CgProgram::mDelegate
private

Definition at line 124 of file OgreCgProgram.h.

GpuLogicalBufferStructPtr Ogre::GpuProgram::mDoubleLogicalToPhysical
mutableprotectedinherited

Record of logical to physical buffer maps.

Mandatory for low-level programs or high-level programs which set their params the same way. This is a shared pointer because if the program is recompiled and the parameters change, this definition will alter, but previous params may reference the old def.

Definition at line 169 of file OgreGpuProgram.h.

String Ogre::CgProgram::mEntryPoint
protected

Definition at line 98 of file OgreCgProgram.h.

Referenced by getEntryPoint(), and setEntryPoint().

String Ogre::GpuProgram::mFilename
protectedinherited

The name of the file to load source from (may be blank)

Definition at line 137 of file OgreGpuProgram.h.

GpuLogicalBufferStructPtr Ogre::GpuProgram::mFloatLogicalToPhysical
mutableprotectedinherited

Record of logical to physical buffer maps.

Mandatory for low-level programs or high-level programs which set their params the same way. This is a shared pointer because if the program is recompiled and the parameters change, this definition will alter, but previous params may reference the old def.

Definition at line 164 of file OgreGpuProgram.h.

String Ogre::Resource::mGroup
protectedinherited

The name of the resource group.

Definition at line 136 of file OgreResource.h.

ResourceHandle Ogre::Resource::mHandle
protectedinherited

Numeric handle for more efficient look up than name.

Definition at line 138 of file OgreResource.h.

bool Ogre::HighLevelGpuProgram::mHighLevelLoaded
protectedinherited

Whether the high-level program (and it's parameter defs) is loaded.

Definition at line 67 of file OgreHighLevelGpuProgram.h.

CGenum Ogre::CgProgram::mInputOp
protected

Definition at line 110 of file OgreCgProgram.h.

GpuLogicalBufferStructPtr Ogre::GpuProgram::mIntLogicalToPhysical
mutableprotectedinherited

Record of logical to physical buffer maps.

Mandatory for low-level programs or high-level programs which set their params the same way. This is a shared pointer because if the program is recompiled and the parameters change, this definition will alter, but previous params may reference the old def.

Definition at line 174 of file OgreGpuProgram.h.

volatile bool Ogre::Resource::mIsBackgroundLoaded
protectedinherited

Is this resource going to be background loaded? Only applicable for multithreaded.

Definition at line 142 of file OgreResource.h.

bool Ogre::Resource::mIsManual
protectedinherited

Is this file manually loaded?

Definition at line 146 of file OgreResource.h.

ListenerList Ogre::Resource::mListenerList
protectedinherited

Definition at line 155 of file OgreResource.h.

bool Ogre::GpuProgram::mLoadedManualNamedConstants
protectedinherited

Definition at line 192 of file OgreGpuProgram.h.

ManualResourceLoader* Ogre::Resource::mLoader
protectedinherited

Optional manual loader; if provided, data is loaded from here instead of a file.

Definition at line 150 of file OgreResource.h.

bool Ogre::GpuProgram::mLoadFromFile
protectedinherited

Whether we need to load source from file or not.

Definition at line 141 of file OgreGpuProgram.h.

AtomicScalar<LoadingState> Ogre::Resource::mLoadingState
protectedinherited

Is the resource currently loaded?

Definition at line 140 of file OgreResource.h.

String Ogre::GpuProgram::mManualNamedConstantsFile
protectedinherited

File from which to load named constants manually.

Definition at line 191 of file OgreGpuProgram.h.

bool Ogre::GpuProgram::mMorphAnimation
protectedinherited

Does this (vertex) program include morph animation?

Definition at line 147 of file OgreGpuProgram.h.

String Ogre::Resource::mName
protectedinherited

Unique name of the resource.

Definition at line 134 of file OgreResource.h.

bool Ogre::GpuProgram::mNeedsAdjacencyInfo
protectedinherited

Does this (geometry) program require adjacency information?

Definition at line 153 of file OgreGpuProgram.h.

String Ogre::Resource::mOrigin
protectedinherited

Origin of this resource (e.g. script name) - optional.

Definition at line 148 of file OgreResource.h.

CGenum Ogre::CgProgram::mOutputOp
protected

Definition at line 110 of file OgreCgProgram.h.

GpuConstantDefinitionMap Ogre::CgProgram::mParametersMap
protected

Definition at line 107 of file OgreCgProgram.h.

size_t Ogre::CgProgram::mParametersMapSizeAsBuffer
protected

Definition at line 108 of file OgreCgProgram.h.

ushort Ogre::GpuProgram::mPoseAnimation
protectedinherited

Does this (vertex) program include pose animation (count of number of poses supported)

Definition at line 149 of file OgreGpuProgram.h.

StringVector Ogre::CgProgram::mProfiles
protected

Definition at line 97 of file OgreCgProgram.h.

Referenced by getProfiles().

String Ogre::CgProgram::mProgramString
protected

Definition at line 100 of file OgreCgProgram.h.

CmdAdjacency Ogre::GpuProgram::msAdjacencyCmd
staticprotectedinherited

Definition at line 132 of file OgreGpuProgram.h.

map<String,int>::type Ogre::CgProgram::mSamplerRegisterMap
protected

Definition at line 109 of file OgreCgProgram.h.

CmdArgs Ogre::CgProgram::msCmdArgs
staticprotected

Definition at line 74 of file OgreCgProgram.h.

CmdEntryPoint Ogre::CgProgram::msCmdEntryPoint
staticprotected

Definition at line 72 of file OgreCgProgram.h.

CmdProfiles Ogre::CgProgram::msCmdProfiles
staticprotected

Definition at line 73 of file OgreCgProgram.h.

CmdComputeGroupDims Ogre::GpuProgram::msComputeGroupDimsCmd
staticprotectedinherited

Definition at line 133 of file OgreGpuProgram.h.

CGprofile Ogre::CgProgram::mSelectedCgProfile
protected

Definition at line 101 of file OgreCgProgram.h.

String Ogre::CgProgram::mSelectedProfile
protected

Definition at line 99 of file OgreCgProgram.h.

size_t Ogre::Resource::mSize
protectedinherited

The size of the resource in bytes.

Definition at line 144 of file OgreResource.h.

bool Ogre::GpuProgram::mSkeletalAnimation
protectedinherited

Does this (vertex) program include skeletal animation?

Definition at line 145 of file OgreGpuProgram.h.

CmdManualNamedConstsFile Ogre::GpuProgram::msManNamedConstsFileCmd
staticprotectedinherited

Definition at line 131 of file OgreGpuProgram.h.

CmdMorph Ogre::GpuProgram::msMorphCmd
staticprotectedinherited

Definition at line 128 of file OgreGpuProgram.h.

String Ogre::GpuProgram::mSource
protectedinherited

The assembler source of the program (may be blank until file loaded)

Definition at line 139 of file OgreGpuProgram.h.

CmdPose Ogre::GpuProgram::msPoseCmd
staticprotectedinherited

Definition at line 129 of file OgreGpuProgram.h.

CmdSkeletal Ogre::GpuProgram::msSkeletalCmd
staticprotectedinherited

Definition at line 127 of file OgreGpuProgram.h.

CmdSyntax Ogre::GpuProgram::msSyntaxCmd
staticprotectedinherited

Definition at line 126 of file OgreGpuProgram.h.

size_t Ogre::Resource::mStateCount
protectedinherited

State count, the number of times this resource has changed state.

Definition at line 152 of file OgreResource.h.

CmdType Ogre::GpuProgram::msTypeCmd
staticprotectedinherited

Definition at line 125 of file OgreGpuProgram.h.

CmdVTF Ogre::GpuProgram::msVTFCmd
staticprotectedinherited

Definition at line 130 of file OgreGpuProgram.h.

String Ogre::GpuProgram::mSyntaxCode
protectedinherited

Syntax code e.g. arbvp1, vs_2_0 etc.

Definition at line 143 of file OgreGpuProgram.h.

GpuProgramType Ogre::GpuProgram::mType
protectedinherited

The type of the program.

Definition at line 135 of file OgreGpuProgram.h.

GpuLogicalBufferStructPtr Ogre::GpuProgram::mUIntLogicalToPhysical
mutableprotectedinherited

Record of logical to physical buffer maps.

Mandatory for low-level programs or high-level programs which set their params the same way. This is a shared pointer because if the program is recompiled and the parameters change, this definition will alter, but previous params may reference the old def.

Definition at line 179 of file OgreGpuProgram.h.

bool Ogre::GpuProgram::mVertexTextureFetch
protectedinherited

Does this (vertex) program require support for vertex texture fetch?

Definition at line 151 of file OgreGpuProgram.h.

Ogre::Resource::OGRE_AUTO_MUTEX
inherited

Definition at line 80 of file OgreResource.h.


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