![]() |
Oyranos Color Management System API |
A basic filter to manipulate data. More...
#include <oyFilterCore_s.h>
Public Member Functions | |
OYAPI oyFilterCore_s *OYEXPORT | oyFilterCore_New (oyObject_s object) |
allocate a new FilterCore object More... | |
OYAPI oyFilterCore_s *OYEXPORT | oyFilterCore_Copy (oyFilterCore_s *filtercore, oyObject_s object) |
copy or reference a FilterCore object More... | |
OYAPI int OYEXPORT | oyFilterCore_Release (oyFilterCore_s **filtercore) |
release and possibly deallocate a oyFilterCore_s object More... | |
const char * | oyFilterCore_GetCategory (oyFilterCore_s *filter, int nontranslated) |
Get category string. More... | |
const char * | oyFilterCore_GetName (oyFilterCore_s *filter, oyNAME_e name_type) |
Get name. More... | |
const char * | oyFilterCore_GetText (oyFilterCore_s *filter, oyNAME_e name_type) |
Get text. More... | |
oyFilterCore_s * | oyFilterCore_NewWith (const char *registration, oyOptions_s *options, oyObject_s object) |
Lookup and initialise a new filter object. More... | |
OYAPI const char *OYEXPORT | oyFilterCore_GetRegistration (oyFilterCore_s *filter) |
Get registration text. More... | |
OYAPI int OYEXPORT | oyFilterCore_SetBackendContext (oyFilterCore_s *obj, oyPointer_s *ptr) |
set backend specific runtime data More... | |
OYAPI oyPointer_s *OYEXPORT | oyFilterCore_GetBackendContext (oyFilterCore_s *obj) |
get backend specific runtime data More... | |
![]() | |
const char * | oyStruct_GetTextFromModule (oyStruct_s *obj, oyNAME_e name_type, uint32_t flags) |
get object infos from a module More... | |
const char * | oyStruct_GetText (oyStruct_s *obj, oyNAME_e name_type, uint32_t flags) |
get a text dump More... | |
Data Fields | |
const oyOBJECT_e | type_ |
Type of object. More... | |
oyStruct_Copy_f | copy |
Copy function. More... | |
oyStruct_Release_f | release |
Release function. More... | |
oyObject_s | oy_ |
Oyranos internal object. More... | |
![]() | |
const oyOBJECT_e | type_ |
Type of object. More... | |
oyStruct_Copy_f | copy |
Copy function. More... | |
oyStruct_Release_f | release |
Release function. More... | |
oyObject_s | oy_ |
Oyranos internal object. More... | |
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).
OYAPI oyFilterCore_s *OYEXPORT oyFilterCore_Copy | ( | oyFilterCore_s * | filtercore, |
oyObject_s | object | ||
) |
copy or reference a FilterCore object
Function oyFilterCore_Copy
The function is for copying and for referencing. The reference is the most often used way, which saves resourcs and time.
[in] | filtercore | FilterCore struct object |
object | NULL - means reference, the optional object triggers a real copy |
References oyOBJECT_FILTER_CORE_S.
Referenced by oyFilterNode_s::oyFilterNode_Create(), and oyFilterNode_s::oyFilterNode_GetCore().
OYAPI oyPointer_s *OYEXPORT oyFilterCore_GetBackendContext | ( | oyFilterCore_s * | obj | ) |
get backend specific runtime data
Backend context is used by a filter type during execution.
[in] | obj | the node object |
References oyCMMapi4_s::oyCMMapi4_GetBackendContext(), and oyOBJECT_FILTER_CORE_S.
const char * oyFilterCore_GetCategory | ( | oyFilterCore_s * | filter, |
int | nontranslated | ||
) |
Get category string.
Function oyFilterCore_GetCategory
[in,out] | filter | filter object |
nontranslated | switch for translation |
Referenced by oyFilterGraph_s::oyFilterGraph_ToText().
const char * oyFilterCore_GetName | ( | oyFilterCore_s * | filter, |
oyNAME_e | name_type | ||
) |
Get name.
Function oyFilterCore_GetName
provides the original filter names
[in,out] | filter | filter object |
name_type | type of name |
Referenced by oyFilterNode_s::oyFilterNode_Connect().
OYAPI const char *OYEXPORT oyFilterCore_GetRegistration | ( | oyFilterCore_s * | filter | ) |
Get registration text.
Function oyFilterCore_GetRegistration
[in] | filter | filter object |
const char * oyFilterCore_GetText | ( | oyFilterCore_s * | filter, |
oyNAME_e | name_type | ||
) |
Get text.
Function oyFilterCore_GetText
oyNAME_NAME provides a XML element with child elements and attributes
[in,out] | filter | filter object |
name_type | type of name |
References oyNAME_NAME, oyProfile_s::oyProfile_GetText(), oyProfiles_s::oyProfiles_Count(), and oyProfiles_s::oyProfiles_Get().
Referenced by oyFilterNode_s::oyFilterNode_GetText().
OYAPI oyFilterCore_s *OYEXPORT oyFilterCore_New | ( | oyObject_s | object | ) |
oyFilterCore_s * oyFilterCore_NewWith | ( | const char * | registration, |
oyOptions_s * | options, | ||
oyObject_s | object | ||
) |
Lookup and initialise a new filter object.
Function oyFilterCore_NewWith
back end selection:
[in] | registration | the filter registration pattern |
[in] | options | the supplied filter options |
[in] | object | the optional object |
References oyFilterCore_Release(), oyOBJECT_CMM_API4_S, and oyOptions_s::oyOptions_Copy().
Referenced by oyFilterNode_s::oyFilterNode_NewWith().
OYAPI int OYEXPORT oyFilterCore_Release | ( | oyFilterCore_s ** | filtercore | ) |
release and possibly deallocate a oyFilterCore_s object
Function oyFilterCore_Release
[in,out] | filtercore | FilterCore struct object |
References oyOBJECT_FILTER_CORE_S.
Referenced by oyFilterCore_NewWith(), oyFilterGraph_s::oyFilterGraph_ToText(), oyFilterNode_s::oyFilterNode_NewWith(), and oyOptions_s::oyOptions_ForFilter().
OYAPI int OYEXPORT oyFilterCore_SetBackendContext | ( | oyFilterCore_s * | obj, |
oyPointer_s * | ptr | ||
) |
set backend specific runtime data
Runtime data can be used as context by a backend during execution. The data is typical set during oyCMMapi4_s creation. This function provides access for a backend inside a DAC in order to change that data during backend lifetime.
[in,out] | obj | the node object |
[in] | ptr | the data needed to run the filter type |
References oyCMMapi4_s::oyCMMapi4_SetBackendContext(), and oyOBJECT_FILTER_CORE_S.
oyStruct_Copy_f oyFilterCore_s::copy |
Copy function.
oyObject_s oyFilterCore_s::oy_ |
Oyranos internal object.
Features name and hash. Do not change during object life time.
oyStruct_Release_f oyFilterCore_s::release |
Release function.
const oyOBJECT_e oyFilterCore_s::type_ |
Type of object.
The struct type tells Oyranos how to interprete hidden fields.