#include <OgreD3D9HLSLProgram.h>
Inheritance diagram for Ogre::D3D9HLSLProgram:
Public Member Functions | |
D3D9HLSLProgram (ResourceManager *creator, const String &name, ResourceHandle handle, const String &group, bool isManual, ManualResourceLoader *loader) | |
~D3D9HLSLProgram () | |
void | setEntryPoint (const String &entryPoint) |
Sets the entry point for this program ie the first method called. | |
const String & | getEntryPoint (void) const |
Gets the entry point defined for this program. | |
void | setTarget (const String &target) |
Sets the shader target to compile down to, e.g. | |
const String & | getTarget (void) const |
Gets the shader target to compile down to, e.g. | |
bool | isSupported (void) const |
Overridden from GpuProgram. | |
GpuProgramParametersSharedPtr | createParameters (void) |
Overridden from GpuProgram. | |
GpuProgram * | _getBindingDelegate (void) |
| |
virtual void | setSourceFile (const String &filename) |
Sets the filename of the source assembly for this program. | |
virtual void | setSource (const String &source) |
Sets the source assembly for this program from an in-memory string. | |
virtual const String & | getSyntaxCode (void) const |
Gets the syntax code for this program e.g. | |
virtual void | setSyntaxCode (const String &syntax) |
Sets the syntax code for this program e.g. | |
virtual const String & | getSourceFile (void) const |
Gets the name of the file used as source for this program. | |
virtual const String & | getSource (void) const |
Gets the assembler source for this program. | |
virtual void | setType (GpuProgramType t) |
Set the program type (only valid before load). | |
virtual GpuProgramType | getType (void) const |
Get the program type. | |
virtual void | setSkeletalAnimationIncluded (bool included) |
Sets whether a vertex program includes the required instructions to perform skeletal animation. | |
virtual bool | isSkeletalAnimationIncluded (void) const |
Returns whether a vertex program includes the required instructions to perform skeletal animation. | |
virtual GpuProgramParametersSharedPtr | getDefaultParameters (void) |
Get a reference to the default parameters which are to be used for all uses of this program. | |
virtual void | setSurfaceAndPassLightStates (bool state) |
Sets whether a vertex program requires light and material states to be passed to through fixed pipeline low level API rendering calls. | |
virtual bool | getPassSurfaceAndLightStates (void) const |
Returns whether a vertex program wants light and material states to be passed through fixed pipeline low level API rendering calls. | |
virtual void | load (void) |
Loads the resource, if it is not already. | |
virtual void | reload (void) |
Reloads the resource, if it is already loaded. | |
bool | isReloadable (void) const |
Returns true if the Resource is reloadable, false otherwise. | |
bool | isManuallyLoaded (void) const |
Is this resource manually loaded? | |
virtual void | unload (void) |
Unloads the resource; this is not permanent, the resource can be reloaded later if required. | |
size_t | getSize (void) const |
Retrieves info about the size of the resource. | |
virtual void | touch (void) |
'Touches' the resource to indicate it has been used. | |
const String & | getName (void) const |
Gets resource name. | |
ResourceHandle | getHandle (void) const |
bool | isLoaded (void) const |
Returns true if the Resource has been loaded, false otherwise. | |
const String & | getGroup (void) |
Gets the group which this resource is a member of. | |
ResourceManager * | getCreator (void) |
Gets the manager which created this resource. | |
const String & | getOrigin (void) const |
Get the origin of this resource, e.g. | |
void | _notifyOrigin (const String &origin) |
Notify this resource of it's origin. | |
ParamDictionary * | getParamDictionary (void) |
Retrieves the parameter dictionary for this class. | |
const ParamDictionary * | getParamDictionary (void) const |
const ParameterList & | getParameters (void) const |
Retrieves a list of parameters valid for this object. | |
virtual bool | setParameter (const String &name, const String &value) |
Generic parameter setting method. | |
virtual void | setParameterList (const NameValuePairList ¶mList) |
Generic multiple parameter setting method. | |
virtual String | getParameter (const String &name) const |
Generic parameter retrieval method. | |
virtual void | copyParametersTo (StringInterface *dest) const |
Method for copying this object's parameters to another object. | |
Static Public Member Functions | |
void | cleanupDictionary () |
Cleans up the static 'msDictionary' required to reset Ogre, otherwise the containers are left with invalid pointers, which will lead to a crash as soon as one of the ResourceManager implementers (e.g. | |
Protected Member Functions | |
void | loadFromSource (void) |
Internal load implementation, must be implemented by subclasses. | |
void | createLowLevelImpl (void) |
Internal method for creating an appropriate low-level program from this high-level program, must be implemented by subclasses. | |
void | unloadHighLevelImpl (void) |
Internal unload implementation, must be implemented by subclasses. | |
void | populateParameterNames (GpuProgramParametersSharedPtr params) |
Populate the passed parameters with name->index map, must be overridden. | |
void | processParamElement (D3DXHANDLE parent, String prefix, unsigned int index, GpuProgramParametersSharedPtr params) |
virtual void | loadHighLevel (void) |
Internal load high-level portion if not loaded. | |
virtual void | unloadHighLevel (void) |
Internal unload high-level portion if loaded. | |
virtual void | loadHighLevelImpl (void) |
Internal load implementation, loads just the high-level portion, enough to get parameters. | |
void | loadImpl () |
| |
void | unloadImpl () |
| |
void | setupBaseParamDictionary (void) |
Internal method for setting up the basic parameter definitions for a subclass. | |
size_t | calculateSize (void) const |
| |
bool | createParamDictionary (const String &className) |
Internal method for creating a parameter dictionary for the class, if it does not already exist. | |
Protected Attributes | |
String | mTarget |
String | mEntryPoint |
LPD3DXBUFFER | mpMicroCode |
LPD3DXCONSTANTTABLE | mpConstTable |
bool | mHighLevelLoaded |
Whether the high-level program (and it's parameter defs) is loaded. | |
GpuProgramPtr | mAssemblerProgram |
The underlying assembler program. | |
GpuProgramType | mType |
The type of the program. | |
String | mFilename |
The name of the file to load source from (may be blank). | |
String | mSource |
The assembler source of the program (may be blank until file loaded). | |
bool | mLoadFromFile |
Whether we need to load source from file or not. | |
String | mSyntaxCode |
Syntax code eg arbvp1, vs_2_0 etc. | |
bool | mSkeletalAnimation |
Does this (vertex) program include skeletal animation? | |
GpuProgramParametersSharedPtr | mDefaultParams |
The default parameters for use with this object. | |
bool | mPassSurfaceAndLightStates |
Does this program want light states passed through fixed pipeline. | |
ResourceManager * | mCreator |
Creator. | |
String | mName |
Unique name of the resource. | |
String | mGroup |
The name of the resource group. | |
ResourceHandle | mHandle |
Numeric handle for more efficient look up than name. | |
bool | mIsLoaded |
Is the resource currently loaded? | |
size_t | mSize |
The size of the resource in bytes. | |
bool | mIsManual |
Is this file manually loaded? | |
String | mOrigin |
Origin of this resource (e.g. script name) - optional. | |
ManualResourceLoader * | mLoader |
Optional manual loader; if provided, data is loaded from here instead of a file. | |
String | mParamDictName |
Class name for this instance to be used as a lookup (must be initialised by subclasses). | |
Static Protected Attributes | |
CmdEntryPoint | msCmdEntryPoint |
CmdTarget | msCmdTarget |
CmdType | msTypeCmd |
CmdSyntax | msSyntaxCmd |
CmdSkeletal | msSkeletalCmd |
ParamDictionaryMap | msDictionary |
Dictionary of parameters. |
Definition at line 40 of file OgreD3D9HLSLProgram.h.
|
|
|
|
|
Reimplemented from Ogre::GpuProgram. Definition at line 97 of file OgreHighLevelGpuProgram.h. |
|
Notify this resource of it's origin.
Definition at line 214 of file OgreResource.h. References Ogre::String. |
|
Implements Ogre::Resource. Definition at line 764 of file OgreGpuProgram.h. |
|
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. |
|
Method for copying this object's parameters to another object.
Definition at line 296 of file OgreStringInterface.h. References Ogre::ParamDictionary::mParamDefs, and Ogre::StringInterface::setParameter(). |
|
Internal method for creating an appropriate low-level program from this high-level program, must be implemented by subclasses.
Implements Ogre::HighLevelGpuProgram. |
|
Internal method for creating a parameter dictionary for the class, if it does not already exist.
Definition at line 172 of file OgreStringInterface.h. References Ogre::String. |
|
Overridden from GpuProgram.
Reimplemented from Ogre::HighLevelGpuProgram. |
|
Gets the manager which created this resource.
Definition at line 205 of file OgreResource.h. |
|
Get a reference to the default parameters which are to be used for all uses of this program.
|
|
Gets the entry point defined for this program.
Definition at line 91 of file OgreD3D9HLSLProgram.h. References Ogre::String. |
|
Gets the group which this resource is a member of.
Definition at line 202 of file OgreResource.h. References Ogre::String. |
|
Definition at line 188 of file OgreResource.h. References Ogre::ResourceHandle. |
|
Gets resource name.
Definition at line 183 of file OgreResource.h. References Ogre::String. |
|
Get the origin of this resource, e.g. a script file name.
Definition at line 212 of file OgreResource.h. References Ogre::String. |
|
Definition at line 209 of file OgreStringInterface.h. |
|
Retrieves the parameter dictionary for this class.
Definition at line 196 of file OgreStringInterface.h. |
|
Generic parameter retrieval method.
Definition at line 265 of file OgreStringInterface.h. References Ogre::ParamCommand::doGet(), Ogre::ParamDictionary::getParamCommand(), and Ogre::String. |
|
Retrieves a list of parameters valid for this object.
|
|
Returns whether a vertex program wants light and material states to be passed through fixed pipeline low level API rendering calls.
Definition at line 863 of file OgreGpuProgram.h. |
|
Retrieves info about the size of the resource.
Definition at line 172 of file OgreResource.h. |
|
Gets the assembler source for this program.
Definition at line 796 of file OgreGpuProgram.h. References Ogre::String. |
|
Gets the name of the file used as source for this program.
Definition at line 794 of file OgreGpuProgram.h. |
|
Gets the syntax code for this program e.g. arbvp1, fp20, vs_1_1 etc Definition at line 788 of file OgreGpuProgram.h. References Ogre::String. |
|
Gets the shader target to compile down to, e.g. 'vs_1_1'. Definition at line 95 of file OgreD3D9HLSLProgram.h. References Ogre::String. |
|
Get the program type.
Definition at line 800 of file OgreGpuProgram.h. References Ogre::GpuProgramType. |
|
Returns true if the Resource has been loaded, false otherwise.
Definition at line 195 of file OgreResource.h. References OGRE_LOCK_AUTO_MUTEX. |
|
Is this resource manually loaded?
Definition at line 160 of file OgreResource.h. |
|
Returns true if the Resource is reloadable, false otherwise.
Definition at line 153 of file OgreResource.h. |
|
Returns whether a vertex program includes the required instructions to perform skeletal animation.
Definition at line 835 of file OgreGpuProgram.h. |
|
Overridden from GpuProgram.
Reimplemented from Ogre::GpuProgram. |
|
Loads the resource, if it is not already.
Reimplemented in Ogre::Mesh, and Ogre::GLSLGpuProgram. |
|
Internal load implementation, must be implemented by subclasses.
Implements Ogre::GpuProgram. |
|
Internal load high-level portion if not loaded.
|
|
Internal load implementation, loads just the high-level portion, enough to get parameters.
|
|
Reimplemented from Ogre::GpuProgram. |
|
Populate the passed parameters with name->index map, must be overridden.
Implements Ogre::HighLevelGpuProgram. |
|
|
|
Reloads the resource, if it is already loaded.
|
|
Sets the entry point for this program ie the first method called.
Definition at line 89 of file OgreD3D9HLSLProgram.h. References Ogre::String. |
|
Generic parameter setting method.
Referenced by Ogre::StringInterface::copyParametersTo(). |
|
Generic multiple parameter setting method.
|
|
Sets whether a vertex program includes the required instructions to perform skeletal animation.
Definition at line 826 of file OgreGpuProgram.h. |
|
Sets the source assembly for this program from an in-memory string.
|
|
Sets the filename of the source assembly for this program.
|
|
Sets whether a vertex program requires light and material states to be passed to through fixed pipeline low level API rendering calls.
Definition at line 857 of file OgreGpuProgram.h. |
|
Sets the syntax code for this program e.g. arbvp1, fp20, vs_1_1 etc |
|
Sets the shader target to compile down to, e.g. 'vs_1_1'. |
|
Set the program type (only valid before load).
Reimplemented in Ogre::GLArbGpuProgram. |
|
Internal method for setting up the basic parameter definitions for a subclass.
|
|
'Touches' the resource to indicate it has been used.
Reimplemented in Ogre::Material. |
|
Unloads the resource; this is not permanent, the resource can be reloaded later if required.
Reimplemented in Ogre::GLSLGpuProgram. |
|
Internal unload high-level portion if loaded.
|
|
Internal unload implementation, must be implemented by subclasses.
Implements Ogre::HighLevelGpuProgram. |
|
Implements Ogre::Resource. |
|
The underlying assembler program.
Definition at line 60 of file OgreHighLevelGpuProgram.h. |
|
Creator.
Definition at line 73 of file OgreResource.h. |
|
The default parameters for use with this object.
Definition at line 749 of file OgreGpuProgram.h. |
|
Definition at line 78 of file OgreD3D9HLSLProgram.h. |
|
The name of the file to load source from (may be blank).
Definition at line 739 of file OgreGpuProgram.h. |
|
The name of the resource group.
Definition at line 77 of file OgreResource.h. |
|
Numeric handle for more efficient look up than name.
Definition at line 79 of file OgreResource.h. |
|
Whether the high-level program (and it's parameter defs) is loaded.
Definition at line 58 of file OgreHighLevelGpuProgram.h. |
|
Is the resource currently loaded?
Definition at line 81 of file OgreResource.h. |
|
Is this file manually loaded?
Definition at line 85 of file OgreResource.h. |
|
Optional manual loader; if provided, data is loaded from here instead of a file.
Definition at line 89 of file OgreResource.h. |
|
Whether we need to load source from file or not.
Definition at line 743 of file OgreGpuProgram.h. |
|
Unique name of the resource.
Definition at line 75 of file OgreResource.h. |
|
Origin of this resource (e.g. script name) - optional.
Definition at line 87 of file OgreResource.h. |
|
Class name for this instance to be used as a lookup (must be initialised by subclasses).
Definition at line 160 of file OgreStringInterface.h. |
|
Does this program want light states passed through fixed pipeline.
Definition at line 751 of file OgreGpuProgram.h. |
|
Definition at line 81 of file OgreD3D9HLSLProgram.h. |
|
Definition at line 80 of file OgreD3D9HLSLProgram.h. |
|
Definition at line 60 of file OgreD3D9HLSLProgram.h. |
|
Definition at line 61 of file OgreD3D9HLSLProgram.h. |
|
Dictionary of parameters.
Definition at line 157 of file OgreStringInterface.h. |
|
The size of the resource in bytes.
Definition at line 83 of file OgreResource.h. |
|
Does this (vertex) program include skeletal animation?
Definition at line 747 of file OgreGpuProgram.h. |
|
The assembler source of the program (may be blank until file loaded).
Definition at line 741 of file OgreGpuProgram.h. |
|
Definition at line 734 of file OgreGpuProgram.h. |
|
Definition at line 733 of file OgreGpuProgram.h. |
|
Definition at line 732 of file OgreGpuProgram.h. |
|
Syntax code eg arbvp1, vs_2_0 etc.
Definition at line 745 of file OgreGpuProgram.h. |
|
Definition at line 77 of file OgreD3D9HLSLProgram.h. |
|
The type of the program.
Definition at line 737 of file OgreGpuProgram.h. |
Copyright © 2000-2005 by The OGRE Team
This work is licensed under a Creative Commons Attribution-ShareAlike 2.5 License.
Last modified Sun Feb 12 13:08:54 2006