SharpDX.DXGI

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

IDXGIAdapter

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

IDXGIObject

Initializes a new instance of the class.

The native pointer.

Sets application-defined data to the object and associates that data with a .

A that identifies the data. Use this in a call to GetPrivateData to get the data. The size of the object's data. A reference to the object's data. Returns one of the DXGI_ERROR values. SetPrivateData makes a copy of the specified data and stores it with the object.Private data that SetPrivateData stores in the object occupies the same storage space as private data that is stored by associated Direct3D objects (for example, by a Microsoft Direct3D?11 device through or by a Direct3D?11 child device through ).The debug layer reports memory leaks by outputting a list of object interface references along with their friendly names. The default friendly name is "<unnamed>". You can set the friendly name so that you can determine if the corresponding object interface reference caused the leak. To set the friendly name, use the SetPrivateData method and the well-known private data () that is in D3Dcommon.h. For example, to give pContext a friendly name of My name, use the following code:

	
             static const char c_szName[] = "My name";	
            hr = pContext->SetPrivateData( , sizeof( c_szName ) - 1, c_szName );

You can use to track down memory leaks and understand performance characteristics of your applications. This information is reflected in the output of the debug layer that is related to memory leaks (ID3D11Debug::ReportLiveDeviceObjects) and with the event tracing for Windows events that we've added to Windows Developer Preview. HRESULT IDXGIObject::SetPrivateData([In] const GUID& Name,[In] unsigned int DataSize,[In, Buffer] const void* pData)

Set an interface in the object's private data.

A identifying the interface. The interface to set. Returns one of the following DXGI_ERROR. This API associates an interface reference with the object.When the interface is set its reference count is incremented. When the data are overwritten (by calling SPD or SPDI with the same ) or the object is destroyed, ::Release() is called and the interface's reference count is decremented. HRESULT IDXGIObject::SetPrivateDataInterface([In] const GUID& Name,[In] const IUnknown* pUnknown)

Get a reference to the object's data.

A identifying the data. The size of the data. Pointer to the data. Returns one of the following DXGI_ERROR. If the data returned is a reference to an , or one of its derivative classes, previously set by , then ::Release() must be called on the reference before the reference is freed to decrement the reference count. HRESULT IDXGIObject::GetPrivateData([In] const GUID& Name,[InOut] unsigned int* pDataSize,[Out, Buffer] void* pData)

Gets the parent of the object.

The ID of the requested interface. The address of a reference to the parent object. Returns one of the DXGI_ERROR values. HRESULT IDXGIObject::GetParent([In] const GUID& riid,[Out] void** ppParent)

Checks to see if a device interface for a graphics component is supported by the system.

The GUID of the interface of the device version for which support is being checked. For example, typeof(ID3D10Device).GUID. true if the interface is supported; otherwise, false. HRESULT IDXGIAdapter::CheckInterfaceSupport([In] GUID* InterfaceName,[Out] __int64* pUMDVersion)

Checks to see if a device interface for a graphics component is supported by the system.

the interface of the device version for which support is being checked. true if the interface is supported; otherwise, false.

Checks to see if a device interface for a graphics component is supported by the system.

the interface of the device version for which support is being checked. The user mode driver version of InterfaceName. This is only returned if the interface is supported. true if the interface is supported; otherwise, false.

Checks to see if a device interface for a graphics component is supported by the system.

The GUID of the interface of the device version for which support is being checked. For example, typeof(ID3D10Device).GUID. The user mode driver version of InterfaceName. This is only returned if the interface is supported. true if the interface is supported; otherwise, false. HRESULT IDXGIAdapter::CheckInterfaceSupport([In] GUID* InterfaceName,[Out] __int64* pUMDVersion)

Return the number of available outputs from this adapter.

The number of outputs

Initializes a new instance of the class.

The native pointer.

Enumerate adapter (video card) outputs.

The index of the output. The address of a reference to an interface at the position specified by the Output parameter. When the EnumOutputs method succeeds and fills the ppOutput parameter with the address of the reference to the output interface, EnumOutputs increments the output interface's reference count. To avoid a memory leak, when you finish using the output interface, call the Release method to decrement the reference count.EnumOutputs first returns the output on which the desktop primary is displayed. This adapter corresponds with an index of zero. EnumOutputs then returns other outputs. HRESULT IDXGIAdapter::EnumOutputs([In] unsigned int Output,[Out] IDXGIOutput** ppOutput)

Gets a DXGI 1.0 description of an adapter (or video card).

A reference to a structure that describes the adapter. This parameter must not be null. Returns if successful; otherwise returns E_INVALIDARG if the pDesc parameter is null. Graphics applications can use the DXGI API to retrieve an accurate set of graphics memory values on systems that have WDDM drivers. The following are the critical steps involved.Graphics driver model determination ? Because DXGI is only available on systems with WDDM drivers, the application must first confirm the driver model by using the following API.

	
             HasWDDMDriver()	
            { LPDIRECT3DCREATE9EX pD3D9Create9Ex = null; HMODULE             hD3D9          = null; hD3D9 = LoadLibrary( L"d3d9.dll" ); if ( null == hD3D9 ) { return false; } // /*  Try to create IDirect3D9Ex interface (also known as a DX9L interface). This interface can only be created if the driver is a WDDM driver. */ // pD3D9Create9Ex = (LPDIRECT3DCREATE9EX) GetProcAddress( hD3D9, "Direct3DCreate9Ex" ); return pD3D9Create9Ex != null;	
            }

Retrieval of graphics memory values.? After the driver model is determined to be WDDM, the application can use the DirectX 10 or later API and DXGI to get the amount of graphics memory. After creating a Direct3D device the following code can be used to obtain a structure containing the amount of available graphics memory.

	
              * pDXGIDevice;	
            hr = g_pd3dDevice->QueryInterface(__uuidof(), (void **)&pDXGIDevice);	
             * pDXGIAdapter;	
            pDXGIDevice->GetAdapter(&pDXGIAdapter);	
             adapterDesc;	
            pDXGIAdapter->GetDesc(&adapterDesc);

HRESULT IDXGIAdapter::GetDesc([Out] DXGI_ADAPTER_DESC* pDesc)

Checks whether the system supports a device interface for a graphics component.

The of the interface of the device version for which support is being checked. For example, __uuidof(). The user mode driver version of InterfaceName. This is returned only if the interface is supported. This parameter can be null. S_OK indicates that the interface is supported, otherwise is returned (For more information, see DXGI_ERROR). Note??You can use CheckInterfaceSupport only to check whether a Direct3D 10.x interface is supported, and only on Windows Vista SP1 and later versions of the operating system. If you try to use CheckInterfaceSupport to check whether a Direct3D 11.x and later version interface is supported, CheckInterfaceSupport returns . Therefore, do not use CheckInterfaceSupport. Instead, to verify whether the operating system supports a particular interface, try to create the interface. For example, if you call the method and it fails, the operating system does not support the interface. HRESULT IDXGIAdapter::CheckInterfaceSupport([In] const GUID& InterfaceName,[Out] LARGE_INTEGER* pUMDVersion)

Gets a DXGI 1.0 description of an adapter (or video card).

Graphics applications can use the DXGI API to retrieve an accurate set of graphics memory values on systems that have WDDM drivers. The following are the critical steps involved.Graphics driver model determination ? Because DXGI is only available on systems with WDDM drivers, the application must first confirm the driver model by using the following API.

	
             HasWDDMDriver()	
            { LPDIRECT3DCREATE9EX pD3D9Create9Ex = null; HMODULE             hD3D9          = null; hD3D9 = LoadLibrary( L"d3d9.dll" ); if ( null == hD3D9 ) { return false; } // /*  Try to create IDirect3D9Ex interface (also known as a DX9L interface). This interface can only be created if the driver is a WDDM driver. */ // pD3D9Create9Ex = (LPDIRECT3DCREATE9EX) GetProcAddress( hD3D9, "Direct3DCreate9Ex" ); return pD3D9Create9Ex != null;	
            }

	
              * pDXGIDevice;	
            hr = g_pd3dDevice->QueryInterface(__uuidof(), (void **)&pDXGIDevice);	
             * pDXGIAdapter;	
            pDXGIDevice->GetAdapter(&pDXGIAdapter);	
             adapterDesc;	
            pDXGIAdapter->GetDesc(&adapterDesc);

GetDesc HRESULT IDXGIAdapter::GetDesc([Out] DXGI_ADAPTER_DESC* pDesc)

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

IDXGIDevice

Gets the residency status of an array of resources.

The information returned by the pResidencyStatus argument array describes the residency status at the time that the QueryResourceResidency method was called. Note that the residency status will constantly change. If you call the QueryResourceResidency method during a device removed state, the pResidencyStatus argument will return the DXGI_RESIDENCY_EVICTED_TO_DISK flag. Note??This method should not be called every frame as it incurs a non-trivial amount of overhead. An array of interfaces. Returns an array of flags. Each element describes the residency status for corresponding element in the ppResources argument array. HRESULT IDXGIDevice::QueryResourceResidency([In, Buffer] const IUnknown** ppResources,[Out, Buffer] DXGI_RESIDENCY* pResidencyStatus,[None] int NumResources)

Initializes a new instance of the class.

The native pointer.

Returns the adapter for the specified device.

The address of an interface reference to the adapter. This parameter must not be null. Returns if successful; otherwise, returns one of the DXGI_ERROR that indicates failure. If the pAdapter parameter is null this method returns E_INVALIDARG. If the GetAdapter method succeeds, the reference count on the adapter interface will be incremented. To avoid a memory leak, be sure to release the interface when you are finished using it. HRESULT IDXGIDevice::GetAdapter([Out] IDXGIAdapter** pAdapter)

Returns a surface. This method is used internally and you should not call it directly in your application.

A reference to a structure that describes the surface. The number of surfaces to create. A DXGI_USAGE flag that specifies how the surface is expected to be used. An optional reference to a structure that contains shared resource information for opening views of such resources. The address of an interface reference to the first created surface. Returns if successful; an error code otherwise. For a list of error codes, see DXGI_ERROR. The CreateSurface method creates a buffer to exchange data between one or more devices. It is used internally, and you should not directly call it.The runtime automatically creates an interface when it creates a Direct3D resource object that represents a surface. For example, the runtime creates an interface when it calls or to create a 2D texture. To retrieve the interface that represents the 2D texture surface, call ID3D11Texture2D::QueryInterface or ID3D10Texture2D::QueryInterface. In this call, you must pass the identifier of . If the 2D texture has only a single MIP-map level and does not consist of an array of textures, QueryInterface succeeds and returns a reference to the interface reference. Otherwise, QueryInterface fails and does not return the reference to . HRESULT IDXGIDevice::CreateSurface([In] const DXGI_SURFACE_DESC* pDesc,[In] unsigned int NumSurfaces,[In] unsigned int Usage,[In, Optional] const DXGI_SHARED_RESOURCE* pSharedResource,[Out] IDXGISurface** ppSurface)

Gets the residency status of an array of resources.

An array of interfaces. An array of flags. Each element describes the residency status for corresponding element in the ppResources argument array. The number of resources in the ppResources argument array and pResidencyStatus argument array. Returns if successfull; otherwise, returns , E_INVALIDARG, or E_POINTER (see WinError.h for more information). The information returned by the pResidencyStatus argument array describes the residency status at the time that the QueryResourceResidency method was called. Note that the residency status will constantly change.If you call the QueryResourceResidency method during a device removed state, the pResidencyStatus argument will return the flag.Note??This method should not be called every frame as it incurs a non-trivial amount of overhead. HRESULT IDXGIDevice::QueryResourceResidency([In, Buffer] const IUnknown** ppResources,[Out, Buffer] DXGI_RESIDENCY* pResidencyStatus,[In] unsigned int NumResources)

Gets the residency status of an array of resources.

Sets the GPU thread priority.

A value that specifies the required GPU thread priority. This value must be between -7 and 7, inclusive, where 0 represents normal priority. Return if successful; otherwise, returns E_INVALIDARG if the Priority parameter is invalid. The values for the Priority parameter function as follows:Positive values increase the likelihood that the GPU scheduler will grant GPU execution cycles to the device when rendering. Negative values lessen the likelihood that the device will receive GPU execution cycles when devices compete for them. The device is guaranteed to receive some GPU execution cycles at all settings.To use the SetGPUThreadPriority method, you should have a comprehensive understanding of GPU scheduling. You should profile your application to ensure that it behaves as intended. If used inappropriately, the SetGPUThreadPriority method can impede rendering speed and result in a poor user experience. HRESULT IDXGIDevice::SetGPUThreadPriority([In] int Priority)

Gets the GPU thread priority.

A reference to a variable that receives a value that indicates the current GPU thread priority. The value will be between -7 and 7, inclusive, where 0 represents normal priority. Return if successful; otherwise, returns E_POINTER if the pPriority parameter is null. HRESULT IDXGIDevice::GetGPUThreadPriority([Out] int* pPriority)

Returns the adapter for the specified device.

If the GetAdapter method succeeds, the reference count on the adapter interface will be incremented. To avoid a memory leak, be sure to release the interface when you are finished using it. GetAdapter HRESULT IDXGIDevice::GetAdapter([Out] IDXGIAdapter** pAdapter)

Gets the GPU thread priority.

GetGPUThreadPriority HRESULT IDXGIDevice::GetGPUThreadPriority([Out] int* pPriority)

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

IDXGIDeviceSubObject

Retrieves the device.

The interface that is returned can be any interface published by the device. The associated device. HRESULT IDXGIDeviceSubObject::GetDevice([In] GUID* riid,[Out] void** ppDevice)

Initializes a new instance of the class.

The native pointer.

Retrieves the device.

The reference id for the device. The address of a reference to the device. A code that indicates success or failure (see DXGI_ERROR). The type of interface that is returned can be any interface published by the device. For example, it could be an * called pDevice, and therefore the REFIID would be obtained by calling __uuidof(pDevice). HRESULT IDXGIDeviceSubObject::GetDevice([In] const GUID& riid,[Out] void** ppDevice)

Gets or sets the debug-name for this object.

The debug name.

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

IDXGIFactory

Default Constructor for Factory

Return the number of available adapters from this factory.

The number of adapters

Initializes a new instance of the class.

The native pointer.

Enumerates the adapters (video cards).

The index of the adapter to enumerate. The address of a reference to an interface at the position specified by the Adapter parameter. This parameter must not be null. When you create a factory, the factory enumerates the set of adapters that are available in the system. Therefore, if you change the adapters in a system, you must destroy and recreate the object. The number of adapters in a system changes when you add or remove a display card, or dock or undock a laptop.When the EnumAdapters method succeeds and fills the ppAdapter parameter with the address of the reference to the adapter interface, EnumAdapters increments the adapter interface's reference count. When you finish using the adapter interface, call the Release method to decrement the reference count before you destroy the reference.EnumAdapters first returns the local adapter with the output on which the desktop primary is displayed. This adapter corresponds with an index of zero. EnumAdapters then returns other adapters with outputs. HRESULT IDXGIFactory::EnumAdapters([In] unsigned int Adapter,[Out] IDXGIAdapter** ppAdapter)

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).

The handle of the window that is to be monitored. This parameter can be null; but only if the flags are also 0. One or more of the following values: - Prevent DXGI from monitoring an applications message queue; this makes DXGI unable to respond to mode changes. - Prevent DXGI from responding to an alt-enter sequence. - Prevent DXGI from responding to a print-screen key. if WindowHandle is invalid, or E_OUTOFMEMORY. The combination of WindowHandle and Flags informs DXGI to stop monitoring window messages for the previously-associated window.If the application switches to full-screen mode, DXGI will choose a full-screen resolution to be the smallest supported resolution that is larger or the same size as the current back buffer size.Applications can make some changes to make the transition from windowed to full screen more efficient. For example, on a WM_SIZE message, the application should release any outstanding swap-chain back buffers, call , then re-acquire the back buffers from the swap chain(s). This gives the swap chain(s) an opportunity to resize the back buffers, and/or recreate them to enable full-screen flipping operation. If the application does not perform this sequence, DXGI will still make the full-screen/windowed transition, but may be forced to use a stretch operation (since the back buffers may not be the correct size), which may be less efficient. Even if a stretch is not required, presentation may not be optimal because the back buffers might not be directly interchangeable with the front buffer. Thus, a call to ResizeBuffers on WM_SIZE is always recommended, since WM_SIZE is always sent during a fullscreen transition.While windowed, the application can, if it chooses, restrict the size of its window's client area to sizes to which it is comfortable rendering. A fully flexible application would make no such restriction, but UI elements or other design considerations can, of course, make this flexibility untenable. If the application further chooses to restrict its window's client area to just those that match supported full-screen resolutions, the application can field WM_SIZING, then check against . If a matching mode is found, allow the resize. (The can be retrieved from . Absent subsequent changes to desktop topology, this will be the same output that will be chosen when alt-enter is fielded and fullscreen mode is begun for that swap chain.)Applications that want to handle mode changes or Alt+Enter themselves should call MakeWindowAssociation with the flag after swap chain creation. The WindowHandle argument, if non-null, specifies that the application message queues will not be handled by the DXGI runtime for all swap chains of a particular target . Calling MakeWindowAssociation with the flag after swapchain creation ensures that DXGI will not interfere with application's handling of window mode changes or Alt+Enter.Notes for Metro style appsIf a Metro style app calls MakeWindowAssociation, it fails with .A Microsoft Win32 application can use MakeWindowAssociation to control full-screen transitions through the Alt+Enter key combination and print screen behavior for full screen. For Metro style apps, because DXGI cannot perform full-screen transitions, Metro style app have no way to control full-screen transitions. HRESULT IDXGIFactory::MakeWindowAssociation([In] HWND WindowHandle,[In] DXGI_MWA_FLAGS Flags)

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

A reference to a window handle. Notes for Metro style appsIf a Metro style app calls GetWindowAssociation, it fails with . HRESULT IDXGIFactory::GetWindowAssociation([Out] HWND* pWindowHandle)

[Starting with Direct3D 11.1, we recommend not to use CreateSwapChain anymore to create a swap chain. Instead, use CreateSwapChainForHwnd, CreateSwapChainForImmersiveWindow, or CreateSwapChainForCompositionSurface depending on how you want to create the swap chain.]

No documentation. No documentation. No documentation. if pDesc or ppSwapChain is null, if you request full-screen mode and it is unavailable, or E_OUTOFMEMORY. Other error codes defined by the type of device passed in may also be returned. If you attempt to create a swap chain in full-screen mode, and full-screen mode is unavailable, the swap chain will be created in windowed mode and will be returned.If the buffer width or the buffer height is zero, the sizes will be inferred from the output window size in the swap-chain description.Because the target output cannot be chosen explicitly when the swap-chain is created, you should not create a full-screen swap chain. This can reduce presentation performance if the swap chain size and the output window size do not match. Here are two ways to ensure that the sizes match:Create a windowed swap chain and then set it full-screen using . Save a reference to the swap chain immediately after creation, and use it to get the output window size during a WM_SIZE event. Then resize the swap chain buffers (with ) during the transition from windowed to full-screen.If the swap chain is in full-screen mode, before you release it you must use SetFullscreenState to switch it to windowed mode. For more information about releasing a swap chain, see the "Destroying a Swap Chain" section of DXGI Overview.You can specify and values in the swap-chain description that pDesc points to. These values allow you to use features like flip-model presentation and content protection by using pre-Windows Developer Preview APIs.However, to use stereo presentation and to change resize behavior for the flip model, applications must use the method. Otherwise, the back-buffer contents implicitly scale to fit the presentation target size; that is, you can't turn off scaling.Notes for Metro style appsIf a Metro style app calls CreateSwapChain with full screen specified, CreateSwapChain fails.Metro style apps call the method to create a swap chain. HRESULT IDXGIFactory::CreateSwapChain([In] IUnknown* pDevice,[In] DXGI_SWAP_CHAIN_DESC* pDesc,[Out, Fast] IDXGISwapChain** ppSwapChain)

Create an adapter interface that represents a software adapter.

Handle to the software adapter's dll. HMODULE can be obtained with GetModuleHandle or LoadLibrary. Address of a reference to an adapter (see ). A software adapter is a DLL that implements the entirety of a device driver interface, plus emulation, if necessary, of kernel-mode graphics components for Windows. Details on implementing a software adapter can be found in the Windows Vista Driver Development Kit. This is a very complex development task, and is not recommended for general readers.Calling this method will increment the module's reference count by one. The reference count can be decremented by calling FreeLibrary.The typical calling scenario is to call LoadLibrary, pass the handle to CreateSoftwareAdapter, then immediately call FreeLibrary on the DLL and forget the DLL's HMODULE. Since the software adapter calls FreeLibrary when it is destroyed, the lifetime of the DLL will now be owned by the adapter, and the application is free of any further consideration of its lifetime. HRESULT IDXGIFactory::CreateSoftwareAdapter([In] HINSTANCE Module,[Out] IDXGIAdapter** ppAdapter)

The interface implements methods for generating DXGI objects.

IDXGIFactory1

Default Constructor for Factory1.

Return the number of available adapters from this factory.

The number of adapters

Initializes a new instance of the class.

The native pointer.

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

The index of the adapter to enumerate. The address of a reference to an interface at the position specified by the Adapter parameter. This parameter must not be null. This method is not supported by DXGI 1.0, which shipped in Windows?Vista and Windows Server?2008. DXGI 1.1 support is required, which is available on Windows?7, Windows Server?2008?R2, and as an update to Windows?Vista with Service Pack?2 (SP2) (KB 971644) and Windows Server?2008 (KB 971512).When you create a factory, the factory enumerates the set of adapters that are available in the system. Therefore, if you change the adapters in a system, you must destroy and recreate the object. The number of adapters in a system changes when you add or remove a display card, or dock or undock a laptop.When the EnumAdapters1 method succeeds and fills the ppAdapter parameter with the address of the reference to the adapter interface, EnumAdapters1 increments the adapter interface's reference count. When you finish using the adapter interface, call the Release method to decrement the reference count before you destroy the reference.EnumAdapters1 first returns the local adapter with the output on which the desktop primary is displayed. This adapter corresponds with an index of zero. EnumAdapters1 next returns other adapters with outputs. EnumAdapters1 finally returns adapters without outputs. HRESULT IDXGIFactory1::EnumAdapters1([In] unsigned int Adapter,[Out] IDXGIAdapter1** ppAdapter)

Informs an application of the possible need to re-enumerate adapters.

