CascadedShadow Class

Defines a cascaded shadow that can be used for DirectionalLights.

Inheritance Hierarchy

SystemObject
DigitalRune.GraphicsShadow
DigitalRune.GraphicsCascadedShadow

Namespace: DigitalRune.Graphics
Assembly: DigitalRune.Graphics (in DigitalRune.Graphics.dll) Version: 1.2.0.0 (1.2.1.14562)

Syntax

C++

Copy

public class CascadedShadow : Shadow

Public Class CascadedShadow
	Inherits Shadow

public ref class CascadedShadow : public Shadow

type CascadedShadow =  
    class
        inherit Shadow
    end

The CascadedShadow type exposes the following members.

Constructors

	Name	Description
	CascadedShadow	Initializes a new instance of the CascadedShadow class.

Top

Methods

	Name	Description
	Clone	Creates a new Shadow that is a clone (deep copy) of the current instance. (Inherited from Shadow.)
	CloneCore	Makes the instance a clone (deep copy) of the specified Shadow. (Overrides ShadowCloneCore(Shadow).)
	ComputeSplitDistances	Computes the Distances for a CascadedShadow.
	CreateInstanceCore	When implemented in a derived class, creates a new instance of the Shadow derived class. (Overrides ShadowCreateInstanceCore.)
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Properties

	Name	Description
	CascadeSelection	Gets or sets the cascade selection mode.
	DepthBias	Gets or sets the depth bias used to remove "surface acne".
	DepthBiasOffset	Obsolete. Gets or sets the depth bias offset of each cascade used to remove surface acne.
	DepthBiasScale	Obsolete. Gets or sets the depth bias scale of each cascade used to remove surface acne.
	Distances	Gets or sets the cascade split distances.
	FadeOutDistance	Obsolete. Gets or sets the distance from the camera where the shadow starts to fade out.
	FadeOutRange	Gets or sets the relative distance over which shadows are faded out.
	FilterRadius	Gets or sets the filter radius.
	IsCascadeLocked	Gets or sets the flags which determine if a cascade is locked.
	JitterResolution	Gets or sets the jitter resolution (for jitter sampling).
	MaxDistance	Obsolete. Gets or sets the maximum distance from the camera up to which shadows are rendered.
	MinLightDistance	Gets or sets the minimal distance of the light projection to the camera frustum of a cascade.
	NormalOffset	Gets or sets the normal offset used to remove "surface acne".
	NumberOfCascades	Gets or sets the number of cascades.
	NumberOfSamples	Gets or sets the number of filter samples.
	Prefer16Bit	Gets or sets a value indicating whether the shadow map should use a 16-bit format to store depth. (Inherited from Shadow.)
	PreferredSize	Gets or sets the size of the desired size of the shadow map in texels. (Inherited from Shadow.)
	ShadowFog	Gets or sets the shadow factor that is used beyond the max shadow distance.
	ShadowMap	Gets or sets the shadow map.
	ShadowMask	Gets or sets the shadow mask. (Inherited from Shadow.)
	ShadowMaskChannel	Gets or sets the shadow mask channel. (Inherited from Shadow.)
	SplitDistribution	Obsolete. Gets or sets the split distribution parameter.
	VisualizeCascades	Gets or sets a value indicating whether cascades are visualized for debugging.

Top

Remarks

A cascaded shadow map splits the camera frustum into separate slices (up to 4). For each slice a shadow map is computed.

A "slice" is also called "cascade interval", "sub-frustum" or simply "cascade". The word "cascade" actually means "a series of stages" - however, it is common to use the term "cascade" to describe an individual slice and this term is used here too.

The term "split" could refer to the border between two slices (4 cascades = 3 splits) or to the slices (cascade = split). Therefore, the term "split" has to be used with care.

Distances defines the cascade split distances and the maximum shadow distance.

PreferredSize defines the size of a single cascade of the cascaded shadow map.

Reference

DigitalRune.Graphics Namespace