X11/extensions/XShm.h

0001 /************************************************************
0002
0003 Copyright 1989, 1998  The Open Group
0004
0005 Permission to use, copy, modify, distribute, and sell this software and its
0006 documentation for any purpose is hereby granted without fee, provided that
0007 the above copyright notice appear in all copies and that both that
0008 copyright notice and this permission notice appear in supporting
0009 documentation.
0010
0011 The above copyright notice and this permission notice shall be included in
0012 all copies or substantial portions of the Software.
0013
0014 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
0015 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
0016 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL THE
0017 OPEN GROUP BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN
0018 AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
0019 CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
0020
0021 Except as contained in this notice, the name of The Open Group shall not be
0022 used in advertising or otherwise to promote the sale, use or other dealings
0023 in this Software without prior written authorization from The Open Group.
0024
0025 ********************************************************/
0026
0027 /* THIS IS NOT AN X CONSORTIUM STANDARD OR AN X PROJECT TEAM SPECIFICATION */
0028
0029 #ifndef _XSHM_H_
0030 #define _XSHM_H_
0031
0032 #include <X11/Xfuncproto.h>
0033 #include <X11/extensions/shm.h>
0034
0035 #ifndef _XSHM_SERVER_
0036 typedef unsigned long ShmSeg;
0037
0038 typedef struct {
0039     int type;           /* of event */
0040     unsigned long serial;   /* # of last request processed by server */
0041     Bool send_event;        /* true if this came from a SendEvent request */
0042     Display *display;       /* Display the event was read from */
0043     Drawable drawable;      /* drawable of request */
0044     int major_code;     /* ShmReqCode */
0045     int minor_code;     /* X_ShmPutImage */
0046     ShmSeg shmseg;      /* the ShmSeg used in the request */
0047     unsigned long offset;   /* the offset into ShmSeg used in the request */
0048 } XShmCompletionEvent;
0049
0050 typedef struct {
0051     ShmSeg shmseg;  /* resource id */
0052     int shmid;      /* kernel id */
0053     char *shmaddr;  /* address in client */
0054     Bool readOnly;  /* how the server should attach it */
0055 } XShmSegmentInfo;
0056
0057 _XFUNCPROTOBEGIN
0058
0059 Bool XShmQueryExtension(
0060     Display*        /* dpy */
0061 );
0062
0063 int XShmGetEventBase(
0064     Display*        /* dpy */
0065 );
0066
0067 Bool XShmQueryVersion(
0068     Display*        /* dpy */,
0069     int*        /* majorVersion */,
0070     int*        /* minorVersion */,
0071     Bool*       /* sharedPixmaps */
0072 );
0073
0074 int XShmPixmapFormat(
0075     Display*        /* dpy */
0076 );
0077
0078 Bool XShmAttach(
0079     Display*        /* dpy */,
0080     XShmSegmentInfo*    /* shminfo */
0081 );
0082
0083 Bool XShmDetach(
0084     Display*        /* dpy */,
0085     XShmSegmentInfo*    /* shminfo */
0086 );
0087
0088 Bool XShmPutImage(
0089     Display*        /* dpy */,
0090     Drawable        /* d */,
0091     GC          /* gc */,
0092     XImage*     /* image */,
0093     int         /* src_x */,
0094     int         /* src_y */,
0095     int         /* dst_x */,
0096     int         /* dst_y */,
0097     unsigned int    /* src_width */,
0098     unsigned int    /* src_height */,
0099     Bool        /* send_event */
0100 );
0101
0102 Bool XShmGetImage(
0103     Display*        /* dpy */,
0104     Drawable        /* d */,
0105     XImage*     /* image */,
0106     int         /* x */,
0107     int         /* y */,
0108     unsigned long   /* plane_mask */
0109 );
0110
0111 XImage *XShmCreateImage(
0112     Display*        /* dpy */,
0113     Visual*     /* visual */,
0114     unsigned int    /* depth */,
0115     int         /* format */,
0116     char*       /* data */,
0117     XShmSegmentInfo*    /* shminfo */,
0118     unsigned int    /* width */,
0119     unsigned int    /* height */
0120 );
0121
0122 Pixmap XShmCreatePixmap(
0123     Display*        /* dpy */,
0124     Drawable        /* d */,
0125     char*       /* data */,
0126     XShmSegmentInfo*    /* shminfo */,
0127     unsigned int    /* width */,
0128     unsigned int    /* height */,
0129     unsigned int    /* depth */
0130 );
0131
0132 _XFUNCPROTOEND
0133 #endif /* _XSHM_SERVER_ */
0134
0135 #endif