FALSE, if a new adapter is becoming available or the current adapter is going away. TRUE, no adapter changes.IsCurrent returns to inform the calling application to re-enumerate adapters. This method is not supported by DXGI 1.0, which shipped in Windows?Vista and Windows Server?2008. DXGI 1.1 support is required, which is available on Windows?7, Windows Server?2008?R2, and as an update to Windows?Vista with Service Pack?2 (SP2) (KB 971644) and Windows Server?2008 (KB 971512). BOOL IDXGIFactory1::IsCurrent()

Informs an application of the possible need to re-enumerate adapters.

Helper to use with .

Calculates the size of a in bytes.

The dxgi format. size of in bytes

Calculates the size of a in bits.

The dxgi format. size of in bits

Identifies the type of DXGI adapter.

The enumerated type is used by the Flags member of the or structure to identify the type of DXGI adapter. DXGI_ADAPTER_FLAG

Specifies no flags.

DXGI_ADAPTER_FLAG_NONE

Value always set to 0. This flag is reserved.

DXGI_ADAPTER_FLAG_REMOTE

Specifies a software adapter. Direct3D 11:??This enumeration value is supported starting with Windows Developer Preview.

DXGI_ADAPTER_FLAG_SOFTWARE

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

For more information about alpha mode, see . DXGI_ALPHA_MODE

Indicates that the transparency behavior is not specified.

DXGI_ALPHA_MODE_UNSPECIFIED

Indicates that the transparency behavior is premultiplied. Each color is first scaled by the alpha value. The alpha value itself is the same in both straight and premultiplied alpha. Typically, no color channel value is greater than the alpha channel value. If a color channel value in a premultiplied format is greater than the alpha channel, the standard source-over blending math results in an additive blend.

DXGI_ALPHA_MODE_PREMULTIPLIED

Indicates that the transparency behavior is not premultiplied. The alpha channel indicates the transparency of the color.

DXGI_ALPHA_MODE_STRAIGHT

Indicates to ignore the transparency behavior.

DXGI_ALPHA_MODE_IGNORE

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

You call the method to retrieve the granularity level at which the GPU can be preempted from performing its current compute task. The operating system specifies the compute granularity level in the ComputePreemptionGranularity member of the structure. DXGI_COMPUTE_PREEMPTION_GRANULARITY

Indicates the preemption granularity as a compute packet.

DXGI_COMPUTE_PREEMPTION_DMA_BUFFER_BOUNDARY

Indicates the preemption granularity as a dispatch (for example, a call to the method). A dispatch is a part of a compute packet.

DXGI_COMPUTE_PREEMPTION_DISPATCH_BOUNDARY

Indicates the preemption granularity as a thread group. A thread group is a part of a dispatch.

DXGI_COMPUTE_PREEMPTION_THREAD_GROUP_BOUNDARY

Indicates the preemption granularity as a thread in a thread group. A thread is a part of a thread group.

DXGI_COMPUTE_PREEMPTION_THREAD_BOUNDARY

Indicates the preemption granularity as a compute instruction in a thread.

DXGI_COMPUTE_PREEMPTION_INSTRUCTION_BOUNDARY

No documentation.

DXGI_ENUM_MODES_FLAGS

No documentation.

DXGI_ENUM_MODES_INTERLACED

No documentation.

DXGI_ENUM_MODES_SCALING

No documentation.

DXGI_ENUM_MODES_STEREO

No documentation.

DXGI_ENUM_MODES_DISABLED_STEREO

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

DXGI_MODE_ROTATION

Unspecified rotation.

DXGI_MODE_ROTATION_UNSPECIFIED

Specifies no rotation.

DXGI_MODE_ROTATION_IDENTITY

Specifies 90 degrees of rotation.

DXGI_MODE_ROTATION_ROTATE90

Specifies 180 degrees of rotation.

DXGI_MODE_ROTATION_ROTATE180

Specifies 270 degrees of rotation.

DXGI_MODE_ROTATION_ROTATE270

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

DXGI_MODE_SCALING

Unspecified scaling.

DXGI_MODE_SCALING_UNSPECIFIED

Specifies no scaling. The image is centered on the display. This flag is typically used for a fixed-dot-pitch display (such as an LED display).

DXGI_MODE_SCALING_CENTERED

Specifies stretched scaling.

DXGI_MODE_SCALING_STRETCHED

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

DXGI_MODE_SCANLINE_ORDER

Scanline order is unspecified.

DXGI_MODE_SCANLINE_ORDER_UNSPECIFIED

The image is created from the first scanline to the last without skipping any.

DXGI_MODE_SCANLINE_ORDER_PROGRESSIVE

The image is created beginning with the upper field.

DXGI_MODE_SCANLINE_ORDER_UPPER_FIELD_FIRST

The image is created beginning with the lower field.

DXGI_MODE_SCANLINE_ORDER_LOWER_FIELD_FIRST

Status codes that can be returned by DXGI functions.

DXGI_STATUS

No documentation.

DXGI_STATUS_OCCLUDED

No documentation.

DXGI_STATUS_CLIPPED

No documentation.

DXGI_STATUS_NO_REDIRECTION

No documentation.

DXGI_STATUS_NO_DESKTOP_ACCESS

No documentation.

DXGI_STATUS_GRAPHICS_VIDPN_SOURCE_IN_USE

No documentation.

DXGI_STATUS_MODE_CHANGED

No documentation.

DXGI_STATUS_MODE_CHANGE_IN_PROGRESS

No documentation.

DXGI_STATUS_UNOCCLUDED

No documentation.

DXGI_STATUS_DDA_WAS_STILL_DRAWING

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.

A few formats have additional restrictions.A resource declared with the DXGI_FORMAT_R32G32B32 family of formats cannot be used simultaneously for vertex and texture data. That is, you may not create a buffer resource with the DXGI_FORMAT_R32G32B32 family of formats that uses any of the following bind flags: , , , or (see ). is designed specifically for text filtering, and must be used with a format-specific, configurable 8x8 filter mode. When calling an HLSL sampling function using this format, the address offset parameter must be set to (0,0). A resource using a sub-sampled format (such as DXGI_FORMAT_R8G8_B8G8) must have a size that is a multiple of 2 in the x dimension. Format is not available in Direct3D 10 and Direct3D 10.1The following topics provide lists of the formats that particular hardware feature levels support:Hardware Support for Direct3D 11.1 Formats Hardware Support for Direct3D 11 Formats Hardware Support for Direct3D 10.1 Formats Hardware Support for Direct3D 10 Formats Hardware Support for Direct3D 10Level9 FormatsFor a list of the DirectXMath types that map to values, see DirectXMath Library Internals.Format ModifiersEach enumeration value contains a format modifier which describes the data type.Format ModifiersDescription _FLOATA floating-point value; 32-bit floating-point formats use IEEE 754 single-precision (s23e8 format): sign bit, 8-bit biased (127) exponent, and 23-bit mantissa. 16-bit floating-point formats use half-precision (s10e5 format): sign bit, 5-bit biased (15) exponent, and 10-bit mantissa. _SINTTwo's complement signed integer. For example, a 3-bit SINT represents the values -4, -3, -2, -1, 0, 1, 2, 3. _SNORMSigned normalized integer; which is interpreted in a resource as a signed integer, and is interpreted in a shader as a signed normalized floating-point value in the range [-1, 1]. For an 2's complement number, the maximum value is 1.0f (a 5-bit value 01111 maps to 1.0f), and the minimum value is -1.0f (a 5-bit value 10000 maps to -1.0f). In addition, the second-minimum number maps to -1.0f (a 5-bit value 10001 maps to -1.0f). The resulting integer representations are evenly spaced floating-point values in the range (-1.0f...0.0f), and also a complementary set of representations for numbers in the range (0.0f...1.0f). _SRGBStandard RGB data, which roughly displays colors in a linear ramp of luminosity levels such that an average observer, under average viewing conditions, can view them on an average display. All 0's maps to 0.0f, and all 1's maps to 1.0f. The sequence of unsigned integer encodings between all 0's and all 1's represent a nonlinear progression in the floating-point interpretation of the numbers between 0.0f to 1.0f. For more detail, see the SRGB color standard, IEC 61996-2-1, at IEC (International Electrotechnical Commission). Conversion to or from sRGB space is automatically done by D3DX10 or D3DX9 texture-load functions. If the format has an alpha channel, the alpha data is also stored in sRGB color space. _TYPELESSTypeless data, with a defined number of bits. Typeless formats are designed for creating typeless resources; that is, a resource whose size is known, but whose data type is not yet fully defined. When a typeless resource is bound to a shader, the application or shader must resolve the format type (which must match the number of bits per component in the typeless format). A typeless format contains one or more subformats; each subformat resolves the data type. For example, in the R32G32B32 group, which defines types for three-component 96-bit data, there is one typeless format and three fully typed subformats.

	
             , , , ,

_UINTUnsigned integer. For instance, a 3-bit UINT represents the values 0, 1, 2, 3, 4, 5, 6, 7. _UNORMUnsigned normalized integer; which is interpreted in a resource as an unsigned integer, and is interpreted in a shader as an unsigned normalized floating-point value in the range [0, 1]. All 0's maps to 0.0f, and all 1's maps to 1.0f. A sequence of evenly spaced floating-point values from 0.0f to 1.0f are represented. For instance, a 2-bit UNORM represents 0.0f, 1/3, 2/3, and 1.0f.?New Resource FormatsDirect3D 10 offers new data compression formats for compressing high-dynamic range (HDR) lighting data, normal maps and heightfields to a fraction of their original size. These compression types include:Shared-Exponent high-dynamic range (HDR) format (RGBE) New Block-Compressed 1-2 channel UNORM/SNORM formatsThe block compression formats can be used for any of the 2D or 3D texture types ( Texture2D, Texture2DArray, Texture3D, or TextureCube) including mipmap surfaces. The block compression techniques require texture dimensions to be a multiple of 4 (since the implementation compresses on blocks of 4x4 texels). In the texture sampler, compressed formats are always decompressed before texture filtering. DXGI_FORMAT

The format is not known.

DXGI_FORMAT_UNKNOWN

A four-component, 128-bit typeless format that supports 32 bits per channel including alpha. 1

DXGI_FORMAT_R32G32B32A32_TYPELESS

A four-component, 128-bit floating-point format that supports 32 bits per channel including alpha. 1

DXGI_FORMAT_R32G32B32A32_FLOAT

A four-component, 128-bit unsigned-integer format that supports 32 bits per channel including alpha. 1

DXGI_FORMAT_R32G32B32A32_UINT

A four-component, 128-bit signed-integer format that supports 32 bits per channel including alpha. 1

DXGI_FORMAT_R32G32B32A32_SINT

A three-component, 96-bit typeless format that supports 32 bits per color channel.

DXGI_FORMAT_R32G32B32_TYPELESS

A three-component, 96-bit floating-point format that supports 32 bits per color channel.

DXGI_FORMAT_R32G32B32_FLOAT

A three-component, 96-bit unsigned-integer format that supports 32 bits per color channel.

DXGI_FORMAT_R32G32B32_UINT

A three-component, 96-bit signed-integer format that supports 32 bits per color channel.

DXGI_FORMAT_R32G32B32_SINT

A four-component, 64-bit typeless format that supports 16 bits per channel including alpha.

DXGI_FORMAT_R16G16B16A16_TYPELESS

A four-component, 64-bit floating-point format that supports 16 bits per channel including alpha.

DXGI_FORMAT_R16G16B16A16_FLOAT

A four-component, 64-bit unsigned-normalized-integer format that supports 16 bits per channel including alpha.

DXGI_FORMAT_R16G16B16A16_UNORM

A four-component, 64-bit unsigned-integer format that supports 16 bits per channel including alpha.

DXGI_FORMAT_R16G16B16A16_UINT

A four-component, 64-bit signed-normalized-integer format that supports 16 bits per channel including alpha.

DXGI_FORMAT_R16G16B16A16_SNORM

A four-component, 64-bit signed-integer format that supports 16 bits per channel including alpha.

DXGI_FORMAT_R16G16B16A16_SINT

A two-component, 64-bit typeless format that supports 32 bits for the red channel and 32 bits for the green channel.

DXGI_FORMAT_R32G32_TYPELESS

A two-component, 64-bit floating-point format that supports 32 bits for the red channel and 32 bits for the green channel.

DXGI_FORMAT_R32G32_FLOAT

A two-component, 64-bit unsigned-integer format that supports 32 bits for the red channel and 32 bits for the green channel.

DXGI_FORMAT_R32G32_UINT

A two-component, 64-bit signed-integer format that supports 32 bits for the red channel and 32 bits for the green channel.

DXGI_FORMAT_R32G32_SINT

A two-component, 64-bit typeless format that supports 32 bits for the red channel, 8 bits for the green channel, and 24 bits are unused.

DXGI_FORMAT_R32G8X24_TYPELESS

A 32-bit floating-point component, and two unsigned-integer components (with an additional 32 bits). This format supports 32-bit depth, 8-bit stencil, and 24 bits are unused.

DXGI_FORMAT_D32_FLOAT_S8X24_UINT

A 32-bit floating-point component, and two typeless components (with an additional 32 bits). This format supports 32-bit red channel, 8 bits are unused, and 24 bits are unused.

DXGI_FORMAT_R32_FLOAT_X8X24_TYPELESS

A 32-bit typeless component, and two unsigned-integer components (with an additional 32 bits). This format has 32 bits unused, 8 bits for green channel, and 24 bits are unused.

DXGI_FORMAT_X32_TYPELESS_G8X24_UINT

A four-component, 32-bit typeless format that supports 10 bits for each color and 2 bits for alpha.

DXGI_FORMAT_R10G10B10A2_TYPELESS

A four-component, 32-bit unsigned-normalized-integer format that supports 10 bits for each color and 2 bits for alpha.

DXGI_FORMAT_R10G10B10A2_UNORM

A four-component, 32-bit unsigned-integer format that supports 10 bits for each color and 2 bits for alpha.

DXGI_FORMAT_R10G10B10A2_UINT

Three partial-precision floating-point numbers encoded into a single 32-bit value (a variant of s10e5, which is sign bit, 10-bit mantissa, and 5-bit biased (15) exponent). There are no sign bits, and there is a 5-bit biased (15) exponent for each channel, 6-bit mantissa for R and G, and a 5-bit mantissa for B, as shown in the following illustration.

DXGI_FORMAT_R11G11B10_FLOAT

A four-component, 32-bit typeless format that supports 8 bits per channel including alpha.

DXGI_FORMAT_R8G8B8A8_TYPELESS

A four-component, 32-bit unsigned-normalized-integer format that supports 8 bits per channel including alpha.

DXGI_FORMAT_R8G8B8A8_UNORM

A four-component, 32-bit unsigned-normalized integer sRGB format that supports 8 bits per channel including alpha.

DXGI_FORMAT_R8G8B8A8_UNORM_SRGB

A four-component, 32-bit unsigned-integer format that supports 8 bits per channel including alpha.

DXGI_FORMAT_R8G8B8A8_UINT

A four-component, 32-bit signed-normalized-integer format that supports 8 bits per channel including alpha.

DXGI_FORMAT_R8G8B8A8_SNORM

A four-component, 32-bit signed-integer format that supports 8 bits per channel including alpha.

DXGI_FORMAT_R8G8B8A8_SINT

A two-component, 32-bit typeless format that supports 16 bits for the red channel and 16 bits for the green channel.

DXGI_FORMAT_R16G16_TYPELESS

A two-component, 32-bit floating-point format that supports 16 bits for the red channel and 16 bits for the green channel.

DXGI_FORMAT_R16G16_FLOAT

A two-component, 32-bit unsigned-normalized-integer format that supports 16 bits each for the green and red channels.

DXGI_FORMAT_R16G16_UNORM

A two-component, 32-bit unsigned-integer format that supports 16 bits for the red channel and 16 bits for the green channel.

DXGI_FORMAT_R16G16_UINT

A two-component, 32-bit signed-normalized-integer format that supports 16 bits for the red channel and 16 bits for the green channel.

DXGI_FORMAT_R16G16_SNORM

A two-component, 32-bit signed-integer format that supports 16 bits for the red channel and 16 bits for the green channel.

DXGI_FORMAT_R16G16_SINT

A single-component, 32-bit typeless format that supports 32 bits for the red channel.

DXGI_FORMAT_R32_TYPELESS

A single-component, 32-bit floating-point format that supports 32 bits for depth.

DXGI_FORMAT_D32_FLOAT

A single-component, 32-bit floating-point format that supports 32 bits for the red channel.

DXGI_FORMAT_R32_FLOAT

A single-component, 32-bit unsigned-integer format that supports 32 bits for the red channel.

DXGI_FORMAT_R32_UINT

A single-component, 32-bit signed-integer format that supports 32 bits for the red channel.

DXGI_FORMAT_R32_SINT

A two-component, 32-bit typeless format that supports 24 bits for the red channel and 8 bits for the green channel.

DXGI_FORMAT_R24G8_TYPELESS

A 32-bit z-buffer format that supports 24 bits for depth and 8 bits for stencil.

DXGI_FORMAT_D24_UNORM_S8_UINT

A 32-bit format, that contains a 24 bit, single-component, unsigned-normalized integer, with an additional typeless 8 bits. This format has 24 bits red channel and 8 bits unused.

DXGI_FORMAT_R24_UNORM_X8_TYPELESS

A 32-bit format, that contains a 24 bit, single-component, typeless format, with an additional 8 bit unsigned integer component. This format has 24 bits unused and 8 bits green channel.

DXGI_FORMAT_X24_TYPELESS_G8_UINT

A two-component, 16-bit typeless format that supports 8 bits for the red channel and 8 bits for the green channel.

DXGI_FORMAT_R8G8_TYPELESS

A two-component, 16-bit unsigned-normalized-integer format that supports 8 bits for the red channel and 8 bits for the green channel.

DXGI_FORMAT_R8G8_UNORM

A two-component, 16-bit unsigned-integer format that supports 8 bits for the red channel and 8 bits for the green channel.

DXGI_FORMAT_R8G8_UINT

A two-component, 16-bit signed-normalized-integer format that supports 8 bits for the red channel and 8 bits for the green channel.

DXGI_FORMAT_R8G8_SNORM

A two-component, 16-bit signed-integer format that supports 8 bits for the red channel and 8 bits for the green channel.

DXGI_FORMAT_R8G8_SINT

A single-component, 16-bit typeless format that supports 16 bits for the red channel.

DXGI_FORMAT_R16_TYPELESS

A single-component, 16-bit floating-point format that supports 16 bits for the red channel.

DXGI_FORMAT_R16_FLOAT

A single-component, 16-bit unsigned-normalized-integer format that supports 16 bits for depth.

DXGI_FORMAT_D16_UNORM

A single-component, 16-bit unsigned-normalized-integer format that supports 16 bits for the red channel.

DXGI_FORMAT_R16_UNORM

A single-component, 16-bit unsigned-integer format that supports 16 bits for the red channel.

DXGI_FORMAT_R16_UINT

A single-component, 16-bit signed-normalized-integer format that supports 16 bits for the red channel.

DXGI_FORMAT_R16_SNORM

A single-component, 16-bit signed-integer format that supports 16 bits for the red channel.

DXGI_FORMAT_R16_SINT

A single-component, 8-bit typeless format that supports 8 bits for the red channel.

DXGI_FORMAT_R8_TYPELESS

A single-component, 8-bit unsigned-normalized-integer format that supports 8 bits for the red channel.

DXGI_FORMAT_R8_UNORM

A single-component, 8-bit unsigned-integer format that supports 8 bits for the red channel.

DXGI_FORMAT_R8_UINT

A single-component, 8-bit signed-normalized-integer format that supports 8 bits for the red channel.

DXGI_FORMAT_R8_SNORM

A single-component, 8-bit signed-integer format that supports 8 bits for the red channel.

DXGI_FORMAT_R8_SINT

A single-component, 8-bit unsigned-normalized-integer format for alpha only.

DXGI_FORMAT_A8_UNORM

A single-component, 1-bit unsigned-normalized integer format that supports 1 bit for the red channel. 2.

DXGI_FORMAT_R1_UNORM

Three partial-precision floating-point numbers encoded into a single 32-bit value all sharing the same 5-bit exponent (variant of s10e5, which is sign bit, 10-bit mantissa, and 5-bit biased (15) exponent). There is no sign bit, and there is a shared 5-bit biased (15) exponent and a 9-bit mantissa for each channel, as shown in the following illustration. 2.

DXGI_FORMAT_R9G9B9E5_SHAREDEXP

A four-component, 32-bit unsigned-normalized-integer format. This packed RGB format is analogous to the UYVY format. Each 32-bit block describes a pair of pixels: (R8, G8, B8) and (R8, G8, B8) where the R8/B8 values are repeated, and the G8 values are unique to each pixel. 3

DXGI_FORMAT_R8G8_B8G8_UNORM

A four-component, 32-bit unsigned-normalized-integer format. This packed RGB format is analogous to the YUY2 format. Each 32-bit block describes a pair of pixels: (R8, G8, B8) and (R8, G8, B8) where the R8/B8 values are repeated, and the G8 values are unique to each pixel. 3

DXGI_FORMAT_G8R8_G8B8_UNORM

Four-component typeless block-compression format. For information about block-compression formats, see Texture Block Compression in Direct3D 11.

DXGI_FORMAT_BC1_TYPELESS

Four-component block-compression format. For information about block-compression formats, see Texture Block Compression in Direct3D 11.

DXGI_FORMAT_BC1_UNORM

Four-component block-compression format for sRGB data. For information about block-compression formats, see Texture Block Compression in Direct3D 11.

DXGI_FORMAT_BC1_UNORM_SRGB

Four-component typeless block-compression format. For information about block-compression formats, see Texture Block Compression in Direct3D 11.

DXGI_FORMAT_BC2_TYPELESS

Four-component block-compression format. For information about block-compression formats, see Texture Block Compression in Direct3D 11.

DXGI_FORMAT_BC2_UNORM

Four-component block-compression format for sRGB data. For information about block-compression formats, see Texture Block Compression in Direct3D 11.

DXGI_FORMAT_BC2_UNORM_SRGB

Four-component typeless block-compression format. For information about block-compression formats, see Texture Block Compression in Direct3D 11.

DXGI_FORMAT_BC3_TYPELESS

Four-component block-compression format. For information about block-compression formats, see Texture Block Compression in Direct3D 11.

DXGI_FORMAT_BC3_UNORM

Four-component block-compression format for sRGB data. For information about block-compression formats, see Texture Block Compression in Direct3D 11.

DXGI_FORMAT_BC3_UNORM_SRGB

One-component typeless block-compression format. For information about block-compression formats, see Texture Block Compression in Direct3D 11.

