Class DxgiFactory3

Enables creating Microsoft DirectX Graphics Infrastructure (DXGI) objects.

Inheritance

object

DXComObject

DxgiObject

DxgiFactory3

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 DxgiFactory3 : DxgiObject, IDisposable

Constructors

| Edit this page View Source

DxgiFactory3(nint)

Initializes a new instance of the DxgiFactory3 class.

Declaration

public DxgiFactory3(nint comPtr)

Parameters

Type	Name	Description
nint	comPtr

Fields

| Edit this page View Source

DxgiFactory3Guid

The interface GUID.

Declaration

public static readonly Guid DxgiFactory3Guid

Field Value

Type	Description
Guid

Properties

| Edit this page View Source

CreationOptions

Gets the flags that were used when a Microsoft DirectX Graphics Infrastructure (DXGI) object was created.

Declaration

public DxgiCreateFactoryOptions CreationOptions { get; }

Property Value

Type	Description
DxgiCreateFactoryOptions

| Edit this page View Source

IsCurrent

Gets a value indicating whether the adapter has not changed.

Declaration

public bool IsCurrent { get; }

Property Value

Type	Description
bool

| Edit this page View Source

IsWindowedStereoEnabled

Gets a value indicating whether to use stereo mode.

Declaration

public bool IsWindowedStereoEnabled { get; }

Property Value

Type	Description
bool

| Edit this page View Source

WindowAssociation

Gets the window through which the user controls the transition to and from full screen.

Declaration

public nint WindowAssociation { get; }

Property Value

Type	Description
nint

Methods

| Edit this page View Source

Create()

Creates a DXGI 1.3 factory that you can use to generate other DXGI objects.

Declaration

public static DxgiFactory3 Create()

Returns

Type	Description
DxgiFactory3	A DxgiFactory3 object.

| Edit this page View Source

Create(DxgiCreateFactoryOptions)

Creates a DXGI 1.3 factory that you can use to generate other DXGI objects.

Declaration

public static DxgiFactory3 Create(DxgiCreateFactoryOptions options)

Parameters

Type	Name	Description
DxgiCreateFactoryOptions	options	The creation options.

Returns

Type	Description
DxgiFactory3	A DxgiFactory3 object.

| Edit this page View Source

CreateSoftwareAdapter(nint)

Create an adapter interface that represents a software adapter.

Declaration

public DxgiAdapter3 CreateSoftwareAdapter(nint module)

Parameters

Type	Name	Description
nint	module	Handle to the software adapter's dll.

Returns

Type	Description
DxgiAdapter3	An adapter.

| Edit this page View Source

CreateSwapChainForWindowHandle(DXComObject, nint, in DxgiSwapChainDesc1)

Creates a swap chain that is associated with an HWND handle to the output window for the swap chain.

Declaration

public DxgiSwapChain3 CreateSwapChainForWindowHandle(DXComObject device, nint hwnd, in DxgiSwapChainDesc1 desc)

Parameters

Type	Name	Description
DXComObject	device	The Direct3D device for the swap chain.
nint	hwnd	The `HWND` handle that is associated with the swap chain.
DxgiSwapChainDesc1	desc	A `DXGI_SWAP_CHAIN_DESC1` structure for the swap-chain description.

Returns

Type	Description
DxgiSwapChain3	The `IDXGISwapChain2` interface for the swap chain.

| Edit this page View Source

CreateSwapChainForWindowHandle(DXComObject, nint, in DxgiSwapChainDesc1, in DxgiSwapChainFullscreenDesc?, DxgiOutput3?)

Creates a swap chain that is associated with an HWND handle to the output window for the swap chain.

Declaration

public DxgiSwapChain3 CreateSwapChainForWindowHandle(DXComObject device, nint hwnd, in DxgiSwapChainDesc1 desc, in DxgiSwapChainFullscreenDesc? fullscreenDesc, DxgiOutput3? restrictToOutput)

Parameters

