IRenderStageCallback

Description

interface Tinman.Engine.Rendering.Stages.IRenderStageCallback

Extended by

RenderStageCallback abstract
Sky sealed
SkyDome sealed

Base interface for callbacks that hook into the steps of a render stage.

See also

IRenderStage.CallbackAdd

Public / Methods

Render​Stage​Begin

public method RenderStageBegin → (1)

stage in : IRenderStage

[not-null]
The IRenderStage object.

This method is called by IRenderStage.Begin, while performing initializations for the new frame to render.

RenderException

If a graphics subsystem error has occurred.

Render​Stage​Step

public method RenderStageStep → (3)

stage in : IRenderStage

[not-null]
The IRenderStage object.

step in : int32

The Begin* call that corresponds to the ending render stage step:
= 1 : IRenderStage.Begin
= 2 : IRenderStage.BeginBackground
= 3 : IRenderStage.BeginOpaque
= 4 : IRenderStage.BeginTransparent
= 5 : IRenderStage.BeginShadow1
> 5 : IRenderStage.BeginShadow2 (index = N - 5)

begin in : bool

true if the render stage step is about to begin,
false if the render stage step is about to end.

This method is called by IRenderStage.End, when beginning or ending a render state step.

The callback for step in = 1 and begin in = true is made right after calling RenderStageBegin. Both callbacks are equivalent, except that the latter one may throw a RenderException.

The callbacks for step in > are only made if IRenderStage.BeginShadow2 returns true.