Search Results for

    Show / Hide Table of Contents

    Class RenderPass

    Represents a pass in a sequence of drawing with a camera.

    Inheritance
    object
    RenderPass
    ForwardDefaultPass
    ForwardGBufferPass
    ForwardZPrePass
    ShadowMapPass
    Namespace: Evergine.Framework.Graphics
    Assembly: Evergine.Framework.dll
    Syntax
    public abstract class RenderPass

    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 pass.

    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 graphic 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 requirement is that the batch has a material defined with that layer.

    Destroy()

    Destroys the resources.

    Declaration
    protected virtual void Destroy()

    Dispose()

    Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

    Declaration
    public void Dispose()

    ~RenderPass()

    Finalizes an instance of the RenderPass class.

    Declaration
    protected ~RenderPass()

    Render(DrawContext, CommandBuffer)

    Renders this scene.

    Declaration
    public abstract void Render(DrawContext drawContext, CommandBuffer commandBuffer)
    Parameters
    Type Name Description
    DrawContext drawContext

    The context for drawing.

    CommandBuffer commandBuffer

    The command buffer.

    RenderBatches(DrawContext, CommandBuffer, ref RenderPassDescription)

    Renders 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.

    Extension Methods

    ReflectionHelper.GetMemberAssembly(object)
    ReflectionHelper.GetTypeName(object)
    In this article
    Back to top
    Generated by DocFX