This is the Oyranos filter object. Filters are categorised into basic classes of filters described in the filter_type_ member. Filters implement a container for data and options. Filters can be manipulated by changing their options or data set. More...
#include <oyranos_alpha.h>
Data Fields | |
oyOBJECT_e | type_ |
oyStruct_Copy_f | copy |
oyStruct_Release_f | release |
oyObject_s | oy_ |
const char * | registration_ |
oyName_s * | name_ |
char * | lib_name_ |
oyFILTER_TYPE_e | filter_type_ |
char * | category_ |
oyOptions_s * | options_ |
char * | opts_ui_ |
oyCMMapi4_s * | api4_ |
Related Functions | |
(Note that these are not member functions.) | |
oyFilter_s * | oyFilter_New (oyFILTER_TYPE_e filter_type, const char *registration, const char *cmm_required, oyOptions_s *options, oyObject_s object) |
lookup and initialise a new filter object | |
oyFilter_s * | oyFilter_Copy (oyFilter_s *filter, oyObject_s object) |
copy or reference a filter object | |
int | oyFilter_Release (oyFilter_s **obj) |
release and zero a filter object | |
const char * | oyFilter_GetText (oyFilter_s *filter, oyNAME_e name_type) |
get text | |
const char * | oyFilter_GetName (oyFilter_s *filter, oyNAME_e name_type) |
get name | |
const char * | oyFilter_CategoryGet (oyFilter_s *filter, int nontranslated) |
get category string | |
oyOptions_s * | oyFilter_OptionsGet (oyFilter_s *filter, int flags) |
get filter options | |
OYAPI oyConnector_s *OYEXPORT | oyFilter_ShowConnector (oyFilter_s *filter, int as_pos, int is_plug) |
get a connector description from a filter backend | |
OYAPI int OYEXPORT | oyFilter_ShowConnectorCount (oyFilter_s *filter, int is_plug, uint32_t *last_adds) |
get the connector count from a filter backend |
This is the Oyranos filter object. Filters are categorised into basic classes of filters described in the filter_type_ 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 oyFILTER_TYPE_e describes different basic types of filters.
oyCMMapi4_s* oyFilter_s::api4_ |
Referenced by oyConversion_s::oyConversion_FilterAdd(), oyConversion_s::oyConversion_GetOnePixel(), oyConversion_s::oyConversion_Run(), oyFilter_GetText(), oyFilter_ShowConnector(), oyFilter_ShowConnectorCount(), oyFilterNode_s::oyFilterNode_Create(), oyFilterNode_s::oyFilterNode_GetPlug(), oyFilterNode_s::oyFilterNode_GetSocket(), oyFilterNode_s::oyFilterNode_Release(), and oyOptions_s::oyOptions_ForFilter_().
char* oyFilter_s::category_ |
the ui menue category for this filter, to be specified
Referenced by oyFilter_CategoryGet(), oyFilter_GetText(), oyFilter_Release(), and oyFilterNode_s::oyFilterNode_Create().
oyStruct_Copy_f oyFilter_s::copy |
copy function
filter type
Referenced by oyConversion_s::oyConversion_FilterAdd(), and oyConversion_s::oyConversion_OutputAdd().
char* oyFilter_s::lib_name_ |
the CMM
nick, name, description/help
Referenced by oyFilter_GetName().
local options
Referenced by oyFilter_New(), oyFilter_OptionsGet(), and oyFilterNode_s::oyFilterNode_GetText().
char* oyFilter_s::opts_ui_ |
xml ui elements for filter options
base object
Referenced by oyFilter_Copy(), oyFilter_GetText(), oyFilter_New(), oyFilter_OptionsGet(), oyFilter_Release(), oyFilterNode_s::oyFilterNode_Create(), and oyOptions_s::oyOptions_ForFilter().
const char* oyFilter_s::registration_ |
a registration name, e.g. "sw/oyranos.org/generic/scale"
Referenced by oyFilter_GetText(), oyFilter_Release(), and oyOptions_s::oyOptions_ForFilter_().
oyStruct_Release_f oyFilter_s::release |
release function
struct type oyOBJECT_FILTER_S
Referenced by oyFilter_Release(), oyFilter_ShowConnector(), oyFilter_ShowConnectorCount(), and oyFilters_s::oyFilters_MoveIn().