Struct DxgiSwapChainDesc

Describes a swap chain.

Implements

IEquatable<DxgiSwapChainDesc>

Inherited Members

ValueType.ToString()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Namespace: JeremyAnsel.DirectX.Dxgi

Assembly: JeremyAnsel.DirectX.Dxgi.dll

Syntax

public struct DxgiSwapChainDesc : IEquatable<DxgiSwapChainDesc>

Properties

BufferCount

Gets or sets a value that describes the number of buffers in the swap chain.

Declaration

public uint BufferCount { get; set; }

Property Value

Type	Description
uint

BufferDescription

Gets or sets a DxgiModeDesc structure that describes the back buffer display mode.

Declaration

public DxgiModeDesc BufferDescription { get; set; }

Property Value

Type	Description
DxgiModeDesc

BufferUsage

Gets or sets a member of the DxgiUsages enumeration that describes the surface usage and CPU access options for the back buffer. The back buffer can be used for shader input or render-target output.

Declaration

public DxgiUsages BufferUsage { get; set; }

Property Value

Type	Description
DxgiUsages

IsWindowed

Gets or sets a value indicating whether the output is in windowed mode.

Declaration

public bool IsWindowed { get; set; }

Property Value

Type	Description
bool

Options

Gets or sets a member of the DxgiSwapChainOptions enumeration that describes options for swap-chain behavior.

Declaration

public DxgiSwapChainOptions Options { get; set; }

Property Value

Type	Description
DxgiSwapChainOptions

OutputWindowHandle

Gets or sets an handle to the output window. This member must not be Zero.

Declaration

public nint OutputWindowHandle { get; set; }

Property Value

Type	Description
nint

SampleDescription

Gets or sets a DxgiSampleDesc structure that describes multi-sampling parameters.

Declaration

public DxgiSampleDesc SampleDescription { get; set; }

Property Value

Type	Description
DxgiSampleDesc

SwapEffect

Gets or sets a member of the DxgiSwapEffect enumeration that describes options for handling the contents of the presentation buffer after presenting a surface.

Declaration

public DxgiSwapEffect SwapEffect { get; set; }

Property Value

Type	Description
DxgiSwapEffect

Methods

Equals(DxgiSwapChainDesc)

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

Declaration

public bool Equals(DxgiSwapChainDesc other)

Parameters

Type	Name	Description
DxgiSwapChainDesc	other	The object to compare with the current object.

Returns

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

Equals(object)

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

Declaration

public override bool Equals(object obj)

Parameters

Type	Name	Description
object	obj	The object to compare with the current object.

Returns

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

Overrides

ValueType.Equals(object)

GetHashCode()

Returns the hash code for this instance.

Declaration

public override int GetHashCode()

Returns

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

Overrides

ValueType.GetHashCode()

Operators

operator ==(DxgiSwapChainDesc, DxgiSwapChainDesc)

Compares two DxgiSwapChainDesc objects. The result specifies whether the values of the two objects are equal.

Declaration

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

Parameters

Type	Name	Description
DxgiSwapChainDesc	left	The left DxgiSwapChainDesc to compare.
DxgiSwapChainDesc	right	The right DxgiSwapChainDesc to compare.

Returns

Type	Description
bool	true if the values of left and right are equal; otherwise, false.

operator !=(DxgiSwapChainDesc, DxgiSwapChainDesc)

Compares two DxgiSwapChainDesc objects. The result specifies whether the values of the two objects are unequal.

Declaration

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

Parameters

Type	Name	Description
DxgiSwapChainDesc	left	The left DxgiSwapChainDesc to compare.
DxgiSwapChainDesc	right	The right DxgiSwapChainDesc to compare.

Returns

Type	Description
bool	true if the values of left and right differ; otherwise, false.

Implements

IEquatable<T>