Skip to content

Commit

Permalink
Adding options to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
AVGP committed Jan 14, 2015
1 parent 1416f32 commit 5bb5159
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 |

0 comments on commit 5bb5159

Please sign in to comment.