Table of contents
Beginners guide to Depth Shadow Mapping
This short guide is intended to help those who have limited knowledge of shaders and want to implement Depth Shadow Mapping into their ogre application as shown in the Shadows demo.
I'm going to assume you have already read the Basic Tutorial 2 about shadows, if you have not please do so now (Basic Tutorial 2). Depth Shadow Mapping is done using texture shadows, and is basically an extension of what you get from just using setShadowTechnique(SHADOWTYPE_TEXTURE_ADDITIVE). The problems with setting SHADOWTYPE_TEXTURE_ADDITIVE alone are:
- You need to separate shadow casters from shadow receivers
- Shadow casters cannot receive shadows (thus self-shadowing is not possible)
- You will see shadows where there shouldn't be any if you shadow receiver ever gets between a shadow caster and the light source
Depth Shadow Mapping can be used to solve all of these issues, however it requires using shaders which can be difficult for those not familiar with them. My aim is to give a step by step guide on how to implement the shaders without giving all the details and theory behind the technique (these details can be found elsewhere, see links at the bottom of the page).
The first step is to get shadows working as described in Basic Tutorial 2 using the SHADOWTYPE_TEXTURE_ADDITIVE technique.
Once you have done this, the following additional steps must be followed:
- Define the necessary shaders (2 fragment programs and 2 vertex programs for casting and receiving shadows + at least 1 custom shader)
- Define the necessary materials (1 generic material for casting shadows, materials for all the entities you want shadows to be cast on)
- Make a few modifications to the C++ code to set up shadows
Defining the shaders
The shaders used in the Shadows demo are stored in the ogre folder under Samples/Media/materials/programs and have file names starting with "DepthShadowmap". In fact each shader is implemented twice, once for OpenGL and once for DirectX. I am going to present the shaders written in Cg instead so that you only need to define each shader once (these will still work in both OpenGL and DirectX). The reason this wasn't done in the first place is that there where some bugs with Cg at the time the shadows demo was implement but these have now been resolved.
Since I'm assuming your shader knowledge is quite limited, I'm not going to attempt to explain what the lines of code do and just expect you to follow the steps 
.
First create a file named "DepthShadowmap.cg" and put the following contents:
DepthShadowmap.cg
/* This file implements standard programs for depth shadow mapping.
These particular ones are suitable for additive lighting models, and
include 3 techniques to reduce depth fighting on self-shadowed surfaces,
constant bias, gradient (slope-scale) bias, and a fuzzy shadow map comparison*/
// Shadow caster vertex program.
void casterVP(
float4 position : POSITION,
out float4 outPos : POSITION,
out float2 outDepth : TEXCOORD0,
uniform float4x4 worldViewProj,
uniform float4 texelOffsets,
uniform float4 depthRange
)
{
outPos = mul(worldViewProj, position);
// fix pixel / texel alignment
outPos.xy += texelOffsets.zw * outPos.w;
// linear depth storage
// offset / scale range output
#if LINEAR_RANGE
outDepth.x = (outPos.z - depthRange.x) * depthRange.w;
#else
outDepth.x = outPos.z;
#endif
outDepth.y = outPos.w;
}
// Shadow caster fragment program for high-precision single-channel textures
void casterFP(
float2 depth : TEXCOORD0,
out float4 result : COLOR)
{
#if LINEAR_RANGE
float finalDepth = depth.x;
#else
float finalDepth = depth.x / depth.y;
#endif
// just smear across all components
// therefore this one needs high individual channel precision
result = float4(finalDepth, finalDepth, finalDepth, 1);
}
void receiverVP(
float4 position : POSITION,
float4 normal : NORMAL,
out float4 outPos : POSITION,
out float4 outColour : COLOR,
out float4 outShadowUV : TEXCOORD0,
uniform float4x4 world,
uniform float4x4 worldIT,
uniform float4x4 worldViewProj,
uniform float4x4 texViewProj,
uniform float4 lightPosition,
uniform float4 lightColour,
uniform float4 shadowDepthRange
)
{
float4 worldPos = mul(world, position);
outPos = mul(worldViewProj, position);
float3 worldNorm = mul(worldIT, normal).xyz;
// calculate lighting (simple vertex lighting)
float3 lightDir = normalize(
lightPosition.xyz - (worldPos.xyz * lightPosition.w));
outColour = lightColour * max(dot(lightDir, worldNorm), 0.0);
// calculate shadow map coords
outShadowUV = mul(texViewProj, worldPos);
#if LINEAR_RANGE
// adjust by fixed depth bias, rescale into range
outShadowUV.z = (outShadowUV.z - shadowDepthRange.x) * shadowDepthRange.w;
#endif
}
void receiverFP(
float4 position : POSITION,
float4 shadowUV : TEXCOORD0,
float4 vertexColour : COLOR,
uniform sampler2D shadowMap : register(s0),
uniform float inverseShadowmapSize,
uniform float fixedDepthBias,
uniform float gradientClamp,
uniform float gradientScaleBias,
uniform float shadowFuzzyWidth,
out float4 result : COLOR)
{
// point on shadowmap
#if LINEAR_RANGE
shadowUV.xy = shadowUV.xy / shadowUV.w;
#else
shadowUV = shadowUV / shadowUV.w;
#endif
float centerdepth = tex2D(shadowMap, shadowUV.xy).x;
// gradient calculation
float pixeloffset = inverseShadowmapSize;
float4 depths = float4(
tex2D(shadowMap, shadowUV.xy + float2(-pixeloffset, 0)).x,
tex2D(shadowMap, shadowUV.xy + float2(+pixeloffset, 0)).x,
tex2D(shadowMap, shadowUV.xy + float2(0, -pixeloffset)).x,
tex2D(shadowMap, shadowUV.xy + float2(0, +pixeloffset)).x);
float2 differences = abs( depths.yw - depths.xz );
float gradient = min(gradientClamp, max(differences.x, differences.y));
float gradientFactor = gradient * gradientScaleBias;
// visibility function
float depthAdjust = gradientFactor + (fixedDepthBias * centerdepth);
float finalCenterDepth = centerdepth + depthAdjust;
// shadowUV.z contains lightspace position of current object
#if FUZZY_TEST
// fuzzy test - introduces some ghosting in result and doesn't appear to be needed?
//float visibility = saturate(1 + delta_z / (gradient * shadowFuzzyWidth));
float visibility = saturate(1 + (finalCenterDepth - shadowUV.z) * shadowFuzzyWidth * shadowUV.w);
result = vertexColour * visibility;
#else
// hard test
#if PCF
// use depths from prev, calculate diff
depths += depthAdjust.xxxx;
float final = (finalCenterDepth > shadowUV.z) ? 1.0f : 0.0f;
final += (depths.x > shadowUV.z) ? 1.0f : 0.0f;
final += (depths.y > shadowUV.z) ? 1.0f : 0.0f;
final += (depths.z > shadowUV.z) ? 1.0f : 0.0f;
final += (depths.w > shadowUV.z) ? 1.0f : 0.0f;
final *= 0.2f;
result = float4(vertexColour.xyz * final, 1);
#else
result = (finalCenterDepth > shadowUV.z) ? vertexColour : float4(0,0,0,1);
#endif
#endif
}
/*
Basic ambient lighting vertex program
*/
void ambientOneTexture_vp(float4 position : POSITION,
float2 uv : TEXCOORD0,
out float4 oPosition : POSITION,
out float2 oUv : TEXCOORD0,
out float4 colour : COLOR,
uniform float4x4 worldViewProj,
uniform float4 ambient)
{
oPosition = mul(worldViewProj, position);
oUv = uv;
colour = ambient;
}
Secondly create a file named "DepthShadowmap.program" and paste the following into it:
DepthShadowmap.program
vertex_program Ogre/DepthShadowmap/CasterVP cg
{
source DepthShadowmap.cg
entry_point casterVP
profiles arbvp1 vs_2_0
compile_arguments -DLINEAR_RANGE=0
default_params
{
param_named_auto worldViewProj worldviewproj_matrix
param_named_auto texelOffsets texel_offsets
//param_named_auto depthRange scene_depth_range
}
}
fragment_program Ogre/DepthShadowmap/CasterFP cg
{
source DepthShadowmap.cg
entry_point casterFP
profiles arbfp1 ps_2_0 fp20
compile_arguments -DLINEAR_RANGE=0
default_params
{
}
}
vertex_program Ogre/DepthShadowmap/ReceiverVP cg
{
source DepthShadowmap.cg
entry_point receiverVP
profiles arbvp1 vs_2_0
compile_arguments -DLINEAR_RANGE=0
default_params
{
param_named_auto world world_matrix
param_named_auto worldIT inverse_transpose_world_matrix
param_named_auto worldViewProj worldviewproj_matrix
param_named_auto texViewProj texture_viewproj_matrix
param_named_auto lightPosition light_position 0
param_named_auto lightColour light_diffuse_colour 0
//param_named_auto shadowDepthRange shadow_scene_depth_range 0
}
}
fragment_program Ogre/DepthShadowmap/ReceiverFP cg
{
source DepthShadowmap.cg
entry_point receiverFP
profiles arbfp1 ps_2_0 fp20
compile_arguments -DLINEAR_RANGE=0 -DFUZZY_TEST=0 -DPCF=0
default_params
{
param_named inverseShadowmapSize float 0.0009765625
param_named fixedDepthBias float 0.01
param_named gradientClamp float 0.0098
param_named gradientScaleBias float 0
//param_named shadowFuzzyWidth float 1
}
}
// A really basic ambient pass program, support for one texture coodinate set
vertex_program Ogre/BasicVertexPrograms/AmbientOneTexture cg
{
source DepthShadowmap.cg
entry_point ambientOneTexture_vp
profiles arbvp1 vs_1_1
default_params
{
param_named_auto worldViewProj worldviewproj_matrix
param_named_auto ambient ambient_light_colour
}
}
And place these files in your application directory somewhere where ogre can find them (i.e. defined in the "resource.cfg" file). Or better yet create a new directory called "shaders" or something similar and add that to your "resource.cfg" file.
Defining the materials
Now that the shaders are defined we will need to create some materials that use them. The first material we create is used as the shadow caster, you won't need to modify this. Secondly we are going to create a template material that will be used as the base for all the materials we want shadows to be cast on. The material I have defined is pretty much the simplest you can get (even know it looks quite complex), it basically makes use of the shaders provided above to receive shadows properly and allows you to apply your own texture to it. If you want more complicated materials with multiple textures you're own your own .
Again create this file with the following contents and place it somewhere your application can find it:
DepthShadowMap.material
// Generic Shadow caster material (floating point shadowmap)
material Ogre/DepthShadowmap/Caster/Float
{
technique
{
pass
{
vertex_program_ref Ogre/DepthShadowmap/CasterVP
{
}
fragment_program_ref Ogre/DepthShadowmap/CasterFP
{
}
}
}
}
// Basic materials which support shadows as a seperate scheme
material Ogre/DepthShadowmap/BasicTemplateMaterial
{
// This technique supports dynamic shadows
technique
{
// Base ambient pass
pass Ambient
{
// base colours, not needed for rendering, but as information
// to lighting pass categorisation routine
ambient 1 1 1
diffuse 0 0 0
specular 0 0 0 0
// Really basic vertex program
vertex_program_ref Ogre/BasicVertexPrograms/AmbientOneTexture
{
}
}
// Now do the lighting pass
// NB we don't do decal texture here because this is repeated per light
pass Lighting
{
// base colours, not needed for rendering, but as information
// to lighting pass categorisation routine
ambient 0 0 0
// do this for each light
iteration once_per_light
scene_blend add
// Vertex program reference
vertex_program_ref Ogre/DepthShadowmap/ReceiverVP
{
}
// Fragment program
fragment_program_ref Ogre/DepthShadowmap/ReceiverFP
{
}
texture_unit
{
content_type shadow
tex_address_mode clamp
filtering none
}
}
// Decal pass
pass Decal
{
// base colours, not needed for rendering, but as information
// to lighting pass categorisation routine
lighting off
// Really basic vertex program
vertex_program_ref Ogre/BasicVertexPrograms/AmbientOneTexture
{
param_named ambient float4 1 1 1 1
}
scene_blend modulate
texture_unit
{
texture_alias MainTexture
tex_address_mode clamp
}
}
}
}
Now you can create your own materials using the above material as a template to make things easier to manage:
MyMaterials.material
material MyMaterial : Ogre/DepthShadowmap/BasicTemplateMaterial
{
set_texture_alias MainTexture MyTexture.jpg
}
Source code modification
Now that your materials and shaders are set up, there are a few modification you will need to do to the source code.
// Allow self shadowing (note: this only works in conjunction with the shaders defined above)
mSceneMgr->setShadowTextureSelfShadow(true);
// Set the caster material which uses the shaders defined above
mSceneMgr->setShadowTextureCasterMaterial("Ogre/DepthShadowmap/Caster/Float");
// Set the pixel format to floating point
mSceneMgr->setShadowTexturePixelFormat(Ogre::PF_FLOAT32_R);
// You can switch this on or off, I suggest you try both and see which works best for you
mSceneMgr->setShadowCasterRenderBackFaces(false);
// Finally enable the shadows using texture additive integrated
mSceneMgr->setShadowTechnique(Ogre::SHADOWTYPE_TEXTURE_ADDITIVE_INTEGRATED);
And hopefully after you have completed these steps, everything should be working. Once that is the case you may want to play around with the settings in the DepthShadowmap.program file. Notably:
There are a number of settings in the Ogre/DepthShadowmap/ReceiverFP shader which can be tweaked:
param_named fixedDepthBias float 0.01 param_named gradientClamp float 0.0098 param_named gradientScaleBias float 0
And you can try switching PCF on by changing the line: "-DPCF=0" to "-DPCF=1"
Alias: Depth_Shadow_Mapping
Links:
Soft Shadows
THE WORK (AS DEFINED BELOW) IS PROVIDED UNDER THE TERMS OF THIS CREATIVE COMMONS PUBLIC LICENSE ("CCPL" OR "LICENSE"). THE WORK IS PROTECTED BY COPYRIGHT AND/OR OTHER APPLICABLE LAW. ANY USE OF THE WORK OTHER THAN AS AUTHORIZED UNDER THIS LICENSE OR COPYRIGHT LAW IS PROHIBITED.
BY EXERCISING ANY RIGHTS TO THE WORK PROVIDED HERE, YOU ACCEPT AND AGREE TO BE BOUND BY THE TERMS OF THIS LICENSE. THE LICENSOR GRANTS YOU THE RIGHTS CONTAINED HERE IN CONSIDERATION OF YOUR ACCEPTANCE OF SUCH TERMS AND CONDITIONS.
1. Definitions
- "Collective Work" means a work, such as a periodical issue, anthology or encyclopedia, in which the Work in its entirety in unmodified form, along with a number of other contributions, constituting separate and independent works in themselves, are assembled into a collective whole. A work that constitutes a Collective Work will not be considered a Derivative Work (as defined below) for the purposes of this License.
- "Derivative Work" means a work based upon the Work or upon the Work and other pre-existing works, such as a translation, musical arrangement, dramatization, fictionalization, motion picture version, sound recording, art reproduction, abridgment, condensation, or any other form in which the Work may be recast, transformed, or adapted, except that a work that constitutes a Collective Work will not be considered a Derivative Work for the purpose of this License. For the avoidance of doubt, where the Work is a musical composition or sound recording, the synchronization of the Work in timed-relation with a moving image ("synching") will be considered a Derivative Work for the purpose of this License.
- "Licensor" means the individual or entity that offers the Work under the terms of this License.
- "Original Author" means the individual or entity who created the Work.
- "Work" means the copyrightable work of authorship offered under the terms of this License.
- "You" means an individual or entity exercising rights under this License who has not previously violated the terms of this License with respect to the Work, or who has received express permission from the Licensor to exercise rights under this License despite a previous violation.
- "License Elements" means the following high-level license attributes as selected by Licensor and indicated in the title of this License: Attribution, ShareAlike.
2. Fair Use Rights
Nothing in this license is intended to reduce, limit, or restrict any rights arising from fair use, first sale or other limitations on the exclusive rights of the copyright owner under copyright law or other applicable laws.
3. License Grant
Subject to the terms and conditions of this License, Licensor hereby grants You a worldwide, royalty-free, non-exclusive, perpetual (for the duration of the applicable copyright) license to exercise the rights in the Work as stated below:
- to reproduce the Work, to incorporate the Work into one or more Collective Works, and to reproduce the Work as incorporated in the Collective Works;
- to create and reproduce Derivative Works;
- to distribute copies or phonorecords of, display publicly, perform publicly, and perform publicly by means of a digital audio transmission the Work including as incorporated in Collective Works;
- to distribute copies or phonorecords of, display publicly, perform publicly, and perform publicly by means of a digital audio transmission Derivative Works.
- For the avoidance of doubt, where the work is a musical composition:
- Performance Royalties Under Blanket Licenses. Licensor waives the exclusive right to collect, whether individually or via a performance rights society (e.g. ASCAP, BMI, SESAC), royalties for the public performance or public digital performance (e.g. webcast) of the Work.
- Mechanical Rights and Statutory Royalties. Licensor waives the exclusive right to collect, whether individually or via a music rights society or designated agent (e.g. Harry Fox Agency), royalties for any phonorecord You create from the Work ("cover version") and distribute, subject to the compulsory license created by 17 USC Section 115 of the US Copyright Act (or the equivalent in other jurisdictions).
- Webcasting Rights and Statutory Royalties. For the avoidance of doubt, where the Work is a sound recording, Licensor waives the exclusive right to collect, whether individually or via a performance-rights society (e.g. SoundExchange), royalties for the public digital performance (e.g. webcast) of the Work, subject to the compulsory license created by 17 USC Section 114 of the US Copyright Act (or the equivalent in other jurisdictions).
The above rights may be exercised in all media and formats whether now known or hereafter devised. The above rights include the right to make such modifications as are technically necessary to exercise the rights in other media and formats. All rights not expressly granted by Licensor are hereby reserved.
4. Restrictions
The license granted in Section 3 above is expressly made subject to and limited by the following restrictions:
- You may distribute, publicly display, publicly perform, or publicly digitally perform the Work only under the terms of this License, and You must include a copy of, or the Uniform Resource Identifier for, this License with every copy or phonorecord of the Work You distribute, publicly display, publicly perform, or publicly digitally perform. You may not offer or impose any terms on the Work that alter or restrict the terms of this License or the recipients' exercise of the rights granted hereunder. You may not sublicense the Work. You must keep intact all notices that refer to this License and to the disclaimer of warranties. You may not distribute, publicly display, publicly perform, or publicly digitally perform the Work with any technological measures that control access or use of the Work in a manner inconsistent with the terms of this License Agreement. The above applies to the Work as incorporated in a Collective Work, but this does not require the Collective Work apart from the Work itself to be made subject to the terms of this License. If You create a Collective Work, upon notice from any Licensor You must, to the extent practicable, remove from the Collective Work any credit as required by clause 4(c), as requested. If You create a Derivative Work, upon notice from any Licensor You must, to the extent practicable, remove from the Derivative Work any credit as required by clause 4(c), as requested.
- You may distribute, publicly display, publicly perform, or publicly digitally perform a Derivative Work only under the terms of this License, a later version of this License with the same License Elements as this License, or a Creative Commons iCommons license that contains the same License Elements as this License (e.g. Attribution-ShareAlike 2.5 Japan). You must include a copy of, or the Uniform Resource Identifier for, this License or other license specified in the previous sentence with every copy or phonorecord of each Derivative Work You distribute, publicly display, publicly perform, or publicly digitally perform. You may not offer or impose any terms on the Derivative Works that alter or restrict the terms of this License or the recipients' exercise of the rights granted hereunder, and You must keep intact all notices that refer to this License and to the disclaimer of warranties. You may not distribute, publicly display, publicly perform, or publicly digitally perform the Derivative Work with any technological measures that control access or use of the Work in a manner inconsistent with the terms of this License Agreement. The above applies to the Derivative Work as incorporated in a Collective Work, but this does not require the Collective Work apart from the Derivative Work itself to be made subject to the terms of this License.
- If you distribute, publicly display, publicly perform, or publicly digitally perform the Work or any Derivative Works or Collective Works, You must keep intact all copyright notices for the Work and provide, reasonable to the medium or means You are utilizing: (i) the name of the Original Author (or pseudonym, if applicable) if supplied, and/or (ii) if the Original Author and/or Licensor designate another party or parties (e.g. a sponsor institute, publishing entity, journal) for attribution in Licensor's copyright notice, terms of service or by other reasonable means, the name of such party or parties; the title of the Work if supplied; to the extent reasonably practicable, the Uniform Resource Identifier, if any, that Licensor specifies to be associated with the Work, unless such URI does not refer to the copyright notice or licensing information for the Work; and in the case of a Derivative Work, a credit identifying the use of the Work in the Derivative Work (e.g., "French translation of the Work by Original Author," or "Screenplay based on original Work by Original Author"). Such credit may be implemented in any reasonable manner; provided, however, that in the case of a Derivative Work or Collective Work, at a minimum such credit will appear where any other comparable authorship credit appears and in a manner at least as prominent as such other comparable authorship credit.
5. Representations, Warranties and Disclaimer
UNLESS OTHERWISE AGREED TO BY THE PARTIES IN WRITING, LICENSOR OFFERS THE WORK AS-IS AND MAKES NO REPRESENTATIONS OR WARRANTIES OF ANY KIND CONCERNING THE MATERIALS, EXPRESS, IMPLIED, STATUTORY OR OTHERWISE, INCLUDING, WITHOUT LIMITATION, WARRANTIES OF TITLE, MERCHANTIBILITY, FITNESS FOR A PARTICULAR PURPOSE, NONINFRINGEMENT, OR THE ABSENCE OF LATENT OR OTHER DEFECTS, ACCURACY, OR THE PRESENCE OF ABSENCE OF ERRORS, WHETHER OR NOT DISCOVERABLE. SOME JURISDICTIONS DO NOT ALLOW THE EXCLUSION OF IMPLIED WARRANTIES, SO SUCH EXCLUSION MAY NOT APPLY TO YOU.
6. Limitation on Liability.
EXCEPT TO THE EXTENT REQUIRED BY APPLICABLE LAW, IN NO EVENT WILL LICENSOR BE LIABLE TO YOU ON ANY LEGAL THEORY FOR ANY SPECIAL, INCIDENTAL, CONSEQUENTIAL, PUNITIVE OR EXEMPLARY DAMAGES ARISING OUT OF THIS LICENSE OR THE USE OF THE WORK, EVEN IF LICENSOR HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
7. Termination
- This License and the rights granted hereunder will terminate automatically upon any breach by You of the terms of this License. Individuals or entities who have received Derivative Works or Collective Works from You under this License, however, will not have their licenses terminated provided such individuals or entities remain in full compliance with those licenses. Sections 1, 2, 5, 6, 7, and 8 will survive any termination of this License.
- Subject to the above terms and conditions, the license granted here is perpetual (for the duration of the applicable copyright in the Work). Notwithstanding the above, Licensor reserves the right to release the Work under different license terms or to stop distributing the Work at any time; provided, however that any such election will not serve to withdraw this License (or any other license that has been, or is required to be, granted under the terms of this License), and this License will continue in full force and effect unless terminated as stated above.
8. Miscellaneous
- Each time You distribute or publicly digitally perform the Work or a Collective Work, the Licensor offers to the recipient a license to the Work on the same terms and conditions as the license granted to You under this License.
- Each time You distribute or publicly digitally perform a Derivative Work, Licensor offers to the recipient a license to the original Work on the same terms and conditions as the license granted to You under this License.
- If any provision of this License is invalid or unenforceable under applicable law, it shall not affect the validity or enforceability of the remainder of the terms of this License, and without further action by the parties to this agreement, such provision shall be reformed to the minimum extent necessary to make such provision valid and enforceable.
- No term or provision of this License shall be deemed waived and no breach consented to unless such waiver or consent shall be in writing and signed by the party to be charged with such waiver or consent.
- This License constitutes the entire agreement between the parties with respect to the Work licensed here. There are no understandings, agreements or representations with respect to the Work not specified here. Licensor shall not be bound by any additional provisions that may appear in any communication from You. This License may not be modified without the mutual written agreement of the Licensor and You.