Specialisation of HighLevelGpuProgram to provide support for D3D9 High-Level Shader Language (HLSL). More...
#include <OgreD3D9HLSLProgram.h>
Classes | |
class | CmdAssemblerCode |
Command object for getting/setting assembler code. More... | |
class | CmdBackwardsCompatibility |
Command object for enabling backwards compatibility. More... | |
class | CmdColumnMajorMatrices |
Command object for setting matrix packing in column-major order. More... | |
class | CmdEntryPoint |
Command object for setting entry point. More... | |
class | CmdMicrocode |
Command object for getting/setting micro code. More... | |
class | CmdOptimisation |
Command object for setting optimisation level. More... | |
class | CmdPreprocessorDefines |
Command object for setting macro defines. More... | |
class | CmdTarget |
Command object for setting target assembler. 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... | |
enum | OptimisationLevel { OPT_DEFAULT, OPT_NONE, OPT_0, OPT_1, OPT_2, OPT_3 } |
Shader optimisation level. More... | |
Public Member Functions | |
D3D9HLSLProgram (ResourceManager *creator, const String &name, ResourceHandle handle, const String &group, bool isManual, ManualResourceLoader *loader) | |
~D3D9HLSLProgram () | |
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 (void) |
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 (void) |
Overridden from GpuProgram. More... | |
virtual void | escalateLoading () |
Escalates the loading of a background loaded resource. More... | |
bool | getBackwardsCompatibility (void) const |
Gets whether backwards compatibility mode should be enabled. More... | |
bool | getColumnMajorMatrices (void) const |
Gets whether matrix packed in column-major order. More... | |
const GpuNamedConstants & | getConstantDefinitions () const |
Get the full list of GpuConstantDefinition instances. More... | |
virtual ResourceManager * | getCreator (void) |
Gets the manager which created this resource. More... | |
virtual GpuProgramParametersSharedPtr | getDefaultParameters (void) |
Get a reference to the default parameters which are to be used for all uses of this program. More... | |
const String & | getEntryPoint (void) const |
Gets the entry point defined for this program. More... | |
virtual const String & | getGroup (void) const |
Gets the group which this resource is a member of. More... | |
virtual ResourceHandle | getHandle (void) const |
const String & | getLanguage (void) const |
Overridden from GpuProgram. More... | |
virtual LoadingState | getLoadingState () const |
Returns the current loading state. More... | |
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. More... | |
LPD3DXBUFFER | getMicroCode () |
virtual const String & | getName (void) const |
Gets resource name. More... | |
const GpuNamedConstants & | getNamedConstants () const |
Override GpuProgram::getNamedConstants to ensure built. More... | |
virtual ushort | getNumberOfPosesIncluded (void) const |
Returns the number of simultaneous poses the vertex program can blend, for use in pose animation. More... | |
OptimisationLevel | getOptimisationLevel () const |
Gets the optimisation level to use. More... | |
virtual const String & | getOrigin (void) const |
Get the origin of this resource, e.g. More... | |
ParamDictionary * | getParamDictionary (void) |
Retrieves the parameter dictionary for this class. More... | |
const ParamDictionary * | getParamDictionary (void) const |
virtual String | getParameter (const String &name) const |
Generic parameter retrieval method. More... | |
const ParameterList & | getParameters (void) const |
Retrieves a list of parameters valid for this object. More... | |
virtual bool | getPassFogStates (void) const |
Returns whether a fragment program wants fog state to be passed through fixed pipeline low level API rendering calls (default true, subclasses can override) More... | |
virtual bool | getPassSurfaceAndLightStates (void) const |
Returns whether a vertex program wants light and material states to be passed through fixed pipeline low level API rendering calls (default false, subclasses can override) More... | |
virtual 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 String & | getPreprocessorDefines (void) const |
Sets the preprocessor defines use to compile the program. More... | |
virtual size_t | getSize (void) const |
Retrieves info about the size of the resource. More... | |
virtual const String & | getSource (void) const |
Gets the assembler source for this program. More... | |
virtual const String & | getSourceFile (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 String & | getSyntaxCode (void) const |
Gets the syntax code for this program e.g. More... | |
const String & | getTarget (void) const |
Gets the shader target to compile down to, e.g. More... | |
virtual GpuProgramType | getType (void) const |
Get the program type. More... | |
virtual bool | hasCompileError (void) const |
Did this program encounter a compile error when loading? More... | |
virtual 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... | |
virtual bool | isMorphAnimationIncluded (void) const |
Returns whether a vertex program includes the required instructions to perform morph animation. More... | |
virtual 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... | |
virtual 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... | |
virtual 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... | |
virtual 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 | setBackwardsCompatibility (bool compat) |
Sets whether backwards compatibility mode should be enabled. More... | |
void | setColumnMajorMatrices (bool columnMajor) |
Sets whether matrix packing in column-major order. More... | |
void | setEntryPoint (const String &entryPoint) |
Sets the entry point for this program ie the first method called. 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 ¶mDefFile) |
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... | |
void | setOptimisationLevel (OptimisationLevel opt) |
Sets the optimisation level to use. More... | |
virtual bool | setParameter (const String &name, const String &value) |
Generic parameter setting method. More... | |
virtual void | setParameterList (const NameValuePairList ¶mList) |
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 | setPreprocessorDefines (const String &defines) |
Sets the preprocessor defines use to compile 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... | |
void | setTarget (const String &target) |
Sets the shader target to compile down to, e.g. 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... | |
virtual 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... | |
Public Attributes | |
OGRE_AUTO_MUTEX | |
Protected Types | |
typedef set< Listener * >::type | ListenerList |
Protected Member Functions | |
void | addMicrocodeToCache () |
void | buildConstantDefinitions () const |
Populate the passed parameters with name->index map, must be overridden. More... | |
void | compileMicrocode (void) |
Compiles the microcode from the program source. More... | |
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 | getMicrocodeFromCache (void) |
Gets the microcode from the microcode cache. More... | |
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 | loadImpl () |
Internal implementation of the meat of the 'load' action, only called if this resource is not being loaded from a ManualResourceLoader. More... | |
OGRE_MUTEX (mListenerListMutex) | |
void | populateDef (D3DXCONSTANT_DESC &d3dDesc, GpuConstantDefinition &def) const |
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 | processParamElement (LPD3DXCONSTANTTABLE pConstTable, D3DXHANDLE parent, String prefix, unsigned int index) |
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... | |
bool | mBackwardsCompatibility |
bool | mColumnMajorMatrices |
bool | mCompileError |
Did we encounter a compilation error? 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... | |
ResourceManager * | mCreator |
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... | |
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 |
ManualResourceLoader * | mLoader |
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< LoadingState > | mLoadingState |
Is the resource currently loaded? More... | |
String | mManualNamedConstantsFile |
File from which to load named constants manually. More... | |
LPD3DXBUFFER | mMicroCode |
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... | |
OptimisationLevel | mOptimisationLevel |
String | mOrigin |
Origin of this resource (e.g. script name) - optional. More... | |
GpuConstantDefinitionMap | mParametersMap |
size_t | mParametersMapSizeAsBuffer |
ushort | mPoseAnimation |
Does this (vertex) program include pose animation (count of number of poses supported) More... | |
String | mPreprocessorDefines |
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... | |
String | mTarget |
GpuProgramType | mType |
The type of the program. More... | |
bool | mVertexTextureFetch |
Does this (vertex) program require support for vertex texture fetch? More... | |
Static Protected Attributes | |
static CmdAdjacency | msAdjacencyCmd |
static CmdAssemblerCode | msCmdAssemblerCode |
static CmdBackwardsCompatibility | msCmdBackwardsCompatibility |
static CmdColumnMajorMatrices | msCmdColumnMajorMatrices |
static CmdEntryPoint | msCmdEntryPoint |
static CmdMicrocode | msCmdMicrocode |
static CmdOptimisation | msCmdOptimisation |
static CmdPreprocessorDefines | msCmdPreprocessorDefines |
static CmdTarget | msCmdTarget |
static CmdManualNamedConstsFile | msManNamedConstsFileCmd |
static CmdMorph | msMorphCmd |
static CmdPose | msPoseCmd |
static CmdSkeletal | msSkeletalCmd |
static CmdSyntax | msSyntaxCmd |
static CmdType | msTypeCmd |
static CmdVTF | msVTFCmd |
Specialisation of HighLevelGpuProgram to provide support for D3D9 High-Level Shader Language (HLSL).
Definition at line 43 of file OgreD3D9HLSLProgram.h.
|
protectedinherited |
Definition at line 166 of file OgreResource.h.
|
inherited |
Enum identifying the loading state of the resource.
Definition at line 127 of file OgreResource.h.
Shader optimisation level.
Definition at line 147 of file OgreD3D9HLSLProgram.h.
Ogre::D3D9HLSLProgram::D3D9HLSLProgram | ( | ResourceManager * | creator, |
const String & | name, | ||
ResourceHandle | handle, | ||
const String & | group, | ||
bool | isManual, | ||
ManualResourceLoader * | loader | ||
) |
Ogre::D3D9HLSLProgram::~D3D9HLSLProgram | ( | ) |
|
virtualinherited |
Manually mark the state of this resource as having been changed.
|
virtualinherited |
Firing of loading complete event.
wasBackgroundLoaded | Whether this was a background loaded event |
|
virtualinherited |
Firing of preparing complete event.
wasBackgroundLoaded | Whether this was a background loaded event |
|
virtualinherited |
Firing of unloading complete event.
|
inlinevirtualinherited |
Returns the GpuProgram which should be bound to the pipeline.
Reimplemented from Ogre::GpuProgram.
Reimplemented in Ogre::CgProgram, and Ogre::UnifiedHighLevelGpuProgram.
Definition at line 116 of file OgreHighLevelGpuProgram.h.
|
inlinevirtualinherited |
Notify this resource of it's origin.
Definition at line 420 of file OgreResource.h.
|
virtualinherited |
Register a listener on this resource.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram.
|
protected |
|
protectedvirtual |
Populate the passed parameters with name->index map, must be overridden.
Implements Ogre::HighLevelGpuProgram.
|
virtualinherited |
Calculate the size of a resource; this will only be called after 'load'.
Reimplemented from Ogre::GpuProgram.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram.
|
virtualinherited |
Change the resource group ownership of a Resource.
newGroup | Name of the new group |
|
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.
|
protected |
Compiles the microcode from the program source.
|
inlinevirtualinherited |
Method for copying this object's parameters to another object.
dest | Pointer to object to have it's parameters set the same as this object. |
Definition at line 303 of file OgreStringInterface.h.
References Ogre::ParamDictionary::mParamDefs, and Ogre::StringInterface::setParameter().
|
protectedinherited |
Create the internal params logical mapping structures.
|
protectedvirtual |
Internal method for creating an appropriate low-level program from this high-level program, must be implemented by subclasses.
Implements Ogre::HighLevelGpuProgram.
|
protectedinherited |
Create the internal params named mapping structures.
|
inlineprotectedinherited |
Internal method for creating a parameter dictionary for the class, if it does not already exist.
className | the name of the class using the dictionary |
Definition at line 186 of file OgreStringInterface.h.
References OGRE_LOCK_MUTEX.
|
protectedinherited |
Create the internal params logical & named mapping structures.
|
virtual |
Overridden from GpuProgram.
Reimplemented from Ogre::HighLevelGpuProgram.
|
virtualinherited |
Escalates the loading of a background loaded resource.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram.
|
inline |
Gets whether backwards compatibility mode should be enabled.
Definition at line 194 of file OgreD3D9HLSLProgram.h.
|
inline |
Gets whether matrix packed in column-major order.
Definition at line 190 of file OgreD3D9HLSLProgram.h.
|
virtualinherited |
Get the full list of GpuConstantDefinition instances.
Reimplemented from Ogre::GpuProgram.
|
inlinevirtualinherited |
Gets the manager which created this resource.
Definition at line 411 of file OgreResource.h.
|
virtualinherited |
Get a reference to the default parameters which are to be used for all uses of this program.
Reimplemented in Ogre::CgProgram, and Ogre::UnifiedHighLevelGpuProgram.
|
inline |
Gets the entry point defined for this program.
Definition at line 178 of file OgreD3D9HLSLProgram.h.
|
inlinevirtualinherited |
Gets the group which this resource is a member of.
Definition at line 399 of file OgreResource.h.
|
inlinevirtualinherited |
Reimplemented in Ogre::SkeletonInstance.
Definition at line 317 of file OgreResource.h.
|
virtual |
Overridden from GpuProgram.
Reimplemented from Ogre::GpuProgram.
|
inlinevirtualinherited |
Returns the current loading state.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram.
Definition at line 348 of file OgreResource.h.
|
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 411 of file OgreGpuProgram.h.
LPD3DXBUFFER Ogre::D3D9HLSLProgram::getMicroCode | ( | ) |
|
protected |
Gets the microcode from the microcode cache.
|
inlinevirtualinherited |
Gets resource name.
Reimplemented in Ogre::SkeletonInstance.
Definition at line 312 of file OgreResource.h.
|
inlinevirtualinherited |
Override GpuProgram::getNamedConstants to ensure built.
Reimplemented from Ogre::GpuProgram.
Definition at line 125 of file OgreHighLevelGpuProgram.h.
|
inlinevirtualinherited |
Returns the number of simultaneous poses the vertex program can blend, for use in pose animation.
Definition at line 309 of file OgreGpuProgram.h.
|
inline |
Gets the optimisation level to use.
Definition at line 201 of file OgreD3D9HLSLProgram.h.
|
inlinevirtualinherited |
Get the origin of this resource, e.g.
a script file name.
Definition at line 418 of file OgreResource.h.
|
inlineinherited |
Retrieves the parameter dictionary for this class.
Definition at line 219 of file OgreStringInterface.h.
|
inlineinherited |
Definition at line 224 of file OgreStringInterface.h.
|
inlinevirtualinherited |
Generic parameter retrieval method.
name | The name of the parameter to get |
Definition at line 272 of file OgreStringInterface.h.
References Ogre::ParamCommand::doGet(), and Ogre::ParamDictionary::getParamCommand().
|
inherited |
Retrieves a list of parameters valid for this object.
|
inlinevirtualinherited |
Returns whether a fragment program wants fog state to be passed through fixed pipeline low level API rendering calls (default true, subclasses can override)
Reimplemented in Ogre::CgProgram, Ogre::GLSLProgram, and Ogre::UnifiedHighLevelGpuProgram.
Definition at line 360 of file OgreGpuProgram.h.
|
inlinevirtualinherited |
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)
Reimplemented in Ogre::CgProgram, Ogre::GLSLProgram, Ogre::UnifiedHighLevelGpuProgram, and Ogre::GLSL::GLSLProgram.
Definition at line 350 of file OgreGpuProgram.h.
|
inlinevirtualinherited |
Returns whether a vertex program wants transform state to be passed through fixed pipeline low level API rendering calls.
Reimplemented in Ogre::CgProgram, Ogre::GLSLProgram, Ogre::UnifiedHighLevelGpuProgram, and Ogre::GLSL::GLSLProgram.
Definition at line 368 of file OgreGpuProgram.h.
|
inline |
Sets the preprocessor defines use to compile the program.
Definition at line 186 of file OgreD3D9HLSLProgram.h.
|
inlinevirtualinherited |
Retrieves info about the size of the resource.
Reimplemented in Ogre::CgProgram, and Ogre::UnifiedHighLevelGpuProgram.
Definition at line 301 of file OgreResource.h.
|
inlinevirtualinherited |
Gets the assembler source for this program.
Definition at line 231 of file OgreGpuProgram.h.
|
inlinevirtualinherited |
Gets the name of the file used as source for this program.
Definition at line 229 of file OgreGpuProgram.h.
|
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 429 of file OgreResource.h.
|
inlinevirtualinherited |
Gets the syntax code for this program e.g.
arbvp1, fp20, vs_1_1 etc
Definition at line 223 of file OgreGpuProgram.h.
|
inline |
Gets the shader target to compile down to, e.g.
'vs_1_1'.
Definition at line 182 of file OgreD3D9HLSLProgram.h.
|
inlinevirtualinherited |
Get the program type.
Definition at line 235 of file OgreGpuProgram.h.
|
inlinevirtualinherited |
Did this program encounter a compile error when loading?
Reimplemented in Ogre::CgProgram, and Ogre::UnifiedHighLevelGpuProgram.
Definition at line 377 of file OgreGpuProgram.h.
|
inlinevirtualinherited |
Returns true if default parameters have been set up.
Reimplemented in Ogre::CgProgram, and Ogre::UnifiedHighLevelGpuProgram.
Definition at line 342 of file OgreGpuProgram.h.
|
inlinevirtualinherited |
Returns whether this geometry program requires adjacency information from the input primitives.
Definition at line 326 of file OgreGpuProgram.h.
|
inlinevirtualinherited |
Returns whether this Resource has been earmarked for background loading.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram.
Definition at line 365 of file OgreResource.h.
|
inlinevirtualinherited |
Returns true if the Resource has been loaded, false otherwise.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram.
Definition at line 332 of file OgreResource.h.
|
inlinevirtualinherited |
Returns whether the resource is currently in the process of background loading.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram.
Definition at line 341 of file OgreResource.h.
|
inlinevirtualinherited |
Is this resource manually loaded?
Definition at line 289 of file OgreResource.h.
|
inlinevirtualinherited |
Returns whether a vertex program includes the required instructions to perform morph animation.
Reimplemented in Ogre::CgProgram, and Ogre::UnifiedHighLevelGpuProgram.
Definition at line 297 of file OgreGpuProgram.h.
|
inlinevirtualinherited |
Returns whether a vertex program includes the required instructions to perform pose animation.
Reimplemented in Ogre::CgProgram, and Ogre::UnifiedHighLevelGpuProgram.
Definition at line 305 of file OgreGpuProgram.h.
|
inlinevirtualinherited |
Returns true if the Resource has been prepared, false otherwise.
Definition at line 324 of file OgreResource.h.
|
inlinevirtualinherited |
Returns true if the Resource is reloadable, false otherwise.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram.
Definition at line 282 of file OgreResource.h.
|
protectedinherited |
Internal method returns whether required capabilities for this program is supported.
|
inlinevirtualinherited |
Returns whether a vertex program includes the required instructions to perform skeletal animation.
Reimplemented in Ogre::CgProgram, and Ogre::UnifiedHighLevelGpuProgram.
Definition at line 270 of file OgreGpuProgram.h.
|
virtual |
Overridden from GpuProgram.
Reimplemented from Ogre::GpuProgram.
|
inlinevirtualinherited |
Returns whether this vertex program requires support for vertex texture fetch from the hardware.
Reimplemented in Ogre::CgProgram, and Ogre::UnifiedHighLevelGpuProgram.
Definition at line 317 of file OgreGpuProgram.h.
|
virtualinherited |
Loads the resource, if it is not already.
backgroundThread | Indicates whether the caller of this method is the background resource loading thread. |
Reimplemented in Ogre::UnifiedHighLevelGpuProgram.
|
protectedvirtual |
Internal load implementation, must be implemented by subclasses.
Implements Ogre::GpuProgram.
|
protectedvirtualinherited |
Internal load high-level portion if not loaded.
|
protectedvirtualinherited |
Internal load implementation, loads just the high-level portion, enough to get parameters.
|
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.
|
protectedinherited |
|
inlineinherited |
Definition at line 96 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 102 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 108 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 113 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 119 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
operator new, with debug line info
Definition at line 68 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 73 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
placement operator new
Definition at line 79 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
array operator new, with debug line info
Definition at line 86 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 91 of file OgreMemoryAllocatedObject.h.
|
protected |
|
protectedvirtualinherited |
Populate the passed parameters with name->index map.
Reimplemented in Ogre::GLSLProgram, Ogre::GLSL::GLSLProgram, and Ogre::D3D11HLSLProgram.
|
inlineprotectedvirtualinherited |
Internal hook to perform actions after the load process, but before the resource has been marked as fully loaded.
Reimplemented in Ogre::Mesh, Ogre::D3D9Texture, and Ogre::D3D11Texture.
Definition at line 191 of file OgreResource.h.
|
inlineprotectedvirtualinherited |
Internal hook to perform actions after the unload process, but before the resource has been marked as fully unloaded.
Definition at line 201 of file OgreResource.h.
|
inlineprotectedvirtualinherited |
Internal hook to perform actions before the load process, but after the resource has been marked as 'loading'.
Definition at line 184 of file OgreResource.h.
|
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.
backgroundThread | Whether this is occurring in a background thread |
|
inlineprotectedvirtualinherited |
Internal implementation of the meat of the 'prepare' action.
Reimplemented in Ogre::Mesh, Ogre::D3D9Texture, Ogre::D3D11Texture, Ogre::Material, Ogre::PatchMesh, Ogre::GLTexture, and Ogre::GL3PlusTexture.
Definition at line 205 of file OgreResource.h.
|
inlineprotectedvirtualinherited |
Internal hook to perform actions before the unload process.
Definition at line 196 of file OgreResource.h.
|
protected |
|
virtualinherited |
Reloads the resource, if it is already loaded.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram.
|
virtualinherited |
Remove a listener on this resource.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram.
|
inlinevirtualinherited |
Reset a compile error if it occurred, allowing the load to be retried.
Reimplemented in Ogre::CgProgram, and Ogre::UnifiedHighLevelGpuProgram.
Definition at line 381 of file OgreGpuProgram.h.
|
inlinevirtualinherited |
Sets whether this geometry program requires adjacency information from the input primitives.
Definition at line 322 of file OgreGpuProgram.h.
|
inlinevirtualinherited |
Tells the resource whether it is background loaded or not.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram.
Definition at line 375 of file OgreResource.h.
|
inline |
Sets whether backwards compatibility mode should be enabled.
Definition at line 192 of file OgreD3D9HLSLProgram.h.
|
inline |
Sets whether matrix packing in column-major order.
Definition at line 188 of file OgreD3D9HLSLProgram.h.
|
inline |
Sets the entry point for this program ie the first method called.
Definition at line 176 of file OgreD3D9HLSLProgram.h.
|
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.
|
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.
|
inlinevirtualinherited |
Sets whether a vertex program includes the required instructions to perform morph animation.
Definition at line 278 of file OgreGpuProgram.h.
|
inline |
Sets the optimisation level to use.
opt | Optimisation level |
Definition at line 198 of file OgreD3D9HLSLProgram.h.
|
virtualinherited |
Generic parameter setting method.
name | The name of the parameter to set |
value | String value. Must be in the right format for the type specified in the parameter definition. See the StringConverter class for more information. |
Referenced by Ogre::StringInterface::copyParametersTo().
|
virtualinherited |
Generic multiple parameter setting method.
paramList | Name/value pair list |
|
inlinevirtualinherited |
Sets whether a vertex program includes the required instructions to perform pose animation.
poseCount | The number of simultaneous poses the program can blend |
Definition at line 288 of file OgreGpuProgram.h.
|
inline |
Sets the preprocessor defines use to compile the program.
Definition at line 184 of file OgreD3D9HLSLProgram.h.
|
inlinevirtualinherited |
Sets whether a vertex program includes the required instructions to perform skeletal animation.
Definition at line 261 of file OgreGpuProgram.h.
|
virtualinherited |
Sets the source assembly for this program from an in-memory string.
|
virtualinherited |
Sets the filename of the source assembly for this program.
|
virtualinherited |
Sets the syntax code for this program e.g.
arbvp1, fp20, vs_1_1 etc
void Ogre::D3D9HLSLProgram::setTarget | ( | const String & | target | ) |
Sets the shader target to compile down to, e.g.
'vs_1_1'.
|
virtualinherited |
Set the program type (only valid before load)
Reimplemented in Ogre::GLArbGpuProgram.
|
protectedinherited |
Internal method for setting up the basic parameter definitions for a subclass.
|
inlinevirtualinherited |
Sets whether this vertex program requires support for vertex texture fetch from the hardware.
Definition at line 313 of file OgreGpuProgram.h.
|
virtualinherited |
'Touches' the resource to indicate it has been used.
Reimplemented in Ogre::Material, Ogre::CgProgram, and Ogre::UnifiedHighLevelGpuProgram.
Referenced by Ogre::Material::touch().
|
virtualinherited |
Unloads the resource; this is not permanent, the resource can be reloaded later if required.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram.
|
protectedvirtualinherited |
Internal unload high-level portion if loaded.
|
protectedvirtual |
Internal unload implementation, must be implemented by subclasses.
Implements Ogre::HighLevelGpuProgram.
|
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::GLSLProgram, and Ogre::GLSL::GLSLProgram.
|
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::GLTexture, and Ogre::GL3PlusTexture.
Definition at line 210 of file OgreResource.h.
|
protectedinherited |
The underlying assembler program.
Definition at line 69 of file OgreHighLevelGpuProgram.h.
|
protected |
Definition at line 136 of file OgreD3D9HLSLProgram.h.
|
protected |
Definition at line 135 of file OgreD3D9HLSLProgram.h.
|
protectedinherited |
Did we encounter a compilation error?
Definition at line 153 of file OgreGpuProgram.h.
|
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 173 of file OgreGpuProgram.h.
|
mutableprotectedinherited |
Have we built the name->index parameter map yet?
Definition at line 71 of file OgreHighLevelGpuProgram.h.
|
protectedinherited |
Creator.
Definition at line 144 of file OgreResource.h.
|
protectedinherited |
The default parameters for use with this object.
Definition at line 151 of file OgreGpuProgram.h.
|
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 163 of file OgreGpuProgram.h.
|
protected |
Definition at line 133 of file OgreD3D9HLSLProgram.h.
|
protectedinherited |
The name of the file to load source from (may be blank)
Definition at line 133 of file OgreGpuProgram.h.
|
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 158 of file OgreGpuProgram.h.
|
protectedinherited |
The name of the resource group.
Definition at line 148 of file OgreResource.h.
|
protectedinherited |
Numeric handle for more efficient look up than name.
Definition at line 150 of file OgreResource.h.
|
protectedinherited |
Whether the high-level program (and it's parameter defs) is loaded.
Definition at line 67 of file OgreHighLevelGpuProgram.h.
|
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 168 of file OgreGpuProgram.h.
|
protectedinherited |
Is this resource going to be background loaded? Only applicable for multithreaded.
Definition at line 154 of file OgreResource.h.
|
protectedinherited |
Is this file manually loaded?
Definition at line 158 of file OgreResource.h.
|
protectedinherited |
Definition at line 167 of file OgreResource.h.
|
protectedinherited |
Definition at line 176 of file OgreGpuProgram.h.
|
protectedinherited |
Optional manual loader; if provided, data is loaded from here instead of a file.
Definition at line 162 of file OgreResource.h.
|
protectedinherited |
Whether we need to load source from file or not.
Definition at line 137 of file OgreGpuProgram.h.
|
protectedinherited |
Is the resource currently loaded?
Definition at line 152 of file OgreResource.h.
|
protectedinherited |
File from which to load named constants manually.
Definition at line 175 of file OgreGpuProgram.h.
|
protected |
Definition at line 138 of file OgreD3D9HLSLProgram.h.
|
protectedinherited |
Does this (vertex) program include morph animation?
Definition at line 143 of file OgreGpuProgram.h.
|
protectedinherited |
Unique name of the resource.
Definition at line 146 of file OgreResource.h.
|
protectedinherited |
Does this (geometry) program require adjacency information?
Definition at line 149 of file OgreGpuProgram.h.
|
protected |
Definition at line 163 of file OgreD3D9HLSLProgram.h.
|
protectedinherited |
Origin of this resource (e.g. script name) - optional.
Definition at line 160 of file OgreResource.h.
|
protected |
Definition at line 140 of file OgreD3D9HLSLProgram.h.
|
protected |
Definition at line 141 of file OgreD3D9HLSLProgram.h.
|
protectedinherited |
Does this (vertex) program include pose animation (count of number of poses supported)
Definition at line 145 of file OgreGpuProgram.h.
|
protected |
Definition at line 134 of file OgreD3D9HLSLProgram.h.
|
staticprotectedinherited |
Definition at line 129 of file OgreGpuProgram.h.
|
staticprotected |
Definition at line 114 of file OgreD3D9HLSLProgram.h.
|
staticprotected |
Definition at line 115 of file OgreD3D9HLSLProgram.h.
|
staticprotected |
Definition at line 111 of file OgreD3D9HLSLProgram.h.
|
staticprotected |
Definition at line 108 of file OgreD3D9HLSLProgram.h.
|
staticprotected |
Definition at line 113 of file OgreD3D9HLSLProgram.h.
|
staticprotected |
Definition at line 112 of file OgreD3D9HLSLProgram.h.
|
staticprotected |
Definition at line 110 of file OgreD3D9HLSLProgram.h.
|
staticprotected |
Definition at line 109 of file OgreD3D9HLSLProgram.h.
|
protectedinherited |
The size of the resource in bytes.
Definition at line 156 of file OgreResource.h.
|
protectedinherited |
Does this (vertex) program include skeletal animation?
Definition at line 141 of file OgreGpuProgram.h.
|
staticprotectedinherited |
Definition at line 128 of file OgreGpuProgram.h.
|
staticprotectedinherited |
Definition at line 125 of file OgreGpuProgram.h.
|
protectedinherited |
The assembler source of the program (may be blank until file loaded)
Definition at line 135 of file OgreGpuProgram.h.
|
staticprotectedinherited |
Definition at line 126 of file OgreGpuProgram.h.
|
staticprotectedinherited |
Definition at line 124 of file OgreGpuProgram.h.
|
staticprotectedinherited |
Definition at line 123 of file OgreGpuProgram.h.
|
protectedinherited |
State count, the number of times this resource has changed state.
Definition at line 164 of file OgreResource.h.
|
staticprotectedinherited |
Definition at line 122 of file OgreGpuProgram.h.
|
staticprotectedinherited |
Definition at line 127 of file OgreGpuProgram.h.
|
protectedinherited |
Syntax code e.g. arbvp1, vs_2_0 etc.
Definition at line 139 of file OgreGpuProgram.h.
|
protected |
Definition at line 132 of file OgreD3D9HLSLProgram.h.
|
protectedinherited |
The type of the program.
Definition at line 131 of file OgreGpuProgram.h.
|
protectedinherited |
Does this (vertex) program require support for vertex texture fetch?
Definition at line 147 of file OgreGpuProgram.h.
|
inherited |
Definition at line 82 of file OgreResource.h.