DXGI_FORMAT_BC4_TYPELESS

One-component block-compression format. For information about block-compression formats, see Texture Block Compression in Direct3D 11.

DXGI_FORMAT_BC4_UNORM

One-component block-compression format. For information about block-compression formats, see Texture Block Compression in Direct3D 11.

DXGI_FORMAT_BC4_SNORM

Two-component typeless block-compression format. For information about block-compression formats, see Texture Block Compression in Direct3D 11.

DXGI_FORMAT_BC5_TYPELESS

Two-component block-compression format. For information about block-compression formats, see Texture Block Compression in Direct3D 11.

DXGI_FORMAT_BC5_UNORM

Two-component block-compression format. For information about block-compression formats, see Texture Block Compression in Direct3D 11.

DXGI_FORMAT_BC5_SNORM

A three-component, 16-bit unsigned-normalized-integer format that supports 5 bits for blue, 6 bits for green, and 5 bits for red.

DXGI_FORMAT_B5G6R5_UNORM

A four-component, 16-bit unsigned-normalized-integer format that supports 5 bits for each color channel and 1-bit alpha.

DXGI_FORMAT_B5G5R5A1_UNORM

A four-component, 32-bit unsigned-normalized-integer format that supports 8 bits for each color channel and 8-bit alpha.

DXGI_FORMAT_B8G8R8A8_UNORM

A four-component, 32-bit unsigned-normalized-integer format that supports 8 bits for each color channel and 8 bits unused.

DXGI_FORMAT_B8G8R8X8_UNORM

A four-component, 32-bit 2.8-biased fixed-point format that supports 10 bits for each color channel and 2-bit alpha.

DXGI_FORMAT_R10G10B10_XR_BIAS_A2_UNORM

A four-component, 32-bit typeless format that supports 8 bits for each channel including alpha. 4

DXGI_FORMAT_B8G8R8A8_TYPELESS

A four-component, 32-bit unsigned-normalized standard RGB format that supports 8 bits for each channel including alpha. 4

DXGI_FORMAT_B8G8R8A8_UNORM_SRGB

A four-component, 32-bit typeless format that supports 8 bits for each color channel, and 8 bits are unused. 4

DXGI_FORMAT_B8G8R8X8_TYPELESS

A four-component, 32-bit unsigned-normalized standard RGB format that supports 8 bits for each color channel, and 8 bits are unused. 4

DXGI_FORMAT_B8G8R8X8_UNORM_SRGB

A typeless block-compression format. 4 For information about block-compression formats, see Texture Block Compression in Direct3D 11.

DXGI_FORMAT_BC6H_TYPELESS

A block-compression format. 4 For information about block-compression formats, see Texture Block Compression in Direct3D 11.

DXGI_FORMAT_BC6H_UF16

A block-compression format. 4 For information about block-compression formats, see Texture Block Compression in Direct3D 11.

DXGI_FORMAT_BC6H_SF16

A typeless block-compression format. 4 For information about block-compression formats, see Texture Block Compression in Direct3D 11.

DXGI_FORMAT_BC7_TYPELESS

A block-compression format. 4 For information about block-compression formats, see Texture Block Compression in Direct3D 11.

DXGI_FORMAT_BC7_UNORM

A block-compression format. 4 For information about block-compression formats, see Texture Block Compression in Direct3D 11.

DXGI_FORMAT_BC7_UNORM_SRGB

Most common YUV 4:4:4 video resource format. Valid view formats for this video resource format are and . For UAVs, an additional valid view format is . By using for UAVs, you can both read and write as opposed to just write for and . Supported view types are SRV, RTV, and UAV. One view provides a straightforward mapping of the entire surface. The mapping to the view channel is V->R8, U->G8, Y->B8, and A->A8. Direct3D 11:??This value is not supported until Windows Developer Preview.

DXGI_FORMAT_AYUV

10-bit per channel packed YUV 4:4:4 video resource format. Valid view formats for this video resource format are and . For UAVs, an additional valid view format is . By using for UAVs, you can both read and write as opposed to just write for and . Supported view types are SRV and UAV. One view provides a straightforward mapping of the entire surface. The mapping to the view channel is U->R10, Y->G10, V->B10, and A->A2. Direct3D 11:??This value is not supported until Windows Developer Preview.

DXGI_FORMAT_Y410

16-bit per channel packed YUV 4:4:4 video resource format. Valid view formats for this video resource format are and . Supported view types are SRV and UAV. One view provides a straightforward mapping of the entire surface. The mapping to the view channel is U->R16, Y->G16, V->B16, and A->A16. Direct3D 11:??This value is not supported until Windows Developer Preview.

DXGI_FORMAT_Y416

Most common YUV 4:2:0 video resource format. Valid luminance data view formats for this video resource format are and . Valid chrominance data view formats (width and height are each 1/2 of luminance view) for this video resource format are and . Supported view types are SRV, RTV, and UAV. For luminance data view, the mapping to the view channel is Y->R8. For chrominance data view, the mapping to the view channel is U->R8 and V->G8. Direct3D 11:??This value is not supported until Windows Developer Preview.

DXGI_FORMAT_NV12

10-bit per channel planar YUV 4:2:0 video resource format. Valid luminance data view formats for this video resource format are and . The runtime does not enforce whether the lowest 6 bits are 0 (given that this video resource format is a 10-bit format that uses 16 bits). If required, application shader code would have to enforce this manually. From the runtime's point of view, is no different than . Valid chrominance data view formats (width and height are each 1/2 of luminance view) for this video resource format are and . For UAVs, an additional valid chrominance data view format is . By using for UAVs, you can both read and write as opposed to just write for and . Supported view types are SRV, RTV, and UAV. For luminance data view, the mapping to the view channel is Y->R16. For chrominance data view, the mapping to the view channel is U->R16 and V->G16. Direct3D 11:??This value is not supported until Windows Developer Preview.

DXGI_FORMAT_P010

16-bit per channel planar YUV 4:2:0 video resource format. Valid luminance data view formats for this video resource format are and . Valid chrominance data view formats (width and height are each 1/2 of luminance view) for this video resource format are and . For UAVs, an additional valid chrominance data view format is . By using for UAVs, you can both read and write as opposed to just write for and . Supported view types are SRV, RTV, and UAV. For luminance data view, the mapping to the view channel is Y->R16. For chrominance data view, the mapping to the view channel is U->R16 and V->G16. Direct3D 11:??This value is not supported until Windows Developer Preview.

DXGI_FORMAT_P016

8-bit per channel planar YUV 4:2:0 video resource format. This format is subsampled where each pixel has its own Y value, but each 2x2 pixel block shares a single U and V value. The runtime requires that the width and height of all resources that are created with this format are multiples of 2. The runtime also requires that the left, right, top, and bottom members of any that are used for this format are multiples of 2. This format differs from in that the layout of the data within the resource is completely opaque to applications. Applications cannot use the CPU to map the resource and then access the data within the resource. You cannot use shaders with this format. Because of this behavior, legacy hardware that supports a non-NV12 4:2:0 layout (for example, YV12, and so on) can be used. Also, new hardware that has a 4:2:0 implementation better than NV12 can be used when the application does not need the data to be in a standard layout. Direct3D 11:??This value is not supported until Windows Developer Preview.

DXGI_FORMAT_420_OPAQUE

Most common YUV 4:2:2 video resource format. Valid view formats for this video resource format are and . For UAVs, an additional valid view format is . By using for UAVs, you can both read and write as opposed to just write for and . Supported view types are SRV and UAV. One view provides a straightforward mapping of the entire surface. The mapping to the view channel is Y0->R8, U0->G8, Y1->B8, and V0->A8. A unique valid view format for this video resource format is . With this view format, the width of the view appears to be twice what the or view would be when hardware reconstructs RGBA automatically on read and before filtering. This Direct3D hardware behavior is legacy and is likely not useful any more. With this view format, the mapping to the view channel is Y0->R8, U0-> G8[0], Y1->B8, and V0-> G8[1]. Direct3D 11:??This value is not supported until Windows Developer Preview.

DXGI_FORMAT_YUY2

10-bit per channel packed YUV 4:2:2 video resource format. Valid view formats for this video resource format are and . The runtime does not enforce whether the lowest 6 bits are 0 (given that this video resource format is a 10-bit format that uses 16 bits). If required, application shader code would have to enforce this manually. From the runtime's point of view, is no different than . Supported view types are SRV and UAV. One view provides a straightforward mapping of the entire surface. The mapping to the view channel is Y0->R16, U->G16, Y1->B16, and V->A16. Direct3D 11:??This value is not supported until Windows Developer Preview.

DXGI_FORMAT_Y210

16-bit per channel packed YUV 4:2:2 video resource format. Valid view formats for this video resource format are and . Supported view types are SRV and UAV. One view provides a straightforward mapping of the entire surface. The mapping to the view channel is Y0->R16, U->G16, Y1->B16, and V->A16. Direct3D 11:??This value is not supported until Windows Developer Preview.

DXGI_FORMAT_Y216

Most common planar YUV 4:1:1 video resource format. Valid luminance data view formats for this video resource format are and . Valid chrominance data view formats (width and height are each 1/4 of luminance view) for this video resource format are and . Supported view types are SRV, RTV, and UAV. For luminance data view, the mapping to the view channel is Y->R8. For chrominance data view, the mapping to the view channel is U->R8 and V->G8. Direct3D 11:??This value is not supported until Windows Developer Preview.

DXGI_FORMAT_NV11

4-bit palletized YUV format that is commonly used for DVD subpicture. Direct3D 11:??This value is not supported until Windows Developer Preview.

DXGI_FORMAT_AI44

4-bit palletized YUV format that is commonly used for DVD subpicture. Direct3D 11:??This value is not supported until Windows Developer Preview.

DXGI_FORMAT_IA44

8-bit palletized format that is used for palletized RGB data when the processor processes ISDB-T data and for palletized YUV data when the processor processes BluRay data. Direct3D 11:??This value is not supported until Windows Developer Preview.

DXGI_FORMAT_P8

8-bit palletized format with 8 bits of alpha that is used for palletized YUV data when the processor processes BluRay data. Direct3D 11:??This value is not supported until Windows Developer Preview.

DXGI_FORMAT_A8P8

A four-component, 16-bit unsigned-normalized integer format that supports 4 bits for each channel including alpha. Direct3D 11:??This value is not supported until Windows Developer Preview.

DXGI_FORMAT_B4G4R4A4_UNORM

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

You call the method to retrieve the granularity level at which the GPU can be preempted from performing its current graphics rendering task. The operating system specifies the graphics granularity level in the GraphicsPreemptionGranularity member of the structure.The following figure shows granularity of graphics rendering tasks. DXGI_GRAPHICS_PREEMPTION_GRANULARITY

Indicates the preemption granularity as a DMA buffer.

DXGI_GRAPHICS_PREEMPTION_DMA_BUFFER_BOUNDARY

Indicates the preemption granularity as a graphics primitive. A primitive is a section in a DMA buffer and can be a group of triangles.

DXGI_GRAPHICS_PREEMPTION_PRIMITIVE_BOUNDARY

Indicates the preemption granularity as a triangle. A triangle is a part of a primitive.

DXGI_GRAPHICS_PREEMPTION_TRIANGLE_BOUNDARY

Indicates the preemption granularity as a pixel. A pixel is a part of a triangle.

DXGI_GRAPHICS_PREEMPTION_PIXEL_BOUNDARY

Indicates the preemption granularity as a graphics instruction. A graphics instruction operates on a pixel.

DXGI_GRAPHICS_PREEMPTION_INSTRUCTION_BOUNDARY

No documentation.

DXGI_MAP_FLAGS

No documentation.

DXGI_MAP_READ

No documentation.

DXGI_MAP_WRITE

No documentation.

DXGI_MAP_DISCARD

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

Priority determines how likely the operating system is to discard an offered resource. Resources offered with lower priority are discarded first. DXGI_OFFER_RESOURCE_PRIORITY

No documentation.

DXGI_OFFER_RESOURCE_PRIORITY_LOW

No documentation.

DXGI_OFFER_RESOURCE_PRIORITY_NORMAL

No documentation.

DXGI_OFFER_RESOURCE_PRIORITY_HIGH

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

DXGI_OUTDUPL_POINTER_SHAPE_TYPE

The reference type is a monochrome mouse reference, which is a monochrome bitmap. The bitmap's size is specified by width and height in a 1 bits per pixel (bpp) device independent bitmap (DIB) format AND mask that is followed by another 1 bpp DIB format XOR mask of the same size.

DXGI_OUTDUPL_POINTER_SHAPE_TYPE_MONOCHROME

The reference type is a color mouse reference, which is a color bitmap. The bitmap's size is specified by width and height in a 32 bpp ARGB DIB format.

DXGI_OUTDUPL_POINTER_SHAPE_TYPE_COLOR

The reference type is a masked color mouse reference. A masked color mouse reference is a 32 bpp ARGB format bitmap with the mask value in the alpha bits. The only allowed mask values are 0 and 0xFF. When the mask value is 0, the RGB value should replace the screen pixel. When the mask value is 0xFF, an XOR operation is performed on the RGB value and the screen pixel; the result replaces the screen pixel.

DXGI_OUTDUPL_POINTER_SHAPE_TYPE_MASKED_COLOR

No documentation.

DXGI_PRESENT_FLAGS

No documentation.

DXGI_PRESENT_TEST

No documentation.

DXGI_PRESENT_DO_NOT_SEQUENCE

No documentation.

DXGI_PRESENT_RESTART

No documentation.

DXGI_PRESENT_DO_NOT_WAIT

No documentation.

DXGI_PRESENT_STEREO_PREFER_RIGHT

No documentation.

DXGI_PRESENT_STEREO_TEMPORARY_MONO

No documentation.

DXGI_PRESENT_RESTRICT_TO_OUTPUT

None.

None

Flags indicating the memory location of a resource.

DXGI_RESIDENCY

The resource is located in video memory.

DXGI_RESIDENCY_FULLY_RESIDENT

At least some of the resource is located in CPU memory.

DXGI_RESIDENCY_RESIDENT_IN_SHARED_MEMORY

At least some of the resource has been paged out to the hard drive.

DXGI_RESIDENCY_EVICTED_TO_DISK

No documentation.

DXGI_RESOURCE_PRIORITY

No documentation.

DXGI_RESOURCE_PRIORITY_MINIMUM

No documentation.

DXGI_RESOURCE_PRIORITY_LOW

No documentation.

DXGI_RESOURCE_PRIORITY_NORMAL

No documentation.

DXGI_RESOURCE_PRIORITY_HIGH

No documentation.

DXGI_RESOURCE_PRIORITY_MAXIMUM

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

The value is supported only for flip presentation model swap chains that you create with the value. You pass these values in a call to , , or . DXGI_SCALING

Directs DXGI to make the back-buffer contents scale to fit the presentation target size. This is the implicit behavior of DXGI when you call the method.

DXGI_SCALING_STRETCH

Directs DXGI to make the back-buffer contents appear without any scaling when the presentation target size is not equal to the back-buffer size. The top edges of the back buffer and presentation target are aligned together. If the WS_EX_LAYOUTRTL style is associated with the handle to the target output window, the right edges of the back buffer and presentation target are aligned together; otherwise, the left edges are aligned together. All target area outside the back buffer is filled with window background color. This value effects all target areas outside the back buffer of a swap chain that you fill with the background color by using .

DXGI_SCALING_NONE

Options for swap-chain behavior.

This enumeration is used by the structure and the method.This enumeration is also used by the structure.Swap chains that you create in full-screen mode with the method behave as if is set even though the flag is not set. That is, presented content is not accessible by remote access or through the desktop duplication APIs.Swap chains that you create with the , , and methods are not protected if is not set and are protected if is set. When swap chains are protected, screen scraping is prevented and, in full-screen mode, presented content is not accessible through the desktop duplication APIs. DXGI_SWAP_CHAIN_FLAG

Set this flag to turn off automatic image rotation; that is, do not perform a rotation when transferring the contents of the front buffer to the monitor. Use this flag to avoid a bandwidth penalty when an application expects to handle rotation. This option is valid only during full-screen mode.

DXGI_SWAP_CHAIN_FLAG_NONPREROTATED

Set this flag to enable an application to switch modes by calling . When switching from windowed to full-screen mode, the display mode (or monitor resolution) will be changed to match the dimensions of the application window.

DXGI_SWAP_CHAIN_FLAG_ALLOW_MODE_SWITCH

Set this flag to enable an application to render using GDI on a swap chain or a surface. This will allow the application to call on the 0th back buffer or a surface.

DXGI_SWAP_CHAIN_FLAG_GDI_COMPATIBLE

Set this flag to indicate that the swap chain might contain protected content; therefore, the operating system supports the creation of the swap chain only when driver and hardware protection is used. If the driver and hardware do not support content protection, the call to create a resource for the swap chain fails. Direct3D 11:??This enumeration value is supported starting with Windows Developer Preview.

DXGI_SWAP_CHAIN_FLAG_RESTRICTED_CONTENT

Set this flag to indicate that shared resources that are created within the swap chain must be protected by using the driver?s mechanism for restricting access to shared surfaces. Direct3D 11:??This enumeration value is supported starting with Windows Developer Preview.

DXGI_SWAP_CHAIN_FLAG_RESTRICT_SHARED_RESOURCE_DRIVER

Set this flag to restrict presented content to the local displays. Therefore, the presented content is not accessible via remote accessing or through the desktop duplication APIs. This flag supports the window content protection features of Windows. Applications can use this flag to protect their own onscreen window content from being captured or copied through a specific set of public operating system features and APIs. If you use this flag with windowed ( or IWindow) swap chains where another process created the , the owner of the must use the SetWindowDisplayAffinity function appropriately in order to allow calls to or to succeed. Direct3D 11:??This enumeration value is supported starting with Windows Developer Preview.

DXGI_SWAP_CHAIN_FLAG_DISPLAY_ONLY

None.

None

Options for handling pixels in a display surface after calling .

This enumeration is used by the structure.This enumeration is also used by the structure.The primary difference between presentation models is how back-buffer contents get to the Desktop Window Manager (DWM) for composition. In the bitblt model, which is used with the and values, contents of the back buffer get copied into the redirection surface on each call to . In the flip model, which is used with the value, all back buffers are shared with the DWM. Therefore, the DWM can compose straight from those back buffers without any additional copy operations. In general, the flip model is the more efficient model. The flip model also provides more features, such as enhanced present statistics.Regardless of whether the flip model is more efficient, an application still might choose the bitblt model for the following reasons:The bitblt model is the only way to mix GDI and DirectX presentation. In the flip model, the application must create the swap chain with , and then must use GetDC on the back buffer explicitly. After the first successful call to on a flip-model swap chain, GDI no longer works with the that is associated with that swap chain, even after the destruction of the swap chain. This restriction even extends to methods like ScrollWindowEx. The flip model requires at least three window-sized buffers if the application uses child windows. For the bitblt model, this minimum is two buffers. DXGI_SWAP_EFFECT

No documentation.

DXGI_SWAP_EFFECT_DISCARD

No documentation.

DXGI_SWAP_EFFECT_SEQUENTIAL

No documentation.

DXGI_SWAP_EFFECT_FLIP_SEQUENTIAL

No documentation.

DXGI_USAGE_ENUM

No documentation.

DXGI_USAGE_SHADER_INPUT

No documentation.

DXGI_USAGE_RENDER_TARGET_OUTPUT

No documentation.

DXGI_USAGE_BACK_BUFFER

No documentation.

DXGI_USAGE_SHARED

No documentation.

DXGI_USAGE_READ_ONLY

No documentation.

DXGI_USAGE_DISCARD_ON_PRESENT

No documentation.

DXGI_USAGE_UNORDERED_ACCESS

No documentation.

DXGI_MWA_FLAGS

No documentation.

DXGI_MWA_NO_WINDOW_CHANGES

No documentation.

DXGI_MWA_NO_ALT_ENTER

No documentation.

DXGI_MWA_NO_PRINT_SCREEN

No documentation.

DXGI_MWA_VALID

None.

None

Functions

Creates a DXGI 1.1 factory that generates objects used to enumerate and specify video graphics settings.

The globally unique identifier () of the object referenced by the ppFactory parameter. Address of a reference to an object. Returns if successful; an error code otherwise. For a list of error codes, see DXGI_ERROR. Use a DXGI 1.1 factory to generate objects that enumerate adapters, create swap chains, and associate a window with the alt+enter key sequence for toggling to and from the full-screen display mode.If the CreateDXGIFactory1 function succeeds, the reference count on the interface is incremented. To avoid a memory leak, when you finish using the interface, call the IDXGIFactory1::Release method to release the interface.This entry point is not supported by DXGI 1.0, which shipped in Windows?Vista and Windows Server?2008. DXGI 1.1 support is required, which is available on Windows?7, Windows Server?2008?R2, and as an update to Windows?Vista with Service Pack?2 (SP2) (KB 971644) and Windows Server?2008 (KB 971512).Note??Do not mix the use of DXGI 1.0 () and DXGI 1.1 () in an application. Use or , but not both in an application. HRESULT CreateDXGIFactory1([In] const GUID& riid,[Out] void** ppFactory)

Creates a DXGI 1.0 factory that generates objects used to enumerate and specify video graphics settings.

The globally unique identifier () of the object referenced by the ppFactory parameter. Address of a reference to an object. Returns if successful; otherwise, returns one of the following DXGI_ERROR. Use a DXGI factory to generate objects that enumerate adapters, create swap chains, and associate a window with the alt+enter key sequence for toggling to and from the fullscreen display mode.If the CreateDXGIFactory function succeeds, the reference count on the interface is incremented. To avoid a memory leak, when you finish using the interface, call the IDXGIFactory::Release method to release the interface.Note??Do not mix the use of DXGI 1.0 () and DXGI 1.1 () in an application. Use or , but not both in an application.The CreateDXGIFactory function does not exist for Metro style apps. Instead, Metro style apps use the CreateDXGIFactory1 function. HRESULT CreateDXGIFactory([In] const GUID& riid,[Out] void** ppFactory)

Functions

Constant Unsupported.

DXGI_ERROR_UNSUPPORTED

Constant AccessLost.

DXGI_ERROR_ACCESS_LOST

Constant RemoteClientDisconnected.

DXGI_ERROR_REMOTE_CLIENT_DISCONNECTED

Constant DeviceRemoved.

DXGI_ERROR_DEVICE_REMOVED

Constant Nonexclusive.

DXGI_ERROR_NONEXCLUSIVE

Constant FrameStatisticsDisjoint.

DXGI_ERROR_FRAME_STATISTICS_DISJOINT

Constant DeviceHung.

DXGI_ERROR_DEVICE_HUNG

Constant AccessDenied.

DXGI_ERROR_ACCESS_DENIED

Constant RemoteOutofmemory.

DXGI_ERROR_REMOTE_OUTOFMEMORY

Constant RestrictToOutputStale.

DXGI_ERROR_RESTRICT_TO_OUTPUT_STALE

Constant NotFound.

DXGI_ERROR_NOT_FOUND

Constant DeviceReset.

DXGI_ERROR_DEVICE_RESET

Constant MoreData.

DXGI_ERROR_MORE_DATA

Constant SessionDisconnected.

DXGI_ERROR_SESSION_DISCONNECTED

Constant CannotProtectContent.

DXGI_ERROR_CANNOT_PROTECT_CONTENT

Constant DriverInternalError.

DXGI_ERROR_DRIVER_INTERNAL_ERROR

Constant InvalidCall.

DXGI_ERROR_INVALID_CALL

Constant GraphicsVidpnSourceInUse.

DXGI_ERROR_GRAPHICS_VIDPN_SOURCE_IN_USE

Constant WasStillDrawing.

DXGI_ERROR_WAS_STILL_DRAWING

Constant WaitTimeout.

DXGI_ERROR_WAIT_TIMEOUT

Constant NotCurrentlyAvailable.

DXGI_ERROR_NOT_CURRENTLY_AVAILABLE

Constant ModeChangeInProgress.

DXGI_ERROR_MODE_CHANGE_IN_PROGRESS

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

IDXGIAdapter1

Initializes a new instance of the class.

The native pointer.

Gets a DXGI 1.1 description of an adapter (or video card).

A reference to a structure that describes the adapter. This parameter must not be null. Returns if successful; otherwise, returns E_INVALIDARG if the pDesc parameter is null. This method is not supported by DXGI 1.0, which shipped in Windows?Vista and Windows Server?2008. DXGI 1.1 support is required, which is available on Windows?7, Windows Server?2008?R2, and as an update to Windows?Vista with Service Pack?2 (SP2) (KB 971644) and Windows Server?2008 (KB 971512).Use the GetDesc1 method to get a DXGI 1.1 description of an adapter. To get a DXGI 1.0 description, use the method. HRESULT IDXGIAdapter1::GetDesc1([Out] DXGI_ADAPTER_DESC1* pDesc)

Gets a DXGI 1.1 description of an adapter (or video card).

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

IDXGIAdapter2

Initializes a new instance of the class.

The native pointer.

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

A reference to a structure that describes the adapter. This parameter must not be null. Returns if successful; otherwise, returns E_INVALIDARG if the pDesc parameter is null. Use the GetDesc2 method to get a DXGI 1.2 description of an adapter. To get a DXGI 1.1 description, use the method. To get a DXGI 1.0 description, use the method.The Windows Display Driver Model (WDDM) scheduler can preempt the GPU's execution of application tasks. The granularity at which the GPU can be preempted from performing its current task in the WDDM 1.1 or earlier driver model is a direct memory access (DMA) buffer for graphics tasks or a compute packet for compute tasks. The GPU can switch between tasks only after it completes the currently executing unit of work, a DMA buffer or a compute packet.A DMA buffer is the largest independent unit of graphics work that the WDDM scheduler can submit to the GPU. This buffer contains a set of GPU instructions that the WDDM driver and GPU use. A compute packet is the largest independent unit of compute work that the WDDM scheduler can submit to the GPU. A compute packet contains dispatches (for example, calls to the method), which contain thread groups. The WDDM 1.2 or later driver model allows the GPU to be preempted at finer granularity levels than a DMA buffer or compute packet. You can use the GetDesc2 method to retrieve the granularity levels for graphics and compute tasks. HRESULT IDXGIAdapter2::GetDesc2([Out] DXGI_ADAPTER_DESC2* pDesc)

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

Use the GetDesc2 method to get a DXGI 1.2 description of an adapter. To get a DXGI 1.1 description, use the method. To get a DXGI 1.0 description, use the method.The Windows Display Driver Model (WDDM) scheduler can preempt the GPU's execution of application tasks. The granularity at which the GPU can be preempted from performing its current task in the WDDM 1.1 or earlier driver model is a direct memory access (DMA) buffer for graphics tasks or a compute packet for compute tasks. The GPU can switch between tasks only after it completes the currently executing unit of work, a DMA buffer or a compute packet.A DMA buffer is the largest independent unit of graphics work that the WDDM scheduler can submit to the GPU. This buffer contains a set of GPU instructions that the WDDM driver and GPU use. A compute packet is the largest independent unit of compute work that the WDDM scheduler can submit to the GPU. A compute packet contains dispatches (for example, calls to the method), which contain thread groups. The WDDM 1.2 or later driver model allows the GPU to be preempted at finer granularity levels than a DMA buffer or compute packet. You can use the GetDesc2 method to retrieve the granularity levels for graphics and compute tasks. GetDesc2 HRESULT IDXGIAdapter2::GetDesc2([Out] DXGI_ADAPTER_DESC2* pDesc)

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

IDXGIDevice1

Initializes a new instance of the class.

The native pointer.

Sets the number of frames that the system is allowed to queue for rendering.

The maximum number of back buffer frames that a driver can queue. The value defaults to 3, but can range from 1 to 16. A value of 0 will reset latency to the default. For multi-head devices, this value is specified per-head. Returns if successful; otherwise, if the device was removed. This method is not supported by DXGI 1.0, which shipped in Windows?Vista and Windows Server?2008. DXGI 1.1 support is required, which is available on Windows?7, Windows Server?2008?R2, and as an update to Windows?Vista with Service Pack?2 (SP2) (KB 971644) and Windows Server?2008 (KB 971512).Frame latency is the number of frames that are allowed to be stored in a queue before submission for rendering. Latency is often used to control how the CPU chooses between responding to user input and frames that are in the render queue. It is often beneficial for applications that have no user input (for example, video playback) to queue more than 3 frames of data. HRESULT IDXGIDevice1::SetMaximumFrameLatency([In] unsigned int MaxLatency)

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

This value is set to the number of frames that can be queued for render. This value defaults to 3, but can range from 1 to 16. Returns if successful; otherwise, returns one of the following members of the D3DERR enumerated type:D3DERR_DEVICELOST D3DERR_DEVICEREMOVED D3DERR_DRIVERINTERNALERROR D3DERR_INVALIDCALL D3DERR_OUTOFVIDEOMEMORY This method is not supported by DXGI 1.0, which shipped in Windows?Vista and Windows Server?2008. DXGI 1.1 support is required, which is available on Windows?7, Windows Server?2008?R2, and as an update to Windows?Vista with Service Pack?2 (SP2) (KB 971644) and Windows Server?2008 (KB 971512).Frame latency is the number of frames that are allowed to be stored in a queue before submission for rendering. Latency is often used to control how the CPU chooses between responding to user input and frames that are in the render queue. It is often beneficial for applications that have no user input (for example, video playback) to queue more than 3 frames of data. HRESULT IDXGIDevice1::GetMaximumFrameLatency([Out] unsigned int* pMaxLatency)

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

This method is not supported by DXGI 1.0, which shipped in Windows?Vista and Windows Server?2008. DXGI 1.1 support is required, which is available on Windows?7, Windows Server?2008?R2, and as an update to Windows?Vista with Service Pack?2 (SP2) (KB 971644) and Windows Server?2008 (KB 971512).Frame latency is the number of frames that are allowed to be stored in a queue before submission for rendering. Latency is often used to control how the CPU chooses between responding to user input and frames that are in the render queue. It is often beneficial for applications that have no user input (for example, video playback) to queue more than 3 frames of data. GetMaximumFrameLatency HRESULT IDXGIDevice1::GetMaximumFrameLatency([Out] unsigned int* pMaxLatency)

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

IDXGIDevice2

Initializes a new instance of the class.

The native pointer.

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

The number of resources in the ppResources argument array. An array of references to interfaces for the resources to offer. A -typed value that indicates how valuable data is. OfferResources returns: if resources were successfully offered E_INVALIDARG if a resource in the array or the priority is invalid The priority value that the Priority parameter specifies describes how valuable the caller considers the content to be. The operating system uses the priority value to discard resources in order of priority. The operating system discards a resource that is offered with low priority before it discards a resource that is offered with a higher priority.If you call OfferResources to offer a resource while the resource is bound to the pipeline, the resource is unbound. You cannot call OfferResources on a resource that is mapped. After you offer a resource, the resource cannot be mapped or bound to the pipeline until you call the IDXGIDevice2::ReclaimResource method to reclaim the resource. You cannot call OfferResources to offer immutable resources.To offer shared resources, call OfferResources on only one of the sharing devices. To ensure exclusive access to the resources, you must use an object and then call OfferResources only while you hold the mutex. HRESULT IDXGIDevice2::OfferResources([In] unsigned int NumResources,[In, Buffer] const IDXGIResource** ppResources,[In] DXGI_OFFER_RESOURCE_PRIORITY Priority)

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

No documentation. No documentation. No documentation. ReclaimResources returns: if resources were successfully reclaimed E_INVALIDARG if the resources are invalid After you call to offer one or more resources, you must call ReclaimResources before you can use those resources again. You must check the values in the array at pDiscarded to determine whether each resource?s content was discarded. If a resource?s content was discarded while it was offered, its current content is undefined. Therefore, you must overwrite the resource?s content before you use the resource.To reclaim shared resources, call ReclaimResources only on one of the sharing devices. To ensure exclusive access to the resources, you must use an object and then call ReclaimResources only while you hold the mutex. HRESULT IDXGIDevice2::ReclaimResources([In] unsigned int NumResources,[In, Buffer] const IDXGIResource** ppResources,[Out, Buffer, Optional] BOOL* pDiscarded)

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

A handle to the event object. The CreateEvent or OpenEvent function returns this handle. All types of event objects (manual-reset, auto-reset, and so on) are supported. The handle must have the EVENT_MODIFY_STATE access right. For more information about access rights, see Synchronization Object Security and Access Rights. Returns if successful; otherwise, returns one of the following values:E_OUTOFMEMORY if insufficient memory is available to complete the operation. E_INVALIDARG if the parameter was validated and determined to be incorrect. EnqueueSetEvent calls the SetEvent function on the event object after all previously submitted rendering commands complete or the device is removed.After an application calls EnqueueSetEvent, it can immediately call the WaitForSingleObject function to put itself to sleep until rendering commands complete.You cannot use EnqueueSetEvent to determine work completion that is associated with presentation (); instead, we recommend that you use . HRESULT IDXGIDevice2::EnqueueSetEvent([In] void* hEvent)

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

IDXGIDisplayControl

Initializes a new instance of the class.

The native pointer.

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

IsStereoEnabled returns TRUE when the operating system's stereoscopic 3D display behavior is enabled and whenthis behavior is disabled. You pass a Boolean value to the method to either enable or disable the operating system's stereoscopic 3D display behavior. TRUE enables the operating system's stereoscopic 3D display behavior and disables it. BOOL IDXGIDisplayControl::IsStereoEnabled()

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

A Boolean value that either enables or disables the operating system's stereoscopic 3D display behavior. TRUE enables the operating system's stereoscopic 3D display behavior and disables it. void IDXGIDisplayControl::SetStereoEnabled([In] BOOL enabled)

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

You pass a Boolean value to the method to either enable or disable the operating system's stereoscopic 3D display behavior. TRUE enables the operating system's stereoscopic 3D display behavior and disables it. IsStereoEnabled BOOL IDXGIDisplayControl::IsStereoEnabled()

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

SetStereoEnabled void IDXGIDisplayControl::SetStereoEnabled([In] BOOL enabled)

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

IDXGIFactory2

Initializes a new instance of the class.

The native pointer.

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

Indicates whether to use stereo mode. TRUE indicates that you can use stereo mode; otherwise, . We recommend that windowed applications call IsWindowedStereoEnabled before they attempt to use stereo. IsWindowedStereoEnabled returns TRUE if both of the following items are true:All adapters in the computer have drivers that are capable of stereo. This only means that the driver is implemented to the Windows Display Driver Model (WDDM) for Windows Developer Preview (WDDM 1.2). However, the adapter does not necessarily have to be able to scan out stereo. The current desktop mode (desktop modes are mono) and system policy and hardware are configured so that the Desktop Window Manager (DWM) performs stereo composition on at least one adapter output.The creation of a windowed stereo swap chain succeeds if the first requirement is met. However, if the adapter can't scan out stereo, the output on that adapter is reduced to mono. BOOL IDXGIFactory2::IsWindowedStereoEnabled()

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

No documentation. No documentation. No documentation. No documentation. No documentation. No documentation. Note??Do not use this method in Metro style apps. Instead, use .If you specify the width, height, or both (Width and Height members of that pDesc points to) of the swap chain as zero, the runtime obtains the size from the output window that the hWnd parameter specifies. You can subsequently call the method to retrieve the assigned width or height value.Because you can associate only one flip presentation model swap chain at a time with an , the Microsoft Direct3D?11 policy of deferring the destruction of objects can cause problems if you attempt to destroy a flip presentation model swap chain and replace it with another swap chain. For more info about this situation, see Deferred Destruction Issues with Flip Presentation Swap Chains. HRESULT IDXGIFactory2::CreateSwapChainForHwnd([In] IUnknown* pDevice,[In] HWND hWnd,[In] const DXGI_SWAP_CHAIN_DESC1* pDesc,[In, Optional] const DXGI_SWAP_CHAIN_FULLSCREEN_DESC* pFullscreenDesc,[In, Optional] IDXGIOutput* pRestrictToOutput,[Out] IDXGISwapChain1** ppSwapChain)

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

A reference to the Direct3D device for the swap chain. This parameter cannot be null. A reference to the IWindow object that is associated with the swap chain that CreateSwapChainForImmersiveWindow creates. A reference to a structure for the swap-chain description. This parameter cannot be null. A reference to the interface that the swap chain is restricted to. If the swap chain is moved to a different output, the content is black. You can optionally set this parameter to an output target that uses to restrict the content on this output. If you do not set this parameter to restrict content on an output target, you can set it to null. A reference to a variable that receives a reference to the interface for the swap chain that CreateSwapChainForImmersiveWindow creates. Note??Use this method in Metro style apps rather than .If you specify the width, height, or both (Width and Height members of that pDesc points to) of the swap chain as zero, the runtime obtains the size from the output window that the pWindow parameter specifies. You can subsequently call the method to retrieve the assigned width or height value.Because you can associate only one flip presentation model swap chain at a time with an IWindow, the Microsoft Direct3D?11 policy of deferring the destruction of objects can cause problems if you attempt to destroy a flip presentation model swap chain and replace it with another swap chain. For more info about this situation, see Deferred Destruction Issues with Flip Presentation Swap Chains. HRESULT IDXGIFactory2::CreateSwapChainForImmersiveWindow([In] IUnknown* pDevice,[In] IUnknown* pWindow,[In] const DXGI_SWAP_CHAIN_DESC1* pDesc,[In, Optional] IDXGIOutput* pRestrictToOutput,[Out] IDXGISwapChain1** ppSwapChain)

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

No documentation. No documentation. No documentation. No documentation. No documentation. Because you can associate only one flip presentation model swap chain at a time with a composition surface, the Microsoft Direct3D?11 policy of deferring the destruction of objects can cause problems if you attempt to destroy a flip presentation model swap chain and replace it with another swap chain. For more info about this situation, see Deferred Destruction Issues with Flip Presentation Swap Chains. HRESULT IDXGIFactory2::CreateSwapChainForCompositionSurface([In] IUnknown* pDevice,[In, Optional] void* hSurface,[In] const DXGI_SWAP_CHAIN_DESC1* pDesc,[In, Optional] IDXGIOutput* pRestrictToOutput,[Out] IDXGISwapChain1** ppSwapChain)

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

A handle to a shared resource object. The method returns this handle. A reference to a variable that receives a locally unique identifier () value that identifies the adapter. is defined in Dxgi.h. An is a 64-bit value that is guaranteed to be unique only on the operating system on which it was generated. The uniqueness of an is guaranteed only until the operating system is restarted. GetSharedResourceAdapterLuid returns: if it identified the adapter. if hResource is invalid. Possibly other error codes that are described in the DXGI_ERROR topic. You cannot share resources across adapters. Therefore, you cannot open a shared resource on an adapter other than the adapter on which the resource was created. Call GetSharedResourceAdapterLuid before you open a shared resource to ensure that the resource was created on the appropriate adapter. To open a shared resource, call the or method. HRESULT IDXGIFactory2::GetSharedResourceAdapterLuid([In] void* hResource,[Out] LUID* pLuid)

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

The handle of the window to send a notification message to when stereo status change occurs. Identifies the notification message to send. A reference to a key value that an application can pass to the method to unregister the notification message that wMsg specifies. RegisterStereoStatusWindow returns: if it successfully registered the window. E_OUTOFMEMORY if memory is unavailable to complete the operation. Possibly other error codes that are described in the DXGI_ERROR topic. HRESULT IDXGIFactory2::RegisterStereoStatusWindow([In] HWND WindowHandle,[In] unsigned int wMsg,[Out] unsigned int* pdwCookie)

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

A handle to the event object that the operating system sets when notification of stereo status change occurs. The CreateEvent or OpenEvent function returns this handle. A reference to a key value that an application can pass to the method to unregister the notification event that hEvent specifies. RegisterStereoStatusEvent returns: if it successfully registered the event. E_OUTOFMEMORY if memory is unavailable to complete the operation. Possibly other error codes that are described in the DXGI_ERROR topic. HRESULT IDXGIFactory2::RegisterStereoStatusEvent([In] void* hEvent,[Out] unsigned int* pdwCookie)

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

A key value for the window or event to unregister. The or method returns this value. void IDXGIFactory2::UnregisterStereoStatus([In] unsigned int dwCookie)

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

The handle of the window to send a notification message to when occlusion status change occurs. Identifies the notification message to send. A reference to a key value that an application can pass to the method to unregister the notification message that wMsg specifies. RegisterOcclusionStatusWindow returns: if it successfully registered the window. E_OUTOFMEMORY if memory is unavailable to complete the operation. if WindowHandle is not a valid window handle or not the window handle that the current process owns. Possibly other error codes that are described in the DXGI_ERROR topic. HRESULT IDXGIFactory2::RegisterOcclusionStatusWindow([In] HWND WindowHandle,[In] unsigned int wMsg,[Out] unsigned int* pdwCookie)

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

A handle to the event object that the operating system sets when notification of occlusion status change occurs. The CreateEvent or OpenEvent function returns this handle. A reference to a key value that an application can pass to the method to unregister the notification event that hEvent specifies. RegisterOcclusionStatusEvent returns: if the method successfully registered the event. E_OUTOFMEMORY if memory is unavailable to complete the operation. if hEvent is not a valid handle or not an event handle. Possibly other error codes that are described in the DXGI_ERROR topic. HRESULT IDXGIFactory2::RegisterOcclusionStatusEvent([In] void* hEvent,[Out] unsigned int* pdwCookie)

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

A key value for the window or event to unregister. The or method returns this value. void IDXGIFactory2::UnregisterOcclusionStatus([In] unsigned int dwCookie)

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

We recommend that windowed applications call IsWindowedStereoEnabled before they attempt to use stereo. IsWindowedStereoEnabled returns TRUE if both of the following items are true:All adapters in the computer have drivers that are capable of stereo. This only means that the driver is implemented to the Windows Display Driver Model (WDDM) for Windows Developer Preview (WDDM 1.2). However, the adapter does not necessarily have to be able to scan out stereo. The current desktop mode (desktop modes are mono) and system policy and hardware are configured so that the Desktop Window Manager (DWM) performs stereo composition on at least one adapter output.The creation of a windowed stereo swap chain succeeds if the first requirement is met. However, if the adapter can't scan out stereo, the output on that adapter is reduced to mono. IsWindowedStereoEnabled BOOL IDXGIFactory2::IsWindowedStereoEnabled()

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

IDXGIKeyedMutex

Initializes a new instance of the class.

The native pointer.

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

A value that indicates which device to give access to. This method will succeed when the device that currently owns the surface calls the method using the same value. This value can be any UINT64 value. The time-out interval, in milliseconds. This method will return if the interval elapses, and the keyed mutex has not been released using the specified Key. If this value is set to zero, the AcquireSync method will test to see if the keyed mutex has been released and returns immediately. If this value is set to INFINITE, the time-out interval will never elapse. Return if successful.If the owning device attempted to create another keyed mutex on the same shared resource, AcquireSync returns E_FAIL.AcquireSync can also return the following DWORD constants. Therefore, you should explicitly check for these constants. If you only use the SUCCEEDED macro on the return value to determine if AcquireSync succeeded, you will not catch these constants.WAIT_ABANDONED - The shared surface and keyed mutex are no longer in a consistent state. If AcquireSync returns this value, you should release and recreate both the keyed mutex and the shared surface. WAIT_TIMEOUT - The time-out interval elapsed before the specified key was released. The AcquireSync method creates a lock to a surface that is shared between multiple devices, allowing only one device to render to a surface at a time. This method uses a key to determine which device currently has exclusive access to the surface.When a surface is created using the value of the enumeration, you must call the AcquireSync method before rendering to the surface. You must call the ReleaseSync method when you are done rendering to a surface.To acquire a reference to the keyed mutex object of a shared resource, call the QueryInterface method of the resource and pass in the UUID of the interface. For more information about acquiring this reference, see the following code example.The AcquireSync method uses the key as follows, depending on the state of the surface:On initial creation, the surface is unowned and any device can call the AcquireSync method to gain access. For an unowned device, only a key of 0 will succeed. Calling the AcquireSync method for any other key will stall the calling CPU thread. If the surface is owned by a device when you call the AcquireSync method, the CPU thread that called the AcquireSync method will stall until the owning device calls the ReleaseSync method using the same Key. If the surface is unowned when you call the AcquireSync method (for example, the last owning device has already called the ReleaseSync method), the AcquireSync method will succeed if you specify the same key that was specified when the ReleaseSync method was last called. Calling the AcquireSync method using any other key will cause a stall. When the owning device calls the ReleaseSync method with a particular key, and more than one device is waiting after calling the AcquireSync method using the same key, any one of the waiting devices could be woken up first. The order in which devices are woken up is undefined. A keyed mutex does not support recursive calls to the AcquireSync method. HRESULT IDXGIKeyedMutex::AcquireSync([In] unsigned longlong Key,[In] unsigned int dwMilliseconds)

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

