Skip to content

Commit 9f5a801

Browse files
1chandu1chandu
authored
API Audit: remove initWebGLParameters and move pure-js example (visgl#1235)
* Remove initWebGLParameters * Move pure-js example into experimental
1 parent 011b255 commit 9f5a801

33 files changed

Lines changed: 33 additions & 31 deletions

‎docs/api-reference/react/deckgl.md‎

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -122,12 +122,6 @@ Default value is `false`.
122122

123123
Note: debug mode is somewhat slower as it will use synchronous operations to keep track of GPU state.
124124

125-
##### `initWebGLParameters` (Boolean, optional)
126-
127-
Sets WebGL parameters to recommended defaults on initialization, e.g. turning on depth checking. Recommended for most applications. `onWebGLInitialized`, if supplied, will be called after these parameters are set.
128-
129-
Default value is `false` (to ensure backwards compatbility, this will be changed in a future major release).
130-
131125
##### `onWebGLInitialized` (Function, optional)
132126

133127
Callback, called once the WebGL context has been initiated

‎docs/upgrade-guide.md‎

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,22 @@ Following methods and props have been renamed for clarity. The semantics are unc
3434

3535
### Picking Uniforms
3636

37-
The shader uniforms `renderPickingBuffer` and `selectedPickingColor` are deprecated, and will be removed in next major version. The old uniforms are still being set for now, but it is recommended that custom layers that implement picking start using the luma.gl `picking` shader module which automatically sets the required uniforms.
37+
The shader uniforms `renderPickingBuffer`, `pickingEnabled` and `selectedPickingColor` are deprecated, and will be removed in next major version. The old uniforms are still being set for now, but it is recommended that custom layers that implement picking start using the luma.gl `picking` shader module which automatically sets the required uniforms.
38+
39+
40+
### Initial WebGL State
41+
42+
Following WebGL parameters are set during DeckGL component initialization.
43+
44+
| WebGL State | Value |
45+
|---- |---- |
46+
| depthTest | true |
47+
| depthFunc | gl.LEQUAL |
48+
| blendFuncSeparate | [gl.SRC_ALPHA, gl.ONE_MINUS_SRC_ALPHA, gl.ONE, gl.ONE_MINUS_SRC_ALPHA] |
49+
50+
All our layers enable depth test so we are going set this state during initialization. We are also changing blend function for more appropriate rendering when multiple elements are blended.
51+
52+
For any custom needs, these parameters can be overwritten by updating them in [`onWebGLInitialized`](docs/api-reference/react/deckgl.md#onWebGLInitialized) callback or by passing them in `parameters` object to `drawLayer` method of `Layer` class.
3853

3954

4055
## Upgrading from deck.gl v4 to v4.1

‎examples/3d-heatmap/deckgl-overlay.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -123,7 +123,7 @@ export default class DeckGLOverlay extends Component {
123123
})
124124
];
125125

126-
return <DeckGL {...viewport} layers={layers} initWebGLParameters />;
126+
return <DeckGL {...viewport} layers={layers} />;
127127
}
128128
}
129129

‎examples/arc/deckgl-overlay.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,7 @@ export default class DeckGLOverlay extends Component {
111111
];
112112

113113
return (
114-
<DeckGL {...viewport} layers={ layers } initWebGLParameters />
114+
<DeckGL {...viewport} layers={ layers } />
115115
);
116116
}
117117
}

‎examples/brushing/deckgl-overlay.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -196,7 +196,7 @@ export default class DeckGLOverlay extends Component {
196196
];
197197

198198
return (
199-
<DeckGL {...viewport} layers={ layers } initWebGLParameters />
199+
<DeckGL {...viewport} layers={ layers } />
200200
);
201201
}
202202
}

examples/js/carto/README.md renamed to examples/experimental/js/carto/README.md

File renamed without changes.

examples/js/carto/app.js renamed to examples/experimental/js/carto/app.js

File renamed without changes.

examples/js/carto/index.html renamed to examples/experimental/js/carto/index.html

File renamed without changes.

examples/js/carto/package.json renamed to examples/experimental/js/carto/package.json

File renamed without changes.

examples/js/carto/time-sliced-scatterplot-layer/time-sliced-scatterplot-layer-fragment.glsl.js renamed to examples/experimental/js/carto/time-sliced-scatterplot-layer/time-sliced-scatterplot-layer-fragment.glsl.js

File renamed without changes.

0 commit comments

Comments
 (0)