oyFilterCore_s Struct Reference

a basic filter to manipulate data More...

#include <oyranos_alpha.h>

Public Member Functions
oyFilterCore_s *	oyFilterCore_New (const char *registration, oyOptions_s *options, oyObject_s object)
	lookup and initialise a new filter object
oyFilterCore_s *	oyFilterCore_Copy (oyFilterCore_s *filter, oyObject_s object)
	copy or reference a filter object
int	oyFilterCore_Release (oyFilterCore_s **obj)
	release and zero a filter object
const char *	oyFilterCore_GetText (oyFilterCore_s *filter, oyNAME_e name_type)
	get text
const char *	oyFilterCore_GetName (oyFilterCore_s *filter, oyNAME_e name_type)
	get name
const char *	oyFilterCore_CategoryGet (oyFilterCore_s *filter, int nontranslated)
	get category string
Data Fields
oyStruct_Copy_f	copy
oyStruct_Release_f	release

---

Detailed Description

a basic filter to manipulate data

This is the Oyranos filter object. Filters are categorised into basic classes of filters described in the registration_ (//xxx) member. Filters implement a container for data and options. Filters can be manipulated by changing their options or data set.

Filters are chained into a oyConversion_s in order to get applied to data. The relation of filters in a graph is defined through the oyFilterNode_s struct.

It is possible to chain filters in different ways together. The aimed way here is to use members and queries to find possible connections. For instance a one in one out filter can not be connected to two sources at once.

The registration_ describes different basic types of filters (//xxx). See oyranos::oyCONNECTOR_e.

Version:

Oyranos: 0.1.10

Since:

2008/06/08 (Oyranos: 0.1.8)

Date:

2009/11/17

---

Field Documentation

oyStruct_Copy_f oyFilterCore_s::copy

copy function

oyStruct_Release_f oyFilterCore_s::release

release function