view src/video/Xext/extensions/xf86vmode.h @ 5067:61d53410eb41

Fixed bug #859 CREATE_SUBDIRS helps a lot if browsing HTML documentation in a file browser. ALWAYS_DETAILED_SEC makes sure everything has at least the automatic documentation like function prototype and source references. STRIP_FROM_PATH allows you to include only the relevant portions of the files' paths, cleaning up both the file list and directory tree, though you need to change the path listed here to match wherever you put SDL. ALIASES avoids some warnings generated by C:\source\svn.libsdl.org\trunk\SDL\src\joystick\darwin\10.3.9-FIX\IOHIDLib.h. It seems Apple uses a few commands which are not normally supported by Doxygen. BUILTIN_STL_SUPPORT adds support for parsing code which makes use of the standard template library. There isn't a lot of C++ in SDL (some in bwindow at least), but this still seems like a good idea. TYPEDEF_HIDES_STRUCT means that for code like this: typedef struct A {int B;} C; C is documented as a structure containing B instead of a typedef mapped to A. EXTRACT_ALL, EXTRACT_PRIVATE, EXTRACT_STATIC, EXTRACT_LOCAL_METHODS, EXTRACT_ANON_NSPACES and INTERNAL_DOCS make sure that _everything_ is documented. CASE_SENSE_NAMES = NO avoids potential conflicts when building documentation on case insensitive file systems like NTFS and FAT32. WARN_NO_PARAMDOC lets you know when you have documented some, but not all, of the parameters of a function. This is useful when you're working on adding such documentation since it makes partially documented functions easier to spot. WARN_LOGFILE writes warnings to a seperate file instead of mixing them in with stdout. When not running in quiet mode, these warnings can be hard to spot without this flag. I added *.h.in and *.h.default to FILE_PATTERNS to generate documentation for config.h.in and config.h.default. RECURSIVE tells doxygen to look not only in the input directory, but also in subfolders. EXCLUDE avoids documenting things like test programs, examples and templates which need to be documented separately. I've used EXCLUDE_PATTERNS to exclude non-source subdirectories that often find their way into source folders (such as obj or .svn). EXAMPLE_PATH lists directories doxygen will search to find included example code. So far, SDL doesn't really use this feature, but I've listed some likely locations. SOURCE_BROWSER adds syntax highlighted source code to the HTML output. USE_HTAGS is nice, but not available on Windows. INLINE_SOURCES adds the body of a function to it's documentation so you can quickly see exactly what it does. ALPHABETICAL_INDEX generates an alphabetical list of all structures, functions, etc., which makes it much easier to find what you're looking for. IGNORE_PREFIX skips the SDL_ prefix when deciding which index page to place an item on so you don't have everything show up under "S". HTML_DYNAMIC_SECTIONS hides the includes/included by diagrams by default and adds JavaScript to allow the user to show and hide them by clicking a link. ENUM_VALUES_PER_LINE = 1 makes enums easier to read by placing each value on it's own line. GENERATE_TREEVIEW produces a two frame index page with a navigation tree on the left. I have LaTeX and man pages turned off to speed up doxygen, you may want to turn them back on yourself. I added _WIN32=1 to PREDEFINED to cause SDL to output documentation related to Win32 builds of SDL. Normally, doxygen gets confused since there are multiple definitions for various structures and formats that vary by platform. Without this doxygen can produce broken documentation or, if you're lucky, output documentation only for the dummy drivers, which isn't very useful. You need to pick a platform. GENERATE_TAGFILE produces a file which can be used to link other doxygen documentation to the SDL documentation. CLASS_DIAGRAMS turns on class diagrams even when dot is not available. HAVE_DOT tells doxygen to try to use dot to generate diagrams. TEMPLATE_RELATIONS and INCLUDE_GRAPH add additional diagrams to the documentation. DOT_MULTI_TARGETS speeds up dot. OUTPUT_DIRECTORY, INPUT and other paths reflect the fact that this Doxyfile is intended to process src as well as include and is being run from a separate subdirectory. Doxygen produces several temporary files while it's running and if interrupted, can leave those files behind. It's easier to clean up if there aren't a hundred or so files in the same folder. I typically run doxygen in SDL/doxy and set the output directory to '.'. Since doxygen puts it's output in subfolders by type, this keeps things pretty well organised. You could use '../doc' instead and get the same results.
author Sam Lantinga <slouken@libsdl.org>
date Fri, 21 Jan 2011 12:57:01 -0800
parents c121d94672cb
children
line wrap: on
line source

/* $XFree86: xc/include/extensions/xf86vmode.h,v 3.30 2001/05/07 20:09:50 mvojkovi Exp $ */
/*

Copyright 1995  Kaleb S. KEITHLEY

Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:

The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL Kaleb S. KEITHLEY BE LIABLE FOR ANY CLAIM, DAMAGES 
OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.

Except as contained in this notice, the name of Kaleb S. KEITHLEY 
shall not be used in advertising or otherwise to promote the sale, use 
or other dealings in this Software without prior written authorization
from Kaleb S. KEITHLEY

*/
/* $Xorg: xf86vmode.h,v 1.3 2000/08/18 04:05:46 coskrey Exp $ */

