phaser/src/renderer/webgl/WebGLPipeline.js

390 lines
9.6 KiB
JavaScript
Raw Normal View History

2018-02-12 16:01:20 +00:00
/**
* @author Richard Davey <rich@photonstorm.com>
* @copyright 2018 Photon Storm Ltd.
* @license {@link https://github.com/photonstorm/phaser/blob/master/license.txt|MIT License}
*/
2018-01-10 20:03:01 +00:00
var Class = require('../../utils/Class');
2018-01-22 22:51:15 +00:00
var Utils = require('./Utils');
2018-02-09 19:19:21 +00:00
/**
* @classdesc
* [description]
*
* @class WebGLPipeline
* @memberOf Phaser.Renderer.WebGL
* @constructor
* @since 3.0.0
*
* @param {object} config - [description]
*/
2018-01-17 21:25:43 +00:00
var WebGLPipeline = new Class({
2018-02-09 19:19:21 +00:00
initialize:
2018-01-10 20:03:01 +00:00
2018-02-09 19:19:21 +00:00
function WebGLPipeline (config)
2018-01-10 20:03:01 +00:00
{
2018-02-09 19:19:21 +00:00
/**
* [description]
*
* @name Phaser.Renderer.WebGL.WebGLPipeline#name
* @type {string}
* @since 3.0.0
*/
2018-01-30 22:46:43 +00:00
this.name = 'WebGLPipeline';
2018-02-09 19:19:21 +00:00
/**
* [description]
*
* @name Phaser.Renderer.WebGL.WebGLPipeline#game
* @type {Phaser.Game}
* @since 3.0.0
*/
2018-01-10 20:03:01 +00:00
this.game = config.game;
2018-02-09 19:19:21 +00:00
/**
* [description]
*
* @name Phaser.Renderer.WebGL.WebGLPipeline#view
* @type {HTMLCanvasElement}
* @since 3.0.0
*/
2018-01-10 20:03:01 +00:00
this.view = config.game.canvas;
2018-02-09 19:19:21 +00:00
/**
* [description]
*
* @name Phaser.Renderer.WebGL.WebGLPipeline#resolution
* @type {number}
* @since 3.0.0
*/
2018-01-10 20:03:01 +00:00
this.resolution = config.game.config.resolution;
2018-02-09 19:19:21 +00:00
/**
* [description]
*
* @name Phaser.Renderer.WebGL.WebGLPipeline#width
* @type {number}
* @since 3.0.0
*/
2018-01-10 20:03:01 +00:00
this.width = config.game.config.width * this.resolution;
2018-02-09 19:19:21 +00:00
/**
* [description]
*
* @name Phaser.Renderer.WebGL.WebGLPipeline#height
* @type {number}
* @since 3.0.0
*/
2018-01-10 20:03:01 +00:00
this.height = config.game.config.height * this.resolution;
2018-02-09 19:19:21 +00:00
/**
* [description]
*
* @name Phaser.Renderer.WebGL.WebGLPipeline#gl
2018-02-13 00:12:17 +00:00
* @type {WebGLRenderingContext}
2018-02-09 19:19:21 +00:00
* @since 3.0.0
*/
2018-01-10 20:03:01 +00:00
this.gl = config.gl;
2018-02-09 19:19:21 +00:00
/**
* [description]
*
* @name Phaser.Renderer.WebGL.WebGLPipeline#vertexCount
* @type {number}
* @default 0
* @since 3.0.0
*/
2018-01-10 20:03:01 +00:00
this.vertexCount = 0;
2018-02-09 19:19:21 +00:00
/**
* [description]
*
* @name Phaser.Renderer.WebGL.WebGLPipeline#vertexCapacity
* @type {integer}
* @since 3.0.0
*/
2018-01-10 20:03:01 +00:00
this.vertexCapacity = config.vertexCapacity;
2018-02-09 19:19:21 +00:00
/**
* [description]
*
* @name Phaser.Renderer.WebGL.WebGLPipeline#renderer
* @type {Phaser.Renderer.WebGL.WebGLRenderer}
* @since 3.0.0
*/
2018-01-20 04:05:56 +00:00
this.renderer = config.renderer;
2018-02-09 19:19:21 +00:00
/**
* [description]
*
* @name Phaser.Renderer.WebGL.WebGLPipeline#vertexData
2018-02-13 00:12:17 +00:00
* @type {ArrayBuffer}
2018-02-09 19:19:21 +00:00
* @since 3.0.0
*/
this.vertexData = (config.vertices ? config.vertices : new ArrayBuffer(config.vertexCapacity * config.vertexSize));
2018-02-09 19:19:21 +00:00
/**
* [description]
*
* @name Phaser.Renderer.WebGL.WebGLPipeline#vertexBuffer
2018-02-13 00:12:17 +00:00
* @type {WebGLBuffer}
2018-02-09 19:19:21 +00:00
* @since 3.0.0
*/
this.vertexBuffer = this.renderer.createVertexBuffer((config.vertices ? config.vertices : this.vertexData.byteLength), this.gl.STREAM_DRAW);
2018-02-09 19:19:21 +00:00
/**
* [description]
*
* @name Phaser.Renderer.WebGL.WebGLPipeline#program
2018-02-13 00:12:17 +00:00
* @type {WebGLProgram}
2018-02-09 19:19:21 +00:00
* @since 3.0.0
*/
2018-01-22 22:51:15 +00:00
this.program = this.renderer.createProgram(config.vertShader, config.fragShader);
2018-02-09 19:19:21 +00:00
/**
* [description]
*
* @name Phaser.Renderer.WebGL.WebGLPipeline#attributes
2018-02-13 00:12:17 +00:00
* @type {object}
2018-02-09 19:19:21 +00:00
* @since 3.0.0
*/
2018-01-20 04:05:56 +00:00
this.attributes = config.attributes;
2018-02-09 19:19:21 +00:00
/**
* [description]
*
* @name Phaser.Renderer.WebGL.WebGLPipeline#vertexSize
2018-02-16 18:07:49 +00:00
* @type {integer}
2018-02-09 19:19:21 +00:00
* @since 3.0.0
*/
2018-01-10 20:03:01 +00:00
this.vertexSize = config.vertexSize;
2018-02-09 19:19:21 +00:00
/**
* [description]
*
* @name Phaser.Renderer.WebGL.WebGLPipeline#topology
2018-02-16 18:07:49 +00:00
* @type {integer}
2018-02-09 19:19:21 +00:00
* @since 3.0.0
*/
2018-01-10 20:03:01 +00:00
this.topology = config.topology;
2018-02-09 19:19:21 +00:00
/**
* [description]
*
* @name Phaser.Renderer.WebGL.WebGLPipeline#bytes
* @type {Uint8Array}
* @since 3.0.0
*/
2018-01-22 21:21:47 +00:00
this.bytes = new Uint8Array(this.vertexData);
2018-02-09 19:19:21 +00:00
/**
* This will store the amount of components of 32 bit length
*
* @name Phaser.Renderer.WebGL.WebGLPipeline#vertexComponentCount
2018-02-16 18:07:49 +00:00
* @type {integer}
2018-02-09 19:19:21 +00:00
* @since 3.0.0
*/
this.vertexComponentCount = Utils.getComponentCount(config.attributes, this.gl);
/**
* Indicates if the current pipeline is flushing the contents to the GPU.
* When the variable is set the flush function will be locked.
*
* @name Phaser.Renderer.WebGL.WebGLPipeline#flushLocked
* @type {boolean}
2018-02-15 14:31:15 +00:00
* @since 3.1.0
*/
this.flushLocked = false;
2018-01-10 20:03:01 +00:00
},
2018-02-09 19:19:21 +00:00
/**
* [description]
*
* @method Phaser.Renderer.WebGL.WebGLPipeline#shouldFlush
* @since 3.0.0
*
* @return {boolean} [description]
*/
2018-01-10 20:03:01 +00:00
shouldFlush: function ()
{
2018-02-09 19:19:21 +00:00
return (this.vertexCount >= this.vertexCapacity);
2018-01-10 20:03:01 +00:00
},
2018-02-09 19:19:21 +00:00
/**
* [description]
*
* @method Phaser.Renderer.WebGL.WebGLPipeline#resize
* @since 3.0.0
*
* @param {number} width - [description]
* @param {number} height - [description]
* @param {number} resolution - [description]
*
* @return {Phaser.Renderer.WebGL.WebGLPipeline} [description]
*/
2018-01-10 20:03:01 +00:00
resize: function (width, height, resolution)
{
2018-01-17 21:25:43 +00:00
this.width = width * resolution;
this.height = height * resolution;
2018-01-10 20:03:01 +00:00
return this;
},
2018-02-09 19:19:21 +00:00
/**
* [description]
*
* @method Phaser.Renderer.WebGL.WebGLPipeline#bind
* @since 3.0.0
*
* @return {Phaser.Renderer.WebGL.WebGLPipeline} [description]
*/
2018-01-30 03:38:31 +00:00
bind: function ()
2018-01-10 20:03:01 +00:00
{
2018-01-20 04:05:56 +00:00
var gl = this.gl;
var vertexBuffer = this.vertexBuffer;
var attributes = this.attributes;
2018-01-30 03:38:31 +00:00
var program = this.program;
2018-01-20 04:05:56 +00:00
var renderer = this.renderer;
var vertexSize = this.vertexSize;
2018-01-10 20:03:01 +00:00
2018-01-20 04:05:56 +00:00
renderer.setProgram(program);
renderer.setVertexBuffer(vertexBuffer);
for (var index = 0; index < attributes.length; ++index)
{
var element = attributes[index];
var location = gl.getAttribLocation(program, element.name);
if (location >= 0)
{
gl.enableVertexAttribArray(location);
gl.vertexAttribPointer(location, element.size, element.type, element.normalized, vertexSize, element.offset);
}
else
{
gl.disableVertexAttribArray(location);
}
}
2018-01-10 20:03:01 +00:00
return this;
},
2018-02-09 19:19:21 +00:00
/**
* [description]
*
* @method Phaser.Renderer.WebGL.WebGLPipeline#onBind
* @since 3.0.0
*
* @return {Phaser.Renderer.WebGL.WebGLPipeline} [description]
*/
2018-01-25 05:26:14 +00:00
onBind: function ()
{
// This is for updating uniform data it's called on each bind attempt.
return this;
},
2018-02-09 19:19:21 +00:00
/**
* [description]
*
* @method Phaser.Renderer.WebGL.WebGLPipeline#onPreRender
* @since 3.0.0
*
* @return {Phaser.Renderer.WebGL.WebGLPipeline} [description]
*/
2018-01-26 23:17:11 +00:00
onPreRender: function ()
{
// called once every frame
return this;
},
2018-02-09 19:19:21 +00:00
/**
* [description]
*
* @method Phaser.Renderer.WebGL.WebGLPipeline#onRender
* @since 3.0.0
*
* @param {Phaser.Scene} scene - [description]
* @param {Phaser.Cameras.Scene2D.Camera} camera - [description]
*
* @return {Phaser.Renderer.WebGL.WebGLPipeline} [description]
*/
2018-02-16 18:44:07 +00:00
onRender: function ()
2018-01-29 21:46:48 +00:00
{
// called for each camera
return this;
},
2018-02-09 19:19:21 +00:00
/**
* [description]
*
* @method Phaser.Renderer.WebGL.WebGLPipeline#onPostRender
* @since 3.0.0
*
* @return {Phaser.Renderer.WebGL.WebGLPipeline} [description]
*/
2018-01-26 23:17:11 +00:00
onPostRender: function ()
{
// called once every frame
return this;
},
2018-02-09 19:19:21 +00:00
/**
* [description]
*
* @method Phaser.Renderer.WebGL.WebGLPipeline#flush
* @since 3.0.0
*
* @return {Phaser.Renderer.WebGL.WebGLPipeline} [description]
*/
2018-01-10 20:03:01 +00:00
flush: function ()
{
2018-02-16 18:17:51 +00:00
if (this.flushLocked) { return this; }
2018-02-16 18:44:07 +00:00
this.flushLocked = true;
2018-01-10 20:03:01 +00:00
var gl = this.gl;
var vertexCount = this.vertexCount;
var topology = this.topology;
2018-01-22 21:21:47 +00:00
var vertexSize = this.vertexSize;
2018-01-10 20:03:01 +00:00
2018-02-16 18:17:51 +00:00
if (vertexCount === 0)
{
this.flushLocked = false;
return;
}
2018-02-16 18:44:07 +00:00
2018-01-22 21:21:47 +00:00
gl.bufferSubData(gl.ARRAY_BUFFER, 0, this.bytes.subarray(0, vertexCount * vertexSize));
2018-01-10 20:03:01 +00:00
gl.drawArrays(topology, 0, vertexCount);
this.vertexCount = 0;
this.flushLocked = false;
2018-01-10 20:03:01 +00:00
2018-01-17 21:25:43 +00:00
return this;
},
2018-02-09 19:19:21 +00:00
/**
* [description]
*
* @method Phaser.Renderer.WebGL.WebGLPipeline#destroy
* @since 3.0.0
*
* @return {Phaser.Renderer.WebGL.WebGLPipeline} [description]
*/
2018-01-17 21:25:43 +00:00
destroy: function ()
{
2018-01-20 04:05:56 +00:00
var gl = this.gl;
2018-01-17 21:25:43 +00:00
gl.deleteProgram(this.program);
2018-01-20 04:05:56 +00:00
gl.deleteBuffer(this.vertexBuffer);
2018-01-17 21:25:43 +00:00
delete this.program;
delete this.vertexBuffer;
delete this.gl;
2018-01-10 20:03:01 +00:00
return this;
}
});
2018-01-17 21:25:43 +00:00
module.exports = WebGLPipeline;