Fl_Device.H

Go to the documentation of this file.

//
// Definition of classes Fl_Surface_Device, Fl_Display_Device
// for the Fast Light Tool Kit (FLTK).
//
// Copyright 2010-2017 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:
//
//     https://www.fltk.org/COPYING.php
//
// Please see the following page on how to report bugs and issues:
//
//     https://www.fltk.org/bugs.php
//

#ifndef Fl_Device_H
#define Fl_Device_H

#include <FL/Fl_Plugin.H>
#include <FL/platform_types.h>
#include <stdlib.h>

class Fl_Graphics_Driver;
class Fl_RGB_Image;
class Fl_Widget;

class FL_EXPORT Fl_Surface_Device {
  Fl_Graphics_Driver *pGraphicsDriver;
  static Fl_Surface_Device *surface_; // the surface that currently receives graphics requests
  static Fl_Surface_Device *default_surface(); // create surface if none exists yet
protected:
  /* Some drawing surfaces (e.g., Fl_XXX_Image_Surface_Driver) re-implement this.
   Gets called each time a surface ceases to be the current drawing surface. */
  virtual void end_current() { surface_ = 0;}
  Fl_Surface_Device(Fl_Graphics_Driver *graphics_driver) {pGraphicsDriver = graphics_driver; }
  inline void driver(Fl_Graphics_Driver *graphics_driver) {pGraphicsDriver = graphics_driver;};
public:
  virtual void set_current(void);
  virtual bool is_current();
  inline Fl_Graphics_Driver *driver() {return pGraphicsDriver; };
  static inline Fl_Surface_Device *surface() {
    return surface_ ? surface_ : default_surface();
  };
  virtual ~Fl_Surface_Device();
  static void push_current(Fl_Surface_Device *new_current);
  static Fl_Surface_Device *pop_current();
};

class FL_EXPORT Fl_Display_Device : public Fl_Surface_Device {
  Fl_Display_Device(Fl_Graphics_Driver *graphics_driver);
public:
  static Fl_Display_Device *display_device();
};

class FL_EXPORT Fl_Device_Plugin : public Fl_Plugin {
public:
  Fl_Device_Plugin(const char *pluginName)
  : Fl_Plugin(klass(), pluginName) { }
  virtual const char *klass() { return "fltk:device"; }
  virtual const char *name() = 0;
  virtual int print(Fl_Widget* w) = 0;
  virtual Fl_RGB_Image* rectangle_capture(Fl_Widget *widget, int x, int y, int w, int h) = 0;
  static Fl_Device_Plugin *opengl_plugin();
};

#endif // Fl_Device_H