]> gitweb.factorcode.org Git - factor.git/commitdiff
extra/cap: add a summary and short docs to cap vocab
authorCat Stevens <catb0t@protonmail.ch>
Fri, 5 Jan 2018 03:49:46 +0000 (22:49 -0500)
committerJohn Benediktsson <mrjbq7@gmail.com>
Fri, 5 Jan 2018 04:31:04 +0000 (20:31 -0800)
extra/cap/cap-docs.factor [new file with mode: 0644]
extra/cap/summary.txt [new file with mode: 0644]

diff --git a/extra/cap/cap-docs.factor b/extra/cap/cap-docs.factor
new file mode 100644 (file)
index 0000000..909ee85
--- /dev/null
@@ -0,0 +1,15 @@
+USING: cap help.markup help.syntax images opengl ui.gadgets.worlds ;
+IN: cap
+
+HELP: screenshot.
+  { $values { "window" world } }
+  { $description
+    "Opens a window with a screenshot of the currently active window."
+  } ;
+
+HELP: screenshot
+  { $values { "window" world } { "bitmap" image } }
+  { $description
+    "Creates a bitmap image of a UI window."
+  }
+  { $notes "If the current " { $link gl-scale-factor } " is " { $snippet "2.0" } ", then the " { $snippet "2x" } " slot in the resulting " { $link image } " will be " { $link t } "." } ;
\ No newline at end of file
diff --git a/extra/cap/summary.txt b/extra/cap/summary.txt
new file mode 100644 (file)
index 0000000..3246a88
--- /dev/null
@@ -0,0 +1 @@
+Creating and displaying screenshots of Factor
\ No newline at end of file