summaryrefslogtreecommitdiff
path: root/src/x11glvnd/x11glvnd.h
blob: e9d5aa158654d97ceb4464920369669bce256e5d (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
/*
 * Copyright (c) 2013, NVIDIA CORPORATION.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a
 * copy of this software and/or associated documentation files (the
 * "Materials"), to deal in the Materials without restriction, including
 * without limitation the rights to use, copy, modify, merge, publish,
 * distribute, sublicense, and/or sell copies of the Materials, and to
 * permit persons to whom the Materials are furnished to do so, subject to
 * the following conditions:
 *
 * The above copyright notice and this permission notice shall be included
 * unaltered in all copies or substantial portions of the Materials.
 * Any additions, deletions, or changes to the original source files
 * must be clearly indicated in accompanying documentation.
 *
 * If only executable code is distributed, then the accompanying
 * documentation must state that "this software is based in part on the
 * work of the Khronos Group."
 *
 * THE MATERIALS ARE 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 THE AUTHORS OR COPYRIGHT HOLDERS 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
 * MATERIALS OR THE USE OR OTHER DEALINGS IN THE MATERIALS.
 */

#ifndef __X11GLVND_H__
#define __X11GLVND_H__

#include <X11/Xlib.h>

/*
 * Describes the client-side functions implemented by the x11glvnd extension.
 * This is a simple extension to query the X server for XID -> screen and screen
 * -> vendor mappings, used by libGLX. This may eventually be replaced by a
 *  server-side GLX extension which does the same thing.
 */

#define XGLV_EXTENSION_NAME "x11glvnd"

/*!
 * Determines if the x11glvnd extension is supported.
 *
 * \param[out] event_base_return Returns the base event code.
 * \param[out] error_base_return Returns the base error code.
 * \return True if the extension is available, or False if it is not.
 */
Bool XGLVQueryExtension(Display *dpy, int *event_base_return, int *error_base_return);

/*!
 * Returns the version of the x11glvnd extension supported by the server.
 *
 * \param[out] major Returns the major version number.
 * \param[out] minor Returns the minor version number.
 * \return nonzero if the server supports a compatible version of x11glvnd.
 */
Bool XGLVQueryVersion(Display *dpy, int *major, int *minor);

/*!
 * Returns the screen associated with this XID, or -1 if there was an error.
 */
int XGLVQueryXIDScreenMapping(
    Display *dpy,
    XID xid
);

/*!
 * Returns the vendor associated with this screen, or NULL if there was an
 * error.
 *
 * The caller must free the string with XFree.
 */
char *XGLVQueryScreenVendorMapping(
    Display *dpy,
    int screen
);

#endif // __X11GLVND_H__