|
Oyranos Color Management System API - Version 0.9.6 |
Node connection descriptor. More...
#include <oyConnectorImaging_s.h>
Public Member Functions | |
| OYAPI oyConnectorImaging_s *OYEXPORT | oyConnectorImaging_New (oyObject_s object) |
| allocate a new ConnectorImaging object | |
| oyConnectorImaging_Copy | |
| Copy or Reference a ConnectorImaging object. | |
| OYAPI int OYEXPORT | oyConnectorImaging_Release (oyConnectorImaging_s **connectorimaging) |
| release and possibly deallocate a oyConnectorImaging_s object | |
| OYAPI int OYEXPORT | oyConnectorImaging_SetDataTypes (oyConnectorImaging_s *c, oyDATATYPE_e *data_types, int data_types_n) |
| Set data types capability of oyConnectorImaging_s. | |
| OYAPI int OYEXPORT | oyConnectorImaging_GetDataTypes (oyConnectorImaging_s *c, const oyDATATYPE_e **data_types, int *data_types_n) |
| Get capabilities of oyConnectorImaging_s. | |
| OYAPI int OYEXPORT | oyConnectorImaging_GetChannelTypes (oyConnectorImaging_s *c, const oyCHANNELTYPE_e **channel_types, int *channel_types_n) |
| Get capabilities of oyConnectorImaging_s. | |
| OYAPI int OYEXPORT | oyConnectorImaging_GetCapability (oyConnectorImaging_s *c, oyCONNECTOR_IMAGING_CAP_e type) |
| Get capabilities of oyConnectorImaging_s. | |
| OYAPI int OYEXPORT | oyConnectorImaging_SetCapability (oyConnectorImaging_s *c, oyCONNECTOR_IMAGING_CAP_e type, int value) |
| Set capabilities of oyConnectorImaging_s. | |
| OYAPI int OYEXPORT | oyConnectorImaging_SetTexts (oyConnectorImaging_s *obj, oyCMMGetText_f getText, const char **text_classes) |
| set the texts in a connector | |
| OYAPI const char **OYEXPORT | oyConnectorImaging_GetTexts (oyConnectorImaging_s *obj) |
| get the text classes in a connector | |
| OYAPI const char *OYEXPORT | oyConnectorImaging_GetText (oyConnectorImaging_s *obj, const char *name_class, oyNAME_e type) |
| get the names in a connector | |
| int | oyConnectorImaging_IsPlug (oyConnectorImaging_s *obj) |
| Is this connector a plug or a socket. | |
| int | oyConnectorImaging_SetIsPlug (oyConnectorImaging_s *obj, int is_plug) |
| Set this connector as a plug or a socket. | |
| const char * | oyConnectorImaging_GetReg (oyConnectorImaging_s *obj) |
| Get the registration for the connection type. | |
| int | oyConnectorImaging_SetReg (oyConnectorImaging_s *obj, const char *type_registration) |
| Set this connectors type string. | |
| int | oyConnectorImaging_SetMatch (oyConnectorImaging_s *obj, oyCMMFilterSocket_MatchPlug_f func) |
| Set this connectors type check function. | |
| oyCMMFilterSocket_MatchPlug_f | oyConnectorImaging_GetMatch (oyConnectorImaging_s *obj) |
| Set this connectors type check function. | |
 Public Member Functions inherited from oyConnector_s | |
