summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorTor Andersson <tor.andersson@artifex.com>2016-07-04 13:38:18 +0200
committerTor Andersson <tor.andersson@artifex.com>2016-07-06 15:45:40 +0200
commit4d13ba9adbe46fc84fea662b906347bfa90ce208 (patch)
tree3cb349e60b97ced79c37fed937787f4a4dc6ab4e /docs
parent7a8be5d456254c6edbf1009a87281c1c963f951a (diff)
downloadmupdf-4d13ba9adbe46fc84fea662b906347bfa90ce208.tar.xz
Add annotations to murun.
Diffstat (limited to 'docs')
-rw-r--r--docs/mutool/run.html20
1 files changed, 17 insertions, 3 deletions
diff --git a/docs/mutool/run.html b/docs/mutool/run.html
index ed1a9707..19433681 100644
--- a/docs/mutool/run.html
+++ b/docs/mutool/run.html
@@ -183,17 +183,31 @@ MuPDF can open many document types (PDF, XPS, CBZ, EPUB, FB2 and a handful of im
<dl>
<dt>Page#bound()
<dd>Returns a rectangle containing the page dimensions.
-<dt>Page#run(device, transform)
+<dt>Page#run(device, transform, skipAnnotations)
<dd>Calls device functions for all the contents on the page, using the specified transform matrix.
The device can be one of the built-in devices or a JavaScript object with methods for the device calls.
The transform maps from user space points to device space pixels.
-<dt>Page#toPixmap(transform, colorspace, alpha)
+If skipAnnotations is true, ignore annotations.
+<dt>Page#toPixmap(transform, colorspace, alpha, skipAnnotations)
<dd>Render the page into a Pixmap, using the transform and colorspace.
If alpha is true, the page will be drawn on a transparent background, otherwise white.
-<dt>Page#toDisplayList()
+<dt>Page#toDisplayList(skipAnnotations)
<dd>Record the contents on the page into a DisplayList.
<dt>Page#search(needle)
<dd>Search for 'needle' text on the page, and return an array with rectangles of all matches found.
+<dt>Page#getAnnotations()
+<dd>Return array of all annotations on the page.
+</dl>
+
+<dl>
+<dt>Annotation#bound()
+<dd>Returns a rectangle containing the location and dimension of the annotation.
+<dt>Annotation#run(device, transform)
+<dd>Calls device functions to draw the annotation.
+<dt>Annotation#toPixmap(transform, colorspace, alpha)
+<dd>Render the annotation into a Pixmap, using the transform and colorspace.
+<dt>Annotation#toDisplayList()
+<dd>Record the contents of the annotation into a DisplayList.
</dl>
<h2>