--- name: "XF86VidModeQueryVersion" section: "3x" platform: "linux" package: "xlibs-static-dev" version: "4.3.0.dfsg.1-14sarge7" release: "Debian 3.1 (Sarge)" platforms: ["linux"] url: "https://new.carta.tech/XF86VidMode" --- # XF86VidModeQueryVersion(3x) XFree86-VidMode extension interface functions Part of [XF86VidMode(3x)](/XF86VidMode/3x.md). ## NAME XF86VidModeQueryExtension, XF86VidModeQueryVersion, XF86VidModeSetClientVersion, XF86VidModeGetModeLine, XF86VidModeGetAllModeLines, XF86VidModeDeleteModeLine, XF86VidModeModModeLine, XF86VidModeValidateModeLine, XF86VidModeSwitchMode, XF86VidModeSwitchToMode, XF86VidModeLockModeSwitch, XF86VidModeGetMonitor, XF86VidModeGetViewPort, XF86VidModeSetViewPort, XF86VidModeGetDotClocks, XF86VidModeGetGamma, XF86VidModeSetGamma, XF86VidModeGetGammaRamp, XF86VidModeSetGammaRamp, XF86VidModeGetGammaRampSize, XF86VidModeGetPermissions - XFree86-VidMode extension interface functions ## SYNTAX ``` ``` \#include \ Bool XF86VidModeQueryExtension(\ Display \**display*,\ int \**event\_base\_return*,\ int \**error\_base\_return*); Bool XF86VidModeQueryVersion(\ Display \**display*,\ int \**major\_version\_return*,\ int \**minor\_version\_return*); Bool XF86VidModeSetClientVersion(\ Display \**display*); Bool XF86VidModeGetModeLine(\ Display \**display*,\ int *screen*,\ int \**dotclock\_return*,\ XF86VidModeModeLine \**modeline*); Bool XF86VidModeGetAllModeLines(\ Display \**display*,\ int *screen*,\ int \**modecount\_return*,\ XF86VidModeModeInfo \*\*\**modesinfo*); Bool XF86VidModeDeleteModeLine(\ Display \**display*,\ int *screen*,\ XF86VidModeModeInfo \**modeline*); Bool XF86VidModeModModeLine(\ Display \**display*,\ int *screen*,\ XF86VidModeModeLine \**modeline*); Status XF86VidModeValidateModeLine(\ Display \**display*,\ int *screen*,\ XF86VidModeModeLine \**modeline*); Bool XF86VidModeSwitchMode(\ Display \**display*,\ int *screen*,\ int *zoom*); Bool XF86VidModeSwitchToMode(\ Display \**display*,\ int *screen*,\ XF86VidModeModeInfo \**modeline*); Bool XF86VidModeLockModeSwitch(\ Display \**display*,\ int *screen*,\ int *lock*); Bool XF86VidModeGetMonitor(\ Display \**display*,\ int *screen*,\ XF86VidModeMonitor \**monitor*); Bool XF86VidModeGetViewPort(\ Display \**display*,\ int *screen*,\ int \**x\_return*,\ int \**y\_return*); Bool XF86VidModeSetViewPort(\ Display \**display*,\ int *screen*,\ int *x*,\ int *y*); XF86VidModeGetDotClocks(\ Display \**display*,\ int *screen*,\ int \**flags return*,\ int \**number of clocks return*,\ int \**max dot clock return*,\ int \*\**clocks return*); XF86VidModeGetGamma(\ Display \**display*,\ int *screen*,\ XF86VidModeGamma \**Gamma*); XF86VidModeSetGamma(\ Display \**display*,\ int *screen*,\ XF86VidModeGamma \**Gamma*); XF86VidModeGetGammaRamp(\ Display \**display*,\ int *screen*,\ int *size*,\ unsigned short \**red array*,\ unsigned short \**green array*,\ unsigned short \**blue array*); XF86VidModeSetGammaRamp(\ Display \**display*,\ int *screen*,\ int *size*,\ unsigned short \**red array*,\ unsigned short \**green array*,\ unsigned short \**blue array*); XF86VidModeGetGammaRampSize(\ Display \**display*,\ int *screen*,\ int \**size*); ## ARGUMENTS - *display* Specifies the connection to the X server. - *screen* Specifies which screen number the setting apply to. - *event\_base\_return* Returns the base event number for the extension. - *error\_base\_return* Returns the base error number for the extension. - *major\_version\_return* Returns the major version number of the extension. - *minor\_version\_return* Returns the minor version number of the extension. - *dotclock\_return* Returns the clock for the mode line. - *modecount\_return* Returns the number of video modes available in the server. - *zoom* If greater than zero, indicates that the server should switch to the next mode, otherwise switch to the previous mode. - *lock* Indicates that mode switching should be locked, if non-zero. - *modeline* Specifies or returns the timing values for a video mode. - *modesinfo* Returns the timing values and dotclocks for all of the available video modes. - *monitor* Returns information about the monitor. - *x* Specifies the desired X location for the viewport. - *x\_return* Returns the current X location of the viewport. - *y* Specifies the desired Y location for the viewport. - *y\_return* Returns the current Y location of the viewport. ## STRUCTURES ``` Video Mode Settings: typedef struct { unsigned short hdisplay; unsigned short hsyncstart; unsigned short hsyncend; unsigned short htotal; unsigned short vdisplay; unsigned short vsyncstart; unsigned short vsyncend; unsigned short vtotal; unsigned int flags; int privsize; INT32 *private; } XF86VidModeModeLine; typedef struct { unsigned int dotclock; unsigned short hdisplay; unsigned short hsyncstart; unsigned short hsyncend; unsigned short htotal; unsigned short vdisplay; unsigned short vsyncstart; unsigned short vsyncend; unsigned short vtotal; unsigned int flags; int privsize; INT32 *private; } XF86VidModeModeInfo; ``` *Monitor information:* typedef struct {\ char\* vendor; \ char\* model; \ float bandwidth; \ unsigned char nhsync; \ XF86VidModeSyncRange\* hsync; \ unsigned char nvsync; \ XF86VidModeSyncRange\* vsync; } XF86VidModeMonitor; typedef struct {\ float hi; \ float lo; } XF86VidModeSyncRange; typedef struct {\ int type; \ unsigned long serial; \ Bool send\_event; \ Display \*display; \ Window root; \ int state; \ int kind; \ Bool forced; \ Time time; } XF86VidModeNotifyEvent; typedef struct {\ float red; \ float green; \ float blue; } XF86VidModeGamma; ## DESCRIPTION These functions provide an interface to the server extension *XFree86-VidModeExtension* which allows the video modes to be queried and adjusted dynamically and mode switching to be controlled. Applications that use these functions must be linked with *-lXxf86vm* ### MODELINE FUNCTIONS The *XF86VidModeGetModeLine* function is used to query the settings for the currently selected video mode. The calling program should pass a pointer to a *XF86VidModeModeLine* structure that it has already allocated. The function fills in the fields of the structure. If there are any server private values (currently only applicable to the S3 server) the function will allocate storage for them. Therefore, if the *privsize* field is non-zero, the calling program should call *Xfree(private)* to free the storage. *XF86VidModeGetAllModeLines* returns the settings for all video modes. The calling program supplies the address of a pointer which will be set by the function to point to an array of *XF86VidModeModeInfo* structures. The memory occupied by the array is dynamically allocated by the *XF86VidModeGetAllModeLines* function and should be freed by the caller. The first element of the array corresponds to the current video mode. The *XF86VidModeModModeLine* function can be used to change the settings of the current video mode provided the requested settings are valid (e.g. they don't exceed the capabilities of the monitor). Modes can be deleted with the *XF86VidModeDeleteModeLine* function. The specified mode must match an existing mode. To be considered a match, all of the fields of the given *XF86VidModeModeInfo* structure must match, except the *privsize* and *private* fields. If the mode to be deleted is the current mode, a mode switch to the next mode will occur first. The last remaining mode can not be deleted. The validity of a mode can be checked with the *XF86VidModeValidateModeLine* function. If the specified mode can be used by the server (i.e. meets all the constraints placed upon a mode by the combination of the server, card, and monitor) the function returns *MODE\_OK*, otherwise it returns a value indicating the reason why the mode is invalid (as defined in *xf86.h*) ### MODE SWITCH FUNCTIONS When the function *XF86VidModeSwitchMode* is called, the server will change the video mode to next (or previous) video mode. The *XF86VidModeSwitchToMode* function can be used to switch directly to the specified mode. Matching is as specified in the description of the *XF86VidModeAddModeLine* function above. The *XF86VidModeLockModeSwitch* function can be used to allow or disallow mode switching whether the request to switch modes comes from a call to the *XF86VidModeSwitchMode* or *XF86VidModeSwitchToMode* functions or from one of the mode switch key sequences. ### MONITOR FUNCTIONS Information known to the server about the monitor is returned by the *XF86VidModeGetMonitor* function. The *hsync* and *vsync* fields each point to an array of *XF86VidModeSyncRange* structures. The arrays contain *nhsync* and *nvsync* elements, respectively. The *hi* and *low* values will be equal if a discreate value was given in the *XF86Config* file. The *vendor*, *model*, *hsync*, and *vsync* fields point to dynamically allocated storage that should be freed by the caller. ### VIEWPORT FUNCTIONS The *XF86VidModeGetViewPort* and *XF86VidModeSetViewPort* functions can be used to, respectively, query and change the location of the upper left corner of the viewport into the virtual screen. ### OTHER FUNCTIONS The *XF86VidModeQueryVersion* function can be used to determine the version of the extension built into the server. The function *XF86VidModeQueryExtension* returns the lowest numbered error and event values assigned to the extension. ## BUGS The XF86VidModeSetClientVersion, XF86VidModeGetDotClocks, XF86VidModeGetGamma, XF86VidModeSetGamma, XF86VidModeSetGammaRamp, XF86VidModeGetGammaRamp, XF86VidModeGetGammaRampSize, and XF86VidModeGetPermissions functions need to be documented. In the meantime, check the source code for information about how to use them. ## SEE ALSO XFree86(1), [XF86Config-4(5x)](/XF86Config-4/5x.md), [xvidtune(1)](/xvidtune/1.md) ## AUTHORS Kaleb Keithley, Jon Tombs, David Dawes, and Joe Moss