/* THIS IS NOT AN X CONSORTIUM STANDARD OR AN X PROJECT TEAM SPECIFICATION */

#ifndef _XF86VIDMODE_H_
#define _XF86VIDMODE_H_

#include <X11/Xfuncproto.h>
#include <X11/Xmd.h>
#include "SDL_name.h"

#define X_XF86VidModeQueryVersion	0
#define X_XF86VidModeGetModeLine	1
#define X_XF86VidModeModModeLine	2
#define X_XF86VidModeSwitchMode		3
#define X_XF86VidModeGetMonitor		4
#define X_XF86VidModeLockModeSwitch	5
#define X_XF86VidModeGetAllModeLines	6
#define X_XF86VidModeAddModeLine	7
#define X_XF86VidModeDeleteModeLine	8
#define X_XF86VidModeValidateModeLine	9
#define X_XF86VidModeSwitchToMode	10
#define X_XF86VidModeGetViewPort	11
#define X_XF86VidModeSetViewPort	12
/* new for version 2.x of this extension */
#define X_XF86VidModeGetDotClocks	13
#define X_XF86VidModeSetClientVersion	14
#define X_XF86VidModeSetGamma		15
#define X_XF86VidModeGetGamma		16
#define X_XF86VidModeGetGammaRamp	17
#define X_XF86VidModeSetGammaRamp	18
#define X_XF86VidModeGetGammaRampSize	19

#define CLKFLAG_PROGRAMABLE		1

#ifdef XF86VIDMODE_EVENTS
#define XF86VidModeNotify		0
#define XF86VidModeNumberEvents		(XF86VidModeNotify + 1)

#define XF86VidModeNotifyMask		0x00000001

#define XF86VidModeNonEvent		0
#define XF86VidModeModeChange		1
#else
#define XF86VidModeNumberEvents		0
#endif

#define XF86VidModeBadClock		0
#define XF86VidModeBadHTimings		1
#define XF86VidModeBadVTimings		2
#define XF86VidModeModeUnsuitable	3
#define XF86VidModeExtensionDisabled	4
#define XF86VidModeClientNotLocal	5
#define XF86VidModeZoomLocked		6
#define XF86VidModeNumberErrors		(XF86VidModeZoomLocked + 1)

#ifndef _XF86VIDMODE_SERVER_

typedef struct
{
    unsigned short hdisplay;
    unsigned short hsyncstart;
    unsigned short hsyncend;
    unsigned short htotal;
    unsigned short hskew;
    unsigned short vdisplay;
    unsigned short vsyncstart;
    unsigned short vsyncend;
    unsigned short vtotal;
    unsigned int flags;
    int privsize;
#if defined(__cplusplus) || defined(c_plusplus)
    /* private is a C++ reserved word */
    INT32 *c_private;
#else
    INT32 *private;
#endif
} SDL_NAME(XF86VidModeModeLine);

typedef struct
{
    unsigned int dotclock;
    unsigned short hdisplay;
    unsigned short hsyncstart;
    unsigned short hsyncend;
    unsigned short htotal;
    unsigned short hskew;
    unsigned short vdisplay;
    unsigned short vsyncstart;
    unsigned short vsyncend;
    unsigned short vtotal;
    unsigned int flags;
    int privsize;
#if defined(__cplusplus) || defined(c_plusplus)
    /* private is a C++ reserved word */
    INT32 *c_private;
#else
    INT32 *private;
#endif
} SDL_NAME(XF86VidModeModeInfo);

typedef struct
{
    float hi;
    float lo;
} SDL_NAME(XF86VidModeSyncRange);

typedef struct
{
    char *vendor;
    char *model;
    float EMPTY;
    unsigned char nhsync;
      SDL_NAME(XF86VidModeSyncRange) * hsync;
    unsigned char nvsync;
      SDL_NAME(XF86VidModeSyncRange) * vsync;
} SDL_NAME(XF86VidModeMonitor);

typedef struct
{
    int type;                   /* of event */
    unsigned long serial;       /* # of last request processed by server */
    Bool send_event;            /* true if this came from a SendEvent req */
    Display *display;           /* Display the event was read from */
    Window root;                /* root window of event screen */
    int state;                  /* What happened */
    int kind;                   /* What happened */
    Bool forced;                /* extents of new region */
    Time time;                  /* event timestamp */
} SDL_NAME(XF86VidModeNotifyEvent);

typedef struct
{
    float red;                  /* Red Gamma value */
    float green;                /* Green Gamma value */
    float blue;                 /* Blue Gamma value */
} SDL_NAME(XF86VidModeGamma);


#define SDL_XF86VidModeSelectNextMode(disp, scr) \
	SDL_NAME(XF86VidModeSwitchMode)(disp, scr, 1)
