mirror/openseadragon
1
0
Fork 0
mirror of https://github.com/openseadragon/openseadragon.git synced 2024-11-25 14:46:10 +03:00
Code Issues Projects Releases Wiki Activity

doc tweak for edge smoothing changes - #755

Browse Source
This commit is contained in:
Petar Petrov 2015-11-06 08:55:30 +02:00
parent 7eda39c9a9
commit 8bee1e7b8b
2 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
src/drawer.js
View File

@ -290,8 +290,8 @@ $.Drawer.prototype = /** @lends OpenSeadragon.Drawer.prototype */{
* drawingHandler({context, tile, rendered}) * drawingHandler({context, tile, rendered})
* @param {Boolean} useSketch - Whether to use the sketch canvas or not. * @param {Boolean} useSketch - Whether to use the sketch canvas or not.
* where <code>rendered</code> is the context with the pre-drawn image. * where <code>rendered</code> is the context with the pre-drawn image.
* @param {Float} scale - Apply a scale to tile position and size. Defaults to 1. * @param {Float} [scale=1] - Apply a scale to tile position and size. Defaults to 1.
* @param {OpenSeadragon.Point} translate Optional. A translation vector to offset tile position * @param {OpenSeadragon.Point} [translate] A translation vector to offset tile position
*/ */
drawTile: function( tile, drawingHandler, useSketch, scale, translate ) { drawTile: function( tile, drawingHandler, useSketch, scale, translate ) {
$.console.assert(tile, '[Drawer.drawTile] tile is required'); $.console.assert(tile, '[Drawer.drawTile] tile is required');
@ -374,9 +374,9 @@ $.Drawer.prototype = /** @lends OpenSeadragon.Drawer.prototype */{
/** /**
* Blends the sketch canvas in the main canvas. * Blends the sketch canvas in the main canvas.
* @param {Float} opacity The opacity of the blending. * @param {Float} opacity The opacity of the blending.
* @param {Float} scale The scale at which tiles were drawn on the sketch. Default is 1. * @param {Float} [scale=1] The scale at which tiles were drawn on the sketch. Default is 1.
* Use scale to draw at a lower scale and then enlarge onto the main canvas. * Use scale to draw at a lower scale and then enlarge onto the main canvas.
* @param {OpenSeadragon.Point} translate A translation vector that was used to draw the tiles * @param OpenSeadragon.Point} [translate] A translation vector that was used to draw the tiles
* @returns {undefined} * @returns {undefined}
*/ */
blendSketch: function(opacity, scale, translate) { blendSketch: function(opacity, scale, translate) {

6
src/tile.js
View File

@ -240,8 +240,8 @@ $.Tile.prototype = /** @lends OpenSeadragon.Tile.prototype */{
* @param {Function} drawingHandler - Method for firing the drawing event. * @param {Function} drawingHandler - Method for firing the drawing event.
* drawingHandler({context, tile, rendered}) * drawingHandler({context, tile, rendered})
* where <code>rendered</code> is the context with the pre-drawn image. * where <code>rendered</code> is the context with the pre-drawn image.
* @param {Number} scale - Apply a scale to position and size * @param {Number} [scale=1] - Apply a scale to position and size
* @param {OpenSeadragon.Point} translate - A translation vector * @param {OpenSeadragon.Point} [translate] - A translation vector
*/ */
drawCanvas: function( context, drawingHandler, scale, translate ) { drawCanvas: function( context, drawingHandler, scale, translate ) {
@ -338,7 +338,7 @@ $.Tile.prototype = /** @lends OpenSeadragon.Tile.prototype */{
* Get a translation vector that when applied to the tile position produces integer coordinates. * Get a translation vector that when applied to the tile position produces integer coordinates.
* Needed to avoid swimming and twitching. * Needed to avoid swimming and twitching.
* @function * @function
* @param {Number} scale - Scale to be applied to position. Defaults to 1. * @param {Number} [scale=1] - Scale to be applied to position.
* @return {OpenSeadragon.Point} * @return {OpenSeadragon.Point}
*/ */
getTranslationForEdgeSmoothing: function(scale) { getTranslationForEdgeSmoothing: function(scale) {