Struct SwapchainDescription

Namespace

NeoVeldrid

Assembly

NeoVeldrid.dll

Describes a Swapchain, for creation via a ResourceFactory.

public struct SwapchainDescription : IEquatable<SwapchainDescription>

Implements

IEquatable<SwapchainDescription>

Inherited Members

ValueType.Equals(object)

ValueType.ToString()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

SwapchainDescription(SwapchainSource, uint, uint, PixelFormat?, bool)

Constructs a new SwapchainDescription.

public SwapchainDescription(SwapchainSource source, uint width, uint height, PixelFormat? depthFormat, bool syncToVerticalBlank)

Parameters

source SwapchainSource

The SwapchainSource which will be used as the target of rendering operations. This is a window-system-specific object which differs by platform.

width uint

The initial width of the Swapchain surface.

height uint

The initial height of the Swapchain surface.

depthFormat PixelFormat?

The optional format of the depth target of the Swapchain's Framebuffer. If non-null, this must be a valid depth Texture format. If null, then no depth target will be created.

syncToVerticalBlank bool

Indicates whether presentation of the Swapchain will be synchronized to the window system's vertical refresh rate.

SwapchainDescription(SwapchainSource, uint, uint, PixelFormat?, bool, bool)

Constructs a new SwapchainDescription.

public SwapchainDescription(SwapchainSource source, uint width, uint height, PixelFormat? depthFormat, bool syncToVerticalBlank, bool colorSrgb)

Parameters

source SwapchainSource

The SwapchainSource which will be used as the target of rendering operations. This is a window-system-specific object which differs by platform.

width uint

The initial width of the Swapchain surface.

height uint

The initial height of the Swapchain surface.

depthFormat PixelFormat?

The optional format of the depth target of the Swapchain's Framebuffer. If non-null, this must be a valid depth Texture format. If null, then no depth target will be created.

syncToVerticalBlank bool

Indicates whether presentation of the Swapchain will be synchronized to the window system's vertical refresh rate.

colorSrgb bool

Indicates whether the color target of the Swapchain will use an sRGB PixelFormat.

Fields

ColorSrgb

Indicates whether the color target of the Swapchain will use an sRGB PixelFormat.

public bool ColorSrgb

Field Value

bool

DepthFormat

The optional format of the depth target of the Swapchain's Framebuffer. If non-null, this must be a valid depth Texture format. If null, then no depth target will be created.

public PixelFormat? DepthFormat

Field Value

PixelFormat?

Height

The initial height of the Swapchain surface.

public uint Height

Field Value

uint

Source

The SwapchainSource which will be used as the target of rendering operations. This is a window-system-specific object which differs by platform.

public SwapchainSource Source

Field Value

SwapchainSource

SyncToVerticalBlank

Indicates whether presentation of the Swapchain will be synchronized to the window system's vertical refresh rate.

public bool SyncToVerticalBlank

Field Value

bool

Width

The initial width of the Swapchain surface.

public uint Width

Field Value

uint

Methods

Equals(SwapchainDescription)

Element-wise equality.

public bool Equals(SwapchainDescription other)

Parameters

other SwapchainDescription

The instance to compare to.

Returns

bool

True if all elements are equal; false otherswise.

GetHashCode()

Returns the hash code for this instance.

public override int GetHashCode()

Returns

int

A 32-bit signed integer that is the hash code for this instance.