extra/opengl/framebuffers/framebuffers-docs.factor

   1 USING: help.markup help.syntax io kernel math quotations
   2 opengl.gl multiline assocs ;
   3 IN: opengl.framebuffers
   4
   5 HELP: gen-framebuffer
   6 { $values { "id" integer } }
   7 { $description "Wrapper for " { $link glGenFramebuffersEXT } " to handle the common case of generating a single framebuffer ID." } ;
   8
   9 HELP: gen-renderbuffer
  10 { $values { "id" integer } }
  11 { $description "Wrapper for " { $link glGenRenderbuffersEXT } " to handle the common case of generating a single render buffer ID." } ;
  12
  13 HELP: delete-framebuffer
  14 { $values { "id" integer } }
  15 { $description "Wrapper for " { $link glDeleteFramebuffersEXT } " to handle the common case of deleting a single framebuffer ID." } ;
  16
  17 HELP: delete-renderbuffer
  18 { $values { "id" integer } }
  19 { $description "Wrapper for " { $link glDeleteRenderbuffersEXT } " to handle the common case of deleting a single render buffer ID." } ;
  20
  21 { gen-framebuffer delete-framebuffer } related-words
  22 { gen-renderbuffer delete-renderbuffer } related-words
  23
  24 HELP: framebuffer-incomplete?
  25 { $values { "status/f" "The framebuffer error code, or " { $snippet "f" } " if the framebuffer is render-complete." } }
  26 { $description "Checks the framebuffer currently bound by " { $link glBindFramebufferEXT } " or " { $link with-framebuffer } " to see if it is incomplete, i.e., it is not ready to be rendered to." } ;
  27
  28 HELP: check-framebuffer
  29 { $description "Checks the framebuffer currently bound by " { $link glBindFramebufferEXT } " or " { $link with-framebuffer } " with " { $link framebuffer-incomplete? } ", and throws a descriptive error if the framebuffer is incomplete." } ;
  30
  31 HELP: with-framebuffer
  32 { $values { "id" "The id of a framebuffer object." } { "quot" "a quotation" } }
  33 { $description "Binds framebuffer " { $snippet "id" } " in the dynamic extent of " { $snippet "quot" } ", restoring the window framebuffer when finished." } ;
  34
  35 ABOUT: "gl-utilities"