From adbcd7342972afb7cb746e5de0884b463a1ad83c Mon Sep 17 00:00:00 2001 From: Joe Groff Date: Mon, 9 Jun 2008 20:31:39 -0700 Subject: [PATCH] oops... accidentally moved opengl.framebuffer docs into root! --- .../framebuffers/framebuffer-docs.factor | 35 ------------------- .../framebuffers/framebuffers-docs.factor | 0 2 files changed, 35 deletions(-) delete mode 100644 extra/opengl/framebuffers/framebuffer-docs.factor rename framebuffers-docs.factor => extra/opengl/framebuffers/framebuffers-docs.factor (100%) diff --git a/extra/opengl/framebuffers/framebuffer-docs.factor b/extra/opengl/framebuffers/framebuffer-docs.factor deleted file mode 100644 index c5507dcce1..0000000000 --- a/extra/opengl/framebuffers/framebuffer-docs.factor +++ /dev/null @@ -1,35 +0,0 @@ -USING: help.markup help.syntax io kernel math quotations -opengl.gl multiline assocs ; -IN: opengl.framebuffers - -HELP: gen-framebuffer -{ $values { "id" integer } } -{ $description "Wrapper for " { $link glGenFramebuffersEXT } " to handle the common case of generating a single framebuffer ID." } ; - -HELP: gen-renderbuffer -{ $values { "id" integer } } -{ $description "Wrapper for " { $link glGenRenderbuffersEXT } " to handle the common case of generating a single render buffer ID." } ; - -HELP: delete-framebuffer -{ $values { "id" integer } } -{ $description "Wrapper for " { $link glDeleteFramebuffersEXT } " to handle the common case of deleting a single framebuffer ID." } ; - -HELP: delete-renderbuffer -{ $values { "id" integer } } -{ $description "Wrapper for " { $link glDeleteRenderbuffersEXT } " to handle the common case of deleting a single render buffer ID." } ; - -{ gen-framebuffer delete-framebuffer } related-words -{ gen-renderbuffer delete-renderbuffer } related-words - -HELP: framebuffer-incomplete? -{ $values { "status/f" "The framebuffer error code, or " { $snippet "f" } " if the framebuffer is render-complete." } } -{ $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." } ; - -HELP: check-framebuffer -{ $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." } ; - -HELP: with-framebuffer -{ $values { "id" "The id of a framebuffer object." } { "quot" "a quotation" } } -{ $description "Binds framebuffer " { $snippet "id" } " in the dynamic extent of " { $snippet "quot" } ", restoring the window framebuffer when finished." } ; - -ABOUT: "gl-utilities" \ No newline at end of file diff --git a/framebuffers-docs.factor b/extra/opengl/framebuffers/framebuffers-docs.factor similarity index 100% rename from framebuffers-docs.factor rename to extra/opengl/framebuffers/framebuffers-docs.factor