lib/glesv2: intro some glTexParameter related features
[nit.git] / lib / glesv2 / glesv2.nit
index b533b36..814ec68 100644 (file)
@@ -67,6 +67,13 @@ extern class GLProgram `{GLuint`}
                return glGetAttribLocation(recv, c_name);
        `}
 
+       # Get the location of the uniform by `name`
+       #
+       # Returns `-1` if there is no active uniform named `name`.
+       fun uniform_location(name: String): Int import String.to_cstring `{
+               GLchar *c_name = String_to_cstring(name);
+               return glGetUniformLocation(recv, c_name);
+       `}
 
        # Query information on this program
        fun query(pname: Int): Int `{
@@ -110,14 +117,90 @@ extern class GLProgram `{GLuint`}
                glGetProgramInfoLog(recv, size, NULL, msg);
                return NativeString_to_s(msg);
        `}
+
+       # Number of active uniform in this program
+       #
+       # This should be the number of uniforms declared in all shader, except
+       # unused uniforms which may have been optimized out.
+       fun n_active_uniforms: Int do return query(0x8B86)
+
+       # Length of the longest uniform name in this program, including `\n`
+       fun active_uniform_max_length: Int do return query(0x8B87)
+
+       # Number of active attributes in this program
+       #
+       # This should be the number of uniforms declared in all shader, except
+       # unused uniforms which may have been optimized out.
+       fun n_active_attributes: Int do return query(0x8B89)
+
+       # Length of the longest uniform name in this program, including `\n`
+       fun active_attribute_max_length: Int do return query(0x8B8A)
+
+       # Number of shaders attached to this program
+       fun n_attached_shaders: Int do return query(0x8B85)
+
+       # Name of the active attribute at `index`
+       fun active_attrib_name(index: Int): String
+       do
+               var max_size = active_attribute_max_length
+               return active_attrib_name_native(index, max_size).to_s
+       end
+       private fun active_attrib_name_native(index, max_size: Int): NativeString `{
+               char *name = malloc(max_size);
+               glGetActiveAttrib(recv, index, max_size, NULL, NULL, NULL, name);
+               return name;
+       `}
+
+       # Size of the active attribute at `index`
+       fun active_attrib_size(index: Int): Int `{
+               int size;
+               glGetActiveAttrib(recv, index, 0, NULL, NULL, &size, NULL);
+               return size;
+       `}
+
+       # Type of the active attribute at `index`
+       #
+       # May only be float related data types (single float, vectors and matrix).
+       fun active_attrib_type(index: Int): GLFloatDataType `{
+               GLenum type;
+               glGetActiveAttrib(recv, index, 0, NULL, &type, NULL, NULL);
+               return type;
+       `}
+
+       # Name of the active uniform at `index`
+       fun active_uniform_name(index: Int): String
+       do
+               var max_size = active_attribute_max_length
+               return active_uniform_name_native(index, max_size).to_s
+       end
+       private fun active_uniform_name_native(index, max_size: Int): NativeString `{
+               char *name = malloc(max_size);
+               glGetActiveUniform(recv, index, max_size, NULL, NULL, NULL, name);
+               return name;
+       `}
+
+       # Size of the active uniform at `index`
+       fun active_uniform_size(index: Int): Int `{
+               int size;
+               glGetActiveUniform(recv, index, 0, NULL, NULL, &size, NULL);
+               return size;
+       `}
+
+       # Type of the active uniform at `index`
+       #
+       # May be any data type supported by OpenGL ES 2.0 shaders.
+       fun active_uniform_type(index: Int): GLDataType `{
+               GLenum type;
+               glGetActiveUniform(recv, index, 0, NULL, &type, NULL, NULL);
+               return type;
+       `}
 end
 
 # Abstract OpenGL ES shader object, implemented by `GLFragmentShader` and `GLVertexShader`
 extern class GLShader `{GLuint`}
        # Set the source of the shader
-       fun source=(code: String) import String.to_cstring, String.length `{
-               GLchar *c_code = String_to_cstring(code);
-               glShaderSource(recv, 1, (const GLchar * const*)&c_code, NULL);
+       fun source=(code: NativeString) `{
+               glShaderSource(recv, 1, (GLchar const **)&code, NULL);
        `}
 
        # Source of the shader, if available
@@ -234,8 +317,17 @@ extern class GLfloatArray `{GLfloat *`}
        `}
 end
 
+# General type for OpenGL enumerations
+extern class GLEnum `{ GLenum `}
+
+       redef fun hash `{ return recv; `}
+
+       redef fun ==(o) do return o != null and is_same_type(o) and o.hash == self.hash
+end
+
 # An OpenGL ES 2.0 error code
-extern class GLError `{ GLenum `}
+extern class GLError
+       super GLEnum
        fun is_ok: Bool do return is_no_error
        fun is_no_error: Bool `{ return recv == GL_NO_ERROR; `}
        fun is_invalid_enum: Bool `{ return recv == GL_INVALID_ENUM; `}
@@ -256,56 +348,217 @@ extern class GLError `{ GLenum `}
        end
 end
 
-# Clear the color buffer with `r`, `g`, `b`, `a`
-protected fun gl_clear_color(r, g, b, a: Float) `{ glClearColor(r, g, b, a); `}
-
-# Set the viewport
-protected fun gl_viewport(x, y, width, height: Int) `{ glViewport(x, y, width, height); `}
-
-# Direct call to `glClear`, call with a combinaison of `gl_clear_color_buffer`,
-# `gl_stencil_buffer_bit` and `gl_color_buffer_bit`.
-private fun gl_clear(flag: Int) `{ glClear(flag); `}
-
-protected fun gl_depth_buffer_bit: Int do return 0x0100
-protected fun gl_stencil_buffer_bit: Int do return 0x0400
-protected fun gl_color_buffer_bit: Int do return 0x4000
-
-protected fun gl_clear_color_buffer do gl_clear(gl_color_buffer_bit)
-protected fun gl_clear_depth_buffer do gl_clear(gl_depth_buffer_bit)
-protected fun gl_clear_stencil_buffer do gl_clear(gl_stencil_buffer_bit)
-
-protected fun gl_error: GLError `{ return glGetError(); `}
 protected fun assert_no_gl_error
 do
-       var error = gl_error
+       var error = gl.error
        if not error.is_ok then
                print "GL error: {error}"
                abort
        end
 end
 
-# Query the boolean value at `key`
-private fun gl_get_bool(key: Int): Bool `{
-       GLboolean val;
-       glGetBooleanv(key, &val);
-       return val == GL_TRUE;
-`}
+# Texture minifying function
+#
+# Used by: `GLES::tex_parameter_min_filter`
+extern class GLTextureMinFilter
+       super GLEnum
 
-# Query the floating point value at `key`
-private fun gl_get_float(key: Int): Float `{
-       GLfloat val;
-       glGetFloatv(key, &val);
-       return val;
-`}
+       new nearest `{ return GL_NEAREST; `}
+       new linear `{ return GL_LINEAR; `}
+end
 
-# Query the integer value at `key`
-private fun gl_get_int(key: Int): Int `{
-       GLint val;
-       glGetIntegerv(key, &val);
-       return val;
-`}
+# Texture magnification function
+#
+# Used by: `GLES::tex_parameter_mag_filter`
+extern class GLTextureMagFilter
+       super GLEnum
+
+       new nearest `{ return GL_NEAREST; `}
+       new linear `{ return GL_LINEAR; `}
+       new nearest_mipmap_nearest `{ return GL_NEAREST_MIPMAP_NEAREST; `}
+       new linear_mipmap_nearest `{ return GL_LINEAR_MIPMAP_NEAREST; `}
+       new nearest_mipmap_linear `{ return GL_NEAREST_MIPMAP_LINEAR; `}
+       new linear_mipmap_linear `{ return GL_LINEAR_MIPMAP_LINEAR; `}
+end
+
+# Wrap parameter of a texture
+#
+# Used by: `tex_parameter_wrap_*`
+extern class GLTextureWrap
+       super GLEnum
+
+       new clamp_to_edge `{ return GL_CLAMP_TO_EDGE; `}
+       new mirrored_repeat `{ return GL_MIRRORED_REPEAT; `}
+       new repeat `{ return GL_REPEAT; `}
+end
+
+# Target texture
+#
+# Used by: `tex_parameter_*`
+extern class GLTextureTarget
+       super GLEnum
 
-# Does this driver support shader compilation?
+       new flat `{ return GL_TEXTURE_2D; `}
+       new cube_map `{ return GL_TEXTURE_CUBE_MAP; `}
+end
+
+redef class Sys
+       private var gles = new GLES is lazy
+end
+
+# Entry points to OpenGL ES 2.0 services
+fun gl: GLES do return sys.gles
+
+# OpenGL ES 2.0 services
+class GLES
+
+       # Clear the color buffer to `red`, `green`, `blue` and `alpha`
+       fun clear_color(red, green, blue, alpha: Float) `{
+               glClearColor(red, green, blue, alpha);
+       `}
+
+       # Set the viewport
+       fun viewport(x, y, width, height: Int) `{ glViewport(x, y, width, height); `}
+
+       # Define front- and back-facing polygons
+       #
+       # Front-facing polygons are clockwise if `value`, counter-clockwise otherwise.
+       fun front_face=(value: Bool) `{ glFrontFace(value? GL_CW: GL_CCW); `}
+
+       # Specify whether front- or back-facing polygons can be culled, default is `back` only
+       #
+       # One or both of `front` or `back` must be `true`. If you want to deactivate culling
+       # use `(new GLCap.cull_face).disable`.
+       #
+       # Require: `front or back`
+       fun cull_face(front, back: Bool)
+       do
+               assert not (front or back)
+               cull_face_native(front, back)
+       end
+
+       private fun cull_face_native(front, back: Bool) `{
+               glCullFace(front? back? GL_FRONT_AND_BACK: GL_BACK: GL_FRONT);
+       `}
+
+       # Clear the `buffer`
+       fun clear(buffer: GLBuffer) `{ glClear(buffer); `}
+
+       # Last error from OpenGL ES 2.0
+       fun error: GLError `{ return glGetError(); `}
+
+       # Query the boolean value at `key`
+       private fun get_bool(key: Int): Bool `{
+               GLboolean val;
+               glGetBooleanv(key, &val);
+               return val == GL_TRUE;
+       `}
+
+       # Query the floating point value at `key`
+       private fun get_float(key: Int): Float `{
+               GLfloat val;
+               glGetFloatv(key, &val);
+               return val;
+       `}
+
+       # Query the integer value at `key`
+       private fun get_int(key: Int): Int `{
+               GLint val;
+               glGetIntegerv(key, &val);
+               return val;
+       `}
+
+       # Does this driver support shader compilation?
+       #
+       # Should always return `true` in OpenGL ES 2.0 and 3.0.
+       fun shader_compiler: Bool do return get_bool(0x8DFA)
+
+       # Set the texture minifying function
+       #
+       # Foreign: glTexParameter with GL_TEXTURE_MIN_FILTER
+       fun tex_parameter_min_filter(target: GLTextureTarget, value: GLTextureMinFilter) `{
+               glTexParameteri(target, GL_TEXTURE_MIN_FILTER, value);
+       `}
+
+       # Set the texture magnification function
+       #
+       # Foreign: glTexParameter with GL_TEXTURE_MAG_FILTER
+       fun tex_parameter_mag_filter(target: GLTextureTarget, value: GLTextureMagFilter) `{
+               glTexParameteri(target, GL_TEXTURE_MAG_FILTER, value);
+       `}
+
+       # Set the texture wrap parameter for coordinates _s_
+       #
+       # Foreign: glTexParameter with GL_TEXTURE_WRAP_S
+       fun tex_parameter_wrap_s(target: GLTextureTarget, value: GLTextureWrap) `{
+               glTexParameteri(target, GL_TEXTURE_WRAP_S, value);
+       `}
+
+       # Set the texture wrap parameter for coordinates _t_
+       #
+       # Foreign: glTexParameter with GL_TEXTURE_WRAP_T
+       fun tex_parameter_wrap_t(target: GLTextureTarget, value: GLTextureWrap) `{
+               glTexParameteri(target, GL_TEXTURE_WRAP_T, value);
+       `}
+end
+
+# Float related data types of OpenGL ES 2.0 shaders
 #
-# Should always return `true` in OpenGL ES 2.0 and 3.0.
-fun gl_shader_compiler: Bool do return gl_get_bool(0x8DFA)
+# Only data types supported by shader attributes, as seen with
+# `GLProgram::active_attrib_type`.
+extern class GLFloatDataType
+       super GLEnum
+
+       fun is_float: Bool `{ return recv == GL_FLOAT; `}
+       fun is_float_vec2: Bool `{ return recv == GL_FLOAT_VEC2; `}
+       fun is_float_vec3: Bool `{ return recv == GL_FLOAT_VEC3; `}
+       fun is_float_vec4: Bool `{ return recv == GL_FLOAT_VEC4; `}
+       fun is_float_mat2: Bool `{ return recv == GL_FLOAT_MAT2; `}
+       fun is_float_mat3: Bool `{ return recv == GL_FLOAT_MAT3; `}
+       fun is_float_mat4: Bool `{ return recv == GL_FLOAT_MAT4; `}
+
+       # Instances of `GLFloatDataType` can be equal to instances of `GLDataType`
+       redef fun ==(o)
+       do
+               return o != null and o isa GLFloatDataType and o.hash == self.hash
+       end
+end
+
+# All data types of OpenGL ES 2.0 shaders
+#
+# These types can be used by shader uniforms, as seen with
+# `GLProgram::active_uniform_type`.
+extern class GLDataType
+       super GLFloatDataType
+
+       fun is_int: Bool `{ return recv == GL_INT; `}
+       fun is_int_vec2: Bool `{ return recv == GL_INT_VEC2; `}
+       fun is_int_vec3: Bool `{ return recv == GL_INT_VEC3; `}
+       fun is_int_vec4: Bool `{ return recv == GL_INT_VEC4; `}
+       fun is_bool: Bool `{ return recv == GL_BOOL; `}
+       fun is_bool_vec2: Bool `{ return recv == GL_BOOL_VEC2; `}
+       fun is_bool_vec3: Bool `{ return recv == GL_BOOL_VEC3; `}
+       fun is_bool_vec4: Bool `{ return recv == GL_BOOL_VEC4; `}
+       fun is_sampler_2d: Bool `{ return recv == GL_SAMPLER_2D; `}
+       fun is_sampler_cube: Bool `{ return recv == GL_SAMPLER_CUBE; `}
+end
+
+# Set of buffers as a bitwise OR mask, used by `GLES::clear`
+#
+# ~~~
+# var buffers = (new GLBuffer).color.depth
+# gl.clear buffers
+# ~~~
+extern class GLBuffer `{ GLbitfield `}
+       # Get an empty set of buffers
+       new `{ return 0; `}
+
+       # Add the color buffer to the returned buffer set
+       fun color: GLBuffer `{ return recv | GL_COLOR_BUFFER_BIT; `}
+
+       # Add the depth buffer to the returned buffer set
+       fun depth: GLBuffer `{ return recv | GL_DEPTH_BUFFER_BIT; `}
+
+       # Add the stencil buffer to the returned buffer set
+       fun stencil: GLBuffer `{ return recv | GL_STENCIL_BUFFER_BIT; `}
+end