A value that indicates which device to give access to. This method succeeds when the device that currently owns the surface calls the ReleaseSync method using the same value. This value can be any UINT64 value. Returns if successful.If the device attempted to release a keyed mutex that is not valid or owned by the device, ReleaseSync returns E_FAIL. The ReleaseSync method releases a lock to a surface that is shared between multiple devices. This method uses a key to determine which device currently has exclusive access to the surface.When a surface is created using the value of the enumeration, you must call the method before rendering to the surface. You must call the ReleaseSync method when you are done rendering to a surface.After you call the ReleaseSync method, the shared resource is unset from the rendering pipeline.To acquire a reference to the keyed mutex object of a shared resource, call the QueryInterface method of the resource and pass in the UUID of the interface. For more information about acquiring this reference, see the following code example. HRESULT IDXGIKeyedMutex::ReleaseSync([In] unsigned longlong Key)

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

IDXGIOutput

Initializes a new instance of the class.

The native pointer.

Get a description of the output.

A reference to the output description (see ). Returns a code that indicates success or failure. if successful, if pDesc is passed in as null. HRESULT IDXGIOutput::GetDesc([Out] DXGI_OUTPUT_DESC* pDesc)

[Starting with Direct3D 11.1, we recommend not to use GetDisplayModeList anymore to retrieve the matching display mode. Instead, use , which supports stereo display mode.]

No documentation. No documentation. No documentation. No documentation. Returns one of the following DXGI_ERROR. It is rare, but possible, that the display modes available can change immediately after calling this method, in which case is returned (if there is not enough room for all the display modes). If GetDisplayModeList is called from a Remote Desktop Services session (formerly Terminal Services session), is returned. In general, when switching from windowed to full-screen mode, a swap chain automatically chooses a display mode that meets (or exceeds) the resolution, color depth and refresh rate of the swap chain. To exercise more control over the display mode, use this API to poll the set of display modes that are validated against monitor capabilities, or all modes that match the desktop (if the desktop settings are not validated against the monitor).As shown, this API is designed to be called twice. First to get the number of modes available, and second to return a description of the modes.

	
             UINT num = 0;	
             format = ;	
            UINT flags         = ; pOutput->GetDisplayModeList( format, flags, &num, 0); ...  * pDescs = new [num];	
            pOutput->GetDisplayModeList( format, flags, &num, pDescs);

HRESULT IDXGIOutput::GetDisplayModeList([In] DXGI_FORMAT EnumFormat,[In] unsigned int Flags,[InOut] unsigned int* pNumModes,[Out, Buffer, Optional] DXGI_MODE_DESC* pDesc)

[Starting with Direct3D 11.1, we recommend not to use FindClosestMatchingMode anymore to find the display mode that most closely matches the requested display mode. Instead, use , which supports stereo display mode.]

No documentation. No documentation. No documentation. Returns one of the following DXGI_ERROR. FindClosestMatchingMode behaves similarly to the except FindClosestMatchingMode considers only the mono display modes. considers only stereo modes if you set the Stereo member in the structure that pModeToMatch points to, and considers only mono modes if Stereo is not set. returns a matched display-mode set with only stereo modes or only mono modes. FindClosestMatchingMode behaves as though you specified the input mode as mono. HRESULT IDXGIOutput::FindClosestMatchingMode([In] const DXGI_MODE_DESC* pModeToMatch,[Out] DXGI_MODE_DESC* pClosestMatch,[In, Optional] IUnknown* pConcernedDevice)

Halt a thread until the next vertical blank occurs.

Returns one of the following DXGI_ERROR. A vertical blank occurs when the raster moves from the lower right corner to the upper left corner to begin drawing the next frame. HRESULT IDXGIOutput::WaitForVBlank()

Takes ownership of an output.

A reference to the interface of a device (such as an ). Set to TRUE to enable other threads or applications to take ownership of the device; otherwise, set to . Returns one of the DXGI_ERROR values. When you are finished with the output, call .TakeOwnership should not be called directly by applications, since results will be unpredictable. It is called implicitly by the DXGI swap chain object during full-screen transitions, and should not be used as a substitute for swap-chain methods.Notes for Metro style appsIf a Metro style app uses TakeOwnership, it fails with . HRESULT IDXGIOutput::TakeOwnership([In] IUnknown* pDevice,[In] BOOL Exclusive)

Releases ownership of the output.

If you are not using a swap chain, get access to an output by calling and release it when you are finished by calling . An application that uses a swap chain will typically not call either of these methods. void IDXGIOutput::ReleaseOwnership()

Gets a description of the gamma-control capabilities.

A reference to a description of the gamma-control capabilities (see ). Returns one of the DXGI_ERROR values. Note??Calling this method is only supported while in full-screen mode. HRESULT IDXGIOutput::GetGammaControlCapabilities([Out] DXGI_GAMMA_CONTROL_CAPABILITIES* pGammaCaps)

Sets the gamma controls.

A reference to an array of gamma controls (see ). Returns one of the DXGI_ERROR values. Note??Calling this method is only supported while in full-screen mode. HRESULT IDXGIOutput::SetGammaControl([In] const DXGI_GAMMA_CONTROL* pArray)

Gets the gamma control settings.

An array of gamma control settings (see ). Returns one of the DXGI_ERROR values. Note??Calling this method is only supported while in full-screen mode. HRESULT IDXGIOutput::GetGammaControl([Out] DXGI_GAMMA_CONTROL* pArray)

Changes the display mode.

A reference to a surface (see ) used for rendering an image to the screen. The surface must have been created as a back buffer (DXGI_USAGE_BACKBUFFER). Returns one of the DXGI_ERROR values. IDXGIOutput::SetDisplaySurface should not be called directly by applications, since results will be unpredictable. It is called implicitly by the DXGI swap chain object during full-screen transitions, and should not be used as a substitute for swap-chain methods.This method should only be called between and calls.Notes for Metro style appsIf a Metro style app uses SetDisplaySurface, it fails with . HRESULT IDXGIOutput::SetDisplaySurface([In] IDXGISurface* pScanoutSurface)

[Starting with Direct3D 11.1, we recommend not to use GetDisplaySurfaceData anymore to retrieve the current display surface. Instead, use , which supports stereo display mode.]

No documentation. Returns one of the DXGI_ERROR values. IDXGIOutput::GetDisplaySurfaceData can only be called when an output is in full-screen mode. If the method succeeds, DXGI fills the destination surface.Use to determine the size (width and height) of the output when you want to allocate space for the destination surface. This is true regardless of target monitor rotation. A destination surface created by a graphics component (such as Direct3D 10) must be created with CPU-write permission (see ). Other surfaces should be created with CPU read-write permission (see D3D10_CPU_ACCESS_READ_WRITE). This method will modify the surface data to fit the destination surface (stretch, shrink, convert format, rotate). The stretch and shrink is performed with point-sampling. HRESULT IDXGIOutput::GetDisplaySurfaceData([In] IDXGISurface* pDestination)

Gets statistics about recently rendered frames.

A reference to frame statistics (see ). If this function succeeds, it returns . Otherwise, it might return . This API is similar to .Note??Calling this method is only supported while in full-screen mode. HRESULT IDXGIOutput::GetFrameStatistics([Out] DXGI_FRAME_STATISTICS* pStats)

Find the display mode that most closely matches the requested display mode.

Direct3D devices require UNORM formats. This method finds the closest matching available display mode to the mode specified in pModeToMatch. Similarly ranked fields (ie. all specified, or all unspecified, etc) are resolved in the following order. ScanlineOrdering Scaling Format Resolution RefreshRate When determining the closest value for a particular field, previously matched fields are used to filter the display mode list choices, and other fields are ignored. For example, when matching Resolution, the display mode list will have already been filtered by a certain ScanlineOrdering, Scaling, and Format, while RefreshRate is ignored. This ordering doesn't define the absolute ordering for every usage scenario of FindClosestMatchingMode, because the application can choose some values initially, effectively changing the order that fields are chosen. Fields of the display mode are matched one at a time, generally in a specified order. If a field is unspecified, FindClosestMatchingMode gravitates toward the values for the desktop related to this output. If this output is not part of the desktop, then the default desktop output is used to find values. If an application uses a fully unspecified display mode, FindClosestMatchingMode will typically return a display mode that matches the desktop settings for this output. Unspecified fields are lower priority than specified fields and will be resolved later than specified fields. A reference to the Direct3D device interface. If this parameter is NULL, only modes whose format matches that of pModeToMatch will be returned; otherwise, only those formats that are supported for scan-out by the device are returned. The desired display mode (see ). Members of DXGI_MODE_DESC can be unspecified indicating no preference for that member. A value of 0 for Width or Height indicates the value is unspecified. If either Width or Height are 0 both must be 0. A numerator and denominator of 0 in RefreshRate indicate it is unspecified. Other members of DXGI_MODE_DESC have enumeration values indicating the member is unspecified. If pConnectedDevice is NULL Format cannot be DXGI_FORMAT_UNKNOWN. The mode that most closely matches pModeToMatch. Returns one of the following . HRESULT IDXGIOutput::FindClosestMatchingMode([In] const DXGI_MODE_DESC* pModeToMatch,[Out] DXGI_MODE_DESC* pClosestMatch,[In, Optional] IUnknown* pConcernedDevice)

Gets the display modes that match the requested format and other input options.

In general, when switching from windowed to full-screen mode, a swap chain automatically chooses a display mode that meets (or exceeds) the resolution, color depth and refresh rate of the swap chain. To exercise more control over the display mode, use this API to poll the set of display modes that are validated against monitor capabilities, or all modes that match the desktop (if the desktop settings are not validated against the monitor). As shown, this API is designed to be called twice. First to get the number of modes available, and second to return a description of the modes.

 UINT num = 0;	
            DXGI_FORMAT format = DXGI_FORMAT_R32G32B32A32_FLOAT;	
            UINT flags         = DXGI_ENUM_MODES_INTERLACED; pOutput->GetDisplayModeList( format, flags, &num, 0); ... DXGI_MODE_DESC * pDescs = new DXGI_MODE_DESC[num];	
            pOutput->GetDisplayModeList( format, flags, &num, pDescs);

The color format (see ). format for modes to include (see {{DXGI_ENUM_MODES}}). DXGI_ENUM_MODES_SCALING needs to be specified to expose the display modes that require scaling. Centered modes, requiring no scaling and corresponding directly to the display output, are enumerated by default. Returns a list of display modes (see ); HRESULT IDXGIOutput::GetDisplayModeList([None] DXGI_FORMAT EnumFormat,[None] int Flags,[InOut] int* pNumModes,[Out, Buffer, Optional] DXGI_MODE_DESC* pDesc)

Get a description of the output.

GetDesc HRESULT IDXGIOutput::GetDesc([Out] DXGI_OUTPUT_DESC* pDesc)

Gets a description of the gamma-control capabilities.

Note??Calling this method is only supported while in full-screen mode. GetGammaControlCapabilities HRESULT IDXGIOutput::GetGammaControlCapabilities([Out] DXGI_GAMMA_CONTROL_CAPABILITIES* pGammaCaps)

Gets the gamma control settings.

Note??Calling this method is only supported while in full-screen mode. GetGammaControl HRESULT IDXGIOutput::GetGammaControl([Out] DXGI_GAMMA_CONTROL* pArray)

Gets statistics about recently rendered frames.

This API is similar to .Note??Calling this method is only supported while in full-screen mode. GetFrameStatistics HRESULT IDXGIOutput::GetFrameStatistics([Out] DXGI_FRAME_STATISTICS* pStats)

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

IDXGIOutput1

Initializes a new instance of the class.

The native pointer.

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

A -typed value for the color format. A combination of DXGI_ENUM_MODES-typed values that are combined by using a bitwise OR operation. The resulting value specifies options for display modes to include. You must specify to expose the display modes that require scaling. Centered modes that require no scaling and correspond directly to the display output are enumerated by default. A reference to a variable that receives the number of display modes that GetDisplayModeList1 returns in the memory block to which pDesc points. Set pDesc to null so that pNumModes returns the number of display modes that match the format and the options. Otherwise, pNumModes returns the number of display modes returned in pDesc. A reference to a list of display modes; set to null to get the number of display modes. Returns one of the error codes described in the DXGI_ERROR topic. It is rare, but possible, that the display modes available can change immediately after calling this method, in which case is returned (if there is not enough room for all the display modes). GetDisplayModeList1 is updated from GetDisplayModeList to return a list of structures, which are updated mode descriptions. GetDisplayModeList behaves as though it calls GetDisplayModeList1 because GetDisplayModeList can return all of the modes that are specified by DXGI_ENUM_MODES, including stereo mode. However, GetDisplayModeList returns a list of structures, which are the former mode descriptions and do not indicate stereo mode.The GetDisplayModeList1 method does not enumerate stereo modes unless you specify the flag in the Flags parameter. If you specify , stereo modes are included in the list of returned modes that the pDesc parameter points to. In other words, the method returns both stereo and mono modes.In general, when you switch from windowed to full-screen mode, a swap chain automatically chooses a display mode that meets (or exceeds) the resolution, color depth, and refresh rate of the swap chain. To exercise more control over the display mode, use GetDisplayModeList1 to poll the set of display modes that are validated against monitor capabilities, or all modes that match the desktop (if the desktop settings are not validated against the monitor).The following example code shows that you need to call GetDisplayModeList1 twice. First call GetDisplayModeList1 to get the number of modes available, and second call GetDisplayModeList1 to return a description of the modes.

	
             UINT num = 0;	
             format = ;	
            UINT flags         = ; pOutput->GetDisplayModeList1( format, flags, &num, 0); ...  * pDescs = new [num];	
            pOutput->GetDisplayModeList1( format, flags, &num, pDescs);

HRESULT IDXGIOutput1::GetDisplayModeList1([In] DXGI_FORMAT EnumFormat,[In] unsigned int Flags,[InOut] unsigned int* pNumModes,[Out, Buffer, Optional] DXGI_MODE_DESC1* pDesc)

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

A reference to the structure that describes the display mode to match. Members of can be unspecified, which indicates no preference for that member. A value of 0 for Width or Height indicates that the value is unspecified. If either Width or Height is 0, both must be 0. A numerator and denominator of 0 in RefreshRate indicate it is unspecified. Other members of have enumeration values that indicate that the member is unspecified. If pConcernedDevice is null, the Format member of cannot be . A reference to the structure that receives a description of the display mode that most closely matches the display mode described at pModeToMatch. A reference to the Direct3D device interface. If this parameter is null, FindClosestMatchingMode1 returns only modes whose format matches that of pModeToMatch; otherwise, FindClosestMatchingMode1 returns only those formats that are supported for scan-out by the device. For info about the formats that are supported for scan-out by the device at each feature level, see Hardware Support for Direct3D 10 Formats, Hardware Support for Direct3D 10.1 Formats, Hardware Support for Direct3D 10Level9 Formats, Hardware Support for Direct3D 11 Formats, and Hardware Support for Direct3D 11.1 Formats. Returns one of the error codes described in the DXGI_ERROR topic. Direct3D devices require UNORM formats.FindClosestMatchingMode1 finds the closest matching available display mode to the mode that you specify in pModeToMatch.If you set the Stereo member in the structure to which pModeToMatch points to specify a stereo mode as input, FindClosestMatchingMode1 considers only stereo modes. FindClosestMatchingMode1 considers only mono modes if Stereo is not set.FindClosestMatchingMode1 resolves similarly ranked members of display modes (that is, all specified, or all unspecified, and so on) in the following order:ScanlineOrdering Scaling Format Resolution RefreshRateWhen FindClosestMatchingMode1 determines the closest value for a particular member, it uses previously matched members to filter the display mode list choices, and ignores other members. For example, when FindClosestMatchingMode1 matches Resolution, it already filtered the display mode list by a certain ScanlineOrdering, Scaling, and Format, while it ignores RefreshRate. This ordering doesn't define the absolute ordering for every usage scenario of FindClosestMatchingMode1, because the application can choose some values initially, which effectively changes the order of resolving members.FindClosestMatchingMode1 matches members of the display mode one at a time, generally in a specified order.If a member is unspecified, FindClosestMatchingMode1 gravitates toward the values for the desktop related to this output. If this output is not part of the desktop, FindClosestMatchingMode1 uses the default desktop output to find values. If an application uses a fully unspecified display mode, FindClosestMatchingMode1 typically returns a display mode that matches the desktop settings for this output. Because unspecified members are lower priority than specified members, FindClosestMatchingMode1 resolves unspecified members later than specified members. HRESULT IDXGIOutput1::FindClosestMatchingMode1([In] const DXGI_MODE_DESC1* pModeToMatch,[Out] DXGI_MODE_DESC1* pClosestMatch,[In, Optional] IUnknown* pConcernedDevice)

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

A reference to a resource interface that represents the resource to which GetDisplaySurfaceData1 copies the display surface. Returns one of the error codes described in the DXGI_ERROR topic. GetDisplaySurfaceData1 is similar to except GetDisplaySurfaceData1 takes an and takes an .GetDisplaySurfaceData1 returns an error if the input resource is not a 2D texture (represented by the interface) with an array size (ArraySize member of the structure) that is equal to the swap chain buffers.The original and the updated GetDisplaySurfaceData1 behave exactly the same. GetDisplaySurfaceData1 was required because textures with an array size equal to 2 (ArraySize = 2) do not implement .You can call GetDisplaySurfaceData1 only when an output is in full-screen mode. If GetDisplaySurfaceData1 succeeds, it fills the destination resource.Use to determine the size (width and height) of the output when you want to allocate space for the destination resource. This is true regardless of target monitor rotation. A destination resource created by a graphics component (such as Direct3D 11) must be created with CPU write permission (see ). Other surfaces can be created with CPU read-write permission ( | ). GetDisplaySurfaceData1 modifies the surface data to fit the destination resource (stretch, shrink, convert format, rotate). GetDisplaySurfaceData1 performs the stretch and shrink with point sampling. HRESULT IDXGIOutput1::GetDisplaySurfaceData1([In] IDXGIResource* pDestination)

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

No documentation. No documentation. DuplicateOutput returns: if DuplicateOutput successfully created the desktop duplication interface. E_INVALIDARG for one of the following reasons: The specified device (pDevice) is invalid, was not created on the correct adapter, or was not created from (or a later version of a DXGI factory interface that inherits from ). The calling application is already duplicating this desktop output. For more information about this error, see Remarks. E_ACCESSDENIED if the application does not have access privilege to the current desktop image. For example, only an application that runs at LOCAL_SYSTEM can access the secure desktop. if the created interface does not support the current desktop mode or scenario. For example, 8bpp and non-DWM desktop modes are not supported. if DXGI reached the limit on the maximum number of concurrent duplication applications (default of four). Therefore, the calling application cannot create any desktop duplication interfaces until the other applications close. if DuplicateOutput failed because the session is currently disconnected. Other error codes are described in the DXGI_ERROR topic. If an application wants to duplicate the entire desktop, it must create a desktop duplication interface on each active output on the desktop. This interface does not provide an explicit way to synchronize the timing of each output image. Instead, the application must use the time stamp of each output, and then determine how to combine the images.For DuplicateOutput to succeed, you must create pDevice from or a later version of a DXGI factory interface that inherits from .If the current mode is a stereo mode, the desktop duplication interface provides the image for the left stereo image only.By default, only four processes can use a interface at the same time within a single session. A process can have only one desktop duplication interface on a single desktop output; however, that process can have a desktop duplication interface for each output that is part of the desktop.If DuplicateOutput fails with , the application can wait for system notification of desktop switches and mode changes and then call DuplicateOutput again after such a notification occurs. For more information, see information in desktop switch (EVENT_SYSTEM_DESKTOPSWITCH) and mode change notification (WM_DISPLAYCHANGE). HRESULT IDXGIOutput1::DuplicateOutput([In] IUnknown* pDevice,[Out] IDXGIOutputDuplication** ppOutputDuplication)

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

IDXGIOutputDuplication

Initializes a new instance of the class.

The native pointer.

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

A reference to a structure that describes the duplicated output. This parameter must not be null. After an application creates an interface, it calls GetDesc to retrieve the dimensions of the surface that contains the desktop image. The format of the desktop image is always . void IDXGIOutputDuplication::GetDesc([Out] DXGI_OUTDUPL_DESC* pDesc)

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

The time-out interval, in milliseconds. This interval specifies the amount of time that this method waits for a new frame before it returns to the caller. This method returns if the interval elapses, and a new desktop image is not available. For more information about the time-out interval, see Remarks. A reference to a memory location that receives the structure that describes timing and presentation statistics for a frame. A reference to a variable that receives the interface of the surface that contains the desktop bitmap. AcquireNextFrame returns: if it successfully received the next desktop image. if the desktop duplication interface is invalid. The desktop duplication interface typically becomes invalid when a different type of image is displayed on the desktop. Examples of this situation are: Desktop switch Mode change Switch from DWM on, DWM off, or other full-screen application In this situation, the application must release the interface and create a new for the new content. if the time-out interval elapsed before the next desktop frame was available. if the application called AcquireNextFrame without releasing the previous frame. E_INVALIDARG if one of the parameters to AcquireNextFrame is incorrect; for example, if pFrameInfo is null. Possibly other error codes that are described in the DXGI_ERROR topic. When AcquireNextFrame returns successfully, the calling application can access the desktop image that AcquireNextFrame returns in the variable at ppDesktopResource. If the caller specifies a zero time-out interval in the TimeoutInMilliseconds parameter, AcquireNextFrame verifies whether there is a new desktop image available, returns immediately, and indicates its outcome with the return value. If the caller specifies an INFINITE time-out interval in the TimeoutInMilliseconds parameter, the time-out interval never elapses.Note??You cannot cancel the wait that you specified in the TimeoutInMilliseconds parameter. Therefore, if you must periodically check for other conditions (for example, a terminate signal), you should specify a non-INFINITE time-out interval. After the time-out interval elapses, you can check for these other conditions and then call AcquireNextFrame again to wait for the next frame.AcquireNextFrame acquires a new desktop frame when the operating system either updates the desktop bitmap image or changes the shape or position of a hardware reference. The new frame that AcquireNextFrame acquires might have only the desktop image updated, only the reference shape or position updated, or both. HRESULT IDXGIOutputDuplication::AcquireNextFrame([In] unsigned int TimeoutInMilliseconds,[Out] DXGI_OUTDUPL_FRAME_INFO* pFrameInfo,[Out] IDXGIResource** ppDesktopResource)

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

