IDXGIDocObject Interface (dxgi)

The IDXGIDocObject interface is the base interface for all DXGI objects that can be represented as a document object. It provides methods for accessing the document source of a DXGI object.

Interface Details

Header: Declare.h

Library: DXGI.lib

Interface ID: IID_IDXGIDocObject

Methods

GetPrivateData
HRESULT GetPrivateData( REFGUID Name, UINT* pDataSize, void* pData );

Retrieves the private data associated with the object.

Return value: Returns S_OK if successful; otherwise, returns an error code.

pDataSize: A pointer to a UINT variable that receives the size of the data.

pData: A pointer to a buffer that receives the private data.

SetPrivateData
HRESULT SetPrivateData( REFGUID Name, UINT DataSize, const void* pData );

Sets private data for the object.

Return value: Returns S_OK if successful; otherwise, returns an error code.

DataSize: The size of the private data.

pData: A pointer to the private data.

SetPrivateDataInterface
HRESULT SetPrivateDataInterface( REFGUID Name, IUnknown* pUnknown );

Associates a COM interface with the object.

Return value: Returns S_OK if successful; otherwise, returns an error code.

pUnknown: A pointer to the COM interface to associate.

GetPrivateDataInterface
HRESULT GetPrivateDataInterface( REFGUID Name, REFIID riid, void** ppvObject );

Retrieves a COM interface associated with the object.

Return value: Returns S_OK if successful; otherwise, returns an error code.

riid: The IID of the interface to retrieve.

ppvObject: A pointer to a buffer that receives the interface pointer.

Remarks

The IDXGIDocObject interface is inherited by several DXGI interfaces, including IDXGIFactory, IDXGIAdapter, and IDXGIOutput. It provides a consistent way to manage private data and associated COM interfaces across various DXGI objects.

Requirements

  • Minimum supported client: Windows 7
  • Minimum supported server: Windows Server 2008 R2
  • Header: Declare.h
  • Library: DXGI.lib