Classes | Typedefs | Enumerations
Materials
Collaboration diagram for Materials:

Classes

class  Ogre::AutoParamDataSource
 This utility class is used to hold the information used to generate the matrices and other information required to automatically populate GpuProgramParameters. More...
 
class  Ogre::ExternalTextureSource
 IMPORTANT: Plugins must override default dictionary name! Base class that texture plugins derive from. More...
 
class  Ogre::ExternalTextureSource::CmdFPS
 
class  Ogre::ExternalTextureSource::CmdInputFileName
 
class  Ogre::ExternalTextureSource::CmdPlayMode
 
class  Ogre::ExternalTextureSource::CmdTecPassState
 
class  Ogre::ExternalTextureSourceManager
 Singleton Class which handles the registering and control of texture plugins. More...
 
struct  Ogre::GpuConstantDefinition
 Information about predefined program constants. More...
 
struct  Ogre::GpuLogicalBufferStruct
 Container struct to allow params to safely & update shared list of logical buffer assignments. More...
 
struct  Ogre::GpuLogicalIndexUse
 Structure recording the use of a physical buffer by a logical parameter index. More...
 
struct  Ogre::GpuNamedConstants
 Struct collecting together the information for named constants. More...
 
class  Ogre::GpuNamedConstantsSerializer
 Simple class for loading / saving GpuNamedConstants. More...
 
class  Ogre::GpuProgramParameters
 Collects together the program parameters used for a GpuProgram. More...
 
struct  Ogre::GpuProgramParameters::AutoConstantDefinition
 Structure defining an auto constant that's available for use in a parameters object. More...
 
class  Ogre::GpuProgramParameters::AutoConstantEntry
 Structure recording the use of an automatic parameter. More...
 
class  Ogre::GpuProgramUsage
 This class makes the usage of a vertex and fragment programs (low-level or high-level), with a given set of parameters, explicit. More...
 
class  Ogre::GpuSharedParameters
 A group of manually updated parameters that are shared between many parameter sets. More...
 
class  Ogre::GpuSharedParametersUsage
 This class records the usage of a set of shared parameters in a concrete set of GpuProgramParameters. More...
 
struct  Ogre::GpuSharedParametersUsage::CopyDataEntry
 
struct  Ogre::IlluminationPass
 Struct recording a pass which can be used for a specific illumination stage. More...
 
class  Ogre::LayerBlendModeEx
 Class which manages blending of both colour and alpha components. More...
 
class  Ogre::Material
 Class encapsulates rendering properties of an object. More...
 
class  Ogre::MaterialManager
 Class for managing Material settings for Ogre. More...
 
class  Ogre::MaterialManager::Listener
 Listener on any general material events. More...
 
struct  Ogre::MaterialScriptContext
 Struct for holding the script context while parsing. More...
 
struct  Ogre::MaterialScriptProgramDefinition
 Struct for holding a program definition which is in progress. More...
 
class  Ogre::MaterialSerializer
 Class for serializing Materials to / from a .material script. More...
 
class  Ogre::MaterialSerializer::Listener
 Class that allows listening in on the various stages of material serialization process. More...
 
class  Ogre::Pass
 Class defining a single pass of a Technique (of a Material), i.e. More...
 
struct  Ogre::Pass::HashFunc
 Definition of a functor for calculating the hashcode of a Pass. More...
 
class  Ogre::Technique
 Class representing an approach to rendering this particular Material. More...
 
struct  Ogre::Technique::GPUDeviceNameRule
 Rule controlling whether technique is deemed supported based on GPU device name. More...
 
struct  Ogre::Technique::GPUVendorRule
 Rule controlling whether technique is deemed supported based on GPU vendor. More...
 
class  Ogre::TextureUnitState
 Class representing the state of a single texture unit during a Pass of a Technique, of a Material. More...
 
struct  Ogre::TextureUnitState::TextureEffect
 Internal structure defining a texture effect. More...
 
struct  Ogre::TextureUnitState::UVWAddressingMode
 Texture addressing mode for each texture coordinate. More...
 

Typedefs

