Ogre::ShadowVolumeExtrudeProgram Class Reference
[Scene]

Static class containing source for vertex programs for extruding shadow volumes. More...

#include <OgreShadowVolumeExtrudeProgram.h>

Inheritance diagram for Ogre::ShadowVolumeExtrudeProgram:

Public Types
enum	Programs { POINT_LIGHT = 0, POINT_LIGHT_DEBUG = 1, DIRECTIONAL_LIGHT = 2, DIRECTIONAL_LIGHT_DEBUG = 3, POINT_LIGHT_FINITE = 4, POINT_LIGHT_FINITE_DEBUG = 5, DIRECTIONAL_LIGHT_FINITE = 6, DIRECTIONAL_LIGHT_FINITE_DEBUG = 7 }
Public Member Functions
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 *)
Static Public Member Functions
static void	initialise (void)
	Initialise the creation of these vertex programs.
static void	shutdown (void)
	Shutdown & destroy the vertex programs.
static const String &	getPointLightExtruderArbvp1 (void)
	Get extruder program source for point lights, compatible with arbvp1.
static const String &	getPointLightExtruderVs_1_1 (void)
	Get extruder program source for point lights, compatible with vs_1_1.
static const String &	getPointLightExtruderVs_4_0 (void)
	Get extruder program source for point lights, compatible with vs_4_0.
static const String &	getPointLightExtruderVs_glsles (void)
	Get extruder program source for point lights, compatible with glsles.
static const String &	getDirectionalLightExtruderArbvp1 (void)
	Get extruder program source for directional lights, compatible with arbvp1.
static const String &	getDirectionalLightExtruderVs_1_1 (void)
	Get extruder program source for directional lights, compatible with vs_1_1.
static const String &	getDirectionalLightExtruderVs_4_0 (void)
	Get extruder program source for directional lights, compatible with vs_4_0.
static const String &	getDirectionalLightExtruderVs_glsles (void)
	Get extruder program source for directional lights, compatible with glsles.
static const String &	getPointLightExtruderArbvp1Debug (void)
	Get extruder program source for debug point lights, compatible with arbvp1.
static const String &	getPointLightExtruderVs_1_1Debug (void)
	Get extruder program source for debug point lights, compatible with vs_1_1.
static const String &	getPointLightExtruderVs_4_0Debug (void)
	Get extruder program source for debug point lights, compatible with vs_4_0.
static const String &	getPointLightExtruderVs_glslesDebug (void)
	Get extruder program source for debug point lights, compatible with glsles.
static const String &	getDirectionalLightExtruderArbvp1Debug (void)
	Get extruder program source for debug directional lights, compatible with arbvp1.
static const String &	getDirectionalLightExtruderVs_1_1Debug (void)
	Get extruder program source for debug directional lights, compatible with vs_1_1.
static const String &	getDirectionalLightExtruderVs_4_0Debug (void)
	Get extruder program source for debug directional lights, compatible with vs_4_0.
static const String &	getDirectionalLightExtruderVs_glslesDebug (void)
	Get extruder program source for debug directional lights, compatible with glsles.
static const String &	getProgramSource (Light::LightTypes lightType, const String syntax, bool finite, bool debug)
	General purpose method to get any of the program sources.
static const String &	getProgramName (Light::LightTypes lightType, bool finite, bool debug)
static const String &	getPointLightExtruderArbvp1Finite (void)
	Get FINITE extruder program source for point lights, compatible with arbvp1.
static const String &	getPointLightExtruderVs_1_1Finite (void)
	Get FINITE extruder program source for point lights, compatible with vs_1_1.
static const String &	getPointLightExtruderVs_4_0Finite (void)
	Get FINITE extruder program source for point lights, compatible with vs_4_0.
static const String &	getPointLightExtruderVs_glslesFinite (void)
	Get FINITE extruder program source for point lights, compatible with glsles.
static const String &	getDirectionalLightExtruderArbvp1Finite (void)
	Get FINITE extruder program source for directional lights, compatible with arbvp1.
