<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>frei0r: f0r_plugin_info Struct Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.4.6 -->
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li id="current"><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="dirs.html"><span>Directories</span></a></li>
</ul></div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Data Fields</span></a></li>
</ul></div>
<h1>f0r_plugin_info Struct Reference</h1><!-- doxytag: class="f0r_plugin_info" --><code>#include <<a class="el" href="frei0r_8h-source.html">frei0r.h</a>></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">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="structf0r__plugin__info.html#6e9916e14a3871987c66964a89b18c5d">name</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="structf0r__plugin__info.html#c6ad807a9ac439e57e7410dd699add6f">author</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structf0r__plugin__info.html#e57fd00690e5f90609120cff276c3ead">plugin_type</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structf0r__plugin__info.html#0b1238f47fe6600243e500446568bb4e">color_model</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structf0r__plugin__info.html#ac89e4129172023e153c952259373149">frei0r_version</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structf0r__plugin__info.html#87ea44cd95f93b3c367d3dcec556deb3">major_version</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structf0r__plugin__info.html#bfa71a212ece4e0af3d4a8c3f4fa55ca">minor_version</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structf0r__plugin__info.html#92cf99cadc76b90d2ac908e367c2c92f">num_params</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="structf0r__plugin__info.html#9df1154eb490f9ba53bcbd4800a8cc3e">explanation</a></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
The f0r_plugin_info_t structure is filled in by the plugin to tell the application about its name, type, number of parameters, and version.<p>
An application should ignore (i.e. not use) frei0r effects that have unknown values in the plugin_type or color_model field. It should also ignore effects with a too high frei0r_version.<p>
This is necessary to be able to extend the frei0r spec (e.g. by adding new color models or plugin types) in a way that does not result in crashes when loading effects that make use of these extensions into an older application.<p>
All strings are unicode, 0-terminated, and the encoding is utf-8.
<p>
<hr><h2>Field Documentation</h2>
<a class="anchor" name="c6ad807a9ac439e57e7410dd699add6f"></a><!-- doxytag: member="f0r_plugin_info::author" ref="c6ad807a9ac439e57e7410dd699add6f" args="" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">const char* <a class="el" href="structf0r__plugin__info.html#c6ad807a9ac439e57e7410dd699add6f">f0r_plugin_info::author</a> </td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
The plugin author </td>
</tr>
</table>
<a class="anchor" name="0b1238f47fe6600243e500446568bb4e"></a><!-- doxytag: member="f0r_plugin_info::color_model" ref="0b1238f47fe6600243e500446568bb4e" args="" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">int <a class="el" href="structf0r__plugin__info.html#0b1238f47fe6600243e500446568bb4e">f0r_plugin_info::color_model</a> </td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
The color model used </td>
</tr>
</table>
<a class="anchor" name="9df1154eb490f9ba53bcbd4800a8cc3e"></a><!-- doxytag: member="f0r_plugin_info::explanation" ref="9df1154eb490f9ba53bcbd4800a8cc3e" args="" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">const char* <a class="el" href="structf0r__plugin__info.html#9df1154eb490f9ba53bcbd4800a8cc3e">f0r_plugin_info::explanation</a> </td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
An optional explanation string </td>
</tr>
</table>
<a class="anchor" name="ac89e4129172023e153c952259373149"></a><!-- doxytag: member="f0r_plugin_info::frei0r_version" ref="ac89e4129172023e153c952259373149" args="" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">int <a class="el" href="structf0r__plugin__info.html#ac89e4129172023e153c952259373149">f0r_plugin_info::frei0r_version</a> </td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
The frei0r major version this plugin is built for </td>
</tr>
</table>
<a class="anchor" name="87ea44cd95f93b3c367d3dcec556deb3"></a><!-- doxytag: member="f0r_plugin_info::major_version" ref="87ea44cd95f93b3c367d3dcec556deb3" args="" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">int <a class="el" href="structf0r__plugin__info.html#87ea44cd95f93b3c367d3dcec556deb3">f0r_plugin_info::major_version</a> </td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
The major version of the plugin </td>
</tr>
</table>
<a class="anchor" name="bfa71a212ece4e0af3d4a8c3f4fa55ca"></a><!-- doxytag: member="f0r_plugin_info::minor_version" ref="bfa71a212ece4e0af3d4a8c3f4fa55ca" args="" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">int <a class="el" href="structf0r__plugin__info.html#bfa71a212ece4e0af3d4a8c3f4fa55ca">f0r_plugin_info::minor_version</a> </td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
The minor version of the plugin </td>
</tr>
</table>
<a class="anchor" name="6e9916e14a3871987c66964a89b18c5d"></a><!-- doxytag: member="f0r_plugin_info::name" ref="6e9916e14a3871987c66964a89b18c5d" args="" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">const char* <a class="el" href="structf0r__plugin__info.html#6e9916e14a3871987c66964a89b18c5d">f0r_plugin_info::name</a> </td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
The (short) name of the plugin </td>
</tr>
</table>
<a class="anchor" name="92cf99cadc76b90d2ac908e367c2c92f"></a><!-- doxytag: member="f0r_plugin_info::num_params" ref="92cf99cadc76b90d2ac908e367c2c92f" args="" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">int <a class="el" href="structf0r__plugin__info.html#92cf99cadc76b90d2ac908e367c2c92f">f0r_plugin_info::num_params</a> </td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
The number of parameters of the plugin </td>
</tr>
</table>
<a class="anchor" name="e57fd00690e5f90609120cff276c3ead"></a><!-- doxytag: member="f0r_plugin_info::plugin_type" ref="e57fd00690e5f90609120cff276c3ead" args="" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">int <a class="el" href="structf0r__plugin__info.html#e57fd00690e5f90609120cff276c3ead">f0r_plugin_info::plugin_type</a> </td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
The plugin type <dl compact><dt><b>See also:</b></dt><dd><a class="el" href="group__PLUGIN__TYPE.html">Type of the Plugin</a> </dd></dl>
</td>
</tr>
</table>
<hr>The documentation for this struct was generated from the following file:<ul>
<li>include/<a class="el" href="frei0r_8h-source.html">frei0r.h</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Wed Nov 7 12:07:53 2007 for frei0r by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6 </small></address>
</body>
</html>
