image::modification Class Reference

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

#include <image_modifications.hpp>

Inheritance diagram for image::modification:

Classes
struct	imod_exception
	Exception thrown by the operator() when an error occurs. More...

Public Member Functions
virtual	~modification ()
virtual void	operator() (surface &src) const =0
	Applies the image-path modification on the specified surface. More...
virtual int	priority () const
	Specifies the priority of the modification. More...

Static Public Member Functions
static modification_queue	decode (const std::string &)
	Decodes modifications from a modification string. More...

Detailed Description

Base abstract class for an image-path modification.

Definition at line 61 of file image_modifications.hpp.

Constructor & Destructor Documentation

~modification()

virtual image::modification::~modification ( )

inlinevirtual

Definition at line 102 of file image_modifications.hpp.

Member Function Documentation

decode()

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 141 of file image_modifications.cpp.

References utils::parenthetical_split(), and image::modification_queue::push().

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

operator()()

virtual void image::modification::operator() ( surface &  src ) const

pure virtual

Applies the image-path modification on the specified surface.

Implemented in image::swap_modification, image::background_modification, image::bl_modification, image::blend_modification, image::cs_modification, image::o_modification, image::xbrz_modification, image::scale_modification, image::light_modification, image::mask_modification, image::blit_modification, image::crop_modification, image::adjust_channels_modification, image::adjust_alpha_modification, image::wipe_alpha_modification, image::plot_alpha_modification, image::negative_modification, image::sepia_modification, image::bw_modification, image::crop_transparency_modification, image::gs_modification, image::rotate_modification, image::fl_modification, and image::rc_modification.

priority()

virtual int image::modification::priority ( ) const

inlinevirtual

Specifies the priority of the modification.

Reimplemented in image::rc_modification.

Definition at line 108 of file image_modifications.hpp.

---

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

• image_modifications.hpp
• image_modifications.cpp