static const String &	getDirectionalLightExtruderVs_1_1Finite (void)
	Get FINITE extruder program source for directional lights, compatible with vs_1_1.
static const String &	getDirectionalLightExtruderVs_4_0Finite (void)
	Get FINITE extruder program source for directional lights, compatible with vs_4_0.
static const String &	getDirectionalLightExtruderVs_glslesFinite (void)
	Get FINITE extruder program source for directional lights, compatible with glsles.
static const String &	getPointLightExtruderArbvp1FiniteDebug (void)
	Get FINITE extruder program source for debug point lights, compatible with arbvp1.
static const String &	getPointLightExtruderVs_1_1FiniteDebug (void)
	Get extruder program source for debug point lights, compatible with vs_1_1.
static const String &	getPointLightExtruderVs_4_0FiniteDebug (void)
	Get extruder program source for debug point lights, compatible with vs_4_0.
static const String &	getPointLightExtruderVs_glslesFiniteDebug (void)
	Get extruder program source for debug point lights, compatible with glsles.
static const String &	getDirectionalLightExtruderArbvp1FiniteDebug (void)
	Get FINITE extruder program source for debug directional lights, compatible with arbvp1.
static const String &	getDirectionalLightExtruderVs_1_1FiniteDebug (void)
	Get FINITE extruder program source for debug directional lights, compatible with vs_1_1.
static const String &	getDirectionalLightExtruderVs_4_0FiniteDebug (void)
	Get FINITE extruder program source for debug directional lights, compatible with vs_4_0.
static const String &	getDirectionalLightExtruderVs_glslesFiniteDebug (void)
	Get FINITE extruder program source for debug directional lights, compatible with glsles.
Static Public Attributes
static const String	programNames [OGRE_NUM_SHADOW_EXTRUDER_PROGRAMS]
static String	frgProgramName
Static Private Attributes
static String	mPointArbvp1
static String	mPointVs_1_1
static String	mPointVs_4_0
static String	mPointVs_glsles
static String	mDirArbvp1
static String	mDirVs_1_1
static String	mDirVs_4_0
static String	mDirVs_glsles
static String	mPointArbvp1Debug
static String	mPointVs_1_1Debug
static String	mPointVs_4_0Debug
static String	mPointVs_glslesDebug
static String	mDirArbvp1Debug
static String	mDirVs_1_1Debug
static String	mDirVs_4_0Debug
static String	mDirVs_glslesDebug
static String	mPointArbvp1Finite
static String	mPointVs_1_1Finite
static String	mPointVs_4_0Finite
static String	mPointVs_glslesFinite
static String	mDirArbvp1Finite
static String	mDirVs_1_1Finite
static String	mDirVs_4_0Finite
static String	mDirVs_glslesFinite
static String	mPointArbvp1FiniteDebug
static String	mPointVs_1_1FiniteDebug
static String	mPointVs_4_0FiniteDebug
static String	mPointVs_glslesFiniteDebug
static String	mDirArbvp1FiniteDebug
static String	mDirVs_1_1FiniteDebug
static String	mDirVs_4_0FiniteDebug
static String	mDirVs_glslesFiniteDebug
static String	mGeneralFs_4_0
static String	mGeneralFs_glsles
static bool	mInitialised

Detailed Description

Static class containing source for vertex programs for extruding shadow volumes.

Remarks:

This exists so we don't have to be dependent on an external media files. Assembler is used so we don't have to rely on particular plugins. The assembler contents of this file were generated from the following Cg:

        // Point light shadow volume extrude
        void shadowVolumeExtrudePointLight_vp (
            float4 position         : POSITION,
            float  wcoord           : TEXCOORD0,

            out float4 oPosition    : POSITION,

            uniform float4x4 worldViewProjMatrix,
            uniform float4   lightPos // homogeneous, object space
            )
        {
            // extrusion in object space
            // vertex unmodified if w==1, extruded if w==0
            float4 newpos = 
                (wcoord.xxxx * lightPos) + 
                float4(position.xyz - lightPos.xyz, 0);

            oPosition = mul(worldViewProjMatrix, newpos);

        }

        // Directional light extrude
        void shadowVolumeExtrudeDirLight_vp (
            float4 position         : POSITION,
            float  wcoord           : TEXCOORD0,

            out float4 oPosition    : POSITION,

            uniform float4x4 worldViewProjMatrix,
            uniform float4   lightPos // homogenous, object space
            )
        {
            // extrusion in object space
            // vertex unmodified if w==1, extruded if w==0
            float4 newpos = 
                (wcoord.xxxx * (position + lightPos)) - lightPos;

            oPosition = mul(worldViewProjMatrix, newpos);

        }
        // Point light shadow volume extrude - FINITE
        void shadowVolumeExtrudePointLightFinite_vp (
            float4 position         : POSITION,
            float  wcoord           : TEXCOORD0,

            out float4 oPosition    : POSITION,

            uniform float4x4 worldViewProjMatrix,
            uniform float4   lightPos, // homogeneous, object space
            uniform float    extrusionDistance // how far to extrude
            )
        {
            // extrusion in object space
            // vertex unmodified if w==1, extruded if w==0
            float3 extrusionDir = position.xyz - lightPos.xyz;
            extrusionDir = normalize(extrusionDir);
            
            float4 newpos = float4(position.xyz +  
                ((1 - wcoord.x) * extrusionDistance * extrusionDir), 1);

            oPosition = mul(worldViewProjMatrix, newpos);

        }

        // Directional light extrude - FINITE
        void shadowVolumeExtrudeDirLightFinite_vp (
            float4 position         : POSITION,
            float  wcoord           : TEXCOORD0,

            out float4 oPosition    : POSITION,

            uniform float4x4 worldViewProjMatrix,
            uniform float4   lightPos, // homogeneous, object space
            uniform float    extrusionDistance // how far to extrude
            )
        {
            // extrusion in object space
            // vertex unmodified if w==1, extruded if w==0
            // -ve lightPos is direction
            float4 newpos = float4(position.xyz - 
                (wcoord.x * extrusionDistance * lightPos.xyz), 1);

            oPosition = mul(worldViewProjMatrix, newpos);

        }

Definition at line 135 of file OgreShadowVolumeExtrudeProgram.h.

Member Enumeration Documentation

enum Ogre::ShadowVolumeExtrudeProgram::Programs

Enumerator:

POINT_LIGHT
POINT_LIGHT_DEBUG
DIRECTIONAL_LIGHT
DIRECTIONAL_LIGHT_DEBUG
POINT_LIGHT_FINITE
POINT_LIGHT_FINITE_DEBUG
DIRECTIONAL_LIGHT_FINITE
DIRECTIONAL_LIGHT_FINITE_DEBUG

Definition at line 181 of file OgreShadowVolumeExtrudeProgram.h.

Member Function Documentation

static const String& Ogre::ShadowVolumeExtrudeProgram::getDirectionalLightExtruderArbvp1 ( void ) [static]

Get extruder program source for directional lights, compatible with arbvp1.

Definition at line 217 of file OgreShadowVolumeExtrudeProgram.h.

static const String& Ogre::ShadowVolumeExtrudeProgram::getDirectionalLightExtruderArbvp1Debug ( void ) [static]

Get extruder program source for debug directional lights, compatible with arbvp1.

Definition at line 234 of file OgreShadowVolumeExtrudeProgram.h.

static const String& Ogre::ShadowVolumeExtrudeProgram::getDirectionalLightExtruderArbvp1Finite ( void ) [static]

Get FINITE extruder program source for directional lights, compatible with arbvp1.

Definition at line 257 of file OgreShadowVolumeExtrudeProgram.h.

static const String& Ogre::ShadowVolumeExtrudeProgram::getDirectionalLightExtruderArbvp1FiniteDebug ( void ) [static]

Get FINITE extruder program source for debug directional lights, compatible with arbvp1.

Definition at line 274 of file OgreShadowVolumeExtrudeProgram.h.

static const String& Ogre::ShadowVolumeExtrudeProgram::getDirectionalLightExtruderVs_1_1 ( void ) [static]

Get extruder program source for directional lights, compatible with vs_1_1.

