D3DKMTGetDisplayModeList function (d3dkmthk.h)
The D3DKMTGetDisplayModeList function retrieves a list of available display modes, including modes with extended format.
Syntax
NTSTATUS D3DKMTGetDisplayModeList(
D3DKMT_GETDISPLAYMODELIST *unnamedParam1
);
Parameters
unnamedParam1
[in/out] pData is a pointer to a D3DKMT_GETDISPLAYMODELIST structure that contains the arguments for this function.
Return value
D3DKMTGetDisplayModeList returns an NTSTATUS value such as one of the following.
| Return code | Description |
|---|---|
| STATUS_SUCCESS | The list of available display modes was successfully retrieved, or the number of display modes was returned in pData->ModeCount if pData->pModeList was NULL and pData->ModeCount was zero on input. |
| STATUS_DEVICE_REMOVED | The graphics adapter was stopped. |
| STATUS_BUFFER_TOO_SMALL | The buffer that the client driver supplied in pData->pModeList is not large enough to contain the requested display mode list. |
| STATUS_GRAPHICS_NO_AVAILABLE_VIDPN_TARGET | No video present target is available for use with the video present source that is identified by pData->VidPnSourceId. Therefore, no display modes are available for this source. |
| STATUS_INVALID_PARAMETER** | Parameters were validated and determined to be incorrect. |
Remarks
To get the number of the display modes for the specified VidPn source (pData->VidPnSourceId) on the graphics adapter (pData->hAdapter), a client driver can call D3DKMTGetDisplayModeList with pData->pModeList set to NULL and pData->ModeCount as 0. If this call returns STATUS_SUCCESS, the returned pData->ModeCount is the total number of the display modes. The client driver can then allocate an array of ModeCount D3DKMT_DISPLAYMODE structures, set pModeList to point to this array, and call D3DKMTGetDisplayModeList again to retrieve the display mode list.
The display attributes on the specified VidPn source can be changed between these two calls, causing the display mode list to be changed. In this case, if the caller-supplied D3DKMT_DISPLAYMODE array isn't big enough to hold the new display mode list, this function will return STATUS_BUFFER_TOO_SMALL with the number of the new display modes in the returned ModeCount. The caller can free the previous D3DKMT_DISPLAYMODE array, allocate a new D3DKMT_DISPLAYMODE array based on the new returned number, and call this function again with the new number and new D3DKMT_DISPLAYMODE array to get the new display mode list.
Requirements
| Requirement | Value |
|---|---|
| Minimum supported client | Windows Vista |
| Target Platform | Universal |
| Header | d3dkmthk.h (include D3dkmthk.h) |
| Library | Gdi32.lib |
| DLL | Gdi32.dll |