/usr/share/frei0r/html/structf0r__plugin__info.html is in frei0r-plugins-doc 1.4-3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.7"/>
<title>frei0r: f0r_plugin_info Struct Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">frei0r
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.7 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>Modules</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 id="navrow2" class="tabs2">
<ul class="tablist">
<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><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('structf0r__plugin__info.html','');});
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-attribs">Data Fields</a> </div>
<div class="headertitle">
<div class="title">f0r_plugin_info Struct Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include <<a class="el" href="frei0r_8h_source.html">frei0r.h</a>></code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr class="memitem:a6e9916e14a3871987c66964a89b18c5d"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="structf0r__plugin__info.html#a6e9916e14a3871987c66964a89b18c5d">name</a></td></tr>
<tr class="separator:a6e9916e14a3871987c66964a89b18c5d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac6ad807a9ac439e57e7410dd699add6f"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="structf0r__plugin__info.html#ac6ad807a9ac439e57e7410dd699add6f">author</a></td></tr>
<tr class="separator:ac6ad807a9ac439e57e7410dd699add6f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae57fd00690e5f90609120cff276c3ead"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structf0r__plugin__info.html#ae57fd00690e5f90609120cff276c3ead">plugin_type</a></td></tr>
<tr class="separator:ae57fd00690e5f90609120cff276c3ead"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0b1238f47fe6600243e500446568bb4e"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structf0r__plugin__info.html#a0b1238f47fe6600243e500446568bb4e">color_model</a></td></tr>
<tr class="separator:a0b1238f47fe6600243e500446568bb4e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aac89e4129172023e153c952259373149"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structf0r__plugin__info.html#aac89e4129172023e153c952259373149">frei0r_version</a></td></tr>
<tr class="separator:aac89e4129172023e153c952259373149"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a87ea44cd95f93b3c367d3dcec556deb3"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structf0r__plugin__info.html#a87ea44cd95f93b3c367d3dcec556deb3">major_version</a></td></tr>
<tr class="separator:a87ea44cd95f93b3c367d3dcec556deb3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abfa71a212ece4e0af3d4a8c3f4fa55ca"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structf0r__plugin__info.html#abfa71a212ece4e0af3d4a8c3f4fa55ca">minor_version</a></td></tr>
<tr class="separator:abfa71a212ece4e0af3d4a8c3f4fa55ca"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a92cf99cadc76b90d2ac908e367c2c92f"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structf0r__plugin__info.html#a92cf99cadc76b90d2ac908e367c2c92f">num_params</a></td></tr>
<tr class="separator:a92cf99cadc76b90d2ac908e367c2c92f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9df1154eb490f9ba53bcbd4800a8cc3e"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="structf0r__plugin__info.html#a9df1154eb490f9ba53bcbd4800a8cc3e">explanation</a></td></tr>
<tr class="separator:a9df1154eb490f9ba53bcbd4800a8cc3e"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>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>
<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>
<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>
<p>All strings are unicode, 0-terminated, and the encoding is utf-8. </p>
<p>Definition at line <a class="el" href="frei0r_8h_source.html#l00341">341</a> of file <a class="el" href="frei0r_8h_source.html">frei0r.h</a>.</p>
</div><h2 class="groupheader">Field Documentation</h2>
<a class="anchor" id="ac6ad807a9ac439e57e7410dd699add6f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* f0r_plugin_info::author</td>
</tr>
</table>
</div><div class="memdoc">
<p>The plugin author </p>
<p>Definition at line <a class="el" href="frei0r_8h_source.html#l00344">344</a> of file <a class="el" href="frei0r_8h_source.html">frei0r.h</a>.</p>
</div>
</div>
<a class="anchor" id="a0b1238f47fe6600243e500446568bb4e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int f0r_plugin_info::color_model</td>
</tr>
</table>
</div><div class="memdoc">
<p>The color model used </p>
<p>Definition at line <a class="el" href="frei0r_8h_source.html#l00349">349</a> of file <a class="el" href="frei0r_8h_source.html">frei0r.h</a>.</p>
</div>
</div>
<a class="anchor" id="a9df1154eb490f9ba53bcbd4800a8cc3e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* f0r_plugin_info::explanation</td>
</tr>
</table>
</div><div class="memdoc">
<p>An optional explanation string </p>
<p>Definition at line <a class="el" href="frei0r_8h_source.html#l00354">354</a> of file <a class="el" href="frei0r_8h_source.html">frei0r.h</a>.</p>
</div>
</div>
<a class="anchor" id="aac89e4129172023e153c952259373149"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int f0r_plugin_info::frei0r_version</td>
</tr>
</table>
</div><div class="memdoc">
<p>The frei0r major version this plugin is built for </p>
<p>Definition at line <a class="el" href="frei0r_8h_source.html#l00350">350</a> of file <a class="el" href="frei0r_8h_source.html">frei0r.h</a>.</p>
</div>
</div>
<a class="anchor" id="a87ea44cd95f93b3c367d3dcec556deb3"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int f0r_plugin_info::major_version</td>
</tr>
</table>
</div><div class="memdoc">
<p>The major version of the plugin </p>
<p>Definition at line <a class="el" href="frei0r_8h_source.html#l00351">351</a> of file <a class="el" href="frei0r_8h_source.html">frei0r.h</a>.</p>
</div>
</div>
<a class="anchor" id="abfa71a212ece4e0af3d4a8c3f4fa55ca"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int f0r_plugin_info::minor_version</td>
</tr>
</table>
</div><div class="memdoc">
<p>The minor version of the plugin </p>
<p>Definition at line <a class="el" href="frei0r_8h_source.html#l00352">352</a> of file <a class="el" href="frei0r_8h_source.html">frei0r.h</a>.</p>
</div>
</div>
<a class="anchor" id="a6e9916e14a3871987c66964a89b18c5d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* f0r_plugin_info::name</td>
</tr>
</table>
</div><div class="memdoc">
<p>The (short) name of the plugin </p>
<p>Definition at line <a class="el" href="frei0r_8h_source.html#l00343">343</a> of file <a class="el" href="frei0r_8h_source.html">frei0r.h</a>.</p>
</div>
</div>
<a class="anchor" id="a92cf99cadc76b90d2ac908e367c2c92f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int f0r_plugin_info::num_params</td>
</tr>
</table>
</div><div class="memdoc">
<p>The number of parameters of the plugin </p>
<p>Definition at line <a class="el" href="frei0r_8h_source.html#l00353">353</a> of file <a class="el" href="frei0r_8h_source.html">frei0r.h</a>.</p>
</div>
</div>
<a class="anchor" id="ae57fd00690e5f90609120cff276c3ead"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int f0r_plugin_info::plugin_type</td>
</tr>
</table>
</div><div class="memdoc">
<p>The plugin type </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="group___p_l_u_g_i_n___t_y_p_e.html">Type of the Plugin</a> </dd></dl>
<p>Definition at line <a class="el" href="frei0r_8h_source.html#l00348">348</a> of file <a class="el" href="frei0r_8h_source.html">frei0r.h</a>.</p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li><a class="el" href="frei0r_8h_source.html">frei0r.h</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="structf0r__plugin__info.html">f0r_plugin_info</a></li>
<li class="footer">Generated on Wed May 28 2014 08:33:23 for frei0r by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.7 </li>
</ul>
</div>
</body>
</html>
|