Definition at line 219 of file OgreShadowVolumeExtrudeProgram.h.

static const String& Ogre::ShadowVolumeExtrudeProgram::getDirectionalLightExtruderVs_1_1Debug ( void ) [static]

Get extruder program source for debug directional lights, compatible with vs_1_1.

Definition at line 236 of file OgreShadowVolumeExtrudeProgram.h.

static const String& Ogre::ShadowVolumeExtrudeProgram::getDirectionalLightExtruderVs_1_1Finite ( void ) [static]

Get FINITE extruder program source for directional lights, compatible with vs_1_1.

Definition at line 259 of file OgreShadowVolumeExtrudeProgram.h.

static const String& Ogre::ShadowVolumeExtrudeProgram::getDirectionalLightExtruderVs_1_1FiniteDebug ( void ) [static]

Get FINITE extruder program source for debug directional lights, compatible with vs_1_1.

Definition at line 276 of file OgreShadowVolumeExtrudeProgram.h.

static const String& Ogre::ShadowVolumeExtrudeProgram::getDirectionalLightExtruderVs_4_0 ( void ) [static]

Get extruder program source for directional lights, compatible with vs_4_0.

Definition at line 221 of file OgreShadowVolumeExtrudeProgram.h.

static const String& Ogre::ShadowVolumeExtrudeProgram::getDirectionalLightExtruderVs_4_0Debug ( void ) [static]

Get extruder program source for debug directional lights, compatible with vs_4_0.

Definition at line 238 of file OgreShadowVolumeExtrudeProgram.h.

static const String& Ogre::ShadowVolumeExtrudeProgram::getDirectionalLightExtruderVs_4_0Finite ( void ) [static]

Get FINITE extruder program source for directional lights, compatible with vs_4_0.

Definition at line 261 of file OgreShadowVolumeExtrudeProgram.h.

static const String& Ogre::ShadowVolumeExtrudeProgram::getDirectionalLightExtruderVs_4_0FiniteDebug ( void ) [static]

Get FINITE extruder program source for debug directional lights, compatible with vs_4_0.

Definition at line 278 of file OgreShadowVolumeExtrudeProgram.h.

static const String& Ogre::ShadowVolumeExtrudeProgram::getDirectionalLightExtruderVs_glsles ( void ) [static]

Get extruder program source for directional lights, compatible with glsles.

Definition at line 223 of file OgreShadowVolumeExtrudeProgram.h.

static const String& Ogre::ShadowVolumeExtrudeProgram::getDirectionalLightExtruderVs_glslesDebug ( void ) [static]

Get extruder program source for debug directional lights, compatible with glsles.

Definition at line 240 of file OgreShadowVolumeExtrudeProgram.h.

static const String& Ogre::ShadowVolumeExtrudeProgram::getDirectionalLightExtruderVs_glslesFinite ( void ) [static]

Get FINITE extruder program source for directional lights, compatible with glsles.

Definition at line 263 of file OgreShadowVolumeExtrudeProgram.h.

static const String& Ogre::ShadowVolumeExtrudeProgram::getDirectionalLightExtruderVs_glslesFiniteDebug ( void ) [static]

Get FINITE extruder program source for debug directional lights, compatible with glsles.

Definition at line 280 of file OgreShadowVolumeExtrudeProgram.h.

static const String& Ogre::ShadowVolumeExtrudeProgram::getPointLightExtruderArbvp1 ( void ) [static]

Get extruder program source for point lights, compatible with arbvp1.

Definition at line 209 of file OgreShadowVolumeExtrudeProgram.h.

static const String& Ogre::ShadowVolumeExtrudeProgram::getPointLightExtruderArbvp1Debug ( void ) [static]

Get extruder program source for debug point lights, compatible with arbvp1.

Definition at line 226 of file OgreShadowVolumeExtrudeProgram.h.

static const String& Ogre::ShadowVolumeExtrudeProgram::getPointLightExtruderArbvp1Finite ( void ) [static]

Get FINITE extruder program source for point lights, compatible with arbvp1.

