Feature support. - Githubissues

There is need to support every WebGL feature, it doesn't mean that every javascript function will be literally translated, though.

When possible, ClojureScript features will be used to for supporting a more idiomatic API. Specifically:

Function overloading is preferred over the OpenGL style of creating multiple functions with different names for each parameter signature;
Side-effect only functions will not be directly exposed (there are a few exceptions);
Property access will be exposed through functions.

Below follows a complete list of WebGL functions as in WebGL Specification Version 1.0.2:

Context related:

[x] readonly attribute HTMLCanvasElement canvas -> get-canvas;
[x] readonly attribute GLsizei drawingBufferWidth -> get-drawing-buffer-width;
[x] readonly attribute GLsizei drawingBufferHeight -> get-drawing-buffer-height;
[x] [WebGLHandlesContextLoss] WebGLContextAttributes? getContextAttributes() -> get-context-attributes;
[x] [WebGLHandlesContextLoss] boolean isContextLost() -> is-context-lost?;
[x] sequence? getSupportedExtensions() -> get-supported-extensions;
[x] object? getExtension(DOMString name) -> get-extension The returned objects are not yet wraped in ClojureScript constructs.;
[x] void shaderSource(WebGLShader? shader, DOMString source) Not directly exposed. Used internally by create-shader;
Shader related:
[x] void attachShader(WebGLProgram? program, WebGLShader? shader) _Not directly exposed. Used internally by create-program _;
[x] void compileShader(WebGLShader? shader) \ Not directly exposed. Used internally by create-shader **;
[x] WebGLShader? createShader(GLenum type) -> create-shader;
[x] void detachShader(WebGLProgram? program, WebGLShader? shader) -> Won't be exposed.;
[x] sequence? getAttachedShaders(WebGLProgram? program) -> get-attached-shaders;
[x] any getShaderParameter(WebGLShader? shader, GLenum pname) -> get-shader-parameter;
[x] WebGLShaderPrecisionFormat? getShaderPrecisionFormat(GLenum shadertype, GLenum precisiontype) -> get-shader-precision-format;
[x] DOMString? getShaderInfoLog(WebGLShader? shader) -> get-shader-info-log;
[x] DOMString? getShaderSource(WebGLShader? shader) -> get-shader-source;
[x] void deleteShader(WebGLShader? shader) -> Won't be exposed. The objects will be garbage collected.
[x] WebGLProgram? createProgram() -> create-program;
[x] [WebGLHandlesContextLoss] GLboolean isShader(WebGLShader? shader) -> is-shader?;
[x] void deleteProgram(WebGLProgram? program); Won't be exposed. The objects will be garbage collected.;
[x] void linkProgram(WebGLProgram? program) -> Not directly exposed. Used interbally by create-program;
[x] [WebGLHandlesContextLoss] GLboolean isProgram(WebGLProgram? program);
[ ] void bindAttribLocation(WebGLProgram? program, GLuint index, DOMString name);
[ ] WebGLActiveInfo? getActiveAttrib(WebGLProgram? program, GLuint index);
[ ] WebGLActiveInfo? getActiveUniform(WebGLProgram? program, GLuint index);
[x] [WebGLHandlesContextLoss] GLint getAttribLocation(WebGLProgram? program, DOMString name) -> get-attrib-location;
[ ] any getProgramParameter(WebGLProgram? program, GLenum pname);
[ ] DOMString? getProgramInfoLog(WebGLProgram? program);
[ ] any getUniform(WebGLProgram? program, WebGLUniformLocation? location);
[x] WebGLUniformLocation? getUniformLocation(WebGLProgram? program, DOMString name) -> get-uniform-location;
[x] void useProgram(WebGLProgram? program) -> \ Won't be exposed as each call to draw! receive a program parameter. **;
[ ] void validateProgram(WebGLProgram? program);
[x] void uniform1f(WebGLUniformLocation? location, GLfloat x);
[x] void uniform1fv(WebGLUniformLocation? location, Float32Array v);
[x] void uniform1fv(WebGLUniformLocation? location, sequence v);
[x] void uniform1i(WebGLUniformLocation? location, GLint x);
[x] void uniform1iv(WebGLUniformLocation? location, Int32Array v);
[x] void uniform1iv(WebGLUniformLocation? location, sequence v);
[x] void uniform2f(WebGLUniformLocation? location, GLfloat x, GLfloat y);
[x] void uniform2fv(WebGLUniformLocation? location, Float32Array v);
[x] void uniform2fv(WebGLUniformLocation? location, sequence v);
[x] void uniform2i(WebGLUniformLocation? location, GLint x, GLint y);
[x] void uniform2iv(WebGLUniformLocation? location, Int32Array v);
[x] void uniform2iv(WebGLUniformLocation? location, sequence v);
[x] void uniform3f(WebGLUniformLocation? location, GLfloat x, GLfloat y, GLfloat z);
[x] void uniform3fv(WebGLUniformLocation? location, Float32Array v);
[x] void uniform3fv(WebGLUniformLocation? location, sequence v);
[x] void uniform3i(WebGLUniformLocation? location, GLint x, GLint y, GLint z);
[x] void uniform3iv(WebGLUniformLocation? location, Int32Array v);
[x] void uniform3iv(WebGLUniformLocation? location, sequence v);
[x] void uniform4f(WebGLUniformLocation? location, GLfloat x, GLfloat y, GLfloat z, GLfloat w);
[x] void uniform4fv(WebGLUniformLocation? location, Float32Array v);
[x] void uniform4fv(WebGLUniformLocation? location, sequence v);
[x] void uniform4i(WebGLUniformLocation? location, GLint x, GLint y, GLint z, GLint w);
[x] void uniform4iv(WebGLUniformLocation? location, Int32Array v);
[x] void uniform4iv(WebGLUniformLocation? location, sequence v);
[x] void uniformMatrix2fv(WebGLUniformLocation? location, GLboolean transpose, Float32Array value);
[x] void uniformMatrix2fv(WebGLUniformLocation? location, GLboolean transpose, sequence value);
[x] void uniformMatrix3fv(WebGLUniformLocation? location, GLboolean transpose, Float32Array value);
[x] void uniformMatrix3fv(WebGLUniformLocation? location, GLboolean transpose, sequence value);
[x] void uniformMatrix4fv(WebGLUniformLocation? location, GLboolean transpose, Float32Array value);
[x] void uniformMatrix4fv(WebGLUniformLocation? location, GLboolean transpose, sequence value);
[ ] void vertexAttrib1f(GLuint indx, GLfloat x);
[ ] void vertexAttrib1fv(GLuint indx, Float32Array values);
[ ] void vertexAttrib1fv(GLuint indx, sequence values);
[ ] void vertexAttrib2f(GLuint indx, GLfloat x, GLfloat y);
[ ] void vertexAttrib2fv(GLuint indx, Float32Array values);
[ ] void vertexAttrib2fv(GLuint indx, sequence values);
[ ] void vertexAttrib3f(GLuint indx, GLfloat x, GLfloat y, GLfloat z);
[ ] void vertexAttrib3fv(GLuint indx, Float32Array values);
[ ] void vertexAttrib3fv(GLuint indx, sequence values);
[ ] void vertexAttrib4f(GLuint indx, GLfloat x, GLfloat y, GLfloat z, GLfloat w);
[ ] void vertexAttrib4fv(GLuint indx, Float32Array values);
[ ] void vertexAttrib4fv(GLuint indx, sequence values);
VBO Related:
[x] void bindBuffer(GLenum target, WebGLBuffer? buffer) Won't be directly exposed;
[x] void bufferData(GLenum target, GLsizeiptr size, GLenum usage) Won't be directly exposed;
[x] void bufferData(GLenum target, ArrayBufferView data, GLenum usage) Won't be directly exposed ;
[x] void bufferData(GLenum target, ArrayBuffer? data, GLenum usage) Won't be directly exposed ;
[x] void bufferSubData(GLenum target, GLintptr offset, ArrayBufferView data) Won't be exposed.;
[x] void bufferSubData(GLenum target, GLintptr offset, ArrayBuffer? data) Won't be exposed.;
[x] WebGLBuffer? createBuffer() -> create-buffer;
[x] void deleteBuffer(WebGLBuffer? buffer) Buffers will be garbage collected.;
[x] void drawArrays(GLenum mode, GLint first, GLsizei count);
[x] void drawElements(GLenum mode, GLsizei count, GLenum type, GLintptr offset);
[x] void enableVertexAttribArray(GLuint index);
[x] void vertexAttribPointer(GLuint indx, GLint size, GLenum type, GLboolean normalized, GLsizei stride, GLintptr offset);
Texture related:
[ ] void activeTexture(GLenum texture);
[ ] void bindTexture(GLenum target, WebGLTexture? texture);
[ ] void compressedTexImage2D(GLenum target, GLint level, GLenum internalformat, GLsizei width, GLsizei height, GLint border,ArrayBufferView data);
[ ] void compressedTexSubImage2D(GLenum target, GLint level, GLint xoffset, GLint yoffset, GLsizei width, GLsizei height, GLenum format, ArrayBufferView data);
[ ] void copyTexImage2D(GLenum target, GLint level, GLenum internalformat, GLint x, GLint y, GLsizei width, Lsizei height, GLint border);
[ ] void copyTexSubImage2D(GLenum target, GLint level, GLint xoffset, GLint yoffset, GLint x, GLint y, GLsizei width, GLsizei height);
[ ] void framebufferTexture2D(GLenum target, GLenum attachment, GLenum textarget, WebGLTexture? texture, GLint level);
[ ] [WebGLHandlesContextLoss] GLboolean isTexture(WebGLTexture? texture);
[ ] void texImage2D(GLenum target, GLint level, GLenum internalformat, GLsizei width, GLsizei height, GLint border, GLenum format, GLenum type, ArrayBufferView? pixels);
[ ] void texImage2D(GLenum target, GLint level, GLenum internalformat, GLenum format, GLenum type, ImageData? pixels);
[ ] void texImage2D(GLenum target, GLint level, GLenum internalformat, GLenum format, GLenum type, HTMLImageElement image); // May throw DOMException
[ ] void texImage2D(GLenum target, GLint level, GLenum internalformat, GLenum format, GLenum type, HTMLCanvasElement canvas); // May throw DOMException
[ ] void texImage2D(GLenum target, GLint level, GLenum internalformat, GLenum format, GLenum type, HTMLVideoElement video); // May throw DOMException
[ ] void texParameterf(GLenum target, GLenum pname, GLfloat param);
[ ] void texParameteri(GLenum target, GLenum pname, GLint param);
[ ] void texSubImage2D(GLenum target, GLint level, GLint xoffset, GLint yoffset, GLsizei width, GLsizei height, GLenum format, GLenum type, ArrayBufferView? pixels);
[ ] void texSubImage2D(GLenum target, GLint level, GLint xoffset, GLint yoffset, GLenum format, GLenum type, ImageData? pixels);
[ ] void texSubImage2D(GLenum target, GLint level, GLint xoffset, GLint yoffset, GLenum format, GLenum type, HTMLImageElement image); // May throw DOMException
[ ] void texSubImage2D(GLenum target, GLint level, GLint xoffset, GLint yoffset, GLenum format, GLenum type, HTMLCanvasElement canvas); // May throw DOMException
[ ] void texSubImage2D(GLenum target, GLint level, GLint xoffset, GLint yoffset, GLenum format, GLenum type, HTMLVideoElement video); // May throw DOMException
[ ] void deleteTexture(WebGLTexture? texture);
[ ] WebGLTexture? createTexture();
Uncategorized:
[ ] void bindFramebuffer(GLenum target, WebGLFramebuffer? framebuffer);
[ ] void bindRenderbuffer(GLenum target, WebGLRenderbuffer? renderbuffer);
[ ] void blendColor(GLclampf red, GLclampf green, GLclampf blue, GLclampf alpha);
[ ] void blendEquation(GLenum mode);
[ ] void blendEquationSeparate(GLenum modeRGB, GLenum modeAlpha);
[ ] void blendFunc(GLenum sfactor, GLenum dfactor);
[ ] void blendFuncSeparate(GLenum srcRGB, GLenum dstRGB, GLenum srcAlpha, GLenum dstAlpha);
[ ] [WebGLHandlesContextLoss] GLenum checkFramebufferStatus(GLenum target);
[x] void clear(GLbitfield mask);
[x] void clearColor(GLclampf red, GLclampf green, GLclampf blue, GLclampf alpha);
[x] void clearDepth(GLclampf depth);
[x] void clearStencil(GLint s);
[ ] void colorMask(GLboolean red, GLboolean green, GLboolean blue, GLboolean alpha);
[ ] WebGLFramebuffer? createFramebuffer();
[ ] WebGLRenderbuffer? createRenderbuffer();
[ ] void cullFace(GLenum mode);
[ ] void deleteFramebuffer(WebGLFramebuffer? framebuffer);
[ ] void deleteRenderbuffer(WebGLRenderbuffer? renderbuffer);
[ ] void depthFunc(GLenum func);
[ ] void depthMask(GLboolean flag);
[ ] void depthRange(GLclampf zNear, GLclampf zFar);
[x] void disable(GLenum cap);
[x] void disableVertexAttribArray(GLuint index);
[x] void enable(GLenum cap);
[ ] void finish();
[ ] void flush();
[ ] void framebufferRenderbuffer(GLenum target, GLenum attachment, GLenum renderbuffertarget, WebGLRenderbuffer? renderbuffer);
[ ] void frontFace(GLenum mode);
[ ] void generateMipmap(GLenum target);
[ ] any getBufferParameter(GLenum target, GLenum pname);
[ ] any getParameter(GLenum pname);
[ ] [WebGLHandlesContextLoss] GLenum getError();
[ ] any getFramebufferAttachmentParameter(GLenum target, GLenum attachment, GLenum pname);
[ ] any getRenderbufferParameter(GLenum target, GLenum pname);
[ ] any getTexParameter(GLenum target, GLenum pname);
[ ] any getVertexAttrib(GLuint index, GLenum pname);
[ ] [WebGLHandlesContextLoss] GLsizeiptr getVertexAttribOffset(GLuint index, GLenum pname);
[ ] void hint(GLenum target, GLenum mode);
[ ] [WebGLHandlesContextLoss] GLboolean isBuffer(WebGLBuffer? buffer);
[x] [WebGLHandlesContextLoss] GLboolean isEnabled(GLenum cap);
[ ] [WebGLHandlesContextLoss] GLboolean isFramebuffer(WebGLFramebuffer? framebuffer);
[ ] [WebGLHandlesContextLoss] GLboolean isRenderbuffer(WebGLRenderbuffer? renderbuffer);
[ ] void lineWidth(GLfloat width);
[ ] void pixelStorei(GLenum pname, GLint param);
[ ] void polygonOffset(GLfloat factor, GLfloat units);
[ ] void readPixels(GLint x, GLint y, GLsizei width, GLsizei height, GLenum format, GLenum type, ArrayBufferView? pixels);
[ ] void renderbufferStorage(GLenum target, GLenum internalformat, GLsizei width, GLsizei height);
[ ] void sampleCoverage(GLclampf value, GLboolean invert);
[ ] void scissor(GLint x, GLint y, GLsizei width, GLsizei height);
[ ] void stencilFunc(GLenum func, GLint ref, GLuint mask);
[ ] void stencilFuncSeparate(GLenum face, GLenum func, GLint ref, GLuint mask);
[ ] void stencilMask(GLuint mask);
[ ] void stencilMaskSeparate(GLenum face, GLuint mask);
[ ] void stencilOp(GLenum fail, GLenum zfail, GLenum zpass);
[ ] void stencilOpSeparate(GLenum face, GLenum fail, GLenum zfail, GLenum zpass);
[x] void viewport(GLint x, GLint y, GLsizei width, GLsizei height);

asakeron / cljs-webgl

Feature support. #1

Context related:

Shader related:

VBO Related:

Texture related:

Uncategorized: