Class DxgiFactory

An IDXGIFactory interface implements methods for generating DXGI objects (which handle full screen transitions).

Inheritance

object

DXComObject

DxgiObject

DxgiFactory

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

Constructors

| Edit this page View Source

DxgiFactory(nint)

Initializes a new instance of the DxgiFactory class.

Declaration

public DxgiFactory(nint comPtr)

Parameters

Type	Name	Description
nint	comPtr

Fields

| Edit this page View Source

DxgiFactoryGuid

The interface GUID.

Declaration

public static readonly Guid DxgiFactoryGuid

Field Value

Type	Description
Guid

Properties

| 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.0 factory that you can use to generate other DXGI objects.

Declaration

public static DxgiFactory Create()

Returns

Type	Description
DxgiFactory	A DxgiFactory object.

| Edit this page View Source

CreateSoftwareAdapter(nint)

Create an adapter interface that represents a software adapter.

Declaration

public DxgiAdapter CreateSoftwareAdapter(nint module)

Parameters

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

Returns

Type	Description
DxgiAdapter	An adapter.

| Edit this page View Source

CreateSwapChain(DXComObject, in DxgiSwapChainDesc)

Creates a swap chain.

Declaration

public DxgiSwapChain CreateSwapChain(DXComObject device, in DxgiSwapChainDesc desc)

Parameters

Type	Name	Description
DXComObject	device	A Direct3D device that will write 2D images to the swap chain.
DxgiSwapChainDesc	desc	A `DXGI_SWAP_CHAIN_DESC` structure for the swap-chain description.

Returns

Type	Description
DxgiSwapChain	An `IDXGISwapChain` interface for the swap chain

| Edit this page View Source

CreateSwapChain(nint, in DxgiSwapChainDesc)

Creates a swap chain.

Declaration

public DxgiSwapChain CreateSwapChain(nint device, in DxgiSwapChainDesc desc)

Parameters

Type	Name	Description
nint	device	A Direct3D device that will write 2D images to the swap chain.
DxgiSwapChainDesc	desc	A `DXGI_SWAP_CHAIN_DESC` structure for the swap-chain description.

Returns

Type	Description
DxgiSwapChain	An `IDXGISwapChain` interface for the swap chain

| Edit this page View Source

EnumAdapters()

Enumerates the adapters (video cards).

Declaration

public IEnumerable<DxgiAdapter> EnumAdapters()

Returns

Type	Description
IEnumerable<DxgiAdapter>	An IEnumerable of DxgiAdapter.

| Edit this page View Source

EnumAdapters(uint)

Enumerates the adapters (video cards).

Declaration

public DxgiAdapter? EnumAdapters(uint i)

Parameters

Type	Name	Description
uint	i

Returns

Type	Description
DxgiAdapter	An adapter or null

| Edit this page View Source

GetAdapter(uint)

Enumerates the adapters (video cards).

Declaration

public DxgiAdapter GetAdapter(uint i)

Parameters

Type	Name	Description
uint	i

Returns

Type	Description
DxgiAdapter	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