Class DxgiDevice2

The IDXGIDevice2 interface implements a derived class for DXGI objects that produce image data. The interface exposes methods to block CPU processing until the GPU completes processing, and to offer resources to the operating system.

Inheritance

object

DXComObject

DxgiObject

DxgiDevice2

Implements

IDisposable

Inherited Members

DxgiObject.DxgiObjectGuid

DxgiObject.SetPrivateDataText(in Guid, string)

DxgiObject.SetPrivateDataText(in Guid, ReadOnlySpan<char>)

DxgiObject.GetPrivateDataText(in Guid)

DxgiObject.GetPrivateDataTextCharCount(in Guid)

DxgiObject.GetPrivateDataTextChars(in Guid, Span<char>)

DxgiObject.GetParent(in Guid)

DXComObject.Handle

DXComObject.Dispose()

DXComObject.AddRef()

DXComObject.Release()

DXComObject.QueryInterface(in Guid)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: JeremyAnsel.DirectX.Dxgi

Assembly: JeremyAnsel.DirectX.Dxgi.dll

Syntax

[SecurityCritical]
public class DxgiDevice2 : DxgiObject, IDisposable

Constructors

| Edit this page View Source

DxgiDevice2(nint)

Initializes a new instance of the DxgiDevice2 class.

Declaration

public DxgiDevice2(nint comPtr)

Parameters

Type	Name	Description
nint	comPtr

Fields

| Edit this page View Source

DxgiDevice2Guid

The interface GUID.

Declaration

public static readonly Guid DxgiDevice2Guid

Field Value

Type	Description
Guid

Properties

| Edit this page View Source

MaximumFrameLatency

Gets or sets the number of frames that the system is allowed to queue for rendering.

Declaration

public uint MaximumFrameLatency { get; set; }

Property Value

Type	Description
uint	The number of frames that can be queued for render. This value defaults to 3, but can range from 1 to 16.

Methods

| Edit this page View Source

CreateDeviceFromDevice(DXComObject)

Initializes a new instance of the DxgiDevice2 class.

Declaration

public static DxgiDevice2 CreateDeviceFromDevice(DXComObject device)

Parameters

Type	Name	Description
DXComObject	device	A device interface which implements the `IDxgiDevice2` interface.

Returns

Type	Description
DxgiDevice2

| Edit this page View Source

CreateDeviceFromDevice(nint)

Initializes a new instance of the DxgiDevice2 class.

Declaration

public static DxgiDevice2 CreateDeviceFromDevice(nint device)

Parameters

Type	Name	Description
nint	device	A device interface which implements the `IDxgiDevice2` interface.

Returns

Type	Description
DxgiDevice2

| Edit this page View Source

GetAdapter()

Returns the adapter for the specified device.

Declaration

public DxgiAdapter2 GetAdapter()

Returns

Type	Description
DxgiAdapter2	The adapter for the specified device.

| Edit this page View Source

OfferResources(DxgiResource2, DxgiOfferResourcePriority)

Allows the operating system to free the video memory of resources by discarding their content.

Declaration

public void OfferResources(DxgiResource2 resource, DxgiOfferResourcePriority priority)

Parameters

Type	Name	Description
DxgiResource2	resource	A `IDXGIResource` interface for the resource to offer.
DxgiOfferResourcePriority	priority	A `DXGI_OFFER_RESOURCE_PRIORITY`-typed value that indicates how valuable data is.

| Edit this page View Source

OfferResources(DxgiResource2?[]?, DxgiOfferResourcePriority)

Allows the operating system to free the video memory of resources by discarding their content.

Declaration

public void OfferResources(DxgiResource2?[]? resources, DxgiOfferResourcePriority priority)

Parameters

Type	Name	Description
DxgiResource2[]	resources	An array of pointers to `IDXGIResource` interfaces for the resources to offer.
DxgiOfferResourcePriority	priority	A `DXGI_OFFER_RESOURCE_PRIORITY`-typed value that indicates how valuable data is.

| Edit this page View Source

OfferResources(ReadOnlySpan<DxgiResource2>, DxgiOfferResourcePriority)

Allows the operating system to free the video memory of resources by discarding their content.

Declaration

public void OfferResources(ReadOnlySpan<DxgiResource2> resources, DxgiOfferResourcePriority priority)

Parameters

Type	Name	Description
ReadOnlySpan<DxgiResource2>	resources	An array of pointers to `IDXGIResource` interfaces for the resources to offer.
DxgiOfferResourcePriority	priority	A `DXGI_OFFER_RESOURCE_PRIORITY`-typed value that indicates how valuable data is.

