lpnf
/
lovr
mirror of https://github.com/bjornbytes/lovr.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Fix typos;

This commit is contained in:
bjorn 2016-10-04 12:16:49 -07:00
parent e2ef9a89ad
commit 8edcd18c52
1 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
doc/API.md
View File

@ -7,14 +7,13 @@
- `renderTo(callback)` - Render to the headset using a function. The callback function will be - `renderTo(callback)` - Render to the headset using a function. The callback function will be
called twice, once for each eye. This function sets the correct transformation and projection called twice, once for each eye. This function sets the correct transformation and projection
matrices before rendering. matrices before rendering.
- `x, y, z = getPosition()` - Get the position of the headset in meters. - `x, y, z = getPosition()` - Get the position of the headset, in meters.
- `angle, axisX, axisY, axisZ = getOrientation()` - Get the orientation of the headset returned in - `angle, axisX, axisY, axisZ = getOrientation()` - Get the orientation of the headset, returned in
angle/axis format (radians). angle/axis format (radians).
- `vx, vy, vz = getVelocity()` - Get the velocity of the headset. - `vx, vy, vz = getVelocity()` - Get the velocity of the headset.
- `x, y, z = getAngularVelocity()` - Get the angular velocity of the headset. - `x, y, z = getAngularVelocity()` - Get the angular velocity of the headset.
`hand` is "left" or "right".
- `setClipDistance(number near, number far)` - Set the clip distance of the virtual camera. - `setClipDistance(number near, number far)` - Set the clip distance of the virtual camera.
- `near, far = getClipDistance()` - Retrieve the clip distance of the virutal camera. - `near, far = getClipDistance()` - Retrieve the clip distance of the virtual camera.
- `width, depth = getTrackingSize()` - Dimensions for the rectangle enclosing the available play - `width, depth = getTrackingSize()` - Dimensions for the rectangle enclosing the available play
area, in meters. area, in meters.
- `isVisible = isBoundsVisible()` - Whether or not the boundary grid is currently visible. - `isVisible = isBoundsVisible()` - Whether or not the boundary grid is currently visible.
@ -23,6 +22,7 @@
Controllers: Controllers:
- `Controller = lovr.headset.getController(string hand)` - Return a controller object for the specified hand. - `Controller = lovr.headset.getController(string hand)` - Return a controller object for the specified hand.
`hand` is "left" or "right".
- `isPresent = Controller:isPresent` - Whether or not the controller is connected and available for - `isPresent = Controller:isPresent` - Whether or not the controller is connected and available for
use. use.
- `x, y, z = Controller:getPosition()` - `x, y, z = Controller:getPosition()`
@ -85,7 +85,7 @@ Shaders:
- `lovrColor` is the color set by `lovr.graphics.setColor`. - `lovrColor` is the color set by `lovr.graphics.setColor`.
- Source for the default shader: - Source for the default shader:
``` ```lua
shader = lovr.graphics.newShader([[ shader = lovr.graphics.newShader([[
void main() { void main() {
gl_Position = lovrProjection * lovrTransform * vec4(position.xyz, 1.0); gl_Position = lovrProjection * lovrTransform * vec4(position.xyz, 1.0);
@ -113,7 +113,7 @@ Buffers:
- `Buffer:setVertex(index, x, y, z)` - Set the value of a vertex. - `Buffer:setVertex(index, x, y, z)` - Set the value of a vertex.
- `Buffer:setVertexMap(map)` - Set the draw order of the vertices. It is possible to re-use - `Buffer:setVertexMap(map)` - Set the draw order of the vertices. It is possible to re-use
indices. indices.
- `Buffer:setDrawRange(start, count)` - Limits the vertices draw to a subset of the total. - `Buffer:setDrawRange(start, count)` - Limits the vertices drawn to a subset of the total.
- `Buffer:getVertexCount()` - Retrieve the number of vertices in the Buffer. - `Buffer:getVertexCount()` - Retrieve the number of vertices in the Buffer.
`lovr.event` `lovr.event`