From 0189e8345d674a3417c20a4b8d6389c656da3f48 Mon Sep 17 00:00:00 2001 From: Frederic Junod Date: Fri, 16 Nov 2018 12:31:25 +0100 Subject: [PATCH] Remove WebGL references in comments --- doc/tutorials/background.md | 2 +- src/ol/PluggableMap.js | 3 +-- src/ol/interaction/Select.js | 6 ++---- src/ol/interaction/Translate.js | 6 ++---- src/ol/source/CartoDB.js | 5 ++--- src/ol/source/ImageArcGISRest.js | 5 ++--- src/ol/source/ImageMapGuide.js | 5 ++--- src/ol/source/ImageStatic.js | 5 ++--- src/ol/source/ImageWMS.js | 5 ++--- src/ol/source/OSM.js | 5 ++--- src/ol/source/TileArcGISRest.js | 8 +++----- src/ol/source/TileImage.js | 5 ++--- src/ol/source/TileJSON.js | 5 ++--- src/ol/source/TileWMS.js | 5 ++--- src/ol/source/WMTS.js | 5 ++--- src/ol/source/XYZ.js | 5 ++--- src/ol/source/Zoomify.js | 5 ++--- src/ol/style/Icon.js | 2 +- 18 files changed, 34 insertions(+), 53 deletions(-) diff --git a/doc/tutorials/background.md b/doc/tutorials/background.md index 4324c900fe..dfe81e174f 100644 --- a/doc/tutorials/background.md +++ b/doc/tutorials/background.md @@ -17,7 +17,7 @@ OpenLayers is available as [`ol` npm package](https://npmjs.com/package/ol), whi ## 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`. diff --git a/src/ol/PluggableMap.js b/src/ol/PluggableMap.js index b4aa1e6ffb..f33d5bb238 100644 --- a/src/ol/PluggableMap.js +++ b/src/ol/PluggableMap.js @@ -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` * will be tested for features. By default, all visible layers will be tested. * @property {number} [hitTolerance=0] Hit-detection tolerance in pixels. Pixels - * inside the radius around the given position will be checked for features. This only - * works for the canvas renderer and not for WebGL. + * inside the radius around the given position will be checked for features. */ diff --git a/src/ol/interaction/Select.js b/src/ol/interaction/Select.js index 28dcb5ed7b..c037025705 100644 --- a/src/ol/interaction/Select.js +++ b/src/ol/interaction/Select.js @@ -91,8 +91,7 @@ const SelectEventType = { * @property {boolean} [wrapX=true] Wrap the world horizontally on the selection * overlay. * @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 not for WebGL. + * the radius around the given position will be checked for features. */ @@ -314,8 +313,7 @@ class Select extends Interaction { /** * Hit-detection tolerance. Pixels inside the radius around the given position - * will be checked for features. This only works for the canvas renderer and - * not for WebGL. + * will be checked for features. * @param {number} hitTolerance Hit tolerance in pixels. * @api */ diff --git a/src/ol/interaction/Translate.js b/src/ol/interaction/Translate.js index 9d180a5ddd..eb2944aa24 100644 --- a/src/ol/interaction/Translate.js +++ b/src/ol/interaction/Translate.js @@ -46,8 +46,7 @@ const TranslateEventType = { * `true` for layers that you want to be translatable. If the option is * absent, all visible layers will be considered translatable. * @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 - * not for WebGL. + * will be checked for features. */ @@ -267,8 +266,7 @@ class Translate extends PointerInteraction { /** * Hit-detection tolerance. Pixels inside the radius around the given position - * will be checked for features. This only works for the canvas renderer and - * not for WebGL. + * will be checked for features. * @param {number} hitTolerance Hit tolerance in pixels. * @api */ diff --git a/src/ol/source/CartoDB.js b/src/ol/source/CartoDB.js index 313da49e7d..cac2c71099 100644 --- a/src/ol/source/CartoDB.js +++ b/src/ol/source/CartoDB.js @@ -11,9 +11,8 @@ import XYZ from './XYZ.js'; * @property {import("./Source.js").AttributionLike} [attributions] Attributions. * @property {number} [cacheSize=2048] Cache size. * @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. See - * https://developer.mozilla.org/en-US/docs/Web/HTML/CORS_enabled_image for more detail. + * you must provide a `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. * @property {import("../proj.js").ProjectionLike} [projection='EPSG:3857'] Projection. * @property {number} [maxZoom=18] Max zoom. * @property {number} [minZoom] Minimum zoom. diff --git a/src/ol/source/ImageArcGISRest.js b/src/ol/source/ImageArcGISRest.js index efc52c495c..417473451b 100644 --- a/src/ol/source/ImageArcGISRest.js +++ b/src/ol/source/ImageArcGISRest.js @@ -16,9 +16,8 @@ import {appendParams} from '../uri.js'; * @typedef {Object} Options * @property {import("./Source.js").AttributionLike} [attributions] Attributions. * @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. See - * {@link https://developer.mozilla.org/en-US/docs/Web/HTML/CORS_enabled_image} for more detail. + * you must provide a `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. * @property {boolean} [hidpi=true] Use the `ol/Map#pixelRatio` value when requesting the image from * the remote server. * @property {import("../Image.js").LoadFunction} [imageLoadFunction] Optional function to load an image given diff --git a/src/ol/source/ImageMapGuide.js b/src/ol/source/ImageMapGuide.js index dae9163c81..be9e2eb408 100644 --- a/src/ol/source/ImageMapGuide.js +++ b/src/ol/source/ImageMapGuide.js @@ -14,9 +14,8 @@ import {appendParams} from '../uri.js'; * @typedef {Object} Options * @property {string} [url] The mapagent url. * @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. See - * https://developer.mozilla.org/en-US/docs/Web/HTML/CORS_enabled_image for more detail. + * you must provide a `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. * @property {number} [displayDpi=96] The display resolution. * @property {number} [metersPerUnit=1] The meters-per-unit value. * @property {boolean} [hidpi=true] Use the `ol/Map#pixelRatio` value when requesting diff --git a/src/ol/source/ImageStatic.js b/src/ol/source/ImageStatic.js index e5da1cd3e4..824e35c605 100644 --- a/src/ol/source/ImageStatic.js +++ b/src/ol/source/ImageStatic.js @@ -15,9 +15,8 @@ import ImageSource, {defaultImageLoadFunction} from './Image.js'; * @typedef {Object} Options * @property {import("./Source.js").AttributionLike} [attributions] Attributions. * @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. See - * https://developer.mozilla.org/en-US/docs/Web/HTML/CORS_enabled_image for more detail. + * you must provide a `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. * @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. * @property {import("../Image.js").LoadFunction} [imageLoadFunction] Optional function to load an image given a URL. diff --git a/src/ol/source/ImageWMS.js b/src/ol/source/ImageWMS.js index 4d3bfb748e..7e9699c106 100644 --- a/src/ol/source/ImageWMS.js +++ b/src/ol/source/ImageWMS.js @@ -29,9 +29,8 @@ const GETFEATUREINFO_IMAGE_SIZE = [101, 101]; * @typedef {Object} Options * @property {import("./Source.js").AttributionLike} [attributions] Attributions. * @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. See - * https://developer.mozilla.org/en-US/docs/Web/HTML/CORS_enabled_image for more detail. + * you must provide a `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. * @property {boolean} [hidpi=true] Use the `ol/Map#pixelRatio` value when requesting * the image from the remote server. * @property {import("./WMSServerType.js").default|string} [serverType] The type of diff --git a/src/ol/source/OSM.js b/src/ol/source/OSM.js index 3026e01221..f8ea4a341f 100644 --- a/src/ol/source/OSM.js +++ b/src/ol/source/OSM.js @@ -22,9 +22,8 @@ export const ATTRIBUTION = '© ' + * @property {import("./Source.js").AttributionLike} [attributions] Attributions. * @property {number} [cacheSize=2048] Cache size. * @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. See - * https://developer.mozilla.org/en-US/docs/Web/HTML/CORS_enabled_image for more detail. + * you must provide a `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. * @property {number} [maxZoom=19] Max zoom. * @property {boolean} [opaque=true] Whether the layer is opaque. * @property {number} [reprojectionErrorThreshold=1.5] Maximum allowed reprojection error (in pixels). diff --git a/src/ol/source/TileArcGISRest.js b/src/ol/source/TileArcGISRest.js index 66850e5943..5efebdecb8 100644 --- a/src/ol/source/TileArcGISRest.js +++ b/src/ol/source/TileArcGISRest.js @@ -14,11 +14,9 @@ import {appendParams} from '../uri.js'; * @typedef {Object} Options * @property {import("./Source.js").AttributionLike} [attributions] Attributions. * @property {number} [cacheSize=2048] Cache size. - * @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. See - * https://developer.mozilla.org/en-US/docs/Web/HTML/CORS_enabled_image - * for more detail. + * @property {null|string} [crossOrigin] The `crossOrigin` attribute for loaded images. Note that + * you must provide a `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. * @property {Object} [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 * default. `TRANSPARENT` is `true` by default. `BBOX`, `SIZE`, `BBOXSR`, diff --git a/src/ol/source/TileImage.js b/src/ol/source/TileImage.js index 7b7708a5d5..1b329df065 100644 --- a/src/ol/source/TileImage.js +++ b/src/ol/source/TileImage.js @@ -20,9 +20,8 @@ import {getForProjection as getTileGridForProjection} from '../tilegrid.js'; * @property {boolean} [attributionsCollapsible=true] Attributions are collapsible. * @property {number} [cacheSize=2048] Cache size. * @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. See - * https://developer.mozilla.org/en-US/docs/Web/HTML/CORS_enabled_image for more detail. + * you must provide a `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. * @property {boolean} [opaque=true] Whether the layer is opaque. * @property {import("../proj.js").ProjectionLike} projection Projection. * @property {number} [reprojectionErrorThreshold=0.5] Maximum allowed reprojection error (in pixels). diff --git a/src/ol/source/TileJSON.js b/src/ol/source/TileJSON.js index eaa3f89890..537ab94cec 100644 --- a/src/ol/source/TileJSON.js +++ b/src/ol/source/TileJSON.js @@ -41,9 +41,8 @@ import {createXYZ, extentFromProjection} from '../tilegrid.js'; * @property {import("./Source.js").AttributionLike} [attributions] Attributions. * @property {number} [cacheSize=2048] Cache size. * @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. See - * https://developer.mozilla.org/en-US/docs/Web/HTML/CORS_enabled_image for more detail. + * you must provide a `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. * @property {boolean} [jsonp=false] Use JSONP with callback to load the TileJSON. * Useful when the server does not support CORS.. * @property {number} [reprojectionErrorThreshold=0.5] Maximum allowed reprojection error (in pixels). diff --git a/src/ol/source/TileWMS.js b/src/ol/source/TileWMS.js index 6520fe604c..923ca2c900 100644 --- a/src/ol/source/TileWMS.js +++ b/src/ol/source/TileWMS.js @@ -22,9 +22,8 @@ import {appendParams} from '../uri.js'; * @property {import("./Source.js").AttributionLike} [attributions] Attributions. * @property {number} [cacheSize=2048] Cache size. * @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. See - * https://developer.mozilla.org/en-US/docs/Web/HTML/CORS_enabled_image for more detail. + * you must provide a `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. * @property {Object} params WMS request parameters. * At least a `LAYERS` param is required. `STYLES` is * `''` by default. `VERSION` is `1.3.0` by default. `WIDTH`, `HEIGHT`, `BBOX` diff --git a/src/ol/source/WMTS.js b/src/ol/source/WMTS.js index cececef8ad..556649cada 100644 --- a/src/ol/source/WMTS.js +++ b/src/ol/source/WMTS.js @@ -17,9 +17,8 @@ import {appendParams} from '../uri.js'; * @property {import("./Source.js").AttributionLike} [attributions] Attributions. * @property {number} [cacheSize=2048] Cache size. * @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. See - * https://developer.mozilla.org/en-US/docs/Web/HTML/CORS_enabled_image for more detail. + * you must provide a `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. * @property {import("../tilegrid/WMTS.js").default} tileGrid Tile grid. * @property {import("../proj.js").ProjectionLike} projection Projection. * @property {number} [reprojectionErrorThreshold=0.5] Maximum allowed reprojection error (in pixels). diff --git a/src/ol/source/XYZ.js b/src/ol/source/XYZ.js index 4b0c753c3b..d026760cb6 100644 --- a/src/ol/source/XYZ.js +++ b/src/ol/source/XYZ.js @@ -11,9 +11,8 @@ import {createXYZ, extentFromProjection} from '../tilegrid.js'; * @property {boolean} [attributionsCollapsible=true] Attributions are collapsible. * @property {number} [cacheSize=2048] Cache size. * @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. See - * https://developer.mozilla.org/en-US/docs/Web/HTML/CORS_enabled_image for more detail. + * you must provide a `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. * @property {boolean} [opaque=true] Whether the layer is opaque. * @property {import("../proj.js").ProjectionLike} [projection='EPSG:3857'] Projection. * @property {number} [reprojectionErrorThreshold=0.5] Maximum allowed reprojection error (in pixels). diff --git a/src/ol/source/Zoomify.js b/src/ol/source/Zoomify.js index 2941d10877..fb9e536ba6 100644 --- a/src/ol/source/Zoomify.js +++ b/src/ol/source/Zoomify.js @@ -84,9 +84,8 @@ export class CustomTile extends ImageTile { * @property {import("./Source.js").AttributionLike} [attributions] Attributions. * @property {number} [cacheSize=2048] Cache size. * @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. See - * https://developer.mozilla.org/en-US/docs/Web/HTML/CORS_enabled_image for more detail. + * you must provide a `crossOrigin` value 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. * @property {import("../proj.js").ProjectionLike} [projection] Projection. * @property {number} [reprojectionErrorThreshold=0.5] Maximum allowed reprojection error (in pixels). * Higher values can increase reprojection performance, but decrease precision. diff --git a/src/ol/style/Icon.js b/src/ol/style/Icon.js index bd3b161f27..21d5a56c2c 100644 --- a/src/ol/style/Icon.js +++ b/src/ol/style/Icon.js @@ -27,7 +27,7 @@ import ImageStyle from './Image.js'; * @property {import("../color.js").Color|string} [color] Color to tint the icon. If not specified, * the icon will be left as is. * @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. * @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