src/shl_gl.h

   1 /*
   2  * shl - OpenGL Helpers
   3  *
   4  * Copyright (c) 2011-2013 David Herrmann <dh.herrmann@gmail.com>
   5  *
   6  * Permission is hereby granted, free of charge, to any person obtaining
   7  * a copy of this software and associated documentation files
   8  * (the "Software"), to deal in the Software without restriction, including
   9  * without limitation the rights to use, copy, modify, merge, publish,
  10  * distribute, sublicense, and/or sell copies of the Software, and to
  11  * permit persons to whom the Software is furnished to do so, subject to
  12  * the following conditions:
  13  *
  14  * The above copyright notice and this permission notice shall be included
  15  * in all copies or substantial portions of the Software.
  16  *
  17  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
  18  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  19  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
  20  * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
  21  * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
  22  * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
  23  * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  24  */
  25
  26 /*
  27  * OpenGL Helpers
  28  * This file provides several helper functions that are commonly used when
  29  * working with OpenGL.
  30  * TODO: Rename to shl_gl_* prefix.
  31  */
  32
  33 #ifndef SHL_GL_H
  34 #define SHL_GL_H
  35
  36 #include <GLES2/gl2.h>
  37 #include <GLES2/gl2ext.h>
  38 #include <stdbool.h>
  39 #include <stdlib.h>
  40 #include <stddef.h>
  41 #include "shl_llog.h"
  42
  43 /*
  44  * Math Helpers
  45  * The gl_m4 type is a 4x4 matrix of floats. The gl_m4_stack is a stack of m4
  46  * matrices where you can only access the top-most member.
  47  */
  48
  49 struct gl_m4_stack;
  50
  51 void gl_m4_identity(float *m);
  52 void gl_m4_copy(float *dest, const float *src);
  53 void gl_m4_mult_dest(float *dest, const float *n, const float *m);
  54 void gl_m4_mult(float *n, const float *m);
  55 void gl_m4_translate(float *m, float x, float y, float z);
  56 void gl_m4_scale(float *m, float x, float y, float z);
  57 void gl_m4_transpose_dest(float *dest, const float *src);
  58 void gl_m4_transpose(float *m);
  59
  60 int gl_m4_stack_new(struct gl_m4_stack **out);
  61 void gl_m4_stack_free(struct gl_m4_stack *stack);
  62 float *gl_m4_stack_push(struct gl_m4_stack *stack);
  63 float *gl_m4_stack_pop(struct gl_m4_stack *stack);
  64 float *gl_m4_stack_tip(struct gl_m4_stack *stack);
  65
  66 /*
  67  * Shader Helpers
  68  * These helpers load, compile and link shaders and allow easy attribute/uniform
  69  * access.
  70  */
  71
  72 struct gl_shader;
  73
  74 int gl_shader_new(struct gl_shader **out, const char *vert, const char *frag,
  75                   char **attr, size_t attr_count, llog_submit_t llog,
  76                   void *llog_data);
  77 void gl_shader_ref(struct gl_shader *shader);
  78 void gl_shader_unref(struct gl_shader *shader);
  79 GLuint gl_shader_get_uniform(struct gl_shader *shader, const char *name);
  80 void gl_shader_use(struct gl_shader *shader);
  81
  82 void gl_tex_new(GLuint *tex, size_t num);
  83 void gl_tex_free(GLuint *tex, size_t num);
  84 void gl_tex_load(GLuint tex, unsigned int width, unsigned int stride,
  85                  unsigned int height, uint8_t *buf);
  86
  87 void gl_clear_error();
  88 bool gl_has_error(struct gl_shader *shader);
  89 const char *gl_err_to_str(GLenum err);
  90
  91 #endif /* SHL_GL_H */