Added Pipeline events

Author: photonstorm

src/renderer/webgl/pipelines/events/AFTER_FLUSH_EVENT.js

@@ -0,0 +1,19 @@
+/**
+ * @author       Richard Davey <rich@photonstorm.com>
+ * @copyright    2020 Photon Storm Ltd.
+ * @license      {@link https://opensource.org/licenses/MIT|MIT License}
+ */
+
+/**
+ * The WebGLPipeline After Flush Event.
+ *
+ * This event is dispatched by a WebGLPipeline right after it has issued a drawArrays command
+ * and cleared its vertex count.
+ *
+ * @event Phaser.Renderer.WebGL.Pipelines.Events#AFTER_FLUSH
+ * @since 3.50.0
+ *
+ * @param {Phaser.Renderer.WebGL.WebGLPipeline} pipeline - The pipeline that has flushed.
+ * @param {boolean} isPostFlush - Was this flush invoked as part of a post-process, or not?
+ */
+module.exports = 'pipelineafterflush';

src/renderer/webgl/pipelines/events/BEFORE_FLUSH_EVENT.js

@@ -0,0 +1,19 @@
+/**
+ * @author       Richard Davey <rich@photonstorm.com>
+ * @copyright    2020 Photon Storm Ltd.
+ * @license      {@link https://opensource.org/licenses/MIT|MIT License}
+ */
+
+/**
+ * The WebGLPipeline Before Flush Event.
+ *
+ * This event is dispatched by a WebGLPipeline right before it is about to
+ * flush and issue a bufferData and drawArrays command.
+ *
+ * @event Phaser.Renderer.WebGL.Pipelines.Events#BEFORE_FLUSH
+ * @since 3.50.0
+ *
+ * @param {Phaser.Renderer.WebGL.WebGLPipeline} pipeline - The pipeline that is about to flush.
+ * @param {boolean} isPostFlush - Was this flush invoked as part of a post-process, or not?
+ */
+module.exports = 'pipelinebeforeflush';

src/renderer/webgl/pipelines/events/BIND_EVENT.js

@@ -0,0 +1,18 @@
+/**
+ * @author       Richard Davey <rich@photonstorm.com>
+ * @copyright    2020 Photon Storm Ltd.
+ * @license      {@link https://opensource.org/licenses/MIT|MIT License}
+ */
+
+/**
+ * The WebGLPipeline Bind Event.
+ *
+ * This event is dispatched by a WebGLPipeline when it is bound by the Pipeline Manager.
+ *
+ * @event Phaser.Renderer.WebGL.Pipelines.Events#BIND
+ * @since 3.50.0
+ *
+ * @param {Phaser.Renderer.WebGL.WebGLPipeline} pipeline - The pipeline that was bound.
+ * @param {Phaser.Renderer.WebGL.WebGLShader} currentShader - The shader that was set as being current.
+ */
+module.exports = 'pipelinebind';

src/renderer/webgl/pipelines/events/BOOT_EVENT.js

@@ -0,0 +1,17 @@
+/**
+ * @author       Richard Davey <rich@photonstorm.com>
+ * @copyright    2020 Photon Storm Ltd.
+ * @license      {@link https://opensource.org/licenses/MIT|MIT License}
+ */
+
+/**
+ * The WebGLPipeline Boot Event.
+ *
+ * This event is dispatched by a WebGLPipeline when it has completed its `boot` phase.
+ *
+ * @event Phaser.Renderer.WebGL.Pipelines.Events#BOOT
+ * @since 3.50.0
+ *
+ * @param {Phaser.Renderer.WebGL.WebGLPipeline} pipeline - The pipeline that booted.
+ */
+module.exports = 'pipelineboot';

src/renderer/webgl/pipelines/events/DESTROY_EVENT.js

@@ -0,0 +1,17 @@
+/**
+ * @author       Richard Davey <rich@photonstorm.com>
+ * @copyright    2020 Photon Storm Ltd.
+ * @license      {@link https://opensource.org/licenses/MIT|MIT License}
+ */
+
+/**
+ * The WebGLPipeline Destroy Event.
+ *
+ * This event is dispatched by a WebGLPipeline when it is starting its destroy process.
+ *
+ * @event Phaser.Renderer.WebGL.Pipelines.Events#DESTROY
+ * @since 3.50.0
+ *
+ * @param {Phaser.Renderer.WebGL.WebGLPipeline} pipeline - The pipeline that has flushed.
+ */
+module.exports = 'pipelinedestroy';

src/renderer/webgl/pipelines/events/REBIND_EVENT.js

@@ -0,0 +1,18 @@
+/**
+ * @author       Richard Davey <rich@photonstorm.com>
+ * @copyright    2020 Photon Storm Ltd.
+ * @license      {@link https://opensource.org/licenses/MIT|MIT License}
+ */
+
+/**
+ * The WebGLPipeline ReBind Event.
+ *
+ * This event is dispatched by a WebGLPipeline when it is re-bound by the Pipeline Manager.
+ *
+ * @event Phaser.Renderer.WebGL.Pipelines.Events#REBIND
+ * @since 3.50.0
+ *
+ * @param {Phaser.Renderer.WebGL.WebGLPipeline} pipeline - The pipeline that was rebound.
+ * @param {Phaser.Renderer.WebGL.WebGLShader} currentShader - The shader that was set as being current.
+ */
+module.exports = 'pipelinerebind';

src/renderer/webgl/pipelines/events/RESIZE_EVENT.js

@@ -0,0 +1,20 @@
+/**
+ * @author       Richard Davey <rich@photonstorm.com>
+ * @copyright    2020 Photon Storm Ltd.
+ * @license      {@link https://opensource.org/licenses/MIT|MIT License}
+ */
+
+/**
+ * The WebGLPipeline Resize Event.
+ *
+ * This event is dispatched by a WebGLPipeline when it is resized, usually as a result
+ * of the Renderer resizing.
+ *
+ * @event Phaser.Renderer.WebGL.Pipelines.Events#RESIZE
+ * @since 3.50.0
+ *
+ * @param {number} width - The new width of the pipeline.
+ * @param {number} height - The new height of the pipeline.
+ * @param {Phaser.Renderer.WebGL.WebGLPipeline} pipeline - The pipeline that was resized.
+ */
+module.exports = 'pipelineresize';

src/renderer/webgl/pipelines/events/index.js

@@ -0,0 +1,21 @@
+/**
+ * @author       Richard Davey <rich@photonstorm.com>
+ * @copyright    2020 Photon Storm Ltd.
+ * @license      {@link https://opensource.org/licenses/MIT|MIT License}
+ */
+
+/**
+ * @namespace Phaser.Renderer.WebGL.Pipelines.Events
+ */
+
+module.exports = {
+
+    AFTER_FLUSH: require('./AFTER_FLUSH_EVENT'),
+    BEFORE_FLUSH: require('./BEFORE_FLUSH_EVENT'),
+    BIND: require('./BIND_EVENT'),
+    BOOT: require('./BOOT_EVENT'),
+    DESTROY: require('./DESTROY_EVENT'),
+    REBIND: require('./REBIND_EVENT'),
+    RESIZE: require('./RESIZE_EVENT')
+
+};

src/renderer/webgl/pipelines/index.js

@@ -14,6 +14,7 @@ var Extend = require('../../../utils/object/Extend');
 var Pipelines = {
 
     BitmapMaskPipeline: require('./BitmapMaskPipeline'),
+    Events: require('./events'),
     GraphicsPipeline: require('./GraphicsPipeline'),
     LightPipeline: require('./LightPipeline'),
     MultiPipeline: require('./MultiPipeline'),