PresentationParameters Class

    Namespace: Stride.Graphics
    Assembly: Stride.Graphics.dll

    Describess how data will be displayed to the screen.

    System.Object → PresentationParameters
    Derived from PresentationParameters: 

    public class PresentationParameters : IEquatable<PresentationParameters>
    Name Description
    Constructors
    PresentationParameters()

    Initializes a new instance of the PresentationParameters class with default values.
    PresentationParameters(Int32, Int32, WindowHandle)

    Initializes a new instance of the PresentationParameters class with R8G8B8A8_UNorm.
    PresentationParameters(Int32, Int32, WindowHandle, PixelFormat)

    Initializes a new instance of the PresentationParameters class.
    Fields
    BackBufferFormat

    A SharpDX.DXGI.Format structure describing the display format.
    BackBufferHeight

    A value that describes the resolution height.
    BackBufferWidth

    A value that describes the resolution width.
    ColorSpace

    The colorspace used.
    DepthStencilFormat

    Gets or sets the depth stencil format
    DeviceWindowHandle

    A Window object. See remarks.
    IsFullScreen

    Gets or sets a value indicating whether the application is in full screen mode.
    MultisampleCount

    Gets or sets a value indicating the number of sample locations during multisampling.
    PreferredFullScreenOutputIndex

    The output (monitor) index to use when switching to fullscreen mode. Doesn't have any effect when windowed mode is used.
    PresentationInterval

    Gets or sets the maximum rate at which the swap chain's back buffers can be presented to the front buffer.
    RefreshRate

    A structure describing the refresh rate in hertz
    Methods
    Clone()
    Equals(PresentationParameters)
    Equals(Object)
    GetHashCode()
    Operators
    Equality(PresentationParameters, PresentationParameters)
    Inequality(PresentationParameters, PresentationParameters)
    | Improve this Doc View Source

    Constructors

    PresentationParameters()

    Initializes a new instance of the PresentationParameters class with default values.

    public PresentationParameters()

    PresentationParameters(Int32, Int32, WindowHandle)

    Initializes a new instance of the PresentationParameters class with R8G8B8A8_UNorm.

    public PresentationParameters(int backBufferWidth, int backBufferHeight, WindowHandle deviceWindowHandle)
    Parameters
    Type Name Description
    System.Int32 backBufferWidth

    Width of the back buffer.
    System.Int32 backBufferHeight

    Height of the back buffer.
    WindowHandle deviceWindowHandle

    The device window handle.

    PresentationParameters(Int32, Int32, WindowHandle, PixelFormat)

    Initializes a new instance of the PresentationParameters class.

    public PresentationParameters(int backBufferWidth, int backBufferHeight, WindowHandle deviceWindowHandle, PixelFormat backBufferFormat)
    Parameters
    Type Name Description
    System.Int32 backBufferWidth

    Width of the back buffer.
    System.Int32 backBufferHeight

    Height of the back buffer.
    WindowHandle deviceWindowHandle

    The device window handle.
    PixelFormat backBufferFormat

    The back buffer format.
    | Improve this Doc View Source

    Fields

    BackBufferFormat

    A SharpDX.DXGI.Format structure describing the display format.

    public PixelFormat BackBufferFormat
    Field Value
    Type Description
    PixelFormat

    BackBufferHeight

    A value that describes the resolution height.

    public int BackBufferHeight
    Field Value
    Type Description
    System.Int32

    BackBufferWidth

    A value that describes the resolution width.

    public int BackBufferWidth
    Field Value
    Type Description
    System.Int32

    ColorSpace

    The colorspace used.

    public ColorSpace ColorSpace
    Field Value
    Type Description
    ColorSpace

    DepthStencilFormat

    Gets or sets the depth stencil format

    public PixelFormat DepthStencilFormat
    Field Value
    Type Description
    PixelFormat

    DeviceWindowHandle

    A Window object. See remarks.

    public WindowHandle DeviceWindowHandle
    Field Value
    Type Description
    WindowHandle
    Remarks

    A window object is platform dependent:

    • On Windows Desktop: This could a low level window/control handle (IntPtr), or directly a Winform Control object.
    • On Windows Metro: This could be SwapChainBackgroundPanel or SwapChainPanel object.

    IsFullScreen

    Gets or sets a value indicating whether the application is in full screen mode.

    public bool IsFullScreen
    Field Value
    Type Description
    System.Boolean

    MultisampleCount

    Gets or sets a value indicating the number of sample locations during multisampling.

    public MultisampleCount MultisampleCount
    Field Value
    Type Description
    MultisampleCount

    PreferredFullScreenOutputIndex

    The output (monitor) index to use when switching to fullscreen mode. Doesn't have any effect when windowed mode is used.

    public int PreferredFullScreenOutputIndex
    Field Value
    Type Description
    System.Int32

    PresentationInterval

    Gets or sets the maximum rate at which the swap chain's back buffers can be presented to the front buffer.

    public PresentInterval PresentationInterval
    Field Value
    Type Description
    PresentInterval

    RefreshRate

    A structure describing the refresh rate in hertz

    public Rational RefreshRate
    Field Value
    Type Description
    Rational
    | Improve this Doc View Source

    Methods

    Clone()

    public PresentationParameters Clone()
    Returns
    Type Description
    PresentationParameters

    Equals(PresentationParameters)

    public bool Equals(PresentationParameters other)
    Parameters
    Type Name Description
    PresentationParameters other
    Returns
    Type Description
    System.Boolean

    Equals(Object)

    public override bool Equals(object obj)
    Parameters
    Type Name Description
    System.Object obj
    Returns
    Type Description
    System.Boolean
    Overrides
    System.Object.Equals(System.Object)

    GetHashCode()

    public override int GetHashCode()
    Returns
    Type Description
    System.Int32
    Overrides
    System.Object.GetHashCode()
    | Improve this Doc View Source

    Operators

    Equality(PresentationParameters, PresentationParameters)

    public static bool operator ==(PresentationParameters left, PresentationParameters right)
    Parameters
    Type Name Description
    PresentationParameters left
    PresentationParameters right
    Returns
    Type Description
    System.Boolean

    Inequality(PresentationParameters, PresentationParameters)

    public static bool operator !=(PresentationParameters left, PresentationParameters right)
    Parameters
    Type Name Description
    PresentationParameters left
    PresentationParameters right
    Returns
    Type Description
    System.Boolean

    Extension Methods