#define SDL_XF86VidModeSelectPrevMode(disp, scr) \
	SDL_NAME(XF86VidModeSwitchMode)(disp, scr, -1)

_XFUNCPROTOBEGIN Bool SDL_NAME(XF86VidModeQueryVersion) (Display * /* dpy */ ,
                                                         int *
                                                         /* majorVersion */ ,
                                                         int *  /* minorVersion */
    );

Bool SDL_NAME(XF86VidModeQueryExtension) (Display * /* dpy */ ,
                                          int * /* event_base */ ,
                                          int * /* error_base */
    );

Bool SDL_NAME(XF86VidModeSetClientVersion) (Display *   /* dpy */
    );

Bool SDL_NAME(XF86VidModeGetModeLine) (Display * /* dpy */ ,
                                       int /* screen */ ,
                                       int * /* dotclock */ ,
                                       SDL_NAME(XF86VidModeModeLine) *  /* modeline */
    );

Bool SDL_NAME(XF86VidModeGetAllModeLines) (Display * /* dpy */ ,
                                           int /* screen */ ,
                                           int * /* modecount */ ,
                                           SDL_NAME(XF86VidModeModeInfo) ***    /* modelinesPtr */
    );

Bool SDL_NAME(XF86VidModeAddModeLine) (Display * /* dpy */ ,
                                       int /* screen */ ,
                                       SDL_NAME(XF86VidModeModeInfo) *
                                       /* new modeline */ ,
                                       SDL_NAME(XF86VidModeModeInfo) *  /* after modeline */
    );

Bool SDL_NAME(XF86VidModeDeleteModeLine) (Display * /* dpy */ ,
                                          int /* screen */ ,
                                          SDL_NAME(XF86VidModeModeInfo) *       /* modeline */
    );

Bool SDL_NAME(XF86VidModeModModeLine) (Display * /* dpy */ ,
                                       int /* screen */ ,
                                       SDL_NAME(XF86VidModeModeLine) *  /* modeline */
    );

Status SDL_NAME(XF86VidModeValidateModeLine) (Display * /* dpy */ ,
                                              int /* screen */ ,
                                              SDL_NAME(XF86VidModeModeInfo) *   /* modeline */
    );

Bool SDL_NAME(XF86VidModeSwitchMode) (Display * /* dpy */ ,
                                      int /* screen */ ,
                                      int       /* zoom */
    );

Bool SDL_NAME(XF86VidModeSwitchToMode) (Display * /* dpy */ ,
                                        int /* screen */ ,
                                        SDL_NAME(XF86VidModeModeInfo) * /* modeline */
    );

Bool SDL_NAME(XF86VidModeLockModeSwitch) (Display * /* dpy */ ,
                                          int /* screen */ ,
                                          int   /* lock */
    );

Bool SDL_NAME(XF86VidModeGetMonitor) (Display * /* dpy */ ,
                                      int /* screen */ ,
                                      SDL_NAME(XF86VidModeMonitor) *    /* monitor */
    );

Bool SDL_NAME(XF86VidModeGetViewPort) (Display * /* dpy */ ,
                                       int /* screen */ ,
                                       int * /* x return */ ,
                                       int *    /* y return */
    );

Bool SDL_NAME(XF86VidModeSetViewPort) (Display * /* dpy */ ,
                                       int /* screen */ ,
                                       int /* x */ ,
                                       int      /* y */
    );

Bool SDL_NAME(XF86VidModeGetDotClocks) (Display * /* dpy */ ,
                                        int /* screen */ ,
                                        int * /* flags return */ ,
                                        int * /* number of clocks return */ ,
                                        int * /* max dot clock return */ ,
                                        int **  /* clocks return */
    );

Bool SDL_NAME(XF86VidModeGetGamma) (Display * /* dpy */ ,
                                    int /* screen */ ,
                                    SDL_NAME(XF86VidModeGamma) *        /* Gamma */
    );

Bool SDL_NAME(XF86VidModeSetGamma) (Display * /* dpy */ ,
                                    int /* screen */ ,
                                    SDL_NAME(XF86VidModeGamma) *        /* Gamma */
    );

Bool SDL_NAME(XF86VidModeSetGammaRamp) (Display * /* dpy */ ,
                                        int /* screen */ ,
                                        int /* size */ ,
                                        unsigned short * /* red array */ ,
                                        unsigned short * /* green array */ ,
                                        unsigned short *        /* blue array */
    );

Bool SDL_NAME(XF86VidModeGetGammaRamp) (Display * /* dpy */ ,
                                        int /* screen */ ,
                                        int /* size */ ,
                                        unsigned short * /* red array */ ,
                                        unsigned short * /* green array */ ,
                                        unsigned short *        /* blue array */
    );

Bool SDL_NAME(XF86VidModeGetGammaRampSize) (Display * /* dpy */ ,
                                            int /* screen */ ,
                                            int *       /* size */
    );


_XFUNCPROTOEND
#endif
#endif
/* vi: set ts=4 sw=4 expandtab: */