The size in bytes of the buffer that the caller passed to the pDirtyRectsBuffer parameter. A reference to an array of structures that identifies the dirty rectangle regions for the desktop frame. Pointer to a variable that receives the number of bytes that GetFrameDirtyRects needs to store information about dirty regions in the buffer at pDirtyRectsBuffer. For more information about returning the required buffer size, see Remarks. GetFrameDirtyRects returns: if it successfully retrieved information about dirty rectangles. if the desktop duplication interface is invalid. The desktop duplication interface typically becomes invalid when a different type of image is displayed on the desktop. Examples of this situation are: Desktop switch Mode change Switch from DWM on, DWM off, or other full-screen application In this situation, the application must release the interface and create a new for the new content. if the buffer that the calling application provided was not big enough. if the application called GetFrameDirtyRects without owning the desktop image. E_INVALIDARG if one of the parameters to GetFrameDirtyRects is incorrect; for example, if pDirtyRectsBuffer is null. Possibly other error codes that are described in the DXGI_ERROR topic. GetFrameDirtyRects stores a size value in the variable at pDirtyRectsBufferSizeRequired. This value specifies the number of bytes that GetFrameDirtyRects needs to store information about dirty regions. You can use this value in the following situations to determine the amount of memory to allocate for future buffers that you pass to pDirtyRectsBuffer:GetFrameDirtyRects fails with because the buffer is not big enough. GetFrameDirtyRects supplies a buffer that is bigger than necessary. The size value returned at pDirtyRectsBufferSizeRequired informs the caller how much buffer space was actually used compared to how much buffer space the caller allocated and specified in the DirtyRectsBufferSize parameter.The caller can also use the value returned at pDirtyRectsBufferSizeRequired to determine the number of RECTs returned in the pDirtyRectsBuffer array.The buffer contains the list of dirty RECTs for the current frame.Note??To produce a visually accurate copy of the desktop, an application must first process all move RECTs before it processes dirty RECTs. HRESULT IDXGIOutputDuplication::GetFrameDirtyRects([In] unsigned int DirtyRectsBufferSize,[Out, Buffer] RECT* pDirtyRectsBuffer,[Out] unsigned int* pDirtyRectsBufferSizeRequired)

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

The size in bytes of the buffer that the caller passed to the pMoveRectBuffer parameter. A reference to an array of structures that identifies the moved rectangle regions for the desktop frame. Pointer to a variable that receives the number of bytes that GetFrameMoveRects needs to store information about moved regions in the buffer at pMoveRectBuffer. For more information about returning the required buffer size, see Remarks. GetFrameMoveRects returns: if it successfully retrieved information about moved rectangles. if the desktop duplication interface is invalid. The desktop duplication interface typically becomes invalid when a different type of image is displayed on the desktop. Examples of this situation are: Desktop switch Mode change Switch from DWM on, DWM off, or other full-screen application In this situation, the application must release the interface and create a new for the new content. if the buffer that the calling application provided is not big enough. if the application called GetFrameMoveRects without owning the desktop image. E_INVALIDARG if one of the parameters to GetFrameMoveRects is incorrect; for example, if pMoveRectBuffer is null. Possibly other error codes that are described in the DXGI_ERROR topic. GetFrameMoveRects stores a size value in the variable at pMoveRectsBufferSizeRequired. This value specifies the number of bytes that GetFrameMoveRects needs to store information about moved regions. You can use this value in the following situations to determine the amount of memory to allocate for future buffers that you pass to pMoveRectBuffer:GetFrameMoveRects fails with because the buffer is not big enough. GetFrameMoveRects supplies a buffer that is bigger than necessary. The size value returned at pMoveRectsBufferSizeRequired informs the caller how much buffer space was actually used compared to how much buffer space the caller allocated and specified in the MoveRectsBufferSize parameter.The caller can also use the value returned at pMoveRectsBufferSizeRequired to determine the number of structures returned.The buffer contains the list of move RECTs for the current frame.Note??To produce a visually accurate copy of the desktop, an application must first process all move RECTs before it processes dirty RECTs. HRESULT IDXGIOutputDuplication::GetFrameMoveRects([In] unsigned int MoveRectsBufferSize,[Out, Buffer] DXGI_OUTDUPL_MOVE_RECT* pMoveRectBuffer,[Out] unsigned int* pMoveRectsBufferSizeRequired)

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

The size in bytes of the buffer that the caller passed to the pPointerShapeBuffer parameter. A reference to a buffer to which GetFramePointerShape copies and returns pixel data for the new reference shape. Pointer to a variable that receives the number of bytes that GetFramePointerShape needs to store the new reference shape pixel data in the buffer at pPointerShapeBuffer. For more information about returning the required buffer size, see Remarks. Pointer to a structure that receives the reference shape information. GetFramePointerShape returns: if it successfully retrieved information about the new reference shape. if the desktop duplication interface is invalid. The desktop duplication interface typically becomes invalid when a different type of image is displayed on the desktop. Examples of this situation are: Desktop switch Mode change Switch from DWM on, DWM off, or other full-screen application In this situation, the application must release the interface and create a new for the new content. if the buffer that the calling application provided was not big enough. if the application called GetFramePointerShape without owning the desktop image. E_INVALIDARG if one of the parameters to GetFramePointerShape is incorrect; for example, if pPointerShapeInfo is null. Possibly other error codes that are described in the DXGI_ERROR topic. GetFramePointerShape stores a size value in the variable at pPointerShapeBufferSizeRequired. This value specifies the number of bytes that pPointerShapeBufferSizeRequired needs to store the new reference shape pixel data. You can use the value in the following situations to determine the amount of memory to allocate for future buffers that you pass to pPointerShapeBuffer:GetFramePointerShape fails with because the buffer is not big enough. GetFramePointerShape supplies a bigger than necessary buffer. The size value returned at pPointerShapeBufferSizeRequired informs the caller how much buffer space was actually used compared to how much buffer space the caller allocated and specified in the PointerShapeBufferSize parameter.The pPointerShapeInfo parameter describes the new reference shape. HRESULT IDXGIOutputDuplication::GetFramePointerShape([In] unsigned int PointerShapeBufferSize,[Out, Buffer] void* pPointerShapeBuffer,[Out] unsigned int* pPointerShapeBufferSizeRequired,[Out] DXGI_OUTDUPL_POINTER_SHAPE_INFO* pPointerShapeInfo)

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

A reference to a structure that receives the surface data that the CPU needs to directly access the surface data. MapDesktopSurface returns: if it successfully retrieved the surface data. if the desktop duplication interface is invalid. The desktop duplication interface typically becomes invalid when a different type of image is displayed on the desktop. Examples of this situation are: Desktop switch Mode change Switch from DWM on, DWM off, or other full-screen application In this situation, the application must release the interface and create a new for the new content. if the application already has an outstanding map on the desktop image. The application must call UnMapDesktopSurface before it calls MapDesktopSurface again. is also returned if the application did not own the desktop image when it called MapDesktopSurface. if the desktop image is not in system memory. In this situation, the application must first transfer the image to a staging surface and then lock the image by calling the method. E_INVALIDARG if the pLockedRect parameter is incorrect; for example, if pLockedRect is null. Possibly other error codes that are described in the DXGI_ERROR topic. You can successfully call MapDesktopSurface if the DesktopImageInSystemMemeory member of the structure is set to TRUE. If DesktopImageInSystemMemeory is , MapDesktopSurface returns . Call to retrieve the structure. HRESULT IDXGIOutputDuplication::MapDesktopSurface([Out] DXGI_MAPPED_RECT* pLockedRect)

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

UnMapDesktopSurface returns: if it successfully completed. if the application did not map the desktop surface by calling . Possibly other error codes that are described in the DXGI_ERROR topic. HRESULT IDXGIOutputDuplication::UnMapDesktopSurface()

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

ReleaseFrame returns: if it successfully completed. if the application already released the frame. if the desktop duplication interface is invalid. The desktop duplication interface typically becomes invalid when a different type of image is displayed on the desktop. Examples of this situation are: Desktop switch Mode change Switch from DWM on, DWM off, or other full-screen application In this situation, the application must release the interface and create a new for the new content. Possibly other error codes that are described in the DXGI_ERROR topic. The application must release the frame before it acquires the next frame. After the frame is released, the surface that contains the desktop bitmap becomes invalid; you will not be able to use the surface in a DirectX graphics operation.For performance reasons, we recommend that you release the frame just before you call the method to acquire the next frame. When the client does not own the frame, the operating system copies all desktop updates to the surface. This can result in wasted GPU cycles if the operating system updates the same region for each frame that occurs. When the client acquires the frame, the client is aware of only the final update to this region; therefore, any overlapping updates during previous frames are wasted. When the client acquires a frame, the client owns the surface; therefore, the operating system can track only the updated regions and cannot copy desktop updates to the surface. Because of this behavior, we recommend that you minimize the time between the call to release the current frame and the call to acquire the next frame. HRESULT IDXGIOutputDuplication::ReleaseFrame() HRESULT IDXGIOutputDuplication::MapDesktopSurface([Out] DXGI_MAPPED_RECT* pLockedRect)

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

After an application creates an interface, it calls GetDesc to retrieve the dimensions of the surface that contains the desktop image. The format of the desktop image is always . GetDesc void IDXGIOutputDuplication::GetDesc([Out] DXGI_OUTDUPL_DESC* pDesc)

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

IDXGIResource

Initializes a new instance of the class.

The native pointer.

[Starting with Direct3D 11.1, we recommend not to use GetSharedHandle anymore to retrieve the handle to a shared resource. Instead, use to get a handle for sharing. To use , you must create the resource as shared and specify that it uses NT handles (that is, you set the flag). We also recommend that you create shared resources that use NT handles so you can use CloseHandle, DuplicateHandle, and so on on those shared resources.]

No documentation. Returns one of the DXGI_ERROR values. You can pass the handle that GetSharedHandle returns in a call to the method to give a device access to a shared resource that you created on a different device.GetSharedHandle doesn't always return a handle. GetSharedHandle only returns the handle when you created the resource as shared (that is, you set the or flag).The handle that GetSharedHandle returns is not an NT handle. Therefore, don't use the handle with CloseHandle, DuplicateHandle, and so on. The creator of a shared resource must not destroy the resource until all entities that opened the resource have destroyed the resource. The validity of the handle is tied to the lifetime of the underlying video memory. If no resource objects exist on any devices that refer to this resource, the handle is no longer valid. To extend the lifetime of the handle and video memory, you must open the shared resource on a device. HRESULT IDXGIResource::GetSharedHandle([Out] void** pSharedHandle)

Get the expected resource usage.

A reference to a usage flag (see DXGI_USAGE). For Direct3D 10, a surface can be used as a shader input or a render-target output. Returns one of the following DXGI_ERROR. HRESULT IDXGIResource::GetUsage([Out] unsigned int* pUsage)

You can pass the handle that GetSharedHandle returns in a call to the method to give a device access to a shared resource that you created on a different device.GetSharedHandle doesn't always return a handle. GetSharedHandle only returns the handle when you created the resource as shared (that is, you set the or flag).The handle that GetSharedHandle returns is not an NT handle. Therefore, don't use the handle with CloseHandle, DuplicateHandle, and so on. The creator of a shared resource must not destroy the resource until all entities that opened the resource have destroyed the resource. The validity of the handle is tied to the lifetime of the underlying video memory. If no resource objects exist on any devices that refer to this resource, the handle is no longer valid. To extend the lifetime of the handle and video memory, you must open the shared resource on a device. GetSharedHandle HRESULT IDXGIResource::GetSharedHandle([Out] void** pSharedHandle)

Get the expected resource usage.

GetUsage HRESULT IDXGIResource::GetUsage([Out] unsigned int* pUsage)

Get the eviction priority.

The eviction priority is a memory-management variable that is used by DXGI to determine how to manage overcommitted memory.Priority levels other than the defined values are used when appropriate. For example, a resource with a priority level of 0x78000001 indicates that the resource is slightly above normal. GetEvictionPriority HRESULT IDXGIResource::GetEvictionPriority([Out] unsigned int* pEvictionPriority)

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

IDXGIResource1

Initializes a new instance of the class.

The native pointer.

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

The index of the subresource surface object to enumerate. The address of a reference to a interface that represents the created subresource surface object at the position specified by the index parameter. Returns if successful; otherwise, returns one of the following values: if the index is out of range or if the subresource is not a valid surface. E_OUTOFMEMORY if insufficient memory is available to create the subresource surface object.A subresource is a valid surface if the original resource would have been a valid surface had its array size been equal to 1. Subresource surface objects implement the interface, which inherits from and indirectly . Therefore, the GDI-interoperable methods of work if the original resource interface object was created with the GDI-interoperable flag ().CreateSubresourceSurface creates a subresource surface that is based on the resource interface on which CreateSubresourceSurface is called. For example, if the original resource interface object is a 2D texture, the created subresource surface is also a 2D texture.You can use CreateSubresourceSurface to create parts of a stereo resource so you can use Direct2D on either the left or right part of the stereo resource. HRESULT IDXGIResource1::CreateSubresourceSurface([In] unsigned int index,[Out] IDXGISurface2** ppSurface)

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

A reference to a structure that contains two separate but related data members: an optional security descriptor, and a Boolean value that determines whether child processes can inherit the returned handle. Set this parameter to null if you want child processes that the application might create to not inherit the handle returned by CreateSharedHandle, and if you want the resource that is associated with the returned handle to get a default security descriptor. The lpSecurityDescriptor member of the structure specifies a SECURITY_DESCRIPTOR for the resource. Set this member to null if you want the runtime to assign a default security descriptor to the resource that is associated with the returned handle. The requested access rights to the resource. In addition to the generic access rights, DXGI defines the following values: DXGI_SHARED_RESOURCE_READ ( 0x80000000L ) - specifies read access to the resource. DXGI_SHARED_RESOURCE_WRITE ( 1 ) - specifies write access to the resource. You can combine these values by using a bitwise OR operation. The name of the resource to share. You will need the resource name if you call the method to access the shared resource by name. If you instead call the method to access the shared resource by handle, set this parameter to null. A reference to a variable that receives the NT HANDLE value to the resource to share. You can use this handle in calls to access the resource. Returns if successful; otherwise, returns one of the following values: if one of the parameters is invalid. E_OUTOFMEMORY if sufficient memory is not available to create the handle. Possibly other error codes that are described in the DXGI_ERROR topic. If you created the resource as shared and specified that it uses NT handles (that is, you set the flag), you must use CreateSharedHandle to get a handle for sharing. In this situation, you cannot use the method because it will fail. Similarly, if you created the resource as shared and did not specify that it uses NT handles, you cannot use CreateSharedHandle to get a handle for sharing because CreateSharedHandle will fail.You can pass the handle that CreateSharedHandle returns in a call to the or method to give a device access to a shared resource that you created on a different device.CreateSharedHandle only returns the NT handle when you created the resource as shared (that is, you set the and flags).Because the handle that CreateSharedHandle returns is an NT handle, you can use the handle with CloseHandle, DuplicateHandle, and so on. You can call CreateSharedHandle only once for a shared resource; later calls fail. If you need more handles to the same shared resource, call DuplicateHandle. When you no longer need the shared resource handle, call CloseHandle to close the handle, in order to avoid memory leaks.The creator of a shared resource must not destroy the resource until all entities that opened the resource have destroyed the resource. The validity of the handle is tied to the lifetime of the underlying video memory. If no resource objects exist on any devices that refer to this resource, the handle is no longer valid. To extend the lifetime of the handle and video memory, you must open the shared resource on a device. HRESULT IDXGIResource1::CreateSharedHandle([In, Optional] const SECURITY_ATTRIBUTES* pAttributes,[In] unsigned int dwAccess,[In, Optional] const wchar_t* lpName,[Out] void** pHandle)

The interface implements methods for image-data objects.

IDXGISurface

Initializes a new instance of the class.

The native pointer.

Get a description of the surface.

A reference to the surface description (see ). Returns if successful; otherwise, returns one of the error codes that are described in the DXGI_ERROR topic. HRESULT IDXGISurface::GetDesc([Out] DXGI_SURFACE_DESC* pDesc)

Get a reference to the data contained in the surface, and deny GPU access to the surface.

A reference to the surface data (see ). CPU read-write flags. These flags can be combined with a logical OR. - Allow CPU read access. - Allow CPU write access. - Discard the previous contents of a resource when it is mapped. Returns if successful; otherwise, returns one of the error codes that are described in the DXGI_ERROR topic. Use to access a surface from the CPU. To release a mapped surface (and allow GPU access) call . HRESULT IDXGISurface::Map([Out] DXGI_MAPPED_RECT* pLockedRect,[In] unsigned int MapFlags)

Invalidate the reference to the surface retrieved by and re-enable GPU access to the resource.

Returns if successful; otherwise, returns one of the error codes that are described in the DXGI_ERROR topic. HRESULT IDXGISurface::Unmap()

Acquires access to the surface data.

Flags specifying CPU access permissions. A for accessing the mapped data, or null on failure..

Acquires access to the surface data.

Flags specifying CPU access permissions. A for accessing the mapped data, or null on failure..

Gets a swap chain back buffer.

The swap chain to get the buffer from. The index of the desired buffer. The buffer interface, or null on failure.

Get a description of the surface.

GetDesc HRESULT IDXGISurface::GetDesc([Out] DXGI_SURFACE_DESC* pDesc)

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

IDXGISurface1

Initializes a new instance of the class.

The native pointer.

Returns a device context (DC) that allows you to render to a Microsoft DirectX Graphics Infrastructure (DXGI) surface using Windows Graphics Device Interface (GDI).

A Boolean value that specifies whether to preserve Direct3D contents in the GDI DC. TRUE directs the runtime not to preserve Direct3D contents in the GDI DC; that is, the runtime discards the Direct3D contents. guarantees that Direct3D contents are available in the GDI DC. A reference to an handle that represents the current device context for GDI rendering. This method is not supported by DXGI 1.0, which shipped in Windows?Vista and Windows Server?2008. DXGI 1.1 support is required, which is available on Windows?7, Windows Server?2008?R2, and as an update to Windows?Vista with Service Pack?2 (SP2) (KB 971644) and Windows Server?2008 (KB 971512).After you use the GetDC method to retrieve a DC, you can render to the DXGI surface by using GDI. The GetDC method readies the surface for GDI rendering and allows inter-operation between DXGI and GDI technologies.Keep the following in mind when using this method:You must create the surface by using the flag for a surface or by using the flag for swap chains, otherwise this method fails. You must release the device and call the method before you issue any new Direct3D commands. This method fails if an outstanding DC has already been created by this method. The format for the surface or swap chain must be or . On GetDC, the render target in the output merger of the Direct3D pipeline is unbound from the surface. You must call the method on the device prior to Direct3D rendering after GDI rendering. Prior to resizing buffers you must release all outstanding DCs.You can also call GetDC on the back buffer at index 0 of a swap chain by obtaining an from the swap chain. The following code illustrates the process.

	
             * g_pSwapChain = null;	
            * g_pSurface1 = null;	
            ...	
            //Setup the device and and swapchain	
            g_pSwapChain->GetBuffer(0, __uuidof(), (void**) &g_pSurface1);	
            g_pSurface1->GetDC( , &g_hDC );	
            ...      	
            //Draw on the DC using GDI	
            ...	
            //When finish drawing release the DC	
            g_pSurface1->ReleaseDC( null );

HRESULT IDXGISurface1::GetDC([In] BOOL Discard,[Out] HDC* phdc)

Releases the GDI device context (DC) that is associated with the current surface and allows you to use Direct3D to render.

A reference to a structure that identifies the dirty region of the surface. A dirty region is any part of the surface that you used for GDI rendering and that you want to preserve. This area is used as a performance hint to graphics subsystem in certain scenarios. Do not use this parameter to restrict rendering to the specified rectangular region. If you pass in null, ReleaseDC considers the whole surface as dirty. Otherwise, ReleaseDC uses the area specified by the as a performance hint to indicate what areas have been manipulated by GDI rendering. You can pass a reference to an empty structure (a rectangle with no position or area) if you didn't change any content. If this method succeeds, it returns . Otherwise, it returns an error code. This method is not supported by DXGI 1.0, which shipped in Windows?Vista and Windows Server?2008. DXGI 1.1 support is required, which is available on Windows?7, Windows Server?2008?R2, and as an update to Windows?Vista with Service Pack?2 (SP2) (KB 971644) and Windows Server?2008 (KB 971512).Use the ReleaseDC method to release the DC and indicate that your application finished all GDI rendering to this surface. You must call the ReleaseDC method before you can use Direct3D to perform additional rendering.Prior to resizing buffers you must release all outstanding DCs. HRESULT IDXGISurface1::ReleaseDC([In, Optional] RECT* pDirtyRect)

Releases the GDI device context (DC) associated with the current surface and allows rendering using Direct3D. The whole surface to be considered dirty.

Releases the GDI device context (DC) associated with the current surface and allows rendering using Direct3D.

Use the ReleaseDC method to release the DC and indicate that your application has finished all GDI rendering to this surface. You must call the ReleaseDC method before you perform addition rendering using Direct3D. Prior to resizing buffers all outstanding DCs must be released. A reference to a structure that identifies the dirty region of the surface. A dirty region is any part of the surface that you have used for GDI rendering and that you want to preserve. This is used as a performance hint to graphics subsystem in certain scenarios. Do not use this parameter to restrict rendering to the specified rectangular region. The area specified by the will be used as a performance hint to indicate what areas have been manipulated by GDI rendering. If the method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. HRESULT IDXGISurface1::ReleaseDC([In, Optional] RECT* pDirtyRect)

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

IDXGISurface2

Initializes a new instance of the class.

The native pointer.

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

The globally unique identifier () of the requested interface type. A reference to a buffer that receives a reference to the parent resource object for the subresource surface. A reference to a variable that receives the index of the subresource surface. Returns if successful; otherwise, returns one of the following values:E_NOINTERFACE if the object does not implement the that the riid parameter specifies. Possibly other error codes that are described in the DXGI_ERROR topic. For subresource surface objects that the method creates, GetResource simply returns the values that were used to create the subresource surface.Current objects that implement are either resources or views. GetResource for these objects returns ?this? or the resource that supports the view respectively. In this situation, the subresource index is 0. HRESULT IDXGISurface2::GetResource([In] const GUID& riid,[Out] void** ppParentResource,[Out] unsigned int* pSubresourceIndex)

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

IDXGISwapChain

Initializes a new instance of the class.

The native pointer.

[Starting with Direct3D 11.1, we recommend not to use Present anymore to present a rendered image. Instead, use .]

