Files
frei0r/frei0r-autoconf/doc/html/group__icons.html
2007-10-30 22:56:25 +00:00

42 lines
2.7 KiB
HTML

<!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: Icons for frei0r effects</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&nbsp;Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Data&nbsp;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>
<h1>Icons for frei0r effects</h1><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
</table>
<h2><a class="anchor" name="sec_icons">
Icons for frei0r effects</a></h2>
Each frei0r effect can have an associated icon.<h3><a class="anchor" name="sec_icon_format">
Icon Format</a></h3>
The format of frei0r icons must be png. Recommended resolution is 64x64. The icon filename of an effect with effect name "frei0r" must be "frei0r.png".<h3><a class="anchor" name="sec_icon_location">
Icon location</a></h3>
The exact location where the application should look for the plugin is platform dependant.<p>
For Windows platforms, the icon should be at the same place as the plugin containing the effect.<p>
For Unix platforms, the following mapping from plugin location to icon location must be used:<p>
Let &lt;plugin_path&gt;/&lt;plugin&gt; be a frei0r plugin with name &lt;effect_name&gt;. Then the corresponding icon (if any) shall be located in &lt;icon_path&gt;/&lt;effect_name&gt;.png. &lt;icon_path&gt; can be obtained in the following way:<p>
<div class="fragment"><pre class="fragment"> &lt;plugin_path&gt; | &lt;icon_path&gt;
----------------------------------------------------------------------------
$HOME/.frei0r-1/lib/&lt;vendor&gt; | $HOME/.frei0r-1/icons/&lt;vendor&gt;
/usr/local/lib/frei0r-1/&lt;vendor&gt; | /usr/local/share/frei0r-1/icons/&lt;vendor&gt;
/usr/lib/frei0r-1/&lt;vendor&gt; | /usr/share/frei0r-1/icons/&lt;vendor&gt;
* | &lt;plugin_path&gt;
</pre></div><p>
(The wildcard '*' stands for any other plugin_path)<p>
For other platforms, no location is defined. We recommend to use the plugin path where possible. <hr size="1"><address style="align: right;"><small>Generated on Wed Nov 7 12:07:53 2007 for frei0r by&nbsp;
<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>