Class RenderPass

Represent a pass into a sequence of drawing a camera.

Inheritance

object

RenderPass

ForwardDefaultPass

ForwardDistortionPass

ForwardZPrePass

ShadowMapPass

Implements

IDisposable

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Evergine.Framework.Graphics

Assembly: Evergine.Framework.dll

Syntax

public abstract class RenderPass : IDisposable

Constructors

RenderPass(string, int, RenderPath)

Initializes a new instance of the RenderPass class.

Declaration

public RenderPass(string name, int passIndex, RenderPath renderPath)

Parameters

Type	Name	Description
string	name	The name of this render path.
int	passIndex	The pass index.
RenderPath	renderPath	The render path of this pass.

Fields

Name

The pass name.

Declaration

public string Name

Field Value

Type	Description
string

PassIndex

The pass index.

Declaration

public readonly int PassIndex

Field Value

Type	Description
int

RenderPath

The render manager.

Declaration

public readonly RenderPath RenderPath

Field Value

Type	Description
RenderPath

Properties

GraphicsContext

Gets the graphics context.

Declaration

public GraphicsContext GraphicsContext { get; }

Property Value

Type	Description
GraphicsContext

GraphicsPresenter

Gets the graphics resources.

Declaration

public GraphicsPresenter GraphicsPresenter { get; }

Property Value

Type	Description
GraphicsPresenter

RenderManager

Gets the render manager.

Declaration

public RenderManager RenderManager { get; }

Property Value

Type	Description
RenderManager

Methods

CheckBatch(DrawContext, ref RenderBatch)

Check if the specified batch is suitable to render this pass.

Declaration

public virtual bool CheckBatch(DrawContext drawContext, ref RenderBatch batch)

Parameters

Type	Name	Description
DrawContext	drawContext	The draw context.
RenderBatch	batch	The batch.

Returns

Type	Description
bool	True if this object can be rendered.

Remarks

By default, the only requirements is that the batch has a material defined with that layer.

Destroy()

Destroy the resources.

Declaration

protected virtual void Destroy()

Dispose()

Declaration

public void Dispose()

~RenderPass()

Finalizes an instance of the RenderPass class.

Declaration

protected ~RenderPass()

Render(DrawContext, CommandBuffer)

Render this scene.

Declaration

public abstract void Render(DrawContext drawContext, CommandBuffer commandBuffer)

Parameters

Type	Name	Description
DrawContext	drawContext	The context to draw.
CommandBuffer	commandBuffer	The command buffer.

RenderBatches(DrawContext, CommandBuffer, ref RenderPassDescription)

Render all batches.

Declaration

protected void RenderBatches(DrawContext drawContext, CommandBuffer commandBuffer, ref RenderPassDescription renderPassDescription)

Parameters

Type	Name	Description
DrawContext	drawContext	The draw context.
CommandBuffer	commandBuffer	The command buffer.
RenderPassDescription	renderPassDescription	The render pass description.

Implements

IDisposable

Extension Methods

ReflectionHelper.GetMemberAssembly(object)

ReflectionHelper.GetTypeName(object)