| Home
| Previous
| Next
| Up

GetCustomVideoModeInfo

Returns information about a custom display mode.

Declaration

N_int32 NAPI GA_initFuncs::GetCustomVideoModeInfo(
N_int32 xRes,
N_int32 yRes,
N_int32 virtualX,
N_int32 virtualY,
N_int32 bitsPerPixel,
GA_modeInfo *modeInfo)

Prototype In

snap/graphics.h

Parameters

xRes | Physical X resolution for the display mode
yRes | Physical Y resolution for the display mode
virtualX | Logical X resolution for the display mode
virtualY | Logical Y resolution for the display mode
bitsPerPixel | Color depth for the display mode
modeInfo | Place to store the returned mode information (GA_modeInfo)

Return Value

0 on success, -1 on failure

Description

This function returns extended information about a custom SNAP display mode. A custom display mode does not need to exist in the mode list pointed to by the AvailableModes pointer in the GA_devCtx structure, and this function will fail for modes that the hardware cannot handle. If the requested mode can be handled by the hardware, this function then fills in the GA_modeInfo structure with detailed information about the requested custom display mode.

Note: Internally SNAP driver have no concept for real display modes, so the regular GetVideoModeInfo function also ends up calling this function internally for modes lists in the driver mode profile.

Note: The calling code must first ensure that the dwSize member of the GA_modeInfo structure is set to the size of the structure in bytes before calling this function. Only the number of bytes set in the dwSize member will be copied into the callers structure.

See Also

GetVideoModeInfo, SetVideoMode, SetCustomVideoMode

Copyright © 2002 SciTech Software, Inc. Visit our web site at http://www.scitechsoft.com