No documentation. No documentation. Possible return values include: , or (see DXGI_ERROR), (see ), or D3DDDIERR_DEVICEREMOVED.Note??The Present method can return either or D3DDDIERR_DEVICEREMOVED if a video card has been physically removed from the computer, or a driver upgrade for the video card has occurred. For the best performance when flipping swap-chain buffers in a full-screen application, see Full-Screen Application Performance Hints.Because calling Present might cause the render thread to wait on the message-pump thread, be careful when calling this method in an application that uses multiple threads. For more details, see Multithreading Considerations.Differences between Direct3D 9 and Direct3D 10: Specifying in the Flags parameter is analogous to IDirect3DDevice9::TestCooperativeLevel in Direct3D 9.?For flip presentation model swap chains that you create with the value set, a successful presentation unbinds back buffer 0 from the graphics pipeline, except for when you pass the flag in the Flags parameter.Flip presentation model queueSuppose the following frames with sync-interval values are queued from oldest (A) to newest (E) before you call Present.A: 3, B: 0, C: 0, D: 1, E: 0When you call Present, the runtime shows frame A for 3 vertical blank intervals, then frame D for 1 vertical blank interval, and then frame E until you submit a new presentation. The runtime discards frames C and D. HRESULT IDXGISwapChain::Present([In] unsigned int SyncInterval,[In] DXGI_PRESENT_FLAGS Flags)

Accesses one of the swap-chain's back buffers.

A zero-based buffer index. If the swap chain's swap effect is , this method can only access the first buffer; for this situation, set the index to zero. If the swap chain's swap effect is either or , this method can only access read-only buffers with indexes greater than zero. Read-only back buffers have the BufferUsage member of the or structure set to . The type of interface used to manipulate the buffer. See remarks. A reference to a back-buffer interface. Returns one of the following DXGI_ERROR. HRESULT IDXGISwapChain::GetBuffer([In] unsigned int Buffer,[In] const GUID& riid,[Out] void** ppSurface)

Sets the display state to windowed or full screen.

A Boolean value that specifies whether to set the display state to windowed or full screen. TRUE for full screen, and for windowed. If you pass TRUE to the Fullscreen parameter to set the display state to full screen, you can optionally set this parameter to a reference to an interface for the output target that contains the swap chain. If you set this parameter to null, DXGI will choose the output based on the swap-chain's device and the output window's placement. If you pass to Fullscreen, you must set this parameter to null. This methods returns: if the action succeeded and the swap chain was placed in the requested state. if the action failed. There are many reasons why a windowed-mode swap chain cannot switch to full-screen mode. For instance: The application is running over Terminal Server. The output window is occluded. The output window does not have keyboard focus. Another application is already in full-screen mode. When this error is returned, an application can continue to run in windowed mode and try to switch to full-screen mode later. is returned if a fullscreen/windowed mode transition is occurring when this API is called. Other error codes if you run out of memory or encounter another unexpected fault; these codes may be treated as hard, non-continuable errors. DXGI may change the display state of a swap chain in response to end user or system requests.We recommend that you create a windowed swap chain and allow the end user to change the swap chain to full screen through SetFullscreenState; that is, do not set the Windowed member of to to force the swap chain to be full screen. However, if you create the swap chain as full screen, also provide the end user with a list of supported display modes because a swap chain that is created with an unsupported display mode might cause the display to go black and prevent the end user from seeing anything. Also, we recommend that you have a time-out confirmation screen or other fallback mechanism when you allow the end user to change display modes.Notes for Metro style appsIf a Metro style app calls SetFullscreenState to set the display state to full screen, SetFullscreenState fails with .You cannot call SetFullscreenState on a windowless swap chain that you created with .For the flip presentation model, after you transition the display state to full screen, you must call ResizeBuffers to ensure that your call to succeeds. HRESULT IDXGISwapChain::SetFullscreenState([In] BOOL Fullscreen,[In, Optional] IDXGIOutput* pTarget)

Get the state associated with full-screen mode.

A reference to a boolean whose value is either: TRUE if the swap chain is in full-screen mode if the swap chain is in windowed mode A reference to the output target (see ) when the mode is full screen; otherwise null. Returns one of the following DXGI_ERROR. When the swap chain is in full-screen mode, a reference to the target output will be returned and its reference count will be incremented. HRESULT IDXGISwapChain::GetFullscreenState([Out, Optional] BOOL* pFullscreen,[Out, Optional] IDXGIOutput** ppTarget)

[Starting with Direct3D 11.1, we recommend not to use GetDesc anymore to get a description of the swap chain. Instead, use .]

No documentation. Returns one of the following DXGI_ERROR. HRESULT IDXGISwapChain::GetDesc([Out] DXGI_SWAP_CHAIN_DESC* pDesc)

Changes the swap chain's back buffer size, format, and number of buffers. This should be called when the application window is resized.

The number of buffers in the swap chain (including all back and front buffers). This number can be different from the number of buffers with which you created the swap chain. This number can't be greater than DXGI_MAX_SWAP_CHAIN_BUFFERS. Set this number to zero to preserve the existing number of buffers in the swap chain. You can't specify greater than two buffers for the flip presentation model. New width of the back buffer. If you specify zero, DXGI will use the width of the client area of the target window. You can't specify the width as zero if you called the method to create the swap chain for a composition surface. New height of the back buffer. If you specify zero, DXGI will use the height of the client area of the target window. You can't specify the height as zero if you called the method to create the swap chain for a composition surface. A -typed value for the new format of the back buffer. Set this value to to preserve the existing format of the back buffer. The flip presentation model supports a more restricted set of formats than the bit-block transfer (bitblt) model. A combination of -typed values that are combined by using a bitwise OR operation. The resulting value specifies options for swap-chain behavior. Returns if successful; an error code otherwise. For a list of error codes, see DXGI_ERROR. You can't resize a swap chain unless you release all outstanding references to its back buffers. You must release all of its direct and indirect references on the back buffers in order for ResizeBuffers to succeed.Direct references are held by the application after it calls AddRef on a resource.Indirect references are held by views to a resource, binding a view of the resource to a device context, a command list that used the resource, a command list that used a view to that resource, a command list that executed another command list that used the resource, and so on.Before you call ResizeBuffers, ensure that the application releases all references (by calling the appropriate number of Release invocations) on the resources, any views to the resource, and any command lists that use either the resources or views, and ensure that neither the resource nor a view is still bound to a device context. You can use to ensure that all references are released. If a view is bound to a deferred context, you must discard the partially built command list as well (by calling ClearState, , then Release on the command list). After you call ResizeBuffers, you can re-query interfaces via .For swap chains that you created with , before you call ResizeBuffers, also call on the swap chain's back-buffer surface to ensure that you have no outstanding GDI device contexts (DCs) open.We recommend that you call ResizeBuffers when a client window is resized (that is, when an application receives a WM_SIZE message).The only difference between ResizeBuffers in Windows Developer Preview and ResizeBuffers in Windows?7 is with flip presentation model swap chains that you create with the value set. In Windows Developer Preview, you must call ResizeBuffers to realize a transition between full-screen mode and windowed mode; otherwise, your next call to the Present method fails. HRESULT IDXGISwapChain::ResizeBuffers([In] unsigned int BufferCount,[In] unsigned int Width,[In] unsigned int Height,[In] DXGI_FORMAT NewFormat,[In] unsigned int SwapChainFlags)

Resizes the output target.

A reference to a structure that describes the mode, which specifies the new width, height, format, and refresh rate of the target. If the format is , ResizeTarget uses the existing format. We only recommend that you use when the swap chain is in full-screen mode as this method is not thread safe. Returns a code that indicates success or failure. is returned if a fullscreen/windowed mode transition is occurring when this API is called. See DXGI_ERROR for additional DXGI error codes. ResizeTarget resizes the target window when the swap chain is in windowed mode, and changes the display mode on the target output when the swap chain is in full-screen mode. Therefore, applications can call ResizeTarget to resize the target window (rather than a Microsoft Win32API such as SetWindowPos) without knowledge of the swap chain display mode.If a Metro style app calls ResizeTarget, it fails with .You cannot call ResizeTarget on a windowless swap chain that you created with . HRESULT IDXGISwapChain::ResizeTarget([In] const DXGI_MODE_DESC* pNewTargetParameters)

Get the output (the display monitor) that contains the majority of the client area of the target window.

A reference to the output interface (see ). Returns one of the following DXGI_ERROR. If the method succeeds, the output interface will be filled and its reference count incremented. When you are finished with it, be sure to release the interface to avoid a memory leak.The output is also owned by the adapter on which the swap chain's device was created.You cannot call GetContainingOutput on a windowless swap chain that you created with . HRESULT IDXGISwapChain::GetContainingOutput([Out] IDXGIOutput** ppOutput)

Gets performance statistics about the last render frame.

A reference to a structure for the frame statistics. Returns one of the DXGI_ERROR values. You cannot use GetFrameStatistics for swap chains that both use the bit-block transfer (bitblt) presentation model and draw in windowed mode.You can only use GetFrameStatistics for swap chains that either use the flip presentation model or draw in full-screen mode. You set the value in the SwapEffect member of the structure to specify that the swap chain uses the flip presentation model. HRESULT IDXGISwapChain::GetFrameStatistics([Out] DXGI_FRAME_STATISTICS* pStats)

Gets the number of times that or has been called.

No documentation. Returns one of the DXGI_ERROR values. For info about presentation statistics for a frame, see . HRESULT IDXGISwapChain::GetLastPresentCount([Out] unsigned int* pLastPresentCount)

Creates a swap chain.

If you attempt to create a swap chain in full-screen mode, and full-screen mode is unavailable, the swap chain will be created in windowed mode and DXGI_STATUS_OCCLUDED will be returned. If the buffer width or the buffer height are zero, the sizes will be inferred from the output window size in the swap-chain description. Since the target output cannot be chosen explicitly when the swap-chain is created, you should not create a full-screen swap chain. This can reduce presentation performance if the swap chain size and the output window size do not match. Here are two ways to ensure the sizes match: Create a windowed swap chain and then set it full-screen using . Save a reference to the swap-chain immediately after creation, and use it to get the output window size during a WM_SIZE event. Then resize the swap chain buffers (with ) during the transition from windowed to full-screen. If the swap chain is in full-screen mode, before you release it, you must use {{SetFullscreenState}} to switch it to windowed mode. For more information about releasing a swap chain, see the Destroying a Swap Chain section of {{DXGI Overview}}. a reference to a . A reference to the device that will write 2D images to the swap chain. A reference to the swap-chain description (see ). HRESULT IDXGIFactory::CreateSwapChain([In] IUnknown* pDevice,[In] DXGI_SWAP_CHAIN_DESC* pDesc,[Out] IDXGISwapChain** ppSwapChain)

Access one of the swap-chain back buffers.

The interface of the surface to resolve from the back buffer A zero-based buffer index. If the swap effect is not DXGI_SWAP_EFFECT_SEQUENTIAL, this method only has access to the first buffer; for this case, set the index to zero. Returns a reference to a back-buffer interface. HRESULT IDXGISwapChain::GetBuffer([None] int Buffer,[In] GUID* riid,[Out] void** ppSurface)

[Starting with Direct3D 11.1, we recommend not to use GetDesc anymore to get a description of the swap chain. Instead, use .]

GetDesc HRESULT IDXGISwapChain::GetDesc([Out] DXGI_SWAP_CHAIN_DESC* pDesc)

Get the output (the display monitor) that contains the majority of the client area of the target window.

If the method succeeds, the output interface will be filled and its reference count incremented. When you are finished with it, be sure to release the interface to avoid a memory leak.The output is also owned by the adapter on which the swap chain's device was created.You cannot call GetContainingOutput on a windowless swap chain that you created with . GetContainingOutput HRESULT IDXGISwapChain::GetContainingOutput([Out] IDXGIOutput** ppOutput)

Gets performance statistics about the last render frame.

You cannot use GetFrameStatistics for swap chains that both use the bit-block transfer (bitblt) presentation model and draw in windowed mode.You can only use GetFrameStatistics for swap chains that either use the flip presentation model or draw in full-screen mode. You set the value in the SwapEffect member of the structure to specify that the swap chain uses the flip presentation model. GetFrameStatistics HRESULT IDXGISwapChain::GetFrameStatistics([Out] DXGI_FRAME_STATISTICS* pStats)

Gets the number of times that or has been called.

For info about presentation statistics for a frame, see . GetLastPresentCount HRESULT IDXGISwapChain::GetLastPresentCount([Out] unsigned int* pLastPresentCount)

Gets or sets a value indicating whether the swapchain is in fullscreen.

true if this swapchain is in fullscreen; otherwise, false.

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

IDXGISwapChain1

Initializes a new instance of the class.

The native pointer.

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

A reference to a structure that describes the swap chain. Returns if successful; an error code otherwise. For a list of error codes, see DXGI_ERROR. HRESULT IDXGISwapChain1::GetDesc1([Out] DXGI_SWAP_CHAIN_DESC1* pDesc)

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

A reference to a structure that describes the full-screen swap chain. GetFullscreenDesc returns: if it successfully retrieved the description of the full-screen swap chain. for non- swap chains or if pDesc is null. Possibly other error codes that are described in the DXGI_ERROR topic. The semantics of GetFullscreenDesc are identical to that of the IDXGISwapchain::GetDesc method for -based swap chains. HRESULT IDXGISwapChain1::GetFullscreenDesc([Out] DXGI_SWAP_CHAIN_FULLSCREEN_DESC* pDesc)

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

No documentation. Returns if successful; an error code otherwise. For a list of error codes, see DXGI_ERROR.If pHwnd receives null (that is, the swap chain is not -based), GetHwnd returns . Applications call the method to create a swap chain that is associated with an . HRESULT IDXGISwapChain1::GetHwnd([Out] HWND* pHwnd)

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

A reference to the globally unique identifier () of the IWindow object that is referenced by the ppUnk parameter. A reference to a variable that receives a reference to the IWindow object. GetImmersiveWindow returns: if it successfully retrieved the underlying IWindow object. if ppUnk is null; that is, the swap chain is not associated with a IWindow object. Any that a call to QueryInterface to query for an IWindow object might typically return. Possibly other error codes that are described in the DXGI_ERROR topic. Applications call the method to create a swap chain that is associated with an IWindow object. HRESULT IDXGISwapChain1::GetImmersiveWindow([In] const GUID& refiid,[Out] void** ppUnk)

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

A reference to a variable that receives the handle to the composition windowless surface that is associated with this swap chain. If the swap chain is not for a composition windowless surface, GetCompositionSurface returns null. GetCompositionSurface returns: if it successfully retrieved the underlying composition surface handle. if pSurface is null; that is, the swap chain is not associated with a composition surface handle. GetCompositionSurface also returns this value if the swap chain is not a windowless swap chain. E_OUTOFMEMORY if insufficient memory is available to complete the operation. Because GetCompositionSurface creates a duplicate handle, it might run out of memory and return E_OUTOFMEMORY. Possibly other error codes that are described in the DXGI_ERROR topic. Applications call the method to create a windowless swap chain.The handle that GetCompositionSurface returns is not necessarily the same as the handle that you passed to the method.The handle that GetCompositionSurface returns has the same access attributes as the handle that DXGI owns.Note??After the calling application is finished with the pSurface handle, it must call CloseHandle to close the handle. HRESULT IDXGISwapChain1::GetCompositionSurface([Out] void** pSurface)

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

An integer that specifies how to synchronize presentation of a frame with the vertical blank. For the bit-block transfer (bitblt) model, values are: 0 - The presentation occurs immediately, there is no synchronization. 1,2,3,4 - Synchronize presentation after the nth vertical blank. For the flip model, values are: 0 - Discard this frame if you submitted a more recent presentation. n > 0 - Synchronize presentation for at least n vertical blanks. For an example that shows how sync-interval values affect a flip presentation queue, see Remarks. If the update region straddles more than one output (each represented by ), Present1 performs the synchronization to the output that contains the largest subrectangle of the target window's client area. An integer value that contains swap-chain presentation options. These options are defined by the DXGI_PRESENT constants. A reference to a structure that describes updated rectangles and scroll information of the frame to present. Possible return values include: , , , , or E_OUTOFMEMORY. An application can use Present1 to optimize presentation by specifying scroll and dirty rectangles. When the runtime has information about these rectangles, the runtime can then perform necessary bitblts during presentation more efficiently and pass this metadata to the Desktop Window Manager (DWM). The DWM can then use the metadata to optimize presentation and pass the metadata to indirect displays and terminal servers to optimize traffic over the wire. An application must confine its modifications to only the dirty regions that it passes to Present1, as well as modify the entire dirty region to avoid undefined resource contents from being exposed.For flip presentation model swap chains that you create with the value set, a successful presentation results in an unbind of back buffer 0 from the graphics pipeline, except for when you pass the flag in the Flags parameter.Flip presentation model queueSuppose the following frames with sync-interval values are queued from oldest (A) to newest (E) before you call Present1.A: 3, B: 0, C: 0, D: 1, E: 0When you call Present1, the runtime shows frame A for 3 vertical blank intervals, then frame D for 1 vertical blank interval, and then frame E until you submit a new presentation. The runtime discards frames C and D. HRESULT IDXGISwapChain1::Present1([In] unsigned int SyncInterval,[In] unsigned int PresentFlags,[In] const DXGI_PRESENT_PARAMETERS* pPresentParameters)

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

Indicates whether to use the swap chain in temporary mono mode. TRUE indicates that you can use temporary-mono mode; otherwise, . Temporary mono is a feature where a stereo swap chain can be presented using only the content in the left buffer. To present using the left buffer as a mono buffer, an application calls the method with the flag. All windowed swap chains support temporary mono. However, full-screen swap chains optionally support temporary mono because not all hardware supports temporary mono on full-screen swap chains efficiently. BOOL IDXGISwapChain1::IsTemporaryMonoSupported()

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

A reference to a buffer that receives a reference to the interface for the restrict-to output. An application passes this reference to in a call to the , , or method to create the swap chain. Returns if the restrict-to output was successfully retrieved; otherwise, returns E_INVALIDARG if the reference is invalid. If the method succeeds, the runtime fills the buffer at ppRestrictToOutput with a reference to the restrict-to output interface. This restrict-to output interface has its reference count incremented. When you are finished with it, be sure to release the interface to avoid a memory leak.The output is also owned by the adapter on which the swap chain's device was created. HRESULT IDXGISwapChain1::GetRestrictToOutput([Out] IDXGIOutput** ppRestrictToOutput)

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

A reference to a DXGI_RGBA structure that specifies the background color to set. SetBackgroundColor returns: if it successfully set the background color. E_INVALIDARG if the pColor parameter is incorrect, for example, pColor is null or any of the floating-point values of the members of DXGI_RGBA to which pColor points are outside the range from 0.0 through 1.0. Possibly other error codes that are described in the DXGI_ERROR topic. The background color affects only swap chains that you create with in windowed mode. You pass this value in a call to , , or . Typically, the background color is not visible unless the swap-chain contents are smaller than the destination window.When you set the background color, it is not immediately realized. It takes effect in conjunction with your next call to the method. The DXGI_PRESENT flags that you pass to can help achieve the effect that you require. For example, if you call SetBackgroundColor and then call with the Flags parameter set to , you change only the background color without changing the displayed contents of the swap chain.When you call the method to display contents of the swap chain, uses the value that is specified in the AlphaMode member of the structure to determine how to handle the a member of the DXGI_RGBA structure, the alpha value of the background color, that achieves window transparency. For example, if AlphaMode is , ignores the a member of DXGI_RGBA. HRESULT IDXGISwapChain1::SetBackgroundColor([In] const D3DCOLORVALUE* pColor)

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

A reference to a DXGI_RGBA structure that receives the background color of the swap chain. GetBackgroundColor returns: if it successfully retrieves the background color. if the pColor parameter is invalid, for example, pColor is null. Possibly other error codes that are described in the DXGI_ERROR topic. Note??The background color that GetBackgroundColor retrieves does not indicate what the screen currently displays. The background color indicates what the screen will display with your next call to the method. The default value of the background color is black with full opacity: 0,0,0,1. HRESULT IDXGISwapChain1::GetBackgroundColor([Out] D3DCOLORVALUE* pColor)

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

A -typed value that specifies how to set the rotation of the back buffers for the swap chain. SetRotation returns: if it successfully set the rotation. if the swap chain is bit-block transfer (bitblt) model. The swap chain must be flip model to successfully call SetRotation. Possibly other error codes that are described in the DXGI_ERROR topic. You can only use SetRotation to rotate the back buffers for flip-model swap chains that you present in windowed mode.SetRotation isn't supported for rotating the back buffers for flip-model swap chains that you present in full-screen mode. In this situation, SetRotation doesn't fail, but you must ensure that you specify no rotation () for the swap chain. Otherwise, when you call or to present a frame, the presentation fails. HRESULT IDXGISwapChain1::SetRotation([In] DXGI_MODE_ROTATION Rotation)

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

A reference to a variable that receives a -typed value that specifies the rotation of the back buffers for the swap chain. Returns if successful; an error code otherwise. For a list of error codes, see DXGI_ERROR. HRESULT IDXGISwapChain1::GetRotation([Out] DXGI_MODE_ROTATION* pRotation)

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

GetDesc1 HRESULT IDXGISwapChain1::GetDesc1([Out] DXGI_SWAP_CHAIN_DESC1* pDesc)

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

The semantics of GetFullscreenDesc are identical to that of the IDXGISwapchain::GetDesc method for -based swap chains. GetFullscreenDesc HRESULT IDXGISwapChain1::GetFullscreenDesc([Out] DXGI_SWAP_CHAIN_FULLSCREEN_DESC* pDesc)

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

Applications call the method to create a swap chain that is associated with an . GetHwnd HRESULT IDXGISwapChain1::GetHwnd([Out] HWND* pHwnd)

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

Applications call the method to create a windowless swap chain.The handle that GetCompositionSurface returns is not necessarily the same as the handle that you passed to the method.The handle that GetCompositionSurface returns has the same access attributes as the handle that DXGI owns.Note??After the calling application is finished with the pSurface handle, it must call CloseHandle to close the handle. GetCompositionSurface HRESULT IDXGISwapChain1::GetCompositionSurface([Out] void** pSurface)

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

Temporary mono is a feature where a stereo swap chain can be presented using only the content in the left buffer. To present using the left buffer as a mono buffer, an application calls the method with the flag. All windowed swap chains support temporary mono. However, full-screen swap chains optionally support temporary mono because not all hardware supports temporary mono on full-screen swap chains efficiently. IsTemporaryMonoSupported BOOL IDXGISwapChain1::IsTemporaryMonoSupported()

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

