phaser/src/display/canvas/Smoothing.js
2018-03-20 15:58:02 +01:00

126 lines
3.7 KiB
JavaScript

/**
* @author Richard Davey <rich@photonstorm.com>
* @copyright 2018 Photon Storm Ltd.
* @license {@link https://github.com/photonstorm/phaser/blob/master/license.txt|MIT License}
*/
// Browser specific prefix, so not going to change between contexts, only between browsers
var prefix = '';
/**
* @namespace Phaser.Display.Canvas.Smoothing
* @since 3.0.0
*/
var Smoothing = function ()
{
/**
* Gets the Smoothing Enabled vendor prefix being used on the given context, or null if not set.
*
* @function Phaser.Display.Canvas.Smoothing.getPrefix
* @since 3.0.0
*
* @param {(CanvasRenderingContext2D|WebGLRenderingContext)} context - [description]
*
* @return {string} [description]
*/
var getPrefix = function (context)
{
var vendors = [ 'i', 'webkitI', 'msI', 'mozI', 'oI' ];
for (var i = 0; i < vendors.length; i++)
{
var s = vendors[i] + 'mageSmoothingEnabled';
if (s in context)
{
return s;
}
}
return null;
};
/**
* Sets the Image Smoothing property on the given context. Set to false to disable image smoothing.
* By default browsers have image smoothing enabled, which isn't always what you visually want, especially
* when using pixel art in a game. Note that this sets the property on the context itself, so that any image
* drawn to the context will be affected. This sets the property across all current browsers but support is
* patchy on earlier browsers, especially on mobile.
*
* @function Phaser.Display.Canvas.Smoothing.enable
* @since 3.0.0
*
* @param {(CanvasRenderingContext2D|WebGLRenderingContext)} context - [description]
*
* @return {(CanvasRenderingContext2D|WebGLRenderingContext)} [description]
*/
var enable = function (context)
{
if (prefix === '')
{
prefix = getPrefix(context);
}
if (prefix)
{
context[prefix] = true;
}
return context;
};
/**
* Sets the Image Smoothing property on the given context. Set to false to disable image smoothing.
* By default browsers have image smoothing enabled, which isn't always what you visually want, especially
* when using pixel art in a game. Note that this sets the property on the context itself, so that any image
* drawn to the context will be affected. This sets the property across all current browsers but support is
* patchy on earlier browsers, especially on mobile.
*
* @function Phaser.Display.Canvas.Smoothing.disable
* @since 3.0.0
*
* @param {(CanvasRenderingContext2D|WebGLRenderingContext)} context - [description]
*
* @return {(CanvasRenderingContext2D|WebGLRenderingContext)} [description]
*/
var disable = function (context)
{
if (prefix === '')
{
prefix = getPrefix(context);
}
if (prefix)
{
context[prefix] = false;
}
return context;
};
/**
* Returns `true` if the given context has image smoothing enabled, otherwise returns `false`.
* Returns null if no smoothing prefix is available.
*
* @function Phaser.Display.Canvas.Smoothing.isEnabled
* @since 3.0.0
*
* @param {(CanvasRenderingContext2D|WebGLRenderingContext)} context - [description]
*
* @return {?boolean} [description]
*/
var isEnabled = function (context)
{
return (prefix !== null) ? context[prefix] : null;
};
return {
disable: disable,
enable: enable,
getPrefix: getPrefix,
isEnabled: isEnabled
};
};
module.exports = Smoothing();