Type	Name	Description
DXComObject	device	The Direct3D device for the swap chain.
nint	hwnd	The `HWND` handle that is associated with the swap chain.
DxgiSwapChainDesc1	desc	A `DXGI_SWAP_CHAIN_DESC1` structure for the swap-chain description.
DxgiSwapChainFullscreenDesc?	fullscreenDesc	A `DXGI_SWAP_CHAIN_FULLSCREEN_DESC` structure for the description of a full-screen swap chain.
DxgiOutput3	restrictToOutput	The `IDXGIOutput` interface for the output to restrict content to.

Returns

Type	Description
DxgiSwapChain3	The `IDXGISwapChain2` interface for the swap chain.

| Edit this page View Source

CreateSwapChainForWindowHandle(nint, nint, in DxgiSwapChainDesc1)

Creates a swap chain that is associated with an HWND handle to the output window for the swap chain.

Declaration

public DxgiSwapChain3 CreateSwapChainForWindowHandle(nint device, nint hwnd, in DxgiSwapChainDesc1 desc)

Parameters

Type	Name	Description
nint	device	The Direct3D device for the swap chain.
nint	hwnd	The `HWND` handle that is associated with the swap chain.
DxgiSwapChainDesc1	desc	A `DXGI_SWAP_CHAIN_DESC1` structure for the swap-chain description.

Returns

Type	Description
DxgiSwapChain3	The `IDXGISwapChain2` interface for the swap chain.

| Edit this page View Source

CreateSwapChainForWindowHandle(nint, nint, in DxgiSwapChainDesc1, in DxgiSwapChainFullscreenDesc?, DxgiOutput3?)

Creates a swap chain that is associated with an HWND handle to the output window for the swap chain.

Declaration

public DxgiSwapChain3 CreateSwapChainForWindowHandle(nint device, nint hwnd, in DxgiSwapChainDesc1 desc, in DxgiSwapChainFullscreenDesc? fullscreenDesc, DxgiOutput3? restrictToOutput)

Parameters

Type	Name	Description
nint	device	The Direct3D device for the swap chain.
nint	hwnd	The `HWND` handle that is associated with the swap chain.
DxgiSwapChainDesc1	desc	A `DXGI_SWAP_CHAIN_DESC1` structure for the swap-chain description.
DxgiSwapChainFullscreenDesc?	fullscreenDesc	A `DXGI_SWAP_CHAIN_FULLSCREEN_DESC` structure for the description of a full-screen swap chain.
DxgiOutput3	restrictToOutput	The `IDXGIOutput` interface for the output to restrict content to.

Returns

Type	Description
DxgiSwapChain3	The `IDXGISwapChain2` interface for the swap chain.

| Edit this page View Source

EnumAdapters()

Enumerates the adapters (video cards).

Declaration

public IEnumerable<DxgiAdapter3> EnumAdapters()

Returns

Type	Description
IEnumerable<DxgiAdapter3>	An IEnumerable of DxgiAdapter3.

| Edit this page View Source

EnumAdapters(uint)

Enumerates the adapters (video cards).

Declaration

public DxgiAdapter3? EnumAdapters(uint i)

Parameters

Type	Name	Description
uint	i

Returns

Type	Description
DxgiAdapter3	An adapter or null

| Edit this page View Source

GetAdapter(uint)

Enumerates the adapters (video cards).

Declaration

public DxgiAdapter3 GetAdapter(uint i)

Parameters

Type	Name	Description
uint	i

Returns

Type	Description
DxgiAdapter3	An adapter.

| Edit this page View Source

GetAdapterCount()

Get the adapter count (video cards).

Declaration

public int GetAdapterCount()

Returns

Type	Description
int

| Edit this page View Source

MakeWindowAssociation(nint, DxgiWindowAssociationOptions)

Allows DXGI to monitor an application's message queue for the alt-enter key sequence (which causes the application to switch from windowed to full screen or vice versa).

Declaration

public void MakeWindowAssociation(nint windowHandle, DxgiWindowAssociationOptions options)

Parameters

Type	Name	Description
nint	windowHandle	The handle of the window that is to be monitored. This parameter can be Zero; but only if the flags are also 0.
DxgiWindowAssociationOptions	options	One or more options.

Implements

IDisposable