d408133397
intended to be part of the FLTK public API. git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@10746 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
623 lines
28 KiB
C++
623 lines
28 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-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
|
|
//
|
|
|
|
/** \file Fl_Device.H
|
|
\brief declaration of classes Fl_Device, Fl_Graphics_Driver, Fl_Surface_Device,
|
|
Fl_Display_Device, Fl_Device_Plugin.
|
|
*/
|
|
|
|
#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>
|
|
#include <stdlib.h>
|
|
|
|
class Fl_Graphics_Driver;
|
|
class Fl_Font_Descriptor;
|
|
/** \brief Points to the driver that currently receives all graphics requests */
|
|
FL_EXPORT extern Fl_Graphics_Driver *fl_graphics_driver;
|
|
|
|
/**
|
|
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);
|
|
|
|
// typedef what the x,y fields in a point are:
|
|
#ifdef WIN32
|
|
typedef int COORD_T;
|
|
# define XPOINT XPoint
|
|
#elif defined(__APPLE__)
|
|
typedef float COORD_T;
|
|
typedef struct { float x; float y; } QPoint;
|
|
# define XPOINT QPoint
|
|
extern float fl_quartz_line_width_;
|
|
#else
|
|
typedef short COORD_T;
|
|
# define XPOINT XPoint
|
|
#endif
|
|
|
|
/**
|
|
All graphical output devices and all graphics systems.
|
|
This class supports a rudimentary system of run-time type information.
|
|
*/
|
|
class FL_EXPORT Fl_Device {
|
|
public:
|
|
/** A string that identifies each subclass of Fl_Device.
|
|
Function class_name() applied to a device of this class returns this string.
|
|
*/
|
|
static const char *class_id;
|
|
/**
|
|
Returns the name of the class of this object.
|
|
Use of the class_name() function is discouraged because it will be removed from future FLTK versions.
|
|
|
|
The class of an instance of an Fl_Device subclass can be checked with code such as:
|
|
\code
|
|
if ( instance->class_name() == Fl_Printer::class_id ) { ... }
|
|
\endcode
|
|
*/
|
|
virtual const char *class_name() {return class_id;};
|
|
/**
|
|
Virtual destructor.
|
|
|
|
The destructor of Fl_Device must be virtual to make the destructors of
|
|
derived classes being called correctly on destruction.
|
|
*/
|
|
virtual ~Fl_Device() {};
|
|
};
|
|
|
|
#define FL_REGION_STACK_SIZE 10
|
|
#define FL_MATRIX_STACK_SIZE 32
|
|
/**
|
|
\brief A virtual class subclassed for each graphics driver FLTK uses.
|
|
Typically, FLTK applications do not use directly objects from this class. Rather, they perform
|
|
drawing operations (e.g., fl_rectf()) that operate on the current drawing surface (see Fl_Surface_Device).
|
|
Drawing operations are functionally presented in \ref drawing and as function lists
|
|
in the \ref fl_drawings and \ref fl_attributes modules.
|
|
|
|
\p The Fl_Graphics_Driver class is of interest if one wants to perform new kinds of drawing operations.
|
|
An example would be to draw to a PDF file. This would involve creating a new Fl_Graphics_Driver derived
|
|
class. This new class should implement all virtual methods of the Fl_Graphics_Driver class
|
|
to support all FLTK drawing functions.
|
|
*/
|
|
class FL_EXPORT Fl_Graphics_Driver : public Fl_Device {
|
|
public:
|
|
/** A 2D coordinate transformation matrix
|
|
*/
|
|
struct matrix {double a, b, c, d, x, y;};
|
|
private:
|
|
static const matrix m0;
|
|
Fl_Font font_; // current font
|
|
Fl_Fontsize size_; // current font size
|
|
Fl_Color color_; // current color
|
|
int sptr;
|
|
static const int matrix_stack_size = FL_MATRIX_STACK_SIZE;
|
|
matrix stack[FL_MATRIX_STACK_SIZE];
|
|
matrix m;
|
|
int n, p_size, gap_;
|
|
XPOINT *p;
|
|
int what;
|
|
int fl_clip_state_number;
|
|
int rstackptr;
|
|
static const int region_stack_max = FL_REGION_STACK_SIZE - 1;
|
|
Fl_Region rstack[FL_REGION_STACK_SIZE];
|
|
#ifdef WIN32
|
|
int numcount;
|
|
int counts[20];
|
|
#endif
|
|
Fl_Font_Descriptor *font_descriptor_;
|
|
void transformed_vertex0(COORD_T x, COORD_T y);
|
|
void fixloop();
|
|
|
|
protected:
|
|
#ifndef FL_DOXYGEN
|
|
enum {LINE, LOOP, POLYGON, POINT_};
|
|
inline int vertex_no() { return n; }
|
|
inline XPOINT *vertices() {return p;}
|
|
inline int vertex_kind() {return what;}
|
|
#endif
|
|
/* ** \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 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_push_matrix();
|
|
friend void fl_pop_matrix();
|
|
friend void fl_mult_matrix(double a, double b, double c, double d, double x, double y);
|
|
friend void fl_scale(double x, double y);
|
|
friend void fl_scale(double x);
|
|
friend void fl_translate(double x, double y);
|
|
friend void fl_rotate(double d);
|
|
friend double fl_transform_x(double x, double y);
|
|
friend double fl_transform_y(double x, double y);
|
|
friend double fl_transform_dx(double x, double y);
|
|
friend double fl_transform_dy(double x, double y);
|
|
friend Fl_Region fl_clip_region();
|
|
friend void fl_clip_region(Fl_Region r);
|
|
friend void fl_restore_clip();
|
|
|
|
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);
|
|
friend FL_EXPORT void gl_start();
|
|
friend void fl_copy_offscreen(int x, int y, int w, int h, Fl_Offscreen pixmap, int srcx, int srcy);
|
|
matrix *fl_matrix; /**< Points to the current coordinate transformation matrix */
|
|
|
|
/** \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) {}
|
|
#ifdef __APPLE__
|
|
virtual void draw(const char *str, int n, float x, float y) { draw(str, n, (int)(x+0.5), (int)(y+0.5));}
|
|
#endif
|
|
/** \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_color(Fl_Color c). */
|
|
virtual void color(Fl_Color c) {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();
|
|
|
|
/** \brief see fl_push_matrix(). */
|
|
void push_matrix();
|
|
/** \brief see fl_pop_matrix(). */
|
|
void pop_matrix();
|
|
/** \brief see fl_mult_matrix(double a, double b, double c, double d, double x, double y). */
|
|
void mult_matrix(double a, double b, double c, double d, double x, double y);
|
|
/** \brief see fl_scale(double x, double y). */
|
|
inline void scale(double x, double y) { mult_matrix(x,0,0,y,0,0); }
|
|
/** \brief see fl_scale(double x). */
|
|
inline void scale(double x) { mult_matrix(x,0,0,x,0,0); }
|
|
/** \brief see fl_translate(double x, double y). */
|
|
inline void translate(double x,double y) { mult_matrix(1,0,0,1,x,y); }
|
|
/** \brief see fl_rotate(double d). */
|
|
void rotate(double d);
|
|
/** \brief see fl_transform_x(double x, double y). */
|
|
double transform_x(double x, double y);
|
|
/** \brief see fl_transform_y(double x, double y). */
|
|
double transform_y(double x, double y);
|
|
/** \brief see fl_transform_dx(double x, double y). */
|
|
double transform_dx(double x, double y);
|
|
/** \brief see fl_transform_dy(double x, double y). */
|
|
double transform_dy(double x, double y);
|
|
/** \brief see fl_clip_region(). */
|
|
Fl_Region clip_region();
|
|
/** \brief see fl_clip_region(Fl_Region r). */
|
|
void clip_region(Fl_Region r);
|
|
/** \brief see fl_restore_clip(). */
|
|
void restore_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) {}
|
|
#if FLTK_ABI_VERSION >= 10301
|
|
virtual
|
|
#endif
|
|
void copy_offscreen(int x, int y, int w, int h, Fl_Offscreen pixmap, int srcx, int srcy);
|
|
|
|
public:
|
|
static const char *class_id;
|
|
virtual const char *class_name() {return class_id;};
|
|
/** \brief see fl_font(Fl_Font face, Fl_Fontsize size). */
|
|
virtual void font(Fl_Font face, Fl_Fontsize fsize) {font_ = face; size_ = fsize;}
|
|
/** \brief see fl_font(void). */
|
|
Fl_Font font() {return font_; }
|
|
/** \brief see fl_size(). */
|
|
Fl_Fontsize size() {return size_; }
|
|
/** \brief see fl_width(const char *str, int n). */
|
|
virtual double width(const char *str, int n) {return 0;}
|
|
/** \brief see fl_width(unsigned int n). */
|
|
virtual inline double width(unsigned int c) { char ch = (char)c; return width(&ch, 1); }
|
|
/** \brief see fl_text_extents(const char*, int n, int& dx, int& dy, int& w, int& h). */
|
|
virtual void text_extents(const char*, int n, int& dx, int& dy, int& w, int& h);
|
|
/** \brief see fl_height(). */
|
|
virtual int height() {return size();}
|
|
/** \brief see fl_descent(). */
|
|
virtual int descent() {return 0;}
|
|
/** \brief see fl_color(void). */
|
|
Fl_Color color() {return color_;}
|
|
/** Returns a pointer to the current Fl_Font_Descriptor for the graphics driver */
|
|
inline Fl_Font_Descriptor *font_descriptor() { return font_descriptor_;}
|
|
/** Sets the current Fl_Font_Descriptor for the graphics driver */
|
|
inline void font_descriptor(Fl_Font_Descriptor *d) { font_descriptor_ = d;}
|
|
#if FLTK_ABI_VERSION >= 10304 || defined(FL_DOXYGEN)
|
|
virtual
|
|
#endif
|
|
int draw_scaled(Fl_Image *img, int X, int Y, int W, int H);
|
|
/** \brief The destructor */
|
|
virtual ~Fl_Graphics_Driver() { if (p) free(p); }
|
|
};
|
|
|
|
#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_EXPORT Fl_Quartz_Graphics_Driver : public Fl_Graphics_Driver {
|
|
public:
|
|
static const char *class_id;
|
|
const char *class_name() {return class_id;};
|
|
void color(Fl_Color c);
|
|
void color(uchar r, uchar g, uchar b);
|
|
void draw(const char* str, int n, int x, int y);
|
|
#ifdef __APPLE__
|
|
void draw(const char *str, int n, float x, float y);
|
|
#endif
|
|
void draw(int angle, const char *str, int n, int x, int y);
|
|
void rtl_draw(const char* str, int n, int x, int y);
|
|
void font(Fl_Font face, Fl_Fontsize size);
|
|
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);
|
|
int draw_scaled(Fl_Image *img, int XP, int YP, int WP, int HP);
|
|
void draw_image(const uchar* buf, int X,int Y,int W,int H, int D=3, int L=0);
|
|
void draw_image(Fl_Draw_Image_Cb cb, void* data, int X,int Y,int W,int H, int D=3);
|
|
void draw_image_mono(const uchar* buf, int X,int Y,int W,int H, int D=1, int L=0);
|
|
void draw_image_mono(Fl_Draw_Image_Cb cb, void* data, int X,int Y,int W,int H, int D=1);
|
|
double width(const char *str, int n);
|
|
double width(unsigned int c);
|
|
void text_extents(const char*, int n, int& dx, int& dy, int& w, int& h);
|
|
int height();
|
|
int descent();
|
|
#if ! defined(FL_DOXYGEN)
|
|
static Fl_Offscreen create_offscreen_with_alpha(int w, int h);
|
|
#endif
|
|
void copy_offscreen(int x, int y, int w, int h, Fl_Offscreen pixmap, int srcx, int srcy);
|
|
};
|
|
#endif
|
|
#if defined(WIN32) || defined(FL_DOXYGEN)
|
|
/**
|
|
\brief The MSWindows-specific graphics class.
|
|
*
|
|
This class is implemented only on the MSWindows platform.
|
|
*/
|
|
class FL_EXPORT Fl_GDI_Graphics_Driver : public Fl_Graphics_Driver {
|
|
public:
|
|
static const char *class_id;
|
|
const char *class_name() {return class_id;};
|
|
void color(Fl_Color c);
|
|
void color(uchar r, uchar g, uchar b);
|
|
void draw(const char* str, int n, int x, int y);
|
|
void draw(int angle, const char *str, int n, int x, int y);
|
|
void rtl_draw(const char* str, int n, int x, int y);
|
|
void font(Fl_Font face, Fl_Fontsize size);
|
|
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);
|
|
void draw_image(const uchar* buf, int X,int Y,int W,int H, int D=3, int L=0);
|
|
void draw_image(Fl_Draw_Image_Cb cb, void* data, int X,int Y,int W,int H, int D=3);
|
|
void draw_image_mono(const uchar* buf, int X,int Y,int W,int H, int D=1, int L=0);
|
|
void draw_image_mono(Fl_Draw_Image_Cb cb, void* data, int X,int Y,int W,int H, int D=1);
|
|
double width(const char *str, int n);
|
|
double width(unsigned int c);
|
|
void text_extents(const char*, int n, int& dx, int& dy, int& w, int& h);
|
|
int height();
|
|
int descent();
|
|
#if ! defined(FL_DOXYGEN)
|
|
void copy_offscreen_with_alpha(int x,int y,int w,int h,HBITMAP bitmap,int srcx,int srcy);
|
|
#endif
|
|
void copy_offscreen(int x, int y, int w, int h, Fl_Offscreen pixmap, int srcx, int srcy);
|
|
};
|
|
|
|
/**
|
|
The graphics driver used when printing on MSWindows.
|
|
*
|
|
This class is implemented only on the MSWindows platform. It 's extremely similar to Fl_GDI_Graphics_Driver.
|
|
*/
|
|
class FL_EXPORT Fl_GDI_Printer_Graphics_Driver : public Fl_GDI_Graphics_Driver {
|
|
public:
|
|
static const char *class_id;
|
|
const char *class_name() {return class_id;};
|
|
void draw(Fl_Pixmap *pxm, int XP, int YP, int WP, int HP, int cx, int cy);
|
|
void draw(Fl_Bitmap *bm, int XP, int YP, int WP, int HP, int cx, int cy);
|
|
int draw_scaled(Fl_Image *img, int XP, int YP, int WP, int HP);
|
|
};
|
|
#endif
|
|
#if !(defined(__APPLE__) || defined(WIN32))
|
|
/**
|
|
\brief The Xlib-specific graphics class.
|
|
*
|
|
This class is implemented only on the Xlib platform.
|
|
*/
|
|
class FL_EXPORT Fl_Xlib_Graphics_Driver : public Fl_Graphics_Driver {
|
|
public:
|
|
static const char *class_id;
|
|
const char *class_name() {return class_id;};
|
|
void color(Fl_Color c);
|
|
void color(uchar r, uchar g, uchar b);
|
|
void draw(const char* str, int n, int x, int y);
|
|
void draw(int angle, const char *str, int n, int x, int y);
|
|
void rtl_draw(const char* str, int n, int x, int y);
|
|
void font(Fl_Font face, Fl_Fontsize size);
|
|
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);
|
|
void draw_image(const uchar* buf, int X,int Y,int W,int H, int D=3, int L=0);
|
|
void draw_image(Fl_Draw_Image_Cb cb, void* data, int X,int Y,int W,int H, int D=3);
|
|
void draw_image_mono(const uchar* buf, int X,int Y,int W,int H, int D=1, int L=0);
|
|
void draw_image_mono(Fl_Draw_Image_Cb cb, void* data, int X,int Y,int W,int H, int D=1);
|
|
double width(const char *str, int n);
|
|
double width(unsigned int c);
|
|
void text_extents(const char*, int n, int& dx, int& dy, int& w, int& h);
|
|
int height();
|
|
int descent();
|
|
void copy_offscreen(int x, int y, int w, int h, Fl_Offscreen pixmap, int srcx, int srcy);
|
|
#if ! defined(FL_DOXYGEN)
|
|
void copy_offscreen_with_alpha(int x, int y, int w, int h, Fl_Offscreen pixmap, int srcx, int srcy);
|
|
#endif
|
|
};
|
|
#endif
|
|
|
|
/**
|
|
\brief A drawing surface that's susceptible to receive graphical output.
|
|
A drawing surface is typically used as follows:
|
|
<ol><li> Create \c surface, an object from a particular Fl_Surface_Device derived class (e.g., Fl_Copy_Surface, Fl_Printer).
|
|
<li> Memorize what is the current drawing surface with <tt> Fl_Surface_Device *old_current = Fl_Surface_Device::surface();</tt>
|
|
<li> Call \c surface->set_current(); to redirect all graphics requests to \c surface which becomes the new
|
|
current drawing surface (not necessary with class Fl_Printer because it is done by Fl_Printer::start_job()).
|
|
<li> At this point any of the \ref fl_drawings (e.g., fl_rect()) or the \ref fl_attributes or \ref drawing_images functions
|
|
(e.g., fl_draw_image(), Fl_Image::draw()) operates on the new current drawing surface.
|
|
Certain drawing surfaces allow additional ways to draw to them (e.g., Fl_Printer::print_widget(), Fl_Image_Surface::draw()).
|
|
<li> After all drawing requests have been performed, redirect graphics requests back to their previous destination
|
|
with \c old_current->set_current();.
|
|
<li> Delete \c surface.
|
|
</ol>
|
|
The current drawing surface is initially the computer's display, an instance of the Fl_Display_Device class.
|
|
*/
|
|
class FL_EXPORT Fl_Surface_Device : public Fl_Device {
|
|
/** \brief The graphics driver in use by this surface. */
|
|
Fl_Graphics_Driver *_driver;
|
|
static Fl_Surface_Device *_surface; // the surface that currently receives graphics output
|
|
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 *class_id;
|
|
const char *class_name() {return class_id;};
|
|
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; };
|
|
/** The current drawing surface.
|
|
In other words, the Fl_Surface_Device object that currently receives all graphics output */
|
|
static inline Fl_Surface_Device *surface() {return _surface; };
|
|
/** \brief The destructor. */
|
|
virtual ~Fl_Surface_Device() {}
|
|
};
|
|
|
|
/**
|
|
A display to which the computer can draw.
|
|
When the program begins running, an Fl_Display_Device instance has been created and made the current drawing surface.
|
|
There is no need to create any other object of this class.
|
|
*/
|
|
class FL_EXPORT Fl_Display_Device : public Fl_Surface_Device {
|
|
static Fl_Display_Device *_display; // the platform display device
|
|
#ifdef __APPLE__
|
|
friend class Fl_X;
|
|
friend class Fl_Graphics_Driver;
|
|
static bool high_res_window_; //< true when drawing to a window of a retina display (Mac OS X only)
|
|
static bool high_resolution() {return high_res_window_;}
|
|
#endif
|
|
public:
|
|
static const char *class_id;
|
|
const char *class_name() {return class_id;};
|
|
Fl_Display_Device(Fl_Graphics_Driver *graphics_driver);
|
|
static Fl_Display_Device *display_device();
|
|
};
|
|
|
|
/**
|
|
This plugin socket allows the integration of new device drivers for special
|
|
window or screen types. It is currently used to provide an automated printing
|
|
service and screen capture for OpenGL windows, if linked with fltk_gl.
|
|
*/
|
|
class FL_EXPORT Fl_Device_Plugin : public Fl_Plugin {
|
|
public:
|
|
/** \brief The constructor */
|
|
Fl_Device_Plugin(const char *pluginName)
|
|
: Fl_Plugin(klass(), pluginName) { }
|
|
/** \brief Returns the class name */
|
|
virtual const char *klass() { return "fltk:device"; }
|
|
/** \brief Returns the plugin name */
|
|
virtual const char *name() = 0;
|
|
/** \brief Prints a widget
|
|
\param w the widget
|
|
\param x,y offsets where to print relatively to coordinates origin
|
|
\param height height of the current drawing area
|
|
*/
|
|
virtual int print(Fl_Widget* w, int x, int y, int height) = 0;
|
|
/** captures a rectangle of a widget as an image
|
|
\return The captured pixels as an RGB image
|
|
*/
|
|
virtual Fl_RGB_Image* rectangle_capture(Fl_Widget *widget, int x, int y, int w, int h) = 0;
|
|
};
|
|
|
|
#endif // Fl_Device_H
|
|
|
|
//
|
|
// End of "$Id$".
|
|
//
|