![]() |
Oyranos Color Management System API |
A filter connection structure. More...
#include <oyFilterPlug_s.h>
Public Member Functions | |
OYAPI oyFilterPlug_s *OYEXPORT | oyFilterPlug_New (oyObject_s object) |
allocate a new FilterPlug object More... | |
OYAPI oyFilterPlug_s *OYEXPORT | oyFilterPlug_Copy (oyFilterPlug_s *filterplug, oyObject_s object) |
copy or reference a FilterPlug object More... | |
OYAPI int OYEXPORT | oyFilterPlug_Release (oyFilterPlug_s **filterplug) |
release and possibly deallocate a oyFilterPlug_s object More... | |
OYAPI int OYEXPORT | oyFilterPlug_Callback (oyFilterPlug_s *c, oyCONNECTOR_EVENT_e e) |
Tell about a oyConversion_s event. More... | |
OYAPI int OYEXPORT | oyFilterPlug_ConnectIntoSocket (oyFilterPlug_s **p, oyFilterSocket_s **s) |
Connect a oyFilterPlug_s with a oyFilterSocket_s. More... | |
OYAPI oyFilterNode_s *OYEXPORT | oyFilterPlug_GetNode (oyFilterPlug_s *plug) |
Access oyFilterPlug_s::node. More... | |
OYAPI oyFilterNode_s *OYEXPORT | oyFilterPlug_GetRemoteNode (oyFilterPlug_s *plug) |
Access oyFilterPlug_s::remote_socket::node. More... | |
OYAPI oyFilterSocket_s *OYEXPORT | oyFilterPlug_GetSocket (oyFilterPlug_s *plug) |
Access oyFilterPlug_s::remote_socket_. More... | |
OYAPI oyConnector_s *OYEXPORT | oyFilterPlug_GetPattern (oyFilterPlug_s *plug) |
Access oyFilterPlug_s::pattern. More... | |
OYAPI const char *OYEXPORT | oyFilterPlug_GetRelatives (oyFilterPlug_s *plug) |
get short description of belonging filter More... | |
OYAPI oyConnector_s *OYEXPORT | oyFilterSocket_GetPattern (oyFilterSocket_s *socket) |
Access oyFilterPlug_s::pattern. More... | |
OYAPI oyImage_s *OYEXPORT | oyFilterPlug_ResolveImage (oyFilterPlug_s *plug, oyFilterSocket_s *socket, oyPixelAccess_s *ticket) |
Resolve processing data during a filter run. 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 filter connection structure.
The active input version of a oyConnector_s. Each plug can connect to exact one socket.
OYAPI int OYEXPORT oyFilterPlug_Callback | ( | oyFilterPlug_s * | c, |
oyCONNECTOR_EVENT_e | e | ||
) |
Tell about a oyConversion_s event.
Function oyFilterPlug_Callback
[in,out] | c | the connector |
e | the event type |
OYAPI int OYEXPORT oyFilterPlug_ConnectIntoSocket | ( | oyFilterPlug_s ** | p, |
oyFilterSocket_s ** | s | ||
) |
Connect a oyFilterPlug_s with a oyFilterSocket_s.
Function oyFilterPlug_ConnectIntoSocket
References oyCONNECTOR_EVENT_RELEASED, oyFilterSocket_s::oyFilterSocket_Callback(), oyFilterSocket_s::oyFilterSocket_Release(), and oyStructTypeToText().
Referenced by oyFilterNode_s::oyFilterNode_Connect().
OYAPI oyFilterPlug_s *OYEXPORT oyFilterPlug_Copy | ( | oyFilterPlug_s * | filterplug, |
oyObject_s | object | ||
) |
copy or reference a FilterPlug object
Function oyFilterPlug_Copy
The function is for copying and for referencing. The reference is the most often used way, which saves resourcs and time.
[in] | filterplug | FilterPlug struct object |
object | NULL - means reference, the optional object triggers a real copy |
References oyOBJECT_FILTER_PLUG_S.
Referenced by oyFilterNode_s::oyFilterNode_GetPlug().
OYAPI oyFilterNode_s *OYEXPORT oyFilterPlug_GetNode | ( | oyFilterPlug_s * | plug | ) |
Access oyFilterPlug_s::node.
Function oyFilterPlug_GetNode
[in] | plug | the plug |
References oyFilterNode_s::oyFilterNode_Copy(), and oyOBJECT_FILTER_PLUG_S.
OYAPI oyConnector_s *OYEXPORT oyFilterPlug_GetPattern | ( | oyFilterPlug_s * | plug | ) |
Access oyFilterPlug_s::pattern.
Function oyFilterPlug_GetPattern
[in] | plug | the plug |
References oyConnector_s::oyConnector_Copy(), and oyOBJECT_FILTER_PLUG_S.
OYAPI const char *OYEXPORT oyFilterPlug_GetRelatives | ( | oyFilterPlug_s * | plug | ) |
get short description of belonging filter
Function oyFilterPlug_GetRelatives
[in] | plug | the plug |
References oyOBJECT_FILTER_PLUG_S.
OYAPI oyFilterNode_s *OYEXPORT oyFilterPlug_GetRemoteNode | ( | oyFilterPlug_s * | plug | ) |
Access oyFilterPlug_s::remote_socket::node.
Function oyFilterPlug_GetRemoteNode
[in] | plug | the plug |
References oyFilterSocket_s::oyFilterSocket_GetNode(), and oyOBJECT_FILTER_PLUG_S.
OYAPI oyFilterSocket_s *OYEXPORT oyFilterPlug_GetSocket | ( | oyFilterPlug_s * | plug | ) |
Access oyFilterPlug_s::remote_socket_.
Function oyFilterPlug_GetSocket
[in] | plug | the plug |
References oyFilterSocket_s::oyFilterSocket_Copy(), and oyOBJECT_FILTER_PLUG_S.
OYAPI oyFilterPlug_s *OYEXPORT oyFilterPlug_New | ( | oyObject_s | object | ) |
allocate a new FilterPlug object
Function oyFilterPlug_New
References oyOBJECT_OBJECT_S.
Referenced by oyFilterNode_s::oyFilterNode_GetPlug().
OYAPI int OYEXPORT oyFilterPlug_Release | ( | oyFilterPlug_s ** | filterplug | ) |
release and possibly deallocate a oyFilterPlug_s object
Function oyFilterPlug_Release
[in,out] | filterplug | FilterPlug struct object |
References oyOBJECT_FILTER_PLUG_S.
Referenced by oyConversion_s::oyConversion_GetOnePixel(), and oyFilterNode_s::oyFilterNode_GetSocketNode().
OYAPI oyImage_s *OYEXPORT oyFilterPlug_ResolveImage | ( | oyFilterPlug_s * | plug, |
oyFilterSocket_s * | socket, | ||
oyPixelAccess_s * | ticket | ||
) |
Resolve processing data during a filter run.
Function oyFilterPlug_ResolveImage
The function is a convenience function to use inside a filters oyCMMFilterPlug_Run_f call. The function makes only sense for non root filters.
[in,out] | plug | the filters own plug |
[in,out] | socket | the filters own socket |
[in,out] | ticket | the actual ticket |
References oyFilterNode_s::oy_, oyBOOLEAN_INTERSECTION, oyBOOLEAN_UNION, oyChannels_m, oyDataType_m, oyFilterNode_s::oyFilterNode_GetOptions(), oyFilterNode_s::oyFilterNode_SetData(), oyImage_s::oyImage_Copy(), oyImage_s::oyImage_Create(), oyImage_s::oyImage_Release(), oyOptions_s::oyOptions_CopyFrom(), oyOptions_s::oyOptions_Filter(), oyOptions_s::oyOptions_FindInt(), oyOptions_s::oyOptions_Release(), oyProfile_s::oyProfile_GetChannelsCount(), oyToChannels_m, and oyToDataType_m.
OYAPI oyConnector_s *OYEXPORT oyFilterSocket_GetPattern | ( | oyFilterSocket_s * | socket | ) |
Access oyFilterPlug_s::pattern.
Function oyFilterPlug_GetPattern
[in] | socket | the socket |
References oyConnector_s::oyConnector_Copy(), and oyOBJECT_FILTER_SOCKET_S.
oyStruct_Copy_f oyFilterPlug_s::copy |
Copy function.
oyObject_s oyFilterPlug_s::oy_ |
Oyranos internal object.
Features name and hash. Do not change during object life time.
oyStruct_Release_f oyFilterPlug_s::release |
Release function.
const oyOBJECT_e oyFilterPlug_s::type_ |
Type of object.
The struct type tells Oyranos how to interprete hidden fields.
Referenced by oyFilterPlugs_s::oyFilterPlugs_MoveIn().