| Edit this page View Source

QueryResourceResidency(DxgiResource2)

Gets the residency status of a resource.

Declaration

public DxgiResidency QueryResourceResidency(DxgiResource2 resource)

Parameters

Type	Name	Description
DxgiResource2	resource	An `IDXGIResource` interfaces.

Returns

Type	Description
DxgiResidency	A `DXGI_RESIDENCY` flags. Each element describes the residency status for corresponding element in the `resources` argument array.

| Edit this page View Source

QueryResourceResidency(DxgiResource2?[]?)

Gets the residency status of an array of resources.

Declaration

public DxgiResidency[] QueryResourceResidency(DxgiResource2?[]? resources)

Parameters

Type	Name	Description
DxgiResource2[]	resources	An array of `IDXGIResource` interfaces.

Returns

Type	Description
DxgiResidency[]	An array of `DXGI_RESIDENCY` flags. Each element describes the residency status for corresponding element in the `resources` argument array.

| Edit this page View Source

QueryResourceResidency(ReadOnlySpan<DxgiResource2>, Span<DxgiResidency>)

Gets the residency status of an array of resources.

Declaration

public void QueryResourceResidency(ReadOnlySpan<DxgiResource2> resources, Span<DxgiResidency> residencies)

Parameters

Type	Name	Description
ReadOnlySpan<DxgiResource2>	resources	An array of `IDXGIResource` interfaces.
Span<DxgiResidency>	residencies	An array of `DXGI_RESIDENCY` flags. Each element describes the residency status for corresponding element in the `resources` argument array.

| Edit this page View Source

ReclaimResources(DxgiResource2)

Restores access to resources that were previously offered by calling IDXGIDevice2::OfferResources.

Declaration

public bool ReclaimResources(DxgiResource2 resource)

Parameters

Type	Name	Description
DxgiResource2	resource	An `IDXGIResource` interface for the resources to reclaim.

Returns

Type	Description
bool	A pointer to an array that receives Boolean values. Each value in the array corresponds to a resource at the same index that the ppResources parameter specifies. The runtime sets each Boolean value to TRUE if the corresponding resource’s content was discarded and is now undefined, or to FALSE if the corresponding resource’s old content is still intact. The caller can pass in NULL, if the caller intends to fill the resources with new content regardless of whether the old content was discarded.

Type

Description

bool

A pointer to an array that receives Boolean values. Each value in the array corresponds to a resource at the same index that the ppResources parameter specifies. The runtime sets each Boolean value to TRUE if the corresponding resource’s content was discarded and is now undefined, or to FALSE if the corresponding resource’s old content is still intact. The caller can pass in NULL, if the caller intends to fill the resources with new content regardless of whether the old content was discarded.

| Edit this page View Source

ReclaimResources(DxgiResource2?[]?)

Restores access to resources that were previously offered by calling IDXGIDevice2::OfferResources.

Declaration

public bool[] ReclaimResources(DxgiResource2?[]? resources)

Parameters

Type	Name	Description
DxgiResource2[]	resources	An array of pointers to `IDXGIResource` interfaces for the resources to reclaim.

Returns

Type	Description
bool[]	A pointer to an array that receives Boolean values. Each value in the array corresponds to a resource at the same index that the ppResources parameter specifies. The runtime sets each Boolean value to TRUE if the corresponding resource’s content was discarded and is now undefined, or to FALSE if the corresponding resource’s old content is still intact. The caller can pass in NULL, if the caller intends to fill the resources with new content regardless of whether the old content was discarded.

Type

Description

bool[]

| Edit this page View Source

ReclaimResources(ReadOnlySpan<DxgiResource2>, Span<bool>)

Restores access to resources that were previously offered by calling IDXGIDevice2::OfferResources.

Declaration

public void ReclaimResources(ReadOnlySpan<DxgiResource2> resources, Span<bool> discarded)

Parameters

Type	Name	Description
ReadOnlySpan<DxgiResource2>	resources	An array of pointers to `IDXGIResource` interfaces for the resources to reclaim.
Span<bool>	discarded	A pointer to an array that receives Boolean values. Each value in the array corresponds to a resource at the same index that the ppResources parameter specifies. The runtime sets each Boolean value to TRUE if the corresponding resource’s content was discarded and is now undefined, or to FALSE if the corresponding resource’s old content is still intact. The caller can pass in NULL, if the caller intends to fill the resources with new content regardless of whether the old content was discarded.

Implements

IDisposable