ShadowMappingResource

Description

sealed class Tinman.Engine.Components.ShadowMappingResource

Derived from

ResourceBase abstract

Wraps the GPU resources of a ShadowMapping object.

Public / Constants

Clear​Color

public constant ClearColor → (Colors.Yellow:int64)

The color to use for clearing the shadow map render targets.

Public / Constructors

Shadow​Mapping​Resource

public constructor ShadowMappingResource → (2)

shadowMapping in : ShadowMapping

[not-null]
The owning ShadowMapping object.

context in : IGraphicsContext

[not-null]
The graphics context.

Creates a new instance of ShadowMappingResource.

RenderException

If a graphics subsystem error has occurred.

Public / Methods

Apply​Parameters

public method ApplyParameters → (2)

shadowMapping in : ShadowMapping

[not-null]
The shadow mapping helper to use.

parameters in : ShadowParameters

[not-null]
The render effect parameters regarding shadow-mapping.

Applies the render state that is necessary for performing shadow-mapping.

See also

ShadowMappingResource.ApplyParametersNoShadows

Apply​Parameters​No​Shadows

public static method ApplyParametersNoShadows → (2)

cache in : IResourceCache

[not-null]
The resource cache to use.

parameters in : ShadowParameters

[not-null]
The render effect parameters regarding shadow-mapping.

Applies the render state that is necessary for rendering a scene without shadows.

Use this method when shadow-mapping is disabled while the shadow-mapping render pipeline is in use.

Get​Shadow​Map​Texture

public method GetShadowMapTexture → (1)

cascade in : int32

The shadow map cascade (see ShadowMapping.Cascade).

returns → ITexture2D

The shadow map texture.

Returns the shadow map texture for the given cascade.

Render​Shadow​Map​Begin

public method RenderShadowMapBegin → (1)

cascade in : ShadowCascade

The shadow map cascade (see ShadowMapping.Cascade).

returns → bool

true if the shadow cascade shall be rendered false if not (i.e. it is empty).

Begins to render the shadow map for the given cascade.

See also

ShadowMappingResource.RenderShadowMapEnd

Render​Shadow​Map​End

public method RenderShadowMapEnd → (2)

effect in : IProcessEffect

[not-null]
The render effect to use.

cascade in : int32

[>=0]
The shadow map cascade.

Finishes rendering of the shadow map of the current cascade.

See also

ShadowMappingResource.RenderShadowMapBegin

Public / Attributes

Texture​Size

[Constant]
public attribute TextureSize → (get)

value : int32

[pow2]
The texture size.

Size of the shadow-map render target textures.