update upstream sources
[clinton/guile-figl.git] / doc / low-level-glx-enums.texi
1 @c This is part of the Figl Reference Manual.
2 @c Copyright (c) 2013 Andy Wingo and others
3 @c See the file figl.texi for copying conditions.
4
5 @c %start of fragment
6
7 The functions from this section may be had by loading the module:
8
9 @example
10 (use-modules (figl glx enums)
11 @end example
12
13 @defmac glx-string-name enum
14 Enumerated value. The symbolic @var{enum} argument is replaced with its
15 corresponding numeric value at compile-time. The symbolic arguments
16 known to this enumerated value form are:
17
18 @code{vendor}, @code{version}, @code{extensions}.
19
20 @end defmac
21
22 @defmac glx-error-code enum
23 Enumerated value. The symbolic @var{enum} argument is replaced with its
24 corresponding numeric value at compile-time. The symbolic arguments
25 known to this enumerated value form are:
26
27 @code{bad-screen}, @code{bad-attribute}, @code{no-extension},
28 @code{bad-visual}, @code{bad-context}, @code{bad-value},
29 @code{bad-enum}, @code{bad-hyperpipe-config-sgix},
30 @code{bad-hyperpipe-sgix}.
31
32 @end defmac
33
34 @defmac glx-drawable-type-mask enum
35 Enumerated value. The symbolic @var{enum} argument is replaced with its
36 corresponding numeric value at compile-time. The symbolic arguments
37 known to this enumerated value form are:
38
39 @code{window-bit}, @code{pixmap-bit}, @code{pbuffer-bit},
40 @code{window-bit-sgix}, @code{pixmap-bit-sgix}, @code{pbuffer-bit-sgix}.
41
42 @end defmac
43
44 @defmac glx-render-type-mask enum
45 Enumerated value. The symbolic @var{enum} argument is replaced with its
46 corresponding numeric value at compile-time. The symbolic arguments
47 known to this enumerated value form are:
48
49 @code{rgba-bit}, @code{color-index-bit}, @code{rgba-bit-sgix},
50 @code{color-index-bit-sgix}, @code{rgba-float-bit-arb},
51 @code{rgba-unsigned-float-bit-ext}.
52
53 @end defmac
54
55 @defmac glx-sync-type enum
56 Enumerated value. The symbolic @var{enum} argument is replaced with its
57 corresponding numeric value at compile-time. The symbolic arguments
58 known to this enumerated value form are:
59
60 @code{sync-frame-sgix}, @code{sync-swap-sgix}.
61
62 @end defmac
63
64 @defmac glx-event-mask enum
65 Enumerated value. The symbolic @var{enum} argument is replaced with its
66 corresponding numeric value at compile-time. The symbolic arguments
67 known to this enumerated value form are:
68
69 @code{pbuffer-clobber-mask}, @code{buffer-clobber-mask-sgix},
70 @code{buffer-swap-complete-intel-mask}.
71
72 @end defmac
73
74 @defmac glx-pbuffer-clobber-mask enum
75 Enumerated value. The symbolic @var{enum} argument is replaced with its
76 corresponding numeric value at compile-time. The symbolic arguments
77 known to this enumerated value form are:
78
79 @code{front-left-buffer-bit}, @code{front-right-buffer-bit},
80 @code{back-left-buffer-bit}, @code{back-right-buffer-bit},
81 @code{aux-buffers-bit}, @code{depth-buffer-bit},
82 @code{stencil-buffer-bit}, @code{accum-buffer-bit},
83 @code{front-left-buffer-bit-sgix}, @code{front-right-buffer-bit-sgix},
84 @code{back-left-buffer-bit-sgix}, @code{back-right-buffer-bit-sgix},
85 @code{aux-buffers-bit-sgix}, @code{depth-buffer-bit-sgix},
86 @code{stencil-buffer-bit-sgix}, @code{accum-buffer-bit-sgix},
87 @code{sample-buffers-bit-sgix}.
88
89 @end defmac
90
91 @defmac glx-hyperpipe-type-mask enum
92 Enumerated value. The symbolic @var{enum} argument is replaced with its
93 corresponding numeric value at compile-time. The symbolic arguments
94 known to this enumerated value form are:
95
96 @code{hyperpipe-display-pipe-sgix}, @code{hyperpipe-render-pipe-sgix}.
97
98 @end defmac
99
100 @defmac glx-hyperpipe-attrib enum
101 Enumerated value. The symbolic @var{enum} argument is replaced with its
102 corresponding numeric value at compile-time. The symbolic arguments
103 known to this enumerated value form are:
104
105 @code{pipe-rect-sgix}, @code{pipe-rect-limits-sgix},
106 @code{hyperpipe-stereo-sgix}, @code{hyperpipe-pixel-average-sgix}.
107
108 @end defmac
109
110 @defmac glx-hyperpipe-misc enum
111 Enumerated value. The symbolic @var{enum} argument is replaced with its
112 corresponding numeric value at compile-time. The symbolic arguments
113 known to this enumerated value form are:
114
115 @code{hyperpipe-pipe-name-length-sgix}.
116
117 @end defmac
118
119 @defmac glx-bind-to-texture-target-mask enum
120 Enumerated value. The symbolic @var{enum} argument is replaced with its
121 corresponding numeric value at compile-time. The symbolic arguments
122 known to this enumerated value form are:
123
124 @code{texture-1d-bit-ext}, @code{texture-2d-bit-ext},
125 @code{texture-rectangle-bit-ext}.
126
127 @end defmac
128
129 @defmac glx-context-flags enum
130 Enumerated value. The symbolic @var{enum} argument is replaced with its
131 corresponding numeric value at compile-time. The symbolic arguments
132 known to this enumerated value form are:
133
134 @code{context-debug-bit-arb}, @code{context-forward-compatible-bit-arb},
135 @code{context-robust-access-bit-arb},
136 @code{context-reset-isolation-bit-arb}.
137
138 @end defmac
139
140 @defmac glx-context-profile-mask enum
141 Enumerated value. The symbolic @var{enum} argument is replaced with its
142 corresponding numeric value at compile-time. The symbolic arguments
143 known to this enumerated value form are:
144
145 @code{context-core-profile-bit-arb},
146 @code{context-compatibility-profile-bit-arb},
147 @code{context-es-profile-bit-ext}, @code{context-es2-profile-bit-ext}.
148
149 @end defmac
150
151 @defmac glx-attribute enum
152 Enumerated value. The symbolic @var{enum} argument is replaced with its
153 corresponding numeric value at compile-time. The symbolic arguments
154 known to this enumerated value form are:
155
156 @code{use-gl}, @code{buffer-size}, @code{level}, @code{rgba},
157 @code{doublebuffer}, @code{stereo}, @code{aux-buffers}, @code{red-size},
158 @code{green-size}, @code{blue-size}, @code{alpha-size},
159 @code{depth-size}, @code{stencil-size}, @code{accum-red-size},
160 @code{accum-green-size}, @code{accum-blue-size},
161 @code{accum-alpha-size}, @code{config-caveat}, @code{x-visual-type},
162 @code{transparent-type}, @code{transparent-index-value},
163 @code{transparent-red-value}, @code{transparent-green-value},
164 @code{transparent-blue-value}, @code{transparent-alpha-value},
165 @code{dont-care}, @code{none}, @code{slow-config}, @code{true-color},
166 @code{direct-color}, @code{pseudo-color}, @code{static-color},
167 @code{gray-scale}, @code{static-gray}, @code{transparent-rgb},
168 @code{transparent-index}, @code{visual-id}, @code{screen},
169 @code{non-conformant-config}, @code{drawable-type}, @code{render-type},
170 @code{x-renderable}, @code{fbconfig-id}, @code{rgba-type},
171 @code{color-index-type}, @code{max-pbuffer-width},
172 @code{max-pbuffer-height}, @code{max-pbuffer-pixels},
173 @code{preserved-contents}, @code{largest-pbuffer}, @code{width},
174 @code{height}, @code{event-mask}, @code{damaged}, @code{saved},
175 @code{window}, @code{pbuffer}, @code{pbuffer-height},
176 @code{pbuffer-width}, @code{visual-caveat-ext},
177 @code{x-visual-type-ext}, @code{transparent-type-ext},
178 @code{transparent-index-value-ext}, @code{transparent-red-value-ext},
179 @code{transparent-green-value-ext}, @code{transparent-blue-value-ext},
180 @code{transparent-alpha-value-ext}, @code{none-ext},
181 @code{slow-visual-ext}, @code{true-color-ext}, @code{direct-color-ext},
182 @code{pseudo-color-ext}, @code{static-color-ext}, @code{gray-scale-ext},
183 @code{static-gray-ext}, @code{transparent-rgb-ext},
184 @code{transparent-index-ext}, @code{share-context-ext},
185 @code{visual-id-ext}, @code{screen-ext},
186 @code{non-conformant-visual-ext}, @code{drawable-type-sgix},
187 @code{render-type-sgix}, @code{x-renderable-sgix},
188 @code{fbconfig-id-sgix}, @code{rgba-type-sgix},
189 @code{color-index-type-sgix}, @code{max-pbuffer-width-sgix},
190 @code{max-pbuffer-height-sgix}, @code{max-pbuffer-pixels-sgix},
191 @code{optimal-pbuffer-width-sgix}, @code{optimal-pbuffer-height-sgix},
192 @code{preserved-contents-sgix}, @code{largest-pbuffer-sgix},
193 @code{width-sgix}, @code{height-sgix}, @code{event-mask-sgix},
194 @code{damaged-sgix}, @code{saved-sgix}, @code{window-sgix},
195 @code{pbuffer-sgix}, @code{digital-media-pbuffer-sgix},
196 @code{blended-rgba-sgis}, @code{multisample-sub-rect-width-sgis},
197 @code{multisample-sub-rect-height-sgis},
198 @code{visual-select-group-sgix}, @code{hyperpipe-id-sgix},
199 @code{sample-buffers-sgis}, @code{samples-sgis},
200 @code{sample-buffers-arb}, @code{samples-arb}, @code{sample-buffers},
201 @code{samples}, @code{coverage-samples-nv},
202 @code{context-major-version-arb}, @code{context-minor-version-arb},
203 @code{context-flags-arb},
204 @code{context-allow-buffer-byte-order-mismatch-arb},
205 @code{float-components-nv}, @code{rgba-unsigned-float-type-ext},
206 @code{framebuffer-srgb-capable-arb},
207 @code{framebuffer-srgb-capable-ext}, @code{color-samples-nv},
208 @code{rgba-float-type-arb}, @code{video-out-color-nv},
209 @code{video-out-alpha-nv}, @code{video-out-depth-nv},
210 @code{video-out-color-and-alpha-nv},
211 @code{video-out-color-and-depth-nv}, @code{video-out-frame-nv},
212 @code{video-out-field-1-nv}, @code{video-out-field-2-nv},
213 @code{video-out-stacked-fields-1-2-nv},
214 @code{video-out-stacked-fields-2-1-nv}, @code{device-id-nv},
215 @code{unique-id-nv}, @code{num-video-capture-slots-nv},
216 @code{bind-to-texture-rgb-ext}, @code{bind-to-texture-rgba-ext},
217 @code{bind-to-mipmap-texture-ext}, @code{bind-to-texture-targets-ext},
218 @code{y-inverted-ext}, @code{texture-format-ext},
219 @code{texture-target-ext}, @code{mipmap-texture-ext},
220 @code{texture-format-none-ext}, @code{texture-format-rgb-ext},
221 @code{texture-format-rgba-ext}, @code{texture-1d-ext},
222 @code{texture-2d-ext}, @code{texture-rectangle-ext},
223 @code{front-left-ext}, @code{front-right-ext}, @code{back-left-ext},
224 @code{back-right-ext}, @code{front-ext}, @code{back-ext},
225 @code{aux0-ext}, @code{aux1-ext}, @code{aux2-ext}, @code{aux3-ext},
226 @code{aux4-ext}, @code{aux5-ext}, @code{aux6-ext}, @code{aux7-ext},
227 @code{aux8-ext}, @code{aux9-ext}.
228
229 @end defmac
230
231 @defmac nv-present-video enum
232 Enumerated value. The symbolic @var{enum} argument is replaced with its
233 corresponding numeric value at compile-time. The symbolic arguments
234 known to this enumerated value form are:
235
236 @code{num-video-slots-nv}.
237
238 @end defmac
239
240 @defmac ext-swap-control enum
241 Enumerated value. The symbolic @var{enum} argument is replaced with its
242 corresponding numeric value at compile-time. The symbolic arguments
243 known to this enumerated value form are:
244
245 @code{swap-interval-ext}, @code{max-swap-interval-ext}.
246
247 @end defmac
248
249 @defmac ext-swap-control-tear enum
250 Enumerated value. The symbolic @var{enum} argument is replaced with its
251 corresponding numeric value at compile-time. The symbolic arguments
252 known to this enumerated value form are:
253
254 @code{late-swaps-tear-ext}.
255
256 @end defmac
257
258 @defmac ext-buffer-age enum
259 Enumerated value. The symbolic @var{enum} argument is replaced with its
260 corresponding numeric value at compile-time. The symbolic arguments
261 known to this enumerated value form are:
262
263 @code{back-buffer-age-ext}.
264
265 @end defmac
266
267 @defmac glx-amd-gpu-association enum
268 Enumerated value. The symbolic @var{enum} argument is replaced with its
269 corresponding numeric value at compile-time. The symbolic arguments
270 known to this enumerated value form are:
271
272 @code{gpu-vendor-amd}, @code{gpu-renderer-string-amd},
273 @code{gpu-opengl-version-string-amd},
274 @code{gpu-fastest-target-gpus-amd}, @code{gpu-ram-amd},
275 @code{gpu-clock-amd}, @code{gpu-num-pipes-amd}, @code{gpu-num-simd-amd},
276 @code{gpu-num-rb-amd}, @code{gpu-num-spi-amd}.
277
278 @end defmac
279
280 @defmac glx-arb-create-context-robustness enum
281 Enumerated value. The symbolic @var{enum} argument is replaced with its
282 corresponding numeric value at compile-time. The symbolic arguments
283 known to this enumerated value form are:
284
285 @code{lose-context-on-reset-arb},
286 @code{context-reset-notification-strategy-arb},
287 @code{no-reset-notification-arb}.
288
289 @end defmac
290
291 @defmac arb-create-context-profile enum
292 Enumerated value. The symbolic @var{enum} argument is replaced with its
293 corresponding numeric value at compile-time. The symbolic arguments
294 known to this enumerated value form are:
295
296 @code{context-profile-mask-arb}.
297
298 @end defmac
299
300
301 @c %end of fragment