fltk/FL/Fl_Image_Surface.H

//
// "$Id$"
//
// Draw-to-image code for the Fast Light Tool Kit (FLTK).
//
// Copyright 1998-2014 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
//

#ifndef Fl_Image_Surface_H
#define Fl_Image_Surface_H

#include <FL/Fl_Copy_Surface.H>
#include <FL/Fl_Image.H>


/** Directs all graphics requests to an Fl_Image.
 
 After creation of an Fl_Image_Surface object, call set_current() on it, and all subsequent graphics requests
 will be recorded in the image. It's possible to draw widgets (using Fl_Image_Surface::draw()) 
 or to use any of the \ref fl_drawings or the \ref fl_attributes.
 Finally, call image() on the object to obtain a newly allocated Fl_RGB_Image object.
 <br> Fl_GL_Window objects can be drawn in the image as well. 
 
 <br> Usage example:
 \code
 Fl_Widget *g = ...; // a widget you want to draw in an image
 Fl_Image_Surface *img_surf = new Fl_Image_Surface(g->w(), g->h()); // create an Fl_Image_Surface object
 img_surf->set_current(); // direct graphics requests to the image
 fl_color(FL_WHITE); fl_rectf(0, 0, g->w(), g->h()); // draw a white background
 img_surf->draw(g); // draw the g widget in the image
 Fl_RGB_Image* image = img_surf->image(); // get the resulting image
 delete img_surf; // delete the img_surf object
 Fl_Display_Device::display_device()->set_current();  // direct graphics requests back to the display
 \endcode
*/
class Fl_Image_Surface : public Fl_Surface_Device {
private:
  Fl_Offscreen offscreen;
  int width;
  int height;
  Fl_Paged_Device *helper;
#ifdef __APPLE__
#elif defined(WIN32)
  HDC _sgc; 
  Window _sw; 
  Fl_Surface_Device *_ss;
  int _savedc;
#else
  Fl_Surface_Device *previous;
  Window pre_window;
  GC gc;
#endif
public:
  static const char *class_id;
  const char *class_name() {return class_id;};
  Fl_Image_Surface(int w, int h);
  ~Fl_Image_Surface();
  void set_current();
  void draw(Fl_Widget*, int delta_x = 0, int delta_y = 0);
  Fl_RGB_Image *image();
};

#ifdef __APPLE__
/* Mac class to implement translate()/untranslate() for a flipped bitmap graphics context */
class Fl_Quartz_Flipped_Surface_ : public Fl_Quartz_Surface_ {
public:
  static const char *class_id;
  const char *class_name() {return class_id;};
  Fl_Quartz_Flipped_Surface_(int w, int h);
  void translate(int x, int y);
  void untranslate();
  virtual ~Fl_Quartz_Flipped_Surface_() {};
};
#endif 

#endif // Fl_Image_Surface_H

//
// End of "$Id$".
//