typedef bool(* Ogre::ATTRIBUTE_PARSER) (String &params, MaterialScriptContext &context)
 Function def for material attribute parser; return value determines if the next line should be {. More...
 
typedef vector< double >::type Ogre::DoubleConstantList
 Definition of container that holds the current double constants. More...
 
typedef vector< float >::type Ogre::FloatConstantList
 Definition of container that holds the current float constants. More...
 
typedef ConstMapIterator< GpuConstantDefinitionMap > Ogre::GpuConstantDefinitionIterator
 
typedef map< String, GpuConstantDefinition >::type Ogre::GpuConstantDefinitionMap
 
typedef SharedPtr< GpuLogicalBufferStruct > Ogre::GpuLogicalBufferStructPtr
 
typedef map< size_t, GpuLogicalIndexUse >::type Ogre::GpuLogicalIndexUseMap
 
typedef SharedPtr< GpuNamedConstants > Ogre::GpuNamedConstantsPtr
 
typedef SharedPtr< GpuProgramParameters > Ogre::GpuProgramParametersSharedPtr
 Shared pointer used to hold references to GpuProgramParameters instances. More...
 
typedef SharedPtr< GpuSharedParameters > Ogre::GpuSharedParametersPtr
 Shared pointer used to hold references to GpuProgramParameters instances. More...
 
typedef vector< IlluminationPass * >::type Ogre::IlluminationPassList
 
typedef vector< int >::type Ogre::IntConstantList
 Definition of container that holds the current float constants. More...
 

Enumerations

enum  Ogre::GpuProgramParameters::ACDataType { Ogre::GpuProgramParameters::ACDT_NONE, Ogre::GpuProgramParameters::ACDT_INT, Ogre::GpuProgramParameters::ACDT_REAL }
 Defines the type of the extra data item used by the auto constant. More...
 
enum  Ogre::GpuProgramParameters::AutoConstantType {
  Ogre::GpuProgramParameters::ACT_WORLD_MATRIX, Ogre::GpuProgramParameters::ACT_INVERSE_WORLD_MATRIX, Ogre::GpuProgramParameters::ACT_TRANSPOSE_WORLD_MATRIX, Ogre::GpuProgramParameters::ACT_INVERSE_TRANSPOSE_WORLD_MATRIX,
  Ogre::GpuProgramParameters::ACT_WORLD_MATRIX_ARRAY_3x4, Ogre::GpuProgramParameters::ACT_WORLD_MATRIX_ARRAY, Ogre::GpuProgramParameters::ACT_WORLD_DUALQUATERNION_ARRAY_2x4, Ogre::GpuProgramParameters::ACT_WORLD_SCALE_SHEAR_MATRIX_ARRAY_3x4,
  Ogre::GpuProgramParameters::ACT_VIEW_MATRIX, Ogre::GpuProgramParameters::ACT_INVERSE_VIEW_MATRIX, Ogre::GpuProgramParameters::ACT_TRANSPOSE_VIEW_MATRIX, Ogre::GpuProgramParameters::ACT_INVERSE_TRANSPOSE_VIEW_MATRIX,
  Ogre::GpuProgramParameters::ACT_PROJECTION_MATRIX, Ogre::GpuProgramParameters::ACT_INVERSE_PROJECTION_MATRIX, Ogre::GpuProgramParameters::ACT_TRANSPOSE_PROJECTION_MATRIX, Ogre::GpuProgramParameters::ACT_INVERSE_TRANSPOSE_PROJECTION_MATRIX,
  Ogre::GpuProgramParameters::ACT_VIEWPROJ_MATRIX, Ogre::GpuProgramParameters::ACT_INVERSE_VIEWPROJ_MATRIX, Ogre::GpuProgramParameters::ACT_TRANSPOSE_VIEWPROJ_MATRIX, Ogre::GpuProgramParameters::ACT_INVERSE_TRANSPOSE_VIEWPROJ_MATRIX,
  Ogre::GpuProgramParameters::ACT_WORLDVIEW_MATRIX, Ogre::GpuProgramParameters::ACT_INVERSE_WORLDVIEW_MATRIX, Ogre::GpuProgramParameters::ACT_TRANSPOSE_WORLDVIEW_MATRIX, Ogre::GpuProgramParameters::ACT_INVERSE_TRANSPOSE_WORLDVIEW_MATRIX,
  Ogre::GpuProgramParameters::ACT_WORLDVIEWPROJ_MATRIX, Ogre::GpuProgramParameters::ACT_INVERSE_WORLDVIEWPROJ_MATRIX, Ogre::GpuProgramParameters::ACT_TRANSPOSE_WORLDVIEWPROJ_MATRIX, Ogre::GpuProgramParameters::ACT_INVERSE_TRANSPOSE_WORLDVIEWPROJ_MATRIX,
  Ogre::GpuProgramParameters::ACT_RENDER_TARGET_FLIPPING, Ogre::GpuProgramParameters::ACT_VERTEX_WINDING, Ogre::GpuProgramParameters::ACT_FOG_COLOUR, Ogre::GpuProgramParameters::ACT_FOG_PARAMS,
  Ogre::GpuProgramParameters::ACT_SURFACE_AMBIENT_COLOUR, Ogre::GpuProgramParameters::ACT_SURFACE_DIFFUSE_COLOUR, Ogre::GpuProgramParameters::ACT_SURFACE_SPECULAR_COLOUR, Ogre::GpuProgramParameters::ACT_SURFACE_EMISSIVE_COLOUR,
  Ogre::GpuProgramParameters::ACT_SURFACE_SHININESS, Ogre::GpuProgramParameters::ACT_SURFACE_ALPHA_REJECTION_VALUE, Ogre::GpuProgramParameters::ACT_LIGHT_COUNT, Ogre::GpuProgramParameters::ACT_AMBIENT_LIGHT_COLOUR,
  Ogre::GpuProgramParameters::ACT_LIGHT_DIFFUSE_COLOUR, Ogre::GpuProgramParameters::ACT_LIGHT_SPECULAR_COLOUR, Ogre::GpuProgramParameters::ACT_LIGHT_ATTENUATION, Ogre::GpuProgramParameters::ACT_SPOTLIGHT_PARAMS,
  Ogre::GpuProgramParameters::ACT_LIGHT_POSITION, Ogre::GpuProgramParameters::ACT_LIGHT_POSITION_OBJECT_SPACE, Ogre::GpuProgramParameters::ACT_LIGHT_POSITION_VIEW_SPACE, Ogre::GpuProgramParameters::ACT_LIGHT_DIRECTION,
  Ogre::GpuProgramParameters::ACT_LIGHT_DIRECTION_OBJECT_SPACE, Ogre::GpuProgramParameters::ACT_LIGHT_DIRECTION_VIEW_SPACE, Ogre::GpuProgramParameters::ACT_LIGHT_DISTANCE_OBJECT_SPACE, Ogre::GpuProgramParameters::ACT_LIGHT_POWER_SCALE,
  Ogre::GpuProgramParameters::ACT_LIGHT_DIFFUSE_COLOUR_POWER_SCALED, Ogre::GpuProgramParameters::ACT_LIGHT_SPECULAR_COLOUR_POWER_SCALED, Ogre::GpuProgramParameters::ACT_LIGHT_DIFFUSE_COLOUR_ARRAY, Ogre::GpuProgramParameters::ACT_LIGHT_SPECULAR_COLOUR_ARRAY,
  Ogre::GpuProgramParameters::ACT_LIGHT_DIFFUSE_COLOUR_POWER_SCALED_ARRAY, Ogre::GpuProgramParameters::ACT_LIGHT_SPECULAR_COLOUR_POWER_SCALED_ARRAY, Ogre::GpuProgramParameters::ACT_LIGHT_ATTENUATION_ARRAY, Ogre::GpuProgramParameters::ACT_LIGHT_POSITION_ARRAY,
  Ogre::GpuProgramParameters::ACT_LIGHT_POSITION_OBJECT_SPACE_ARRAY, Ogre::GpuProgramParameters::ACT_LIGHT_POSITION_VIEW_SPACE_ARRAY, Ogre::GpuProgramParameters::ACT_LIGHT_DIRECTION_ARRAY, Ogre::GpuProgramParameters::ACT_LIGHT_DIRECTION_OBJECT_SPACE_ARRAY,
  Ogre::GpuProgramParameters::ACT_LIGHT_DIRECTION_VIEW_SPACE_ARRAY, Ogre::GpuProgramParameters::ACT_LIGHT_DISTANCE_OBJECT_SPACE_ARRAY, Ogre::GpuProgramParameters::ACT_LIGHT_POWER_SCALE_ARRAY, Ogre::GpuProgramParameters::ACT_SPOTLIGHT_PARAMS_ARRAY,
  Ogre::GpuProgramParameters::ACT_DERIVED_AMBIENT_LIGHT_COLOUR, Ogre::GpuProgramParameters::ACT_DERIVED_SCENE_COLOUR, Ogre::GpuProgramParameters::ACT_DERIVED_LIGHT_DIFFUSE_COLOUR, Ogre::GpuProgramParameters::ACT_DERIVED_LIGHT_SPECULAR_COLOUR,
  Ogre::GpuProgramParameters::ACT_DERIVED_LIGHT_DIFFUSE_COLOUR_ARRAY, Ogre::GpuProgramParameters::ACT_DERIVED_LIGHT_SPECULAR_COLOUR_ARRAY, Ogre::GpuProgramParameters::ACT_LIGHT_NUMBER, Ogre::GpuProgramParameters::ACT_LIGHT_CASTS_SHADOWS,
  Ogre::GpuProgramParameters::ACT_LIGHT_CASTS_SHADOWS_ARRAY, Ogre::GpuProgramParameters::ACT_SHADOW_EXTRUSION_DISTANCE, Ogre::GpuProgramParameters::ACT_CAMERA_POSITION, Ogre::GpuProgramParameters::ACT_CAMERA_POSITION_OBJECT_SPACE,
  Ogre::GpuProgramParameters::ACT_TEXTURE_VIEWPROJ_MATRIX, Ogre::GpuProgramParameters::ACT_TEXTURE_VIEWPROJ_MATRIX_ARRAY, Ogre::GpuProgramParameters::ACT_TEXTURE_WORLDVIEWPROJ_MATRIX, Ogre::GpuProgramParameters::ACT_TEXTURE_WORLDVIEWPROJ_MATRIX_ARRAY,
  Ogre::GpuProgramParameters::ACT_SPOTLIGHT_VIEWPROJ_MATRIX, Ogre::GpuProgramParameters::ACT_SPOTLIGHT_VIEWPROJ_MATRIX_ARRAY, Ogre::GpuProgramParameters::ACT_SPOTLIGHT_WORLDVIEWPROJ_MATRIX, Ogre::GpuProgramParameters::ACT_SPOTLIGHT_WORLDVIEWPROJ_MATRIX_ARRAY,
  Ogre::GpuProgramParameters::ACT_CUSTOM, Ogre::GpuProgramParameters::ACT_TIME, Ogre::GpuProgramParameters::ACT_TIME_0_X, Ogre::GpuProgramParameters::ACT_COSTIME_0_X,
  Ogre::GpuProgramParameters::ACT_SINTIME_0_X, Ogre::GpuProgramParameters::ACT_TANTIME_0_X, Ogre::GpuProgramParameters::ACT_TIME_0_X_PACKED, Ogre::GpuProgramParameters::ACT_TIME_0_1,
  Ogre::GpuProgramParameters::ACT_COSTIME_0_1, Ogre::GpuProgramParameters::ACT_SINTIME_0_1, Ogre::GpuProgramParameters::ACT_TANTIME_0_1, Ogre::GpuProgramParameters::ACT_TIME_0_1_PACKED,
  Ogre::GpuProgramParameters::ACT_TIME_0_2PI, Ogre::GpuProgramParameters::ACT_COSTIME_0_2PI, Ogre::GpuProgramParameters::ACT_SINTIME_0_2PI, Ogre::GpuProgramParameters::ACT_TANTIME_0_2PI,
  Ogre::GpuProgramParameters::ACT_TIME_0_2PI_PACKED, Ogre::GpuProgramParameters::ACT_FRAME_TIME, Ogre::GpuProgramParameters::ACT_FPS, Ogre::GpuProgramParameters::ACT_VIEWPORT_WIDTH,
  Ogre::GpuProgramParameters::ACT_VIEWPORT_HEIGHT, Ogre::GpuProgramParameters::ACT_INVERSE_VIEWPORT_WIDTH, Ogre::GpuProgramParameters::ACT_INVERSE_VIEWPORT_HEIGHT, Ogre::GpuProgramParameters::ACT_VIEWPORT_SIZE,
  Ogre::GpuProgramParameters::ACT_VIEW_DIRECTION, Ogre::GpuProgramParameters::ACT_VIEW_SIDE_VECTOR, Ogre::GpuProgramParameters::ACT_VIEW_UP_VECTOR, Ogre::GpuProgramParameters::ACT_FOV,
  Ogre::GpuProgramParameters::ACT_NEAR_CLIP_DISTANCE, Ogre::GpuProgramParameters::ACT_FAR_CLIP_DISTANCE, Ogre::GpuProgramParameters::ACT_PASS_NUMBER, Ogre::GpuProgramParameters::ACT_PASS_ITERATION_NUMBER,
  Ogre::GpuProgramParameters::ACT_ANIMATION_PARAMETRIC, Ogre::GpuProgramParameters::ACT_TEXEL_OFFSETS, Ogre::GpuProgramParameters::ACT_SCENE_DEPTH_RANGE, Ogre::GpuProgramParameters::ACT_SHADOW_SCENE_DEPTH_RANGE,
  Ogre::GpuProgramParameters::ACT_SHADOW_SCENE_DEPTH_RANGE_ARRAY, Ogre::GpuProgramParameters::ACT_SHADOW_COLOUR, Ogre::GpuProgramParameters::ACT_TEXTURE_SIZE, Ogre::GpuProgramParameters::ACT_INVERSE_TEXTURE_SIZE,
  Ogre::GpuProgramParameters::ACT_PACKED_TEXTURE_SIZE, Ogre::GpuProgramParameters::ACT_TEXTURE_MATRIX, Ogre::GpuProgramParameters::ACT_LOD_CAMERA_POSITION, Ogre::GpuProgramParameters::ACT_LOD_CAMERA_POSITION_OBJECT_SPACE,
  Ogre::GpuProgramParameters::ACT_LIGHT_CUSTOM, Ogre::GpuProgramParameters::ACT_UNKNOWN = 999
}
 Defines the types of automatically updated values that may be bound to GpuProgram parameters, or used to modify parameters on a per-object basis. More...
 
enum  Ogre::TextureUnitState::BindingType {
  Ogre::TextureUnitState::BT_FRAGMENT = 0, Ogre::TextureUnitState::BT_VERTEX = 1, Ogre::TextureUnitState::BT_GEOMETRY = 2, Ogre::TextureUnitState::BT_TESSELATION_HULL = 3,
  Ogre::TextureUnitState::BT_TESSELATION_DOMAIN = 4, Ogre::TextureUnitState::BT_COMPUTE = 5
}
 The type of unit to bind the texture settings to. More...
 
enum  Ogre::Pass::BuiltinHashFunction { Ogre::Pass::MIN_TEXTURE_CHANGE, Ogre::Pass::MIN_GPU_PROGRAM_CHANGE }
 There are some default hash functions used to order passes so that render state changes are minimised, this enumerates them. More...
 
enum  Ogre::TextureUnitState::ContentType { Ogre::TextureUnitState::CONTENT_NAMED = 0, Ogre::TextureUnitState::CONTENT_SHADOW = 1, Ogre::TextureUnitState::CONTENT_COMPOSITOR = 2 }
 Enum identifying the type of content this texture unit contains. More...
 
enum  Ogre::GpuProgramParameters::ElementType { Ogre::GpuProgramParameters::ET_INT, Ogre::GpuProgramParameters::ET_REAL }
 Defines the base element type of the auto constant. More...
 
enum  Ogre::TextureUnitState::EnvMapType { Ogre::TextureUnitState::ENV_PLANAR, Ogre::TextureUnitState::ENV_CURVED, Ogre::TextureUnitState::ENV_REFLECTION, Ogre::TextureUnitState::ENV_NORMAL }
 Enumeration to specify type of envmap. More...
 
enum  Ogre::eTexturePlayMode { Ogre::TextureEffectPause = 0, Ogre::TextureEffectPlay_ASAP = 1, Ogre::TextureEffectPlay_Looping = 2 }
 Enum for type of texture play mode. More...
 
enum  Ogre::GpuConstantType {
  Ogre::GCT_FLOAT1 = 1, Ogre::GCT_FLOAT2 = 2, Ogre::GCT_FLOAT3 = 3, Ogre::GCT_FLOAT4 = 4,
  Ogre::GCT_SAMPLER1D = 5, Ogre::GCT_SAMPLER2D = 6, Ogre::GCT_SAMPLER3D = 7, Ogre::GCT_SAMPLERCUBE = 8,
  Ogre::GCT_SAMPLERRECT = 9, Ogre::GCT_SAMPLER1DSHADOW = 10, Ogre::GCT_SAMPLER2DSHADOW = 11, Ogre::GCT_SAMPLER2DARRAY = 12,
  Ogre::GCT_MATRIX_2X2 = 13, Ogre::GCT_MATRIX_2X3 = 14, Ogre::GCT_MATRIX_2X4 = 15, Ogre::GCT_MATRIX_3X2 = 16,
  Ogre::GCT_MATRIX_3X3 = 17, Ogre::GCT_MATRIX_3X4 = 18, Ogre::GCT_MATRIX_4X2 = 19, Ogre::GCT_MATRIX_4X3 = 20,
  Ogre::GCT_MATRIX_4X4 = 21, Ogre::GCT_INT1 = 22, Ogre::GCT_INT2 = 23, Ogre::GCT_INT3 = 24,
  Ogre::GCT_INT4 = 25, Ogre::GCT_SUBROUTINE = 26, Ogre::GCT_DOUBLE1 = 27, Ogre::GCT_DOUBLE2 = 28,
  Ogre::GCT_DOUBLE3 = 29, Ogre::GCT_DOUBLE4 = 30, Ogre::GCT_MATRIX_DOUBLE_2X2 = 31, Ogre::GCT_MATRIX_DOUBLE_2X3 = 32,
  Ogre::GCT_MATRIX_DOUBLE_2X4 = 33, Ogre::GCT_MATRIX_DOUBLE_3X2 = 34, Ogre::GCT_MATRIX_DOUBLE_3X3 = 35, Ogre::GCT_MATRIX_DOUBLE_3X4 = 36,
  Ogre::GCT_MATRIX_DOUBLE_4X2 = 37, Ogre::GCT_MATRIX_DOUBLE_4X3 = 38, Ogre::GCT_MATRIX_DOUBLE_4X4 = 39, Ogre::GCT_UNKNOWN = 99
}
 Enumeration of the types of constant we may encounter in programs. More...
 
enum  Ogre::GpuParamVariability {
  Ogre::GPV_GLOBAL = 1, Ogre::GPV_PER_OBJECT = 2, Ogre::GPV_LIGHTS = 4, Ogre::GPV_PASS_ITERATION_NUMBER = 8,
  Ogre::GPV_ALL = 0xFFFF
}
 The variability of a GPU parameter, as derived from auto-params targeting it. More...
 
enum  Ogre::Technique::IlluminationPassesState { Ogre::Technique::IPS_COMPILE_DISABLED = -1, Ogre::Technique::IPS_NOT_COMPILED = 0, Ogre::Technique::IPS_COMPILED = 1 }
 Illumination pass state type. More...
 
enum  Ogre::IlluminationStage { Ogre::IS_AMBIENT, Ogre::IS_PER_LIGHT, Ogre::IS_DECAL, Ogre::IS_UNKNOWN }
 Categorisation of passes for the purpose of additive lighting. More...
 
enum  Ogre::Technique::IncludeOrExclude { Ogre::Technique::INCLUDE = 0, Ogre::Technique::EXCLUDE = 1 }
 Directive used to manually control technique support based on the inclusion or exclusion of some factor. More...
 
enum  Ogre::LayerBlendOperation { Ogre::LBO_REPLACE, Ogre::LBO_ADD, Ogre::LBO_MODULATE, Ogre::LBO_ALPHA_BLEND }
 List of valid texture blending operations, for use with TextureUnitState::setColourOperation. More...
 
enum  Ogre::LayerBlendOperationEx {
  Ogre::LBX_SOURCE1, Ogre::LBX_SOURCE2, Ogre::LBX_MODULATE, Ogre::LBX_MODULATE_X2,
  Ogre::LBX_MODULATE_X4, Ogre::LBX_ADD, Ogre::LBX_ADD_SIGNED, Ogre::LBX_ADD_SMOOTH,
  Ogre::LBX_SUBTRACT, Ogre::LBX_BLEND_DIFFUSE_ALPHA, Ogre::LBX_BLEND_TEXTURE_ALPHA, Ogre::LBX_BLEND_CURRENT_ALPHA,
  Ogre::LBX_BLEND_MANUAL, Ogre::LBX_DOTPRODUCT, Ogre::LBX_BLEND_DIFFUSE_COLOUR
}
 Expert list of valid texture blending operations, for use with TextureUnitState::setColourOperationEx and TextureUnitState::setAlphaOperation, and internally in the LayerBlendModeEx class. More...
 
enum  Ogre::LayerBlendSource {
  Ogre::LBS_CURRENT, Ogre::LBS_TEXTURE, Ogre::LBS_DIFFUSE, Ogre::LBS_SPECULAR,
  Ogre::LBS_MANUAL
}
 List of valid sources of values for blending operations used in TextureUnitState::setColourOperation and TextureUnitState::setAlphaOperation, and internally in the LayerBlendModeEx class. More...
 
enum  Ogre::LayerBlendType { Ogre::LBT_COLOUR, Ogre::LBT_ALPHA }
 Type of texture blend mode. More...
 
enum  Ogre::MaterialScriptSection {
  Ogre::MSS_NONE, Ogre::MSS_MATERIAL, Ogre::MSS_TECHNIQUE, Ogre::MSS_PASS,
  Ogre::MSS_TEXTUREUNIT, Ogre::MSS_PROGRAM_REF, Ogre::MSS_PROGRAM, Ogre::MSS_DEFAULT_PARAMETERS,
  Ogre::MSS_TEXTURESOURCE
}
 Enum to identify material sections. More...
 
enum  Ogre::SceneBlendFactor {
  Ogre::SBF_ONE, Ogre::SBF_ZERO, Ogre::SBF_DEST_COLOUR, Ogre::SBF_SOURCE_COLOUR,
  Ogre::SBF_ONE_MINUS_DEST_COLOUR, Ogre::SBF_ONE_MINUS_SOURCE_COLOUR, Ogre::SBF_DEST_ALPHA, Ogre::SBF_SOURCE_ALPHA,
  Ogre::SBF_ONE_MINUS_DEST_ALPHA, Ogre::SBF_ONE_MINUS_SOURCE_ALPHA
}
 Blending factors for manually blending objects with the scene. More...
 
enum  Ogre::SceneBlendOperation {
  Ogre::SBO_ADD, Ogre::SBO_SUBTRACT, Ogre::SBO_REVERSE_SUBTRACT, Ogre::SBO_MIN,
  Ogre::SBO_MAX
}
 Blending operations controls how objects are blended into the scene. More...
 
enum  Ogre::SceneBlendType {
  Ogre::SBT_TRANSPARENT_ALPHA, Ogre::SBT_TRANSPARENT_COLOUR, Ogre::SBT_ADD, Ogre::SBT_MODULATE,
  Ogre::SBT_REPLACE
}
 Types of blending that you can specify between an object and the existing contents of the scene. More...
 
enum  Ogre::MaterialSerializer::SerializeEvent { Ogre::MaterialSerializer::MSE_PRE_WRITE, Ogre::MaterialSerializer::MSE_WRITE_BEGIN, Ogre::MaterialSerializer::MSE_WRITE_END, Ogre::MaterialSerializer::MSE_POST_WRITE }
 
enum  Ogre::TextureUnitState::TextureAddressingMode {
  Ogre::TextureUnitState::TAM_WRAP, Ogre::TextureUnitState::TAM_MIRROR, Ogre::TextureUnitState::TAM_CLAMP, Ogre::TextureUnitState::TAM_BORDER,
  Ogre::TextureUnitState::TAM_UNKNOWN = 99
}
 Texture addressing modes - default is TAM_WRAP. More...
 
enum  Ogre::TextureUnitState::TextureCubeFace {
  Ogre::TextureUnitState::CUBE_FRONT = 0, Ogre::TextureUnitState::CUBE_BACK = 1, Ogre::TextureUnitState::CUBE_LEFT = 2, Ogre::TextureUnitState::CUBE_RIGHT = 3,
  Ogre::TextureUnitState::CUBE_UP = 4, Ogre::TextureUnitState::CUBE_DOWN = 5
}
 Enum identifying the frame indexes for faces of a cube map (not the composite 3D type. More...
 
enum  Ogre::TextureUnitState::TextureEffectType {
  Ogre::TextureUnitState::ET_ENVIRONMENT_MAP, Ogre::TextureUnitState::ET_PROJECTIVE_TEXTURE, Ogre::TextureUnitState::ET_UVSCROLL, Ogre::TextureUnitState::ET_USCROLL,
  Ogre::TextureUnitState::ET_VSCROLL, Ogre::TextureUnitState::ET_ROTATE, Ogre::TextureUnitState::ET_TRANSFORM
}
 Definition of the broad types of texture effect you can apply to a texture unit. More...
 
enum  Ogre::TextureUnitState::TextureTransformType {
  Ogre::TextureUnitState::TT_TRANSLATE_U, Ogre::TextureUnitState::TT_TRANSLATE_V, Ogre::TextureUnitState::TT_SCALE_U, Ogre::TextureUnitState::TT_SCALE_V,
  Ogre::TextureUnitState::TT_ROTATE
}
 Useful enumeration when dealing with procedural transforms. More...
 

Detailed Description

Typedef Documentation

typedef bool(* Ogre::ATTRIBUTE_PARSER) (String &params, MaterialScriptContext &context)

Function def for material attribute parser; return value determines if the next line should be {.

Definition at line 103 of file OgreMaterialSerializer.h.

typedef vector<double>::type Ogre::DoubleConstantList

Definition of container that holds the current double constants.

Note
Not necessarily in direct index order to constant indexes, logical to physical index map is derived from GpuProgram

Definition at line 468 of file OgreGpuProgramParams.h.

typedef vector<float>::type Ogre::FloatConstantList

Definition of container that holds the current float constants.

Note
Not necessarily in direct index order to constant indexes, logical to physical index map is derived from GpuProgram

Definition at line 463 of file OgreGpuProgramParams.h.

typedef ConstMapIterator<GpuConstantDefinitionMap> Ogre::GpuConstantDefinitionIterator

Definition at line 352 of file OgreGpuProgramParams.h.

typedef map<String, GpuConstantDefinition>::type Ogre::GpuConstantDefinitionMap

Definition at line 351 of file OgreGpuProgramParams.h.

typedef SharedPtr<GpuLogicalBufferStruct> Ogre::GpuLogicalBufferStructPtr

Definition at line 457 of file OgreGpuProgramParams.h.

typedef map<size_t, GpuLogicalIndexUse>::type Ogre::GpuLogicalIndexUseMap

Definition at line 445 of file OgreGpuProgramParams.h.

typedef SharedPtr<GpuNamedConstants> Ogre::GpuNamedConstantsPtr

Definition at line 413 of file OgreGpuProgramParams.h.

typedef SharedPtr<GpuProgramParameters> Ogre::GpuProgramParametersSharedPtr

Shared pointer used to hold references to GpuProgramParameters instances.

Definition at line 2050 of file OgreGpuProgramParams.h.

typedef SharedPtr<GpuSharedParameters> Ogre::GpuSharedParametersPtr

Shared pointer used to hold references to GpuProgramParameters instances.

Definition at line 612 of file OgreGpuProgramParams.h.

typedef vector<IlluminationPass*>::type Ogre::IlluminationPassList

Definition at line 1872 of file OgrePass.h.

typedef vector<int>::type Ogre::IntConstantList

Definition of container that holds the current float constants.

Note
Not necessarily in direct index order to constant indexes, logical to physical index map is derived from GpuProgram

Definition at line 473 of file OgreGpuProgramParams.h.

Enumeration Type Documentation

Defines the type of the extra data item used by the auto constant.

Enumerator
ACDT_NONE 

no data is required

ACDT_INT 

the auto constant requires data of type int

ACDT_REAL 

the auto constant requires data of type real

Definition at line 1175 of file OgreGpuProgramParams.h.

Defines the types of automatically updated values that may be bound to GpuProgram parameters, or used to modify parameters on a per-object basis.

Enumerator
ACT_WORLD_MATRIX 

The current world matrix.

ACT_INVERSE_WORLD_MATRIX 

The current world matrix, inverted.

ACT_TRANSPOSE_WORLD_MATRIX 

Provides transpose of world matrix.

Equivalent to RenderMonkey's "WorldTranspose".

ACT_INVERSE_TRANSPOSE_WORLD_MATRIX 

The current world matrix, inverted & transposed.

ACT_WORLD_MATRIX_ARRAY_3x4 

The current array of world matrices, as a 3x4 matrix, used for blending.

ACT_WORLD_MATRIX_ARRAY 

The current array of world matrices, used for blending.

ACT_WORLD_DUALQUATERNION_ARRAY_2x4 

The current array of world matrices transformed to an array of dual quaternions, represented as a 2x4 matrix.

ACT_WORLD_SCALE_SHEAR_MATRIX_ARRAY_3x4 

The scale and shear components of the current array of world matrices.

ACT_VIEW_MATRIX 

The current view matrix.

ACT_INVERSE_VIEW_MATRIX 

The current view matrix, inverted.

ACT_TRANSPOSE_VIEW_MATRIX 

Provides transpose of view matrix.

Equivalent to RenderMonkey's "ViewTranspose".

ACT_INVERSE_TRANSPOSE_VIEW_MATRIX 

Provides inverse transpose of view matrix.

Equivalent to RenderMonkey's "ViewInverseTranspose".

ACT_PROJECTION_MATRIX 

The current projection matrix.

ACT_INVERSE_PROJECTION_MATRIX 

Provides inverse of projection matrix.

Equivalent to RenderMonkey's "ProjectionInverse".

ACT_TRANSPOSE_PROJECTION_MATRIX 

Provides transpose of projection matrix.

Equivalent to RenderMonkey's "ProjectionTranspose".

ACT_INVERSE_TRANSPOSE_PROJECTION_MATRIX 

Provides inverse transpose of projection matrix.

Equivalent to RenderMonkey's "ProjectionInverseTranspose".

ACT_VIEWPROJ_MATRIX 

The current view & projection matrices concatenated.

ACT_INVERSE_VIEWPROJ_MATRIX 

Provides inverse of concatenated view and projection matrices.

Equivalent to RenderMonkey's "ViewProjectionInverse".

ACT_TRANSPOSE_VIEWPROJ_MATRIX 

Provides transpose of concatenated view and projection matrices.

Equivalent to RenderMonkey's "ViewProjectionTranspose".

ACT_INVERSE_TRANSPOSE_VIEWPROJ_MATRIX 

Provides inverse transpose of concatenated view and projection matrices.

Equivalent to RenderMonkey's "ViewProjectionInverseTranspose".

ACT_WORLDVIEW_MATRIX 

The current world & view matrices concatenated.

ACT_INVERSE_WORLDVIEW_MATRIX 

The current world & view matrices concatenated, then inverted.

ACT_TRANSPOSE_WORLDVIEW_MATRIX 

Provides transpose of concatenated world and view matrices.

Equivalent to RenderMonkey's "WorldViewTranspose".

ACT_INVERSE_TRANSPOSE_WORLDVIEW_MATRIX 

The current world & view matrices concatenated, then inverted & transposed.

ACT_WORLDVIEWPROJ_MATRIX 

view matrices.

The current world, view & projection matrices concatenated

ACT_INVERSE_WORLDVIEWPROJ_MATRIX 

Provides inverse of concatenated world, view and projection matrices.

Equivalent to RenderMonkey's "WorldViewProjectionInverse".

ACT_TRANSPOSE_WORLDVIEWPROJ_MATRIX 

Provides transpose of concatenated world, view and projection matrices.

Equivalent to RenderMonkey's "WorldViewProjectionTranspose".

ACT_INVERSE_TRANSPOSE_WORLDVIEWPROJ_MATRIX 

Provides inverse transpose of concatenated world, view and projection matrices.

Equivalent to RenderMonkey's "WorldViewProjectionInverseTranspose".

ACT_RENDER_TARGET_FLIPPING 

render target related values

-1 if requires texture flipping, +1 otherwise. It's useful when you bypassed projection matrix transform, still able use this value to adjust transformed y position.

ACT_VERTEX_WINDING 

-1 if the winding has been inverted (e.g.

for reflections), +1 otherwise.

ACT_FOG_COLOUR 

Fog colour.

ACT_FOG_PARAMS 

Fog params: density, linear start, linear end, 1/(end-start)

ACT_SURFACE_AMBIENT_COLOUR 

Surface ambient colour, as set in Pass::setAmbient.

ACT_SURFACE_DIFFUSE_COLOUR 

Surface diffuse colour, as set in Pass::setDiffuse.

ACT_SURFACE_SPECULAR_COLOUR 

Surface specular colour, as set in Pass::setSpecular.

ACT_SURFACE_EMISSIVE_COLOUR 

Surface emissive colour, as set in Pass::setSelfIllumination.

ACT_SURFACE_SHININESS 

Surface shininess, as set in Pass::setShininess.

ACT_SURFACE_ALPHA_REJECTION_VALUE 

Surface alpha rejection value, not as set in Pass::setAlphaRejectionValue, but a floating number between 0.0f and 1.0f instead (255.0f / Pass::getAlphaRejectionValue())

ACT_LIGHT_COUNT 

The number of active light sources (better than gl_MaxLights)

ACT_AMBIENT_LIGHT_COLOUR 

The ambient light colour set in the scene.

ACT_LIGHT_DIFFUSE_COLOUR 

Light diffuse colour (index determined by setAutoConstant call)

ACT_LIGHT_SPECULAR_COLOUR 

Light specular colour (index determined by setAutoConstant call)

ACT_LIGHT_ATTENUATION 

Light attenuation parameters, Vector4(range, constant, linear, quadric)

ACT_SPOTLIGHT_PARAMS 

Spotlight parameters, Vector4(innerFactor, outerFactor, falloff, isSpot) innerFactor and outerFactor are cos(angle/2) The isSpot parameter is 0.0f for non-spotlights, 1.0f for spotlights.

Also for non-spotlights the inner and outer factors are 1 and nearly 1 respectively

ACT_LIGHT_POSITION 

A light position in world space (index determined by setAutoConstant call)

ACT_LIGHT_POSITION_OBJECT_SPACE 

A light position in object space (index determined by setAutoConstant call)

ACT_LIGHT_POSITION_VIEW_SPACE 

A light position in view space (index determined by setAutoConstant call)

ACT_LIGHT_DIRECTION 

A light direction in world space (index determined by setAutoConstant call)

ACT_LIGHT_DIRECTION_OBJECT_SPACE 

A light direction in object space (index determined by setAutoConstant call)

ACT_LIGHT_DIRECTION_VIEW_SPACE 

A light direction in view space (index determined by setAutoConstant call)

ACT_LIGHT_DISTANCE_OBJECT_SPACE 

The distance of the light from the center of the object a useful approximation as an alternative to per-vertex distance calculations.

ACT_LIGHT_POWER_SCALE 

Light power level, a single scalar as set in Light::setPowerScale (index determined by setAutoConstant call)

ACT_LIGHT_DIFFUSE_COLOUR_POWER_SCALED 

Light diffuse colour pre-scaled by Light::setPowerScale (index determined by setAutoConstant call)

ACT_LIGHT_SPECULAR_COLOUR_POWER_SCALED 

Light specular colour pre-scaled by Light::setPowerScale (index determined by setAutoConstant call)

ACT_LIGHT_DIFFUSE_COLOUR_ARRAY 

Array of light diffuse colours (count set by extra param)

ACT_LIGHT_SPECULAR_COLOUR_ARRAY 

Array of light specular colours (count set by extra param)

ACT_LIGHT_DIFFUSE_COLOUR_POWER_SCALED_ARRAY 

Array of light diffuse colours scaled by light power (count set by extra param)

ACT_LIGHT_SPECULAR_COLOUR_POWER_SCALED_ARRAY 

Array of light specular colours scaled by light power (count set by extra param)

ACT_LIGHT_ATTENUATION_ARRAY 

Array of light attenuation parameters, Vector4(range, constant, linear, quadric) (count set by extra param)

ACT_LIGHT_POSITION_ARRAY 

Array of light positions in world space (count set by extra param)

ACT_LIGHT_POSITION_OBJECT_SPACE_ARRAY 

Array of light positions in object space (count set by extra param)

ACT_LIGHT_POSITION_VIEW_SPACE_ARRAY 

Array of light positions in view space (count set by extra param)

ACT_LIGHT_DIRECTION_ARRAY 

Array of light directions in world space (count set by extra param)

ACT_LIGHT_DIRECTION_OBJECT_SPACE_ARRAY 

Array of light directions in object space (count set by extra param)

ACT_LIGHT_DIRECTION_VIEW_SPACE_ARRAY 

Array of light directions in view space (count set by extra param)

ACT_LIGHT_DISTANCE_OBJECT_SPACE_ARRAY 

Array of distances of the lights from the center of the object a useful approximation as an alternative to per-vertex distance calculations.

(count set by extra param)

ACT_LIGHT_POWER_SCALE_ARRAY 

Array of light power levels, a single scalar as set in Light::setPowerScale (count set by extra param)

ACT_SPOTLIGHT_PARAMS_ARRAY 

Spotlight parameters array of Vector4(innerFactor, outerFactor, falloff, isSpot) innerFactor and outerFactor are cos(angle/2) The isSpot parameter is 0.0f for non-spotlights, 1.0f for spotlights.

Also for non-spotlights the inner and outer factors are 1 and nearly 1 respectively. (count set by extra param)

ACT_DERIVED_AMBIENT_LIGHT_COLOUR 

The derived ambient light colour, with 'r', 'g', 'b' components filled with product of surface ambient colour and ambient light colour, respectively, and 'a' component filled with surface ambient alpha component.

ACT_DERIVED_SCENE_COLOUR 

The derived scene colour, with 'r', 'g' and 'b' components filled with sum of derived ambient light colour and surface emissive colour, respectively, and 'a' component filled with surface diffuse alpha component.

ACT_DERIVED_LIGHT_DIFFUSE_COLOUR 

The derived light diffuse colour (index determined by setAutoConstant call), with 'r', 'g' and 'b' components filled with product of surface diffuse colour, light power scale and light diffuse colour, respectively, and 'a' component filled with surface diffuse alpha component.

ACT_DERIVED_LIGHT_SPECULAR_COLOUR 

The derived light specular colour (index determined by setAutoConstant call), with 'r', 'g' and 'b' components filled with product of surface specular colour and light specular colour, respectively, and 'a' component filled with surface specular alpha component.

ACT_DERIVED_LIGHT_DIFFUSE_COLOUR_ARRAY 

Array of derived light diffuse colours (count set by extra param)

ACT_DERIVED_LIGHT_SPECULAR_COLOUR_ARRAY 

Array of derived light specular colours (count set by extra param)

ACT_LIGHT_NUMBER 

The absolute light number of a local light index.

Each pass may have a number of lights passed to it, and each of these lights will have an index in the overall light list, which will differ from the local light index due to factors like setStartLight and setIteratePerLight. This binding provides the global light index for a local index.

ACT_LIGHT_CASTS_SHADOWS 

Returns (int) 1 if the given light casts shadows, 0 otherwise (index set in extra param)

ACT_LIGHT_CASTS_SHADOWS_ARRAY 

Returns (int) 1 if the given light casts shadows, 0 otherwise (index set in extra param)

ACT_SHADOW_EXTRUSION_DISTANCE 

The distance a shadow volume should be extruded when using finite extrusion programs.

ACT_CAMERA_POSITION 

The current camera's position in world space.

ACT_CAMERA_POSITION_OBJECT_SPACE 

The current camera's position in object space.

ACT_TEXTURE_VIEWPROJ_MATRIX 

The view/projection matrix of the assigned texture projection frustum.

ACT_TEXTURE_VIEWPROJ_MATRIX_ARRAY 

Array of view/projection matrices of the first n texture projection frustums.

ACT_TEXTURE_WORLDVIEWPROJ_MATRIX 

The view/projection matrix of the assigned texture projection frustum, combined with the current world matrix.

ACT_TEXTURE_WORLDVIEWPROJ_MATRIX_ARRAY 

Array of world/view/projection matrices of the first n texture projection frustums.

ACT_SPOTLIGHT_VIEWPROJ_MATRIX 

The view/projection matrix of a given spotlight.

ACT_SPOTLIGHT_VIEWPROJ_MATRIX_ARRAY 

Array of view/projection matrix of a given spotlight.

ACT_SPOTLIGHT_WORLDVIEWPROJ_MATRIX 

The view/projection matrix of a given spotlight projection frustum, combined with the current world matrix.

ACT_SPOTLIGHT_WORLDVIEWPROJ_MATRIX_ARRAY 

An array of the view/projection matrix of a given spotlight projection frustum, combined with the current world matrix.

ACT_CUSTOM 

A custom parameter which will come from the renderable, using 'data' as the identifier.

ACT_TIME 

provides current elapsed time

ACT_TIME_0_X 

Single float value, which repeats itself based on given as parameter "cycle time".

Equivalent to RenderMonkey's "Time0_X".

ACT_COSTIME_0_X 

Cosine of "Time0_X". Equivalent to RenderMonkey's "CosTime0_X".

ACT_SINTIME_0_X 

Sine of "Time0_X". Equivalent to RenderMonkey's "SinTime0_X".

ACT_TANTIME_0_X 

Tangent of "Time0_X". Equivalent to RenderMonkey's "TanTime0_X".

ACT_TIME_0_X_PACKED 

Vector of "Time0_X", "SinTime0_X", "CosTime0_X", "TanTime0_X".

Equivalent to RenderMonkey's "Time0_X_Packed".

ACT_TIME_0_1 

Single float value, which represents scaled time value [0..1], which repeats itself based on given as parameter "cycle time".

Equivalent to RenderMonkey's "Time0_1".

ACT_COSTIME_0_1 

Cosine of "Time0_1". Equivalent to RenderMonkey's "CosTime0_1".

ACT_SINTIME_0_1 

Sine of "Time0_1". Equivalent to RenderMonkey's "SinTime0_1".

ACT_TANTIME_0_1 

Tangent of "Time0_1". Equivalent to RenderMonkey's "TanTime0_1".

ACT_TIME_0_1_PACKED 

Vector of "Time0_1", "SinTime0_1", "CosTime0_1", "TanTime0_1".

Equivalent to RenderMonkey's "Time0_1_Packed".

ACT_TIME_0_2PI 

Single float value, which represents scaled time value [0..2*Pi], which repeats itself based on given as parameter "cycle time".

Equivalent to RenderMonkey's "Time0_2PI".

ACT_COSTIME_0_2PI 

Cosine of "Time0_2PI". Equivalent to RenderMonkey's "CosTime0_2PI".

ACT_SINTIME_0_2PI 

Sine of "Time0_2PI". Equivalent to RenderMonkey's "SinTime0_2PI".

ACT_TANTIME_0_2PI 

Tangent of "Time0_2PI". Equivalent to RenderMonkey's "TanTime0_2PI".

ACT_TIME_0_2PI_PACKED 

Vector of "Time0_2PI", "SinTime0_2PI", "CosTime0_2PI", "TanTime0_2PI".

Equivalent to RenderMonkey's "Time0_2PI_Packed".

ACT_FRAME_TIME 

provides the scaled frame time, returned as a floating point value.

ACT_FPS 

provides the calculated frames per second, returned as a floating point value.

ACT_VIEWPORT_WIDTH 

viewport-related values

Current viewport width (in pixels) as floating point value. Equivalent to RenderMonkey's "ViewportWidth".

ACT_VIEWPORT_HEIGHT 

Current viewport height (in pixels) as floating point value.

Equivalent to RenderMonkey's "ViewportHeight".

ACT_INVERSE_VIEWPORT_WIDTH 

This variable represents 1.0/ViewportWidth.

Equivalent to RenderMonkey's "ViewportWidthInverse".

ACT_INVERSE_VIEWPORT_HEIGHT 

This variable represents 1.0/ViewportHeight.

Equivalent to RenderMonkey's "ViewportHeightInverse".

ACT_VIEWPORT_SIZE 

Packed of "ViewportWidth", "ViewportHeight", "ViewportWidthInverse", "ViewportHeightInverse".

ACT_VIEW_DIRECTION 

view parameters

This variable provides the view direction vector (world space). Equivalent to RenderMonkey's "ViewDirection".

ACT_VIEW_SIDE_VECTOR 

This variable provides the view side vector (world space).

Equivalent to RenderMonkey's "ViewSideVector".

ACT_VIEW_UP_VECTOR 

This variable provides the view up vector (world space).

Equivalent to RenderMonkey's "ViewUpVector".

ACT_FOV 

This variable provides the field of view as a floating point value.

Equivalent to RenderMonkey's "FOV".

ACT_NEAR_CLIP_DISTANCE 

This variable provides the near clip distance as a floating point value.

Equivalent to RenderMonkey's "NearClipPlane".

ACT_FAR_CLIP_DISTANCE 

This variable provides the far clip distance as a floating point value.

Equivalent to RenderMonkey's "FarClipPlane".

ACT_PASS_NUMBER 

provides the pass index number within the technique of the active materil.

ACT_PASS_ITERATION_NUMBER 

provides the current iteration number of the pass.

The iteration number is the number of times the current render operation has been drawn for the active pass.

ACT_ANIMATION_PARAMETRIC 

Provides a parametric animation value [0..1], only available where the renderable specifically implements it.

ACT_TEXEL_OFFSETS 

Provides the texel offsets required by this rendersystem to map texels to pixels.

Packed as float4(absoluteHorizontalOffset, absoluteVerticalOffset, horizontalOffset / viewportWidth, verticalOffset / viewportHeight)

ACT_SCENE_DEPTH_RANGE 

Provides information about the depth range of the scene as viewed from the current camera.

Passed as float4(minDepth, maxDepth, depthRange, 1 / depthRange)

ACT_SHADOW_SCENE_DEPTH_RANGE 

Provides information about the depth range of the scene as viewed from a given shadow camera.

Requires an index parameter which maps to a light index relative to the current light list. Passed as float4(minDepth, maxDepth, depthRange, 1 / depthRange)

ACT_SHADOW_SCENE_DEPTH_RANGE_ARRAY 

Provides an array of information about the depth range of the scene as viewed from a given shadow camera.

Requires an index parameter which maps to a light index relative to the current light list. Passed as float4(minDepth, maxDepth, depthRange, 1 / depthRange)

ACT_SHADOW_COLOUR 

Provides the fixed shadow colour as configured via SceneManager::setShadowColour; useful for integrated modulative shadows.

ACT_TEXTURE_SIZE 

Provides texture size of the texture unit (index determined by setAutoConstant call).

Packed as float4(width, height, depth, 1)

ACT_INVERSE_TEXTURE_SIZE 

Provides inverse texture size of the texture unit (index determined by setAutoConstant call).

Packed as float4(1 / width, 1 / height, 1 / depth, 1)

ACT_PACKED_TEXTURE_SIZE 

Provides packed texture size of the texture unit (index determined by setAutoConstant call).

Packed as float4(width, height, 1 / width, 1 / height)

ACT_TEXTURE_MATRIX 

Provides the current transform matrix of the texture unit (index determined by setAutoConstant call), as seen by the fixed-function pipeline.

ACT_LOD_CAMERA_POSITION 

Provides the position of the LOD camera in world space, allowing you to perform separate LOD calculations in shaders independent of the rendering camera.

If there is no separate LOD camera then this is the real camera position. See Camera::setLodCamera.

ACT_LOD_CAMERA_POSITION_OBJECT_SPACE 

Provides the position of the LOD camera in object space, allowing you to perform separate LOD calculations in shaders independent of the rendering camera.

If there is no separate LOD camera then this is the real camera position. See Camera::setLodCamera.

ACT_LIGHT_CUSTOM 

Binds custom per-light constants to the shaders.

ACT_UNKNOWN 

Definition at line 708 of file OgreGpuProgramParams.h.

The type of unit to bind the texture settings to.

Enumerator
BT_FRAGMENT 

Regular fragment processing unit - the default.

BT_VERTEX 

Vertex processing unit - indicates this unit will be used for a vertex texture fetch.

BT_GEOMETRY 

Geometry processing unit.

BT_TESSELATION_HULL 

Tesselation control processing unit.

BT_TESSELATION_DOMAIN 

Tesselation evaluation processing unit.

BT_COMPUTE 

Compute processing unit.

Definition at line 468 of file OgreTextureUnitState.h.

There are some default hash functions used to order passes so that render state changes are minimised, this enumerates them.

Enumerator
MIN_TEXTURE_CHANGE 

Try to minimise the number of texture changes.

MIN_GPU_PROGRAM_CHANGE 

Try to minimise the number of GPU program changes.

Note
Only really useful if you use GPU programs for all of your materials.

Definition at line 1704 of file OgrePass.h.

Enum identifying the type of content this texture unit contains.

Enumerator
CONTENT_NAMED 

Normal texture identified by name.

CONTENT_SHADOW 

A shadow texture, automatically bound by engine.

CONTENT_COMPOSITOR 

A compositor texture, automatically linked to active viewport's chain.

Definition at line 487 of file OgreTextureUnitState.h.

Defines the base element type of the auto constant.

Enumerator
ET_INT 
ET_REAL 

Definition at line 1186 of file OgreGpuProgramParams.h.

Enumeration to specify type of envmap.

Note
Note that these have no effect when using the programmable pipeline, since their effect is overridden by the vertex / fragment programs.
Enumerator
ENV_PLANAR 

Envmap based on vector from camera to vertex position, good for planar geometry.

ENV_CURVED 

Envmap based on dot of vector from camera to vertex and vertex normal, good for curves.

ENV_REFLECTION 

Envmap intended to supply reflection vectors for cube mapping.

ENV_NORMAL 

Envmap intended to supply normal vectors for cube mapping.

Definition at line 95 of file OgreTextureUnitState.h.

Enum for type of texture play mode.

Enumerator
TextureEffectPause 
TextureEffectPlay_ASAP 

Video starts out paused.

TextureEffectPlay_Looping 

Video starts playing as soon as possible.

Definition at line 60 of file OgreExternalTextureSource.h.

Enumeration of the types of constant we may encounter in programs.

Note
Low-level programs, by definition, will always use either float4 or int4 constant types since that is the fundamental underlying type in assembler.
Enumerator
GCT_FLOAT1 
GCT_FLOAT2 
GCT_FLOAT3 
GCT_FLOAT4 
GCT_SAMPLER1D 
GCT_SAMPLER2D 
GCT_SAMPLER3D 
GCT_SAMPLERCUBE 
GCT_SAMPLERRECT 
GCT_SAMPLER1DSHADOW 
GCT_SAMPLER2DSHADOW 
GCT_SAMPLER2DARRAY 
GCT_MATRIX_2X2 
GCT_MATRIX_2X3 
GCT_MATRIX_2X4 
GCT_MATRIX_3X2 
GCT_MATRIX_3X3 
GCT_MATRIX_3X4 
GCT_MATRIX_4X2 
GCT_MATRIX_4X3 
GCT_MATRIX_4X4 
GCT_INT1 
GCT_INT2 
GCT_INT3 
GCT_INT4 
GCT_SUBROUTINE 
GCT_DOUBLE1 
GCT_DOUBLE2 
GCT_DOUBLE3 
GCT_DOUBLE4 
GCT_MATRIX_DOUBLE_2X2 
GCT_MATRIX_DOUBLE_2X3 
GCT_MATRIX_DOUBLE_2X4 
GCT_MATRIX_DOUBLE_3X2 
GCT_MATRIX_DOUBLE_3X3 
GCT_MATRIX_DOUBLE_3X4 
GCT_MATRIX_DOUBLE_4X2 
GCT_MATRIX_DOUBLE_4X3 
GCT_MATRIX_DOUBLE_4X4 
GCT_UNKNOWN 

Definition at line 54 of file OgreGpuProgramParams.h.

The variability of a GPU parameter, as derived from auto-params targeting it.

These values must be powers of two since they are used in masks.

Enumerator
GPV_GLOBAL 

No variation except by manual setting - the default.

GPV_PER_OBJECT 

Varies per object (based on an auto param usually), but not per light setup.

GPV_LIGHTS 

Varies with light setup.

GPV_PASS_ITERATION_NUMBER 

Varies with pass iteration number.

GPV_ALL 

Full mask (16-bit)

Definition at line 101 of file OgreGpuProgramParams.h.

Illumination pass state type.

Enumerator
IPS_COMPILE_DISABLED 
IPS_NOT_COMPILED 
IPS_COMPILED 

Definition at line 57 of file OgreTechnique.h.

Categorisation of passes for the purpose of additive lighting.

Enumerator
IS_AMBIENT 

Part of the rendering which occurs without any kind of direct lighting.

IS_PER_LIGHT 

Part of the rendering which occurs per light.

IS_DECAL 

Post-lighting rendering.

IS_UNKNOWN 

Not determined.

Definition at line 49 of file OgrePass.h.

Directive used to manually control technique support based on the inclusion or exclusion of some factor.

Enumerator
INCLUDE 

Inclusive - only support if present.

EXCLUDE 

Exclusive - do not support if present.

Definition at line 116 of file OgreTechnique.h.

List of valid texture blending operations, for use with TextureUnitState::setColourOperation.

Remarks
This list is a more limited list than LayerBlendOperationEx because it only includes operations that are supportable in both multipass and multitexture rendering and thus provides automatic fallback if multitexture hardware is lacking or insufficient.
Enumerator
LBO_REPLACE 

Replace all colour with texture with no adjustment.

LBO_ADD 

Add colour components together.

LBO_MODULATE 

Multiply colour components together.

LBO_ALPHA_BLEND 

Blend based on texture alpha.

Definition at line 57 of file OgreBlendMode.h.

Expert list of valid texture blending operations, for use with TextureUnitState::setColourOperationEx and TextureUnitState::setAlphaOperation, and internally in the LayerBlendModeEx class.

It's worth noting that these operations are for blending between texture layers and not between rendered objects and the existing scene. Because all of these modes are only supported in multitexture hardware it may be required to set up a fallback operation where this hardware is not available.

Enumerator
LBX_SOURCE1 

use source1 without modification

LBX_SOURCE2 

use source2 without modification

LBX_MODULATE 

multiply source1 and source2 together

LBX_MODULATE_X2 

as LBX_MODULATE but brighten afterwards (x2)

LBX_MODULATE_X4 

as LBX_MODULATE but brighten more afterwards (x4)

LBX_ADD 

add source1 and source2 together

LBX_ADD_SIGNED 

as LBX_ADD, but subtract 0.5 from the result

LBX_ADD_SMOOTH 

as LBX_ADD, but subtract product from the sum

LBX_SUBTRACT 

subtract source2 from source1

LBX_BLEND_DIFFUSE_ALPHA 

use interpolated alpha value from vertices to scale source1, then add source2 scaled by (1-alpha)

LBX_BLEND_TEXTURE_ALPHA 

as LBX_BLEND_DIFFUSE_ALPHA, but use alpha from texture

LBX_BLEND_CURRENT_ALPHA 

as LBX_BLEND_DIFFUSE_ALPHA, but use current alpha from previous stages

LBX_BLEND_MANUAL 

as LBX_BLEND_DIFFUSE_ALPHA but use a constant manual blend value (0.0-1.0)

LBX_DOTPRODUCT 

dot product of color1 and color2

LBX_BLEND_DIFFUSE_COLOUR 

use interpolated color values from vertices to scale source1, then add source2 scaled by (1-color)

Definition at line 75 of file OgreBlendMode.h.

List of valid sources of values for blending operations used in TextureUnitState::setColourOperation and TextureUnitState::setAlphaOperation, and internally in the LayerBlendModeEx class.

Enumerator
LBS_CURRENT 

the colour as built up from previous stages

LBS_TEXTURE 

the colour derived from the texture assigned to this layer

LBS_DIFFUSE 

the interpolated diffuse colour from the vertices

LBS_SPECULAR 

the interpolated specular colour from the vertices

LBS_MANUAL 

a colour supplied manually as a separate argument

Definition at line 112 of file OgreBlendMode.h.

Type of texture blend mode.

Enumerator
LBT_COLOUR 
LBT_ALPHA 

Definition at line 44 of file OgreBlendMode.h.

Enum to identify material sections.

Enumerator
MSS_NONE 
MSS_MATERIAL 
MSS_TECHNIQUE 
MSS_PASS 
MSS_TEXTUREUNIT 
MSS_PROGRAM_REF 
MSS_PROGRAM 
MSS_DEFAULT_PARAMETERS 
MSS_TEXTURESOURCE 

Definition at line 48 of file OgreMaterialSerializer.h.

Blending factors for manually blending objects with the scene.

If there isn't a predefined SceneBlendType that you like, then you can specify the blending factors directly to affect the combination of object and the existing scene. See Material::setSceneBlending for more details.

Enumerator
SBF_ONE 
SBF_ZERO 
SBF_DEST_COLOUR 
SBF_SOURCE_COLOUR 
SBF_ONE_MINUS_DEST_COLOUR 
SBF_ONE_MINUS_SOURCE_COLOUR 
SBF_DEST_ALPHA 
SBF_SOURCE_ALPHA 
SBF_ONE_MINUS_DEST_ALPHA 
SBF_ONE_MINUS_SOURCE_ALPHA 

Definition at line 234 of file OgreBlendMode.h.

Blending operations controls how objects are blended into the scene.

The default operation is add (+) but by changing this you can change how drawn objects are blended into the existing scene.

Enumerator
SBO_ADD 
SBO_SUBTRACT 
SBO_REVERSE_SUBTRACT 
SBO_MIN 
SBO_MAX 

Definition at line 253 of file OgreBlendMode.h.

Types of blending that you can specify between an object and the existing contents of the scene.

Remarks
As opposed to the LayerBlendType, which classifies blends between texture layers, these blending types blend between the output of the texture units and the pixels already in the viewport, allowing for object transparency, glows, etc.
These types are provided to give quick and easy access to common effects. You can also use the more manual method of supplying source and destination blending factors. See Material::setSceneBlending for more details.
See also
Material::setSceneBlending
Enumerator
SBT_TRANSPARENT_ALPHA 

Make the object transparent based on the final alpha values in the texture.

SBT_TRANSPARENT_COLOUR 

Make the object transparent based on the colour values in the texture (brighter = more opaque)

SBT_ADD 

Add the texture values to the existing scene content.

SBT_MODULATE 

Multiply the 2 colours together.

SBT_REPLACE 

The default blend mode where source replaces destination.

Definition at line 215 of file OgreBlendMode.h.

Enumerator
MSE_PRE_WRITE 
MSE_WRITE_BEGIN 
MSE_WRITE_END 
MSE_POST_WRITE 

Definition at line 111 of file OgreMaterialSerializer.h.

Texture addressing modes - default is TAM_WRAP.

Note
These settings are relevant in both the fixed-function and the programmable pipeline.
Enumerator
TAM_WRAP 

Texture wraps at values over 1.0.

TAM_MIRROR 

Texture mirrors (flips) at joins over 1.0.

TAM_CLAMP 

Texture clamps at 1.0.

TAM_BORDER 

Texture coordinates outside the range [0.0, 1.0] are set to the border colour.

TAM_UNKNOWN 

Unknown.

Definition at line 126 of file OgreTextureUnitState.h.

Enum identifying the frame indexes for faces of a cube map (not the composite 3D type.

Enumerator
CUBE_FRONT 
CUBE_BACK 
CUBE_LEFT 
CUBE_RIGHT 
CUBE_UP 
CUBE_DOWN 

Definition at line 148 of file OgreTextureUnitState.h.

Definition of the broad types of texture effect you can apply to a texture unit.

Note
Note that these have no effect when using the programmable pipeline, since their effect is overridden by the vertex / fragment programs.
Enumerator
ET_ENVIRONMENT_MAP 

Generate all texture coords based on angle between camera and vertex.

ET_PROJECTIVE_TEXTURE 

Generate texture coords based on a frustum.

ET_UVSCROLL 

Constant u/v scrolling effect.

ET_USCROLL 

Constant u scrolling effect.

ET_VSCROLL 

Constant u/v scrolling effect.

ET_ROTATE 

Constant rotation.

ET_TRANSFORM 

More complex transform.

Definition at line 71 of file OgreTextureUnitState.h.

Useful enumeration when dealing with procedural transforms.

Note
Note that these have no effect when using the programmable pipeline, since their effect is overridden by the vertex / fragment programs.
Enumerator
TT_TRANSLATE_U 
TT_TRANSLATE_V 
TT_SCALE_U 
TT_SCALE_V 
TT_ROTATE 

Definition at line 112 of file OgreTextureUnitState.h.


Copyright © 2012 Torus Knot Software Ltd
Creative Commons License
This work is licensed under a Creative Commons Attribution-ShareAlike 3.0 Unported License.