/usr/share/doc/lvtk-doc/html/index.html is in lvtk-doc 1.2.0~dfsg0-2.
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 | <!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.11"/>
<title>LV2 Toolkit: LV2 Toolkit</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="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { init_search(); });
</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 id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">LV2 Toolkit
 <span id="projectnumber">1.2.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.11 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li class="current"><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="annotated.html"><span>Classes</span></a></li>
<li><a href="examples.html"><span>Examples</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
</div><!-- top -->
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="headertitle">
<div class="title">LV2 Toolkit </div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><h1><a class="anchor" id="intro"></a>
Introduction</h1>
<p>These documents describe some C++ classes that may be of use if you want to write LV2 plugins in C++. They implement most of the boilerplate code so you only have to write the parts that matter, and hide the low-level C API.</p>
<p><b>Libraries</b> The classes are separated into two libraries. One, called liblvtk-plugin, contains the classes Plugin and Synth, defined in the files <<a class="el" href="plugin_8hpp_source.html">lvtk/plugin.hpp</a>> and <<a class="el" href="synth_8hpp_source.html">lvtk/synth.hpp</a>>. They are base classes that you can inherit in order to create new LV2 plugins. The other library, called liblvtk-ui, contains the class UI, defined in the file <<a class="el" href="ui_8hpp_source.html">lvtk/ui.hpp</a>> which you can use in a similar way to create new LV2 plugin UIs.</p>
<p><b>Packages</b> There are a few included pkg-config packages to choose from when writing a plugins and UIs. Below is a list of all packages included and what they are for.</p>
<ul>
<li><b>lvtk-plugin</b> - Use when writing an LV2 plugin</li>
<li><b>lvtk-ui</b> - Use if NOT using a <a class="el" href="group__toolkitmixins.html">Toolkit Mixin</a></li>
<li><b>lvtk-gtkui</b> - Use if using the GtkUI <a class="el" href="group__toolkitmixins.html">Toolkit Mixin</a></li>
</ul>
<p>In summary, there is one package for a plugin and one for each type of supported UI. Each UI package includes the same static library plus dependencies of its cooresponding toolkit.</p>
<p><b>Mixins</b> For both the plugin and the GUI class there are other helper classes called <a class="el" href="group__pluginmixins.html">mixins</a> that you can use to add extra functionality to your plugins, for example support for LV2 extensions.</p>
<p><b>Versioning</b> These libraries are only available as static libraries (and most of the code is template classes in header files), thus ABI stability is not an issue. The API will be stable between major version bumps, at which the pkg-config name would change to prevent plugins from building against an incompatible version.</p>
<dl class="section author"><dt>Author</dt><dd>Lars Luthman <a href="#" onclick="location.href='mai'+'lto:'+'lar'+'s.'+'lut'+'hm'+'an@'+'gm'+'ail'+'.c'+'om'; return false;">lars.<span style="display: none;">.nosp@m.</span>luth<span style="display: none;">.nosp@m.</span>man@g<span style="display: none;">.nosp@m.</span>mail<span style="display: none;">.nosp@m.</span>.com</a> </dd>
<dd>
Michael Fisher <a href="#" onclick="location.href='mai'+'lto:'+'mfi'+'sh'+'er3'+'1@'+'gma'+'il'+'.co'+'m'; return false;">mfish<span style="display: none;">.nosp@m.</span>er31<span style="display: none;">.nosp@m.</span>@gmai<span style="display: none;">.nosp@m.</span>l.co<span style="display: none;">.nosp@m.</span>m</a> </dd></dl>
</div></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Aug 31 2016 15:25:44 for LV2 Toolkit by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.11
</small></address>
</body>
</html>
|