If the method succeeds, the runtime fills the buffer at ppRestrictToOutput with a reference to the restrict-to output interface. This restrict-to output interface has its reference count incremented. When you are finished with it, be sure to release the interface to avoid a memory leak.The output is also owned by the adapter on which the swap chain's device was created. GetRestrictToOutput HRESULT IDXGISwapChain1::GetRestrictToOutput([Out] IDXGIOutput** ppRestrictToOutput)

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

Note??The background color that GetBackgroundColor retrieves does not indicate what the screen currently displays. The background color indicates what the screen will display with your next call to the method. The default value of the background color is black with full opacity: 0,0,0,1. GetBackgroundColor HRESULT IDXGISwapChain1::GetBackgroundColor([Out] D3DCOLORVALUE* pColor)

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

GetRotation HRESULT IDXGISwapChain1::GetRotation([Out] DXGI_MODE_ROTATION* pRotation)

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

The structure provides a DXGI 1.2 description of an adapter. This structure is initialized by using the method. DXGI_ADAPTER_DESC2

A string that contains the adapter description.

wchar_t Description[128]

The PCI ID of the hardware vendor.

unsigned int VendorId

The PCI ID of the hardware device.

unsigned int DeviceId

The PCI ID of the sub system.

unsigned int SubSysId

The PCI ID of the revision number of the adapter.

unsigned int Revision

The number of bytes of dedicated video memory that are not shared with the CPU.

SIZE_T DedicatedVideoMemory

The number of bytes of dedicated system memory that are not shared with the CPU. This memory is allocated from available system memory at boot time.

SIZE_T DedicatedSystemMemory

The number of bytes of shared system memory. This is the maximum value of system memory that may be consumed by the adapter during operation. Any incidental memory consumed by the driver as it manages and uses video memory is additional.

SIZE_T SharedSystemMemory

A unique value that identifies the adapter. See for a definition of the structure. is defined in dxgi.h.

LUID AdapterLuid

A value of the enumerated type that describes the adapter type. The flag is reserved.

unsigned int Flags

A value of the enumerated type that describes the granularity level at which the GPU can be preempted from performing its current graphics rendering task.

DXGI_GRAPHICS_PREEMPTION_GRANULARITY GraphicsPreemptionGranularity

A value of the enumerated type that describes the granularity level at which the GPU can be preempted from performing its current compute task.

DXGI_COMPUTE_PREEMPTION_GRANULARITY ComputePreemptionGranularity

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

The structure provides a description of an adapter. This structure is initialized by using the method. DXGI_ADAPTER_DESC

A string that contains the adapter description.

wchar_t Description[128]

The PCI ID of the hardware vendor.

unsigned int VendorId

The PCI ID of the hardware device.

unsigned int DeviceId

The PCI ID of the sub system.

unsigned int SubSysId

The PCI ID of the revision number of the adapter.

unsigned int Revision

The number of bytes of dedicated video memory that are not shared with the CPU.

SIZE_T DedicatedVideoMemory

The number of bytes of dedicated system memory that are not shared with the CPU. This memory is allocated from available system memory at boot time.

SIZE_T DedicatedSystemMemory

SIZE_T SharedSystemMemory

A unique value that identifies the adapter. See for a definition of the structure. is defined in dxgi.h.

LUID AdapterLuid

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

The structure provides a DXGI 1.1 description of an adapter. This structure is initialized by using the method. DXGI_ADAPTER_DESC1

A string that contains the adapter description.

wchar_t Description[128]

The PCI ID of the hardware vendor.

unsigned int VendorId

The PCI ID of the hardware device.

unsigned int DeviceId

The PCI ID of the sub system.

unsigned int SubSysId

The PCI ID of the revision number of the adapter.

unsigned int Revision

The number of bytes of dedicated video memory that are not shared with the CPU.

SIZE_T DedicatedVideoMemory

The number of bytes of dedicated system memory that are not shared with the CPU. This memory is allocated from available system memory at boot time.

SIZE_T DedicatedSystemMemory

SIZE_T SharedSystemMemory

A unique value that identifies the adapter. See for a definition of the structure. is defined in dxgi.h.

LUID AdapterLuid

A value of the enumerated type that describes the adapter type. The flag is reserved.

DXGI_ADAPTER_FLAG Flags

Describes timing and presentation statistics for a frame.

You initialize the structure with the or method.You can only use for swap chains that either use the flip presentation model or draw in full-screen mode. You set the value in the SwapEffect member of the structure to specify that the swap chain uses the flip presentation model.The values in the PresentCount and PresentRefreshCount members indicate information about when a frame was presented on the display screen. You can use these values to determine whether a glitch occurred. The values in the SyncRefreshCount and SyncQPCTime members indicate timing information that you can use for audio and video synchronization or very precise animation. If the swap chain draws in full-screen mode, these values are based on when the computer booted. If the swap chain draws in windowed mode, these values are based on when the swap chain is created. DXGI_FRAME_STATISTICS

A value that represents the running total count of times that an image was presented to the monitor since the computer booted. Note??The number of times that an image was presented to the monitor is not necessarily the same as the number of times that you called or .

unsigned int PresentCount

A value that represents the running total count of v-blanks at which the last image was presented to the monitor and that have happened since the computer booted (for windowed mode, since the swap chain was created).

unsigned int PresentRefreshCount

A value that represents the running total count of v-blanks when the scheduler last sampled the machine time by calling QueryPerformanceCounter and that have happened since the computer booted (for windowed mode, since the swap chain was created).

unsigned int SyncRefreshCount

A value that represents the high-resolution performance counter timer. This value is the same as the value returned by the QueryPerformanceCounter function.

LARGE_INTEGER SyncQPCTime

Reserved. Always returns 0.

LARGE_INTEGER SyncGPUTime

Controls the settings of a gamma curve.

The structure is used by the method. DXGI_GAMMA_CONTROL

A structure with scalar values that are applied to rgb values before being sent to the gamma look up table.

DXGI_RGB Scale

A structure with offset values that are applied to the rgb values before being sent to the gamma look up table.

DXGI_RGB Offset

An array of structures that control the points of a gamma curve.

DXGI_RGB GammaCurve[1025]

Controls the gamma capabilities of an adapter.

To get a list of the capabilities for controlling gamma correction, call . DXGI_GAMMA_CONTROL_CAPABILITIES

A value describing the maximum range of the control-point positions.

float MaxConvertedValue

A value describing the minimum range of the control-point positions.

float MinConvertedValue

A value describing the number of control points in the array.

unsigned int NumGammaControlPoints

True if scaling and offset operations are supported during gamma correction; otherwise, false.

BOOL ScaleAndOffsetSupported

An array of values describing control points; the maximum length of control points is 1025.

float ControlPointPositions[1025]

Describes a mapped rectangle that is used to access a surface.

The structure is initialized by the method. DXGI_MAPPED_RECT

A value that describes the width, in bytes, of the surface.

int Pitch

A reference to the image buffer of the surface.

unsigned char* pBits

Describes a display mode.

The following format values are valid for display modes and when you create a bit-block transfer (bitblt) model swap chain. The valid values depend on the feature level that you are working with.Feature level >= 9.1 (except 10.x on Windows?Vista) (except 10.x on Windows?Vista) Feature level >= 10.0 Feature level >= 11.0 You can pass one of these format values to to determine if it is a valid format for displaying on screen. If returns in the bit field to which the pFormatSupport parameter points, the format is valid for displaying on screen.Starting with Windows Developer Preview for a flip model swap chain (that is, a swap chain that has the value set in the SwapEffect member of ), you must set the Format member of to , , or .Because of the relaxed render target creation rules that Direct3D 11 has for back buffers, applications can create a render target view from a swap chain so they can use automatic color space conversion when they render the swap chain. DXGI_MODE_DESC

A value that describes the resolution width. If you specify the width as zero when you call the method to create a swap chain, the runtime obtains the width from the output window and assigns this width value to the swap-chain description. You can subsequently call the method to retrieve the assigned width value.

unsigned int Width

A value describing the resolution height. If you specify the height as zero when you call the method to create a swap chain, the runtime obtains the height from the output window and assigns this height value to the swap-chain description. You can subsequently call the method to retrieve the assigned height value.

unsigned int Height

A structure describing the refresh rate in hertz

DXGI_RATIONAL RefreshRate

A structure describing the display format.

DXGI_FORMAT Format

A member of the enumerated type describing the scanline drawing mode.

DXGI_MODE_SCANLINE_ORDER ScanlineOrdering

A member of the enumerated type describing the scaling mode.

DXGI_MODE_SCALING Scaling

Initializes a new instance of the structure.

The width. The height. The refresh rate. The format.

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

DXGI_MODE_DESC1 is identical to except that includes the Stereo member. DXGI_MODE_DESC1

A value that describes the resolution width.

unsigned int Width

A value that describes the resolution height.

unsigned int Height

A structure that describes the refresh rate in hertz.

DXGI_RATIONAL RefreshRate

A -typed value that describes the display format.

DXGI_FORMAT Format

A -typed value that describes the scan-line drawing mode.

DXGI_MODE_SCANLINE_ORDER ScanlineOrdering

A -typed value that describes the scaling mode.

DXGI_MODE_SCALING Scaling

Specifies whether the full-screen display mode is stereo. TRUE if stereo; otherwise, .

BOOL Stereo

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

DXGI_OUTDUPL_DESC

No documentation.

DXGI_MODE_DESC ModeDesc

No documentation.

DXGI_MODE_ROTATION Rotation

No documentation.

BOOL DesktopImageInSystemMemeory

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

A non-zero LastMouseUpdateTime indicates an update to either a mouse reference position or a mouse reference position and shape. That is, the mouse reference position is always valid for a non-zero LastMouseUpdateTime; however, the application must check the value of the PointerShapeBufferSize member to determine whether the shape was updated too.If only the reference was updated (that is, the desktop image was not updated), the AccumulatedFrames, TotalMetadataBufferSize, and LastPresentTime members are set to zero.An AccumulatedFrames value of one indicates that the application completed processing the last frame before a new desktop image was presented. If the AccumulatedFrames value is greater than one, more desktop image updates have occurred while the application processed the last desktop update. In this situation, the operating system accumulated the update regions. For more information about desktop updates, see Desktop Update Data.A non-zero TotalMetadataBufferSize indicates the total size of the buffers that are required to store all the desktop update metadata. An application cannot determine the size of each type of metadata. The application must call the , , or method to obtain information about each type of metadata.Note??To correct visual effects, an application must process the move region data before it processes the dirty rectangles. DXGI_OUTDUPL_FRAME_INFO

The time stamp of the last update of the desktop image. The operating system calls the QueryPerformanceCounter function to obtain the value. A zero value indicates that the desktop image was not updated since an application last called the method to acquire the next frame of the desktop image.

LARGE_INTEGER LastPresentTime

The time stamp of the last update to the mouse. The operating system calls the QueryPerformanceCounter function to obtain the value. A zero value indicates that the position or shape of the mouse was not updated since an application last called the method to acquire the next frame of the desktop image. The mouse position is always supplied for a mouse update. A new reference shape is indicated by a non-zero value in the PointerShapeBufferSize member.

LARGE_INTEGER LastMouseUpdateTime

The number of frames that the operating system accumulated in the desktop image surface since the calling application processed the last desktop image. For more information about this number, see Remarks.

unsigned int AccumulatedFrames

A structure that describes the most recent mouse position if the LastMouseUpdateTime member is a non-zero value; otherwise, this value is ignored. This value provides the coordinates of the location where the top-left-hand corner of the reference shape is drawn; this value is not the desktop position of the hot spot.

DXGI_OUTDUPL_POINTER_POSITION PointerPosition

Size in bytes of the buffers to store all the desktop update metadata for this frame. For more information about this size, see Remarks.

unsigned int TotalMetadataBufferSize

Size in bytes of the buffer to hold the new pixel data for the mouse shape. For more information about this size, see Remarks.

unsigned int PointerShapeBufferSize

Specifies whether the operating system accumulated updates by coalescing dirty regions. Therefore, the dirty regions might contain unmodified pixels. TRUE if dirty regions were accumulated; otherwise, .

BOOL RectsCoalesced

Specifies whether the desktop image might contain protected content that was already blacked out in the desktop image. TRUE if protected content was already blacked; otherwise, . The application can use this information to notify the remote user that some of the desktop content might be protected and therefore not visible.

BOOL ProtectedContentMaskedOut

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

DXGI_OUTDUPL_MOVE_RECT

The starting position of a rectangle.

POINT SourcePoint

The target region to which to move a rectangle.

RECT DestinationRect

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

The Position member is valid only if the Visible member?s value is set to TRUE. DXGI_OUTDUPL_POINTER_POSITION

The position of the hardware cursor relative to the top-left of the adapter output.

POINT Position

Specifies whether the hardware cursor is visible. TRUE if visible; otherwise, . If the hardware cursor is not visible, the calling application does not display the cursor in the client.

BOOL Visible

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

An application draws the cursor shape with the top-left-hand corner drawn at the position that the Position member of the structure specifies; the application does not use the hot spot to draw the cursor shape.An application calls the method to retrieve cursor shape information in a structure. DXGI_OUTDUPL_POINTER_SHAPE_INFO

A -typed value that specifies the type of cursor shape.

unsigned int Type

The width in pixels of the mouse cursor.

unsigned int Width

The height in scan lines of the mouse cursor.

unsigned int Height

The width in bytes of the mouse cursor.

unsigned int Pitch

The position of the cursor's hot spot relative to its upper-left pixel. An application does not use the hot spot when it determines where to draw the cursor shape.

POINT HotSpot

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

The structure is initialized by the method. DXGI_OUTPUT_DESC

A string that contains the name of the output device.

wchar_t DeviceName[32]

A structure containing the bounds of the output in desktop coordinates.

RECT DesktopCoordinates

A member of the enumerated type describing on how an image is rotated by the output.

DXGI_MODE_ROTATION Rotation

An handle that represents the display monitor. For more information, see and the Device Context.

HMONITOR Monitor

True if the output is attached to the desktop; otherwise, false.

BOOL AttachedToDesktop

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

The scroll rectangle and the list of dirty rectangles could overlap. In this situation, the dirty rectangles take priority. Applications can then have pieces of dynamic content on top of a scrolled area. For example, an application could scroll a page and play video at the same time.The following diagram and coordinates illustrate this example.DirtyRectsCount = 2 pDirtyRects[ 0 ] = { 10, 30, 40, 50 } // Video pDirtyRects[ 1 ] = { 0, 70, 50, 80 } // New line *pScrollRect = { 0, 0, 50, 70 } *pScrollOffset = { 0, -10 }Parts of the previous frame and content that the application renders are combined to produce the final frame that the operating system presents on the display screen. Most of the window is scrolled from the previous frame. The application must update the video frame with the new chunk of content that appears due to scrolling.The dashed rectangle shows the scroll rectangle in the current frame. The scroll rectangle is specified by the pScrollRect member. The arrow shows the scroll offset. The scroll offset is specified by the pScrollOffset member. Filled rectangles show dirty rectangles that the application updated with new content. The filled rectangles are specified by the DirtyRectsCount and pDirtyRects members.The scroll rectangle and offset are not supported for the or present option. Dirty rectangles and scroll rectangle are not supported for multisampled swap chains.The actual implementation of composition and necessary bitblts is different for the bitblt model and the flip model. DXGI_PRESENT_PARAMETERS

The number of updated rectangles that you update in the back buffer for the presented frame. The operating system uses this information to optimize presentation. You can set this member to 0 to indicate that you update the whole frame.

unsigned int DirtyRectsCount

A list of updated rectangles that you update in the back buffer for the presented frame. An application must update every single pixel in each rectangle that it reports to the runtime; the application cannot assume that the pixels are saved from the previous frame. For more information about updating dirty rectangles, see Remarks. You can set this member to null if DirtyRectsCount is 0. An application must not update any pixel outside of the dirty rectangles.

RECT* pDirtyRects

A reference to the scrolled rectangle. The scrolled rectangle is the rectangle of the previous frame from which the runtime bit-block transfers (bitblts) content. The runtime also uses the scrolled rectangle to optimize presentation in terminal server and indirect display scenarios. The scrolled rectangle also describes the destination rectangle, that is, the region on the current frame that is filled with scrolled content. You can set this member to null to indicate that no content is scrolled from the previous frame.

RECT* pScrollRect

A reference to the offset of the scrolled area that goes from the source rectangle (of previous frame) to the destination rectangle (of current frame). You can set this member to null to indicate no offset.

POINT* pScrollOffset

Represents a rational number.

The structure operates under the following rules:0/0 is legal and will be interpreted as 0/1. 0/anything is interpreted as zero. If you are representing a whole number, the denominator should be 1. DXGI_RATIONAL

An unsigned integer value representing the top of the rational number.

unsigned int Numerator

An unsigned integer value representing the bottom of the rational number.

unsigned int Denominator

Initializes a new instance of the structure.

The numerator of the rational pair. The denominator of the rational pair.

Describes multi-sampling parameters for a resource.

The default sampler mode, with no anti-aliasing, has a count of 1 and a quality level of 0.If multi-sample antialiasing is being used, all bound render targets and depth buffers must have the same sample counts and quality levels.Differences between Direct3D 10.0 and Direct3D 10.1 and between Direct3D 10.0 and Direct3D 11: Direct3D 10.1 has defined two standard quality levels: and in the enumeration in D3D10_1.h. Direct3D 11 has defined two standard quality levels: and in the enumeration in D3D11.h.? DXGI_SAMPLE_DESC

The number of multisamples per pixel.

unsigned int Count

The image quality level. The higher the quality, the lower the performance. The valid range is between zero and one less than the level returned by for Direct3D 10 or for Direct3D 11. For Direct3D 10.1 and Direct3D 11, you can use two special quality level values. For more information about these quality level values, see Remarks.

unsigned int Quality

Initializes a new instance of the structure.

The sample count. The sample quality.

Represents a handle to a shared resource.

To create a shared surface, pass a shared-resource handle into the method. DXGI_SHARED_RESOURCE

A handle to a shared resource.

void* Handle

Describes a surface.

DXGI_SURFACE_DESC

A value describing the surface width.

unsigned int Width

A value describing the surface height.

unsigned int Height

A member of the enumerated type that describes the surface format.

DXGI_FORMAT Format

A member of the structure that describes multi-sampling parameters for the surface.

DXGI_SAMPLE_DESC SampleDesc

Describes a swap chain.

In full-screen mode, there is a dedicated front buffer; in windowed mode, the desktop is the front buffer.If you create a swap chain with one buffer, specifying does not cause the contents of the single buffer to be swapped with the front buffer.For performance information about flipping swap-chain buffers in full-screen application, see Full-Screen Application Performance Hints. DXGI_SWAP_CHAIN_DESC

A structure that describes the backbuffer display mode.

DXGI_MODE_DESC BufferDesc

A structure that describes multi-sampling parameters.

DXGI_SAMPLE_DESC SampleDesc

A member of the DXGI_USAGE enumerated type that describes the surface usage and CPU access options for the back buffer. The back buffer can be used for shader input or render-target output.

DXGI_USAGE_ENUM BufferUsage

A value that describes the number of buffers in the swap chain. When you call to create a full-screen swap chain, you typically include the front buffer in this value. For more information about swap-chain buffers, see Remarks.

unsigned int BufferCount

An handle to the output window. This member must not be null.

HWND OutputWindow

A member of the enumerated type that describes options for handling the contents of the presentation buffer after presenting a surface.

DXGI_SWAP_EFFECT SwapEffect

A member of the enumerated type that describes options for swap-chain behavior.

DXGI_SWAP_CHAIN_FLAG Flags

A Boolean value that specifies whether the output is in windowed mode. TRUE if the output is in windowed mode; otherwise, . We recommend that you create a windowed swap chain and allow the end user to change the swap chain to full screen through ; that is, do not set this member to to force the swap chain to be full screen. However, if you create the swap chain as full screen, also provide the end user with a list of supported display modes through the BufferDesc member because a swap chain that is created with an unsupported display mode might cause the display to go black and prevent the end user from seeing anything. For more information about choosing windowed verses full screen, see .

BOOL Windowed

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

Note??You cannot cast a to a and vice versa. An application must explicitly use the method to retrieve the newer version of the swap-chain description structure.In full-screen mode, there is a dedicated front buffer; in windowed mode, the desktop is the front buffer.For a flip-model swap chain (that is, a swap chain that has the value set in the SwapEffect member), you must set the Format member to , , or ; you must set the Count member of the structure that the SampleDesc member specifies to one and the Quality member of to zero because multiple sample antialiasing (MSAA) is not supported; you must set the BufferCount member to from two to sixteen. DXGI_SWAP_CHAIN_DESC1

unsigned int Width

A value that describes the resolution height. If you specify the height as zero when you call the method to create a swap chain, the runtime obtains the height from the output window and assigns this height value to the swap-chain description. You can subsequently call the method to retrieve the assigned height value. You cannot specify the height as zero when you call the method.

unsigned int Height

A structure that describes the display format.

DXGI_FORMAT Format

A structure that describes multi-sampling parameters. This member is valid only with bit-block transfer (bitblt) model swap chains.

DXGI_SAMPLE_DESC SampleDesc

A DXGI_USAGE-typed value that describes the surface usage and CPU access options for the back buffer. The back buffer can be used for shader input or render-target output.

DXGI_USAGE_ENUM BufferUsage

A value that describes the number of buffers in the swap chain. When you create a full-screen swap chain, you typically include the front buffer in this value.

unsigned int BufferCount

A -typed value that identifies resize behavior if the size of the back buffer is not equal to the target output.

DXGI_SCALING Scaling

A -typed value that describes the presentation model that is used by the swap chain and options for handling the contents of the presentation buffer after presenting a surface. You must specify the value when you call the method.

DXGI_SWAP_EFFECT SwapEffect

A -typed value that identifies the transparency behavior of the swap-chain back buffer.

DXGI_ALPHA_MODE AlphaMode

A combination of -typed values that are combined by using a bitwise OR operation. The resulting value specifies options for swap-chain behavior.

DXGI_SWAP_CHAIN_FLAG Flags

Specifies whether the full-screen display mode or the swap-chain back buffer is stereo. TRUE if stereo; otherwise, . If you specify stereo, you must also specify a flip-model swap chain (that is, a swap chain that has the value set in the SwapEffect member).

BOOL Stereo

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

DXGI_SWAP_CHAIN_FULLSCREEN_DESC

A structure that describes the refresh rate in hertz.

DXGI_RATIONAL RefreshRate

A member of the enumerated type that describes the scan-line drawing mode.

DXGI_MODE_SCANLINE_ORDER ScanlineOrdering

A member of the enumerated type that describes the scaling mode.

DXGI_MODE_SCALING Scaling