#include <OgreTechnique.h>
Inheritance diagram for Ogre::Technique:
Public Types | |
typedef std::vector< GPUVendorRule > | GPUVendorRuleList |
typedef std::vector< GPUDeviceNameRule > | GPUDeviceNameRuleList |
typedef VectorIterator< Passes > | PassIterator |
typedef VectorIterator< IlluminationPassList > | IlluminationPassIterator |
typedef ConstVectorIterator< GPUVendorRuleList > | GPUVendorRuleIterator |
typedef ConstVectorIterator< GPUDeviceNameRuleList > | GPUDeviceNameRuleIterator |
enum | IncludeOrExclude { INCLUDE = 0, EXCLUDE = 1 } |
Directive used to manually control technique support based on the inclusion or exclusion of some factor. More... | |
Public Member Functions | |
Technique (Material *parent) | |
Constructor. | |
Technique (Material *parent, const Technique &oth) | |
Copy constructor. | |
~Technique () | |
bool | isSupported (void) const |
Indicates if this technique is supported by the current graphics card. | |
String | _compile (bool autoManageTextureUnits) |
Internal compilation method; see Material::compile. | |
bool | checkGPURules (StringUtil::StrStreamType &errors) |
Internal method for checking GPU vendor / device rules. | |
bool | checkHardwareSupport (bool autoManageTextureUnits, StringUtil::StrStreamType &compileErrors) |
Internal method for checking hardware support. | |
void | _compileIlluminationPasses (void) |
Internal method for splitting the passes into illumination passes. | |
Pass * | createPass (void) |
Creates a new Pass for this Technique. | |
Pass * | getPass (unsigned short index) |
Retrieves the Pass with the given index. | |
Pass * | getPass (const String &name) |
Retrieves the Pass matching name. | |
unsigned short | getNumPasses (void) const |
Retrieves the number of passes. | |
void | removePass (unsigned short index) |
Removes the Pass with the given index. | |
void | removeAllPasses (void) |
Removes all Passes from this Technique. | |
bool | movePass (const unsigned short sourceIndex, const unsigned short destinationIndex) |
Move a pass from source index to destination index. | |
const PassIterator | getPassIterator (void) |
Gets an iterator over the passes in this Technique. | |
const IlluminationPassIterator | getIlluminationPassIterator (void) |
Gets an iterator over the illumination-stage categorised passes. | |
Material * | getParent (void) const |
Gets the parent Material. | |
Technique & | operator= (const Technique &rhs) |
Overloaded operator to copy on Technique to another. | |
const String & | getResourceGroup (void) const |
Gets the resource group of the ultimate parent Material. | |
bool | isTransparent (void) const |
Returns true if this Technique involves transparency. | |
bool | isTransparentSortingEnabled (void) const |
Returns true if this Technique has transparent sorting enabled. | |
void | _prepare (void) |
Internal prepare method, derived from call to Material::prepare. | |
void | _unprepare (void) |
Internal unprepare method, derived from call to Material::unprepare. | |
void | _load (void) |
Internal load method, derived from call to Material::load. | |
void | _unload (void) |
Internal unload method, derived from call to Material::unload. | |
bool | isLoaded (void) const |
void | _notifyNeedsRecompile (void) |
Tells the technique that it needs recompilation. | |
Ogre::MaterialPtr | getShadowCasterMaterial () const |
return this material specific shadow casting specific material | |
void | setShadowCasterMaterial (Ogre::MaterialPtr val) |
set this material specific shadow casting specific material | |
void | setShadowCasterMaterial (const Ogre::String &name) |
set this material specific shadow casting specific material | |
Ogre::MaterialPtr | getShadowReceiverMaterial () const |
return this material specific shadow receiving specific material | |
void | setShadowReceiverMaterial (Ogre::MaterialPtr val) |
set this material specific shadow receiving specific material | |
void | setShadowReceiverMaterial (const Ogre::String &name) |
set this material specific shadow receiving specific material | |
void | setPointSize (Real ps) |
Sets the point size properties for every Pass in this Technique. | |
void | setAmbient (Real red, Real green, Real blue) |
Sets the ambient colour reflectance properties for every Pass in every Technique. | |
void | setAmbient (const ColourValue &ambient) |
Sets the ambient colour reflectance properties for every Pass in every Technique. | |
void | setDiffuse (Real red, Real green, Real blue, Real alpha) |
Sets the diffuse colour reflectance properties of every Pass in every Technique. | |
void | setDiffuse (const ColourValue &diffuse) |
Sets the diffuse colour reflectance properties of every Pass in every Technique. | |
void | setSpecular (Real red, Real green, Real blue, Real alpha) |
Sets the specular colour reflectance properties of every Pass in every Technique. | |
void | setSpecular (const ColourValue &specular) |
Sets the specular colour reflectance properties of every Pass in every Technique. | |
void | setShininess (Real val) |
Sets the shininess properties of every Pass in every Technique. | |
void | setSelfIllumination (Real red, Real green, Real blue) |
Sets the amount of self-illumination of every Pass in every Technique. | |
void | setSelfIllumination (const ColourValue &selfIllum) |
Sets the amount of self-illumination of every Pass in every Technique. | |
void | setDepthCheckEnabled (bool enabled) |
Sets whether or not each Pass renders with depth-buffer checking on or not. | |
void | setDepthWriteEnabled (bool enabled) |
Sets whether or not each Pass renders with depth-buffer writing on or not. | |
void | setDepthFunction (CompareFunction func) |
Sets the function used to compare depth values when depth checking is on. | |
void | setColourWriteEnabled (bool enabled) |
Sets whether or not colour buffer writing is enabled for each Pass. | |
void | setCullingMode (CullingMode mode) |
Sets the culling mode for each pass based on the 'vertex winding'. | |
void | setManualCullingMode (ManualCullingMode mode) |
Sets the manual culling mode, performed by CPU rather than hardware. | |
void | setLightingEnabled (bool enabled) |
Sets whether or not dynamic lighting is enabled for every Pass. | |
void | setShadingMode (ShadeOptions mode) |
Sets the type of light shading required. | |
void | setFog (bool overrideScene, FogMode mode=FOG_NONE, const ColourValue &colour=ColourValue::White, Real expDensity=0.001, Real linearStart=0.0, Real linearEnd=1.0) |
Sets the fogging mode applied to each pass. | |
void | setDepthBias (float constantBias, float slopeScaleBias) |
Sets the depth bias to be used for each Pass. | |
void | setTextureFiltering (TextureFilterOptions filterType) |
Set texture filtering for every texture unit in every Pass. | |
void | setTextureAnisotropy (unsigned int maxAniso) |
Sets the anisotropy level to be used for all textures. | |
void | setSceneBlending (const SceneBlendType sbt) |
Sets the kind of blending every pass has with the existing contents of the scene. | |
void | setSeparateSceneBlending (const SceneBlendType sbt, const SceneBlendType sbta) |
Sets the kind of blending every pass has with the existing contents of the scene, using individual factors both color and alpha channels. | |
void | setSceneBlending (const SceneBlendFactor sourceFactor, const SceneBlendFactor destFactor) |
Allows very fine control of blending every Pass with the existing contents of the scene. | |
void | setSeparateSceneBlending (const SceneBlendFactor sourceFactor, const SceneBlendFactor destFactor, const SceneBlendFactor sourceFactorAlpha, const SceneBlendFactor destFactorAlpha) |
Allows very fine control of blending every Pass with the existing contents of the scene, using individual factors both color and alpha channels. | |
void | setLodIndex (unsigned short index) |
Assigns a level-of-detail (LOD) index to this Technique. | |
unsigned short | getLodIndex (void) const |
Gets the level-of-detail index assigned to this Technique. | |
void | setSchemeName (const String &schemeName) |
Set the 'scheme name' for this technique. | |
const String & | getSchemeName (void) const |
Returns the scheme to which this technique is assigned. | |
unsigned short | _getSchemeIndex (void) const |
Internal method for getting the scheme index. | |
bool | isDepthWriteEnabled (void) const |
Is depth writing going to occur on this technique? | |
bool | isDepthCheckEnabled (void) const |
Is depth checking going to occur on this technique? | |
bool | hasColourWriteDisabled (void) const |
Exists colour writing disabled pass on this technique? | |
void | setName (const String &name) |
Set the name of the technique. | |
const String & | getName (void) const |
Gets the name of the technique. | |
bool | applyTextureAliases (const AliasTextureNamePairList &aliasList, const bool apply=true) const |
Applies texture names to Texture Unit State with matching texture name aliases. | |
void | addGPUVendorRule (GPUVendor vendor, IncludeOrExclude includeOrExclude) |
Add a rule which manually influences the support for this technique based on a GPU vendor. | |
void | addGPUVendorRule (const GPUVendorRule &rule) |
Add a rule which manually influences the support for this technique based on a GPU vendor. | |
void | removeGPUVendorRule (GPUVendor vendor) |
Removes a matching vendor rule. | |
GPUVendorRuleIterator | getGPUVendorRuleIterator () const |
Get an iterator over the currently registered vendor rules. | |
void | addGPUDeviceNameRule (const String &devicePattern, IncludeOrExclude includeOrExclude, bool caseSensitive=false) |
Add a rule which manually influences the support for this technique based on a pattern that matches a GPU device name (e.g. | |
void | addGPUDeviceNameRule (const GPUDeviceNameRule &rule) |
Add a rule which manually influences the support for this technique based on a pattern that matches a GPU device name (e.g. | |
void | removeGPUDeviceNameRule (const String &devicePattern) |
Removes a matching device name rule. | |
GPUDeviceNameRuleIterator | getGPUDeviceNameRuleIterator () const |
Get an iterator over the currently registered device name rules. | |
void * | operator new (size_t sz, const char *file, int line, const char *func) |
operator new, with debug line info | |
void * | operator new (size_t sz) |
void * | operator new (size_t sz, void *ptr) |
placement operator new | |
void * | operator new[] (size_t sz, const char *file, int line, const char *func) |
array operator new, with debug line info | |
void * | operator new[] (size_t sz) |
void | operator delete (void *ptr) |
void | operator delete (void *ptr, 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 *) |
Protected Types | |
typedef std::vector< Pass * > | Passes |
enum | IlluminationPassesState { IPS_COMPILE_DISABLED = -1, IPS_NOT_COMPILED = 0, IPS_COMPILED = 1 } |
Protected Member Functions | |
void | clearIlluminationPasses (void) |
Internal method for clearing illumination pass list. | |
bool | checkManuallyOrganisedIlluminationPasses () |
Internal method - check for manually assigned illumination passes. | |
Protected Attributes | |
Passes | mPasses |
List of primary passes. | |
IlluminationPassList | mIlluminationPasses |
List of derived passes, categorised into IlluminationStage (ordered). | |
Material * | mParent |
bool | mIsSupported |
IlluminationPassesState | mIlluminationPassesCompilationPhase |
unsigned short | mLodIndex |
LOD level. | |
unsigned short | mSchemeIndex |
Scheme index, derived from scheme name but the names are held on MaterialManager, for speed an index is used here. | |
String | mName |
MaterialPtr | mShadowCasterMaterial |
When casting shadow, if not using default Ogre shadow casting material, or nor using fixed function casting, mShadowCasterMaterial let you customize per material shadow caster behavior. | |
String | mShadowCasterMaterialName |
When casting shadow, if not using default Ogre shadow casting material, or nor using fixed function casting, mShadowCasterMaterial let you customize per material shadow caster behavior.There only material name is stored so that it can be loaded once all file parsed in a resource group. | |
MaterialPtr | mShadowReceiverMaterial |
When receiving shadow, if not using default Ogre shadow receiving material, or nor using fixed function texture projection receiving, mShadowReceiverMaterial let you customize per material shadow caster behavior. | |
String | mShadowReceiverMaterialName |
When receiving shadow, if not using default Ogre shadow receiving material, or nor using fixed function texture projection receiving, mShadowReceiverMaterial let you customize per material shadow caster behavior. | |
GPUVendorRuleList | mGPUVendorRules |
GPUDeviceNameRuleList | mGPUDeviceNameRules |
Classes | |
struct | GPUDeviceNameRule |
Rule controlling whether technique is deemed supported based on GPU device name. More... | |
struct | GPUVendorRule |
Rule controlling whether technique is deemed supported based on GPU vendor. More... |
Definition at line 47 of file OgreTechnique.h.
|
Definition at line 676 of file OgreTechnique.h. |
|
Definition at line 134 of file OgreTechnique.h. |
|
Definition at line 635 of file OgreTechnique.h. |
|
Definition at line 133 of file OgreTechnique.h. |
|
Definition at line 192 of file OgreTechnique.h. |
|
Definition at line 58 of file OgreTechnique.h. |
|
Definition at line 189 of file OgreTechnique.h. |
|
Definition at line 51 of file OgreTechnique.h. |
|
Directive used to manually control technique support based on the inclusion or exclusion of some factor.
Definition at line 105 of file OgreTechnique.h. |
|
Constructor.
|
|
Copy constructor.
|
|
|
|
Internal compilation method; see Material::compile.
|
|
Internal method for splitting the passes into illumination passes.
|
|
Internal method for getting the scheme index.
|
|
Internal load method, derived from call to Material::load.
|
|
Tells the technique that it needs recompilation.
|
|
Internal prepare method, derived from call to Material::prepare.
|
|
Internal unload method, derived from call to Material::unload.
|
|
Internal unprepare method, derived from call to Material::unprepare.
|
|
Add a rule which manually influences the support for this technique based on a pattern that matches a GPU device name (e.g. '*8800*').
|
|
Add a rule which manually influences the support for this technique based on a pattern that matches a GPU device name (e.g. '*8800*').
|
|
Add a rule which manually influences the support for this technique based on a GPU vendor.
|
|
Add a rule which manually influences the support for this technique based on a GPU vendor.
|
|
Applies texture names to Texture Unit State with matching texture name aliases. All passes, and Texture Unit States within the technique are checked. If matching texture aliases are found then true is returned.
|
|
Internal method for checking GPU vendor / device rules.
|
|
Internal method for checking hardware support.
|
|
Internal method - check for manually assigned illumination passes.
|
|
Internal method for clearing illumination pass list.
|
|
Creates a new Pass for this Technique.
|
|
Get an iterator over the currently registered device name rules.
|
|
Get an iterator over the currently registered vendor rules.
|
|
Gets an iterator over the illumination-stage categorised passes.
|
|
Gets the level-of-detail index assigned to this Technique.
Definition at line 541 of file OgreTechnique.h. |
|
Gets the name of the technique.
Definition at line 585 of file OgreTechnique.h. |
|
Retrieves the number of passes.
|
|
Gets the parent Material.
Definition at line 196 of file OgreTechnique.h. |
|
Retrieves the Pass matching name. Returns 0 if name match is not found. |
|
Retrieves the Pass with the given index.
|
|
Gets an iterator over the passes in this Technique.
|
|
Gets the resource group of the ultimate parent Material.
|
|
Returns the scheme to which this technique is assigned.
|
|
return this material specific shadow casting specific material
|
|
return this material specific shadow receiving specific material
|
|
Exists colour writing disabled pass on this technique?
|
|
Is depth checking going to occur on this technique?
|
|
Is depth writing going to occur on this technique?
|
|
|
|
Indicates if this technique is supported by the current graphics card.
|
|
Returns true if this Technique involves transparency.
|
|
Returns true if this Technique has transparent sorting enabled.
|
|
Move a pass from source index to destination index. If successful then returns true. |
|
Definition at line 101 of file OgreMemoryAllocatedObject.h. |
|
Definition at line 95 of file OgreMemoryAllocatedObject.h. |
|
Definition at line 89 of file OgreMemoryAllocatedObject.h. |
|
Definition at line 112 of file OgreMemoryAllocatedObject.h. |
|
Definition at line 106 of file OgreMemoryAllocatedObject.h. |
|
placement operator new
Definition at line 73 of file OgreMemoryAllocatedObject.h. |
|
Definition at line 67 of file OgreMemoryAllocatedObject.h. |
|
operator new, with debug line info
Definition at line 62 of file OgreMemoryAllocatedObject.h. |
|
Definition at line 84 of file OgreMemoryAllocatedObject.h. |
|
array operator new, with debug line info
Definition at line 79 of file OgreMemoryAllocatedObject.h. |
|
Overloaded operator to copy on Technique to another.
|
|
Removes all Passes from this Technique.
|
|
Removes a matching device name rule.
|
|
Removes a matching vendor rule.
|
|
Removes the Pass with the given index.
|
|
Sets the ambient colour reflectance properties for every Pass in every Technique.
|
|
Sets the ambient colour reflectance properties for every Pass in every Technique.
|
|
Sets whether or not colour buffer writing is enabled for each Pass.
|
|
Sets the culling mode for each pass based on the 'vertex winding'.
|
|
Sets the depth bias to be used for each Pass.
|
|
Sets whether or not each Pass renders with depth-buffer checking on or not.
|
|
Sets the function used to compare depth values when depth checking is on.
|
|
Sets whether or not each Pass renders with depth-buffer writing on or not.
|
|
Sets the diffuse colour reflectance properties of every Pass in every Technique.
|
|
Sets the diffuse colour reflectance properties of every Pass in every Technique.
|
|
Sets the fogging mode applied to each pass.
|
|
Sets whether or not dynamic lighting is enabled for every Pass.
|
|
Assigns a level-of-detail (LOD) index to this Technique.
|
|
Sets the manual culling mode, performed by CPU rather than hardware.
|
|
Set the name of the technique.
|
|
Sets the point size properties for every Pass in this Technique.
|
|
Allows very fine control of blending every Pass with the existing contents of the scene.
|
|
Sets the kind of blending every pass has with the existing contents of the scene.
|
|
Set the 'scheme name' for this technique.
|
|
Sets the amount of self-illumination of every Pass in every Technique.
|
|
Sets the amount of self-illumination of every Pass in every Technique.
|
|
Allows very fine control of blending every Pass with the existing contents of the scene, using individual factors both color and alpha channels.
|
|
Sets the kind of blending every pass has with the existing contents of the scene, using individual factors both color and alpha channels.
|
|
Sets the type of light shading required.
|
|
set this material specific shadow casting specific material
|
|
set this material specific shadow casting specific material
|
|
set this material specific shadow receiving specific material
|
|
set this material specific shadow receiving specific material
|
|
Sets the shininess properties of every Pass in every Technique.
|
|
Sets the specular colour reflectance properties of every Pass in every Technique.
|
|
Sets the specular colour reflectance properties of every Pass in every Technique.
|
|
Sets the anisotropy level to be used for all textures.
|
|
Set texture filtering for every texture unit in every Pass.
|
|
Definition at line 137 of file OgreTechnique.h. |
|
Definition at line 136 of file OgreTechnique.h. |
|
List of derived passes, categorised into IlluminationStage (ordered).
Definition at line 62 of file OgreTechnique.h. |
|
Definition at line 65 of file OgreTechnique.h. |
|
Definition at line 64 of file OgreTechnique.h. |
|
LOD level.
Definition at line 67 of file OgreTechnique.h. |
|
Definition at line 72 of file OgreTechnique.h. |
|
Definition at line 63 of file OgreTechnique.h. |
|
List of primary passes.
Definition at line 60 of file OgreTechnique.h. |
|
Scheme index, derived from scheme name but the names are held on MaterialManager, for speed an index is used here.
Definition at line 71 of file OgreTechnique.h. |
|
When casting shadow, if not using default Ogre shadow casting material, or nor using fixed function casting, mShadowCasterMaterial let you customize per material shadow caster behavior.
Definition at line 84 of file OgreTechnique.h. |
|
When casting shadow, if not using default Ogre shadow casting material, or nor using fixed function casting, mShadowCasterMaterial let you customize per material shadow caster behavior.There only material name is stored so that it can be loaded once all file parsed in a resource group.
Definition at line 89 of file OgreTechnique.h. |
|
When receiving shadow, if not using default Ogre shadow receiving material, or nor using fixed function texture projection receiving, mShadowReceiverMaterial let you customize per material shadow caster behavior.
Definition at line 94 of file OgreTechnique.h. |
|
When receiving shadow, if not using default Ogre shadow receiving material, or nor using fixed function texture projection receiving, mShadowReceiverMaterial let you customize per material shadow caster behavior. There only material name is stored so that it can be loaded once all file parsed in a resource group. Definition at line 99 of file OgreTechnique.h. |
Copyright © 2008 Torus Knot Software Ltd
This work is licensed under a Creative Commons Attribution-ShareAlike 2.5 License.
Last modified Sat Apr 11 13:55:40 2009