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