Imagine++
ImageIO.h
1 // ===========================================================================
2 // Imagine++ Libraries
3 // Copyright (C) Imagine
4 // For detailed information: http://imagine.enpc.fr/software
5 // ===========================================================================
6 
7 #ifndef IMAGINE_GRAPHICS_IMAGEIO_H
8 #define IMAGINE_GRAPHICS_IMAGEIO_H
9 
10 namespace Imagine {
13 
14  // ====================================================
15  // ImageIO: displaying, loading, saving, capturing, ...
16 
17  // Image displaying functions
18 
30  void putColorImage(int x, int y, const Color* cols, int w, int h, bool xorMode = false, double fact = 1.);
42  inline void putColorImage(const IntPoint2& p, const Color* cols, int w, int h, bool xorMode = false, double fact = 1.)
43  { putColorImage(p.x(), p.y(), cols, w, h, xorMode, fact); }
55  void putColorImage(int x, int y, const octet *rgb, int w, int h, bool xorMode = false, double fact = 1.);
67  inline void putColorImage(const IntPoint2& p, const octet *rgb, int w, int h, bool xorMode = false, double fact = 1.)
68  { putColorImage(p.x(), p.y(), rgb, w, h, xorMode, fact); }
80  void putColorImage(int x, int y, const octet *r, const octet *g, const octet *b, int w, int h, bool xorMode = false, double fact = 1.);
81 
93  inline void putColorImage(const IntPoint2& p, const octet *r, const octet *g, const octet *b, int w, int h, bool xorMode = false, double fact = 1.)
94  { putColorImage(p.x(), p.y(), r, g, b, w, h, xorMode, fact); }
95 
96  // Color Image whith transparency displaying functions
108  void putAlphaColorImage(int x, int y, Imagine::AlphaColor *cols, int w, int h, bool xorMode = false, double fact = 1.);
120  void putColorImage(int x, int y, const octet *r, const octet *g, const octet *b, const octet *a,int w, int h, bool xorMode = false, double fact = 1.);
132  inline void putColorImage(const IntPoint2& p, const octet *r, const octet *g, const octet *b, const octet *a,int w, int h, bool xorMode = false, double fact = 1.)
133  { putColorImage(p.x(), p.y(), r, g, b, a ,w, h, xorMode, fact); }
145  void putAlphaColorImage(int x, int y, octet *rgba, int w, int h, bool xorMode = false, double fact = 1.);
157  void putAlphaColorImage(const IntPoint2& p, octet *rgba, int w, int h, bool xorMode = false, double fact = 1.);
169  void putGreyImage(int x, int y, const octet* g, int w, int h, bool xorMode = false, double fact = 1.);
181  inline void putGreyImage(const IntPoint2& p, const octet* g, int w, int h, bool xorMode = false, double fact = 1.)
182  { putGreyImage(p.x(), p.y(), g, w, h, xorMode, fact); }
192  void setMaskFromColor(octet *&r, octet *&g, octet *&b, octet *&a, int w, int h, const Color &col);
202  void setMaskFromColor(octet *&rgba, int w, int h, const Color &col);
212  void setMaskFromColor(AlphaColor *&acols, int w, int h, AlphaColor col);
221  AlphaColor* convertColorToAlphaColor(const Imagine::Color *cols, int w, int h);
222  // Image loading functions
233  bool loadColorImage(const std::string& name, Color *&cols, int& w, int& h);
244  bool loadAlphaColorImage(const std::string& name, AlphaColor *&acols, int& w, int& h);
255  bool loadColorImage(const std::string &name, octet *&rgb, int &w, int &h);
266  bool loadAlphaColorImage(const std::string &name, octet *&rgba, int &w, int &h);
277  bool loadColorImage(const std::string &name, octet *&r, octet *&g, octet *&b, int &w, int &h);
288  bool loadColorImage(const std::string &name, octet *&r, octet *&g, octet *&b, octet*&a, int &w, int &h);
299  bool loadGreyImage(const std::string& name, octet*& g, int& w, int& h);
300 
301  // Image saving functions
302 
314  bool saveColorImage(const std::string& name,const Color* cols, int w, int h, int quality = 85);
326  bool saveAlphaColorImage(const std::string& name, Imagine::AlphaColor *cols, int w, int h, int quality = 85);
338  bool saveColorImage(const std::string &name, const octet *rgb, int w, int h, int quality = 85);
350  bool saveAlphaColorImage(const std::string &name, octet *rgba, int w, int h, int quality = 85);
362  bool saveColorImage(const std::string &name, const octet *r, const octet *g, const octet *b, int w, int h, int quality = 85);
374  bool saveAlphaColorImage(const std::string &name, const octet *r, const octet *g, const octet *b, const octet *a,int w, int h, int quality = 85);
386  bool saveGreyImage(const std::string& name, const octet* g, int w, int h, int quality = 85);
387 
388  // Image capture functions
389 
397  Color capturePoint(int x, int y);
405  inline Color capturePoint(const IntPoint2& p)
406  { return capturePoint(p.x(), p.y()); }
415  void captureRectangle(int x, int y, Color *c, int w, int h);
424  inline void captureRectangle(const IntPoint2& p, Color *c, int w, int h)
425  { captureRectangle(p.x(), p.y(), c, w, h); }
434  void captureRectangle(int x, int y, octet *RGB, int w, int h);
443  inline void captureRectangle(const IntPoint2& p, octet *RGB, int w, int h)
444  { captureRectangle(p.x(), p.y(), RGB, w, h); }
453  void captureRectangle(int x, int y, octet *R, octet *G, octet *B, int w, int h);
462  inline void captureRectangle(const IntPoint2& p, octet *R, octet *G, octet *B, int w, int h)
463  { captureRectangle(p.x(), p.y(), R, G, B, w, h); }
472  void captureWindow(Color *&cols, int &w, int &h);
481  void captureWindow(octet *&RGB, int &w, int &h);
490  void captureWindow(octet *&R, octet *&G, octet *&B, int &w, int &h);
491 
492  // ====================================================
493  // NativeBitmap class
494 #ifndef DOXYGEN_SHOULD_SKIP_THIS
495  class NativeBitmapInternal; // Private
496  class NativeBitmap;
497 #endif
498  void putNativeBitmap(int x,int y,const NativeBitmap &bm,bool xorMode=false,double fact=1.);
509 
514  class NativeBitmap {
515  NativeBitmapInternal* priv;
516  public:
518  NativeBitmap();
525  NativeBitmap(int w,int h);
527  NativeBitmap(const NativeBitmap& I);
529  ~NativeBitmap();
531  const NativeBitmap& operator=(const NativeBitmap& I);
541  void setColorImage(int x,int y,const octet *r,const octet *g,const octet *b,int w,int h);
551  inline void setColorImage(const IntPoint2&p,const octet *r,const octet *g,const octet *b,int w,int h)
552  { setColorImage(p.x(),p.y(),r,g,b,w,h); }
562  void setColorImage(int x,int y,const Color *cols,int w,int h);
572  inline void setColorImage(const IntPoint2& p,const Color *cols,int w,int h)
573  { setColorImage(p.x(),p.y(),cols,w,h); }
583  inline void setColorImage(int x,int y,const octet *rgb,int w,int h)
584  { setColorImage(x,y,(const Color*)rgb,w,h); }
594  inline void setColorImage(const IntPoint2& p,const octet *rgb,int w,int h)
595  { setColorImage(p.x(),p.y(),(const Color*)rgb,w,h); }
605  void setGreyImage(int x,int y,const octet *g,int w,int h);
615  inline void setGreyImage(const IntPoint2 &p,const octet *g,int w,int h)
616  { setGreyImage(p.x(),p.y(),g,w,h); }
625  void setPoint(int x,int y,Color col);
634  inline void setPoint(const IntPoint2&p,Color col)
635  { setPoint(p.x(),p.y(),col); }
636  friend void putNativeBitmap(int x,int y,const NativeBitmap &bm,bool xorMode,double fact);
647  friend inline void putNativeBitmap(const IntPoint2& p,const NativeBitmap &bm,bool xorMode=false,double fact=1.) // Variant with IntPoint2
648  { putNativeBitmap(p.x(),p.y(),bm,xorMode,fact); }
649  };
650 
652 } /* namespace Imagine */
653 
654 #endif // IMAGINE_GRAPHICS_IMAGEIO_H
Imagine::saveColorImage
bool saveColorImage(const std::string &name, const Color *cols, int w, int h, int quality=85)
Save color image.
Imagine::captureRectangle
void captureRectangle(int x, int y, Color *c, int w, int h)
Capture (sub window).
Imagine::convertColorToAlphaColor
AlphaColor * convertColorToAlphaColor(const Imagine::Color *cols, int w, int h)
Convert a Color Image to a AlphaColor Image.
Imagine::NativeBitmap
Native bitmap: image stored in graphics card format, fast to display.
Definition: ImageIO.h:514
Imagine::IntPoint2
Coords< 2 > IntPoint2
Plane point with integral coordinates.
Definition: Types.h:17
Imagine::AlphaColor
RGBA< octet > AlphaColor
RGBA alias.
Definition: Color.h:356
Imagine::loadColorImage
bool loadColorImage(const std::string &name, Color *&cols, int &w, int &h)
Load color image.
Imagine::NativeBitmap::setColorImage
void setColorImage(int x, int y, const octet *rgb, int w, int h)
Set color image.
Definition: ImageIO.h:583
Imagine::setMaskFromColor
void setMaskFromColor(octet *&r, octet *&g, octet *&b, octet *&a, int w, int h, const Color &col)
Create a transparency mask from a specified color-key.
Imagine::putNativeBitmap
void putNativeBitmap(int x, int y, const NativeBitmap &bm, bool xorMode=false, double fact=1.)
Display native bitmap.
Imagine::NativeBitmap::NativeBitmap
NativeBitmap()
Empty constructor.
Imagine::Color
RGB< octet > Color
RGB alias.
Definition: Color.h:283
Imagine::NativeBitmap::operator=
const NativeBitmap & operator=(const NativeBitmap &I)
Assignment.
Imagine::NativeBitmap::setColorImage
void setColorImage(const IntPoint2 &p, const octet *rgb, int w, int h)
Set color image.
Definition: ImageIO.h:594
Imagine::captureWindow
void captureWindow(Color *&cols, int &w, int &h)
Window capture.
Imagine::capturePoint
Color capturePoint(int x, int y)
Capture (point).
Imagine::saveAlphaColorImage
bool saveAlphaColorImage(const std::string &name, Imagine::AlphaColor *cols, int w, int h, int quality=85)
Save color image with alpha channel.
Imagine::putAlphaColorImage
void putAlphaColorImage(int x, int y, Imagine::AlphaColor *cols, int w, int h, bool xorMode=false, double fact=1.)
Display color bitmap with alpha channel.
Imagine::RGBA
RED GREEN BLUE Alpha color.
Definition: Color.h:140
Imagine::NativeBitmap::setPoint
void setPoint(const IntPoint2 &p, Color col)
Set point.
Definition: ImageIO.h:634
Imagine::NativeBitmap::setGreyImage
void setGreyImage(const IntPoint2 &p, const octet *g, int w, int h)
Set grey image.
Definition: ImageIO.h:615
Imagine::saveGreyImage
bool saveGreyImage(const std::string &name, const octet *g, int w, int h, int quality=85)
Save grey image.
Imagine::putGreyImage
void putGreyImage(int x, int y, const octet *g, int w, int h, bool xorMode=false, double fact=1.)
Display grey bitmap.
Imagine::putColorImage
void putColorImage(int x, int y, const Color *cols, int w, int h, bool xorMode=false, double fact=1.)
Display color bitmap.
Imagine::NativeBitmap::~NativeBitmap
~NativeBitmap()
Destructor.
Imagine::loadGreyImage
bool loadGreyImage(const std::string &name, octet *&g, int &w, int &h)
Load grey image.
Imagine::NativeBitmap::setColorImage
void setColorImage(int x, int y, const octet *r, const octet *g, const octet *b, int w, int h)
Set color image.
Imagine::octet
unsigned char octet
0 to 255 integer type.
Definition: Color.h:18
Imagine::NativeBitmap::putNativeBitmap
friend void putNativeBitmap(const IntPoint2 &p, const NativeBitmap &bm, bool xorMode=false, double fact=1.)
Display native bitmap.
Definition: ImageIO.h:647
Imagine::loadAlphaColorImage
bool loadAlphaColorImage(const std::string &name, AlphaColor *&acols, int &w, int &h)
Load color image with alpha channel.
Imagine::NativeBitmap::setPoint
void setPoint(int x, int y, Color col)
Set point.
Imagine::NativeBitmap::setColorImage
void setColorImage(const IntPoint2 &p, const Color *cols, int w, int h)
Set color image.
Definition: ImageIO.h:572
Imagine::NativeBitmap::setGreyImage
void setGreyImage(int x, int y, const octet *g, int w, int h)
Set grey image.
Imagine::FVector::x
const T & x() const
Read alias.
Definition: FVector.h:104
Imagine
Imagine++ namespace.
Definition: Array.h:7
Imagine::RGB
RED GREEN BLUE color.
Definition: Color.h:28
Imagine::FVector::y
const T & y() const
Read alias.
Definition: FVector.h:118
Imagine::NativeBitmap::putNativeBitmap
friend void putNativeBitmap(int x, int y, const NativeBitmap &bm, bool xorMode, double fact)
Display native bitmap.
Imagine::NativeBitmap::setColorImage
void setColorImage(const IntPoint2 &p, const octet *r, const octet *g, const octet *b, int w, int h)
Set color image.
Definition: ImageIO.h:551
Generated on Thu Jul 17 2025 15:07:22 for Imagine++ by   doxygen 1.8.8