tfilter Struct Reference

Contains the definition of a filter. More...

Public Types
typedef std::function< void(surface &surf, const std::string &parameters)>	tfunctor
	The functor to call for the filter. More...

Public Member Functions
	tfilter (const std::string &name__, const std::string &description__, const tfunctor &functor__)

Public Attributes
std::string	name
	The name of the filter. More...
tfilter_description	description
	Description of the filter. More...
tfunctor	functor
	The functor to call for the filter. More...

Detailed Description

Contains the definition of a filter.

Definition at line 25 of file filter.cpp.

Member Typedef Documentation

typedef std::function<void( surface& surf , const std::string& parameters )> tfilter::tfunctor

The functor to call for the filter.

surf The surface to apply the filter to. parameters A string with the parameters for the functor. The code is expected to be supplied on the command line. So it should be validated.

Definition at line 40 of file filter.cpp.

Constructor & Destructor Documentation

tfilter::tfilter ( const std::string &  name__, const std::string &  description__, const tfunctor &  functor__  )

inline

Definition at line 42 of file filter.cpp.

Member Data Documentation

tfilter_description tfilter::description

Description of the filter.

The exact format of the string is documented at filter_list.

Definition at line 64 of file filter.cpp.

tfunctor tfilter::functor

The functor to call for the filter.

Definition at line 67 of file filter.cpp.

std::string tfilter::name

The name of the filter.

This value must be unique.

Definition at line 57 of file filter.cpp.

---

The documentation for this struct was generated from the following file:

• wesmage/filter.cpp