From 5bb515945d3e77188a796bbef8de411fb8887e62 Mon Sep 17 00:00:00 2001 From: "Martin N." Date: Thu, 15 Jan 2015 00:59:59 +0100 Subject: [PATCH] Adding options to readme --- README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/README.md b/README.md index 975b153..6d3eece 100644 --- a/README.md +++ b/README.md @@ -37,3 +37,14 @@ In addition you can get the Camera, Scene and Renderer: scene = world.getScene(), renderer = world.getRenderer(); ``` + +## Available options + +| Option | Description | Default | +| --- | --- | --- | +| ambientLightColor | Color of the ambient light. Optional. | 0xffffff (white) | +| camDistance | Position on the z-axis where the camera should initially be. Optional. | 100 | +| clearColor | Color that is used to clear the canvas. Optional. | 0 (black) | +| container | Element that the renderer should be appended to. Optional. | document.body | +| farPlane | Maximum distance from the camera that is still rendered. Optional. | 2000 | +| renderCallback | Callback function that is called right before rendering a new frame. Optional | undefined |