X11/extensions/Xdbe.h

0001 /******************************************************************************
0002  *
0003  * Copyright (c) 1994, 1995  Hewlett-Packard Company
0004  *
0005  * Permission is hereby granted, free of charge, to any person obtaining
0006  * a copy of this software and associated documentation files (the
0007  * "Software"), to deal in the Software without restriction, including
0008  * without limitation the rights to use, copy, modify, merge, publish,
0009  * distribute, sublicense, and/or sell copies of the Software, and to
0010  * permit persons to whom the Software is furnished to do so, subject to
0011  * the following conditions:
0012  *
0013  * The above copyright notice and this permission notice shall be included
0014  * in all copies or substantial portions of the Software.
0015  *
0016  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
0017  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
0018  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
0019  * IN NO EVENT SHALL HEWLETT-PACKARD COMPANY BE LIABLE FOR ANY CLAIM,
0020  * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
0021  * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
0022  * THE USE OR OTHER DEALINGS IN THE SOFTWARE.
0023  *
0024  * Except as contained in this notice, the name of the Hewlett-Packard
0025  * Company shall not be used in advertising or otherwise to promote the
0026  * sale, use or other dealings in this Software without prior written
0027  * authorization from the Hewlett-Packard Company.
0028  *
0029  *     Header file for Xlib-related DBE
0030  *
0031  *****************************************************************************/
0032
0033 #ifndef XDBE_H
0034 #define XDBE_H
0035
0036 #include <X11/Xfuncproto.h>
0037 #include <X11/extensions/dbe.h>
0038
0039 typedef struct
0040 {
0041     VisualID    visual;    /* one visual ID that supports double-buffering */
0042     int         depth;     /* depth of visual in bits                      */
0043     int         perflevel; /* performance level of visual                  */
0044 }
0045 XdbeVisualInfo;
0046
0047 typedef struct
0048 {
0049     int                 count;          /* number of items in visual_depth   */
0050     XdbeVisualInfo      *visinfo;       /* list of visuals & depths for scrn */
0051 }
0052 XdbeScreenVisualInfo;
0053
0054
0055 typedef Drawable XdbeBackBuffer;
0056
0057 typedef unsigned char XdbeSwapAction;
0058
0059 typedef struct
0060 {
0061     Window      swap_window;    /* window for which to swap buffers   */
0062     XdbeSwapAction  swap_action;    /* swap action to use for swap_window */
0063 }
0064 XdbeSwapInfo;
0065
0066 typedef struct
0067 {
0068     Window  window;         /* window that buffer belongs to */
0069 }
0070 XdbeBackBufferAttributes;
0071
0072 typedef struct
0073 {
0074     int         type;
0075     Display     *display;   /* display the event was read from */
0076     XdbeBackBuffer  buffer;     /* resource id                     */
0077     unsigned long   serial;     /* serial number of failed request */
0078     unsigned char   error_code; /* error base + XdbeBadBuffer      */
0079     unsigned char   request_code;   /* major opcode of failed request  */
0080     unsigned char   minor_code; /* minor opcode of failed request  */
0081 }
0082 XdbeBufferError;
0083
0084 /* _XFUNCPROTOBEGIN and _XFUNCPROTOEND are defined as noops
0085  * (for non-C++ builds) in X11/Xfuncproto.h.
0086  */
0087 _XFUNCPROTOBEGIN
0088
0089 extern Status XdbeQueryExtension(
0090     Display*        /* dpy                  */,
0091     int*        /* major_version_return */,
0092     int*        /* minor_version_return */
0093 );
0094
0095 extern XdbeBackBuffer XdbeAllocateBackBufferName(
0096     Display*        /* dpy         */,
0097     Window      /* window      */,
0098     XdbeSwapAction  /* swap_action */
0099 );
0100
0101 extern Status XdbeDeallocateBackBufferName(
0102     Display*        /* dpy    */,
0103     XdbeBackBuffer  /* buffer */
0104 );
0105
0106 extern Status XdbeSwapBuffers(
0107     Display*        /* dpy         */,
0108     XdbeSwapInfo*   /* swap_info   */,
0109     int         /* num_windows */
0110 );
0111
0112 extern Status XdbeBeginIdiom(
0113     Display*        /* dpy */
0114 );
0115
0116 extern Status XdbeEndIdiom(
0117     Display*        /* dpy */
0118 );
0119
0120 extern XdbeScreenVisualInfo *XdbeGetVisualInfo(
0121     Display*        /* dpy               */,
0122     Drawable*       /* screen_specifiers */,
0123     int*        /* num_screens       */
0124 );
0125
0126 extern void XdbeFreeVisualInfo(
0127     XdbeScreenVisualInfo*   /* visual_info */
0128 );
0129
0130 extern XdbeBackBufferAttributes *XdbeGetBackBufferAttributes(
0131     Display*        /* dpy    */,
0132     XdbeBackBuffer  /* buffer */
0133 );
0134
0135 _XFUNCPROTOEND
0136
0137 #endif /* XDBE_H */
0138