Class PresentationParameters

Namespace

Stride.Graphics

Assembly

Stride.Graphics.dll

Describess how data will be displayed to the screen.

public class PresentationParameters : IEquatable<PresentationParameters>

Inheritance

object

PresentationParameters

Implements

IEquatable<PresentationParameters>

Constructors

PresentationParameters()

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

public PresentationParameters()

PresentationParameters(int, int, WindowHandle)

Initializes a new instance of the PresentationParameters class with R8G8B8A8_UNorm.

public PresentationParameters(int backBufferWidth, int backBufferHeight, WindowHandle deviceWindowHandle)

Parameters

backBufferWidth int

Width of the back buffer.

backBufferHeight int

Height of the back buffer.

deviceWindowHandle WindowHandle

The device window handle.

PresentationParameters(int, int, WindowHandle, PixelFormat)

Initializes a new instance of the PresentationParameters class.

public PresentationParameters(int backBufferWidth, int backBufferHeight, WindowHandle deviceWindowHandle, PixelFormat backBufferFormat)

Parameters

backBufferWidth int

Width of the back buffer.

backBufferHeight int

Height of the back buffer.

deviceWindowHandle WindowHandle

The device window handle.

backBufferFormat PixelFormat

The back buffer format.

Fields

BackBufferFormat

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

public PixelFormat BackBufferFormat

Field Value

PixelFormat

BackBufferHeight

A value that describes the resolution height.

public int BackBufferHeight

Field Value

int

BackBufferWidth

A value that describes the resolution width.

public int BackBufferWidth

Field Value

int

ColorSpace

The colorspace of the rendering pipeline.

public ColorSpace ColorSpace

Field Value

ColorSpace

DepthStencilFormat

Gets or sets the depth stencil format

public PixelFormat DepthStencilFormat

Field Value

PixelFormat

DeviceWindowHandle

A Window object. See remarks.

public WindowHandle DeviceWindowHandle

Field Value

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

bool

MultisampleCount

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

public MultisampleCount MultisampleCount

Field Value

MultisampleCount

OutputColorSpace

The colorspace type used for the swapchain output. Currently only supported by the DirectX backend.

public ColorSpaceType OutputColorSpace

Field Value

ColorSpaceType

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

int

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

PresentInterval

RefreshRate

A structure describing the refresh rate in hertz

public Rational RefreshRate

Field Value

Rational

Methods

Clone()

public PresentationParameters Clone()

Returns

PresentationParameters

Equals(PresentationParameters)

Indicates whether the current object is equal to another object of the same type.

public bool Equals(PresentationParameters other)

Parameters

other PresentationParameters

An object to compare with this object.

Returns

bool

true if the current object is equal to the other parameter; otherwise, false.

Equals(object)

Determines whether the specified object is equal to the current object.

public override bool Equals(object obj)

Parameters

obj object

The object to compare with the current object.

Returns

bool

true if the specified object is equal to the current object; otherwise, false.

GetHashCode()

Serves as the default hash function.

public override int GetHashCode()

Returns

int

A hash code for the current object.

Operators

operator ==(PresentationParameters, PresentationParameters)

public static bool operator ==(PresentationParameters left, PresentationParameters right)

Parameters

left PresentationParameters

right PresentationParameters

Returns

bool

operator !=(PresentationParameters, PresentationParameters)

public static bool operator !=(PresentationParameters left, PresentationParameters right)

Parameters

left PresentationParameters

right PresentationParameters

Returns

bool