| Home
| Previous
| Next
| Up

GetVideoModeInfo

Returns information about a specific display mode.

Declaration

N_int32 NAPI GA_initFuncs::GetVideoModeInfo(
N_uint32 mode,
GA_modeInfo *modeInfo)

Prototype In

snap/graphics.h

Parameters

mode | Mode number to get information for
modeInfo | Place to store the returned mode information (GA_modeInfo)

Return Value

0 on success, -1 on failure

Description

This function returns complete information about a specific SNAP display mode from the mode list pointed to by the AvailableModes pointer in the GA_devCtx structure. This function fills the GA_modeInfo structure with detailed information about the requested mode. This function will fail if you pass in a mode number that is not listed in the AvailableModes list.

This function returns the mode information for the currently active output device. To find out information specific to a particular output device (ie: TV, LCD flat panel etc), please use the GetVideoModeInfoExt function instead.

Note: Modes listed in the AvailableModes list may not be available at runtime, as they may be mapped out based on the maximum pixel clock limits for the display controller, or based on the frequency limits of the attached monitor.

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

GetVideoModeInfoExt, GetCustomVideoModeInfo, GetCustomVideoModeInfoExt, GetCurrentVideoModeInfo, GetCurrentRefreshRate, SetVideoMode

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