git.maemo.org Git - sdlhildon/blob - sdlgles/src/SDL_gles.h

   1 /* This file is part of SDL_gles - SDL addon for OpenGL|ES
   2  * Copyright (C) 2010 Javier S. Pedro
   3  *
   4  * This library is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU Lesser General Public
   6  * License as published by the Free Software Foundation; either
   7  * version 3 of the License, or (at your option) any later version.
   8  *
   9  * This library is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * Lesser General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Lesser General Public
  15  * License along with this library; if not, write to the
  16  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  17  * Boston, MA 02111-1307, USA or see <http://www.gnu.org/licenses/>.
  18  */
  19
  20 #ifndef __SDL_GLES_H
  21 #define __SDL_GLES_H
  22
  23 /* Set up for C function definitions, even when using C++ */
  24 #ifdef __cplusplus
  25 extern "C" {
  26 #endif
  27
  28 typedef enum SDL_GLES_Version
  29 {
  30         SDL_GLES_VERSION_NONE = 0,
  31         SDL_GLES_VERSION_1_1 = 1,
  32         SDL_GLES_VERSION_2_0 = 2
  33 } SDL_GLES_Version;
  34
  35 typedef enum SDL_GLES_Attr
  36 {
  37         SDL_GLES_BUFFER_SIZE = 0,
  38         SDL_GLES_RED_SIZE,
  39         SDL_GLES_GREEN_SIZE,
  40         SDL_GLES_BLUE_SIZE,
  41         SDL_GLES_ALPHA_SIZE,
  42         SDL_GLES_LUMINANCE_SIZE,
  43         SDL_GLES_DEPTH_SIZE,
  44         SDL_GLES_STENCIL_SIZE
  45 } SDL_GLES_Attr;
  46
  47 typedef struct SDL_GLES_Context
  48 {
  49         /* Opaque pointer to an EGLContext */
  50 } SDL_GLES_Context;
  51
  52 /** Invoke after SDL_Init.
  53         @return 0 if SDL_gles was initialized correctly.
  54   */
  55 extern DECLSPEC int SDLCALL SDL_GLES_Init(SDL_GLES_Version version);
  56
  57 /** Invoke just before SDL_Quit.
  58   */
  59 extern DECLSPEC void SDLCALL SDL_GLES_Quit();
  60
  61 /** Call before calling GetProcAddress. Dynamically loads a GLES library.
  62   * @param path full path to the library to load, or leave as NULL to load
  63   *             the default GL ES library (version as specified in SDL_GLES_Init()).
  64   * @return 0 if everything went OK.
  65   */
  66 extern DECLSPEC int SDLCALL SDL_GLES_LoadLibrary(const char *path);
  67 /** Returns the address of a symbol in the loaded GL ES library.
  68   * @param name of the symbol to look up.
  69   * @return address of the symbol or NULL.
  70   */
  71 extern DECLSPEC void* SDLCALL SDL_GLES_GetProcAddress(const char *proc);
  72
  73 /** Creates a new GL ES rendering context. This is where all your textures,
  74   * etc. are stored. You need one for rendering; after creating it, make sure
  75   * it is the current one calling SDL_GLES_MakeCurrent().
  76   * @return the created context or NULL.
  77   */
  78 extern DECLSPEC SDL_GLES_Context* SDLCALL SDL_GLES_CreateContext(void);
  79 /** Deletes an existing GL ES rendering context. This can delete the current
  80   * context, but after that no context will be current.
  81   * @param context context to delete
  82   */
  83 extern DECLSPEC void SDLCALL SDL_GLES_DeleteContext(SDL_GLES_Context *context);
  84
  85 /** Call after calling SDL_SetVideoMode() if you have an active context
  86   * to refresh the surface parameters.
  87   * @return 0 if everything went OK.
  88   */
  89 extern DECLSPEC int SDLCALL SDL_GLES_SetVideoMode(void);
  90 /** Makes a context the current one. All GLES calls will use it from now on.
  91   * @param context context to use
  92   * @return 0 if everything went OK.
  93   */
  94 extern DECLSPEC int SDLCALL SDL_GLES_MakeCurrent(SDL_GLES_Context *context);
  95
  96 /** Equivalent to SDL_Flip(). Call when you're finished issuing GL calls
  97   * and want to draw the color buffer contents to the window surface.
  98   */
  99 extern DECLSPEC void SDLCALL SDL_GLES_SwapBuffers(void);
 100
 101 /** Sets a specific context attribute before calling SDL_CreateContext().
 102   * @param attr
 103   * @param value
 104   * @return 0 if the attribute exists, -1 otherwise.
 105   */
 106 extern DECLSPEC int SDLCALL SDL_GLES_SetAttribute(SDL_GLES_Attr attr, int value);
 107
 108 /** Gets a context attribute from the current context, or from the wanted
 109   * attribute set if no context is current.
 110   * @param attr
 111   * @param value pointer where the result will be stored.
 112   * @return 0 if the attribute exists, -1 otherwise.
 113   */
 114 extern DECLSPEC int SDLCALL SDL_GLES_GetAttribute(SDL_GLES_Attr attr, int *value);
 115
 116 /* Ends C function definitions when using C++ */
 117 #ifdef __cplusplus
 118 }
 119 #endif
 120
 121 #endif