| OYAPI oyConnector_s *OYEXPORT | oyConnector_New (oyObject_s object) |
| allocate a new Connector object | |
| oyConnector_Copy | |
| Copy or Reference a Connector object. | |
| OYAPI int OYEXPORT | oyConnector_Release (oyConnector_s **connector) |
| release and possibly deallocate a oyConnector_s object | |
| OYAPI int OYEXPORT | oyConnector_SetTexts (oyConnector_s *obj, oyCMMGetText_f getText, const char **text_classes) |
| set the texts in a connector | |
| OYAPI const char **OYEXPORT | oyConnector_GetTexts (oyConnector_s *obj) |
| get the text classes in a connector | |
| OYAPI const char *OYEXPORT | oyConnector_GetText (oyConnector_s *obj, const char *name_class, oyNAME_e type) |
| get the names in a connector | |
| int | oyConnector_IsPlug (oyConnector_s *obj) |
| Is this connector a plug or a socket. | |
| int | oyConnector_SetIsPlug (oyConnector_s *obj, int is_plug) |
| Set this connector as a plug or a socket. | |
| const char * | oyConnector_GetReg (oyConnector_s *obj) |
| Get the registration for the connection type. | |
| int | oyConnector_SetReg (oyConnector_s *obj, const char *type_registration) |
| Set this connectors type string. | |
| int | oyConnector_SetMatch (oyConnector_s *obj, oyCMMFilterSocket_MatchPlug_f func) |
| Set this connectors type check function. | |
| oyCMMFilterSocket_MatchPlug_f | oyConnector_GetMatch (oyConnector_s *obj) |
| Set this connectors type check function. | |
| Public Member Functions inherited from oyStruct_s | |
| const char * | oyStruct_GetTextFromModule (oyStruct_s *obj, oyNAME_e name_type, uint32_t flags) |
| get object infos from a module | |
| const char * | oyStruct_GetText (oyStruct_s *obj, oyNAME_e name_type, uint32_t flags) |
| Get a text dump. | |
| oyStruct_RegisterStaticMessageFunc | |
| register a function for verbosity | |
| oyStruct_GetInfo | |
| get a additional string from a object | |
| const char * | oyStructTypeToText (oyOBJECT_e type) |
| Objects type to small string. | |
Data Fields | |
| const oyOBJECT_e | type_ |
| Type of object. | |
| oyStruct_Copy_f | copy |
| Copy function. | |
| oyStruct_Release_f | release |
| Release function. | |
| oyObject_s | oy_ |
| Oyranos internal object. | |
| Data Fields inherited from oyConnector_s | |
| const oyOBJECT_e | type_ |
| Type of object. | |
| oyStruct_Copy_f | copy |
| Copy function. | |
| oyStruct_Release_f | release |
| Release function. | |
| oyObject_s | oy_ |
| Oyranos internal object. | |
| Data Fields inherited from oyStruct_s | |
| const oyOBJECT_e | type_ |
| Type of object. | |
| oyStruct_Copy_f | copy |
| Copy function. | |
| oyStruct_Release_f | release |
| Release function. | |
| oyObject_s | oy_ |
| Oyranos internal object. | |
Node connection descriptor.
This structure holds informations about the connection capabilities. It holds common structure members of oyFilterPlug_s and oyFilterSocket_s.
To signal a value is not initialised or does not apply, set the according integer value to -1.
| oyConnectorImaging_Copy |
Copy or Reference a ConnectorImaging object.
The function is for copying and for referencing. The reference is the most often used way, which saves resourcs and time.
| [in] | connectorimaging | ConnectorImaging struct object |
| object | NULL - means reference, the optional object triggers a real copy |
| OYAPI int OYEXPORT oyConnectorImaging_GetCapability | ( | oyConnectorImaging_s * | c, |
| oyCONNECTOR_IMAGING_CAP_e | type | ||
| ) |
Get capabilities of oyConnectorImaging_s.
Function oyConnectorImaging_GetDataTypes
References oyCONNECTOR_IMAGING_CAP_CAN_INTERWOVEN, oyCONNECTOR_IMAGING_CAP_CAN_NONPREMULTIPLIED_ALPHA, oyCONNECTOR_IMAGING_CAP_CAN_PLANAR, oyCONNECTOR_IMAGING_CAP_CAN_PREMULTIPLIED_ALPHA, oyCONNECTOR_IMAGING_CAP_CAN_REVERT, oyCONNECTOR_IMAGING_CAP_CAN_SUBPIXEL, oyCONNECTOR_IMAGING_CAP_CAN_SWAP, oyCONNECTOR_IMAGING_CAP_CAN_SWAP_BYTES, oyCONNECTOR_IMAGING_CAP_ID, oyCONNECTOR_IMAGING_CAP_IS_PLUG, oyCONNECTOR_IMAGING_CAP_MAX_CHANNELS_COUNT, oyCONNECTOR_IMAGING_CAP_MAX_COLOR_COUNT, oyCONNECTOR_IMAGING_CAP_MAX_COLOR_OFFSET, oyCONNECTOR_IMAGING_CAP_MIN_CHANNELS_COUNT, oyCONNECTOR_IMAGING_CAP_MIN_COLOR_COUNT, and oyOBJECT_CONNECTOR_IMAGING_S.
| OYAPI int OYEXPORT oyConnectorImaging_GetChannelTypes | ( | oyConnectorImaging_s * | c, |
| const oyCHANNELTYPE_e ** | channel_types, | ||
| int * | channel_types_n | ||
| ) |
Get capabilities of oyConnectorImaging_s.
Function oyConnectorImaging_GetChannelTypes
References oyOBJECT_CONNECTOR_IMAGING_S.
| OYAPI int OYEXPORT oyConnectorImaging_GetDataTypes | ( | oyConnectorImaging_s * | c, |
| const oyDATATYPE_e ** | data_types, | ||
| int * | data_types_n | ||
| ) |
Get capabilities of oyConnectorImaging_s.
Function oyConnectorImaging_GetDataTypes
References oyOBJECT_CONNECTOR_IMAGING_S.
| oyCMMFilterSocket_MatchPlug_f oyConnectorImaging_GetMatch | ( | oyConnectorImaging_s * | obj | ) |
Set this connectors type check function.
Function oyConnectorImaging_GetMatch
This is use as a check, if connections are possible. This allowes for a more fine grained control than the type registration.
| [in] | obj | ConnectorImaging object |
References oyOBJECT_CONNECTOR_S.
| const char * oyConnectorImaging_GetReg | ( | oyConnectorImaging_s * | obj | ) |
Get the registration for the connection type.
Function oyConnectorImaging_GetReg
This is use as a rough check, if connections are possible.
| [in] | obj | ConnectorImaging object |
References oyOBJECT_CONNECTOR_S.
| OYAPI const char *OYEXPORT oyConnectorImaging_GetText | ( | oyConnectorImaging_s * | obj, |
| const char * | name_class, | ||
| oyNAME_e | type | ||
| ) |
get the names in a connector
Function oyConnectorImaging_GetText
Get UI strings.
| [in] | obj | ConnectorImaging object |
| [in] | name_class | the names class, e.g. "name", "help" ... |
| [in] | type | the names type |
References oyOBJECT_CONNECTOR_S.
| OYAPI const char **OYEXPORT oyConnectorImaging_GetTexts | ( | oyConnectorImaging_s * | obj | ) |
get the text classes in a connector
Function oyConnectorImaging_GetTexts
Set UI strings.
| [in] | obj | ConnectorImaging object |
References oyOBJECT_CONNECTOR_S.
| int oyConnectorImaging_IsPlug | ( | oyConnectorImaging_s * | obj | ) |
Is this connector a plug or a socket.
Function oyConnectorImaging_IsPlug
| [in] | obj | ConnectorImaging object |
References oyOBJECT_CONNECTOR_S.
| OYAPI oyConnectorImaging_s *OYEXPORT oyConnectorImaging_New | ( | oyObject_s | object | ) |
allocate a new ConnectorImaging object
Function oyConnectorImaging_New
References oyOBJECT_OBJECT_S.
| OYAPI int OYEXPORT oyConnectorImaging_Release | ( | oyConnectorImaging_s ** | connectorimaging | ) |
release and possibly deallocate a oyConnectorImaging_s object
Function oyConnectorImaging_Release
| [in,out] | connectorimaging | ConnectorImaging struct object |
References oyOBJECT_CONNECTOR_IMAGING_S.
| OYAPI int OYEXPORT oyConnectorImaging_SetCapability | ( | oyConnectorImaging_s * | c, |
| oyCONNECTOR_IMAGING_CAP_e | type, | ||
| int | value | ||
| ) |
Set capabilities of oyConnectorImaging_s.
Function oyConnectorImaging_SetCapability
References oyCONNECTOR_IMAGING_CAP_CAN_INTERWOVEN, oyCONNECTOR_IMAGING_CAP_CAN_NONPREMULTIPLIED_ALPHA, oyCONNECTOR_IMAGING_CAP_CAN_PLANAR, oyCONNECTOR_IMAGING_CAP_CAN_PREMULTIPLIED_ALPHA, oyCONNECTOR_IMAGING_CAP_CAN_REVERT, oyCONNECTOR_IMAGING_CAP_CAN_SUBPIXEL, oyCONNECTOR_IMAGING_CAP_CAN_SWAP, oyCONNECTOR_IMAGING_CAP_CAN_SWAP_BYTES, oyCONNECTOR_IMAGING_CAP_ID, oyCONNECTOR_IMAGING_CAP_IS_PLUG, oyCONNECTOR_IMAGING_CAP_MAX_CHANNELS_COUNT, oyCONNECTOR_IMAGING_CAP_MAX_COLOR_COUNT, oyCONNECTOR_IMAGING_CAP_MAX_COLOR_OFFSET, oyCONNECTOR_IMAGING_CAP_MIN_CHANNELS_COUNT, oyCONNECTOR_IMAGING_CAP_MIN_COLOR_COUNT, and oyOBJECT_CONNECTOR_IMAGING_S.
| OYAPI int OYEXPORT oyConnectorImaging_SetDataTypes | ( | oyConnectorImaging_s * | c, |
| oyDATATYPE_e * | data_types, | ||
| int | data_types_n | ||
| ) |
Set data types capability of oyConnectorImaging_s.
Function oyConnectorImaging_SetDataTypes
| c | the image connector |
| data_types | array of supported data types, const |
| data_types_n | number of elements in data_types |
References oyOBJECT_CONNECTOR_IMAGING_S.
| int oyConnectorImaging_SetIsPlug | ( | oyConnectorImaging_s * | obj, |
| int | is_plug | ||
| ) |
Set this connector as a plug or a socket.
Function oyConnectorImaging_SetIsPlug
| [in,out] | obj | ConnectorImaging object |
| [in] | is_plug | boolean; 0 - socket; 1 - plug |
References oyOBJECT_CONNECTOR_S.
| int oyConnectorImaging_SetMatch | ( | oyConnectorImaging_s * | obj, |
| oyCMMFilterSocket_MatchPlug_f | func | ||
| ) |
Set this connectors type check function.
Function oyConnectorImaging_SetMatch
This is use as a check, if connections are possible. This allowes for a more fine grained control than the type registration.
| [in,out] | obj | ConnectorImaging object |
| [in] | func | the check function |
References oyOBJECT_CONNECTOR_S.
| int oyConnectorImaging_SetReg | ( | oyConnectorImaging_s * | obj, |
| const char * | type_registration | ||
| ) |
Set this connectors type string.
Function oyConnectorImaging_SetReg
This is use as a rough check, if connections are possible.
| [in,out] | obj | ConnectorImaging object |
| [in] | type_registration | the registration string to describe the type |
References oyOBJECT_CONNECTOR_S.
| OYAPI int OYEXPORT oyConnectorImaging_SetTexts | ( | oyConnectorImaging_s * | obj, |
| oyCMMGetText_f | getText, | ||
| const char ** | text_classes | ||
| ) |
set the texts in a connector
Function oyConnectorImaging_SetTexts
Set UI strings.
| [in] | obj | ConnectorImaging object |
| [in] | getText | the name function |
| [in] | text_classes | zero terminated list of classes, e.g. {"name",NULL} owned by the user, but has to live the lifetime of the object |
References oyOBJECT_CONNECTOR_S.
| oyStruct_Copy_f oyConnectorImaging_s::copy |
Copy function.
| oyObject_s oyConnectorImaging_s::oy_ |
Oyranos internal object.
Features name and hash. Do not change during object life time.
| oyStruct_Release_f oyConnectorImaging_s::release |
Release function.
| const oyOBJECT_e oyConnectorImaging_s::type_ |
Type of object.
The struct type tells Oyranos how to interprete hidden fields.
Generated for Oyranos-0.9.6 by
1.8.1.2
Copyright © 2004-2016 Kai-Uwe Behrmann and others.
All Rights Reserved.