image::modification Class Reference

Base abstract class for an image-path modification. More...

#include <image_modifications.hpp>

Inheritance diagram for image::modification:

List of all members.

Classes
struct	texception
	Exception thrown by the operator() when an error occurs. More...
Public Member Functions
virtual	~modification ()
virtual surface	operator() (const surface &src) const =0
	Applies the image-path modification on the specified surface.
virtual int	priority () const
	Specifies the priority of the modification.
Static Public Member Functions
static modification_queue	decode (const std::string &)
	Decodes modifications from a modification string.

---

Detailed Description

Base abstract class for an image-path modification.

Definition at line 34 of file image_modifications.hpp.

---

Constructor & Destructor Documentation

virtual image::modification::~modification

(

)

[inline, virtual]

Definition at line 75 of file image_modifications.hpp.

---

Member Function Documentation

modification_queue image::modification::decode

(

const std::string &

encoded_mods

)

[static]

Decodes modifications from a modification string.

Decodes the modification string.

Important: It creates new objects which need to be deleted after use

Parameters:

encoded_mods

A string representing any number of modifications

Returns:

A modification_queue filled with decoded modification pointers

Definition at line 99 of file image_modifications.cpp.

References utils::parenthetical_split().

Referenced by BOOST_AUTO_TEST_CASE(), and image::locator::load_image_sub_file().

Here is the call graph for this function:

Here is the caller graph for this function:

virtual surface image::modification::operator()

(

const surface &

src

)

const [pure virtual]

Applies the image-path modification on the specified surface.

Implemented in image::rc_modification, image::fl_modification, image::rotate_modification, image::gs_modification, image::crop_modification, image::blit_modification, image::mask_modification, image::light_modification, image::scale_modification, image::o_modification, image::cs_modification, image::blend_modification, image::bl_modification, image::brighten_modification, image::darken_modification, and image::background_modification.

virtual int image::modification::priority

(

)

const [inline, virtual]

Specifies the priority of the modification.

Reimplemented in image::rc_modification.

Definition at line 81 of file image_modifications.hpp.

Referenced by image::mod_ptr_comparator_::operator()().

Here is the caller graph for this function:

---

The documentation for this class was generated from the following files:

• image_modifications.hpp
• image_modifications.cpp