IDirect3DDevice8::GetInfo

Retrieves information about the rendering device.

HRESULT GetInfo(
  DWORD DevInfoID,
  VOID* pDevInfoStruct,
  DWORD DevInfoStructSize
);

Parameters

DevInfoID

[in] Value used to identify what information will be returned in pDevInfoStruct.

pDevInfoStruct

[in, out] Pointer to a structure that receives the specified device information if the call succeeds.

DevInfoStructSize

[in] Size of the structure at pDevInfoStruct, in bytes.

Return Values

If the method succeeds, the return value is D3D_OK.

If this method fails, the return value is one of following.

D3DERR_INVALIDCALL	One or more parameters are invalid.
E_FAIL	All parameters are valid, but not supported. The structure passed in the pDevInfoStruct parameter is not filled.
S_FALSE	All parameters are valid, but an unknown error occurred. The structure passed in the pDevInfoStruct parameter is not filled.

Remarks

Information returned by this method can pertain to the underlying device driver. This method makes it possible for drivers to declare specific information types and corresponding structures that are not documented in this software development kit (SDK).

This method executes synchronously and can negatively impact an application's performance when it executes slowly. Do not call this method during scene rendering (between calls to IDirect3DDevice8::BeginScene and IDirect3DDevice8::EndScene).

This method is intended to be used for performance tracking and debugging during product development.

The following table shows a list of all the possible input values and the expected return value. ID is equivalent to the DevInfoID parameter, Struct is equivalent to the pDevInfoStruct parameter, and Size is equivalent to the DevInfoStructSize parameter.

ID	Struct	Size	Expected return value
-	NULL	-	D3DERR_INVALIDCALL
-	-	0	D3DERR_INVALIDCALL
0	Struct_7	Size_7	E_FAIL
ID_1	Struct_1	Size_1	E_FAIL
ID_2	Struct_2	Size_2	E_FAIL
ID_3	Struct_3	Size_3	E_FAIL
ID_4	Struct_4	Size_4	S_FALSE
ID_5	Struct_5	Size_5
ID_6	Struct_6	Size_6
ID_7	Struct_7	Size_7	E_FAIL

Requirements

  Header: Declared in D3d8.h.
  Import Library: Use D3d8.lib.