aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorxgoff <antipotroast@gmail.com>2012-08-01 23:03:00 -0500
committerxgoff <antipotroast@gmail.com>2012-08-01 23:03:00 -0500
commit5307c4052398ef4dfe85c446a2c70533eb7700f6 (patch)
treef2cc62e7dc90fca2fea634a58c87ea5feadaf4f2
parentb299cfe8bee64d1d299e7382ba854f92fcbdbbc5 (diff)
downloadlove2d-fakecanvas-5307c4052398ef4dfe85c446a2c70533eb7700f6.tar.gz
love2d-fakecanvas-5307c4052398ef4dfe85c446a2c70533eb7700f6.tar.bz2
love2d-fakecanvas-5307c4052398ef4dfe85c446a2c70533eb7700f6.tar.xz
love2d-fakecanvas-5307c4052398ef4dfe85c446a2c70533eb7700f6.zip
slight tweak to readme and its example
-rw-r--r--README.md4
1 files changed, 2 insertions, 2 deletions
diff --git a/README.md b/README.md
index f819b10..33e9963 100644
--- a/README.md
+++ b/README.md
@@ -26,7 +26,7 @@ so, consider this more of a proof-of-concept than as an actual alternative. get
fakecanvas directly replaces some of LÖVE's functions, so there are no special functions you need to use. however, the library itself consists of a couple extra functions:
-* `enable([state])`: control fakecanvas' usage directly by passing the `state` argument, which can be one of:
+* `enable([state])`: control fakecanvas' usage directly by passing the `state` argument. returns the module, for your chaining pleasure. `state` can be one of:
* `true`: force usage of fakecanvas' functions even if real canvases are supported
* `false`: disable canvas functions even if real canvases are supported
* `nil` (or no argument): **default**. fakecanvas will only use its own functions if real canvases are not supported
@@ -38,7 +38,7 @@ fakecanvas directly replaces some of LÖVE's functions, so there are no special
```lua
local c
function love.load ()
- local fc = require 'fakecanvas'
+ local fc = require 'fakecanvas'.enable(true) -- force usage of fake canvases
c = love.graphics.newCanvas(fc.getMaxCanvasSize(256, 256))