diff --git a/scripts/jsdoc.conf.json b/scripts/jsdoc.conf.json index 553e61c..3f52180 100644 --- a/scripts/jsdoc.conf.json +++ b/scripts/jsdoc.conf.json @@ -43,7 +43,7 @@ }, "markdown" : { "parser" : "gfm", - "hardwrap" : true + "hardwrap" : false }, "opts": { "encoding" : "utf8", diff --git a/scripts/jsdoc.conf.json b/scripts/jsdoc.conf.json index 553e61c..3f52180 100644 --- a/scripts/jsdoc.conf.json +++ b/scripts/jsdoc.conf.json @@ -43,7 +43,7 @@ }, "markdown" : { "parser" : "gfm", - "hardwrap" : true + "hardwrap" : false }, "opts": { "encoding" : "utf8", diff --git a/src/accessibility/AccessibilityManager.js b/src/accessibility/AccessibilityManager.js index f16bcb1..220427a 100644 --- a/src/accessibility/AccessibilityManager.js +++ b/src/accessibility/AccessibilityManager.js @@ -21,7 +21,7 @@ const DIV_HOOK_ZINDEX = 2; /** - * The Accessibility manager reacreates the ability to tab and and have content read by screen + * The Accessibility manager recreates the ability to tab and and have content read by screen * readers. This is very important as it can possibly help people with disabilities access pixi * content. * diff --git a/scripts/jsdoc.conf.json b/scripts/jsdoc.conf.json index 553e61c..3f52180 100644 --- a/scripts/jsdoc.conf.json +++ b/scripts/jsdoc.conf.json @@ -43,7 +43,7 @@ }, "markdown" : { "parser" : "gfm", - "hardwrap" : true + "hardwrap" : false }, "opts": { "encoding" : "utf8", diff --git a/src/accessibility/AccessibilityManager.js b/src/accessibility/AccessibilityManager.js index f16bcb1..220427a 100644 --- a/src/accessibility/AccessibilityManager.js +++ b/src/accessibility/AccessibilityManager.js @@ -21,7 +21,7 @@ const DIV_HOOK_ZINDEX = 2; /** - * The Accessibility manager reacreates the ability to tab and and have content read by screen + * The Accessibility manager recreates the ability to tab and and have content read by screen * readers. This is very important as it can possibly help people with disabilities access pixi * content. * diff --git a/src/accessibility/index.js b/src/accessibility/index.js index 568cfb1..0ae108f 100644 --- a/src/accessibility/index.js +++ b/src/accessibility/index.js @@ -1,4 +1,9 @@ /** + * This namespace contains a renderer plugin for interaction accessibility for end-users + * with physical impairments which require screen-renders, keyboard navigation, etc. + * + * Do not instantiate this plugin directly. It is available from the `renderer.plugins` property. + * See {@link PIXI.CanvasRenderer#plugins} or {@link PIXI.WebGLRenderer#plugins}. * @namespace PIXI.accessibility */ export { default as accessibleTarget } from './accessibleTarget'; diff --git a/scripts/jsdoc.conf.json b/scripts/jsdoc.conf.json index 553e61c..3f52180 100644 --- a/scripts/jsdoc.conf.json +++ b/scripts/jsdoc.conf.json @@ -43,7 +43,7 @@ }, "markdown" : { "parser" : "gfm", - "hardwrap" : true + "hardwrap" : false }, "opts": { "encoding" : "utf8", diff --git a/src/accessibility/AccessibilityManager.js b/src/accessibility/AccessibilityManager.js index f16bcb1..220427a 100644 --- a/src/accessibility/AccessibilityManager.js +++ b/src/accessibility/AccessibilityManager.js @@ -21,7 +21,7 @@ const DIV_HOOK_ZINDEX = 2; /** - * The Accessibility manager reacreates the ability to tab and and have content read by screen + * The Accessibility manager recreates the ability to tab and and have content read by screen * readers. This is very important as it can possibly help people with disabilities access pixi * content. * diff --git a/src/accessibility/index.js b/src/accessibility/index.js index 568cfb1..0ae108f 100644 --- a/src/accessibility/index.js +++ b/src/accessibility/index.js @@ -1,4 +1,9 @@ /** + * This namespace contains a renderer plugin for interaction accessibility for end-users + * with physical impairments which require screen-renders, keyboard navigation, etc. + * + * Do not instantiate this plugin directly. It is available from the `renderer.plugins` property. + * See {@link PIXI.CanvasRenderer#plugins} or {@link PIXI.WebGLRenderer#plugins}. * @namespace PIXI.accessibility */ export { default as accessibleTarget } from './accessibleTarget'; diff --git a/src/core/renderers/canvas/CanvasRenderer.js b/src/core/renderers/canvas/CanvasRenderer.js index c84ec58..c617dfb 100644 --- a/src/core/renderers/canvas/CanvasRenderer.js +++ b/src/core/renderers/canvas/CanvasRenderer.js @@ -300,4 +300,25 @@ } } +/** + * Collection of installed plugins. These are included by default in PIXI, but can be excluded + * by creating a custom build. Consult the README for more information about creating custom + * builds and excluding plugins. + * @name PIXI.CanvasRenderer#plugins + * @type {object} + * @readonly + * @property {PIXI.accessibility.AccessibilityManager} accessibility Support tabbing interactive elements. + * @property {PIXI.extract.CanvasExtract} extract Extract image data from renderer. + * @property {PIXI.interaction.InteractionManager} interaction Handles mouse, touch and pointer events. + * @property {PIXI.prepare.CanvasPrepare} prepare Pre-render display objects. + */ + +/** + * Adds a plugin to the renderer. + * + * @method PIXI.CanvasRenderer#registerPlugin + * @param {string} pluginName - The name of the plugin. + * @param {Function} ctor - The constructor function or class for the plugin. + */ + pluginTarget.mixin(CanvasRenderer); diff --git a/scripts/jsdoc.conf.json b/scripts/jsdoc.conf.json index 553e61c..3f52180 100644 --- a/scripts/jsdoc.conf.json +++ b/scripts/jsdoc.conf.json @@ -43,7 +43,7 @@ }, "markdown" : { "parser" : "gfm", - "hardwrap" : true + "hardwrap" : false }, "opts": { "encoding" : "utf8", diff --git a/src/accessibility/AccessibilityManager.js b/src/accessibility/AccessibilityManager.js index f16bcb1..220427a 100644 --- a/src/accessibility/AccessibilityManager.js +++ b/src/accessibility/AccessibilityManager.js @@ -21,7 +21,7 @@ const DIV_HOOK_ZINDEX = 2; /** - * The Accessibility manager reacreates the ability to tab and and have content read by screen + * The Accessibility manager recreates the ability to tab and and have content read by screen * readers. This is very important as it can possibly help people with disabilities access pixi * content. * diff --git a/src/accessibility/index.js b/src/accessibility/index.js index 568cfb1..0ae108f 100644 --- a/src/accessibility/index.js +++ b/src/accessibility/index.js @@ -1,4 +1,9 @@ /** + * This namespace contains a renderer plugin for interaction accessibility for end-users + * with physical impairments which require screen-renders, keyboard navigation, etc. + * + * Do not instantiate this plugin directly. It is available from the `renderer.plugins` property. + * See {@link PIXI.CanvasRenderer#plugins} or {@link PIXI.WebGLRenderer#plugins}. * @namespace PIXI.accessibility */ export { default as accessibleTarget } from './accessibleTarget'; diff --git a/src/core/renderers/canvas/CanvasRenderer.js b/src/core/renderers/canvas/CanvasRenderer.js index c84ec58..c617dfb 100644 --- a/src/core/renderers/canvas/CanvasRenderer.js +++ b/src/core/renderers/canvas/CanvasRenderer.js @@ -300,4 +300,25 @@ } } +/** + * Collection of installed plugins. These are included by default in PIXI, but can be excluded + * by creating a custom build. Consult the README for more information about creating custom + * builds and excluding plugins. + * @name PIXI.CanvasRenderer#plugins + * @type {object} + * @readonly + * @property {PIXI.accessibility.AccessibilityManager} accessibility Support tabbing interactive elements. + * @property {PIXI.extract.CanvasExtract} extract Extract image data from renderer. + * @property {PIXI.interaction.InteractionManager} interaction Handles mouse, touch and pointer events. + * @property {PIXI.prepare.CanvasPrepare} prepare Pre-render display objects. + */ + +/** + * Adds a plugin to the renderer. + * + * @method PIXI.CanvasRenderer#registerPlugin + * @param {string} pluginName - The name of the plugin. + * @param {Function} ctor - The constructor function or class for the plugin. + */ + pluginTarget.mixin(CanvasRenderer); diff --git a/src/core/renderers/webgl/WebGLRenderer.js b/src/core/renderers/webgl/WebGLRenderer.js index e807f9f..01f7fd1 100644 --- a/src/core/renderers/webgl/WebGLRenderer.js +++ b/src/core/renderers/webgl/WebGLRenderer.js @@ -707,4 +707,25 @@ } } +/** + * Collection of installed plugins. These are included by default in PIXI, but can be excluded + * by creating a custom build. Consult the README for more information about creating custom + * builds and excluding plugins. + * @name PIXI.WebGLRenderer#plugins + * @type {object} + * @readonly + * @property {PIXI.accessibility.AccessibilityManager} accessibility Support tabbing interactive elements. + * @property {PIXI.extract.WebGLExtract} extract Extract image data from renderer. + * @property {PIXI.interaction.InteractionManager} interaction Handles mouse, touch and pointer events. + * @property {PIXI.prepare.WebGLPrepare} prepare Pre-render display objects. + */ + +/** + * Adds a plugin to the renderer. + * + * @method PIXI.WebGLRenderer#registerPlugin + * @param {string} pluginName - The name of the plugin. + * @param {Function} ctor - The constructor function or class for the plugin. + */ + pluginTarget.mixin(WebGLRenderer); diff --git a/scripts/jsdoc.conf.json b/scripts/jsdoc.conf.json index 553e61c..3f52180 100644 --- a/scripts/jsdoc.conf.json +++ b/scripts/jsdoc.conf.json @@ -43,7 +43,7 @@ }, "markdown" : { "parser" : "gfm", - "hardwrap" : true + "hardwrap" : false }, "opts": { "encoding" : "utf8", diff --git a/src/accessibility/AccessibilityManager.js b/src/accessibility/AccessibilityManager.js index f16bcb1..220427a 100644 --- a/src/accessibility/AccessibilityManager.js +++ b/src/accessibility/AccessibilityManager.js @@ -21,7 +21,7 @@ const DIV_HOOK_ZINDEX = 2; /** - * The Accessibility manager reacreates the ability to tab and and have content read by screen + * The Accessibility manager recreates the ability to tab and and have content read by screen * readers. This is very important as it can possibly help people with disabilities access pixi * content. * diff --git a/src/accessibility/index.js b/src/accessibility/index.js index 568cfb1..0ae108f 100644 --- a/src/accessibility/index.js +++ b/src/accessibility/index.js @@ -1,4 +1,9 @@ /** + * This namespace contains a renderer plugin for interaction accessibility for end-users + * with physical impairments which require screen-renders, keyboard navigation, etc. + * + * Do not instantiate this plugin directly. It is available from the `renderer.plugins` property. + * See {@link PIXI.CanvasRenderer#plugins} or {@link PIXI.WebGLRenderer#plugins}. * @namespace PIXI.accessibility */ export { default as accessibleTarget } from './accessibleTarget'; diff --git a/src/core/renderers/canvas/CanvasRenderer.js b/src/core/renderers/canvas/CanvasRenderer.js index c84ec58..c617dfb 100644 --- a/src/core/renderers/canvas/CanvasRenderer.js +++ b/src/core/renderers/canvas/CanvasRenderer.js @@ -300,4 +300,25 @@ } } +/** + * Collection of installed plugins. These are included by default in PIXI, but can be excluded + * by creating a custom build. Consult the README for more information about creating custom + * builds and excluding plugins. + * @name PIXI.CanvasRenderer#plugins + * @type {object} + * @readonly + * @property {PIXI.accessibility.AccessibilityManager} accessibility Support tabbing interactive elements. + * @property {PIXI.extract.CanvasExtract} extract Extract image data from renderer. + * @property {PIXI.interaction.InteractionManager} interaction Handles mouse, touch and pointer events. + * @property {PIXI.prepare.CanvasPrepare} prepare Pre-render display objects. + */ + +/** + * Adds a plugin to the renderer. + * + * @method PIXI.CanvasRenderer#registerPlugin + * @param {string} pluginName - The name of the plugin. + * @param {Function} ctor - The constructor function or class for the plugin. + */ + pluginTarget.mixin(CanvasRenderer); diff --git a/src/core/renderers/webgl/WebGLRenderer.js b/src/core/renderers/webgl/WebGLRenderer.js index e807f9f..01f7fd1 100644 --- a/src/core/renderers/webgl/WebGLRenderer.js +++ b/src/core/renderers/webgl/WebGLRenderer.js @@ -707,4 +707,25 @@ } } +/** + * Collection of installed plugins. These are included by default in PIXI, but can be excluded + * by creating a custom build. Consult the README for more information about creating custom + * builds and excluding plugins. + * @name PIXI.WebGLRenderer#plugins + * @type {object} + * @readonly + * @property {PIXI.accessibility.AccessibilityManager} accessibility Support tabbing interactive elements. + * @property {PIXI.extract.WebGLExtract} extract Extract image data from renderer. + * @property {PIXI.interaction.InteractionManager} interaction Handles mouse, touch and pointer events. + * @property {PIXI.prepare.WebGLPrepare} prepare Pre-render display objects. + */ + +/** + * Adds a plugin to the renderer. + * + * @method PIXI.WebGLRenderer#registerPlugin + * @param {string} pluginName - The name of the plugin. + * @param {Function} ctor - The constructor function or class for the plugin. + */ + pluginTarget.mixin(WebGLRenderer); diff --git a/src/core/settings.js b/src/core/settings.js index fb92cbe..9e8144d 100644 --- a/src/core/settings.js +++ b/src/core/settings.js @@ -2,6 +2,8 @@ import canUploadSameBuffer from './utils/canUploadSameBuffer'; /** + * User's customizable globals for overriding the default PIXI settings, such + * as a renderer's default resolution, framerate, float percision, etc. * @namespace PIXI.settings */ export default { diff --git a/scripts/jsdoc.conf.json b/scripts/jsdoc.conf.json index 553e61c..3f52180 100644 --- a/scripts/jsdoc.conf.json +++ b/scripts/jsdoc.conf.json @@ -43,7 +43,7 @@ }, "markdown" : { "parser" : "gfm", - "hardwrap" : true + "hardwrap" : false }, "opts": { "encoding" : "utf8", diff --git a/src/accessibility/AccessibilityManager.js b/src/accessibility/AccessibilityManager.js index f16bcb1..220427a 100644 --- a/src/accessibility/AccessibilityManager.js +++ b/src/accessibility/AccessibilityManager.js @@ -21,7 +21,7 @@ const DIV_HOOK_ZINDEX = 2; /** - * The Accessibility manager reacreates the ability to tab and and have content read by screen + * The Accessibility manager recreates the ability to tab and and have content read by screen * readers. This is very important as it can possibly help people with disabilities access pixi * content. * diff --git a/src/accessibility/index.js b/src/accessibility/index.js index 568cfb1..0ae108f 100644 --- a/src/accessibility/index.js +++ b/src/accessibility/index.js @@ -1,4 +1,9 @@ /** + * This namespace contains a renderer plugin for interaction accessibility for end-users + * with physical impairments which require screen-renders, keyboard navigation, etc. + * + * Do not instantiate this plugin directly. It is available from the `renderer.plugins` property. + * See {@link PIXI.CanvasRenderer#plugins} or {@link PIXI.WebGLRenderer#plugins}. * @namespace PIXI.accessibility */ export { default as accessibleTarget } from './accessibleTarget'; diff --git a/src/core/renderers/canvas/CanvasRenderer.js b/src/core/renderers/canvas/CanvasRenderer.js index c84ec58..c617dfb 100644 --- a/src/core/renderers/canvas/CanvasRenderer.js +++ b/src/core/renderers/canvas/CanvasRenderer.js @@ -300,4 +300,25 @@ } } +/** + * Collection of installed plugins. These are included by default in PIXI, but can be excluded + * by creating a custom build. Consult the README for more information about creating custom + * builds and excluding plugins. + * @name PIXI.CanvasRenderer#plugins + * @type {object} + * @readonly + * @property {PIXI.accessibility.AccessibilityManager} accessibility Support tabbing interactive elements. + * @property {PIXI.extract.CanvasExtract} extract Extract image data from renderer. + * @property {PIXI.interaction.InteractionManager} interaction Handles mouse, touch and pointer events. + * @property {PIXI.prepare.CanvasPrepare} prepare Pre-render display objects. + */ + +/** + * Adds a plugin to the renderer. + * + * @method PIXI.CanvasRenderer#registerPlugin + * @param {string} pluginName - The name of the plugin. + * @param {Function} ctor - The constructor function or class for the plugin. + */ + pluginTarget.mixin(CanvasRenderer); diff --git a/src/core/renderers/webgl/WebGLRenderer.js b/src/core/renderers/webgl/WebGLRenderer.js index e807f9f..01f7fd1 100644 --- a/src/core/renderers/webgl/WebGLRenderer.js +++ b/src/core/renderers/webgl/WebGLRenderer.js @@ -707,4 +707,25 @@ } } +/** + * Collection of installed plugins. These are included by default in PIXI, but can be excluded + * by creating a custom build. Consult the README for more information about creating custom + * builds and excluding plugins. + * @name PIXI.WebGLRenderer#plugins + * @type {object} + * @readonly + * @property {PIXI.accessibility.AccessibilityManager} accessibility Support tabbing interactive elements. + * @property {PIXI.extract.WebGLExtract} extract Extract image data from renderer. + * @property {PIXI.interaction.InteractionManager} interaction Handles mouse, touch and pointer events. + * @property {PIXI.prepare.WebGLPrepare} prepare Pre-render display objects. + */ + +/** + * Adds a plugin to the renderer. + * + * @method PIXI.WebGLRenderer#registerPlugin + * @param {string} pluginName - The name of the plugin. + * @param {Function} ctor - The constructor function or class for the plugin. + */ + pluginTarget.mixin(WebGLRenderer); diff --git a/src/core/settings.js b/src/core/settings.js index fb92cbe..9e8144d 100644 --- a/src/core/settings.js +++ b/src/core/settings.js @@ -2,6 +2,8 @@ import canUploadSameBuffer from './utils/canUploadSameBuffer'; /** + * User's customizable globals for overriding the default PIXI settings, such + * as a renderer's default resolution, framerate, float percision, etc. * @namespace PIXI.settings */ export default { diff --git a/src/core/ticker/index.js b/src/core/ticker/index.js index 9ac7173..d4d2f40 100644 --- a/src/core/ticker/index.js +++ b/src/core/ticker/index.js @@ -53,6 +53,10 @@ }; /** + * This namespace contains an API for interacting with PIXI's internal global update loop. + * + * This ticker is used for rendering, {@link PIXI.extras.AnimatedSprite AnimatedSprite}, + * {@link PIXI.interaction.InteractionManager InteractionManager} and many other time-based PIXI systems. * @namespace PIXI.ticker */ export { shared, Ticker }; diff --git a/scripts/jsdoc.conf.json b/scripts/jsdoc.conf.json index 553e61c..3f52180 100644 --- a/scripts/jsdoc.conf.json +++ b/scripts/jsdoc.conf.json @@ -43,7 +43,7 @@ }, "markdown" : { "parser" : "gfm", - "hardwrap" : true + "hardwrap" : false }, "opts": { "encoding" : "utf8", diff --git a/src/accessibility/AccessibilityManager.js b/src/accessibility/AccessibilityManager.js index f16bcb1..220427a 100644 --- a/src/accessibility/AccessibilityManager.js +++ b/src/accessibility/AccessibilityManager.js @@ -21,7 +21,7 @@ const DIV_HOOK_ZINDEX = 2; /** - * The Accessibility manager reacreates the ability to tab and and have content read by screen + * The Accessibility manager recreates the ability to tab and and have content read by screen * readers. This is very important as it can possibly help people with disabilities access pixi * content. * diff --git a/src/accessibility/index.js b/src/accessibility/index.js index 568cfb1..0ae108f 100644 --- a/src/accessibility/index.js +++ b/src/accessibility/index.js @@ -1,4 +1,9 @@ /** + * This namespace contains a renderer plugin for interaction accessibility for end-users + * with physical impairments which require screen-renders, keyboard navigation, etc. + * + * Do not instantiate this plugin directly. It is available from the `renderer.plugins` property. + * See {@link PIXI.CanvasRenderer#plugins} or {@link PIXI.WebGLRenderer#plugins}. * @namespace PIXI.accessibility */ export { default as accessibleTarget } from './accessibleTarget'; diff --git a/src/core/renderers/canvas/CanvasRenderer.js b/src/core/renderers/canvas/CanvasRenderer.js index c84ec58..c617dfb 100644 --- a/src/core/renderers/canvas/CanvasRenderer.js +++ b/src/core/renderers/canvas/CanvasRenderer.js @@ -300,4 +300,25 @@ } } +/** + * Collection of installed plugins. These are included by default in PIXI, but can be excluded + * by creating a custom build. Consult the README for more information about creating custom + * builds and excluding plugins. + * @name PIXI.CanvasRenderer#plugins + * @type {object} + * @readonly + * @property {PIXI.accessibility.AccessibilityManager} accessibility Support tabbing interactive elements. + * @property {PIXI.extract.CanvasExtract} extract Extract image data from renderer. + * @property {PIXI.interaction.InteractionManager} interaction Handles mouse, touch and pointer events. + * @property {PIXI.prepare.CanvasPrepare} prepare Pre-render display objects. + */ + +/** + * Adds a plugin to the renderer. + * + * @method PIXI.CanvasRenderer#registerPlugin + * @param {string} pluginName - The name of the plugin. + * @param {Function} ctor - The constructor function or class for the plugin. + */ + pluginTarget.mixin(CanvasRenderer); diff --git a/src/core/renderers/webgl/WebGLRenderer.js b/src/core/renderers/webgl/WebGLRenderer.js index e807f9f..01f7fd1 100644 --- a/src/core/renderers/webgl/WebGLRenderer.js +++ b/src/core/renderers/webgl/WebGLRenderer.js @@ -707,4 +707,25 @@ } } +/** + * Collection of installed plugins. These are included by default in PIXI, but can be excluded + * by creating a custom build. Consult the README for more information about creating custom + * builds and excluding plugins. + * @name PIXI.WebGLRenderer#plugins + * @type {object} + * @readonly + * @property {PIXI.accessibility.AccessibilityManager} accessibility Support tabbing interactive elements. + * @property {PIXI.extract.WebGLExtract} extract Extract image data from renderer. + * @property {PIXI.interaction.InteractionManager} interaction Handles mouse, touch and pointer events. + * @property {PIXI.prepare.WebGLPrepare} prepare Pre-render display objects. + */ + +/** + * Adds a plugin to the renderer. + * + * @method PIXI.WebGLRenderer#registerPlugin + * @param {string} pluginName - The name of the plugin. + * @param {Function} ctor - The constructor function or class for the plugin. + */ + pluginTarget.mixin(WebGLRenderer); diff --git a/src/core/settings.js b/src/core/settings.js index fb92cbe..9e8144d 100644 --- a/src/core/settings.js +++ b/src/core/settings.js @@ -2,6 +2,8 @@ import canUploadSameBuffer from './utils/canUploadSameBuffer'; /** + * User's customizable globals for overriding the default PIXI settings, such + * as a renderer's default resolution, framerate, float percision, etc. * @namespace PIXI.settings */ export default { diff --git a/src/core/ticker/index.js b/src/core/ticker/index.js index 9ac7173..d4d2f40 100644 --- a/src/core/ticker/index.js +++ b/src/core/ticker/index.js @@ -53,6 +53,10 @@ }; /** + * This namespace contains an API for interacting with PIXI's internal global update loop. + * + * This ticker is used for rendering, {@link PIXI.extras.AnimatedSprite AnimatedSprite}, + * {@link PIXI.interaction.InteractionManager InteractionManager} and many other time-based PIXI systems. * @namespace PIXI.ticker */ export { shared, Ticker }; diff --git a/src/core/utils/index.js b/src/core/utils/index.js index 99e585a..a0db0d9 100644 --- a/src/core/utils/index.js +++ b/src/core/utils/index.js @@ -9,6 +9,7 @@ let saidHello = false; /** + * Generalized convenience utilities for PIXI. * @namespace PIXI.utils */ export { diff --git a/scripts/jsdoc.conf.json b/scripts/jsdoc.conf.json index 553e61c..3f52180 100644 --- a/scripts/jsdoc.conf.json +++ b/scripts/jsdoc.conf.json @@ -43,7 +43,7 @@ }, "markdown" : { "parser" : "gfm", - "hardwrap" : true + "hardwrap" : false }, "opts": { "encoding" : "utf8", diff --git a/src/accessibility/AccessibilityManager.js b/src/accessibility/AccessibilityManager.js index f16bcb1..220427a 100644 --- a/src/accessibility/AccessibilityManager.js +++ b/src/accessibility/AccessibilityManager.js @@ -21,7 +21,7 @@ const DIV_HOOK_ZINDEX = 2; /** - * The Accessibility manager reacreates the ability to tab and and have content read by screen + * The Accessibility manager recreates the ability to tab and and have content read by screen * readers. This is very important as it can possibly help people with disabilities access pixi * content. * diff --git a/src/accessibility/index.js b/src/accessibility/index.js index 568cfb1..0ae108f 100644 --- a/src/accessibility/index.js +++ b/src/accessibility/index.js @@ -1,4 +1,9 @@ /** + * This namespace contains a renderer plugin for interaction accessibility for end-users + * with physical impairments which require screen-renders, keyboard navigation, etc. + * + * Do not instantiate this plugin directly. It is available from the `renderer.plugins` property. + * See {@link PIXI.CanvasRenderer#plugins} or {@link PIXI.WebGLRenderer#plugins}. * @namespace PIXI.accessibility */ export { default as accessibleTarget } from './accessibleTarget'; diff --git a/src/core/renderers/canvas/CanvasRenderer.js b/src/core/renderers/canvas/CanvasRenderer.js index c84ec58..c617dfb 100644 --- a/src/core/renderers/canvas/CanvasRenderer.js +++ b/src/core/renderers/canvas/CanvasRenderer.js @@ -300,4 +300,25 @@ } } +/** + * Collection of installed plugins. These are included by default in PIXI, but can be excluded + * by creating a custom build. Consult the README for more information about creating custom + * builds and excluding plugins. + * @name PIXI.CanvasRenderer#plugins + * @type {object} + * @readonly + * @property {PIXI.accessibility.AccessibilityManager} accessibility Support tabbing interactive elements. + * @property {PIXI.extract.CanvasExtract} extract Extract image data from renderer. + * @property {PIXI.interaction.InteractionManager} interaction Handles mouse, touch and pointer events. + * @property {PIXI.prepare.CanvasPrepare} prepare Pre-render display objects. + */ + +/** + * Adds a plugin to the renderer. + * + * @method PIXI.CanvasRenderer#registerPlugin + * @param {string} pluginName - The name of the plugin. + * @param {Function} ctor - The constructor function or class for the plugin. + */ + pluginTarget.mixin(CanvasRenderer); diff --git a/src/core/renderers/webgl/WebGLRenderer.js b/src/core/renderers/webgl/WebGLRenderer.js index e807f9f..01f7fd1 100644 --- a/src/core/renderers/webgl/WebGLRenderer.js +++ b/src/core/renderers/webgl/WebGLRenderer.js @@ -707,4 +707,25 @@ } } +/** + * Collection of installed plugins. These are included by default in PIXI, but can be excluded + * by creating a custom build. Consult the README for more information about creating custom + * builds and excluding plugins. + * @name PIXI.WebGLRenderer#plugins + * @type {object} + * @readonly + * @property {PIXI.accessibility.AccessibilityManager} accessibility Support tabbing interactive elements. + * @property {PIXI.extract.WebGLExtract} extract Extract image data from renderer. + * @property {PIXI.interaction.InteractionManager} interaction Handles mouse, touch and pointer events. + * @property {PIXI.prepare.WebGLPrepare} prepare Pre-render display objects. + */ + +/** + * Adds a plugin to the renderer. + * + * @method PIXI.WebGLRenderer#registerPlugin + * @param {string} pluginName - The name of the plugin. + * @param {Function} ctor - The constructor function or class for the plugin. + */ + pluginTarget.mixin(WebGLRenderer); diff --git a/src/core/settings.js b/src/core/settings.js index fb92cbe..9e8144d 100644 --- a/src/core/settings.js +++ b/src/core/settings.js @@ -2,6 +2,8 @@ import canUploadSameBuffer from './utils/canUploadSameBuffer'; /** + * User's customizable globals for overriding the default PIXI settings, such + * as a renderer's default resolution, framerate, float percision, etc. * @namespace PIXI.settings */ export default { diff --git a/src/core/ticker/index.js b/src/core/ticker/index.js index 9ac7173..d4d2f40 100644 --- a/src/core/ticker/index.js +++ b/src/core/ticker/index.js @@ -53,6 +53,10 @@ }; /** + * This namespace contains an API for interacting with PIXI's internal global update loop. + * + * This ticker is used for rendering, {@link PIXI.extras.AnimatedSprite AnimatedSprite}, + * {@link PIXI.interaction.InteractionManager InteractionManager} and many other time-based PIXI systems. * @namespace PIXI.ticker */ export { shared, Ticker }; diff --git a/src/core/utils/index.js b/src/core/utils/index.js index 99e585a..a0db0d9 100644 --- a/src/core/utils/index.js +++ b/src/core/utils/index.js @@ -9,6 +9,7 @@ let saidHello = false; /** + * Generalized convenience utilities for PIXI. * @namespace PIXI.utils */ export { diff --git a/src/extract/canvas/CanvasExtract.js b/src/extract/canvas/CanvasExtract.js index 941ca05..3ac5aee 100644 --- a/src/extract/canvas/CanvasExtract.js +++ b/src/extract/canvas/CanvasExtract.js @@ -8,7 +8,7 @@ * An instance of this class is automatically created by default, and can be found at renderer.plugins.extract * * @class - * @memberof PIXI + * @memberof PIXI.extract */ export default class CanvasExtract { @@ -21,9 +21,9 @@ /** * Collection of methods for extracting data (image, pixels, etc.) from a display object or render texture * - * @member {PIXI.CanvasExtract} extract + * @member {PIXI.extract.CanvasExtract} extract * @memberof PIXI.CanvasRenderer# - * @see PIXI.CanvasExtract + * @see PIXI.extract.CanvasExtract */ renderer.extract = this; } diff --git a/scripts/jsdoc.conf.json b/scripts/jsdoc.conf.json index 553e61c..3f52180 100644 --- a/scripts/jsdoc.conf.json +++ b/scripts/jsdoc.conf.json @@ -43,7 +43,7 @@ }, "markdown" : { "parser" : "gfm", - "hardwrap" : true + "hardwrap" : false }, "opts": { "encoding" : "utf8", diff --git a/src/accessibility/AccessibilityManager.js b/src/accessibility/AccessibilityManager.js index f16bcb1..220427a 100644 --- a/src/accessibility/AccessibilityManager.js +++ b/src/accessibility/AccessibilityManager.js @@ -21,7 +21,7 @@ const DIV_HOOK_ZINDEX = 2; /** - * The Accessibility manager reacreates the ability to tab and and have content read by screen + * The Accessibility manager recreates the ability to tab and and have content read by screen * readers. This is very important as it can possibly help people with disabilities access pixi * content. * diff --git a/src/accessibility/index.js b/src/accessibility/index.js index 568cfb1..0ae108f 100644 --- a/src/accessibility/index.js +++ b/src/accessibility/index.js @@ -1,4 +1,9 @@ /** + * This namespace contains a renderer plugin for interaction accessibility for end-users + * with physical impairments which require screen-renders, keyboard navigation, etc. + * + * Do not instantiate this plugin directly. It is available from the `renderer.plugins` property. + * See {@link PIXI.CanvasRenderer#plugins} or {@link PIXI.WebGLRenderer#plugins}. * @namespace PIXI.accessibility */ export { default as accessibleTarget } from './accessibleTarget'; diff --git a/src/core/renderers/canvas/CanvasRenderer.js b/src/core/renderers/canvas/CanvasRenderer.js index c84ec58..c617dfb 100644 --- a/src/core/renderers/canvas/CanvasRenderer.js +++ b/src/core/renderers/canvas/CanvasRenderer.js @@ -300,4 +300,25 @@ } } +/** + * Collection of installed plugins. These are included by default in PIXI, but can be excluded + * by creating a custom build. Consult the README for more information about creating custom + * builds and excluding plugins. + * @name PIXI.CanvasRenderer#plugins + * @type {object} + * @readonly + * @property {PIXI.accessibility.AccessibilityManager} accessibility Support tabbing interactive elements. + * @property {PIXI.extract.CanvasExtract} extract Extract image data from renderer. + * @property {PIXI.interaction.InteractionManager} interaction Handles mouse, touch and pointer events. + * @property {PIXI.prepare.CanvasPrepare} prepare Pre-render display objects. + */ + +/** + * Adds a plugin to the renderer. + * + * @method PIXI.CanvasRenderer#registerPlugin + * @param {string} pluginName - The name of the plugin. + * @param {Function} ctor - The constructor function or class for the plugin. + */ + pluginTarget.mixin(CanvasRenderer); diff --git a/src/core/renderers/webgl/WebGLRenderer.js b/src/core/renderers/webgl/WebGLRenderer.js index e807f9f..01f7fd1 100644 --- a/src/core/renderers/webgl/WebGLRenderer.js +++ b/src/core/renderers/webgl/WebGLRenderer.js @@ -707,4 +707,25 @@ } } +/** + * Collection of installed plugins. These are included by default in PIXI, but can be excluded + * by creating a custom build. Consult the README for more information about creating custom + * builds and excluding plugins. + * @name PIXI.WebGLRenderer#plugins + * @type {object} + * @readonly + * @property {PIXI.accessibility.AccessibilityManager} accessibility Support tabbing interactive elements. + * @property {PIXI.extract.WebGLExtract} extract Extract image data from renderer. + * @property {PIXI.interaction.InteractionManager} interaction Handles mouse, touch and pointer events. + * @property {PIXI.prepare.WebGLPrepare} prepare Pre-render display objects. + */ + +/** + * Adds a plugin to the renderer. + * + * @method PIXI.WebGLRenderer#registerPlugin + * @param {string} pluginName - The name of the plugin. + * @param {Function} ctor - The constructor function or class for the plugin. + */ + pluginTarget.mixin(WebGLRenderer); diff --git a/src/core/settings.js b/src/core/settings.js index fb92cbe..9e8144d 100644 --- a/src/core/settings.js +++ b/src/core/settings.js @@ -2,6 +2,8 @@ import canUploadSameBuffer from './utils/canUploadSameBuffer'; /** + * User's customizable globals for overriding the default PIXI settings, such + * as a renderer's default resolution, framerate, float percision, etc. * @namespace PIXI.settings */ export default { diff --git a/src/core/ticker/index.js b/src/core/ticker/index.js index 9ac7173..d4d2f40 100644 --- a/src/core/ticker/index.js +++ b/src/core/ticker/index.js @@ -53,6 +53,10 @@ }; /** + * This namespace contains an API for interacting with PIXI's internal global update loop. + * + * This ticker is used for rendering, {@link PIXI.extras.AnimatedSprite AnimatedSprite}, + * {@link PIXI.interaction.InteractionManager InteractionManager} and many other time-based PIXI systems. * @namespace PIXI.ticker */ export { shared, Ticker }; diff --git a/src/core/utils/index.js b/src/core/utils/index.js index 99e585a..a0db0d9 100644 --- a/src/core/utils/index.js +++ b/src/core/utils/index.js @@ -9,6 +9,7 @@ let saidHello = false; /** + * Generalized convenience utilities for PIXI. * @namespace PIXI.utils */ export { diff --git a/src/extract/canvas/CanvasExtract.js b/src/extract/canvas/CanvasExtract.js index 941ca05..3ac5aee 100644 --- a/src/extract/canvas/CanvasExtract.js +++ b/src/extract/canvas/CanvasExtract.js @@ -8,7 +8,7 @@ * An instance of this class is automatically created by default, and can be found at renderer.plugins.extract * * @class - * @memberof PIXI + * @memberof PIXI.extract */ export default class CanvasExtract { @@ -21,9 +21,9 @@ /** * Collection of methods for extracting data (image, pixels, etc.) from a display object or render texture * - * @member {PIXI.CanvasExtract} extract + * @member {PIXI.extract.CanvasExtract} extract * @memberof PIXI.CanvasRenderer# - * @see PIXI.CanvasExtract + * @see PIXI.extract.CanvasExtract */ renderer.extract = this; } diff --git a/src/extract/index.js b/src/extract/index.js index 0f2170d..031c859 100644 --- a/src/extract/index.js +++ b/src/extract/index.js @@ -1,2 +1,10 @@ +/** + * This namespace provides renderer-specific plugins for exporting content from a renderer. + * For instance, these plugins can be used for saving an Image, Canvas element or for exporting the raw image data (pixels). + * + * Do not instantiate these plugins directly. It is available from the `renderer.plugins` property. + * See {@link PIXI.CanvasRenderer#plugins} or {@link PIXI.WebGLRenderer#plugins}. + * @namespace PIXI.extract + */ export { default as webgl } from './webgl/WebGLExtract'; export { default as canvas } from './canvas/CanvasExtract'; diff --git a/scripts/jsdoc.conf.json b/scripts/jsdoc.conf.json index 553e61c..3f52180 100644 --- a/scripts/jsdoc.conf.json +++ b/scripts/jsdoc.conf.json @@ -43,7 +43,7 @@ }, "markdown" : { "parser" : "gfm", - "hardwrap" : true + "hardwrap" : false }, "opts": { "encoding" : "utf8", diff --git a/src/accessibility/AccessibilityManager.js b/src/accessibility/AccessibilityManager.js index f16bcb1..220427a 100644 --- a/src/accessibility/AccessibilityManager.js +++ b/src/accessibility/AccessibilityManager.js @@ -21,7 +21,7 @@ const DIV_HOOK_ZINDEX = 2; /** - * The Accessibility manager reacreates the ability to tab and and have content read by screen + * The Accessibility manager recreates the ability to tab and and have content read by screen * readers. This is very important as it can possibly help people with disabilities access pixi * content. * diff --git a/src/accessibility/index.js b/src/accessibility/index.js index 568cfb1..0ae108f 100644 --- a/src/accessibility/index.js +++ b/src/accessibility/index.js @@ -1,4 +1,9 @@ /** + * This namespace contains a renderer plugin for interaction accessibility for end-users + * with physical impairments which require screen-renders, keyboard navigation, etc. + * + * Do not instantiate this plugin directly. It is available from the `renderer.plugins` property. + * See {@link PIXI.CanvasRenderer#plugins} or {@link PIXI.WebGLRenderer#plugins}. * @namespace PIXI.accessibility */ export { default as accessibleTarget } from './accessibleTarget'; diff --git a/src/core/renderers/canvas/CanvasRenderer.js b/src/core/renderers/canvas/CanvasRenderer.js index c84ec58..c617dfb 100644 --- a/src/core/renderers/canvas/CanvasRenderer.js +++ b/src/core/renderers/canvas/CanvasRenderer.js @@ -300,4 +300,25 @@ } } +/** + * Collection of installed plugins. These are included by default in PIXI, but can be excluded + * by creating a custom build. Consult the README for more information about creating custom + * builds and excluding plugins. + * @name PIXI.CanvasRenderer#plugins + * @type {object} + * @readonly + * @property {PIXI.accessibility.AccessibilityManager} accessibility Support tabbing interactive elements. + * @property {PIXI.extract.CanvasExtract} extract Extract image data from renderer. + * @property {PIXI.interaction.InteractionManager} interaction Handles mouse, touch and pointer events. + * @property {PIXI.prepare.CanvasPrepare} prepare Pre-render display objects. + */ + +/** + * Adds a plugin to the renderer. + * + * @method PIXI.CanvasRenderer#registerPlugin + * @param {string} pluginName - The name of the plugin. + * @param {Function} ctor - The constructor function or class for the plugin. + */ + pluginTarget.mixin(CanvasRenderer); diff --git a/src/core/renderers/webgl/WebGLRenderer.js b/src/core/renderers/webgl/WebGLRenderer.js index e807f9f..01f7fd1 100644 --- a/src/core/renderers/webgl/WebGLRenderer.js +++ b/src/core/renderers/webgl/WebGLRenderer.js @@ -707,4 +707,25 @@ } } +/** + * Collection of installed plugins. These are included by default in PIXI, but can be excluded + * by creating a custom build. Consult the README for more information about creating custom + * builds and excluding plugins. + * @name PIXI.WebGLRenderer#plugins + * @type {object} + * @readonly + * @property {PIXI.accessibility.AccessibilityManager} accessibility Support tabbing interactive elements. + * @property {PIXI.extract.WebGLExtract} extract Extract image data from renderer. + * @property {PIXI.interaction.InteractionManager} interaction Handles mouse, touch and pointer events. + * @property {PIXI.prepare.WebGLPrepare} prepare Pre-render display objects. + */ + +/** + * Adds a plugin to the renderer. + * + * @method PIXI.WebGLRenderer#registerPlugin + * @param {string} pluginName - The name of the plugin. + * @param {Function} ctor - The constructor function or class for the plugin. + */ + pluginTarget.mixin(WebGLRenderer); diff --git a/src/core/settings.js b/src/core/settings.js index fb92cbe..9e8144d 100644 --- a/src/core/settings.js +++ b/src/core/settings.js @@ -2,6 +2,8 @@ import canUploadSameBuffer from './utils/canUploadSameBuffer'; /** + * User's customizable globals for overriding the default PIXI settings, such + * as a renderer's default resolution, framerate, float percision, etc. * @namespace PIXI.settings */ export default { diff --git a/src/core/ticker/index.js b/src/core/ticker/index.js index 9ac7173..d4d2f40 100644 --- a/src/core/ticker/index.js +++ b/src/core/ticker/index.js @@ -53,6 +53,10 @@ }; /** + * This namespace contains an API for interacting with PIXI's internal global update loop. + * + * This ticker is used for rendering, {@link PIXI.extras.AnimatedSprite AnimatedSprite}, + * {@link PIXI.interaction.InteractionManager InteractionManager} and many other time-based PIXI systems. * @namespace PIXI.ticker */ export { shared, Ticker }; diff --git a/src/core/utils/index.js b/src/core/utils/index.js index 99e585a..a0db0d9 100644 --- a/src/core/utils/index.js +++ b/src/core/utils/index.js @@ -9,6 +9,7 @@ let saidHello = false; /** + * Generalized convenience utilities for PIXI. * @namespace PIXI.utils */ export { diff --git a/src/extract/canvas/CanvasExtract.js b/src/extract/canvas/CanvasExtract.js index 941ca05..3ac5aee 100644 --- a/src/extract/canvas/CanvasExtract.js +++ b/src/extract/canvas/CanvasExtract.js @@ -8,7 +8,7 @@ * An instance of this class is automatically created by default, and can be found at renderer.plugins.extract * * @class - * @memberof PIXI + * @memberof PIXI.extract */ export default class CanvasExtract { @@ -21,9 +21,9 @@ /** * Collection of methods for extracting data (image, pixels, etc.) from a display object or render texture * - * @member {PIXI.CanvasExtract} extract + * @member {PIXI.extract.CanvasExtract} extract * @memberof PIXI.CanvasRenderer# - * @see PIXI.CanvasExtract + * @see PIXI.extract.CanvasExtract */ renderer.extract = this; } diff --git a/src/extract/index.js b/src/extract/index.js index 0f2170d..031c859 100644 --- a/src/extract/index.js +++ b/src/extract/index.js @@ -1,2 +1,10 @@ +/** + * This namespace provides renderer-specific plugins for exporting content from a renderer. + * For instance, these plugins can be used for saving an Image, Canvas element or for exporting the raw image data (pixels). + * + * Do not instantiate these plugins directly. It is available from the `renderer.plugins` property. + * See {@link PIXI.CanvasRenderer#plugins} or {@link PIXI.WebGLRenderer#plugins}. + * @namespace PIXI.extract + */ export { default as webgl } from './webgl/WebGLExtract'; export { default as canvas } from './canvas/CanvasExtract'; diff --git a/src/extract/webgl/WebGLExtract.js b/src/extract/webgl/WebGLExtract.js index 60228bb..1c3dd30 100644 --- a/src/extract/webgl/WebGLExtract.js +++ b/src/extract/webgl/WebGLExtract.js @@ -9,7 +9,7 @@ * An instance of this class is automatically created by default, and can be found at renderer.plugins.extract * * @class - * @memberof PIXI + * @memberof PIXI.extract */ export default class WebGLExtract { @@ -22,9 +22,9 @@ /** * Collection of methods for extracting data (image, pixels, etc.) from a display object or render texture * - * @member {PIXI.WebGLExtract} extract + * @member {PIXI.extract.WebGLExtract} extract * @memberof PIXI.WebGLRenderer# - * @see PIXI.WebGLExtract + * @see PIXI.extract.WebGLExtract */ renderer.extract = this; } diff --git a/scripts/jsdoc.conf.json b/scripts/jsdoc.conf.json index 553e61c..3f52180 100644 --- a/scripts/jsdoc.conf.json +++ b/scripts/jsdoc.conf.json @@ -43,7 +43,7 @@ }, "markdown" : { "parser" : "gfm", - "hardwrap" : true + "hardwrap" : false }, "opts": { "encoding" : "utf8", diff --git a/src/accessibility/AccessibilityManager.js b/src/accessibility/AccessibilityManager.js index f16bcb1..220427a 100644 --- a/src/accessibility/AccessibilityManager.js +++ b/src/accessibility/AccessibilityManager.js @@ -21,7 +21,7 @@ const DIV_HOOK_ZINDEX = 2; /** - * The Accessibility manager reacreates the ability to tab and and have content read by screen + * The Accessibility manager recreates the ability to tab and and have content read by screen * readers. This is very important as it can possibly help people with disabilities access pixi * content. * diff --git a/src/accessibility/index.js b/src/accessibility/index.js index 568cfb1..0ae108f 100644 --- a/src/accessibility/index.js +++ b/src/accessibility/index.js @@ -1,4 +1,9 @@ /** + * This namespace contains a renderer plugin for interaction accessibility for end-users + * with physical impairments which require screen-renders, keyboard navigation, etc. + * + * Do not instantiate this plugin directly. It is available from the `renderer.plugins` property. + * See {@link PIXI.CanvasRenderer#plugins} or {@link PIXI.WebGLRenderer#plugins}. * @namespace PIXI.accessibility */ export { default as accessibleTarget } from './accessibleTarget'; diff --git a/src/core/renderers/canvas/CanvasRenderer.js b/src/core/renderers/canvas/CanvasRenderer.js index c84ec58..c617dfb 100644 --- a/src/core/renderers/canvas/CanvasRenderer.js +++ b/src/core/renderers/canvas/CanvasRenderer.js @@ -300,4 +300,25 @@ } } +/** + * Collection of installed plugins. These are included by default in PIXI, but can be excluded + * by creating a custom build. Consult the README for more information about creating custom + * builds and excluding plugins. + * @name PIXI.CanvasRenderer#plugins + * @type {object} + * @readonly + * @property {PIXI.accessibility.AccessibilityManager} accessibility Support tabbing interactive elements. + * @property {PIXI.extract.CanvasExtract} extract Extract image data from renderer. + * @property {PIXI.interaction.InteractionManager} interaction Handles mouse, touch and pointer events. + * @property {PIXI.prepare.CanvasPrepare} prepare Pre-render display objects. + */ + +/** + * Adds a plugin to the renderer. + * + * @method PIXI.CanvasRenderer#registerPlugin + * @param {string} pluginName - The name of the plugin. + * @param {Function} ctor - The constructor function or class for the plugin. + */ + pluginTarget.mixin(CanvasRenderer); diff --git a/src/core/renderers/webgl/WebGLRenderer.js b/src/core/renderers/webgl/WebGLRenderer.js index e807f9f..01f7fd1 100644 --- a/src/core/renderers/webgl/WebGLRenderer.js +++ b/src/core/renderers/webgl/WebGLRenderer.js @@ -707,4 +707,25 @@ } } +/** + * Collection of installed plugins. These are included by default in PIXI, but can be excluded + * by creating a custom build. Consult the README for more information about creating custom + * builds and excluding plugins. + * @name PIXI.WebGLRenderer#plugins + * @type {object} + * @readonly + * @property {PIXI.accessibility.AccessibilityManager} accessibility Support tabbing interactive elements. + * @property {PIXI.extract.WebGLExtract} extract Extract image data from renderer. + * @property {PIXI.interaction.InteractionManager} interaction Handles mouse, touch and pointer events. + * @property {PIXI.prepare.WebGLPrepare} prepare Pre-render display objects. + */ + +/** + * Adds a plugin to the renderer. + * + * @method PIXI.WebGLRenderer#registerPlugin + * @param {string} pluginName - The name of the plugin. + * @param {Function} ctor - The constructor function or class for the plugin. + */ + pluginTarget.mixin(WebGLRenderer); diff --git a/src/core/settings.js b/src/core/settings.js index fb92cbe..9e8144d 100644 --- a/src/core/settings.js +++ b/src/core/settings.js @@ -2,6 +2,8 @@ import canUploadSameBuffer from './utils/canUploadSameBuffer'; /** + * User's customizable globals for overriding the default PIXI settings, such + * as a renderer's default resolution, framerate, float percision, etc. * @namespace PIXI.settings */ export default { diff --git a/src/core/ticker/index.js b/src/core/ticker/index.js index 9ac7173..d4d2f40 100644 --- a/src/core/ticker/index.js +++ b/src/core/ticker/index.js @@ -53,6 +53,10 @@ }; /** + * This namespace contains an API for interacting with PIXI's internal global update loop. + * + * This ticker is used for rendering, {@link PIXI.extras.AnimatedSprite AnimatedSprite}, + * {@link PIXI.interaction.InteractionManager InteractionManager} and many other time-based PIXI systems. * @namespace PIXI.ticker */ export { shared, Ticker }; diff --git a/src/core/utils/index.js b/src/core/utils/index.js index 99e585a..a0db0d9 100644 --- a/src/core/utils/index.js +++ b/src/core/utils/index.js @@ -9,6 +9,7 @@ let saidHello = false; /** + * Generalized convenience utilities for PIXI. * @namespace PIXI.utils */ export { diff --git a/src/extract/canvas/CanvasExtract.js b/src/extract/canvas/CanvasExtract.js index 941ca05..3ac5aee 100644 --- a/src/extract/canvas/CanvasExtract.js +++ b/src/extract/canvas/CanvasExtract.js @@ -8,7 +8,7 @@ * An instance of this class is automatically created by default, and can be found at renderer.plugins.extract * * @class - * @memberof PIXI + * @memberof PIXI.extract */ export default class CanvasExtract { @@ -21,9 +21,9 @@ /** * Collection of methods for extracting data (image, pixels, etc.) from a display object or render texture * - * @member {PIXI.CanvasExtract} extract + * @member {PIXI.extract.CanvasExtract} extract * @memberof PIXI.CanvasRenderer# - * @see PIXI.CanvasExtract + * @see PIXI.extract.CanvasExtract */ renderer.extract = this; } diff --git a/src/extract/index.js b/src/extract/index.js index 0f2170d..031c859 100644 --- a/src/extract/index.js +++ b/src/extract/index.js @@ -1,2 +1,10 @@ +/** + * This namespace provides renderer-specific plugins for exporting content from a renderer. + * For instance, these plugins can be used for saving an Image, Canvas element or for exporting the raw image data (pixels). + * + * Do not instantiate these plugins directly. It is available from the `renderer.plugins` property. + * See {@link PIXI.CanvasRenderer#plugins} or {@link PIXI.WebGLRenderer#plugins}. + * @namespace PIXI.extract + */ export { default as webgl } from './webgl/WebGLExtract'; export { default as canvas } from './canvas/CanvasExtract'; diff --git a/src/extract/webgl/WebGLExtract.js b/src/extract/webgl/WebGLExtract.js index 60228bb..1c3dd30 100644 --- a/src/extract/webgl/WebGLExtract.js +++ b/src/extract/webgl/WebGLExtract.js @@ -9,7 +9,7 @@ * An instance of this class is automatically created by default, and can be found at renderer.plugins.extract * * @class - * @memberof PIXI + * @memberof PIXI.extract */ export default class WebGLExtract { @@ -22,9 +22,9 @@ /** * Collection of methods for extracting data (image, pixels, etc.) from a display object or render texture * - * @member {PIXI.WebGLExtract} extract + * @member {PIXI.extract.WebGLExtract} extract * @memberof PIXI.WebGLRenderer# - * @see PIXI.WebGLExtract + * @see PIXI.extract.WebGLExtract */ renderer.extract = this; } diff --git a/src/extras/index.js b/src/extras/index.js index 6e8d039..a34d7ec 100644 --- a/src/extras/index.js +++ b/src/extras/index.js @@ -1,4 +1,5 @@ /** + * Additional PIXI DisplayObjects for animation, tiling and bitmap text. * @namespace PIXI.extras */ export { default as AnimatedSprite } from './AnimatedSprite'; diff --git a/scripts/jsdoc.conf.json b/scripts/jsdoc.conf.json index 553e61c..3f52180 100644 --- a/scripts/jsdoc.conf.json +++ b/scripts/jsdoc.conf.json @@ -43,7 +43,7 @@ }, "markdown" : { "parser" : "gfm", - "hardwrap" : true + "hardwrap" : false }, "opts": { "encoding" : "utf8", diff --git a/src/accessibility/AccessibilityManager.js b/src/accessibility/AccessibilityManager.js index f16bcb1..220427a 100644 --- a/src/accessibility/AccessibilityManager.js +++ b/src/accessibility/AccessibilityManager.js @@ -21,7 +21,7 @@ const DIV_HOOK_ZINDEX = 2; /** - * The Accessibility manager reacreates the ability to tab and and have content read by screen + * The Accessibility manager recreates the ability to tab and and have content read by screen * readers. This is very important as it can possibly help people with disabilities access pixi * content. * diff --git a/src/accessibility/index.js b/src/accessibility/index.js index 568cfb1..0ae108f 100644 --- a/src/accessibility/index.js +++ b/src/accessibility/index.js @@ -1,4 +1,9 @@ /** + * This namespace contains a renderer plugin for interaction accessibility for end-users + * with physical impairments which require screen-renders, keyboard navigation, etc. + * + * Do not instantiate this plugin directly. It is available from the `renderer.plugins` property. + * See {@link PIXI.CanvasRenderer#plugins} or {@link PIXI.WebGLRenderer#plugins}. * @namespace PIXI.accessibility */ export { default as accessibleTarget } from './accessibleTarget'; diff --git a/src/core/renderers/canvas/CanvasRenderer.js b/src/core/renderers/canvas/CanvasRenderer.js index c84ec58..c617dfb 100644 --- a/src/core/renderers/canvas/CanvasRenderer.js +++ b/src/core/renderers/canvas/CanvasRenderer.js @@ -300,4 +300,25 @@ } } +/** + * Collection of installed plugins. These are included by default in PIXI, but can be excluded + * by creating a custom build. Consult the README for more information about creating custom + * builds and excluding plugins. + * @name PIXI.CanvasRenderer#plugins + * @type {object} + * @readonly + * @property {PIXI.accessibility.AccessibilityManager} accessibility Support tabbing interactive elements. + * @property {PIXI.extract.CanvasExtract} extract Extract image data from renderer. + * @property {PIXI.interaction.InteractionManager} interaction Handles mouse, touch and pointer events. + * @property {PIXI.prepare.CanvasPrepare} prepare Pre-render display objects. + */ + +/** + * Adds a plugin to the renderer. + * + * @method PIXI.CanvasRenderer#registerPlugin + * @param {string} pluginName - The name of the plugin. + * @param {Function} ctor - The constructor function or class for the plugin. + */ + pluginTarget.mixin(CanvasRenderer); diff --git a/src/core/renderers/webgl/WebGLRenderer.js b/src/core/renderers/webgl/WebGLRenderer.js index e807f9f..01f7fd1 100644 --- a/src/core/renderers/webgl/WebGLRenderer.js +++ b/src/core/renderers/webgl/WebGLRenderer.js @@ -707,4 +707,25 @@ } } +/** + * Collection of installed plugins. These are included by default in PIXI, but can be excluded + * by creating a custom build. Consult the README for more information about creating custom + * builds and excluding plugins. + * @name PIXI.WebGLRenderer#plugins + * @type {object} + * @readonly + * @property {PIXI.accessibility.AccessibilityManager} accessibility Support tabbing interactive elements. + * @property {PIXI.extract.WebGLExtract} extract Extract image data from renderer. + * @property {PIXI.interaction.InteractionManager} interaction Handles mouse, touch and pointer events. + * @property {PIXI.prepare.WebGLPrepare} prepare Pre-render display objects. + */ + +/** + * Adds a plugin to the renderer. + * + * @method PIXI.WebGLRenderer#registerPlugin + * @param {string} pluginName - The name of the plugin. + * @param {Function} ctor - The constructor function or class for the plugin. + */ + pluginTarget.mixin(WebGLRenderer); diff --git a/src/core/settings.js b/src/core/settings.js index fb92cbe..9e8144d 100644 --- a/src/core/settings.js +++ b/src/core/settings.js @@ -2,6 +2,8 @@ import canUploadSameBuffer from './utils/canUploadSameBuffer'; /** + * User's customizable globals for overriding the default PIXI settings, such + * as a renderer's default resolution, framerate, float percision, etc. * @namespace PIXI.settings */ export default { diff --git a/src/core/ticker/index.js b/src/core/ticker/index.js index 9ac7173..d4d2f40 100644 --- a/src/core/ticker/index.js +++ b/src/core/ticker/index.js @@ -53,6 +53,10 @@ }; /** + * This namespace contains an API for interacting with PIXI's internal global update loop. + * + * This ticker is used for rendering, {@link PIXI.extras.AnimatedSprite AnimatedSprite}, + * {@link PIXI.interaction.InteractionManager InteractionManager} and many other time-based PIXI systems. * @namespace PIXI.ticker */ export { shared, Ticker }; diff --git a/src/core/utils/index.js b/src/core/utils/index.js index 99e585a..a0db0d9 100644 --- a/src/core/utils/index.js +++ b/src/core/utils/index.js @@ -9,6 +9,7 @@ let saidHello = false; /** + * Generalized convenience utilities for PIXI. * @namespace PIXI.utils */ export { diff --git a/src/extract/canvas/CanvasExtract.js b/src/extract/canvas/CanvasExtract.js index 941ca05..3ac5aee 100644 --- a/src/extract/canvas/CanvasExtract.js +++ b/src/extract/canvas/CanvasExtract.js @@ -8,7 +8,7 @@ * An instance of this class is automatically created by default, and can be found at renderer.plugins.extract * * @class - * @memberof PIXI + * @memberof PIXI.extract */ export default class CanvasExtract { @@ -21,9 +21,9 @@ /** * Collection of methods for extracting data (image, pixels, etc.) from a display object or render texture * - * @member {PIXI.CanvasExtract} extract + * @member {PIXI.extract.CanvasExtract} extract * @memberof PIXI.CanvasRenderer# - * @see PIXI.CanvasExtract + * @see PIXI.extract.CanvasExtract */ renderer.extract = this; } diff --git a/src/extract/index.js b/src/extract/index.js index 0f2170d..031c859 100644 --- a/src/extract/index.js +++ b/src/extract/index.js @@ -1,2 +1,10 @@ +/** + * This namespace provides renderer-specific plugins for exporting content from a renderer. + * For instance, these plugins can be used for saving an Image, Canvas element or for exporting the raw image data (pixels). + * + * Do not instantiate these plugins directly. It is available from the `renderer.plugins` property. + * See {@link PIXI.CanvasRenderer#plugins} or {@link PIXI.WebGLRenderer#plugins}. + * @namespace PIXI.extract + */ export { default as webgl } from './webgl/WebGLExtract'; export { default as canvas } from './canvas/CanvasExtract'; diff --git a/src/extract/webgl/WebGLExtract.js b/src/extract/webgl/WebGLExtract.js index 60228bb..1c3dd30 100644 --- a/src/extract/webgl/WebGLExtract.js +++ b/src/extract/webgl/WebGLExtract.js @@ -9,7 +9,7 @@ * An instance of this class is automatically created by default, and can be found at renderer.plugins.extract * * @class - * @memberof PIXI + * @memberof PIXI.extract */ export default class WebGLExtract { @@ -22,9 +22,9 @@ /** * Collection of methods for extracting data (image, pixels, etc.) from a display object or render texture * - * @member {PIXI.WebGLExtract} extract + * @member {PIXI.extract.WebGLExtract} extract * @memberof PIXI.WebGLRenderer# - * @see PIXI.WebGLExtract + * @see PIXI.extract.WebGLExtract */ renderer.extract = this; } diff --git a/src/extras/index.js b/src/extras/index.js index 6e8d039..a34d7ec 100644 --- a/src/extras/index.js +++ b/src/extras/index.js @@ -1,4 +1,5 @@ /** + * Additional PIXI DisplayObjects for animation, tiling and bitmap text. * @namespace PIXI.extras */ export { default as AnimatedSprite } from './AnimatedSprite'; diff --git a/src/filters/index.js b/src/filters/index.js index f3e8862..01f63a2 100644 --- a/src/filters/index.js +++ b/src/filters/index.js @@ -1,4 +1,6 @@ /** + * This namespace contains WebGL-only display filters that can be applied + * to DisplayObjects using the {@link PIXI.DisplayObject#filters filters} property. * @namespace PIXI.filters */ export { default as FXAAFilter } from './fxaa/FXAAFilter'; diff --git a/scripts/jsdoc.conf.json b/scripts/jsdoc.conf.json index 553e61c..3f52180 100644 --- a/scripts/jsdoc.conf.json +++ b/scripts/jsdoc.conf.json @@ -43,7 +43,7 @@ }, "markdown" : { "parser" : "gfm", - "hardwrap" : true + "hardwrap" : false }, "opts": { "encoding" : "utf8", diff --git a/src/accessibility/AccessibilityManager.js b/src/accessibility/AccessibilityManager.js index f16bcb1..220427a 100644 --- a/src/accessibility/AccessibilityManager.js +++ b/src/accessibility/AccessibilityManager.js @@ -21,7 +21,7 @@ const DIV_HOOK_ZINDEX = 2; /** - * The Accessibility manager reacreates the ability to tab and and have content read by screen + * The Accessibility manager recreates the ability to tab and and have content read by screen * readers. This is very important as it can possibly help people with disabilities access pixi * content. * diff --git a/src/accessibility/index.js b/src/accessibility/index.js index 568cfb1..0ae108f 100644 --- a/src/accessibility/index.js +++ b/src/accessibility/index.js @@ -1,4 +1,9 @@ /** + * This namespace contains a renderer plugin for interaction accessibility for end-users + * with physical impairments which require screen-renders, keyboard navigation, etc. + * + * Do not instantiate this plugin directly. It is available from the `renderer.plugins` property. + * See {@link PIXI.CanvasRenderer#plugins} or {@link PIXI.WebGLRenderer#plugins}. * @namespace PIXI.accessibility */ export { default as accessibleTarget } from './accessibleTarget'; diff --git a/src/core/renderers/canvas/CanvasRenderer.js b/src/core/renderers/canvas/CanvasRenderer.js index c84ec58..c617dfb 100644 --- a/src/core/renderers/canvas/CanvasRenderer.js +++ b/src/core/renderers/canvas/CanvasRenderer.js @@ -300,4 +300,25 @@ } } +/** + * Collection of installed plugins. These are included by default in PIXI, but can be excluded + * by creating a custom build. Consult the README for more information about creating custom + * builds and excluding plugins. + * @name PIXI.CanvasRenderer#plugins + * @type {object} + * @readonly + * @property {PIXI.accessibility.AccessibilityManager} accessibility Support tabbing interactive elements. + * @property {PIXI.extract.CanvasExtract} extract Extract image data from renderer. + * @property {PIXI.interaction.InteractionManager} interaction Handles mouse, touch and pointer events. + * @property {PIXI.prepare.CanvasPrepare} prepare Pre-render display objects. + */ + +/** + * Adds a plugin to the renderer. + * + * @method PIXI.CanvasRenderer#registerPlugin + * @param {string} pluginName - The name of the plugin. + * @param {Function} ctor - The constructor function or class for the plugin. + */ + pluginTarget.mixin(CanvasRenderer); diff --git a/src/core/renderers/webgl/WebGLRenderer.js b/src/core/renderers/webgl/WebGLRenderer.js index e807f9f..01f7fd1 100644 --- a/src/core/renderers/webgl/WebGLRenderer.js +++ b/src/core/renderers/webgl/WebGLRenderer.js @@ -707,4 +707,25 @@ } } +/** + * Collection of installed plugins. These are included by default in PIXI, but can be excluded + * by creating a custom build. Consult the README for more information about creating custom + * builds and excluding plugins. + * @name PIXI.WebGLRenderer#plugins + * @type {object} + * @readonly + * @property {PIXI.accessibility.AccessibilityManager} accessibility Support tabbing interactive elements. + * @property {PIXI.extract.WebGLExtract} extract Extract image data from renderer. + * @property {PIXI.interaction.InteractionManager} interaction Handles mouse, touch and pointer events. + * @property {PIXI.prepare.WebGLPrepare} prepare Pre-render display objects. + */ + +/** + * Adds a plugin to the renderer. + * + * @method PIXI.WebGLRenderer#registerPlugin + * @param {string} pluginName - The name of the plugin. + * @param {Function} ctor - The constructor function or class for the plugin. + */ + pluginTarget.mixin(WebGLRenderer); diff --git a/src/core/settings.js b/src/core/settings.js index fb92cbe..9e8144d 100644 --- a/src/core/settings.js +++ b/src/core/settings.js @@ -2,6 +2,8 @@ import canUploadSameBuffer from './utils/canUploadSameBuffer'; /** + * User's customizable globals for overriding the default PIXI settings, such + * as a renderer's default resolution, framerate, float percision, etc. * @namespace PIXI.settings */ export default { diff --git a/src/core/ticker/index.js b/src/core/ticker/index.js index 9ac7173..d4d2f40 100644 --- a/src/core/ticker/index.js +++ b/src/core/ticker/index.js @@ -53,6 +53,10 @@ }; /** + * This namespace contains an API for interacting with PIXI's internal global update loop. + * + * This ticker is used for rendering, {@link PIXI.extras.AnimatedSprite AnimatedSprite}, + * {@link PIXI.interaction.InteractionManager InteractionManager} and many other time-based PIXI systems. * @namespace PIXI.ticker */ export { shared, Ticker }; diff --git a/src/core/utils/index.js b/src/core/utils/index.js index 99e585a..a0db0d9 100644 --- a/src/core/utils/index.js +++ b/src/core/utils/index.js @@ -9,6 +9,7 @@ let saidHello = false; /** + * Generalized convenience utilities for PIXI. * @namespace PIXI.utils */ export { diff --git a/src/extract/canvas/CanvasExtract.js b/src/extract/canvas/CanvasExtract.js index 941ca05..3ac5aee 100644 --- a/src/extract/canvas/CanvasExtract.js +++ b/src/extract/canvas/CanvasExtract.js @@ -8,7 +8,7 @@ * An instance of this class is automatically created by default, and can be found at renderer.plugins.extract * * @class - * @memberof PIXI + * @memberof PIXI.extract */ export default class CanvasExtract { @@ -21,9 +21,9 @@ /** * Collection of methods for extracting data (image, pixels, etc.) from a display object or render texture * - * @member {PIXI.CanvasExtract} extract + * @member {PIXI.extract.CanvasExtract} extract * @memberof PIXI.CanvasRenderer# - * @see PIXI.CanvasExtract + * @see PIXI.extract.CanvasExtract */ renderer.extract = this; } diff --git a/src/extract/index.js b/src/extract/index.js index 0f2170d..031c859 100644 --- a/src/extract/index.js +++ b/src/extract/index.js @@ -1,2 +1,10 @@ +/** + * This namespace provides renderer-specific plugins for exporting content from a renderer. + * For instance, these plugins can be used for saving an Image, Canvas element or for exporting the raw image data (pixels). + * + * Do not instantiate these plugins directly. It is available from the `renderer.plugins` property. + * See {@link PIXI.CanvasRenderer#plugins} or {@link PIXI.WebGLRenderer#plugins}. + * @namespace PIXI.extract + */ export { default as webgl } from './webgl/WebGLExtract'; export { default as canvas } from './canvas/CanvasExtract'; diff --git a/src/extract/webgl/WebGLExtract.js b/src/extract/webgl/WebGLExtract.js index 60228bb..1c3dd30 100644 --- a/src/extract/webgl/WebGLExtract.js +++ b/src/extract/webgl/WebGLExtract.js @@ -9,7 +9,7 @@ * An instance of this class is automatically created by default, and can be found at renderer.plugins.extract * * @class - * @memberof PIXI + * @memberof PIXI.extract */ export default class WebGLExtract { @@ -22,9 +22,9 @@ /** * Collection of methods for extracting data (image, pixels, etc.) from a display object or render texture * - * @member {PIXI.WebGLExtract} extract + * @member {PIXI.extract.WebGLExtract} extract * @memberof PIXI.WebGLRenderer# - * @see PIXI.WebGLExtract + * @see PIXI.extract.WebGLExtract */ renderer.extract = this; } diff --git a/src/extras/index.js b/src/extras/index.js index 6e8d039..a34d7ec 100644 --- a/src/extras/index.js +++ b/src/extras/index.js @@ -1,4 +1,5 @@ /** + * Additional PIXI DisplayObjects for animation, tiling and bitmap text. * @namespace PIXI.extras */ export { default as AnimatedSprite } from './AnimatedSprite'; diff --git a/src/filters/index.js b/src/filters/index.js index f3e8862..01f63a2 100644 --- a/src/filters/index.js +++ b/src/filters/index.js @@ -1,4 +1,6 @@ /** + * This namespace contains WebGL-only display filters that can be applied + * to DisplayObjects using the {@link PIXI.DisplayObject#filters filters} property. * @namespace PIXI.filters */ export { default as FXAAFilter } from './fxaa/FXAAFilter'; diff --git a/src/interaction/index.js b/src/interaction/index.js index 56c5b09..72f7d71 100644 --- a/src/interaction/index.js +++ b/src/interaction/index.js @@ -1,4 +1,8 @@ /** + * This namespace contains a renderer plugin for handling mouse, pointer, and touch events. + * + * Do not instantiate this plugin directly. It is available from the `renderer.plugins` property. + * See {@link PIXI.CanvasRenderer#plugins} or {@link PIXI.WebGLRenderer#plugins}. * @namespace PIXI.interaction */ export { default as InteractionData } from './InteractionData'; diff --git a/scripts/jsdoc.conf.json b/scripts/jsdoc.conf.json index 553e61c..3f52180 100644 --- a/scripts/jsdoc.conf.json +++ b/scripts/jsdoc.conf.json @@ -43,7 +43,7 @@ }, "markdown" : { "parser" : "gfm", - "hardwrap" : true + "hardwrap" : false }, "opts": { "encoding" : "utf8", diff --git a/src/accessibility/AccessibilityManager.js b/src/accessibility/AccessibilityManager.js index f16bcb1..220427a 100644 --- a/src/accessibility/AccessibilityManager.js +++ b/src/accessibility/AccessibilityManager.js @@ -21,7 +21,7 @@ const DIV_HOOK_ZINDEX = 2; /** - * The Accessibility manager reacreates the ability to tab and and have content read by screen + * The Accessibility manager recreates the ability to tab and and have content read by screen * readers. This is very important as it can possibly help people with disabilities access pixi * content. * diff --git a/src/accessibility/index.js b/src/accessibility/index.js index 568cfb1..0ae108f 100644 --- a/src/accessibility/index.js +++ b/src/accessibility/index.js @@ -1,4 +1,9 @@ /** + * This namespace contains a renderer plugin for interaction accessibility for end-users + * with physical impairments which require screen-renders, keyboard navigation, etc. + * + * Do not instantiate this plugin directly. It is available from the `renderer.plugins` property. + * See {@link PIXI.CanvasRenderer#plugins} or {@link PIXI.WebGLRenderer#plugins}. * @namespace PIXI.accessibility */ export { default as accessibleTarget } from './accessibleTarget'; diff --git a/src/core/renderers/canvas/CanvasRenderer.js b/src/core/renderers/canvas/CanvasRenderer.js index c84ec58..c617dfb 100644 --- a/src/core/renderers/canvas/CanvasRenderer.js +++ b/src/core/renderers/canvas/CanvasRenderer.js @@ -300,4 +300,25 @@ } } +/** + * Collection of installed plugins. These are included by default in PIXI, but can be excluded + * by creating a custom build. Consult the README for more information about creating custom + * builds and excluding plugins. + * @name PIXI.CanvasRenderer#plugins + * @type {object} + * @readonly + * @property {PIXI.accessibility.AccessibilityManager} accessibility Support tabbing interactive elements. + * @property {PIXI.extract.CanvasExtract} extract Extract image data from renderer. + * @property {PIXI.interaction.InteractionManager} interaction Handles mouse, touch and pointer events. + * @property {PIXI.prepare.CanvasPrepare} prepare Pre-render display objects. + */ + +/** + * Adds a plugin to the renderer. + * + * @method PIXI.CanvasRenderer#registerPlugin + * @param {string} pluginName - The name of the plugin. + * @param {Function} ctor - The constructor function or class for the plugin. + */ + pluginTarget.mixin(CanvasRenderer); diff --git a/src/core/renderers/webgl/WebGLRenderer.js b/src/core/renderers/webgl/WebGLRenderer.js index e807f9f..01f7fd1 100644 --- a/src/core/renderers/webgl/WebGLRenderer.js +++ b/src/core/renderers/webgl/WebGLRenderer.js @@ -707,4 +707,25 @@ } } +/** + * Collection of installed plugins. These are included by default in PIXI, but can be excluded + * by creating a custom build. Consult the README for more information about creating custom + * builds and excluding plugins. + * @name PIXI.WebGLRenderer#plugins + * @type {object} + * @readonly + * @property {PIXI.accessibility.AccessibilityManager} accessibility Support tabbing interactive elements. + * @property {PIXI.extract.WebGLExtract} extract Extract image data from renderer. + * @property {PIXI.interaction.InteractionManager} interaction Handles mouse, touch and pointer events. + * @property {PIXI.prepare.WebGLPrepare} prepare Pre-render display objects. + */ + +/** + * Adds a plugin to the renderer. + * + * @method PIXI.WebGLRenderer#registerPlugin + * @param {string} pluginName - The name of the plugin. + * @param {Function} ctor - The constructor function or class for the plugin. + */ + pluginTarget.mixin(WebGLRenderer); diff --git a/src/core/settings.js b/src/core/settings.js index fb92cbe..9e8144d 100644 --- a/src/core/settings.js +++ b/src/core/settings.js @@ -2,6 +2,8 @@ import canUploadSameBuffer from './utils/canUploadSameBuffer'; /** + * User's customizable globals for overriding the default PIXI settings, such + * as a renderer's default resolution, framerate, float percision, etc. * @namespace PIXI.settings */ export default { diff --git a/src/core/ticker/index.js b/src/core/ticker/index.js index 9ac7173..d4d2f40 100644 --- a/src/core/ticker/index.js +++ b/src/core/ticker/index.js @@ -53,6 +53,10 @@ }; /** + * This namespace contains an API for interacting with PIXI's internal global update loop. + * + * This ticker is used for rendering, {@link PIXI.extras.AnimatedSprite AnimatedSprite}, + * {@link PIXI.interaction.InteractionManager InteractionManager} and many other time-based PIXI systems. * @namespace PIXI.ticker */ export { shared, Ticker }; diff --git a/src/core/utils/index.js b/src/core/utils/index.js index 99e585a..a0db0d9 100644 --- a/src/core/utils/index.js +++ b/src/core/utils/index.js @@ -9,6 +9,7 @@ let saidHello = false; /** + * Generalized convenience utilities for PIXI. * @namespace PIXI.utils */ export { diff --git a/src/extract/canvas/CanvasExtract.js b/src/extract/canvas/CanvasExtract.js index 941ca05..3ac5aee 100644 --- a/src/extract/canvas/CanvasExtract.js +++ b/src/extract/canvas/CanvasExtract.js @@ -8,7 +8,7 @@ * An instance of this class is automatically created by default, and can be found at renderer.plugins.extract * * @class - * @memberof PIXI + * @memberof PIXI.extract */ export default class CanvasExtract { @@ -21,9 +21,9 @@ /** * Collection of methods for extracting data (image, pixels, etc.) from a display object or render texture * - * @member {PIXI.CanvasExtract} extract + * @member {PIXI.extract.CanvasExtract} extract * @memberof PIXI.CanvasRenderer# - * @see PIXI.CanvasExtract + * @see PIXI.extract.CanvasExtract */ renderer.extract = this; } diff --git a/src/extract/index.js b/src/extract/index.js index 0f2170d..031c859 100644 --- a/src/extract/index.js +++ b/src/extract/index.js @@ -1,2 +1,10 @@ +/** + * This namespace provides renderer-specific plugins for exporting content from a renderer. + * For instance, these plugins can be used for saving an Image, Canvas element or for exporting the raw image data (pixels). + * + * Do not instantiate these plugins directly. It is available from the `renderer.plugins` property. + * See {@link PIXI.CanvasRenderer#plugins} or {@link PIXI.WebGLRenderer#plugins}. + * @namespace PIXI.extract + */ export { default as webgl } from './webgl/WebGLExtract'; export { default as canvas } from './canvas/CanvasExtract'; diff --git a/src/extract/webgl/WebGLExtract.js b/src/extract/webgl/WebGLExtract.js index 60228bb..1c3dd30 100644 --- a/src/extract/webgl/WebGLExtract.js +++ b/src/extract/webgl/WebGLExtract.js @@ -9,7 +9,7 @@ * An instance of this class is automatically created by default, and can be found at renderer.plugins.extract * * @class - * @memberof PIXI + * @memberof PIXI.extract */ export default class WebGLExtract { @@ -22,9 +22,9 @@ /** * Collection of methods for extracting data (image, pixels, etc.) from a display object or render texture * - * @member {PIXI.WebGLExtract} extract + * @member {PIXI.extract.WebGLExtract} extract * @memberof PIXI.WebGLRenderer# - * @see PIXI.WebGLExtract + * @see PIXI.extract.WebGLExtract */ renderer.extract = this; } diff --git a/src/extras/index.js b/src/extras/index.js index 6e8d039..a34d7ec 100644 --- a/src/extras/index.js +++ b/src/extras/index.js @@ -1,4 +1,5 @@ /** + * Additional PIXI DisplayObjects for animation, tiling and bitmap text. * @namespace PIXI.extras */ export { default as AnimatedSprite } from './AnimatedSprite'; diff --git a/src/filters/index.js b/src/filters/index.js index f3e8862..01f63a2 100644 --- a/src/filters/index.js +++ b/src/filters/index.js @@ -1,4 +1,6 @@ /** + * This namespace contains WebGL-only display filters that can be applied + * to DisplayObjects using the {@link PIXI.DisplayObject#filters filters} property. * @namespace PIXI.filters */ export { default as FXAAFilter } from './fxaa/FXAAFilter'; diff --git a/src/interaction/index.js b/src/interaction/index.js index 56c5b09..72f7d71 100644 --- a/src/interaction/index.js +++ b/src/interaction/index.js @@ -1,4 +1,8 @@ /** + * This namespace contains a renderer plugin for handling mouse, pointer, and touch events. + * + * Do not instantiate this plugin directly. It is available from the `renderer.plugins` property. + * See {@link PIXI.CanvasRenderer#plugins} or {@link PIXI.WebGLRenderer#plugins}. * @namespace PIXI.interaction */ export { default as InteractionData } from './InteractionData'; diff --git a/src/loaders/index.js b/src/loaders/index.js index f468bc3..f13d855 100644 --- a/src/loaders/index.js +++ b/src/loaders/index.js @@ -1,4 +1,6 @@ /** + * This namespace contains APIs which extends the {@link https://github.com/englercj/resource-loader resource-loader} module + * for loading assets, data, and other resources dynamically. * @namespace PIXI.loaders */ export { default as Loader } from './loader'; diff --git a/scripts/jsdoc.conf.json b/scripts/jsdoc.conf.json index 553e61c..3f52180 100644 --- a/scripts/jsdoc.conf.json +++ b/scripts/jsdoc.conf.json @@ -43,7 +43,7 @@ }, "markdown" : { "parser" : "gfm", - "hardwrap" : true + "hardwrap" : false }, "opts": { "encoding" : "utf8", diff --git a/src/accessibility/AccessibilityManager.js b/src/accessibility/AccessibilityManager.js index f16bcb1..220427a 100644 --- a/src/accessibility/AccessibilityManager.js +++ b/src/accessibility/AccessibilityManager.js @@ -21,7 +21,7 @@ const DIV_HOOK_ZINDEX = 2; /** - * The Accessibility manager reacreates the ability to tab and and have content read by screen + * The Accessibility manager recreates the ability to tab and and have content read by screen * readers. This is very important as it can possibly help people with disabilities access pixi * content. * diff --git a/src/accessibility/index.js b/src/accessibility/index.js index 568cfb1..0ae108f 100644 --- a/src/accessibility/index.js +++ b/src/accessibility/index.js @@ -1,4 +1,9 @@ /** + * This namespace contains a renderer plugin for interaction accessibility for end-users + * with physical impairments which require screen-renders, keyboard navigation, etc. + * + * Do not instantiate this plugin directly. It is available from the `renderer.plugins` property. + * See {@link PIXI.CanvasRenderer#plugins} or {@link PIXI.WebGLRenderer#plugins}. * @namespace PIXI.accessibility */ export { default as accessibleTarget } from './accessibleTarget'; diff --git a/src/core/renderers/canvas/CanvasRenderer.js b/src/core/renderers/canvas/CanvasRenderer.js index c84ec58..c617dfb 100644 --- a/src/core/renderers/canvas/CanvasRenderer.js +++ b/src/core/renderers/canvas/CanvasRenderer.js @@ -300,4 +300,25 @@ } } +/** + * Collection of installed plugins. These are included by default in PIXI, but can be excluded + * by creating a custom build. Consult the README for more information about creating custom + * builds and excluding plugins. + * @name PIXI.CanvasRenderer#plugins + * @type {object} + * @readonly + * @property {PIXI.accessibility.AccessibilityManager} accessibility Support tabbing interactive elements. + * @property {PIXI.extract.CanvasExtract} extract Extract image data from renderer. + * @property {PIXI.interaction.InteractionManager} interaction Handles mouse, touch and pointer events. + * @property {PIXI.prepare.CanvasPrepare} prepare Pre-render display objects. + */ + +/** + * Adds a plugin to the renderer. + * + * @method PIXI.CanvasRenderer#registerPlugin + * @param {string} pluginName - The name of the plugin. + * @param {Function} ctor - The constructor function or class for the plugin. + */ + pluginTarget.mixin(CanvasRenderer); diff --git a/src/core/renderers/webgl/WebGLRenderer.js b/src/core/renderers/webgl/WebGLRenderer.js index e807f9f..01f7fd1 100644 --- a/src/core/renderers/webgl/WebGLRenderer.js +++ b/src/core/renderers/webgl/WebGLRenderer.js @@ -707,4 +707,25 @@ } } +/** + * Collection of installed plugins. These are included by default in PIXI, but can be excluded + * by creating a custom build. Consult the README for more information about creating custom + * builds and excluding plugins. + * @name PIXI.WebGLRenderer#plugins + * @type {object} + * @readonly + * @property {PIXI.accessibility.AccessibilityManager} accessibility Support tabbing interactive elements. + * @property {PIXI.extract.WebGLExtract} extract Extract image data from renderer. + * @property {PIXI.interaction.InteractionManager} interaction Handles mouse, touch and pointer events. + * @property {PIXI.prepare.WebGLPrepare} prepare Pre-render display objects. + */ + +/** + * Adds a plugin to the renderer. + * + * @method PIXI.WebGLRenderer#registerPlugin + * @param {string} pluginName - The name of the plugin. + * @param {Function} ctor - The constructor function or class for the plugin. + */ + pluginTarget.mixin(WebGLRenderer); diff --git a/src/core/settings.js b/src/core/settings.js index fb92cbe..9e8144d 100644 --- a/src/core/settings.js +++ b/src/core/settings.js @@ -2,6 +2,8 @@ import canUploadSameBuffer from './utils/canUploadSameBuffer'; /** + * User's customizable globals for overriding the default PIXI settings, such + * as a renderer's default resolution, framerate, float percision, etc. * @namespace PIXI.settings */ export default { diff --git a/src/core/ticker/index.js b/src/core/ticker/index.js index 9ac7173..d4d2f40 100644 --- a/src/core/ticker/index.js +++ b/src/core/ticker/index.js @@ -53,6 +53,10 @@ }; /** + * This namespace contains an API for interacting with PIXI's internal global update loop. + * + * This ticker is used for rendering, {@link PIXI.extras.AnimatedSprite AnimatedSprite}, + * {@link PIXI.interaction.InteractionManager InteractionManager} and many other time-based PIXI systems. * @namespace PIXI.ticker */ export { shared, Ticker }; diff --git a/src/core/utils/index.js b/src/core/utils/index.js index 99e585a..a0db0d9 100644 --- a/src/core/utils/index.js +++ b/src/core/utils/index.js @@ -9,6 +9,7 @@ let saidHello = false; /** + * Generalized convenience utilities for PIXI. * @namespace PIXI.utils */ export { diff --git a/src/extract/canvas/CanvasExtract.js b/src/extract/canvas/CanvasExtract.js index 941ca05..3ac5aee 100644 --- a/src/extract/canvas/CanvasExtract.js +++ b/src/extract/canvas/CanvasExtract.js @@ -8,7 +8,7 @@ * An instance of this class is automatically created by default, and can be found at renderer.plugins.extract * * @class - * @memberof PIXI + * @memberof PIXI.extract */ export default class CanvasExtract { @@ -21,9 +21,9 @@ /** * Collection of methods for extracting data (image, pixels, etc.) from a display object or render texture * - * @member {PIXI.CanvasExtract} extract + * @member {PIXI.extract.CanvasExtract} extract * @memberof PIXI.CanvasRenderer# - * @see PIXI.CanvasExtract + * @see PIXI.extract.CanvasExtract */ renderer.extract = this; } diff --git a/src/extract/index.js b/src/extract/index.js index 0f2170d..031c859 100644 --- a/src/extract/index.js +++ b/src/extract/index.js @@ -1,2 +1,10 @@ +/** + * This namespace provides renderer-specific plugins for exporting content from a renderer. + * For instance, these plugins can be used for saving an Image, Canvas element or for exporting the raw image data (pixels). + * + * Do not instantiate these plugins directly. It is available from the `renderer.plugins` property. + * See {@link PIXI.CanvasRenderer#plugins} or {@link PIXI.WebGLRenderer#plugins}. + * @namespace PIXI.extract + */ export { default as webgl } from './webgl/WebGLExtract'; export { default as canvas } from './canvas/CanvasExtract'; diff --git a/src/extract/webgl/WebGLExtract.js b/src/extract/webgl/WebGLExtract.js index 60228bb..1c3dd30 100644 --- a/src/extract/webgl/WebGLExtract.js +++ b/src/extract/webgl/WebGLExtract.js @@ -9,7 +9,7 @@ * An instance of this class is automatically created by default, and can be found at renderer.plugins.extract * * @class - * @memberof PIXI + * @memberof PIXI.extract */ export default class WebGLExtract { @@ -22,9 +22,9 @@ /** * Collection of methods for extracting data (image, pixels, etc.) from a display object or render texture * - * @member {PIXI.WebGLExtract} extract + * @member {PIXI.extract.WebGLExtract} extract * @memberof PIXI.WebGLRenderer# - * @see PIXI.WebGLExtract + * @see PIXI.extract.WebGLExtract */ renderer.extract = this; } diff --git a/src/extras/index.js b/src/extras/index.js index 6e8d039..a34d7ec 100644 --- a/src/extras/index.js +++ b/src/extras/index.js @@ -1,4 +1,5 @@ /** + * Additional PIXI DisplayObjects for animation, tiling and bitmap text. * @namespace PIXI.extras */ export { default as AnimatedSprite } from './AnimatedSprite'; diff --git a/src/filters/index.js b/src/filters/index.js index f3e8862..01f63a2 100644 --- a/src/filters/index.js +++ b/src/filters/index.js @@ -1,4 +1,6 @@ /** + * This namespace contains WebGL-only display filters that can be applied + * to DisplayObjects using the {@link PIXI.DisplayObject#filters filters} property. * @namespace PIXI.filters */ export { default as FXAAFilter } from './fxaa/FXAAFilter'; diff --git a/src/interaction/index.js b/src/interaction/index.js index 56c5b09..72f7d71 100644 --- a/src/interaction/index.js +++ b/src/interaction/index.js @@ -1,4 +1,8 @@ /** + * This namespace contains a renderer plugin for handling mouse, pointer, and touch events. + * + * Do not instantiate this plugin directly. It is available from the `renderer.plugins` property. + * See {@link PIXI.CanvasRenderer#plugins} or {@link PIXI.WebGLRenderer#plugins}. * @namespace PIXI.interaction */ export { default as InteractionData } from './InteractionData'; diff --git a/src/loaders/index.js b/src/loaders/index.js index f468bc3..f13d855 100644 --- a/src/loaders/index.js +++ b/src/loaders/index.js @@ -1,4 +1,6 @@ /** + * This namespace contains APIs which extends the {@link https://github.com/englercj/resource-loader resource-loader} module + * for loading assets, data, and other resources dynamically. * @namespace PIXI.loaders */ export { default as Loader } from './loader'; diff --git a/src/prepare/index.js b/src/prepare/index.js index f559c45..28a5ff5 100644 --- a/src/prepare/index.js +++ b/src/prepare/index.js @@ -1,4 +1,9 @@ /** + * The prepare namespace provides renderer-specific plugins for pre-rendering DisplayObjects. These plugins are useful for + * asynchronously preparing assets, textures, graphics waiting to be displayed. + * + * Do not instantiate these plugins directly. It is available from the `renderer.plugins` property. + * See {@link PIXI.CanvasRenderer#plugins} or {@link PIXI.WebGLRenderer#plugins}. * @namespace PIXI.prepare */ export { default as webgl } from './webgl/WebGLPrepare';