vglModule.shaderProgram.rst

vgl.shaderProgram (class)

.. js:class:: vgl.shaderProgram ()



   .. ============================== constructor details ====================








   Create a new instace of class shaderProgram













   :returns:



     :rtype: vgl.shaderProgram














   .. ============================== properties summary =====================



   .. ============================== events summary ========================





   .. ============================== field details ==========================



   .. ============================== method details =========================






   .. js:function:: vgl.shaderProgram.queryUniformLocation(name)





       :param  name:







       Query uniform location in the program












       :returns:


       :rtype: *










   .. js:function:: vgl.shaderProgram.queryAttributeLocation(name)





       :param  name:







       Query attribute location in the program












       :returns:


       :rtype: *










   .. js:function:: vgl.shaderProgram.addShader(shader)





       :param  shader:







       Add a new shader to the program












       :returns:


       :rtype: boolean










   .. js:function:: vgl.shaderProgram.addUniform(uniform)





       :param  uniform:







       Add a new uniform to the program












       :returns:


       :rtype: boolean










   .. js:function:: vgl.shaderProgram.addVertexAttribute(attr, key)





       :param  attr:





       :param  key:







       Add a new vertex attribute to the program



















   .. js:function:: vgl.shaderProgram.uniformLocation(name)





       :param  name:







       Get uniform location

       This method does not perform any query into the program but relies on
       the fact that it depends on a call to queryUniformLocation earlier.












       :returns:


       :rtype: number










   .. js:function:: vgl.shaderProgram.attributeLocation(name)





       :param  name:







       Get attribute location

       This method does not perform any query into the program but relies on the
       fact that it depends on a call to queryUniformLocation earlier.












       :returns:


       :rtype: number










   .. js:function:: vgl.shaderProgram.uniform(name)





       :param  name:







       Get uniform object using name as the key












       :returns:


       :rtype: *










   .. js:function:: vgl.shaderProgram.updateUniforms()





       Update all uniforms

       This method should be used directly unless required



















   .. js:function:: vgl.shaderProgram.link()





       Link shader program












       :returns:


       :rtype: boolean










   .. js:function:: vgl.shaderProgram.use()





       Use the shader program



















   .. js:function:: vgl.shaderProgram.cleanUp()





       Peform any clean up required when the program gets deleted



















   .. js:function:: vgl.shaderProgram.deleteProgram()





       Delete the shader program



















   .. js:function:: vgl.shaderProgram.deleteVertexAndFragment()





       Delete vertex and fragment shaders



















   .. js:function:: vgl.shaderProgram.bind(renderState)





       :param  renderState:







       Bind the program with its shaders












       :returns:


       :rtype: boolean










   .. js:function:: vgl.shaderProgram.undoBind(renderState)





       :param  renderState:







       Undo binding of the shader program



















   .. js:function:: vgl.shaderProgram.bindVertexData(renderState, key)





       :param  renderState:





       :param  key:







       Bind vertex data



















   .. js:function:: vgl.shaderProgram.undoBindVertexData(renderState, key)





       :param  renderState:





       :param  key:







       Undo bind vetex data



















   .. js:function:: vgl.shaderProgram.bindUniforms()





       Bind uniforms



















   .. js:function:: vgl.shaderProgram.bindAttributes()





       Bind vertex attributes


















   .. ============================== event details =========================

Documentation generated by jsdoc-toolkit 2.4.0 using jsdoc-toolkit-rst-template