Definition at line 249 of file OgreShadowVolumeExtrudeProgram.h.

static const String& Ogre::ShadowVolumeExtrudeProgram::getPointLightExtruderArbvp1FiniteDebug ( void ) [static]

Get FINITE extruder program source for debug point lights, compatible with arbvp1.

Definition at line 266 of file OgreShadowVolumeExtrudeProgram.h.

static const String& Ogre::ShadowVolumeExtrudeProgram::getPointLightExtruderVs_1_1 ( void ) [static]

Get extruder program source for point lights, compatible with vs_1_1.

Definition at line 211 of file OgreShadowVolumeExtrudeProgram.h.

static const String& Ogre::ShadowVolumeExtrudeProgram::getPointLightExtruderVs_1_1Debug ( void ) [static]

Get extruder program source for debug point lights, compatible with vs_1_1.

Definition at line 228 of file OgreShadowVolumeExtrudeProgram.h.

static const String& Ogre::ShadowVolumeExtrudeProgram::getPointLightExtruderVs_1_1Finite ( void ) [static]

Get FINITE extruder program source for point lights, compatible with vs_1_1.

Definition at line 251 of file OgreShadowVolumeExtrudeProgram.h.

static const String& Ogre::ShadowVolumeExtrudeProgram::getPointLightExtruderVs_1_1FiniteDebug ( void ) [static]

Get extruder program source for debug point lights, compatible with vs_1_1.

Definition at line 268 of file OgreShadowVolumeExtrudeProgram.h.

static const String& Ogre::ShadowVolumeExtrudeProgram::getPointLightExtruderVs_4_0 ( void ) [static]

Get extruder program source for point lights, compatible with vs_4_0.

Definition at line 213 of file OgreShadowVolumeExtrudeProgram.h.

static const String& Ogre::ShadowVolumeExtrudeProgram::getPointLightExtruderVs_4_0Debug ( void ) [static]

Get extruder program source for debug point lights, compatible with vs_4_0.

Definition at line 230 of file OgreShadowVolumeExtrudeProgram.h.

static const String& Ogre::ShadowVolumeExtrudeProgram::getPointLightExtruderVs_4_0Finite ( void ) [static]

Get FINITE extruder program source for point lights, compatible with vs_4_0.

Definition at line 253 of file OgreShadowVolumeExtrudeProgram.h.

static const String& Ogre::ShadowVolumeExtrudeProgram::getPointLightExtruderVs_4_0FiniteDebug ( void ) [static]

Get extruder program source for debug point lights, compatible with vs_4_0.

Definition at line 270 of file OgreShadowVolumeExtrudeProgram.h.

static const String& Ogre::ShadowVolumeExtrudeProgram::getPointLightExtruderVs_glsles ( void ) [static]

Get extruder program source for point lights, compatible with glsles.

Definition at line 215 of file OgreShadowVolumeExtrudeProgram.h.

static const String& Ogre::ShadowVolumeExtrudeProgram::getPointLightExtruderVs_glslesDebug ( void ) [static]

Get extruder program source for debug point lights, compatible with glsles.

Definition at line 232 of file OgreShadowVolumeExtrudeProgram.h.

static const String& Ogre::ShadowVolumeExtrudeProgram::getPointLightExtruderVs_glslesFinite ( void ) [static]

Get FINITE extruder program source for point lights, compatible with glsles.

Definition at line 255 of file OgreShadowVolumeExtrudeProgram.h.

static const String& Ogre::ShadowVolumeExtrudeProgram::getPointLightExtruderVs_glslesFiniteDebug ( void ) [static]

Get extruder program source for debug point lights, compatible with glsles.

Definition at line 272 of file OgreShadowVolumeExtrudeProgram.h.

static const String& Ogre::ShadowVolumeExtrudeProgram::getProgramName	(	Light::LightTypes	lightType,
		bool	finite,
		bool	debug
	)			`[static]`

static const String& Ogre::ShadowVolumeExtrudeProgram::getProgramSource	(	Light::LightTypes	lightType,
		const String	syntax,
		bool	finite,
		bool	debug
	)			`[static]`