Using OpenGL in Fltk
#include <FL/gl.h>

With a bit of care you can also use OpenGL to draw into normal fltk windows. This is mostly useful because you can access Gourand shading for drawing your widgets. To do this you use the gl_start() and gl_finish() functions around your OpenGL code.

You must include fltk's <FL/gl.h> header file. It will include the file <GL/gl.h>, plus it defines some extra drawing functions provided by fltk, and also gets around a horrid screwup by our friends in Seattle.

Sample code for subclassing Fl_Gl_Window

  class MyWindow : public Fl_Gl_Window {
    void draw();
    int handle(int);
  public:
    MyWindow(int X, int Y, int W, int H, const char* L)
      : Fl_Gl_Window(X,Y,W,H,L) {}
  };

  void MyWindow::draw() {
    if (!valid()) {
      ... set up projection, viewport, etc ...
      ... window size is in w() and h().
      ... valid() is turned on by fltk after draw() returns
    }
    ... draw ...
  }

  int MyWindow::handle(int event) {
    switch(event) {
    case FL_PUSH:
      ... mouse down event ...
      ... position in Fl::event_x() and Fl::event_y()
      return 1;
    case FL_DRAG:
      ... mouse moved while down event ...
      return 1;
    case FL_RELEASE:    
      ... mouse up event ...
      return 1;
    case FL_KEYBOARD:
      ... keypress, key is in Fl::event_key(), ascii in Fl::event_text()
      return 1;
    default:
      // tell fltk that I don't understand other events
      return 0;
    }
  }

When handle() is called, the glx context is not set up! If your display changes, you should call redraw() and let draw() do the work. Don't call any gl functions from inside handle()!

This may mean you cannot call some OpenGl stuff like hit detection. You can fix this by doing:

    case FL_PUSH:
      make_current(); // make glx context current
      if (!valid()) {
        ... set up projection exactly the same as draw ...
        valid(1); // stop it from doing this next time
      }
      ... ok to call NON-DRAWING OpenGL code here, such as hit
      detection ...

Your main program can now create one of your windows by doing "new MyWindow(...)". You can also use fluid:

1. Put your class definition in a MyWindow.H file.
2. In fluid create a box object, resize & place where you want.
3. In the control panel, fill in the "class" field with MyWindow.H. This will make fluid produce constructors for your new class.
4. In the "extra code" put "#include "MyWindow.H"", so that the fluid output file will compile.

You must put glwindow->show() in your main code after calling show() on the window containing the gl window.

class Fl_Gl_Window : public Fl_Window

An Fl_Gl_Window sets things up so OpenGL works, and also keeps an OpenGL "context" for that window, so that changes to the lighting and projection may be reused between redraws. Fl_Gl_Window also flushes the OpenGL streams and swaps buffers after draw() returns.

Fl_Gl_Window::draw() is a pure virtual method. You must subclass Fl_Gl_Window and provide an implementation for draw(). You may also provide an implementation of draw_overlay() if you want to draw into the overlay planes. You can avoid reinitializing the viewport and lights and other things by checking valid() at the start of draw() and only doing the initialization if it is false.

The draw() method can only use OpenGL calls. Do not attempt to call X, any of the functions in <FL/fl_draw.H>, or glX directly. Do not call gl_start() or gl_finish().

Methods:

Fl_Gl_Window::Fl_Gl_Window(int W, int H, const char *l=0);
Fl_Gl_Window::Fl_Gl_Window(int X, int Y, int W, int H, const char *l=0)

The constructors. Fl_Gl_Window::mode() defaults to FL_RGB|FL_DOUBLE|FL_DEPTH.

const int Fl_Gl_Window::mode() const;
int Fl_Gl_Window::mode(int);

Set or change the OpenGL capabilites of the window. The value can be any of the following or'd together:
• FL_RGB - Color (not indexed)
• FL_RGB8 - Color with at least 8 bits of each color
• FL_INDEX - Indexed mode
• FL_SINGLE - not double buffered
• FL_DOUBLE - double buffered
• FL_ACCUM - accumulation buffer
• FL_ALPHA - alpha channel in color
• FL_DEPTH - depth buffer
• FL_STENCIL - stencil buffer
• FL_MULTISAMPLE - multisample antialiasing

FL_RGB and FL_SINGLE have a value of zero, they are "on" unless you give FL_INDEX or FL_DOUBLE.

If the desired combination cannot be done, fltk will try turning off the FL_MULTISAMPLE. If this also fails show() will call Fl::error() and not show the window.

