#include <OgrePass.h>
Collaboration diagram for Ogre::Pass:
Public Types | |
typedef VectorIterator< TextureUnitStates > | TextureUnitStateIterator |
Public Methods | |
Pass (Technique *parent, unsigned short index) | |
Default constructor. | |
Pass (Technique *parent, unsigned short index, const Pass &oth) | |
Copy constructor. | |
Pass & | operator= (const Pass &oth) |
Operator = overload. | |
~Pass () | |
bool | isProgrammable (void) const |
Returns true if this pass is programmable ie includes either a vertex or fragment program. | |
bool | hasVertexProgram (void) |
Returns true if this pass uses a programmable vertex pipeline. | |
bool | hasFragmentProgram (void) |
Returns true if this pass uses a programmable fragment pipeline. | |
unsigned short | getIndex (void) const |
Gets the index of this Pass in the parent Technique. | |
void | setAmbient (Real red, Real green, Real blue) |
Sets the ambient colour reflectance properties of this pass. | |
void | setAmbient (const ColourValue &ambient) |
Sets the ambient colour reflectance properties of this pass. | |
void | setDiffuse (Real red, Real green, Real blue) |
Sets the diffuse colour reflectance properties of this pass. | |
void | setDiffuse (const ColourValue &diffuse) |
Sets the diffuse colour reflectance properties of this pass. | |
void | setSpecular (Real red, Real green, Real blue) |
Sets the specular colour reflectance properties of this pass. | |
void | setSpecular (const ColourValue &specular) |
Sets the specular colour reflectance properties of this pass. | |
void | setShininess (Real val) |
Sets the shininess of the pass, affecting the size of specular highlights. | |
void | setSelfIllumination (Real red, Real green, Real blue) |
Sets the amount of self-illumination an object has. | |
void | setSelfIllumination (const ColourValue &selfIllum) |
Sets the amount of self-illumination an object has. | |
const ColourValue & | getAmbient (void) const |
Gets the ambient colour reflectance of the pass. | |
const ColourValue & | getDiffuse (void) const |
Gets the diffuse colour reflectance of the pass. | |
const ColourValue & | getSpecular (void) const |
Gets the specular colour reflectance of the pass. | |
const ColourValue & | getSelfIllumination (void) const |
Gets the self illumination colour of the pass. | |
Real | getShininess (void) const |
Gets the 'shininess' property of the pass (affects specular highlights). | |
TextureUnitState * | createTextureUnitState (void) |
Inserts a new TextureUnitState object into the Pass. | |
TextureUnitState * | createTextureUnitState (const String &textureName, unsigned short texCoordSet=0) |
Inserts a new TextureUnitState object into the Pass. | |
void | addTextureUnitState (TextureUnitState *state) |
Adds the passed in TextureUnitState, to the existing Pass. | |
TextureUnitState * | getTextureUnitState (unsigned short index) |
Retrieves a pointer to a texture unit state so it may be modified. | |
TextureUnitStateIterator | getTextureUnitStateIterator (void) |
Get an iterator over the TextureUnitStates contained in this Pass. | |
void | removeTextureUnitState (unsigned short index) |
Removes the indexed texture unit state from this pass. | |
void | removeAllTextureUnitStates (void) |
Removes all texture unit settings. | |
size_t | getNumTextureUnitStates (void) const |
Returns the number of texture unit settings. | |
void | setSceneBlending (const SceneBlendType sbt) |
Sets the kind of blending this pass has with the existing contents of the scene. | |
void | setSceneBlending (const SceneBlendFactor sourceFactor, const SceneBlendFactor destFactor) |
Allows very fine control of blending this Pass with the existing contents of the scene. | |
SceneBlendFactor | getSourceBlendFactor () const |
Retrieves the source blending factor for the material (as set using Materiall::setSceneBlending). | |
SceneBlendFactor | getDestBlendFactor () const |
Retrieves the destination blending factor for the material (as set using Materiall::setSceneBlending). | |
bool | isTransparent (void) const |
Returns true if this pass has some element of transparency. | |
void | setDepthCheckEnabled (bool enabled) |
Sets whether or not this pass renders with depth-buffer checking on or not. | |
bool | getDepthCheckEnabled (void) const |
Returns whether or not this pass renders with depth-buffer checking on or not. | |
void | setDepthWriteEnabled (bool enabled) |
Sets whether or not this pass renders with depth-buffer writing on or not. | |
bool | getDepthWriteEnabled (void) const |
Returns whether or not this 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. | |
CompareFunction | getDepthFunction (void) const |
Returns 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 this Pass. | |
bool | getColourWriteEnabled (void) const |
Determines if colour buffer writing is enabled for this pass. | |
void | setCullingMode (CullingMode mode) |
Sets the culling mode for this pass based on the 'vertex winding'. | |
CullingMode | getCullingMode (void) const |
Returns the culling mode for geometry rendered with this pass. | |
void | setManualCullingMode (ManualCullingMode mode) |
Sets the manual culling mode, performed by CPU rather than hardware. | |
ManualCullingMode | getManualCullingMode (void) const |
Retrieves the manual culling mode for this pass. | |
void | setLightingEnabled (bool enabled) |
Sets whether or not dynamic lighting is enabled. | |
bool | getLightingEnabled (void) const |
Returns whether or not dynamic lighting is enabled. | |
void | setMaxSimultaneousLights (unsigned short maxLights) |
Sets the maximum number of lights to be used by this pass. | |
unsigned short | getMaxSimultaneousLights (void) const |
Gets the maximum number of lights to be used by this pass. | |
void | setShadingMode (ShadeOptions mode) |
Sets the type of light shading required. | |
ShadeOptions | getShadingMode (void) const |
Returns the type of light shading to be used. | |
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 this pass. | |
bool | getFogOverride (void) const |
Returns true if this pass is to override the scene fog settings. | |
FogMode | getFogMode (void) const |
Returns the fog mode for this pass. | |
const ColourValue & | getFogColour (void) const |
Returns the fog colour for the scene. | |
Real | getFogStart (void) const |
Returns the fog start distance for this pass. | |
Real | getFogEnd (void) const |
Returns the fog end distance for this pass. | |
Real | getFogDensity (void) const |
Returns the fog density for this pass. | |
void | setDepthBias (ushort bias) |
Sets the depth bias to be used for this material. | |
ushort | getDepthBias (void) const |
Retrieves the depth bias value as set by setDepthValue. | |
void | setRunOncePerLight (bool enabled, bool onlyForOneLightType=true, Light::LightTypes lightType=Light::LT_POINT) |
Sets whether or not this pass should be run once per light which can affect the object being rendered. | |
bool | getRunOncePerLight (void) const |
Does this pass run once for every light in range? | |
bool | getRunOnlyForOneLightType (void) const |
Does this pass run only for a single light type (if getRunOncePerLight is true). | |
Light::LightTypes | getOnlyLightType () const |
Gets the single light type this pass runs for if getRunOncePerLight and getRunOnlyForOneLightType are both true. | |
Technique * | getParent (void) |
Gets the parent Technique. | |
void | setVertexProgram (const String &name) |
Sets the details of the vertex program to use. | |
void | setVertexProgramParameters (GpuProgramParametersSharedPtr params) |
Sets the vertex program parameters. | |
const String & | getVertexProgramName (void) |
Gets the name of the vertex program used by this pass. | |
GpuProgramParametersSharedPtr | getVertexProgramParameters (void) |
Gets the vertex program parameters used by this pass. | |
GpuProgram * | getVertexProgram (void) |
Gets the vertex program used by this pass, only available after _load(). | |
void | setFragmentProgram (const String &name) |
Sets the details of the fragment program to use. | |
void | setFragmentProgramParameters (GpuProgramParametersSharedPtr params) |
Sets the vertex program parameters. | |
const String & | getFragmentProgramName (void) |
Gets the name of the fragment program used by this pass. | |
GpuProgramParametersSharedPtr | getFragmentProgramParameters (void) |
Gets the vertex program parameters used by this pass. | |
GpuProgram * | getFragmentProgram (void) |
Gets the vertex program used by this pass, only available after _load(). | |
Pass * | _split (unsigned short numUnits) |
Splits this Pass to one which can be handled in the number of texture units specified. | |
void | _load (void) |
Internal method for loading this pass. | |
void | _unload (void) |
Internal method for unloading this pass. | |
bool | isLoaded (void) const |
unsigned long | getHash (void) const |
Gets the 'hash' of this pass, ie a precomputed number to use for sorting. | |
void | _recalculateHash (void) |
Internal method for recalculating the hash. | |
void | _notifyNeedsRecompile (void) |
Tells the pass that it needs recompilation. | |
void | _updateAutoParamsNoLights (const AutoParamDataSource &source) |
Update any automatic parameters (except lights) on this pass. | |
void | _updateAutoParamsLightsOnly (const AutoParamDataSource &source) |
Update any automatic light parameters on this pass. | |
void | setTextureFiltering (TextureFilterOptions filterType) |
Set texture filtering for every texture unit. | |
void | setTextureAnisotropy (unsigned int maxAniso) |
Sets the anisotropy level to be used for all textures. | |
Protected Types | |
typedef std::vector< TextureUnitState * > | TextureUnitStates |
Storage of texture unit states. | |
Protected Attributes | |
Technique * | mParent |
unsigned short | mIndex |
unsigned long | mHash |
ColourValue | mAmbient |
ColourValue | mDiffuse |
ColourValue | mSpecular |
ColourValue | mEmissive |
Real | mShininess |
SceneBlendFactor | mSourceBlendFactor |
SceneBlendFactor | mDestBlendFactor |
bool | mDepthCheck |
bool | mDepthWrite |
CompareFunction | mDepthFunc |
ushort | mDepthBias |
bool | mColourWrite |
CullingMode | mCullMode |
ManualCullingMode | mManualCullMode |
bool | mLightingEnabled |
Lighting enabled? | |
unsigned short | mMaxSimultaneousLights |
Max simultaneous lights. | |
bool | mRunOncePerLight |
Run this pass once per light? | |
bool | mRunOnlyForOneLightType |
Light::LightTypes | mOnlyLightType |
ShadeOptions | mShadeOptions |
Shading options. | |
bool | mFogOverride |
FogMode | mFogMode |
ColourValue | mFogColour |
Real | mFogStart |
Real | mFogEnd |
Real | mFogDensity |
TextureUnitStates | mTextureUnitStates |
GpuProgramUsage * | mVertexProgramUsage |
GpuProgramUsage * | mFragmentProgramUsage |
Programmable passes are complex to define, because they require custom programs and you have to set all constant inputs to the programs (like the position of lights, any base material colours you wish to use etc), but they do give you much total flexibility over the algorithms used to render your pass, and you can create some effects which are impossible with a fixed-function pass. On the other hand, you can define a fixed-function pass in very little time, and you can use a range of fixed-function effects like environment mapping very easily, plus your pass will be more likely to be compatible with older hardware. There are pros and cons to both, just remember that if you use a programmable pass to create some great effects, allow more time for definition and testing.
Definition at line 55 of file OgrePass.h.
|
Definition at line 295 of file OgrePass.h. Referenced by getTextureUnitStateIterator(). |
|
Storage of texture unit states.
Definition at line 118 of file OgrePass.h. |
|
Default constructor.
Definition at line 37 of file OgrePass.cpp. References Ogre::CMPF_LESS_EQUAL, Ogre::CULL_CLOCKWISE, mAmbient, Ogre::MANUAL_CULL_BACK, mColourWrite, mCullMode, mDepthBias, mDepthCheck, mDepthFunc, mDepthWrite, mDestBlendFactor, mDiffuse, mEmissive, mFogOverride, mFragmentProgramUsage, mHash, mLightingEnabled, mManualCullMode, mMaxSimultaneousLights, mOnlyLightType, mRunOncePerLight, mRunOnlyForOneLightType, mShadeOptions, mShininess, mSourceBlendFactor, mSpecular, mVertexProgramUsage, OGRE_MAX_SIMULTANEOUS_LIGHTS, Ogre::SBF_ONE, Ogre::SBF_ZERO, and Ogre::SO_GOURAUD. |
|
Copy constructor.
Definition at line 72 of file OgrePass.cpp. |
|
Definition at line 80 of file OgrePass.cpp. References mFragmentProgramUsage, mVertexProgramUsage, and removeAllTextureUnitStates(). |
|
Internal method for loading this pass.
Definition at line 530 of file OgrePass.cpp. References Ogre::GpuProgramUsage::_load(), _recalculateHash(), mFragmentProgramUsage, mTextureUnitStates, and mVertexProgramUsage. |
|
Tells the pass that it needs recompilation.
Definition at line 715 of file OgrePass.cpp. References Ogre::Technique::_notifyNeedsRecompile(), and mParent. Referenced by Ogre::TextureUnitState::_notifyNeedsRecompile(), and Ogre::TextureUnitState::setCubicTextureName(). |
|
Internal method for recalculating the hash.
Definition at line 692 of file OgrePass.cpp. References Ogre::_StringHash, getNumTextureUnitStates(), mHash, mIndex, and mTextureUnitStates. Referenced by _load(), Ogre::TextureUnitState::setAnimatedTextureName(), Ogre::TextureUnitState::setCurrentFrame(), and Ogre::TextureUnitState::setTextureName(). |
|
Splits this Pass to one which can be handled in the number of texture units specified.
Definition at line 496 of file OgrePass.cpp. References addTextureUnitState(), Ogre::Technique::createPass(), Except, mParent, mTextureUnitStates, and setSceneBlending(). Referenced by Ogre::Technique::_compile(). |
|
Internal method for unloading this pass.
Definition at line 560 of file OgrePass.cpp. References mTextureUnitStates. |
|
Update any automatic light parameters on this pass.
Definition at line 755 of file OgrePass.cpp. References Ogre::GpuProgramUsage::getParameters(), hasFragmentProgram(), hasVertexProgram(), mFragmentProgramUsage, and mVertexProgramUsage. Referenced by Ogre::SceneManager::renderSingleObject(). |
|
Update any automatic parameters (except lights) on this pass.
Definition at line 740 of file OgrePass.cpp. References Ogre::GpuProgramUsage::getParameters(), hasFragmentProgram(), hasVertexProgram(), mFragmentProgramUsage, and mVertexProgramUsage. Referenced by Ogre::SceneManager::renderSingleObject(). |
|
Adds the passed in TextureUnitState, to the existing Pass.
Definition at line 257 of file OgrePass.cpp. References Ogre::Technique::_notifyNeedsRecompile(), mParent, and mTextureUnitStates. Referenced by _split(). |
|
Inserts a new TextureUnitState object into the Pass.
Definition at line 245 of file OgrePass.cpp. References Ogre::Technique::_notifyNeedsRecompile(), mParent, mTextureUnitStates, Ogre::TextureUnitState::setTextureCoordSet(), and Ogre::TextureUnitState::setTextureName(). |
|
Inserts a new TextureUnitState object into the Pass.
Definition at line 236 of file OgrePass.cpp. References Ogre::Technique::_notifyNeedsRecompile(), mParent, and mTextureUnitStates. Referenced by Ogre::Font::createTextureFromFont(), Ogre::Font::load(), Ogre::BspLevel::loadQuake3Level(), Ogre::parseTextureUnit(), Ogre::MeshSerializerImpl_v1::readTextureLayer(), and Ogre::TerrainSceneManager::setWorldGeometry(). |
|
Gets the ambient colour reflectance of the pass.
Definition at line 211 of file OgrePass.cpp. References mAmbient. Referenced by Ogre::SceneManager::setPass(), and Ogre::MaterialSerializer::writePass(). |
|
Determines if colour buffer writing is enabled for this pass.
Definition at line 379 of file OgrePass.cpp. References mColourWrite. Referenced by Ogre::SceneManager::setPass(). |
|
Returns the culling mode for geometry rendered with this pass. See setCullingMode for more information. Definition at line 389 of file OgrePass.cpp. References Ogre::CullingMode, and mCullMode. Referenced by Ogre::SceneManager::setPass(), and Ogre::MaterialSerializer::writePass(). |
|
Retrieves the depth bias value as set by setDepthValue.
Definition at line 491 of file OgrePass.cpp. References mDepthBias, and Ogre::ushort. Referenced by Ogre::SceneManager::setPass(), and Ogre::MaterialSerializer::writePass(). |
|
Returns whether or not this pass renders with depth-buffer checking on or not.
Definition at line 349 of file OgrePass.cpp. References mDepthCheck. Referenced by Ogre::SceneManager::setPass(), and Ogre::MaterialSerializer::writePass(). |
|
Returns the function used to compare depth values when depth checking is on.
Definition at line 369 of file OgrePass.cpp. References Ogre::CompareFunction, and mDepthFunc. Referenced by Ogre::SceneManager::setPass(), and Ogre::MaterialSerializer::writePass(). |
|
Returns whether or not this pass renders with depth-buffer writing on or not.
Definition at line 359 of file OgrePass.cpp. References mDepthWrite. Referenced by Ogre::SceneManager::setPass(), and Ogre::MaterialSerializer::writePass(). |
|
Retrieves the destination blending factor for the material (as set using Materiall::setSceneBlending).
Definition at line 330 of file OgrePass.cpp. References mDestBlendFactor, and Ogre::SceneBlendFactor. Referenced by Ogre::SceneManager::setPass(), and Ogre::MaterialSerializer::writePass(). |
|
Gets the diffuse colour reflectance of the pass.
Definition at line 216 of file OgrePass.cpp. References mDiffuse. Referenced by Ogre::SceneManager::setPass(), and Ogre::MaterialSerializer::writePass(). |
|
Returns the fog colour for the scene.
Definition at line 465 of file OgrePass.cpp. References mFogColour. Referenced by Ogre::SceneManager::setPass(), and Ogre::MaterialSerializer::writePass(). |
|
Returns the fog density for this pass.
Definition at line 480 of file OgrePass.cpp. References mFogDensity, and Ogre::Real. Referenced by Ogre::SceneManager::setPass(), and Ogre::MaterialSerializer::writePass(). |
|
Returns the fog end distance for this pass.
Definition at line 475 of file OgrePass.cpp. References mFogEnd, and Ogre::Real. Referenced by Ogre::SceneManager::setPass(), and Ogre::MaterialSerializer::writePass(). |
|
Returns the fog mode for this pass.
Definition at line 460 of file OgrePass.cpp. References Ogre::FogMode, and mFogMode. Referenced by Ogre::SceneManager::setPass(), and Ogre::MaterialSerializer::writePass(). |
|
Returns true if this pass is to override the scene fog settings.
Definition at line 455 of file OgrePass.cpp. References mFogOverride. Referenced by Ogre::SceneManager::setPass(), and Ogre::MaterialSerializer::writePass(). |
|
Returns the fog start distance for this pass.
Definition at line 470 of file OgrePass.cpp. References mFogStart, and Ogre::Real. Referenced by Ogre::SceneManager::setPass(), and Ogre::MaterialSerializer::writePass(). |
|
Gets the vertex program used by this pass, only available after _load().
Definition at line 677 of file OgrePass.cpp. References Ogre::GpuProgramUsage::getProgram(), and mFragmentProgramUsage. Referenced by Ogre::Technique::_compile(), and Ogre::SceneManager::setPass(). |
|
Gets the name of the fragment program used by this pass.
Definition at line 667 of file OgrePass.cpp. References Ogre::GpuProgramUsage::getProgramName(), and mFragmentProgramUsage. |
|
Gets the vertex program parameters used by this pass.
Definition at line 672 of file OgrePass.cpp. References Ogre::GpuProgramUsage::getParameters(), Ogre::GpuProgramParametersSharedPtr, and mFragmentProgramUsage. Referenced by Ogre::parseFragmentProgramRef(), and Ogre::SceneManager::renderSingleObject(). |
|
Gets the 'hash' of this pass, ie a precomputed number to use for sorting.
Definition at line 687 of file OgrePass.cpp. References mHash. Referenced by Ogre::RenderPriorityGroup::TransparentQueueItemLess::operator()(), and Ogre::RenderPriorityGroup::SolidQueueItemLess::operator()(). |
|
Gets the index of this Pass in the parent Technique.
Definition at line 144 of file OgrePass.h. |
|
Returns whether or not dynamic lighting is enabled.
Definition at line 399 of file OgrePass.cpp. References mLightingEnabled. Referenced by Ogre::SceneManager::renderSingleObject(), Ogre::SceneManager::setPass(), and Ogre::MaterialSerializer::writePass(). |
|
Retrieves the manual culling mode for this pass.
Definition at line 437 of file OgrePass.cpp. References Ogre::ManualCullingMode, and mManualCullMode. Referenced by Ogre::BspSceneManager::processVisibleLeaf(), and Ogre::MaterialSerializer::writePass(). |
|
Gets the maximum number of lights to be used by this pass.
Definition at line 409 of file OgrePass.cpp. References mMaxSimultaneousLights. Referenced by Ogre::SceneManager::renderSingleObject(), and Ogre::MaterialSerializer::writePass(). |
|
Returns the number of texture unit settings.
Definition at line 311 of file OgrePass.h. Referenced by Ogre::Technique::_compile(), _recalculateHash(), Ogre::SceneManager::setPass(), and Ogre::PanelGuiElement::updateTextureGeometry(). |
|
Gets the single light type this pass runs for if getRunOncePerLight and getRunOnlyForOneLightType are both true.
Definition at line 639 of file OgrePass.h. Referenced by Ogre::SceneManager::renderSingleObject(), and Ogre::MaterialSerializer::writePass(). |
|
Gets the parent Technique.
Definition at line 642 of file OgrePass.h. |
|
Does this pass run once for every light in range?
Definition at line 634 of file OgrePass.h. Referenced by Ogre::SceneManager::renderSingleObject(), and Ogre::MaterialSerializer::writePass(). |
|
Does this pass run only for a single light type (if getRunOncePerLight is true).
Definition at line 636 of file OgrePass.h. Referenced by Ogre::SceneManager::renderSingleObject(), and Ogre::MaterialSerializer::writePass(). |
|
Gets the self illumination colour of the pass.
Definition at line 226 of file OgrePass.cpp. References mEmissive. Referenced by Ogre::SceneManager::setPass(), and Ogre::MaterialSerializer::writePass(). |
|
Returns the type of light shading to be used.
Definition at line 427 of file OgrePass.cpp. References mShadeOptions, and Ogre::ShadeOptions. Referenced by Ogre::SceneManager::setPass(), and Ogre::MaterialSerializer::writePass(). |
|
Gets the 'shininess' property of the pass (affects specular highlights).
Definition at line 231 of file OgrePass.cpp. References mShininess, and Ogre::Real. Referenced by Ogre::SceneManager::setPass(), and Ogre::MaterialSerializer::writePass(). |
|
Retrieves the source blending factor for the material (as set using Materiall::setSceneBlending).
Definition at line 325 of file OgrePass.cpp. References mSourceBlendFactor, and Ogre::SceneBlendFactor. Referenced by Ogre::SceneManager::setPass(), and Ogre::MaterialSerializer::writePass(). |
|
Gets the specular colour reflectance of the pass.
Definition at line 221 of file OgrePass.cpp. References mSpecular. Referenced by Ogre::SceneManager::setPass(), and Ogre::MaterialSerializer::writePass(). |
|
Retrieves a pointer to a texture unit state so it may be modified.
Definition at line 264 of file OgrePass.cpp. References mTextureUnitStates. Referenced by Ogre::Font::load(), and Ogre::SceneManager::setSkyBox(). |
|
Get an iterator over the TextureUnitStates contained in this Pass.
Definition at line 271 of file OgrePass.cpp. References mTextureUnitStates, and TextureUnitStateIterator. Referenced by Ogre::Technique::_compile(), Ogre::SceneManager::renderSingleObject(), and Ogre::SceneManager::setPass(). |
|
Gets the vertex program used by this pass, only available after _load().
Definition at line 662 of file OgrePass.cpp. References Ogre::GpuProgramUsage::getProgram(), and mVertexProgramUsage. Referenced by Ogre::Technique::_compile(), and Ogre::SceneManager::setPass(). |
|
Gets the name of the vertex program used by this pass.
Definition at line 643 of file OgrePass.cpp. References Ogre::GpuProgramUsage::getProgramName(), and mVertexProgramUsage. |
|
Gets the vertex program parameters used by this pass.
Definition at line 651 of file OgrePass.cpp. References Except, Ogre::GpuProgramUsage::getParameters(), Ogre::GpuProgramParametersSharedPtr, and mVertexProgramUsage. Referenced by Ogre::parseVertexProgramRef(), and Ogre::SceneManager::renderSingleObject(). |
|
Returns true if this pass uses a programmable fragment pipeline.
Definition at line 141 of file OgrePass.h. Referenced by Ogre::Technique::_compile(), _updateAutoParamsLightsOnly(), _updateAutoParamsNoLights(), Ogre::SceneManager::renderSingleObject(), and Ogre::SceneManager::setPass(). |
|
Returns true if this pass uses a programmable vertex pipeline.
Definition at line 138 of file OgrePass.h. Referenced by Ogre::Technique::_compile(), _updateAutoParamsLightsOnly(), _updateAutoParamsNoLights(), Ogre::SceneManager::renderSingleObject(), and Ogre::SceneManager::setPass(). |
|
Definition at line 682 of file OgrePass.cpp. References Ogre::Technique::isLoaded(), and mParent. Referenced by Ogre::TextureUnitState::isLoaded(). |
|
Returns true if this pass is programmable ie includes either a vertex or fragment program.
Definition at line 135 of file OgrePass.h. Referenced by Ogre::SceneManager::renderSingleObject(). |
|
Returns true if this pass has some element of transparency.
Definition at line 335 of file OgrePass.cpp. References mDestBlendFactor, and Ogre::SBF_ZERO. |
|
Operator = overload.
Definition at line 96 of file OgrePass.cpp. References mAmbient, mColourWrite, mCullMode, mDepthBias, mDepthCheck, mDepthFunc, mDepthWrite, mDestBlendFactor, mDiffuse, mEmissive, mFogOverride, mFragmentProgramUsage, mLightingEnabled, mManualCullMode, mMaxSimultaneousLights, mOnlyLightType, mRunOncePerLight, mRunOnlyForOneLightType, mShadeOptions, mShininess, mSourceBlendFactor, mSpecular, mTextureUnitStates, mVertexProgramUsage, and removeAllTextureUnitStates(). |
|
Removes all texture unit settings.
Definition at line 287 of file OgrePass.cpp. References Ogre::Technique::_notifyNeedsRecompile(), mParent, and mTextureUnitStates. |
|
Removes the indexed texture unit state from this pass.
Definition at line 276 of file OgrePass.cpp. References Ogre::Technique::_notifyNeedsRecompile(), mParent, and mTextureUnitStates. |
|
Sets the ambient colour reflectance properties of this pass.
Definition at line 164 of file OgrePass.cpp. References mAmbient. |
|
Sets the ambient colour reflectance properties of this pass.
Definition at line 156 of file OgrePass.cpp. References Ogre::ColourValue::b, Ogre::ColourValue::g, Ogre::green, mAmbient, Ogre::ColourValue::r, Ogre::Real, and Ogre::red. Referenced by Ogre::parseAmbient(). |
|
Sets whether or not colour buffer writing is enabled for this Pass.
Definition at line 374 of file OgrePass.cpp. References mColourWrite. Referenced by Ogre::parseColourWrite(). |
|
Sets the culling mode for this pass based on the 'vertex winding'.
Definition at line 384 of file OgrePass.cpp. References Ogre::CullingMode, and mCullMode. Referenced by Ogre::parseCullHardware(). |
|
Sets the depth bias to be used for this material.
Definition at line 485 of file OgrePass.cpp. References mDepthBias, and Ogre::ushort. Referenced by Ogre::parseDepthBias(). |
|
Sets whether or not this pass renders with depth-buffer checking on or not.
Definition at line 344 of file OgrePass.cpp. References mDepthCheck. Referenced by Ogre::parseDepthCheck(). |
|
Sets the function used to compare depth values when depth checking is on.
Definition at line 364 of file OgrePass.cpp. References Ogre::CompareFunction, and mDepthFunc. Referenced by Ogre::parseDepthFunc(). |
|
Sets whether or not this pass renders with depth-buffer writing on or not.
Definition at line 354 of file OgrePass.cpp. References mDepthWrite. Referenced by Ogre::parseDepthWrite(). |
|
Sets the diffuse colour reflectance properties of this pass.
Definition at line 176 of file OgrePass.cpp. References mDiffuse. |
|
Sets the diffuse colour reflectance properties of this pass.
Definition at line 169 of file OgrePass.cpp. References Ogre::ColourValue::b, Ogre::ColourValue::g, Ogre::green, mDiffuse, Ogre::ColourValue::r, Ogre::Real, and Ogre::red. Referenced by Ogre::parseDiffuse(). |
|
Sets the fogging mode applied to this pass.
Definition at line 442 of file OgrePass.cpp. References Ogre::FogMode, mFogColour, mFogDensity, mFogEnd, mFogMode, mFogOverride, mFogStart, and Ogre::Real. Referenced by Ogre::parseFogging(). |
|
Sets the details of the fragment program to use.
Definition at line 612 of file OgrePass.cpp. References Ogre::Technique::_notifyNeedsRecompile(), Ogre::GPT_FRAGMENT_PROGRAM, mFragmentProgramUsage, mParent, and Ogre::GpuProgramUsage::setProgramName(). Referenced by Ogre::parseFragmentProgramRef(). |
|
Sets the vertex program parameters.
Definition at line 632 of file OgrePass.cpp. References Except, Ogre::GpuProgramParametersSharedPtr, mFragmentProgramUsage, and Ogre::GpuProgramUsage::setParameters(). |
|
Sets whether or not dynamic lighting is enabled.
Definition at line 394 of file OgrePass.cpp. References mLightingEnabled. Referenced by Ogre::parseLighting(). |
|
Sets the manual culling mode, performed by CPU rather than hardware. @pemarks In some situations you want to use manual culling of triangles rather than sending the triangles to the hardware and letting it cull them. This setting only takes effect on SceneManager's that use it (since it is best used on large groups of planar world geometry rather than on movable geometry since this would be expensive), but if used can cull geometry before it is sent to the hardware.
Definition at line 432 of file OgrePass.cpp. References Ogre::ManualCullingMode, and mManualCullMode. Referenced by Ogre::parseCullSoftware(). |
|
Sets the maximum number of lights to be used by this pass.
Definition at line 404 of file OgrePass.cpp. References mMaxSimultaneousLights. Referenced by Ogre::parseMaxLights(). |
|
Sets whether or not this pass should be run once per light which can affect the object being rendered.
Definition at line 414 of file OgrePass.cpp. References mOnlyLightType, mRunOncePerLight, and mRunOnlyForOneLightType. Referenced by Ogre::parseIteration(). |
|
Allows very fine control of blending this Pass with the existing contents of the scene.
Definition at line 319 of file OgrePass.cpp. References mDestBlendFactor, mSourceBlendFactor, and Ogre::SceneBlendFactor. |
|
Sets the kind of blending this pass has with the existing contents of the scene.
Definition at line 300 of file OgrePass.cpp. References Ogre::SBF_ONE, Ogre::SBF_ONE_MINUS_SOURCE_ALPHA, Ogre::SBF_ONE_MINUS_SOURCE_COLOUR, Ogre::SBF_SOURCE_ALPHA, Ogre::SBF_SOURCE_COLOUR, Ogre::SBT_ADD, Ogre::SBT_TRANSPARENT_ALPHA, Ogre::SBT_TRANSPARENT_COLOUR, and Ogre::SceneBlendType. Referenced by _split(), and Ogre::parseSceneBlend(). |
|
Sets the amount of self-illumination an object has.
Definition at line 206 of file OgrePass.cpp. References mEmissive. |
|
Sets the amount of self-illumination an object has.
Definition at line 198 of file OgrePass.cpp. References Ogre::ColourValue::b, Ogre::ColourValue::g, Ogre::green, mEmissive, Ogre::ColourValue::r, Ogre::Real, and Ogre::red. Referenced by Ogre::parseEmissive(). |
|
Sets the type of light shading required.
Definition at line 422 of file OgrePass.cpp. References mShadeOptions, and Ogre::ShadeOptions. Referenced by Ogre::parseShading(). |
|
Sets the shininess of the pass, affecting the size of specular highlights.
Definition at line 193 of file OgrePass.cpp. References mShininess, and Ogre::Real. Referenced by Ogre::parseSpecular(). |
|
Sets the specular colour reflectance properties of this pass.
Definition at line 188 of file OgrePass.cpp. References mSpecular. |
|
Sets the specular colour reflectance properties of this pass.
Definition at line 181 of file OgrePass.cpp. References Ogre::ColourValue::b, Ogre::ColourValue::g, Ogre::green, mSpecular, Ogre::ColourValue::r, Ogre::Real, and Ogre::red. Referenced by Ogre::parseSpecular(). |
|
Sets the anisotropy level to be used for all textures.
Definition at line 730 of file OgrePass.cpp. References mTextureUnitStates. |
|
Set texture filtering for every texture unit.
Definition at line 720 of file OgrePass.cpp. References mTextureUnitStates, and Ogre::TextureFilterOptions. |
|
Sets the details of the vertex program to use.
Definition at line 581 of file OgrePass.cpp. References Ogre::Technique::_notifyNeedsRecompile(), Ogre::GPT_VERTEX_PROGRAM, mParent, mVertexProgramUsage, and Ogre::GpuProgramUsage::setProgramName(). Referenced by Ogre::parseVertexProgramRef(). |
|
Sets the vertex program parameters.
Definition at line 601 of file OgrePass.cpp. References Except, Ogre::GpuProgramParametersSharedPtr, mVertexProgramUsage, and Ogre::GpuProgramUsage::setParameters(). |
|
Definition at line 63 of file OgrePass.h. Referenced by getAmbient(), operator=(), Pass(), and setAmbient(). |
|
Definition at line 84 of file OgrePass.h. Referenced by getColourWriteEnabled(), operator=(), Pass(), and setColourWriteEnabled(). |
|
Definition at line 90 of file OgrePass.h. Referenced by getCullingMode(), operator=(), Pass(), and setCullingMode(). |
|
Definition at line 81 of file OgrePass.h. Referenced by getDepthBias(), operator=(), Pass(), and setDepthBias(). |
|
Definition at line 78 of file OgrePass.h. Referenced by getDepthCheckEnabled(), operator=(), Pass(), and setDepthCheckEnabled(). |
|
Definition at line 80 of file OgrePass.h. Referenced by getDepthFunction(), operator=(), Pass(), and setDepthFunction(). |
|
Definition at line 79 of file OgrePass.h. Referenced by getDepthWriteEnabled(), operator=(), Pass(), and setDepthWriteEnabled(). |
|
Definition at line 73 of file OgrePass.h. Referenced by getDestBlendFactor(), isTransparent(), operator=(), Pass(), and setSceneBlending(). |
|
Definition at line 64 of file OgrePass.h. Referenced by getDiffuse(), operator=(), Pass(), and setDiffuse(). |
|
Definition at line 66 of file OgrePass.h. Referenced by getSelfIllumination(), operator=(), Pass(), and setSelfIllumination(). |
|
Definition at line 111 of file OgrePass.h. Referenced by getFogColour(), and setFog(). |
|
Definition at line 114 of file OgrePass.h. Referenced by getFogDensity(), and setFog(). |
|
Definition at line 113 of file OgrePass.h. |
|
Definition at line 110 of file OgrePass.h. Referenced by getFogMode(), and setFog(). |
|
Definition at line 109 of file OgrePass.h. Referenced by getFogOverride(), operator=(), Pass(), and setFog(). |
|
Definition at line 112 of file OgrePass.h. Referenced by getFogStart(), and setFog(). |
|
Definition at line 124 of file OgrePass.h. Referenced by _load(), _updateAutoParamsLightsOnly(), _updateAutoParamsNoLights(), getFragmentProgram(), getFragmentProgramName(), getFragmentProgramParameters(), operator=(), Pass(), setFragmentProgram(), setFragmentProgramParameters(), and ~Pass(). |
|
Definition at line 60 of file OgrePass.h. Referenced by _recalculateHash(), getHash(), and Pass(). |
|
Definition at line 59 of file OgrePass.h. Referenced by _recalculateHash(), and Pass(). |
|
Lighting enabled?
Definition at line 95 of file OgrePass.h. Referenced by getLightingEnabled(), operator=(), Pass(), and setLightingEnabled(). |
|
Definition at line 91 of file OgrePass.h. Referenced by getManualCullingMode(), operator=(), Pass(), and setManualCullingMode(). |
|
Max simultaneous lights.
Definition at line 97 of file OgrePass.h. Referenced by getMaxSimultaneousLights(), operator=(), Pass(), and setMaxSimultaneousLights(). |
|
Definition at line 102 of file OgrePass.h. Referenced by operator=(), Pass(), and setRunOncePerLight(). |
|
Definition at line 58 of file OgrePass.h. Referenced by _notifyNeedsRecompile(), _split(), addTextureUnitState(), createTextureUnitState(), isLoaded(), Pass(), removeAllTextureUnitStates(), removeTextureUnitState(), setFragmentProgram(), and setVertexProgram(). |
|
Run this pass once per light?
Definition at line 99 of file OgrePass.h. Referenced by operator=(), Pass(), and setRunOncePerLight(). |
|
Definition at line 101 of file OgrePass.h. Referenced by operator=(), Pass(), and setRunOncePerLight(). |
|
Shading options.
Definition at line 105 of file OgrePass.h. Referenced by getShadingMode(), operator=(), Pass(), and setShadingMode(). |
|
Definition at line 67 of file OgrePass.h. Referenced by getShininess(), operator=(), Pass(), and setShininess(). |
|
Definition at line 72 of file OgrePass.h. Referenced by getSourceBlendFactor(), operator=(), Pass(), and setSceneBlending(). |
|
Definition at line 65 of file OgrePass.h. Referenced by getSpecular(), operator=(), Pass(), and setSpecular(). |
|
Definition at line 119 of file OgrePass.h. Referenced by _load(), _recalculateHash(), _split(), _unload(), addTextureUnitState(), createTextureUnitState(), getTextureUnitState(), getTextureUnitStateIterator(), operator=(), removeAllTextureUnitStates(), removeTextureUnitState(), setTextureAnisotropy(), and setTextureFiltering(). |
|
Definition at line 122 of file OgrePass.h. Referenced by _load(), _updateAutoParamsLightsOnly(), _updateAutoParamsNoLights(), getVertexProgram(), getVertexProgramName(), getVertexProgramParameters(), operator=(), Pass(), setVertexProgram(), setVertexProgramParameters(), and ~Pass(). |
Copyright © 2002-2003 by The OGRE Team
Last modified Wed Jan 21 00:19:02 2004