Documentation  

Last Update: Dec 2012

SharpDX.DXGI Namespace

The SharpDX.DXGI namespace provides a managed DXGI API.

  Platforms Name Unmanaged Description
Adapter IDXGIAdapter

The Adapter interface represents a display sub-system (including one or more GPU's, DACs and video memory).

 
Adapter1 IDXGIAdapter1

The Adapter1 interface represents a display sub-system (including one or more GPU's, DACs and video memory).

 
Adapter2 IDXGIAdapter2

[This documentation is preliminary and is subject to change.]

Applies to: desktop apps | Metro style apps

Gets a Microsoft DirectX Graphics Infrastructure (DXGI) 1.2 description of an adapter or video card. This description includes information about the granularity at which the graphics processing unit (GPU) can be preempted from performing its current task.

 
DXGIObject IDXGIObject

An DXGIObject interface is a base interface for all DXGI objects; DXGIObject supports associating caller-defined (private data) with an object and retrieval of an interface to the parent object.

 
Device IDXGIDevice

An Device interface implements a derived class for DXGI objects that produce image data.

 
Device1 IDXGIDevice1

An Device1 interface implements a derived class for DXGI objects that produce image data.

 
Device2 IDXGIDevice2

[This documentation is preliminary and is subject to change.]

Applies to: desktop apps | Metro style apps

Flushes any outstanding rendering commands and sets the specified event object to the signaled state after all previously submitted rendering commands complete.

 
DeviceChild IDXGIDeviceSubObject

Inherited from objects that are tied to the device so that they can retrieve a reference to it.

 
DisplayControl IDXGIDisplayControl

[This documentation is preliminary and is subject to change.]

Applies to: desktop apps only

The DisplayControl interface exposes methods to indicate user preference for the operating system's stereoscopic 3D display behavior and to set stereoscopic 3D display status to enable or disable.

We recommend that you not use DisplayControl to query or set system-wide stereoscopic 3D settings in your stereoscopic 3D apps. Instead, for your windowed apps, call the IsWindowedStereoEnabled method to determine whether to render in stereo; for your full-screen apps, call the GetDisplayModeList1 method and then determine whether any of the returned display modes support rendering in stereo.

 
Factory IDXGIFactory

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

 
Factory1 IDXGIFactory1

The Factory1 interface implements methods for generating DXGI objects.

 
Factory2 IDXGIFactory2

[This documentation is preliminary and is subject to change.]

Applies to: desktop apps | Metro style apps

Creates a swap chain that is associated with an IWindow object for the output window for the swap chain.

 
FormatHelper Helper to use with Format
ISurfaceImageSourceNative ISurfaceImageSourceNative

[This documentation is preliminary and is subject to change.]

Applies to: desktop apps only

Closes the surface draw operation.

 
ISwapChainBackgroundPanelNative ISwapChainBackgroundPanelNative

[This documentation is preliminary and is subject to change.]

Applies to: desktop apps only

Provides interoperation between XAML and a DirectX swap chain.

 
IVirtualSurfaceImageSourceNative IVirtualSurfaceImageSourceNative

[This documentation is preliminary and is subject to change.]

Applies to: Metro style apps only

Provides the implementation of a large (greater than the screen size) shared surface for DirectX drawing.

 
KeyedMutex IDXGIKeyedMutex

Using a key, acquires exclusive rendering access to a shared resource.

 
Output IDXGIOutput

An Output interface represents an adapter output (such as a monitor).

 
Output1 IDXGIOutput1

[This documentation is preliminary and is subject to change.]

Applies to: desktop apps only

Creates a desktop duplication interface from the Output1 interface that represents an adapter output.

 
OutputDuplication IDXGIOutputDuplication

[This documentation is preliminary and is subject to change.]

Applies to: desktop apps only

The OutputDuplication interface accesses and manipulates the duplicated desktop image.

 
Resource IDXGIResource

An Resource interface allows resource sharing and identifies the memory that a resource resides in.

 
Resource1 IDXGIResource1

[This documentation is preliminary and is subject to change.]

Applies to: desktop apps | Metro style apps

Creates a handle to a shared resource. You can then use the returned handle with multiple Direct3D devices.

 
ResultCode Functions 
Surface IDXGISurface

The Surface interface implements methods for image-data objects.

 
Surface1 IDXGISurface1

The Surface1 interface extends the Surface by adding support for using Windows Graphics Device Interface (GDI) to render to a Microsoft DirectX Graphics Infrastructure (DXGI) surface.

 
Surface2 IDXGISurface2

[This documentation is preliminary and is subject to change.]

Applies to: desktop apps | Metro style apps

The Surface2 interface extends the Surface1 interface by adding support for subresource surfaces and getting a handle to a shared resource.

 
SwapChain IDXGISwapChain

An SwapChain interface implements one or more surfaces for storing rendered data before presenting it to an output.

 
SwapChain1 IDXGISwapChain1

[This documentation is preliminary and is subject to change.]

Applies to: desktop apps | Metro style apps

Provides presentation capabilities that are enhanced from SwapChain. These presentation capabilities consist of specifying dirty rectangles and scroll rectangle to optimize the presentation.

 
Top
  Platforms Name Unmanaged Description
AdapterDescription DXGI_ADAPTER_DESC

Describes an adapter (or video card) by using DXGI 1.0.

 
AdapterDescription1 DXGI_ADAPTER_DESC1

Describes an adapter (or video card) using DXGI 1.1.

 
AdapterDescription2 DXGI_ADAPTER_DESC2

[This documentation is preliminary and is subject to change.]

Applies to: desktop apps | Metro style apps

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

 
FrameStatistics DXGI_FRAME_STATISTICS

Describes timing and presentation statistics for a frame.

 
GammaControl DXGI_GAMMA_CONTROL

Controls the settings of a gamma curve.

 
GammaControlCapabilities DXGI_GAMMA_CONTROL_CAPABILITIES

Controls the gamma capabilities of an adapter.

 
ModeDescription DXGI_MODE_DESC

Describes a display mode.

 
ModeDescription1 DXGI_MODE_DESC1

[This documentation is preliminary and is subject to change.]

Applies to: desktop apps | Metro style apps

Describes a display mode and whether the display mode supports stereo.

 
OutputDescription DXGI_OUTPUT_DESC

Describes an output or physical connection between the adapter (video card) and a device.

 
OutputDuplicateDescription DXGI_OUTDUPL_DESC

[This documentation is preliminary and is subject to change.]

Applies to: desktop apps only

The OutputDuplicateDescription structure describes the dimension of the output and the surface that contains the desktop image. The format of the desktop image is always B8G8R8A8_UNorm.

 
OutputDuplicateFrameInformation DXGI_OUTDUPL_FRAME_INFO

[This documentation is preliminary and is subject to change.]

Applies to: desktop apps only

The OutputDuplicateFrameInformation structure describes the current desktop image.

 
OutputDuplicateMoveRectangle DXGI_OUTDUPL_MOVE_RECT

[This documentation is preliminary and is subject to change.]

Applies to: desktop apps only

The OutputDuplicateMoveRectangle structure describes the movement of a rectangle.

 
OutputDuplicatePointerPosition DXGI_OUTDUPL_POINTER_POSITION

[This documentation is preliminary and is subject to change.]

Applies to: desktop apps only

The OutputDuplicatePointerPosition structure describes the position of the hardware cursor.

 
OutputDuplicatePointerShapeInformation DXGI_OUTDUPL_POINTER_SHAPE_INFO

[This documentation is preliminary and is subject to change.]

Applies to: desktop apps only

The OutputDuplicatePointerShapeInformation structure describes information about the cursor shape.

 
PresentParameters DXGI_PRESENT_PARAMETERS

[This documentation is preliminary and is subject to change.]

Applies to: desktop apps | Metro style apps

Describes information about present that helps the operating system optimize presentation.

 
Rational DXGI_RATIONAL

Represents a rational number.

 
SampleDescription DXGI_SAMPLE_DESC

Describes multi-sampling parameters for a resource.

 
SharedResource DXGI_SHARED_RESOURCE

Represents a handle to a shared resource.

 
SurfaceDescription DXGI_SURFACE_DESC

Describes a surface.

 
SwapChainDescription DXGI_SWAP_CHAIN_DESC

Describes a swap chain.

 
SwapChainDescription1 DXGI_SWAP_CHAIN_DESC1

[This documentation is preliminary and is subject to change.]

Applies to: desktop apps | Metro style apps

Describes a swap chain.

 
SwapChainFullScreenDescription DXGI_SWAP_CHAIN_FULLSCREEN_DESC

[This documentation is preliminary and is subject to change.]

Describes full-screen mode for a swap chain.

 
Top
  Platforms Name Unmanaged Description
AdapterFlags DXGI_ADAPTER_FLAG

Identifies the type of DXGI adapter.

 
AlphaMode DXGI_ALPHA_MODE

[This documentation is preliminary and is subject to change.]

Applies to: desktop apps | Metro style apps

Identifies the alpha value, transparency behavior, of a surface.

 
ComputePreemptionGranularity DXGI_COMPUTE_PREEMPTION_GRANULARITY

[This documentation is preliminary and is subject to change.]

Applies to: desktop apps | Metro style apps

Identifies the granularity at which the graphics processing unit (GPU) can be preempted from performing its current compute task.

 
DXGIStatus DXGI_STATUS

Status codes that can be returned by DXGI functions.

 
DisplayModeEnumerationFlags DXGI_ENUM_MODES_FLAGS No documentation. 
DisplayModeRotation DXGI_MODE_ROTATION

Flags that indicate how the back buffers should be rotated to fit the physical rotation of a monitor.

 
DisplayModeScaling DXGI_MODE_SCALING

Flags indicating how an image is stretched to fit a given monitor's resolution.

 
DisplayModeScanlineOrder DXGI_MODE_SCANLINE_ORDER

Flags indicating the method the raster uses to create an image on a surface.

 
Format DXGI_FORMAT

Resource data formats which includes fully-typed and typeless formats. There is a list of format modifiers at the bottom of the page, that more fully describes each format type.

 
GraphicsPreemptionGranularity DXGI_GRAPHICS_PREEMPTION_GRANULARITY

[This documentation is preliminary and is subject to change.]

Applies to: desktop apps | Metro style apps

Identifies the granularity at which the graphics processing unit (GPU) can be preempted from performing its current graphics rendering task.

 
MapFlags DXGI_MAP_FLAGS No documentation. 
OfferResourcePriority DXGI_OFFER_RESOURCE_PRIORITY

[This documentation is preliminary and is subject to change.]

Applies to: desktop apps | Metro style apps

Identifies the importance of a resource?s content when you call the OfferResources method to offer the resource.

 
OutputDuplicatePointerShapeType DXGI_OUTDUPL_POINTER_SHAPE_TYPE

[This documentation is preliminary and is subject to change.]

Applies to: desktop apps only

Identifies the type of reference shape.

 
PresentFlags DXGI_PRESENT_FLAGS No documentation. 
Residency DXGI_RESIDENCY

Flags indicating the memory location of a resource.

 
ResourcePriority DXGI_RESOURCE_PRIORITY No documentation. 
Scaling DXGI_SCALING

[This documentation is preliminary and is subject to change.]

Applies to: desktop apps | Metro style apps

Identifies resize behavior when the back-buffer size does not match the size of the target output.

 
SharedResourceFlags DXGI_SHARED_RESOURCE_FLAGS No documentation. 
SwapChainFlags DXGI_SWAP_CHAIN_FLAG

Options for swap-chain behavior.

 
SwapEffect DXGI_SWAP_EFFECT

Options for handling pixels in a display surface after calling Present.

 
Usage DXGI_USAGE_ENUM No documentation. 
WindowAssociationFlags DXGI_MWA_FLAGS No documentation. 
Top
Supported in:

    
 All Windows Desktop - .NET 2.0+ - .NET 4.0+
    
 Windows 8 Metro - DirectX11.1 - .NET 4.5 Core
    
 Windows Phone 8 - DirectX11.1 - .NET 4.5 Core
    
 Windows 8 Desktop - DirectX11.1 - .NET 4.0+