Fl_Gl_Window.H

//
// "$Id$"
//
// OpenGL header file for the Fast Light Tool Kit (FLTK).
//
// Copyright 1998-2015 by Bill Spitzak and others.
//
// This library is free software. Distribution and use rights are outlined in
// the file "COPYING" which should have been included with this file.  If this
// file is missing or damaged, see the license at:
//
//     http://www.fltk.org/COPYING.php
//
// Please report all bugs and problems on the following page:
//
//     http://www.fltk.org/str.php
//
 
/* \file
   Fl_Gl_Window widget . */
 
#ifndef Fl_Gl_Window_H
#define Fl_Gl_Window_H
 
#include "Fl_Window.H"
 
#ifndef GLContext
typedef void* GLContext; // actually a GLXContext or HGLDC
#endif
 
class Fl_Gl_Choice; // structure to hold result of glXChooseVisual
 
class FL_EXPORT Fl_Gl_Window : public Fl_Window {
 
  int mode_;
  const int *alist;
  Fl_Gl_Choice *g;
  GLContext context_;
  char valid_f_;
  char damage1_; // damage() of back buffer
  virtual void draw_overlay();
  void init();
 
  void *overlay;
  void make_overlay();
  friend class _Fl_Gl_Overlay;
 
  static int can_do(int, const int *);
  int mode(int, const int *);
  static int gl_plugin_linkage();
 
public:
 
  void show();
  void show(int a, char **b) {Fl_Window::show(a,b);}
  void flush();
  void hide();
  void resize(int,int,int,int);
  int handle(int);
  
  char valid() const {return valid_f_ & 1;}
  void valid(char v) {if (v) valid_f_ |= 1; else valid_f_ &= 0xfe;}
  void invalidate();
 
  char context_valid() const {return valid_f_ & 2;}
  void context_valid(char v) {if (v) valid_f_ |= 2; else valid_f_ &= 0xfd;}
 
  static int can_do(int m) {return can_do(m,0);}
  static int can_do(const int *m) {return can_do(0, m);}
  int can_do() {return can_do(mode_,alist);}
  Fl_Mode mode() const {return (Fl_Mode)mode_;}
  int mode(int a) {return mode(a,0);}
  int mode(const int *a) {return mode(0, a);}
  void* context() const {return context_;}
  void context(void*, int destroy_flag = 0);
  void make_current();
  void swap_buffers();
  void ortho();
 
  int can_do_overlay();
  void redraw_overlay();
  void hide_overlay();
  void make_overlay_current();
 
  // Note: Doxygen docs in Fl_Widget.H to avoid redundancy.
  virtual Fl_Gl_Window* as_gl_window() {return this;}
  
#ifdef __APPLE__
  float pixels_per_unit();
#else
  float pixels_per_unit() { return 1; }
#endif
  int pixel_w() { return int(pixels_per_unit() * w() + 0.5); }
  int pixel_h() { return int(pixels_per_unit() * h() + 0.5); }
  
  ~Fl_Gl_Window();
  Fl_Gl_Window(int W, int H, const char *l=0) : Fl_Window(W,H,l) {init();}
  Fl_Gl_Window(int X, int Y, int W, int H, const char *l=0)
    : Fl_Window(X,Y,W,H,l) {init();}
 
protected: