Class DxgiFactory3

Enables creating Microsoft DirectX Graphics Infrastructure (DXGI) objects.

Inheritance

object

DxgiObject

DxgiFactory3

Implements

IDisposable

IDxgiReleasable

Inherited Members

DxgiObject.ToBoolean()

DxgiObject.Dispose()

DxgiObject.Release()

DxgiObject.SetPrivateDataText(Guid, string)

DxgiObject.GetPrivateDataText(Guid)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: JeremyAnsel.DirectX.Dxgi

Assembly: JeremyAnsel.DirectX.Dxgi.dll

Syntax

public sealed class DxgiFactory3 : DxgiObject, IDisposable, IDxgiReleasable

Properties

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

Handle

Gets an handle representing the DXGI object interface.

Declaration

public override object Handle { get; }

Property Value

Type	Description
object

Overrides

DxgiObject.Handle

IsCurrent

Gets a value indicating whether the adapter has not changed.

Declaration

public bool IsCurrent { get; }

Property Value

Type	Description
bool

IsWindowedStereoEnabled

Gets a value indicating whether to use stereo mode.

Declaration

public bool IsWindowedStereoEnabled { get; }

Property Value

Type	Description
bool

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

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.

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.

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

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

Declaration

[SuppressMessage("Microsoft.Design", "CA1011:ConsiderPassingBaseTypesAsParameters", Justification = "Reviewed")]
[SuppressMessage("Microsoft.Reliability", "CA2000:Supprimer les objets avant la mise hors de portée", Justification = "Reviewed")]
public DxgiSwapChain3? CreateSwapChainForWindowHandle(object? device, nint hwnd, DxgiSwapChainDesc1 desc, DxgiSwapChainFullscreenDesc? fullscreenDesc, DxgiOutput3? restrictToOutput)

Parameters

Type	Name	Description
object	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 IDXGISwapChain1 interface for the swap chain.

EnumAdapters()

Enumerates both adapters (video cards) with or without outputs.

Declaration

public IEnumerable<DxgiAdapter3?> EnumAdapters()

Returns

Type	Description
IEnumerable<DxgiAdapter3>	An IEnumerable of DxgiAdapter3.

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

IDxgiReleasable