Data Structures

Here are the data structures with brief descriptions:
oyArray2d_s2d data array

oyArray2d_s is a in memory data view. The array2d holds pointers to lines in the original memory blob. The arrays contained in array2d represent the samples. There is no information in which order the samples appear. No pixel layout or meaning is provided. Given the coordinates x and y, a samples memory adress can be accessed by &array2d[y][x] . This adress must be converted to the data type provided in oyArray2d_s::t

oyCMMInfo_sCMM API resources struct to implement and set by a CMM

Given an example CMM with name "little cms", which wants to use the four-char ID 'lcms', the CMM can register itself to Oyranos as follows: The CMM module file must be named something_lcms_cmm_module_something.something . On Linux this could be "liboyranos_lcms_cmm_module.so.0.1.8". The four-chars 'lcms' must be prepended with OY_MODULE_NAME alias "_cmm_module"

oyColourConversion_s
oyConnector_sFilter connection description structure

This structure holds informations about the connection capabilities. It holds common structure members of oyFilterPlug_s and oyFilterSocket_s

oyConversion_sFilter chain or graph to manipulate a image

Order of filters matters. The processing direction is a bit like raytracing as nodes request their parent

oyFilter_sFilter to manipulate a image

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

oyFilterNode_sFilterNode object

Filter nodes chain filters into a oyConversion_s graph. The filter nodes use plugs and sockets for creating connections. Each plug can only connect to one socket

oyFilterPlug_sFilter connection structure

The active input version of a oyConnector_s. Each plug can connect to exact one socket

oyFilterPlugs_sFilterPlugs list
oyFilters_sFilters list
oyFilterSocket_sFilter connection structure

The passive output version of a oyConnector_s

oyIcon_sIcon data

Since: 0.1.8

oyImage_sReference struct to gather information for image transformation

as we dont target a complete imaging solution, only raster is supported

oyName_sOyranos name structure
oyNamedColour_sColour patch with meta informations

Data management on library side. User can control memory management at creation time

oyNamedColours_sList of colour patches

Data management on library side. User can control memory management at creation time

oyObject_sOyranos structure base

The base object of Oyranos object system is self contained. It can be handled by the belonging function set. Complex objects for user interaction should almost all be derived from this struct.
The memory management can be controlled by the user and will affect internal and derived data

oyOption_sOption for rendering
oyOptions_sGeneric Options

Options can be any flag or rendering intent and other informations needed to configure a process. The object contains a list of oyOption_s objects

oyPixelAccess_sControl pixel access order

A struct to control pixel access. It is a kind of flexible pixel iterator. The order or pattern of access is defined by the array_xy and start_[x,y] variables

oyProfile_sProfile and its attributes
oyProfiles_sTell about the conversion profiles
oyProfileTag_sProfile constituting element
oyRegion_sStart with a simple rectangle
oyStruct_sOyranos base structure

All Oyranos structures should be castable to this basic one

oyValue_uValue

Generated on Mon Jul 27 04:30:07 2009 for Oyranos by  doxygen 1.5.9