862648ebfc
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@7701 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
390 lines
17 KiB
C++
390 lines
17 KiB
C++
//
|
|
// "$Id$"
|
|
//
|
|
// Definition of classes Fl_Device, Fl_Graphics_Driver, Fl_Surface_Device, Fl_Display_Device
|
|
// for the Fast Light Tool Kit (FLTK).
|
|
//
|
|
// Copyright 2010 by Bill Spitzak and others.
|
|
//
|
|
// This library is free software; you can redistribute it and/or
|
|
// modify it under the terms of the GNU Library General Public
|
|
// License as published by the Free Software Foundation; either
|
|
// version 2 of the License, or (at your option) any later version.
|
|
//
|
|
// This library is distributed in the hope that it will be useful,
|
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
// Library General Public License for more details.
|
|
//
|
|
// You should have received a copy of the GNU Library General Public
|
|
// License along with this library; if not, write to the Free Software
|
|
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
|
|
// USA.
|
|
//
|
|
// Please report all bugs and problems on the following page:
|
|
//
|
|
// http://www.fltk.org/str.php
|
|
//
|
|
/** \file Fl_Device.H
|
|
\brief declaration of classes Fl_Device, Fl_Graphics_Driver, Fl_Surface_Device, Fl_Display_Device.
|
|
*/
|
|
|
|
#ifndef Fl_Device_H
|
|
#define Fl_Device_H
|
|
|
|
#include <FL/x.H>
|
|
#include <FL/Fl_Plugin.H>
|
|
#include <FL/Fl_Image.H>
|
|
#include <FL/Fl_Bitmap.H>
|
|
#include <FL/Fl_Pixmap.H>
|
|
#include <FL/Fl_RGB_Image.H>
|
|
#ifdef WIN32
|
|
#include <commdlg.h>
|
|
#elif defined(__APPLE__)
|
|
#else
|
|
#include <stdio.h>
|
|
#endif
|
|
|
|
class Fl_Graphics_Driver;
|
|
class Fl_Display_Device;
|
|
class Fl_Surface_Device;
|
|
/** \brief Points to the driver that currently receives all graphics requests */
|
|
FL_EXPORT extern Fl_Graphics_Driver *fl_graphics_driver;
|
|
/** \brief Points to the surface that currently receives all graphics requests */
|
|
FL_EXPORT extern Fl_Surface_Device *fl_surface;
|
|
/** \brief Points to the platform's display */
|
|
FL_EXPORT extern Fl_Display_Device *fl_display_device;
|
|
|
|
/**
|
|
signature of image generation callback function.
|
|
\param[in] data user data passed to function
|
|
\param[in] x,y,w position and width of scan line in image
|
|
\param[out] buf buffer for generated image data. You must copy \p w
|
|
pixels from scanline \p y, starting at pixel \p x
|
|
to this buffer.
|
|
*/
|
|
typedef void (*Fl_Draw_Image_Cb)(void* data,int x,int y,int w,uchar* buf);
|
|
|
|
/**
|
|
\brief All graphical output devices and all graphics systems.
|
|
*/
|
|
class Fl_Device {
|
|
protected:
|
|
/** \brief The device type */
|
|
const char *type_;
|
|
/** \brief A string that identifies each subclass of Fl_Device.
|
|
*
|
|
Function type() applied to a device of this class returns this string.
|
|
*/
|
|
static const char *device_type;
|
|
public:
|
|
/**
|
|
@brief An RTTI emulation of device classes.
|
|
*
|
|
The type of an instance of an Fl_Device subclass can be checked with code such as:
|
|
\code
|
|
if ( instance->type() == Fl_Printer::device_type ) { ... }
|
|
\endcode
|
|
*/
|
|
inline const char *type() {return type_;};
|
|
};
|
|
|
|
/**
|
|
\brief A virtual class subclassed for each graphics driver FLTK uses.
|
|
*
|
|
The protected virtual methods of this class are those that a graphics driver should implement to
|
|
support all of FLTK drawing functions.
|
|
<br> The preferred FLTK API for drawing operations is the function collection of the
|
|
\ref fl_drawings and \ref fl_attributes modules.
|
|
<br> Alternatively, methods of the Fl_Graphics_Driver class can be called
|
|
using the global variable Fl_Graphics_Driver * \ref fl_graphics_driver that points at all time to
|
|
the single driver (an instance of an Fl_Graphics_Driver subclass) that's currently receiving graphics
|
|
requests. For example:
|
|
\code fl_graphics_driver->rect(x, y, w, h); \endcode
|
|
<br>Each protected method of the Fl_Graphics_Driver class has the same effect as the
|
|
function of the \ref fl_drawings and \ref fl_attributes modules which bears the same name
|
|
prefixed with fl_ and has the same parameter list.
|
|
*/
|
|
class Fl_Graphics_Driver : public Fl_Device {
|
|
protected:
|
|
/* ** \brief red color for background and/or mixing if device does not support masking or alpha *
|
|
uchar bg_r_;
|
|
** \brief green color for background and/or mixing if device does not support masking or alpha *
|
|
uchar bg_g_;
|
|
** \brief blue color for background and/or mixing if device does not support masking or alpha *
|
|
uchar bg_b_; */
|
|
friend class Fl_Pixmap;
|
|
friend class Fl_Bitmap;
|
|
friend class Fl_RGB_Image;
|
|
friend class Fl_PostScript_Graphics_Driver;
|
|
friend void fl_rect(int x, int y, int w, int h);
|
|
friend void fl_rectf(int x, int y, int w, int h);
|
|
friend void fl_line_style(int style, int width, char* dashes);
|
|
friend void fl_xyline(int x, int y, int x1);
|
|
friend void fl_xyline(int x, int y, int x1, int y2);
|
|
friend void fl_xyline(int x, int y, int x1, int y2, int x3);
|
|
friend void fl_yxline(int x, int y, int y1);
|
|
friend void fl_yxline(int x, int y, int y1, int x2);
|
|
friend void fl_yxline(int x, int y, int y1, int x2, int y3);
|
|
friend void fl_line(int x, int y, int x1, int y1);
|
|
friend void fl_line(int x, int y, int x1, int y1, int x2, int y2);
|
|
friend void fl_draw(const char *str, int n, int x, int y);
|
|
#ifdef __APPLE__
|
|
friend void fl_draw(const char *str, int n, float x, float y);
|
|
#endif
|
|
friend void fl_draw(int angle, const char *str, int n, int x, int y);
|
|
friend void fl_rtl_draw(const char *str, int n, int x, int y);
|
|
friend void fl_font(Fl_Font face, Fl_Fontsize size);
|
|
friend void fl_color(Fl_Color c);
|
|
friend void fl_color(uchar r, uchar g, uchar b);
|
|
friend void fl_point(int x, int y);
|
|
friend void fl_loop(int x0, int y0, int x1, int y1, int x2, int y2);
|
|
friend void fl_loop(int x0, int y0, int x1, int y1, int x2, int y2, int x3, int y3);
|
|
friend void fl_polygon(int x0, int y0, int x1, int y1, int x2, int y2);
|
|
friend void fl_polygon(int x0, int y0, int x1, int y1, int x2, int y2, int x3, int y3);
|
|
friend void fl_begin_points();
|
|
friend void fl_begin_line();
|
|
friend void fl_begin_loop();
|
|
friend void fl_begin_polygon();
|
|
friend void fl_vertex(double x, double y);
|
|
friend void fl_curve(double X0, double Y0, double X1, double Y1, double X2, double Y2, double X3, double Y3);
|
|
friend void fl_circle(double x, double y, double r);
|
|
friend void fl_arc(double x, double y, double r, double start, double end);
|
|
friend void fl_arc(int x, int y, int w, int h, double a1, double a2);
|
|
friend void fl_pie(int x, int y, int w, int h, double a1, double a2);
|
|
friend void fl_end_points();
|
|
friend void fl_end_line();
|
|
friend void fl_end_loop();
|
|
friend void fl_end_polygon();
|
|
friend void fl_transformed_vertex(double xf, double yf);
|
|
friend void fl_push_clip(int x, int y, int w, int h);
|
|
friend int fl_clip_box(int x, int y, int w, int h, int &X, int &Y, int &W, int &H);
|
|
friend int fl_not_clipped(int x, int y, int w, int h);
|
|
friend void fl_push_no_clip();
|
|
friend void fl_pop_clip();
|
|
friend void fl_begin_complex_polygon();
|
|
friend void fl_gap();
|
|
friend void fl_end_complex_polygon();
|
|
friend void fl_draw_image(const uchar* buf, int X,int Y,int W,int H, int D, int L);
|
|
friend void fl_draw_image_mono(const uchar* buf, int X,int Y,int W,int H, int D, int L);
|
|
friend void fl_draw_image(Fl_Draw_Image_Cb cb, void* data, int X,int Y,int W,int H, int D);
|
|
friend FL_EXPORT void fl_draw_image_mono(Fl_Draw_Image_Cb cb, void* data, int X,int Y,int W,int H, int D);
|
|
|
|
/** \brief The constructor. */
|
|
Fl_Graphics_Driver() {};
|
|
/** \brief see fl_rect(int x, int y, int w, int h). */
|
|
virtual void rect(int x, int y, int w, int h);
|
|
/** \brief see fl_rectf(int x, int y, int w, int h). */
|
|
virtual void rectf(int x, int y, int w, int h);
|
|
/** \brief see fl_line_style(int style, int width, char* dashes). */
|
|
virtual void line_style(int style, int width=0, char* dashes=0);
|
|
/** \brief see fl_xyline(int x, int y, int x1). */
|
|
virtual void xyline(int x, int y, int x1);
|
|
/** \brief see fl_xyline(int x, int y, int x1, int y2). */
|
|
virtual void xyline(int x, int y, int x1, int y2);
|
|
/** \brief see fl_xyline(int x, int y, int x1, int y2, int x3). */
|
|
virtual void xyline(int x, int y, int x1, int y2, int x3);
|
|
/** \brief see fl_yxline(int x, int y, int y1). */
|
|
virtual void yxline(int x, int y, int y1);
|
|
/** \brief see fl_yxline(int x, int y, int y1, int x2). */
|
|
virtual void yxline(int x, int y, int y1, int x2);
|
|
/** \brief see fl_yxline(int x, int y, int y1, int x2, int y3). */
|
|
virtual void yxline(int x, int y, int y1, int x2, int y3);
|
|
/** \brief see fl_line(int x, int y, int x1, int y1). */
|
|
virtual void line(int x, int y, int x1, int y1);
|
|
/** \brief see fl_line(int x, int y, int x1, int y1, int x2, int y2). */
|
|
virtual void line(int x, int y, int x1, int y1, int x2, int y2);
|
|
/** \brief see fl_draw(const char *str, int n, int x, int y). */
|
|
virtual void draw(const char *str, int n, int x, int y);
|
|
/** \brief see fl_draw(int angle, const char *str, int n, int x, int y). */
|
|
virtual void draw(int angle, const char *str, int n, int x, int y);
|
|
/** \brief see fl_rtl_draw(const char *str, int n, int x, int y). */
|
|
virtual void rtl_draw(const char *str, int n, int x, int y);
|
|
/** \brief see fl_font(Fl_Font face, Fl_Fontsize size). */
|
|
virtual void font(Fl_Font face, Fl_Fontsize size);
|
|
/** \brief see fl_color(Fl_Color c). */
|
|
virtual void color(Fl_Color c);
|
|
/** \brief see fl_color(uchar r, uchar g, uchar b). */
|
|
virtual void color(uchar r, uchar g, uchar b);
|
|
/** \brief see fl_point(int x, int y). */
|
|
virtual void point(int x, int y);
|
|
/** \brief see fl_loop(int x0, int y0, int x1, int y1, int x2, int y2). */
|
|
virtual void loop(int x0, int y0, int x1, int y1, int x2, int y2);
|
|
/** \brief see fl_loop(int x0, int y0, int x1, int y1, int x2, int y2, int x3, int y3). */
|
|
virtual void loop(int x0, int y0, int x1, int y1, int x2, int y2, int x3, int y3);
|
|
/** \brief see fl_polygon(int x0, int y0, int x1, int y1, int x2, int y2). */
|
|
virtual void polygon(int x0, int y0, int x1, int y1, int x2, int y2);
|
|
/** \brief see fl_polygon(int x0, int y0, int x1, int y1, int x2, int y2, int x3, int y3). */
|
|
virtual void polygon(int x0, int y0, int x1, int y1, int x2, int y2, int x3, int y3);
|
|
/** \brief see fl_begin_points(). */
|
|
virtual void begin_points();
|
|
/** \brief see fl_begin_line(). */
|
|
virtual void begin_line();
|
|
/** \brief see fl_begin_loop(). */
|
|
virtual void begin_loop();
|
|
/** \brief see fl_begin_polygon(). */
|
|
virtual void begin_polygon();
|
|
/** \brief see fl_vertex(double x, double y). */
|
|
virtual void vertex(double x, double y);
|
|
/** \brief see fl_curve(double X0, double Y0, double X1, double Y1, double X2, double Y2, double X3, double Y3). */
|
|
virtual void curve(double X0, double Y0, double X1, double Y1, double X2, double Y2, double X3, double Y3);
|
|
/** \brief see fl_circle(double x, double y, double r). */
|
|
virtual void circle(double x, double y, double r);
|
|
/** \brief see fl_arc(double x, double y, double r, double start, double end). */
|
|
virtual void arc(double x, double y, double r, double start, double end);
|
|
/** \brief see fl_arc(int x, int y, int w, int h, double a1, double a2). */
|
|
virtual void arc(int x, int y, int w, int h, double a1, double a2);
|
|
/** \brief see fl_pie(int x, int y, int w, int h, double a1, double a2). */
|
|
virtual void pie(int x, int y, int w, int h, double a1, double a2);
|
|
/** \brief see fl_end_points(). */
|
|
virtual void end_points();
|
|
/** \brief see fl_end_line(). */
|
|
virtual void end_line();
|
|
/** \brief see fl_end_loop(). */
|
|
virtual void end_loop();
|
|
/** \brief see fl_end_polygon(). */
|
|
virtual void end_polygon();
|
|
/** \brief see fl_begin_complex_polygon(). */
|
|
virtual void begin_complex_polygon();
|
|
/** \brief see fl_gap(). */
|
|
virtual void gap();
|
|
/** \brief see fl_end_complex_polygon(). */
|
|
virtual void end_complex_polygon();
|
|
/** \brief see fl_transformed_vertex(double xf, double yf). */
|
|
virtual void transformed_vertex(double xf, double yf);
|
|
/** \brief see fl_push_clip(int x, int y, int w, int h). */
|
|
virtual void push_clip(int x, int y, int w, int h);
|
|
/** \brief see fl_clip_box(int x, int y, int w, int h, int &X, int &Y, int &W, int &H). */
|
|
virtual int clip_box(int x, int y, int w, int h, int &X, int &Y, int &W, int &H);
|
|
/** \brief see fl_not_clipped(int x, int y, int w, int h). */
|
|
virtual int not_clipped(int x, int y, int w, int h);
|
|
/** \brief see fl_push_no_clip(). */
|
|
virtual void push_no_clip();
|
|
/** \brief see fl_pop_clip(). */
|
|
virtual void pop_clip();
|
|
// Images
|
|
/** \brief see fl_draw_image(const uchar* buf, int X,int Y,int W,int H, int D, int L). */
|
|
virtual void draw_image(const uchar* buf, int X,int Y,int W,int H, int D=3, int L=0);
|
|
/** \brief see fl_draw_image_mono(const uchar* buf, int X,int Y,int W,int H, int D, int L). */
|
|
virtual void draw_image_mono(const uchar* buf, int X,int Y,int W,int H, int D=1, int L=0);
|
|
/** \brief see fl_draw_image(Fl_Draw_Image_Cb cb, void* data, int X,int Y,int W,int H, int D). */
|
|
virtual void draw_image(Fl_Draw_Image_Cb cb, void* data, int X,int Y,int W,int H, int D=3);
|
|
/** \brief see fl_draw_image_mono(Fl_Draw_Image_Cb cb, void* data, int X,int Y,int W,int H, int D). */
|
|
virtual void draw_image_mono(Fl_Draw_Image_Cb cb, void* data, int X,int Y,int W,int H, int D=1);
|
|
// Image classes
|
|
/** \brief Draws an Fl_RGB_Image object to the device.
|
|
*
|
|
Specifies a bounding box for the image, with the origin (upper left-hand corner) of
|
|
the image offset by the cx and cy arguments.
|
|
*/
|
|
virtual void draw(Fl_RGB_Image * rgb,int XP, int YP, int WP, int HP, int cx, int cy) {};
|
|
/** \brief Draws an Fl_Pixmap object to the device.
|
|
*
|
|
Specifies a bounding box for the image, with the origin (upper left-hand corner) of
|
|
the image offset by the cx and cy arguments.
|
|
*/
|
|
virtual void draw(Fl_Pixmap * pxm,int XP, int YP, int WP, int HP, int cx, int cy) {};
|
|
/** \brief Draws an Fl_Bitmap object to the device.
|
|
*
|
|
Specifies a bounding box for the image, with the origin (upper left-hand corner) of
|
|
the image offset by the cx and cy arguments.
|
|
*/
|
|
virtual void draw(Fl_Bitmap *bm, int XP, int YP, int WP, int HP, int cx, int cy) {};
|
|
|
|
public:
|
|
static const char *device_type;
|
|
/** \brief The destructor */
|
|
virtual ~Fl_Graphics_Driver() {};
|
|
};
|
|
|
|
#if defined(__APPLE__) || defined(FL_DOXYGEN)
|
|
/**
|
|
\brief The Mac OS X-specific graphics class.
|
|
*
|
|
This class is implemented only on the Mac OS X platform.
|
|
*/
|
|
class Fl_Quartz_Graphics_Driver : public Fl_Graphics_Driver {
|
|
public:
|
|
/** \brief The constructor. */
|
|
Fl_Quartz_Graphics_Driver() { type_ = device_type; };
|
|
static const char *device_type;
|
|
void draw(Fl_Pixmap *pxm, int XP, int YP, int WP, int HP, int cx, int cy);
|
|
void draw(Fl_Bitmap *pxm, int XP, int YP, int WP, int HP, int cx, int cy);
|
|
void draw(Fl_RGB_Image *img, int XP, int YP, int WP, int HP, int cx, int cy);
|
|
};
|
|
#endif
|
|
#if defined(WIN32) || defined(FL_DOXYGEN)
|
|
/**
|
|
\brief The MSWindows-specific graphics class.
|
|
*
|
|
This class is implemented only on the MSWindows platform.
|
|
*/
|
|
class Fl_GDI_Graphics_Driver : public Fl_Graphics_Driver {
|
|
public:
|
|
/** \brief The constructor. */
|
|
Fl_GDI_Graphics_Driver() { type_ = device_type; };
|
|
static const char *device_type;
|
|
void draw(Fl_Pixmap *pxm, int XP, int YP, int WP, int HP, int cx, int cy);
|
|
void draw(Fl_Bitmap *pxm, int XP, int YP, int WP, int HP, int cx, int cy);
|
|
void draw(Fl_RGB_Image *img, int XP, int YP, int WP, int HP, int cx, int cy);
|
|
};
|
|
#endif
|
|
#if !(defined(__APPLE__) || defined(WIN32))
|
|
/**
|
|
\brief The Xlib-specific graphics class.
|
|
*
|
|
This class is implemented only on the Xlib platform.
|
|
*/
|
|
class Fl_Xlib_Graphics_Driver : public Fl_Graphics_Driver {
|
|
public:
|
|
/** \brief The constructor. */
|
|
Fl_Xlib_Graphics_Driver() { type_ = device_type; };
|
|
static const char *device_type;
|
|
void draw(Fl_Pixmap *pxm, int XP, int YP, int WP, int HP, int cx, int cy);
|
|
void draw(Fl_Bitmap *pxm, int XP, int YP, int WP, int HP, int cx, int cy);
|
|
void draw(Fl_RGB_Image *img, int XP, int YP, int WP, int HP, int cx, int cy);
|
|
};
|
|
#endif
|
|
|
|
/**
|
|
\brief A surface that's susceptible to receive graphical output.
|
|
*/
|
|
class Fl_Surface_Device : public Fl_Device {
|
|
/** \brief The graphics driver in use by this surface. */
|
|
Fl_Graphics_Driver *_driver;
|
|
protected:
|
|
/** \brief Constructor that sets the graphics driver to use for the created surface. */
|
|
Fl_Surface_Device(Fl_Graphics_Driver *graphics_driver) {_driver = graphics_driver; };
|
|
public:
|
|
static const char *device_type;
|
|
virtual void set_current(void);
|
|
/** \brief Sets the graphics driver of this drawing surface. */
|
|
inline void driver(Fl_Graphics_Driver *graphics_driver) {_driver = graphics_driver;};
|
|
/** \brief Returns the graphics driver of this drawing surface. */
|
|
inline Fl_Graphics_Driver *driver() {return _driver; };
|
|
/** \brief the surface that currently receives graphics output */
|
|
static Fl_Surface_Device *surface() {return fl_surface; };
|
|
/** \brief The destructor. */
|
|
virtual ~Fl_Surface_Device() {}
|
|
};
|
|
|
|
/**
|
|
\brief A display to which the computer can draw.
|
|
*/
|
|
class Fl_Display_Device : public Fl_Surface_Device {
|
|
public:
|
|
static const char *device_type;
|
|
/** \brief A constructor that sets the graphics driver used by the display */
|
|
Fl_Display_Device(Fl_Graphics_Driver *graphics_driver) : Fl_Surface_Device( graphics_driver) { type_ = device_type; };
|
|
/**
|
|
@brief Returns the platform's display device.
|
|
*/
|
|
static Fl_Display_Device *display_device() { return fl_display_device; };
|
|
};
|
|
|
|
#endif // Fl_Device_H
|
|
|
|
//
|
|
// End of "$Id$".
|
|
//
|