Core/Uniform.js

  1. /**
  2.  * A class representing a uniform.
  3.  * 
  4.  * @property {String} name The name of this uniform. Also the variable name in the shader.
  5.  * @property {Number} value The value of this uniform.
  6.  * @property {String} type The type of this uniform. Available types: int, int_vec2, int_vec3, int_vec4, int_array, float, float_vec2, float_vec3, float_vec4, float_array, float_mat2, float_mat3, float_mat4.
  7.  * @property {Boolean} stale A boolean indicating whether or not this uniform is stale and needs to be updated.
  8.  */
  9. Lore.Uniform = class Uniform {
  10.     /**
  11.      * Creates an instance of Uniform.
  12.      * @param {String} name The name of this uniform. Also the variable name in the shader.
  13.      * @param {Number} value The value of this uniform.
  14.      * @param {String} type The type of this uniform. Available types: int, int_vec2, int_vec3, int_vec4, int_array, float, float_vec2, float_vec3, float_vec4, float_array, float_mat2, float_mat3, float_mat4.
  15.      */
  16.     constructor(name, value, type) {
  17.         this.name = name;
  18.         this.value = value;
  19.         this.type = type;
  20.         this.stale = true;
  21.     }
  23.     /**
  24.      * Set the value of this uniform.
  25.      * 
  26.      * @param {Number} value A number which is valid for the specified type.
  27.      */
  28.     setValue(value) {
  29.         this.value = value;
  30.         this.stale = true;
  31.     }
  33.     /**
  34.      * Pushes the uniform to the GPU.
  35.      * 
  36.      * @param {WebGLRenderingContext} gl A WebGL rendering context.
  37.      * @param {WebGLUniformLocation} program 
  38.      * @param {Lore.Uniform} uniform 
  39.      */
  40.     static Set(gl, program, uniform) {
  41.         let location = gl.getUniformLocation(program, uniform.name);
  43.         if (uniform.type === 'int') {
  44.             gl.uniform1i(location, uniform.value);
  45.         } else if (uniform.type === 'int_vec2') {
  46.             gl.uniform2iv(location, uniform.value);
  47.         } else if (uniform.type === 'int_vec3') {
  48.             gl.uniform3iv(location, uniform.value);
  49.         } else if (uniform.type === 'int_vec4') {
  50.             gl.uniform4iv(location, uniform.value);
  51.         } else if (uniform.type === 'int_array') {
  52.             gl.uniform1iv(location, uniform.value);
  53.         } else if (uniform.type === 'float') {
  54.             gl.uniform1f(location, uniform.value);
  55.         } else if (uniform.type === 'float_vec2') {
  56.             gl.uniform2fv(location, uniform.value);
  57.         } else if (uniform.type === 'float_vec3') {
  58.             gl.uniform3fv(location, uniform.value);
  59.         } else if (uniform.type === 'float_vec4') {
  60.             gl.uniform4fv(location, uniform.value);
  61.         } else if (uniform.type === 'float_array') {
  62.             gl.uniform1fv(location, uniform.value);
  63.         } else if (uniform.type === 'float_mat2') {
  64.             // false, see https://developer.mozilla.org/en-US/docs/Web/API/WebGLRenderingContext/uniformMatrix
  65.             gl.uniformMatrix2fv(location, false, uniform.value);
  66.         } else if (uniform.type === 'float_mat3') {
  67.             gl.uniformMatrix3fv(location, false, uniform.value);
  68.         } else if (uniform.type === 'float_mat4') {
  69.             gl.uniformMatrix4fv(location, false, uniform.value);
  70.         }
  72.         // TODO: Add SAMPLER_2D and SAMPLER_CUBE
  74.         // Had to set this to true because point sizes did not update...
  75.         uniform.stale = true;
  76.     }
  77. }