Remove WebGL references in comments

This commit is contained in:
Frederic Junod
2018-11-16 12:31:25 +01:00
committed by Olivier Guyot
parent 72cf7b13fa
commit 0189e8345d
18 changed files with 34 additions and 53 deletions

View File

@@ -17,7 +17,7 @@ OpenLayers is available as [`ol` npm package](https://npmjs.com/package/ol), whi
## Renderers and Browser Support ## Renderers and Browser Support
By default, OpenLayers uses a performance optimized Canvas renderer. An experimental WebGL renderer (without text rendering support) is also available. By default, OpenLayers uses a performance optimized Canvas renderer.
OpenLayers runs on all modern browsers that support [HTML5](https://html.spec.whatwg.org/multipage/) and [ECMAScript 5](http://www.ecma-international.org/ecma-262/5.1/). This includes Chrome, Firefox, Safari and Edge. For older browsers and platforms like Internet Explorer (down to version 9) and Android 4.x, [polyfills](http://polyfill.io), the application bundle needs to be transpiled (e.g. using [Babel](https://babeljs.io)) and bundled with polyfills for `requestAnimationFrame`, `Element.prototype.classList` and `URL`. OpenLayers runs on all modern browsers that support [HTML5](https://html.spec.whatwg.org/multipage/) and [ECMAScript 5](http://www.ecma-international.org/ecma-262/5.1/). This includes Chrome, Firefox, Safari and Edge. For older browsers and platforms like Internet Explorer (down to version 9) and Android 4.x, [polyfills](http://polyfill.io), the application bundle needs to be transpiled (e.g. using [Babel](https://babeljs.io)) and bundled with polyfills for `requestAnimationFrame`, `Element.prototype.classList` and `URL`.

View File

@@ -68,8 +68,7 @@ import {create as createTransform, apply as applyTransform} from './transform.js
* Only layers which are visible and for which this function returns `true` * Only layers which are visible and for which this function returns `true`
* will be tested for features. By default, all visible layers will be tested. * will be tested for features. By default, all visible layers will be tested.
* @property {number} [hitTolerance=0] Hit-detection tolerance in pixels. Pixels * @property {number} [hitTolerance=0] Hit-detection tolerance in pixels. Pixels
* inside the radius around the given position will be checked for features. This only * inside the radius around the given position will be checked for features.
* works for the canvas renderer and not for WebGL.
*/ */

View File

@@ -91,8 +91,7 @@ const SelectEventType = {
* @property {boolean} [wrapX=true] Wrap the world horizontally on the selection * @property {boolean} [wrapX=true] Wrap the world horizontally on the selection
* overlay. * overlay.
* @property {number} [hitTolerance=0] Hit-detection tolerance. Pixels inside * @property {number} [hitTolerance=0] Hit-detection tolerance. Pixels inside
* the radius around the given position will be checked for features. This only * the radius around the given position will be checked for features.
* works for the canvas renderer and not for WebGL.
*/ */
@@ -314,8 +313,7 @@ class Select extends Interaction {
/** /**
* Hit-detection tolerance. Pixels inside the radius around the given position * Hit-detection tolerance. Pixels inside the radius around the given position
* will be checked for features. This only works for the canvas renderer and * will be checked for features.
* not for WebGL.
* @param {number} hitTolerance Hit tolerance in pixels. * @param {number} hitTolerance Hit tolerance in pixels.
* @api * @api
*/ */

View File

@@ -46,8 +46,7 @@ const TranslateEventType = {
* `true` for layers that you want to be translatable. If the option is * `true` for layers that you want to be translatable. If the option is
* absent, all visible layers will be considered translatable. * absent, all visible layers will be considered translatable.
* @property {number} [hitTolerance=0] Hit-detection tolerance. Pixels inside the radius around the given position * @property {number} [hitTolerance=0] Hit-detection tolerance. Pixels inside the radius around the given position
* will be checked for features. This only works for the canvas renderer and * will be checked for features.
* not for WebGL.
*/ */
@@ -267,8 +266,7 @@ class Translate extends PointerInteraction {
/** /**
* Hit-detection tolerance. Pixels inside the radius around the given position * Hit-detection tolerance. Pixels inside the radius around the given position
* will be checked for features. This only works for the canvas renderer and * will be checked for features.
* not for WebGL.
* @param {number} hitTolerance Hit tolerance in pixels. * @param {number} hitTolerance Hit tolerance in pixels.
* @api * @api
*/ */

View File

@@ -11,9 +11,8 @@ import XYZ from './XYZ.js';
* @property {import("./Source.js").AttributionLike} [attributions] Attributions. * @property {import("./Source.js").AttributionLike} [attributions] Attributions.
* @property {number} [cacheSize=2048] Cache size. * @property {number} [cacheSize=2048] Cache size.
* @property {null|string} [crossOrigin] The `crossOrigin` attribute for loaded images. Note that * @property {null|string} [crossOrigin] The `crossOrigin` attribute for loaded images. Note that
* you must provide a `crossOrigin` value if you are using the WebGL renderer or if you want to * you must provide a `crossOrigin` value if you want to access pixel data with the Canvas renderer.
* access pixel data with the Canvas renderer. See * See https://developer.mozilla.org/en-US/docs/Web/HTML/CORS_enabled_image for more detail.
* https://developer.mozilla.org/en-US/docs/Web/HTML/CORS_enabled_image for more detail.
* @property {import("../proj.js").ProjectionLike} [projection='EPSG:3857'] Projection. * @property {import("../proj.js").ProjectionLike} [projection='EPSG:3857'] Projection.
* @property {number} [maxZoom=18] Max zoom. * @property {number} [maxZoom=18] Max zoom.
* @property {number} [minZoom] Minimum zoom. * @property {number} [minZoom] Minimum zoom.

View File

@@ -16,9 +16,8 @@ import {appendParams} from '../uri.js';
* @typedef {Object} Options * @typedef {Object} Options
* @property {import("./Source.js").AttributionLike} [attributions] Attributions. * @property {import("./Source.js").AttributionLike} [attributions] Attributions.
* @property {null|string} [crossOrigin] The `crossOrigin` attribute for loaded images. Note that * @property {null|string} [crossOrigin] The `crossOrigin` attribute for loaded images. Note that
* you must provide a `crossOrigin` value if you are using the WebGL renderer or if you want to * you must provide a `crossOrigin` value if you want to access pixel data with the Canvas renderer.
* access pixel data with the Canvas renderer. See * See https://developer.mozilla.org/en-US/docs/Web/HTML/CORS_enabled_image for more detail.
* {@link https://developer.mozilla.org/en-US/docs/Web/HTML/CORS_enabled_image} for more detail.
* @property {boolean} [hidpi=true] Use the `ol/Map#pixelRatio` value when requesting the image from * @property {boolean} [hidpi=true] Use the `ol/Map#pixelRatio` value when requesting the image from
* the remote server. * the remote server.
* @property {import("../Image.js").LoadFunction} [imageLoadFunction] Optional function to load an image given * @property {import("../Image.js").LoadFunction} [imageLoadFunction] Optional function to load an image given

View File

@@ -14,9 +14,8 @@ import {appendParams} from '../uri.js';
* @typedef {Object} Options * @typedef {Object} Options
* @property {string} [url] The mapagent url. * @property {string} [url] The mapagent url.
* @property {null|string} [crossOrigin] The `crossOrigin` attribute for loaded images. Note that * @property {null|string} [crossOrigin] The `crossOrigin` attribute for loaded images. Note that
* you must provide a `crossOrigin` value if you are using the WebGL renderer or if you want to * you must provide a `crossOrigin` value if you want to access pixel data with the Canvas renderer.
* access pixel data with the Canvas renderer. See * See https://developer.mozilla.org/en-US/docs/Web/HTML/CORS_enabled_image for more detail.
* https://developer.mozilla.org/en-US/docs/Web/HTML/CORS_enabled_image for more detail.
* @property {number} [displayDpi=96] The display resolution. * @property {number} [displayDpi=96] The display resolution.
* @property {number} [metersPerUnit=1] The meters-per-unit value. * @property {number} [metersPerUnit=1] The meters-per-unit value.
* @property {boolean} [hidpi=true] Use the `ol/Map#pixelRatio` value when requesting * @property {boolean} [hidpi=true] Use the `ol/Map#pixelRatio` value when requesting

View File

@@ -15,9 +15,8 @@ import ImageSource, {defaultImageLoadFunction} from './Image.js';
* @typedef {Object} Options * @typedef {Object} Options
* @property {import("./Source.js").AttributionLike} [attributions] Attributions. * @property {import("./Source.js").AttributionLike} [attributions] Attributions.
* @property {null|string} [crossOrigin] The `crossOrigin` attribute for loaded images. Note that * @property {null|string} [crossOrigin] The `crossOrigin` attribute for loaded images. Note that
* you must provide a `crossOrigin` value if you are using the WebGL renderer or if you want to * you must provide a `crossOrigin` value if you want to access pixel data with the Canvas renderer.
* access pixel data with the Canvas renderer. See * See https://developer.mozilla.org/en-US/docs/Web/HTML/CORS_enabled_image for more detail.
* https://developer.mozilla.org/en-US/docs/Web/HTML/CORS_enabled_image for more detail.
* @property {import("../extent.js").Extent} [imageExtent] Extent of the image in map coordinates. * @property {import("../extent.js").Extent} [imageExtent] Extent of the image in map coordinates.
* This is the [left, bottom, right, top] map coordinates of your image. * This is the [left, bottom, right, top] map coordinates of your image.
* @property {import("../Image.js").LoadFunction} [imageLoadFunction] Optional function to load an image given a URL. * @property {import("../Image.js").LoadFunction} [imageLoadFunction] Optional function to load an image given a URL.

View File

@@ -29,9 +29,8 @@ const GETFEATUREINFO_IMAGE_SIZE = [101, 101];
* @typedef {Object} Options * @typedef {Object} Options
* @property {import("./Source.js").AttributionLike} [attributions] Attributions. * @property {import("./Source.js").AttributionLike} [attributions] Attributions.
* @property {null|string} [crossOrigin] The `crossOrigin` attribute for loaded images. Note that * @property {null|string} [crossOrigin] The `crossOrigin` attribute for loaded images. Note that
* you must provide a `crossOrigin` value if you are using the WebGL renderer or if you want to * you must provide a `crossOrigin` value if you want to access pixel data with the Canvas renderer.
* access pixel data with the Canvas renderer. See * See https://developer.mozilla.org/en-US/docs/Web/HTML/CORS_enabled_image for more detail.
* https://developer.mozilla.org/en-US/docs/Web/HTML/CORS_enabled_image for more detail.
* @property {boolean} [hidpi=true] Use the `ol/Map#pixelRatio` value when requesting * @property {boolean} [hidpi=true] Use the `ol/Map#pixelRatio` value when requesting
* the image from the remote server. * the image from the remote server.
* @property {import("./WMSServerType.js").default|string} [serverType] The type of * @property {import("./WMSServerType.js").default|string} [serverType] The type of

View File

@@ -22,9 +22,8 @@ export const ATTRIBUTION = '© ' +
* @property {import("./Source.js").AttributionLike} [attributions] Attributions. * @property {import("./Source.js").AttributionLike} [attributions] Attributions.
* @property {number} [cacheSize=2048] Cache size. * @property {number} [cacheSize=2048] Cache size.
* @property {null|string} [crossOrigin] The `crossOrigin` attribute for loaded images. Note that * @property {null|string} [crossOrigin] The `crossOrigin` attribute for loaded images. Note that
* you must provide a `crossOrigin` value if you are using the WebGL renderer or if you want to * you must provide a `crossOrigin` value if you want to access pixel data with the Canvas renderer.
* access pixel data with the Canvas renderer. See * See https://developer.mozilla.org/en-US/docs/Web/HTML/CORS_enabled_image for more detail.
* https://developer.mozilla.org/en-US/docs/Web/HTML/CORS_enabled_image for more detail.
* @property {number} [maxZoom=19] Max zoom. * @property {number} [maxZoom=19] Max zoom.
* @property {boolean} [opaque=true] Whether the layer is opaque. * @property {boolean} [opaque=true] Whether the layer is opaque.
* @property {number} [reprojectionErrorThreshold=1.5] Maximum allowed reprojection error (in pixels). * @property {number} [reprojectionErrorThreshold=1.5] Maximum allowed reprojection error (in pixels).

View File

@@ -14,11 +14,9 @@ import {appendParams} from '../uri.js';
* @typedef {Object} Options * @typedef {Object} Options
* @property {import("./Source.js").AttributionLike} [attributions] Attributions. * @property {import("./Source.js").AttributionLike} [attributions] Attributions.
* @property {number} [cacheSize=2048] Cache size. * @property {number} [cacheSize=2048] Cache size.
* @property {null|string} [crossOrigin] The `crossOrigin` attribute for loaded images. * @property {null|string} [crossOrigin] The `crossOrigin` attribute for loaded images. Note that
* Note that you must provide a `crossOrigin` value if you are using the WebGL renderer * you must provide a `crossOrigin` value if you want to access pixel data with the Canvas renderer.
* or if you want to access pixel data with the Canvas renderer. See * See https://developer.mozilla.org/en-US/docs/Web/HTML/CORS_enabled_image for more detail.
* https://developer.mozilla.org/en-US/docs/Web/HTML/CORS_enabled_image
* for more detail.
* @property {Object<string,*>} [params] ArcGIS Rest parameters. This field is optional. Service defaults will be * @property {Object<string,*>} [params] ArcGIS Rest parameters. This field is optional. Service defaults will be
* used for any fields not specified. `FORMAT` is `PNG32` by default. `F` is `IMAGE` by * used for any fields not specified. `FORMAT` is `PNG32` by default. `F` is `IMAGE` by
* default. `TRANSPARENT` is `true` by default. `BBOX`, `SIZE`, `BBOXSR`, * default. `TRANSPARENT` is `true` by default. `BBOX`, `SIZE`, `BBOXSR`,

View File

@@ -20,9 +20,8 @@ import {getForProjection as getTileGridForProjection} from '../tilegrid.js';
* @property {boolean} [attributionsCollapsible=true] Attributions are collapsible. * @property {boolean} [attributionsCollapsible=true] Attributions are collapsible.
* @property {number} [cacheSize=2048] Cache size. * @property {number} [cacheSize=2048] Cache size.
* @property {null|string} [crossOrigin] The `crossOrigin` attribute for loaded images. Note that * @property {null|string} [crossOrigin] The `crossOrigin` attribute for loaded images. Note that
* you must provide a `crossOrigin` value if you are using the WebGL renderer or if you want to * you must provide a `crossOrigin` value if you want to access pixel data with the Canvas renderer.
* access pixel data with the Canvas renderer. See * See https://developer.mozilla.org/en-US/docs/Web/HTML/CORS_enabled_image for more detail.
* https://developer.mozilla.org/en-US/docs/Web/HTML/CORS_enabled_image for more detail.
* @property {boolean} [opaque=true] Whether the layer is opaque. * @property {boolean} [opaque=true] Whether the layer is opaque.
* @property {import("../proj.js").ProjectionLike} projection Projection. * @property {import("../proj.js").ProjectionLike} projection Projection.
* @property {number} [reprojectionErrorThreshold=0.5] Maximum allowed reprojection error (in pixels). * @property {number} [reprojectionErrorThreshold=0.5] Maximum allowed reprojection error (in pixels).

View File

@@ -41,9 +41,8 @@ import {createXYZ, extentFromProjection} from '../tilegrid.js';
* @property {import("./Source.js").AttributionLike} [attributions] Attributions. * @property {import("./Source.js").AttributionLike} [attributions] Attributions.
* @property {number} [cacheSize=2048] Cache size. * @property {number} [cacheSize=2048] Cache size.
* @property {null|string} [crossOrigin] The `crossOrigin` attribute for loaded images. Note that * @property {null|string} [crossOrigin] The `crossOrigin` attribute for loaded images. Note that
* you must provide a `crossOrigin` value if you are using the WebGL renderer or if you want to * you must provide a `crossOrigin` value if you want to access pixel data with the Canvas renderer.
* access pixel data with the Canvas renderer. See * See https://developer.mozilla.org/en-US/docs/Web/HTML/CORS_enabled_image for more detail.
* https://developer.mozilla.org/en-US/docs/Web/HTML/CORS_enabled_image for more detail.
* @property {boolean} [jsonp=false] Use JSONP with callback to load the TileJSON. * @property {boolean} [jsonp=false] Use JSONP with callback to load the TileJSON.
* Useful when the server does not support CORS.. * Useful when the server does not support CORS..
* @property {number} [reprojectionErrorThreshold=0.5] Maximum allowed reprojection error (in pixels). * @property {number} [reprojectionErrorThreshold=0.5] Maximum allowed reprojection error (in pixels).

View File

@@ -22,9 +22,8 @@ import {appendParams} from '../uri.js';
* @property {import("./Source.js").AttributionLike} [attributions] Attributions. * @property {import("./Source.js").AttributionLike} [attributions] Attributions.
* @property {number} [cacheSize=2048] Cache size. * @property {number} [cacheSize=2048] Cache size.
* @property {null|string} [crossOrigin] The `crossOrigin` attribute for loaded images. Note that * @property {null|string} [crossOrigin] The `crossOrigin` attribute for loaded images. Note that
* you must provide a `crossOrigin` value if you are using the WebGL renderer or if you want to * you must provide a `crossOrigin` value if you want to access pixel data with the Canvas renderer.
* access pixel data with the Canvas renderer. See * See https://developer.mozilla.org/en-US/docs/Web/HTML/CORS_enabled_image for more detail.
* https://developer.mozilla.org/en-US/docs/Web/HTML/CORS_enabled_image for more detail.
* @property {Object<string,*>} params WMS request parameters. * @property {Object<string,*>} params WMS request parameters.
* At least a `LAYERS` param is required. `STYLES` is * At least a `LAYERS` param is required. `STYLES` is
* `''` by default. `VERSION` is `1.3.0` by default. `WIDTH`, `HEIGHT`, `BBOX` * `''` by default. `VERSION` is `1.3.0` by default. `WIDTH`, `HEIGHT`, `BBOX`

View File

@@ -17,9 +17,8 @@ import {appendParams} from '../uri.js';
* @property {import("./Source.js").AttributionLike} [attributions] Attributions. * @property {import("./Source.js").AttributionLike} [attributions] Attributions.
* @property {number} [cacheSize=2048] Cache size. * @property {number} [cacheSize=2048] Cache size.
* @property {null|string} [crossOrigin] The `crossOrigin` attribute for loaded images. Note that * @property {null|string} [crossOrigin] The `crossOrigin` attribute for loaded images. Note that
* you must provide a `crossOrigin` value if you are using the WebGL renderer or if you want to * you must provide a `crossOrigin` value if you want to access pixel data with the Canvas renderer.
* access pixel data with the Canvas renderer. See * See https://developer.mozilla.org/en-US/docs/Web/HTML/CORS_enabled_image for more detail.
* https://developer.mozilla.org/en-US/docs/Web/HTML/CORS_enabled_image for more detail.
* @property {import("../tilegrid/WMTS.js").default} tileGrid Tile grid. * @property {import("../tilegrid/WMTS.js").default} tileGrid Tile grid.
* @property {import("../proj.js").ProjectionLike} projection Projection. * @property {import("../proj.js").ProjectionLike} projection Projection.
* @property {number} [reprojectionErrorThreshold=0.5] Maximum allowed reprojection error (in pixels). * @property {number} [reprojectionErrorThreshold=0.5] Maximum allowed reprojection error (in pixels).

View File

@@ -11,9 +11,8 @@ import {createXYZ, extentFromProjection} from '../tilegrid.js';
* @property {boolean} [attributionsCollapsible=true] Attributions are collapsible. * @property {boolean} [attributionsCollapsible=true] Attributions are collapsible.
* @property {number} [cacheSize=2048] Cache size. * @property {number} [cacheSize=2048] Cache size.
* @property {null|string} [crossOrigin] The `crossOrigin` attribute for loaded images. Note that * @property {null|string} [crossOrigin] The `crossOrigin` attribute for loaded images. Note that
* you must provide a `crossOrigin` value if you are using the WebGL renderer or if you want to * you must provide a `crossOrigin` value if you want to access pixel data with the Canvas renderer.
* access pixel data with the Canvas renderer. See * See https://developer.mozilla.org/en-US/docs/Web/HTML/CORS_enabled_image for more detail.
* https://developer.mozilla.org/en-US/docs/Web/HTML/CORS_enabled_image for more detail.
* @property {boolean} [opaque=true] Whether the layer is opaque. * @property {boolean} [opaque=true] Whether the layer is opaque.
* @property {import("../proj.js").ProjectionLike} [projection='EPSG:3857'] Projection. * @property {import("../proj.js").ProjectionLike} [projection='EPSG:3857'] Projection.
* @property {number} [reprojectionErrorThreshold=0.5] Maximum allowed reprojection error (in pixels). * @property {number} [reprojectionErrorThreshold=0.5] Maximum allowed reprojection error (in pixels).

View File

@@ -84,9 +84,8 @@ export class CustomTile extends ImageTile {
* @property {import("./Source.js").AttributionLike} [attributions] Attributions. * @property {import("./Source.js").AttributionLike} [attributions] Attributions.
* @property {number} [cacheSize=2048] Cache size. * @property {number} [cacheSize=2048] Cache size.
* @property {null|string} [crossOrigin] The `crossOrigin` attribute for loaded images. Note that * @property {null|string} [crossOrigin] The `crossOrigin` attribute for loaded images. Note that
* you must provide a `crossOrigin` value if you are using the WebGL renderer or if you want to * you must provide a `crossOrigin` value you want to access pixel data with the Canvas renderer.
* access pixel data with the Canvas renderer. See * See https://developer.mozilla.org/en-US/docs/Web/HTML/CORS_enabled_image for more detail.
* https://developer.mozilla.org/en-US/docs/Web/HTML/CORS_enabled_image for more detail.
* @property {import("../proj.js").ProjectionLike} [projection] Projection. * @property {import("../proj.js").ProjectionLike} [projection] Projection.
* @property {number} [reprojectionErrorThreshold=0.5] Maximum allowed reprojection error (in pixels). * @property {number} [reprojectionErrorThreshold=0.5] Maximum allowed reprojection error (in pixels).
* Higher values can increase reprojection performance, but decrease precision. * Higher values can increase reprojection performance, but decrease precision.

View File

@@ -27,7 +27,7 @@ import ImageStyle from './Image.js';
* @property {import("../color.js").Color|string} [color] Color to tint the icon. If not specified, * @property {import("../color.js").Color|string} [color] Color to tint the icon. If not specified,
* the icon will be left as is. * the icon will be left as is.
* @property {null|string} [crossOrigin] The `crossOrigin` attribute for loaded images. Note that you must provide a * @property {null|string} [crossOrigin] The `crossOrigin` attribute for loaded images. Note that you must provide a
* `crossOrigin` value if you are using the WebGL renderer or if you want to access pixel data with the Canvas renderer. * `crossOrigin` value if you want to access pixel data with the Canvas renderer.
* See https://developer.mozilla.org/en-US/docs/Web/HTML/CORS_enabled_image for more detail. * See https://developer.mozilla.org/en-US/docs/Web/HTML/CORS_enabled_image for more detail.
* @property {HTMLImageElement|HTMLCanvasElement} [img] Image object for the icon. If the `src` option is not provided then the * @property {HTMLImageElement|HTMLCanvasElement} [img] Image object for the icon. If the `src` option is not provided then the
* provided image must already be loaded. And in that case, it is required * provided image must already be loaded. And in that case, it is required