Struct DxgiAdapterDesc2

Describes an adapter (or video card) that uses Microsoft DirectX Graphics Infrastructure (DXGI) 1.2.

Implements

IEquatable<DxgiAdapterDesc2>

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Namespace: JeremyAnsel.DirectX.Dxgi

Assembly: JeremyAnsel.DirectX.Dxgi.dll

Syntax

public struct DxgiAdapterDesc2 : IEquatable<DxgiAdapterDesc2>

Fields

AdapterDescriptionMaxLength

Gets the maximum char count of the string that contains the adapter description.

Declaration

public const int AdapterDescriptionMaxLength = 128

Field Value

Type	Description
int

Properties

AdapterDescription

Gets a string that contains the adapter description. On feature level 9 graphics hardware, “Software Adapter”.

Declaration

public readonly string AdapterDescription { get; }

Property Value

Type	Description
string

AdapterLuid

Gets a unique value that identifies the adapter.

Declaration

public readonly ulong AdapterLuid { get; }

Property Value

Type	Description
ulong

AdapterType

Gets a value of the DxgiAdapterType enumeration that describes the adapter type.

Declaration

public readonly DxgiAdapterType AdapterType { get; }

Property Value

Type	Description
DxgiAdapterType

ComputePreemptionGranularity

Gets a value of the DxgiComputePreemptionGranularity enumeration that describes the granularity level at which the GPU can be preempted from performing its current compute task.

Declaration

public readonly DxgiComputePreemptionGranularity ComputePreemptionGranularity { get; }

Property Value

Type	Description
DxgiComputePreemptionGranularity

DedicatedSystemMemory

Gets the number of bytes of dedicated system memory that are not shared with the CPU. This memory is allocated from available system memory at boot time.

Declaration

public readonly ulong DedicatedSystemMemory { get; }

Property Value

Type	Description
ulong

DedicatedVideoMemory

Gets the number of bytes of dedicated video memory that are not shared with the CPU.

Declaration

public readonly ulong DedicatedVideoMemory { get; }

Property Value

Type	Description
ulong

DeviceId

Gets the PCI ID of the hardware device. On feature level 9 graphics hardware, 0.

Declaration

public readonly uint DeviceId { get; }

Property Value

Type	Description
uint

GraphicsPreemptionGranularity

Gets a value of the DxgiGraphicsPreemptionGranularity enumeration that describes the granularity level at which the GPU can be preempted from performing its current graphics rendering task.

Declaration

public readonly DxgiGraphicsPreemptionGranularity GraphicsPreemptionGranularity { get; }

Property Value

Type	Description
DxgiGraphicsPreemptionGranularity

Revision

Gets the PCI ID of the revision number of the adapter. On feature level 9 graphics hardware, 0.

Declaration

public readonly uint Revision { get; }

Property Value

Type	Description
uint

SharedSystemMemory

Gets the number of bytes of shared system memory. This is the maximum value of system memory that may be consumed by the adapter during operation. Any incidental memory consumed by the driver as it manages and uses video memory is additional.

Declaration

public readonly ulong SharedSystemMemory { get; }

Property Value

Type	Description
ulong

SubSysId

Gets the PCI ID of the sub system. On feature level 9 graphics hardware, 0.

Declaration

public readonly uint SubSysId { get; }

Property Value

Type	Description
uint

VendorId

Gets the PCI ID of the hardware vendor. On feature level 9 graphics hardware, 0.

Declaration

public readonly uint VendorId { get; }

Property Value

Type	Description
uint

Methods

Equals(DxgiAdapterDesc2)

Declaration

public readonly bool Equals(DxgiAdapterDesc2 other)

Parameters

Type	Name	Description
DxgiAdapterDesc2	other

Returns

Type	Description
bool

Equals(object?)

Declaration

public override readonly bool Equals(object? obj)

Parameters

Type	Name	Description
object	obj

Returns

Type	Description
bool

Overrides

ValueType.Equals(object)

GetAdapterDescriptionAsSpan()

Gets a string as span that contains the adapter description. On feature level 9 graphics hardware, “Software Adapter”.

Declaration

public readonly ReadOnlySpan<char> GetAdapterDescriptionAsSpan()

Returns

Type	Description
ReadOnlySpan<char>

GetAdapterDescriptionCharCount()

Gets the char count of the string that contains the adapter description. On feature level 9 graphics hardware, “Software Adapter”.

Declaration

public readonly int GetAdapterDescriptionCharCount()

Returns

Type	Description
int

GetAdapterDescriptionChars(Span<char>)

Gets the chars of the string that contains the adapter description. On feature level 9 graphics hardware, “Software Adapter”.

Declaration

public readonly void GetAdapterDescriptionChars(Span<char> desc)

Parameters

Type	Name	Description
Span<char>	desc

GetHashCode()

Declaration

public override readonly int GetHashCode()

Returns

Type	Description
int

Overrides

ValueType.GetHashCode()

NativeReadFrom(nint)

Declaration

public static DxgiAdapterDesc2 NativeReadFrom(nint buffer)

Parameters

Type	Name	Description
nint	buffer

Returns

Type	Description
DxgiAdapterDesc2

NativeReadFrom(nint, Span<DxgiAdapterDesc2>)

Declaration

public static void NativeReadFrom(nint buffer, Span<DxgiAdapterDesc2> objects)

Parameters

Type	Name	Description
nint	buffer
Span<DxgiAdapterDesc2>	objects

NativeRequiredSize()

Declaration

public static int NativeRequiredSize()

Returns

Type	Description
int

NativeRequiredSize(int)

Declaration

public static int NativeRequiredSize(int count)

Parameters

Type	Name	Description
int	count

Returns

Type	Description
int

NativeWriteTo(nint, in DxgiAdapterDesc2)

Declaration

public static void NativeWriteTo(nint buffer, in DxgiAdapterDesc2 obj)

Parameters

Type	Name	Description
nint	buffer
DxgiAdapterDesc2	obj

NativeWriteTo(nint, ReadOnlySpan<DxgiAdapterDesc2>)

Declaration

public static void NativeWriteTo(nint buffer, ReadOnlySpan<DxgiAdapterDesc2> objects)

Parameters

Type	Name	Description
nint	buffer
ReadOnlySpan<DxgiAdapterDesc2>	objects

ToString()

Returns a string that represents the current object.

Declaration

public override readonly string ToString()

Returns

Type	Description
string	A string that represents the current object.

Overrides

ValueType.ToString()

Operators

operator ==(DxgiAdapterDesc2, DxgiAdapterDesc2)

Declaration

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

Parameters

Type	Name	Description
DxgiAdapterDesc2	left
DxgiAdapterDesc2	right

Returns

Type	Description
bool

operator !=(DxgiAdapterDesc2, DxgiAdapterDesc2)

Declaration

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

Parameters

Type	Name	Description
DxgiAdapterDesc2	left
DxgiAdapterDesc2	right

Returns

Type	Description
bool

Implements

IEquatable<T>