Remove @api on webgl vector layer renderer as well as utilities
This removes the WebGL vector layer renderer as well as the WebGL helper class from the API.
This commit is contained in:
@@ -89,8 +89,6 @@ import {listen, unlistenByKey} from '../../events.js';
|
|||||||
*
|
*
|
||||||
*
|
*
|
||||||
* This uses {@link module:ol/webgl/Helper~WebGLHelper} internally.
|
* This uses {@link module:ol/webgl/Helper~WebGLHelper} internally.
|
||||||
*
|
|
||||||
* @api
|
|
||||||
*/
|
*/
|
||||||
class WebGLVectorLayerRenderer extends WebGLLayerRenderer {
|
class WebGLVectorLayerRenderer extends WebGLLayerRenderer {
|
||||||
/**
|
/**
|
||||||
|
|||||||
@@ -304,8 +304,6 @@ function releaseCanvas(key) {
|
|||||||
* ```
|
* ```
|
||||||
*
|
*
|
||||||
* For an example usage of this class, refer to {@link module:ol/renderer/webgl/PointsLayer~WebGLPointsLayerRenderer}.
|
* For an example usage of this class, refer to {@link module:ol/renderer/webgl/PointsLayer~WebGLPointsLayerRenderer}.
|
||||||
*
|
|
||||||
* @api
|
|
||||||
*/
|
*/
|
||||||
class WebGLHelper extends Disposable {
|
class WebGLHelper extends Disposable {
|
||||||
/**
|
/**
|
||||||
@@ -486,7 +484,6 @@ class WebGLHelper extends Disposable {
|
|||||||
* the WebGL buffer, bind it, populate it, and add an entry to
|
* the WebGL buffer, bind it, populate it, and add an entry to
|
||||||
* the cache.
|
* the cache.
|
||||||
* @param {import("./Buffer").default} buffer Buffer.
|
* @param {import("./Buffer").default} buffer Buffer.
|
||||||
* @api
|
|
||||||
*/
|
*/
|
||||||
bindBuffer(buffer) {
|
bindBuffer(buffer) {
|
||||||
const gl = this.getGL();
|
const gl = this.getGL();
|
||||||
@@ -507,7 +504,6 @@ class WebGLHelper extends Disposable {
|
|||||||
* Update the data contained in the buffer array; this is required for the
|
* Update the data contained in the buffer array; this is required for the
|
||||||
* new data to be rendered
|
* new data to be rendered
|
||||||
* @param {import("./Buffer").default} buffer Buffer.
|
* @param {import("./Buffer").default} buffer Buffer.
|
||||||
* @api
|
|
||||||
*/
|
*/
|
||||||
flushBufferData(buffer) {
|
flushBufferData(buffer) {
|
||||||
const gl = this.getGL();
|
const gl = this.getGL();
|
||||||
@@ -553,7 +549,6 @@ class WebGLHelper extends Disposable {
|
|||||||
* subsequent draw calls.
|
* subsequent draw calls.
|
||||||
* @param {import("../PluggableMap.js").FrameState} frameState current frame state
|
* @param {import("../PluggableMap.js").FrameState} frameState current frame state
|
||||||
* @param {boolean} [opt_disableAlphaBlend] If true, no alpha blending will happen.
|
* @param {boolean} [opt_disableAlphaBlend] If true, no alpha blending will happen.
|
||||||
* @api
|
|
||||||
*/
|
*/
|
||||||
prepareDraw(frameState, opt_disableAlphaBlend) {
|
prepareDraw(frameState, opt_disableAlphaBlend) {
|
||||||
const gl = this.getGL();
|
const gl = this.getGL();
|
||||||
@@ -611,7 +606,6 @@ class WebGLHelper extends Disposable {
|
|||||||
* Execute a draw call based on the currently bound program, texture, buffers, attributes.
|
* Execute a draw call based on the currently bound program, texture, buffers, attributes.
|
||||||
* @param {number} start Start index.
|
* @param {number} start Start index.
|
||||||
* @param {number} end End index.
|
* @param {number} end End index.
|
||||||
* @api
|
|
||||||
*/
|
*/
|
||||||
drawElements(start, end) {
|
drawElements(start, end) {
|
||||||
const gl = this.getGL();
|
const gl = this.getGL();
|
||||||
@@ -652,7 +646,6 @@ class WebGLHelper extends Disposable {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* @return {HTMLCanvasElement} Canvas.
|
* @return {HTMLCanvasElement} Canvas.
|
||||||
* @api
|
|
||||||
*/
|
*/
|
||||||
getCanvas() {
|
getCanvas() {
|
||||||
return this.canvas_;
|
return this.canvas_;
|
||||||
@@ -661,7 +654,6 @@ class WebGLHelper extends Disposable {
|
|||||||
/**
|
/**
|
||||||
* Get the WebGL rendering context
|
* Get the WebGL rendering context
|
||||||
* @return {WebGLRenderingContext} The rendering context.
|
* @return {WebGLRenderingContext} The rendering context.
|
||||||
* @api
|
|
||||||
*/
|
*/
|
||||||
getGL() {
|
getGL() {
|
||||||
return this.gl_;
|
return this.gl_;
|
||||||
@@ -800,7 +792,6 @@ class WebGLHelper extends Disposable {
|
|||||||
* in the program will be set based on the current frame state and the helper configuration.
|
* in the program will be set based on the current frame state and the helper configuration.
|
||||||
* @param {WebGLProgram} program Program.
|
* @param {WebGLProgram} program Program.
|
||||||
* @param {import("../PluggableMap.js").FrameState} frameState Frame state.
|
* @param {import("../PluggableMap.js").FrameState} frameState Frame state.
|
||||||
* @api
|
|
||||||
*/
|
*/
|
||||||
useProgram(program, frameState) {
|
useProgram(program, frameState) {
|
||||||
const gl = this.getGL();
|
const gl = this.getGL();
|
||||||
@@ -834,7 +825,6 @@ class WebGLHelper extends Disposable {
|
|||||||
* @param {string} fragmentShaderSource Fragment shader source.
|
* @param {string} fragmentShaderSource Fragment shader source.
|
||||||
* @param {string} vertexShaderSource Vertex shader source.
|
* @param {string} vertexShaderSource Vertex shader source.
|
||||||
* @return {WebGLProgram} Program
|
* @return {WebGLProgram} Program
|
||||||
* @api
|
|
||||||
*/
|
*/
|
||||||
getProgram(fragmentShaderSource, vertexShaderSource) {
|
getProgram(fragmentShaderSource, vertexShaderSource) {
|
||||||
const gl = this.getGL();
|
const gl = this.getGL();
|
||||||
@@ -884,7 +874,6 @@ class WebGLHelper extends Disposable {
|
|||||||
* Will get the location from the shader or the cache
|
* Will get the location from the shader or the cache
|
||||||
* @param {string} name Uniform name
|
* @param {string} name Uniform name
|
||||||
* @return {WebGLUniformLocation} uniformLocation
|
* @return {WebGLUniformLocation} uniformLocation
|
||||||
* @api
|
|
||||||
*/
|
*/
|
||||||
getUniformLocation(name) {
|
getUniformLocation(name) {
|
||||||
if (this.uniformLocations_[name] === undefined) {
|
if (this.uniformLocations_[name] === undefined) {
|
||||||
@@ -900,7 +889,6 @@ class WebGLHelper extends Disposable {
|
|||||||
* Will get the location from the shader or the cache
|
* Will get the location from the shader or the cache
|
||||||
* @param {string} name Attribute name
|
* @param {string} name Attribute name
|
||||||
* @return {number} attribLocation
|
* @return {number} attribLocation
|
||||||
* @api
|
|
||||||
*/
|
*/
|
||||||
getAttributeLocation(name) {
|
getAttributeLocation(name) {
|
||||||
if (this.attribLocations_[name] === undefined) {
|
if (this.attribLocations_[name] === undefined) {
|
||||||
@@ -918,7 +906,6 @@ class WebGLHelper extends Disposable {
|
|||||||
* @param {import("../PluggableMap.js").FrameState} frameState Frame state.
|
* @param {import("../PluggableMap.js").FrameState} frameState Frame state.
|
||||||
* @param {import("../transform").Transform} transform Transform to update.
|
* @param {import("../transform").Transform} transform Transform to update.
|
||||||
* @return {import("../transform").Transform} The updated transform object.
|
* @return {import("../transform").Transform} The updated transform object.
|
||||||
* @api
|
|
||||||
*/
|
*/
|
||||||
makeProjectionTransform(frameState, transform) {
|
makeProjectionTransform(frameState, transform) {
|
||||||
const size = frameState.size;
|
const size = frameState.size;
|
||||||
@@ -944,7 +931,6 @@ class WebGLHelper extends Disposable {
|
|||||||
* Give a value for a standard float uniform
|
* Give a value for a standard float uniform
|
||||||
* @param {string} uniform Uniform name
|
* @param {string} uniform Uniform name
|
||||||
* @param {number} value Value
|
* @param {number} value Value
|
||||||
* @api
|
|
||||||
*/
|
*/
|
||||||
setUniformFloatValue(uniform, value) {
|
setUniformFloatValue(uniform, value) {
|
||||||
this.getGL().uniform1f(this.getUniformLocation(uniform), value);
|
this.getGL().uniform1f(this.getUniformLocation(uniform), value);
|
||||||
@@ -972,7 +958,6 @@ class WebGLHelper extends Disposable {
|
|||||||
* Give a value for a standard matrix4 uniform
|
* Give a value for a standard matrix4 uniform
|
||||||
* @param {string} uniform Uniform name
|
* @param {string} uniform Uniform name
|
||||||
* @param {Array<number>} value Matrix value
|
* @param {Array<number>} value Matrix value
|
||||||
* @api
|
|
||||||
*/
|
*/
|
||||||
setUniformMatrixValue(uniform, value) {
|
setUniformMatrixValue(uniform, value) {
|
||||||
this.getGL().uniformMatrix4fv(
|
this.getGL().uniformMatrix4fv(
|
||||||
@@ -1014,7 +999,6 @@ class WebGLHelper extends Disposable {
|
|||||||
* i.e. tell the GPU where to read the different attributes in the buffer. An error in the
|
* i.e. tell the GPU where to read the different attributes in the buffer. An error in the
|
||||||
* size/type/order of attributes will most likely break the rendering and throw a WebGL exception.
|
* size/type/order of attributes will most likely break the rendering and throw a WebGL exception.
|
||||||
* @param {Array<AttributeDescription>} attributes Ordered list of attributes to read from the buffer
|
* @param {Array<AttributeDescription>} attributes Ordered list of attributes to read from the buffer
|
||||||
* @api
|
|
||||||
*/
|
*/
|
||||||
enableAttributes(attributes) {
|
enableAttributes(attributes) {
|
||||||
const stride = computeAttributesStride(attributes);
|
const stride = computeAttributesStride(attributes);
|
||||||
@@ -1056,7 +1040,6 @@ class WebGLHelper extends Disposable {
|
|||||||
* @param {ImageData|HTMLImageElement|HTMLCanvasElement} [opt_data] Image data/object to bind to the texture
|
* @param {ImageData|HTMLImageElement|HTMLCanvasElement} [opt_data] Image data/object to bind to the texture
|
||||||
* @param {WebGLTexture} [opt_texture] Existing texture to reuse
|
* @param {WebGLTexture} [opt_texture] Existing texture to reuse
|
||||||
* @return {WebGLTexture} The generated texture
|
* @return {WebGLTexture} The generated texture
|
||||||
* @api
|
|
||||||
*/
|
*/
|
||||||
createTexture(size, opt_data, opt_texture) {
|
createTexture(size, opt_data, opt_texture) {
|
||||||
const gl = this.getGL();
|
const gl = this.getGL();
|
||||||
@@ -1103,7 +1086,6 @@ class WebGLHelper extends Disposable {
|
|||||||
* Compute a stride in bytes based on a list of attributes
|
* Compute a stride in bytes based on a list of attributes
|
||||||
* @param {Array<AttributeDescription>} attributes Ordered list of attributes
|
* @param {Array<AttributeDescription>} attributes Ordered list of attributes
|
||||||
* @return {number} Stride, ie amount of values for each vertex in the vertex buffer
|
* @return {number} Stride, ie amount of values for each vertex in the vertex buffer
|
||||||
* @api
|
|
||||||
*/
|
*/
|
||||||
export function computeAttributesStride(attributes) {
|
export function computeAttributesStride(attributes) {
|
||||||
let stride = 0;
|
let stride = 0;
|
||||||
|
|||||||
Reference in New Issue
Block a user