doc/glut.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 @node GLUT
   6 @chapter GLUT
   7
   8 Import the GLUT module to have access to these procedures:
   9
  10 @example
  11 (use-modules (figl glut))
  12 @end example
  13
  14 The GLUT specification is available at
  15 @uref{http://www.opengl.org/resources/libraries/glut/glut-3.spec.pdf}.
  16
  17 @menu
  18 * GLUT Initialization::
  19 * Beginning Event Processing::
  20 * Window Management::
  21 * Overlay Management::
  22 * Menu Management::
  23 * Callback Registration::
  24 * Color Index Colormap Management::
  25 * State Retrieval::
  26 * Font Rendering::
  27 * Geometric Object Rendering::
  28 @end menu
  29
  30
  31 @node GLUT Initialization
  32 @section GLUT Initialization
  33
  34 @anchor{set-initial-display-mode}
  35 @defun set-initial-display-mode mode
  36 @end defun
  37
  38 @anchor{set-initial-window-position}
  39 @defun set-initial-window-position x y
  40 @end defun
  41
  42 @anchor{set-initial-window-size}
  43 @defun set-initial-window-size width height
  44 @end defun
  45
  46 @anchor{initialize-glut}
  47 @defun initialize-glut [args] [#:window-position] [#:window-size] [#:display-mode]
  48 @end defun
  49
  50
  51 @node Beginning Event Processing
  52 @section Beginning Event Processing
  53
  54 @anchor{glut-main-loop}
  55 @defun glut-main-loop
  56 @end defun
  57
  58
  59 @node Window Management
  60 @section Window Management
  61
  62 @anchor{window-id}
  63 @defun window-id
  64 @end defun
  65
  66 @anchor{window-live?}
  67 @defun window-live?
  68 @end defun
  69
  70 @anchor{window?}
  71 @defun window?
  72 @end defun
  73
  74 @anchor{set-window-cursor!}
  75 @defun set-window-cursor! window cursor
  76 @end defun
  77
  78 @anchor{set-window-icon-title!}
  79 @defun set-window-icon-title! window str
  80 @end defun
  81
  82 @anchor{set-window-title!}
  83 @defun set-window-title! window str
  84 @end defun
  85
  86 @anchor{show-window}
  87 @defun show-window [window]
  88 @end defun
  89
  90 @anchor{sub-window?}
  91 @defun sub-window? window
  92 @end defun
  93
  94 @anchor{swap-buffers}
  95 @defun swap-buffers [window]
  96 @end defun
  97
  98 @anchor{top-level-window?}
  99 @defun top-level-window? window
 100 @end defun
 101
 102 @anchor{with-window}
 103 @defmac with-window window body1 body2 ...
 104 @end defmac
 105
 106 @anchor{with-window*}
 107 @defun with-window* _ _
 108 @end defun
 109
 110 @anchor{make-sub-window}
 111 @defun make-sub-window window x y width height
 112 @end defun
 113
 114 @anchor{make-window}
 115 @defun make-window str
 116 @end defun
 117
 118 @anchor{pop-window}
 119 @defun pop-window
 120 @end defun
 121
 122 @anchor{position-window}
 123 @defun position-window window x y
 124 @end defun
 125
 126 @anchor{post-redisplay}
 127 @defun post-redisplay [window]
 128 @end defun
 129
 130 @anchor{push-window}
 131 @defun push-window
 132 @end defun
 133
 134 @anchor{reshape-window}
 135 @defun reshape-window window width height
 136 @end defun
 137
 138 @anchor{current-window}
 139 @defun current-window
 140 @end defun
 141
 142 @anchor{destroy-window}
 143 @defun destroy-window window
 144 @end defun
 145
 146 @anchor{full-screen}
 147 @defun full-screen window full-screen?
 148 @end defun
 149
 150 @anchor{hide-window}
 151 @defun hide-window [window]
 152 @end defun
 153
 154 @anchor{iconify-window}
 155 @defun iconify-window [window]
 156 @end defun
 157
 158
 159 @node Overlay Management
 160 @section Overlay Management
 161
 162
 163 @node Menu Management
 164 @section Menu Management
 165
 166
 167 @node Callback Registration
 168 @section Callback Registration
 169
 170 @anchor{set-button-box-callback}
 171 @defun set-button-box-callback func
 172 @end defun
 173
 174 @anchor{set-current-window}
 175 @defun set-current-window window
 176 @end defun
 177
 178 @anchor{set-dials-callback}
 179 @defun set-dials-callback func
 180 @end defun
 181
 182 @anchor{set-display-callback}
 183 @defun set-display-callback func
 184 @end defun
 185
 186 @anchor{set-entry-callback}
 187 @defun set-entry-callback func
 188 @end defun
 189
 190 @anchor{set-idle-callback}
 191 @defun set-idle-callback func
 192 @end defun
 193
 194 @anchor{set-keyboard-callback}
 195 @defun set-keyboard-callback func
 196 @end defun
 197
 198 @anchor{set-menu-status-callback}
 199 @defun set-menu-status-callback func
 200 @end defun
 201
 202 @anchor{set-motion-callback}
 203 @defun set-motion-callback func
 204 @end defun
 205
 206 @anchor{set-mouse-callback}
 207 @defun set-mouse-callback func
 208 @end defun
 209
 210 @anchor{set-overlay-display-callback}
 211 @defun set-overlay-display-callback func
 212 @end defun
 213
 214 @anchor{set-passive-motion-callback}
 215 @defun set-passive-motion-callback func
 216 @end defun
 217
 218 @anchor{set-reshape-callback}
 219 @defun set-reshape-callback func
 220 @end defun
 221
 222 @anchor{set-spaceball-button-callback}
 223 @defun set-spaceball-button-callback func
 224 @end defun
 225
 226 @anchor{set-spaceball-motion-callback}
 227 @defun set-spaceball-motion-callback func
 228 @end defun
 229
 230 @anchor{set-spaceball-rotate-callback}
 231 @defun set-spaceball-rotate-callback func
 232 @end defun
 233
 234 @anchor{set-special-callback}
 235 @defun set-special-callback func
 236 @end defun
 237
 238 @anchor{set-tablet-button-callback}
 239 @defun set-tablet-button-callback func
 240 @end defun
 241
 242 @anchor{set-tablet-motion-callback}
 243 @defun set-tablet-motion-callback func
 244 @end defun
 245
 246 @anchor{set-visibility-callback}
 247 @defun set-visibility-callback func
 248 @end defun
 249
 250 @anchor{add-timer-callback}
 251 @defun add-timer-callback msecs func value
 252 @end defun
 253
 254
 255 @node Color Index Colormap Management
 256 @section Color Index Colormap Management
 257
 258
 259 @node State Retrieval
 260 @section State Retrieval
 261
 262 @anchor{window-alpha-size}
 263 @defun window-alpha-size window
 264 @end defun
 265
 266 @anchor{window-blue-size}
 267 @defun window-blue-size window
 268 @end defun
 269
 270 @anchor{window-color-buffer-size}
 271 @defun window-color-buffer-size window
 272 @end defun
 273
 274 @anchor{window-colormap-size}
 275 @defun window-colormap-size window
 276 @end defun
 277
 278 @anchor{window-depth-buffer-size}
 279 @defun window-depth-buffer-size window
 280 @end defun
 281
 282 @anchor{window-double-buffered?}
 283 @defun window-double-buffered? window
 284 @end defun
 285
 286 @anchor{window-green-size}
 287 @defun window-green-size window
 288 @end defun
 289
 290 @anchor{window-height}
 291 @defun window-height width
 292 @end defun
 293
 294 @anchor{window-number-of-children}
 295 @defun window-number-of-children window
 296 @end defun
 297
 298 @anchor{window-number-of-samples}
 299 @defun window-number-of-samples window
 300 @end defun
 301
 302 @anchor{window-parent}
 303 @defun window-parent window
 304 @end defun
 305
 306 @anchor{window-position}
 307 @defun window-position window
 308 @end defun
 309
 310 @anchor{window-red-size}
 311 @defun window-red-size window
 312 @end defun
 313
 314 @anchor{window-size}
 315 @defun window-size window
 316 @end defun
 317
 318 @anchor{window-stencil-buffer-size}
 319 @defun window-stencil-buffer-size window
 320 @end defun
 321
 322 @anchor{window-stereo?}
 323 @defun window-stereo? window
 324 @end defun
 325
 326 @anchor{window-rgba?}
 327 @defun window-rgba window
 328 @end defun
 329
 330 @anchor{window-width}
 331 @defun window-width width
 332 @end defun
 333
 334 @anchor{window-x}
 335 @defun window-x width
 336 @end defun
 337
 338 @anchor{window-y}
 339 @defun window-y width
 340 @end defun
 341
 342 @anchor{screen-height}
 343 @defun screen-height
 344 @end defun
 345
 346 @anchor{screen-height-mm}
 347 @defun screen-height-mm
 348 @end defun
 349
 350 @anchor{screen-size}
 351 @defun screen-size
 352 @end defun
 353
 354 @anchor{screen-size-mm}
 355 @defun screen-size-mm
 356 @end defun
 357
 358 @anchor{screen-width}
 359 @defun screen-width
 360 @end defun
 361
 362 @anchor{screen-width-mm}
 363 @defun screen-width-mm
 364 @end defun
 365
 366 @anchor{display-mode-possible?}
 367 @defun display-mode-possible?
 368 @end defun
 369
 370 @anchor{initial-display-mode}
 371 @defun initial-display-mode
 372 @end defun
 373
 374 @anchor{initial-window-height}
 375 @defun initial-window-height
 376 @end defun
 377
 378 @anchor{initial-window-position}
 379 @defun initial-window-position
 380 @end defun
 381
 382 @anchor{initial-window-size}
 383 @defun initial-window-size
 384 @end defun
 385
 386 @anchor{initial-window-width}
 387 @defun initial-window-width
 388 @end defun
 389
 390 @anchor{initial-window-x}
 391 @defun initial-window-x
 392 @end defun
 393
 394 @anchor{initial-window-y}
 395 @defun initial-window-y
 396 @end defun
 397
 398 @anchor{elapsed-time}
 399 @defun elapsed-time
 400 @end defun
 401
 402
 403 @node Font Rendering
 404 @section Font Rendering
 405
 406
 407 @node Geometric Object Rendering
 408 @section Geometric Object Rendering
 409