Search Results for

    Show / Hide Table of Contents

    Class SwapChain

    An instance of the SwapChain.

    Inheritance
    object
    SwapChain
    DX11SwapChain
    DX12SwapChain
    MTLSwapChain
    GLSwapChain
    VKSwapChain
    WGPUSwapChain
    Namespace: Evergine.Common.Graphics
    Assembly: Evergine.Common.dll
    Syntax
    public abstract class SwapChain

    Fields

    GraphicsContext

    The device context reference.

    Declaration
    public GraphicsContext GraphicsContext
    Field Value
    Type Description
    GraphicsContext

    disposed

    Indicates if the instance has been disposed.

    Declaration
    protected bool disposed
    Field Value
    Type Description
    bool

    Properties

    FrameBuffer

    Gets or sets the swap chain framebuffer.

    Declaration
    public FrameBuffer FrameBuffer { get; protected set; }
    Property Value
    Type Description
    FrameBuffer

    Name

    Gets or sets a string identifying this instance. Can be used in graphics debugging tools.

    Declaration
    public abstract string Name { get; set; }
    Property Value
    Type Description
    string

    NativeSwapChainPointer

    Gets the native SwapChain pointer. The default value is returned if the platform does not support it.

    Declaration
    public virtual nint NativeSwapChainPointer { get; }
    Property Value
    Type Description
    nint

    SwapChainDescription

    Gets or sets the description of the SwapChain.

    Declaration
    public SwapChainDescription SwapChainDescription { get; protected set; }
    Property Value
    Type Description
    SwapChainDescription

    VerticalSync

    Gets or sets a value indicating whether vertical synchronization is enabled or not.

    Declaration
    public virtual bool VerticalSync { get; set; }
    Property Value
    Type Description
    bool

    Methods

    Dispose()

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

    Declaration
    public abstract void Dispose()

    GetCurrentFramebufferTexture()

    Gets the current framebuffer texture.

    Declaration
    public abstract Texture GetCurrentFramebufferTexture()
    Returns
    Type Description
    Texture

    Framebuffer texture.

    InitFrame()

    This method is invoked when the frame starts.

    Declaration
    public virtual void InitFrame()

    Present()

    Presents a rendered image to the user.

    Declaration
    public abstract void Present()

    RefreshSurfaceInfo(SurfaceInfo)

    The swapchain surface information has changed.

    Declaration
    public abstract void RefreshSurfaceInfo(SurfaceInfo surfaceInfo)
    Parameters
    Type Name Description
    SurfaceInfo surfaceInfo

    The surface information.

    ResizeSwapChain(uint, uint)

    Resizes the SwapChain.

    Declaration
    public abstract void ResizeSwapChain(uint width, uint height)
    Parameters
    Type Name Description
    uint width

    The new width.

    uint height

    The new height.

    Extension Methods

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