<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>Oyranos: oyFilterNode_s Struct Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css">
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.9 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="classes.html"><span>Data Structure Index</span></a></li>
<li><a href="functions.html"><span>Data Fields</span></a></li>
</ul>
</div>
</div>
<div class="contents">
<h1>oyFilterNode_s Struct Reference<br>
<small>
[<a class="el" href="group__objects__conversion.html">Conversion API's</a>]</small>
</h1><!-- doxytag: class="oyFilterNode_s" -->a FilterNode object<p>
Filter nodes chain filters into a <a class="el" href="structoyConversion__s.html" title="a filter chain or graph to manipulate a imageOrder of filters matters. The processing...">oyConversion_s</a> graph. The filter nodes use plugs and sockets for creating connections. Each plug can only connect to one socket.
<a href="#_details">More...</a>
<p>
<code>#include <oyranos_alpha.h></code>
<p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Data Fields</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__objects__generic.html#ga62ef859fd449252e08ccba088cf4f20">oyOBJECT_e</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structoyFilterNode__s.html#137cf69e98bc0dc9a158f0b2a58a3698">type_</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">oyStruct_Copy_f </td><td class="memItemRight" valign="bottom"><a class="el" href="structoyFilterNode__s.html#bfd5b7242eb9450cf70465c3f029df8f">copy</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">oyStruct_Release_f </td><td class="memItemRight" valign="bottom"><a class="el" href="structoyFilterNode__s.html#cc36cd6d934020b78e783574d49b84aa">release</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="structoyObject__s.html">oyObject_s</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structoyFilterNode__s.html#a7a592700903feb3cbc4a8833b14de0a">oy_</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="structoyFilterPlug__s.html">oyFilterPlug_s</a> ** </td><td class="memItemRight" valign="bottom"><a class="el" href="structoyFilterNode__s.html#7fd88b057b84fa9d00480b60cb4f1863">plugs</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="structoyFilterSocket__s.html">oyFilterSocket_s</a> ** </td><td class="memItemRight" valign="bottom"><a class="el" href="structoyFilterNode__s.html#4cec2ba127d639f274da400e20bad2a9">sockets</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="structoyFilter__s.html">oyFilter_s</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structoyFilterNode__s.html#0365e53c917dc2fc76c9eac3a7e9a2d1">filter</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="structoyFilterNode__s.html#16b3503f9894a3eb3d42b47ac118e26f">relatives_</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="structoyStruct__s.html">oyStruct_s</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structoyFilterNode__s.html#4a740144e2ddfaddf1b4739092e6955b">backend_data</a></td></tr>
<tr><td colspan="2"><br><h2>Related Functions</h2></td></tr>
<tr><td colspan="2">(Note that these are not member functions.) <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="structoyFilterNode__s.html">oyFilterNode_s</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__objects__conversion.html#g54deedc8bf1d1102cd5dc4d20eb50604">oyFilterNode_New</a> (<a class="el" href="structoyObject__s.html">oyObject_s</a> object)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">allocate and initialise a new filter node object <a href="group__objects__conversion.html#g54deedc8bf1d1102cd5dc4d20eb50604"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="structoyFilterNode__s.html">oyFilterNode_s</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__objects__conversion.html#ge704d22e52bc436e83efb7356ea6614d">oyFilterNode_Create</a> (<a class="el" href="structoyFilter__s.html">oyFilter_s</a> *<a class="el" href="structoyFilterNode__s.html#0365e53c917dc2fc76c9eac3a7e9a2d1">filter</a>, <a class="el" href="structoyObject__s.html">oyObject_s</a> object)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">initialise a new filter node object properly <a href="group__objects__conversion.html#ge704d22e52bc436e83efb7356ea6614d"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="structoyFilterNode__s.html">oyFilterNode_s</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__objects__conversion.html#g8311084339325255e9b943def0d54a7d">oyFilterNode_Copy</a> (<a class="el" href="structoyFilterNode__s.html">oyFilterNode_s</a> *node, <a class="el" href="structoyObject__s.html">oyObject_s</a> object)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">copy or reference a filter node object <a href="group__objects__conversion.html#g8311084339325255e9b943def0d54a7d"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__objects__conversion.html#gfd20546d21e6e367364e17f18015e01e">oyFilterNode_Release</a> (<a class="el" href="structoyFilterNode__s.html">oyFilterNode_s</a> **obj)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">release and zero a filter node object <a href="group__objects__conversion.html#gfd20546d21e6e367364e17f18015e01e"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">OYAPI int OYEXPORT </td><td class="memItemRight" valign="bottom"><a class="el" href="group__objects__conversion.html#g680dab40eba72dfde7d9fca59c3583b3">oyFilterNode_ConnectorMatch</a> (<a class="el" href="structoyFilterNode__s.html">oyFilterNode_s</a> *node_first, int pos_first, <a class="el" href="structoyConnector__s.html">oyConnector_s</a> *connector_second)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">check if a connector match to a FilterNode <a href="group__objects__conversion.html#g680dab40eba72dfde7d9fca59c3583b3"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">OYAPI <a class="el" href="structoyFilterSocket__s.html">oyFilterSocket_s</a> *OYEXPORT </td><td class="memItemRight" valign="bottom"><a class="el" href="group__objects__conversion.html#g028b3479e05ce0919382f051994393ed">oyFilterNode_GetSocket</a> (<a class="el" href="structoyFilterNode__s.html">oyFilterNode_s</a> *node, int pos)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">get a <a class="el" href="structoyFilterSocket__s.html" title="a filter connection structureThe passive output version of a oyConnector_s.">oyFilterSocket_s</a> of type from a FilterNode <a href="group__objects__conversion.html#g028b3479e05ce0919382f051994393ed"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">OYAPI <a class="el" href="structoyFilterPlug__s.html">oyFilterPlug_s</a> *OYEXPORT </td><td class="memItemRight" valign="bottom"><a class="el" href="group__objects__conversion.html#geeb96a27f7af2a5d4450323308e4e68f">oyFilterNode_GetPlug</a> (<a class="el" href="structoyFilterNode__s.html">oyFilterNode_s</a> *node, int pos)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">get a <a class="el" href="structoyFilterPlug__s.html" title="a filter connection structureThe active input version of a oyConnector_s. Each plug...">oyFilterPlug_s</a> of type from a FilterNode <a href="group__objects__conversion.html#geeb96a27f7af2a5d4450323308e4e68f"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__objects__conversion.html#g7aa48e301189cf165ab86516a24a296e">oyFilterNode_GetText</a> (<a class="el" href="structoyFilterNode__s.html">oyFilterNode_s</a> *node, <a class="el" href="group__objects__generic.html#g843f8ac2692fc9726f7152966fea1f6f">oyNAME_e</a> name_type)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">serialise filter node to text <a href="group__objects__conversion.html#g7aa48e301189cf165ab86516a24a296e"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">oyPointer </td><td class="memItemRight" valign="bottom"><a class="el" href="group__objects__conversion.html#gaa5977c97cd054b4ebe9739e63cdb737">oyFilterNode_TextToInfo</a> (<a class="el" href="structoyFilterNode__s.html">oyFilterNode_s</a> *node, size_t *size, <a class="el" href="oyranos_8h.html#c8c6790602510b0b1cdfb5d0c06f99c9">oyAlloc_f</a> allocateFunc)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">serialise filter node to binary <a href="group__objects__conversion.html#gaa5977c97cd054b4ebe9739e63cdb737"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
a FilterNode object<p>
Filter nodes chain filters into a <a class="el" href="structoyConversion__s.html" title="a filter chain or graph to manipulate a imageOrder of filters matters. The processing...">oyConversion_s</a> graph. The filter nodes use plugs and sockets for creating connections. Each plug can only connect to one socket.
<p>
<div align="center">
<img src="inline_dotgraph_11.dot.png" alt="inline_dotgraph_11.dot" border="0" usemap="#inline_dotgraph_11.dot.map">
<map name="inline_dotgraph_11.dot.map"></map>
</div>
<p>
This object provides support for separation of options from chaining. So it will be possible to implement options changing, which can affect the same filter instance in different graphs.<p>
A <a class="el" href="structoyFilterNode__s.html" title="a FilterNode objectFilter nodes chain filters into a oyConversion_s graph. The filter...">oyFilterNode_s</a> can have various <a class="el" href="structoyFilterPlug__s.html" title="a filter connection structureThe active input version of a oyConnector_s. Each plug...">oyFilterPlug_s</a> ' to obtain data from different sources. The required number is described in the oyCMMapi4_s structure, which is part of <a class="el" href="structoyFilter__s.html" title="a filter to manipulate a imageThis is the Oyranos filter object. Filters are categorised...">oyFilter_s</a>. <div align="center">
<img src="inline_dotgraph_12.dot.png" alt="inline_dotgraph_12.dot" border="0" usemap="#inline_dotgraph_12.dot.map">
<map name="inline_dotgraph_12.dot.map"></map>
</div>
<p>
<a class="el" href="structoyFilterSocket__s.html" title="a filter connection structureThe passive output version of a oyConnector_s.">oyFilterSocket_s</a> is designed to accept arbitrary numbers of connections to allow for viewing on a filters data output or observe its state changes. <div align="center">
<img src="inline_dotgraph_13.dot.png" alt="inline_dotgraph_13.dot" border="0" usemap="#inline_dotgraph_13.dot.map">
<map name="inline_dotgraph_13.dot.map"></map>
</div>
<p>
<dl class="version" compact><dt><b>Version:</b></dt><dd>Oyranos: 0.1.8 </dd></dl>
<dl class="since" compact><dt><b>Since:</b></dt><dd>2008/07/08 (Oyranos: 0.1.8) </dd></dl>
<dl class="date" compact><dt><b>Date:</b></dt><dd>2008/07/10 </dd></dl>
<hr><h2>Field Documentation</h2>
<a class="anchor" name="4a740144e2ddfaddf1b4739092e6955b"></a><!-- doxytag: member="oyFilterNode_s::backend_data" ref="4a740144e2ddfaddf1b4739092e6955b" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structoyStruct__s.html">oyStruct_s</a>* <a class="el" href="structoyFilterNode__s.html#4a740144e2ddfaddf1b4739092e6955b">oyFilterNode_s::backend_data</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
the filters private data, requested over oyCMMapi4_s::oyCMMFilterNode_CreateContext() and cached through Oyranos
</div>
</div><p>
<a class="anchor" name="bfd5b7242eb9450cf70465c3f029df8f"></a><!-- doxytag: member="oyFilterNode_s::copy" ref="bfd5b7242eb9450cf70465c3f029df8f" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">oyStruct_Copy_f <a class="el" href="structoyFilterNode__s.html#bfd5b7242eb9450cf70465c3f029df8f">oyFilterNode_s::copy</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
copy function
</div>
</div><p>
<a class="anchor" name="0365e53c917dc2fc76c9eac3a7e9a2d1"></a><!-- doxytag: member="oyFilterNode_s::filter" ref="0365e53c917dc2fc76c9eac3a7e9a2d1" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structoyFilter__s.html">oyFilter_s</a>* <a class="el" href="structoyFilterNode__s.html#0365e53c917dc2fc76c9eac3a7e9a2d1">oyFilterNode_s::filter</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
the filter
<p>Referenced by <a class="el" href="oyranos__alpha_8c_source.html#l15207">oyConversion_s::oyConversion_FilterAdd()</a>, <a class="el" href="oyranos__alpha_8c_source.html#l15414">oyConversion_s::oyConversion_GetOnePixel()</a>, <a class="el" href="oyranos__alpha_8c_source.html#l15312">oyConversion_s::oyConversion_OutputAdd()</a>, <a class="el" href="oyranos__alpha_8c_source.html#l15370">oyConversion_s::oyConversion_Run()</a>, <a class="el" href="oyranos__alpha_8c_source.html#l13241">oyFilterNode_ConnectorMatch()</a>, <a class="el" href="oyranos__alpha_8c_source.html#l13060">oyFilterNode_Create()</a>, <a class="el" href="oyranos__alpha_8c_source.html#l13397">oyFilterNode_GetPlug()</a>, <a class="el" href="oyranos__alpha_8c_source.html#l13349">oyFilterNode_GetSocket()</a>, <a class="el" href="oyranos__alpha_8c_source.html#l13448">oyFilterNode_GetText()</a>, and <a class="el" href="oyranos__alpha_8c_source.html#l13178">oyFilterNode_Release()</a>.</p>
</div>
</div><p>
<a class="anchor" name="a7a592700903feb3cbc4a8833b14de0a"></a><!-- doxytag: member="oyFilterNode_s::oy_" ref="a7a592700903feb3cbc4a8833b14de0a" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structoyObject__s.html">oyObject_s</a> <a class="el" href="structoyFilterNode__s.html#a7a592700903feb3cbc4a8833b14de0a">oyFilterNode_s::oy_</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
base object
<p>Referenced by <a class="el" href="oyranos__alpha_8c_source.html#l13149">oyFilterNode_Copy()</a>, <a class="el" href="oyranos__alpha_8c_source.html#l13060">oyFilterNode_Create()</a>, <a class="el" href="oyranos__alpha_8c_source.html#l13397">oyFilterNode_GetPlug()</a>, <a class="el" href="oyranos__alpha_8c_source.html#l13349">oyFilterNode_GetSocket()</a>, <a class="el" href="oyranos__alpha_8c_source.html#l13448">oyFilterNode_GetText()</a>, and <a class="el" href="oyranos__alpha_8c_source.html#l13178">oyFilterNode_Release()</a>.</p>
</div>
</div><p>
<a class="anchor" name="7fd88b057b84fa9d00480b60cb4f1863"></a><!-- doxytag: member="oyFilterNode_s::plugs" ref="7fd88b057b84fa9d00480b60cb4f1863" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structoyFilterPlug__s.html">oyFilterPlug_s</a>** <a class="el" href="structoyFilterNode__s.html#7fd88b057b84fa9d00480b60cb4f1863">oyFilterNode_s::plugs</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
active input connectors, list ends with a trailing zero
<p>Referenced by <a class="el" href="oyranos__alpha_8c_source.html#l15370">oyConversion_s::oyConversion_Run()</a>, <a class="el" href="oyranos__alpha_8c_source.html#l13060">oyFilterNode_Create()</a>, <a class="el" href="oyranos__alpha_8c_source.html#l13397">oyFilterNode_GetPlug()</a>, and <a class="el" href="oyranos__alpha_8c_source.html#l13178">oyFilterNode_Release()</a>.</p>
</div>
</div><p>
<a class="anchor" name="16b3503f9894a3eb3d42b47ac118e26f"></a><!-- doxytag: member="oyFilterNode_s::relatives_" ref="16b3503f9894a3eb3d42b47ac118e26f" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char* <a class="el" href="structoyFilterNode__s.html#16b3503f9894a3eb3d42b47ac118e26f">oyFilterNode_s::relatives_</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
hint about belonging to a filter
<p>Referenced by <a class="el" href="oyranos__alpha_8c_source.html#l13060">oyFilterNode_Create()</a>, <a class="el" href="oyranos__alpha_8c_source.html#l13397">oyFilterNode_GetPlug()</a>, <a class="el" href="oyranos__alpha_8c_source.html#l13349">oyFilterNode_GetSocket()</a>, and <a class="el" href="oyranos__alpha_8c_source.html#l13178">oyFilterNode_Release()</a>.</p>
</div>
</div><p>
<a class="anchor" name="cc36cd6d934020b78e783574d49b84aa"></a><!-- doxytag: member="oyFilterNode_s::release" ref="cc36cd6d934020b78e783574d49b84aa" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">oyStruct_Release_f <a class="el" href="structoyFilterNode__s.html#cc36cd6d934020b78e783574d49b84aa">oyFilterNode_s::release</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
release function
<p>Referenced by <a class="el" href="oyranos__alpha_8c_source.html#l13009">oyFilterNode_New()</a>.</p>
</div>
</div><p>
<a class="anchor" name="4cec2ba127d639f274da400e20bad2a9"></a><!-- doxytag: member="oyFilterNode_s::sockets" ref="4cec2ba127d639f274da400e20bad2a9" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structoyFilterSocket__s.html">oyFilterSocket_s</a>** <a class="el" href="structoyFilterNode__s.html#4cec2ba127d639f274da400e20bad2a9">oyFilterNode_s::sockets</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
active output connectors, list ends with a trailing zero
<p>Referenced by <a class="el" href="oyranos__alpha_8c_source.html#l15414">oyConversion_s::oyConversion_GetOnePixel()</a>, <a class="el" href="oyranos__alpha_8c_source.html#l13060">oyFilterNode_Create()</a>, <a class="el" href="oyranos__alpha_8c_source.html#l13349">oyFilterNode_GetSocket()</a>, and <a class="el" href="oyranos__alpha_8c_source.html#l13178">oyFilterNode_Release()</a>.</p>
</div>
</div><p>
<a class="anchor" name="137cf69e98bc0dc9a158f0b2a58a3698"></a><!-- doxytag: member="oyFilterNode_s::type_" ref="137cf69e98bc0dc9a158f0b2a58a3698" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__objects__generic.html#ga62ef859fd449252e08ccba088cf4f20">oyOBJECT_e</a> <a class="el" href="structoyFilterNode__s.html#137cf69e98bc0dc9a158f0b2a58a3698">oyFilterNode_s::type_</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
struct type oyOBJECT_FILTER_NODE_S
<p>Referenced by <a class="el" href="oyranos__alpha_8c_source.html#l13241">oyFilterNode_ConnectorMatch()</a>, <a class="el" href="oyranos__alpha_8c_source.html#l13397">oyFilterNode_GetPlug()</a>, <a class="el" href="oyranos__alpha_8c_source.html#l13349">oyFilterNode_GetSocket()</a>, and <a class="el" href="oyranos__alpha_8c_source.html#l13178">oyFilterNode_Release()</a>.</p>
</div>
</div><p>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Mon Jul 27 04:18:00 2009 for Oyranos by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address>
</body>
</html>
