GetCustomVideoModeInfoExt

Returns information about a custom display mode for a specific output device

Declaration

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

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)
outputDevice | Output device flags to use (GA_OutputFlagsType)

Return Value

0 on success, -1 on failure

Description

This function returns extened information about a custom SNAP display mode for a specific output device selection. This is different to the normal GetCustomVideoModeInfo function, which returns the display mode information for the currently active output device (ie: LCD, CRT or TV). The only difference is the addition of the outputDevice parameter, which contains flags from the GA_OutputFlagsType enumeration.

This function is useful if you are running on a different output device (ie: CRT display) but with to find out the capabilities of a another output device (ie: LCD or TV), without needing to first switch to that device and make it active.

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, GetVideoModeInfoExt, GetCustomVideoModeInfo, GetCurrentVideoModeInfo, GetCurrentRefreshRate, SetVideoMode

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