basis/opengl/debug/debug-docs.factor

   1 ! Copyright (C) 2009 Joe Groff.
   2 ! See http://factorcode.org/license.txt for BSD license.
   3 USING: help.markup help.syntax tools.continuations ;
   4 IN: opengl.debug
   5
   6 HELP: G
   7 { $description "Makes the OpenGL context associated with " { $link G-world } " active for subsequent OpenGL calls. This is intended to be used from the listener, where interactively entered OpenGL calls can be directed to any window. Note that the Factor UI resets the OpenGL context every time a window is updated, so every code snippet entered in the listener must be prefixed with " { $snippet "G" } " in this use case." }
   8 { $examples { $code "USING: opengl.debug ui ;
   9
  10 [ drop t ] find-window G-world set
  11 G 0.0 0.0 1.0 1.0 glClearColor
  12 G GL_COLOR_BUFFER_BIT glClear" } } ;
  13
  14 HELP: F
  15 { $description "Flushes the OpenGL context associated with " { $link G-world } ", thereby committing any outstanding drawing operations." } ;
  16
  17 HELP: G-world
  18 { $var-description "The world whose OpenGL context is made active by " { $link G } "." } ;
  19
  20 HELP: GB
  21 { $description "A shorthand for " { $link gl-break } "." } ;
  22
  23 HELP: gl-break
  24 { $description "Suspends the current thread and activates the walker like " { $link break } ", but also preserves the current OpenGL context, saves it to " { $link G-world } " for interactive use through " { $link G } ", and restores the current context when the suspended thread is continued. The shorthand word " { $link POSTPONE: GB } " can also be used." } ;
  25
  26 { G F G-world POSTPONE: GB gl-break } related-words
  27
  28 ARTICLE: "opengl.debug" "Interactive debugging of OpenGL applications"
  29 "The " { $vocab-link "opengl.debug" } " vocabulary provides words to assist with interactive debugging of OpenGL applications in the Factor UI."
  30 { $subsections
  31     G-world
  32     G
  33     F
  34     GB
  35     gl-break
  36 } ;
  37
  38 ABOUT: "opengl.debug"