You can change the mode while the window is displayed. This is most useful for turning double-buffering on and off. Under X this will cause the old X window to be destroyed and a new one created. If this is a top-level window this will unfortunately also cause the window to blink, raise to the top, and be de-iconized, and the xid() will change, possibly breaking other code. It is best to make the GL window a child of another window if you wish to do this!

int Fl_Gl_Window::mode(const int *);

This call only works on systems using glX. This value is passed unchanged to glXChooseVisual(), superceeding the value calculated from mode(int). See "man glXChooseVisual" if you wish to construct your own mode. Fltk assummes that the pointer is to static const data, and caches the pointer with the found visual. glXChooseVisual is not called until show() or can_do() is called. To restore the use of mode(int), call mode((int*)0).

static int Fl_Gl_Window::can_do(int);
static int Fl_Gl_Window::can_do(const int *mode);
int Fl_Gl_Window::can_do() const;

Returns non-zero if show() will not call Fl::error() if called with the given or current mode.

char Fl_Gl_Window::valid() const;
void Fl_Gl_Window::invalidate();
void Fl_Gl_Window::valid(char i);

Fl_Gl_Window::valid() is turned off when fltk creates a new context for this window and by the window resizing, and is turned on after draw() is called. You can use this inside your draw() method to avoid unneccessarily initializing the OpenGL context. Just do this:

void mywindow::draw() {
  if (!valid()) {
    glViewport(0,0,w(),h());
    glFrustum(...);
    glLight(...);
    ...other initilization...
  }
  ... draw your geometry here ...
}

You can also turn valid() off yourself (for instance if you know the current projection has changed). To do this call invalidate().

You can turn valid() on by calling valid(1). You should only do this after fixing the transformation inside a draw() or after make_current(). This is done automatically after draw() returns.

void Fl_Gl_Window::ortho();

Set the projection so 0,0 is in the lower left of the window and each pixel is 1 unit wide/tall. If you are drawing 2D images, your draw() method may want to call this if valid() is false.

void Fl_Gl_Window::make_current();
void Fl_Gl_Window::make_overlay_current();
void Fl_Gl_Window::swap_buffers();

These functions can be used to set the current GL context to a window and draw into it incrementally, rather than using the draw() method. You will also need to call make_current() to do OpenGL feedback or hit detection in response to events. After calling make_current(), be sure to test valid(), and if false, initialize the transformation and call valid(1).

void Fl_Gl_Window::hide();
Fl_Gl_Window::~Fl_Gl_Window();

Hiding the window or destroying it also destroys the OpenGL context it uses.

Fl_Gl_Window overlay

You can put OpenGL code into an Fl_Widget::draw() method or into the code for a boxtype or other places, with some care.

Most important, before you show any windows (including those that don't have OpenGL drawing) you must initialize fltk/X so that it knows it is going to use OpenGL. You may use any of the symbols described for Fl_Gl_Window::mode() to describe how you intend to use OpenGL:

Fl::gl_visual(FL_RGB);

You can then put OpenGL drawing code anywhere you can draw normally by surrounding it with:

gl_start();
... put your OpenGL code here ...
gl_finish();

gl_start() and gl_finish() set up a GL context with an orthographic projection so that 0,0 is the lower-left corner of the window and each pixel is one unit. The current clipping is reproduced with OpenGL scissor commands. These also synchronize the OpenGL graphics stream with the drawing done by other X or fltk functions.

The same context is reused each time. If your code changes the projection transformation or anything else you should use glPush/glPop to put the state back before calling gl_finish().

You may want to use Fl_Window::current()->h() to get the drawable height so you can flip the coordinate system.

Unfortunately there are a bunch of limitations you must adhere to for maximum portability:

• You must choose a default visual with Fl::gl_visual().
• You cannot pass FL_DOUBLE to Fl::gl_visual().
• You cannot use Fl_Double_Window (or Fl_Overlay_Window).

Do not call gl_start()/gl_finish() when drawing an Fl_Gl_Window!

Set the "current GL font" to the same font you get by calling fl_font().

int gl_height();
int gl_descent();
float gl_width(const char *);
float gl_width(const char *, int n);
float gl_width(uchar);

Return information about the current GL font.

void gl_draw(const char *);
void gl_draw(const char *, int n);

Draw a null-terminated string or an array of n characters in the current GL font at the current glRasterPos.

void gl_draw(const char *, int x, int y);
void gl_draw(const char *, int n, int x, int y);

Draw a null-terminated string or an array of n characters in the current GL font at the given position.

void gl_draw(const char *, int x, int y, int w, int h, Fl_Align);

Draw a string formatted into a box, with newlines and tabs expanded, other control characters changed to ^X, and aligned with the edges or center. Exactly the same output as fl_draw().

(back to contents)