ansilove.js

commit 12f37aeade1ebfba77279ebda299054bd36e2d4d
parent 0502e5b6fe044c446ba8c78716ea4708e41a5ed2
Author: Andy Herbert <andy.herbert@gmail.com>
Date:   Sat, 12 Oct 2013 13:42:33 +0100

Added documentation for splitRender.

Diffstat:
M
README.md
 | 
10
++++++++++

1 file changed, 10 insertions(+), 0 deletions(-)
diff --git a/README.md b/README.md
@@ -49,6 +49,16 @@ Ansilove.js has been tested on Safari, Firefox, and Chrome. Results may vary wid
         console.log(sauce);
     }, {"font": "80x25", "bits": "8", "icecolors": 0, "columns": 80});
 
+For extremely large files, which may silently fail on some browsers when producing a single canvas element, the `splitRender` function will produce an array of canvas elements, which can then be stacked vertically in the browser to simulate a single, contiguous display. The value of `27` in the following example is the maximum amount of text-rows in used in each element.
+
+    AnsiLove.splitRender("long_ansi.ans", function (canvases, sauce) {
+        canvases.forEach(function (canvas) {
+            document.body.appendChild(canvas);
+        });
+        console.log(sauce);
+    }, 27, {"bits": "8"});
+
+
 ### PC font options: 
 
  - 80x25 (Default, code page 437)