Mercurial > sdl-ios-xcode

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

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
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

/*
   Copyright (c) 1999  XFree86 Inc
*/
/* $XFree86: xc/include/extensions/xf86dga.h,v 3.21 2001/08/01 00:44:36 tsi Exp $ */

#ifndef _XF86DGA_H_
#define _XF86DGA_H_

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

#define X_XDGAQueryVersion		0

/* 1 through 9 are in xf86dga1.h */

/* 10 and 11 are reserved to avoid conflicts with rogue DGA extensions */

#define X_XDGAQueryModes		12
#define X_XDGASetMode			13
#define X_XDGASetViewport		14
#define X_XDGAInstallColormap		15
#define X_XDGASelectInput		16
#define X_XDGAFillRectangle		17
#define X_XDGACopyArea			18
#define X_XDGACopyTransparentArea	19
#define X_XDGAGetViewportStatus		20
#define X_XDGASync			21
#define X_XDGAOpenFramebuffer		22
#define X_XDGACloseFramebuffer		23
#define X_XDGASetClientVersion		24
#define X_XDGAChangePixmapMode		25
#define X_XDGACreateColormap		26


#define XDGAConcurrentAccess	0x00000001
#define XDGASolidFillRect	0x00000002
#define XDGABlitRect		0x00000004
#define XDGABlitTransRect	0x00000008
#define XDGAPixmap    		0x00000010

#define XDGAInterlaced          0x00010000
#define XDGADoublescan          0x00020000

#define XDGAFlipImmediate	0x00000001
#define XDGAFlipRetrace		0x00000002

#define XDGANeedRoot		0x00000001

#define XF86DGANumberEvents		7

#define XDGAPixmapModeLarge		0
#define XDGAPixmapModeSmall		1

#define XF86DGAClientNotLocal		0
#define XF86DGANoDirectVideoMode	1
#define XF86DGAScreenNotActive		2
#define XF86DGADirectNotActivated	3
#define XF86DGAOperationNotSupported	4
#define XF86DGANumberErrors		(XF86DGAOperationNotSupported + 1)


typedef struct
{
    int num;                    /* A unique identifier for the mode (num > 0) */
    char *name;                 /* name of mode given in the XF86Config */
    float verticalRefresh;
    int flags;                  /* DGA_CONCURRENT_ACCESS, etc... */
    int imageWidth;             /* linear accessible portion (pixels) */
    int imageHeight;
    int pixmapWidth;            /* Xlib accessible portion (pixels) */
    int pixmapHeight;           /* both fields ignored if no concurrent access */
    int bytesPerScanline;
    int byteOrder;              /* MSBFirst, LSBFirst */
    int depth;
    int bitsPerPixel;
    unsigned long redMask;
    unsigned long greenMask;
    unsigned long blueMask;
    short visualClass;
    int viewportWidth;
    int viewportHeight;
    int xViewportStep;          /* viewport position granularity */
    int yViewportStep;
    int maxViewportX;           /* max viewport origin */
    int maxViewportY;
    int viewportFlags;          /* types of page flipping possible */
    int reserved1;
    int reserved2;
} SDL_NAME(XDGAMode);


typedef struct
{
    SDL_NAME(XDGAMode) mode;
    unsigned char *data;
    Pixmap pixmap;
} SDL_NAME(XDGADevice);


#ifndef _XF86DGA_SERVER_
_XFUNCPROTOBEGIN typedef struct
{
    int type;
    unsigned long serial;
    Display *display;
    int screen;
    Time time;
    unsigned int state;
    unsigned int button;
} SDL_NAME(XDGAButtonEvent);

typedef struct
{
    int type;
    unsigned long serial;
    Display *display;
    int screen;
    Time time;
    unsigned int state;
    unsigned int keycode;
} SDL_NAME(XDGAKeyEvent);

typedef struct
{
    int type;
    unsigned long serial;
    Display *display;
    int screen;
    Time time;
    unsigned int state;
    int dx;
    int dy;
} SDL_NAME(XDGAMotionEvent);

typedef union
{
    int type;
      SDL_NAME(XDGAButtonEvent) xbutton;
      SDL_NAME(XDGAKeyEvent) xkey;
      SDL_NAME(XDGAMotionEvent) xmotion;
    long pad[24];
} SDL_NAME(XDGAEvent);

Bool SDL_NAME(XDGAQueryExtension) (Display * dpy,
                                   int *eventBase, int *erroBase);

Bool SDL_NAME(XDGAQueryVersion) (Display * dpy,
                                 int *majorVersion, int *minorVersion);

SDL_NAME(XDGAMode) * SDL_NAME(XDGAQueryModes) (Display * dpy,
                                               int screen, int *num);

SDL_NAME(XDGADevice) * SDL_NAME(XDGASetMode) (Display * dpy,
                                              int screen, int mode);

Bool
SDL_NAME(XDGAOpenFramebuffer) (Display * dpy, int screen);

     void SDL_NAME(XDGACloseFramebuffer) (Display * dpy, int screen);

     void SDL_NAME(XDGASetViewport) (Display * dpy,
                                     int screen, int x, int y, int flags);

     void SDL_NAME(XDGAInstallColormap) (Display * dpy,
                                         int screen, Colormap cmap);

Colormap
SDL_NAME(XDGACreateColormap) (Display * dpy,
                              int screen,
                              SDL_NAME(XDGADevice) * device, int alloc);

     void SDL_NAME(XDGASelectInput) (Display * dpy, int screen,
                                     long event_mask);

     void SDL_NAME(XDGAFillRectangle) (Display * dpy,
                                       int screen,
                                       int x,
                                       int y,
                                       unsigned int width,
                                       unsigned int height,
                                       unsigned long color);


     void SDL_NAME(XDGACopyArea) (Display * dpy,
                                  int screen,
                                  int srcx,
                                  int srcy,
                                  unsigned int width,
                                  unsigned int height, int dstx, int dsty);


     void SDL_NAME(XDGACopyTransparentArea) (Display * dpy,
                                             int screen,
                                             int srcx,
                                             int srcy,
                                             unsigned int width,
                                             unsigned int height,
                                             int dstx,
                                             int dsty, unsigned long key);

     int SDL_NAME(XDGAGetViewportStatus) (Display * dpy, int screen);

     void SDL_NAME(XDGASync) (Display * dpy, int screen);

Bool
SDL_NAME(XDGASetClientVersion) (Display * dpy);

     void SDL_NAME(XDGAChangePixmapMode) (Display * dpy,
                                          int screen, int *x, int *y,
                                          int mode);


     void SDL_NAME(XDGAKeyEventToXKeyEvent) (SDL_NAME(XDGAKeyEvent) * dk,
                                             XKeyEvent * xk);


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