FL/gl.h

   1 //
   2 // "$Id: gl.h 8623 2011-04-24 17:09:41Z AlbrechtS $"
   3 //
   4 // OpenGL header file for the Fast Light Tool Kit (FLTK).
   5 //
   6 // Copyright 1998-2011 by Bill Spitzak and others.
   7 //
   8 // You must include this instead of GL/gl.h to get the Microsoft
   9 // APIENTRY stuff included (from <windows.h>) prior to the OpenGL
  10 // header files.
  11 //
  12 // This file also provides "missing" OpenGL functions, and
  13 // gl_start() and gl_finish() to allow OpenGL to be used in any window
  14 //
  15 // This library is free software; you can redistribute it and/or
  16 // modify it under the terms of the GNU Library General Public
  17 // License as published by the Free Software Foundation; either
  18 // version 2 of the License, or (at your option) any later version.
  19 //
  20 // This library is distributed in the hope that it will be useful,
  21 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  22 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  23 // Library General Public License for more details.
  24 //
  25 // You should have received a copy of the GNU Library General Public
  26 // License along with this library; if not, write to the Free Software
  27 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
  28 // USA.
  29 //
  30 // Please report all bugs and problems on the following page:
  31 //
  32 //     http://www.fltk.org/str.php
  33 //
  34
  35 /** \file gl.h
  36  *  This file defines wrapper functions for OpenGL in FLTK
  37  *
  38  *  To use OpenGL from within an FLTK application you MUST use gl_visual()
  39  *  to select the default visual before doing show() on any windows. Mesa
  40  *  will crash if yoy try to use a visual not returned by glxChooseVidual.
  41  *
  42  *  This does not work with Fl_Double_Window's!  It will try to draw
  43  *  into the front buffer.  Depending on the system this will either
  44  *  crash or do nothing (when pixmaps are being used as back buffer
  45  *  and GL is being done by hardware), work correctly (when GL is done
  46  *  with software, such as Mesa), or draw into the front buffer and
  47  *  be erased when the buffers are swapped (when double buffer hardware
  48  *  is being used)
  49  */
  50
  51 #ifndef FL_gl_H
  52 #  define FL_gl_H
  53
  54 #  include "Enumerations.H" // for color names
  55 #  ifdef WIN32
  56 #    include <windows.h>
  57 #  endif
  58 #  ifndef APIENTRY
  59 #    if defined(__CYGWIN__)
  60 #      define APIENTRY __attribute__ ((__stdcall__))
  61 #    else
  62 #      define APIENTRY
  63 #    endif
  64 #  endif
  65
  66 #  ifdef __APPLE__
  67 #    include <OpenGL/gl.h>
  68 #  else
  69 #    include <GL/gl.h>
  70 #  endif
  71
  72 FL_EXPORT void gl_start();
  73 FL_EXPORT void gl_finish();
  74
  75 FL_EXPORT void gl_color(Fl_Color i);
  76 /** back compatibility */
  77 inline void gl_color(int c) {gl_color((Fl_Color)c);}
  78
  79 FL_EXPORT void gl_rect(int x,int y,int w,int h);
  80 /**
  81   Fills the given rectangle with the current color.
  82   \see gl_rect(int x, int y, int w, int h)
  83   */
  84 inline void gl_rectf(int x,int y,int w,int h) {glRecti(x,y,x+w,y+h);}
  85
  86 FL_EXPORT void gl_font(int fontid, int size);
  87 FL_EXPORT int  gl_height();
  88 FL_EXPORT int  gl_descent();
  89 FL_EXPORT double gl_width(const char *);
  90 FL_EXPORT double gl_width(const char *, int n);
  91 FL_EXPORT double gl_width(uchar);
  92
  93 FL_EXPORT void gl_draw(const char*);
  94 FL_EXPORT void gl_draw(const char*, int n);
  95 FL_EXPORT void gl_draw(const char*, int x, int y);
  96 FL_EXPORT void gl_draw(const char*, float x, float y);
  97 FL_EXPORT void gl_draw(const char*, int n, int x, int y);
  98 FL_EXPORT void gl_draw(const char*, int n, float x, float y);
  99 FL_EXPORT void gl_draw(const char*, int x, int y, int w, int h, Fl_Align);
 100 FL_EXPORT void gl_measure(const char*, int& x, int& y);
 101 #ifdef __APPLE__
 102 extern FL_EXPORT void gl_texture_pile_height(int max);
 103 extern FL_EXPORT int gl_texture_pile_height();
 104 #endif
 105
 106 FL_EXPORT void gl_draw_image(const uchar *, int x,int y,int w,int h, int d=3, int ld=0);
 107
 108 #endif // !FL_gl_H
 109
 110 //
 111 // End of "$Id: gl.h 8623 2011-04-24 17:09:41Z AlbrechtS $".
 112 //