Skip to content

Commit

Permalink
Website: fix links, remove references to Sampler and Texture2DArray (#…
Browse files Browse the repository at this point in the history
  • Loading branch information
1chandu committed Apr 19, 2019
1 parent ffb004f commit 17b9446
Show file tree
Hide file tree
Showing 8 changed files with 25 additions and 17 deletions.
4 changes: 2 additions & 2 deletions dev-docs/tech-docs-wip/README-WEBGL.md
Expand Up @@ -27,10 +27,10 @@ These objects all inherit from the [`Resource`](resource.html) class.
| [`Shader`](/docs/api-reference/webgl/shader.md) | [`WebGLShader`](https://developer.mozilla.org/en-US/docs/Web/API/WebGLProgram) | Holds a compiled GLSL shader program. |
| [`Texture2D`](/docs/api-reference/webgl/texture-2d.md) | [`WebGLTexture(GL.TEXTURE_2D)`](https://developer.mozilla.org/en-US/docs/Web/API/WebGLTexture) | Holds a loaded texture in a format that supports sampling |
| [`TextureCube`](/docs/api-reference/webgl/texture-cube.md) | [`WebGLTexture(GL.TEXTURE_CUBE)`](https://developer.mozilla.org/en-US/docs/Web/API/WebGLTexture) | Holds 6 textures |
| [`Texture2DArray`](/docs/api-reference/webgl/texture-2d-array.md) **WebGL2** | [`WebGLTexture(GL.TEXTURE_2D_ARRAY)`](https://developer.mozilla.org/en-US/docs/Web/API/WebGLTexture) | Holds an array of textures |
| [`WebGLTexture(GL.TEXTURE_2D_ARRAY)`](https://developer.mozilla.org/en-US/docs/Web/API/WebGLTexture) | Holds an array of textures |
| [`Texture3D`](/docs/api-reference/webgl/texture-3d.md) **WebGL2** | [`WebGLTexture(GL.TEXTURE_3D)`](https://developer.mozilla.org/en-US/docs/Web/API/WebGLTexture) | Holds a stack of textures |
| [`Query`](/docs/api-reference/webgl/query.md) **WebGL2/ext*** | [`WebGLQuery`](https://developer.mozilla.org/en-US/docs/Web/API/WebGLQuery) | Occlusion, Tranform Feedback and Performance Queries |
| [`Sampler`](/docs/api-reference/webgl/sampler.md) **WebGL2** | [`WebGLSampler`](https://developer.mozilla.org/en-US/docs/Web/API/WebGLSampler) | Stores texture sampling params |
| [`WebGLSampler`](https://developer.mozilla.org/en-US/docs/Web/API/WebGLSampler) | Stores texture sampling params |
| [`Sync`](/#/documentation/api-reference/sync) **WebGL2** | [`WebGLSync`](https://developer.mozilla.org/en-US/docs/Web/API/WebGLSync) | Synchronize GPU and app. |
| [`TransformFeedback`](/docs/api-reference/webgl/transform-feedback.md) **WebGL2** | [`WebGLTransformFeedback`](https://developer.mozilla.org/en-US/docs/Web/API/WebGLTransformFeedback) | Capture Vertex Shader output |
| [`VertexArrayObject`](/docs/api-reference/webgl/vertex-array.md) **WebGL2/ext** | [`WebGLVertexArrayObject`](https://developer.mozilla.org/en-US/docs/Web/API/WebGLVertexArrayObject) | Save global vertex attribute array. |
Expand Down
6 changes: 3 additions & 3 deletions docs/api-reference/README.md
Expand Up @@ -15,8 +15,8 @@ luma.gl contains a lot of classes and functions that might make new users wonder

## WebGL Classes

The heart of luma.gl is the `webgl` module, a set of JavaScript class wrappers covering all WebGL objects. From luma.gl v4,
After creating a context, perhaps with luma.gl's [`createGLContext`](/docs/api-reference/webgl/context/context.md) function, you have can start instantiating luma.gl's WebGL2 classes: [`Buffer`](/docs/api-reference/webgl/buffer.md), [`FrameBuffer`](/docs/api-reference/webgl/framebuffer.md), [`RenderBuffer`](/docs/api-reference/webgl/renderbuffer.md), [`Program`](/docs/api-reference/webgl/program.md), [`Shader`](/docs/api-reference/webgl/shader.md), [`Texture2D`](/docs/api-reference/webgl/texture-2d.md), [`Texture2DArray`](/docs/api-reference/webgl/texture-2d-array.md), [`Texture3D`](/docs/api-reference/webgl/texture-3d.md), [`TextureCube`](/docs/api-reference/webgl/texture-cube.md), [`Query`](/docs/api-reference/webgl/query.md), [`Sampler`](/docs/api-reference/webgl/sampler.md), [`TransformFeedback`](/docs/api-reference/webgl/transform-feedback.md), [`VertexArrayObject`](/docs/api-reference/webgl/vertex-array.md)
The heart of luma.gl is the `webgl` module, a set of JavaScript class wrappers covering all WebGL objects. From luma.gl v4,
After creating a context, perhaps with luma.gl's [`createGLContext`](/docs/api-reference/webgl/context/context.md) function, you have can start instantiating luma.gl's WebGL2 classes: [`Buffer`](/docs/api-reference/webgl/buffer.md), [`FrameBuffer`](/docs/api-reference/webgl/framebuffer.md), [`RenderBuffer`](/docs/api-reference/webgl/renderbuffer.md), [`Program`](/docs/api-reference/webgl/program.md), [`Shader`](/docs/api-reference/webgl/shader.md), [`Texture2D`](/docs/api-reference/webgl/texture-2d.md), [`Texture3D`](/docs/api-reference/webgl/texture-3d.md), [`TextureCube`](/docs/api-reference/webgl/texture-cube.md), [`Query`](/docs/api-reference/webgl/query.md), [`TransformFeedback`](/docs/api-reference/webgl/transform-feedback.md), [`VertexArrayObject`](/docs/api-reference/webgl/vertex-array.md)

## Core Classes

Expand All @@ -37,7 +37,7 @@ A `Geometry` object holds a set of attributes (native JavaScript arrays) (vertic

There are several basic geometry classes predefined in luma.gl: `Geometry`, `ConeGeometry`, `CubeGeometry`, `IcoSphereGeometry`, `PlaneGeometry`, `SphereGeometry`, `SphereGeometry`. They are all subclasses of the `Geometry` class.

Corresponding to those geometry objects, luma.gl also provides commonly used [`Model`](/docs/api-reference/core/model.md) classes that consist of basic geometries. These include [`Cone`](/docs/api-reference/core/model.md), [`Cube`](/docs/api-reference/models/cube.md), [`Cylinder`](/docs/api-reference/models/cylinder.md), [`IcoSphere`](/docs/api-reference/models/ico-sphere.md), [`Plane`](/docs/api-reference/models/plane.md) and [`Sphere`](/docs/api-reference/models/sphere.md), etc...
Corresponding to those geometry objects, luma.gl also provides commonly used [`Model`](/docs/api-reference/core/model.md) classes that consist of basic geometries. These include [`Cone`](/docs/api-reference/core/scenegraph/geometries/cone.md), [`Cube`](/docs/api-reference/core/scenegraph/geometries/cube.md), [`Cylinder`](/docs/api-reference/core/scenegraph/geometries/cylinder.md), [`IcoSphere`](/docs/api-reference/core/scenegraph/geometries/ico-sphere.md), [`Plane`](/docs/api-reference/core/scenegraph/geometries/plane.md) and [`Sphere`](/docs/api-reference/core/scenegraph/geometries/sphere.md), etc...


Users are encouraged to write their own geometries and models and luma.gl could include them in its future releases.
2 changes: 1 addition & 1 deletion docs/api-reference/webgl/texture-2d.md
Expand Up @@ -110,4 +110,4 @@ const texture1 = new Texture2D(gl, {data: loadImage(url)});
Notes:
* setting `mipmaps` to true when `format` set to `RGB32F` will fail, even though `RGB32F` is supported texture format (with EXT_color_buffer_float), it is not supported as renderable format.

Note that since many of the constructor parameters are common to all the `Texture` classes they are detailed in [`Texture`](/docs/api-reference/webgl/texture.md). Sampler parameters are specified in [Sampler](/docs/api-reference/webgl/sampler.md), and pixel store parameters are specified in [State Management](/docs/api-reference/webgl/context/get-parameters.md)
Note that since many of the constructor parameters are common to all the `Texture` classes they are detailed in [`Texture`](/docs/api-reference/webgl/texture.md). Pixel store parameters are specified in [State Management](/docs/api-reference/webgl/context/get-parameters.md)
5 changes: 1 addition & 4 deletions docs/api-reference/webgl/texture.md
Expand Up @@ -5,7 +5,6 @@ A `Texture` is a WebGL object that contains one or more images that all have the
Note: This section describes the `Texture` base class that implements functionality common to all four types of WebGL:
* [`Texture2D`](/docs/api-reference/webgl/texture-2d.md) - Contains a "normal" image texture
* [`TextureCube`](/docs/api-reference/webgl/texture-cube.md) - Holds 6 textures representing sides of a cube.
* [`Texture2DArray`](/docs/api-reference/webgl/texture-2d-array.md) (WebGL2) - Holds an array of textures
* [`Texture3D`](/docs/api-reference/webgl/texture-3d.md) (WebGL2) - Holds a "stack" of textures which enables 3D interpolation.

For more details see [OpenGL Wiki](https://www.khronos.org/opengl/wiki/Texture).
Expand Down Expand Up @@ -69,13 +68,11 @@ Sampler parameters can be accessed using `Texture.getParameter`, e.g:

The texture class cannot be constructed directly. It is a base class that provides common methods the the concrete texture classes.
* [`Texture2D`](/docs/api-reference/webgl/texture-2d.md),
* [`TextureCube`](/docs/api-reference/webgl/texture-cube.md),
* [`Texture2DArray`](/docs/api-reference/webgl/texture-2d-array.md) and
* [`TextureCube`](/docs/api-reference/webgl/texture-cube.md) and
* [`Texture3D`](/docs/api-reference/webgl/texture-3d.md).

The constructors for these classes should be used to create textures. They constructors all take common parameters, many of which are specified in this document.

* Sampling parameters are described in [`Sampler`](/docs/api-reference/webgl/sampler.md).
* Pixel store parameters are described in [`State Management`](/docs/api-reference/webgl/context/get-parameters.md).


Expand Down
3 changes: 1 addition & 2 deletions docs/get-started/README.md
Expand Up @@ -31,10 +31,9 @@ The key to luma.gl's interoperability is careful state management. luma.gl will

luma.gl is designed to support isorender application, i.e. the library can be loaded without problems under Node.js, as long as the application doesn't actually try to use WebGL (i.e. create WebGL contexts). However when luma.gl discovers that headless gl is not available it tries to give a helpful message explaining the situation. This can safely be ignored.

Remember that you **can** actually create WebGL contexts under Node.js, as long as the headless `gl` is installed in your `node_modules` directory. More information on [using luma.gl with Node.js](/docs/get-started/using-with-node.md).
Remember that you **can** actually create WebGL contexts under Node.js, as long as the headless `gl` is installed in your `node_modules` directory. More information on [using luma.gl with Node.js](/docs/get-started/README.md).


## FAQ

We occasionally mark github issues that contain answers to questions that pop up repeatedly with the [`FAQ` label](https://github.com/uber/luma.gl/issues?utf8=%E2%9C%93&q=label%3AFAQ+).

2 changes: 1 addition & 1 deletion docs/upgrade-guide.md
Expand Up @@ -381,7 +381,7 @@ v5.3 deprecates a number of symbols. It is recommended that you replace their us

### Running under Node.js

[Using with Node](/docs/get-started/using-with-node.md): `"import luma.gl/headless"` is no longer required for luma.gl to load headless gl and the usage has been deprecated. You can now simply remove any such import statements from your code.
[Using with Node](/docs/get-started/README.md): `"import luma.gl/headless"` is no longer required for luma.gl to load headless gl and the usage has been deprecated. You can now simply remove any such import statements from your code.


### Using Debug Contexts
Expand Down
4 changes: 2 additions & 2 deletions docs/whats-new.md
Expand Up @@ -313,7 +313,7 @@ The impact of importing luma.gl on production application bundle sizes has been

## Running luma.gl in Node.js

Running of luma.gl under Node.js is now easier than ever. luma.gl v5.2 automatically loads headless-gl if installed on the system, avoiding the need for the app to import special files or add other conditional logic. See [Using with Node](/docs/get-started/using-with-node.md) and the Upgrade Guide.
Running of luma.gl under Node.js is now easier than ever. luma.gl v5.2 automatically loads headless-gl if installed on the system, avoiding the need for the app to import special files or add other conditional logic. See [Using with Node](/docs/get-started/README.md) and the Upgrade Guide.


## Debug Mode Changes
Expand Down Expand Up @@ -405,7 +405,7 @@ A major release that brings full WebGL2 support to luma.gl, as well as adding su

luma.gl now exposes the complete WebGL2 APIs:

* New classes expose all the new WebGL2 objects ([`Query`](/docs/api-reference/webgl/query.md), [`Sampler`](/docs/api-reference/webgl/sampler.md), [`Texture2DArray`](/docs/api-reference/webgl/texture-2d-array.md), [`Texture3D`](/docs/api-reference/webgl/texture-3d.md), and [`TransformFeedback`](/docs/api-reference/webgl/transform-feedback.md)), together with a new [`UniformBufferLayout`](/docs/api-reference/webgl/uniform-buffer-layout.md) helper class to make uniform buffers easy to use.
* New classes expose all the new WebGL2 objects ([`Query`](/docs/api-reference/webgl/query.md), [`Texture3D`](/docs/api-reference/webgl/texture-3d.md), and [`TransformFeedback`](/docs/api-reference/webgl/transform-feedback.md)), together with a new [`UniformBufferLayout`](/docs/api-reference/webgl/uniform-buffer-layout.md) helper class to make uniform buffers easy to use.
* Other existing WebGL classes with new functionalites under WebGL2 have been updated.
* Add new WebGL2 texture formats and types support, including floating point textures, and multiple render targets.

Expand Down
16 changes: 14 additions & 2 deletions website/contents/pages.js
Expand Up @@ -388,7 +388,11 @@ export const DOC_PAGES = [
},
{
name: 'loadFile',
content: 'api-reference/core/load-file'
content: 'api-reference/core/load-file.md'
},
{
name: 'Model',
content: 'api-reference/core/model.md'
},
{
name: 'Transform',
Expand Down Expand Up @@ -553,6 +557,10 @@ export const DOC_PAGES = [
name: 'Buffer',
content: 'api-reference/webgl/buffer.md'
},
{
name: 'Framebuffer',
content: 'api-reference/webgl/framebuffer.md'
},
{
name: 'Program',
content: 'api-reference/webgl/program.md'
Expand All @@ -573,6 +581,10 @@ export const DOC_PAGES = [
name: 'Resource',
content: 'api-reference/webgl/resource.md'
},
{
name: 'Sampler',
content: 'api-reference/webgl/shader.md'
},
{
name: 'Shader',
content: 'api-reference/webgl/shader.md'
Expand Down Expand Up @@ -690,7 +702,7 @@ export const DOC_PAGES = [
{
name: 'Development Environment',
content: 'developer-guide/README.md'
},
}
]
}
];

0 comments on commit 17b9446

Please sign in to comment.