aboutsummaryrefslogtreecommitdiff
path: root/nx-X11/include/extensions/dmxext.h
blob: c554232e4d2efdec817ca8bd747d8993de1f748a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
/* $XFree86$ */
/*
 * Copyright 2002-2004 Red Hat Inc., Durham, North Carolina.
 *
 * All Rights Reserved.
 *
 * 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 on 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 (including the
 * next paragraph) 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
 * NON-INFRINGEMENT.  IN NO EVENT SHALL RED HAT AND/OR THEIR SUPPLIERS
 * 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.
 */

/*
 * Authors:
 *   Rickard E. (Rik) Faith <faith@redhat.com>
 *
 */

/** \file
 * This file describes the interface to the client-side libdmx.a
 * library.  All DMX-aware client-side applications should include this
 * file. */

#ifndef _DMXEXT_H_
#define _DMXEXT_H_

/* These values must be larger than LastExtensionError.
   The values in dmxext.h and dmxproto.h *MUST* match. */
#define DmxBadXinerama         1001
#define DmxBadValue            1002
#define DmxBadReply            1003

#define DMXScreenWindowWidth   (1L<<0)
#define DMXScreenWindowHeight  (1L<<1)
#define DMXScreenWindowXoffset (1L<<2)
#define DMXScreenWindowYoffset (1L<<3)
#define DMXRootWindowWidth     (1L<<4)
#define DMXRootWindowHeight    (1L<<5)
#define DMXRootWindowXoffset   (1L<<6)
#define DMXRootWindowYoffset   (1L<<7)
#define DMXRootWindowXorigin   (1L<<8)
#define DMXRootWindowYorigin   (1L<<9)

#define DMXDesktopWidth        (1L<<0)
#define DMXDesktopHeight       (1L<<1)
#define DMXDesktopShiftX       (1L<<2)
#define DMXDesktopShiftY       (1L<<3)

#define DMXInputType           (1L<<0)
#define DMXInputPhysicalScreen (1L<<1)
#define DMXInputSendsCore      (1L<<2)

#ifndef _DMX_SERVER_

/** Client-library screen information structure, returned by
 * #DMXGetScreenAttributes.  */
typedef struct {
    char         *displayName;
    int          logicalScreen;

    unsigned int screenWindowWidth;    /* displayName's coordinate system */
    unsigned int screenWindowHeight;   /* displayName's coordinate system */
    int          screenWindowXoffset;  /* displayName's coordinate system */
    int          screenWindowYoffset;  /* displayName's coordinate system */

    unsigned int rootWindowWidth;      /* screenWindow's coordinate system */
    unsigned int rootWindowHeight;     /* screenWindow's coordinate system */
    int          rootWindowXoffset;    /* screenWindow's coordinate system */
    int          rootWindowYoffset;    /* screenWindow's coordinate system */

    int          rootWindowXorigin;    /* global coordinate system */
    int          rootWindowYorigin;    /* global coordinate system */
} DMXScreenAttributes;

/** Client-library window information structure, returned by
 * #DMXGetWindowAttributes. */
typedef struct {
    int          screen;
    Window       window;
    XRectangle   pos, vis;
} DMXWindowAttributes;

/** Client-library desktop information structure, returned by
 * #DMXGetDesktopAttributes. */
typedef struct {
    unsigned int width;         /* global coordinate system */
    unsigned int height;        /* global coordinate system */
    int          shiftX;        /* global coordinate system */
    int          shiftY;        /* global coordinate system */
} DMXDesktopAttributes;

/** Enumeration for the #inputType field in the #DMXInputAttributes
 * structure. */
typedef enum {
    DMXLocalInputType,
    DMXConsoleInputType,
    DMXBackendInputType
} DMXInputEnum;

/** Client-library input information structure, returned by
 * #DMXGetInputAttributes. */ 
typedef struct {
    DMXInputEnum inputType;
    int          physicalScreen;
    int          physicalId;
    Bool         isCore;
    Bool         sendsCore;
    const char   *name;
    Bool         detached;
} DMXInputAttributes;

_XFUNCPROTOBEGIN

extern Bool DMXQueryExtension(Display *dpy,
                              int *event_basep, int *error_basep);
extern Bool DMXQueryVersion(Display *dpy, int *major_version,
                            int *minor_version, int *patch_version);
extern Bool DMXSync(Display *dpy);
extern Bool DMXForceWindowCreation(Display *dpy, Window window);


extern Bool DMXGetScreenCount(Display *dpy, int *screen_count);
extern Bool DMXGetScreenAttributes(Display *dpy,
                                   int screen,
                                   DMXScreenAttributes *attr);
extern int  DMXChangeScreensAttributes(Display *dpy,
                                       int screen_count,
                                       int *screens,
                                       int mask_count,
                                       unsigned int *masks,
                                       DMXScreenAttributes *attr, /* vector */
                                       int *error_screen);

extern Bool DMXAddScreen(Display *dpy,
                         const char *displayName,
                         unsigned int mask,
                         DMXScreenAttributes *attr,
                         int *screen);
extern Bool DMXRemoveScreen(Display *dpy, int screen);

/* Call DMXGetScreenWindowCount and allocate info to that size.  Pass
 * the size in available_count.  This call can generate a large amount
 * of wire traffic and should not be used called with available_count=0
 * just to determine the screen_count value -- use DMXGetScreenCount
 * instead.  NOTE: Also see DMX protocol specification (DMXSpec.txt) for
 * usage of DMXSync to flush pending commands. */
extern Bool DMXGetWindowAttributes(Display *dpy, Window window,
                                   int *screen_count, int available_count,
                                   DMXWindowAttributes *attr);

extern Bool DMXGetDesktopAttributes(Display *dpy, DMXDesktopAttributes *attr);
extern int  DMXChangeDesktopAttributes(Display *dpy,
                                       unsigned int mask,
                                       DMXDesktopAttributes *attr);

extern Bool DMXGetInputCount(Display *dpy, int *input_count);
extern Bool DMXGetInputAttributes(Display *dpy, int id,
                                  DMXInputAttributes *attr);

extern Bool DMXAddInput(Display *dpy,
                        unsigned int mask,
                        DMXInputAttributes *attr,
                        int *id);
extern Bool DMXRemoveInput(Display *dpy, int id);

/* These are helper functions that call DMXAddInput. */
extern Bool DMXAddBackendInput(Display *dpy, int screen, int sendsCore,
                               int *newId);
extern Bool DMXAddConsoleInput(Display *dpy, const char *name, int sendsCore,
                               int *newId);

_XFUNCPROTOEND
#endif
#endif