A class for xbm pictures. More...
#include <xbm.hpp>
Inheritance diagram for claw::graphic::xbm:
Classes | |
| class | reader |
| This class read data from a xbm file and store it in an image. More... | |
| class | writer |
| This class write an image in a xbm file. More... | |
Public Member Functions | |
| xbm (unsigned int w, unsigned int h) | |
| Constructor. Creates an empty image. | |
| xbm (const image &that) | |
| Copy constructor. | |
| xbm (std::istream &f) | |
| Constructor. Load an image from a xbm file. | |
| ~xbm () | |
| Destructor. | |
| void | save (std::ostream &os) const |
| Save the image. | |
| void | set_name (const std::string &name) |
| Set the name of the image. | |
| void | set_hot (const claw::math::coordinate_2d< int > &hot) |
| Set the hot spot of the image. | |
 Public Member Functions inherited from claw::graphic::image | |
| image () | |
| Constructor. Creates an image without datas. | |
| image (unsigned int w, unsigned int h) | |
| Constructor. Creates an empty image. | |
| image (std::istream &f) | |
| Constructor. Reads an image from an input stream. | |
| void | swap (image &that) |
| Swap the content of two images. | |
| unsigned int | width () const |
| Gets image's width. | |
| unsigned int | height () const |
| Gets image's height. | |
| scanline & | operator[] (unsigned int i) |
| Gets a line of the image. | |
| const scanline & | operator[] (unsigned int i) const |
| Gets a line of the image. | |
| iterator | begin () |
| Get an iterator pointing on the first pixel. | |
| iterator | end () |
| Get an iterator pointing just past the last pixel. | |
| const_iterator | begin () const |
| Get an iterator pointing on the first pixel. | |
| const_iterator | end () const |
| Get an iterator pointing just past the last pixel. | |
| void | merge (const image &that) |
| Merge an image on the current image. | |
| void | merge (const image &that, const math::coordinate_2d< int > &pos) |
| Merge an image on the current image. | |
| void | partial_copy (const image &that, const math::coordinate_2d< int > &pos) |
| Copy an image on the current image. | |
| void | flip () |
| Set the image upside down. | |
| void | fill (const math::rectangle< int > r, const pixel_type &c) |
| Fill an area of the image with a given color. | |
| void | set_size (unsigned int w, unsigned int h) |
| Set a new size to the image. | |
| void | load (std::istream &f) |
| Read the image from a stream. | |
Additional Inherited Members | |
| Public Types inherited from claw::graphic::image | |
| typedef rgba_pixel | pixel_type |
| The type representing the colors of the pixels in the image. | |
| typedef base_iterator< image, pixel_type > | iterator |
| The type of the iterator on the pixels of the image. | |
| typedef base_iterator< const image, const pixel_type > | const_iterator |
| The type of the iterator to access constant pixels. | |
Detailed Description
Constructor & Destructor Documentation
| claw::graphic::xbm::xbm | ( | unsigned int | w, |
| unsigned int | h | ||
| ) |
| claw::graphic::xbm::xbm | ( | const image & | that | ) |
| claw::graphic::xbm::xbm | ( | std::istream & | f | ) |
Member Function Documentation
| void claw::graphic::xbm::save | ( | std::ostream & | f | ) | const |
Save the image.
- Parameters
-
f The file in which we write.
Definition at line 82 of file xbm.cpp.
Referenced by claw::graphic::xbm::writer::writer().
| void claw::graphic::xbm::set_hot | ( | const claw::math::coordinate_2d< int > & | hot | ) |
Set the hot spot of the image.
- Parameters
-
hot The hot spot of the image;
Definition at line 102 of file xbm.cpp.
Referenced by claw::graphic::xbm::reader::reader().
| void claw::graphic::xbm::set_name | ( | const std::string & | name | ) |
Set the name of the image.
- Parameters
-
name The name of the image;
Definition at line 92 of file xbm.cpp.
Referenced by claw::graphic::xbm::reader::reader().
The documentation for this class was generated from the following files:
