gl-react/docs/api/README.md
Gaëtan Renaudeau 36a702f2e8 add docs
2015-08-27 14:37:18 +02:00

22 lines
591 B
Markdown

# The API
```js
var GL = require("gl-react-native");
```
## [GL.Shaders.create](Shaders.create.md)
`GL.Shaders.create(spec)` allows to create shaders that can be used later in GL.View component.
## [GL.View](View.md)
`GL.View` is a React Component that renders a given shader with uniforms (parameters to send to the shader).
## [GL.Target](Target.md)
*(advanced)* `GL.Target` allows to render a shader with any content (any React Native component rasterized as a uniform texture).
## [GL.Component](Component.md)
`GL.Component` is the class to extends to implement a GL component.