Initial release
This commit is contained in:
civ
@@ -0,0 +1,158 @@
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
|
||||
<meta name="generator" content="Doxygen 1.13.2"/>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
||||
<title>VST 3 Interfaces: Wayland Frame</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>
|
||||
<script type="text/javascript" src="clipboard.js"></script>
|
||||
<link href="navtree.css" rel="stylesheet" type="text/css"/>
|
||||
<script type="text/javascript" src="navtreedata.js"></script>
|
||||
<script type="text/javascript" src="navtree.js"></script>
|
||||
<script type="text/javascript" src="resize.js"></script>
|
||||
<script type="text/javascript" src="cookie.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>
|
||||
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
||||
<link href="smtg_extra.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 id="projectrow">
|
||||
<td id="projectalign">
|
||||
<div id="projectname">VST 3 Interfaces<span id="projectnumber"> VST 3.8</span>
|
||||
</div>
|
||||
<div id="projectbrief">SDK for developing VST plug-in</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<!-- end header part -->
|
||||
<!-- Generated by Doxygen 1.13.2 -->
|
||||
<script type="text/javascript">
|
||||
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
||||
var searchBox = new SearchBox("searchBox", "search/",'.html');
|
||||
/* @license-end */
|
||||
</script>
|
||||
<script type="text/javascript">
|
||||
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
||||
$(function() { codefold.init(0); });
|
||||
/* @license-end */
|
||||
</script>
|
||||
<script type="text/javascript" src="menudata.js"></script>
|
||||
<script type="text/javascript" src="menu.js"></script>
|
||||
<script type="text/javascript">
|
||||
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
||||
$(function() {
|
||||
initMenu('',true,false,'search.php','Search',true);
|
||||
$(function() { init_search(); });
|
||||
});
|
||||
/* @license-end */
|
||||
</script>
|
||||
<div id="main-nav"></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">
|
||||
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
||||
$(function(){initNavTree('group__waylandFrame.html',''); initResizable(true); });
|
||||
/* @license-end */
|
||||
</script>
|
||||
<div id="doc-content">
|
||||
<!-- 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">
|
||||
<div id="MSearchResults">
|
||||
<div class="SRPage">
|
||||
<div id="SRIndex">
|
||||
<div id="SRResults"></div>
|
||||
<div class="SRStatus" id="Loading">Loading...</div>
|
||||
<div class="SRStatus" id="Searching">Searching...</div>
|
||||
<div class="SRStatus" id="NoMatches">No Matches</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="header">
|
||||
<div class="summary">
|
||||
<a href="#nested-classes">Classes</a> </div>
|
||||
<div class="headertitle"><div class="title">Wayland Frame</div></div>
|
||||
</div><!--header-->
|
||||
<div class="contents">
|
||||
|
||||
<p>The following interfaces allow querying information about the host plug-in frame when running in a Wayland session.
|
||||
<a href="#details">More...</a></p>
|
||||
<div id="dynsection-0" onclick="return dynsection.toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
|
||||
<img id="dynsection-0-trigger" src="closed.png" alt="+"/> Collaboration diagram for Wayland Frame:</div>
|
||||
<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
|
||||
</div>
|
||||
<div id="dynsection-0-content" class="dyncontent" style="display:none;">
|
||||
<div class="center"><img src="group__waylandFrame.png" border="0" usemap="#agroup____waylandFrame" alt=""/></div>
|
||||
<map name="agroup____waylandFrame" id="agroup____waylandFrame">
|
||||
<area shape="rect" href="group__pluginGUI.html" title=" " alt="" coords="306,21,459,46"/>
|
||||
<area shape="rect" title="The following interfaces allow querying information about the host plug-in frame when running in a Wa..." alt="" coords="5,21,113,46"/>
|
||||
</map>
|
||||
</div>
|
||||
<table class="memberdecls">
|
||||
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
|
||||
Classes</h2></td></tr>
|
||||
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classSteinberg_1_1IWaylandHost.html">IWaylandHost</a></td></tr>
|
||||
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classSteinberg_1_1IWaylandHost.html" title="IWaylandHost: Wayland host interface Implemented as a singleton in the host application.">IWaylandHost</a>: Wayland host interface Implemented as a singleton in the host application. <a href="classSteinberg_1_1IWaylandHost.html#details">More...</a><br /></td></tr>
|
||||
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classSteinberg_1_1IWaylandFrame.html">IWaylandFrame</a></td></tr>
|
||||
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classSteinberg_1_1IWaylandFrame.html" title="IWaylandFrame interface Interface to query additional information about the host plug-in frame in a W...">IWaylandFrame</a> interface Interface to query additional information about the host plug-in frame in a Wayland session. <a href="classSteinberg_1_1IWaylandFrame.html#details">More...</a><br /></td></tr>
|
||||
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
</table>
|
||||
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
||||
<p>The following interfaces allow querying information about the host plug-in frame when running in a Wayland session. </p>
|
||||
<p>A native Wayland host application acts as both a Wayland client and a Wayland compositor. The host application connects to the system compositor and creates application windows etc. using this compositor connection.<br />
|
||||
A plug-in does not connect to the system compositor, but connects to the host application by calling <a class="el" href="classSteinberg_1_1IWaylandHost.html#aac1c5eb544d1edda1f83947f67f05648" title="Open a Wayland connection to the host.">IWaylandHost::openWaylandConnection()</a>.<br />
|
||||
The <a class="el" href="classSteinberg_1_1IWaylandHost.html" title="IWaylandHost: Wayland host interface Implemented as a singleton in the host application.">IWaylandHost</a> interface can be created via IHostApplication::createInstance. As the interface may be required early, the host should pass IHostApplication to the plug-in using <a class="elRef" href="../base/classSteinberg_1_1IPluginFactory3.html#a7fa0087a5cb612e3aeeefa4c91f638c7">IPluginFactory3::setHostContext</a>.<br />
|
||||
When opening a plug-in window, the host calls <a class="elRef" href="../base/classSteinberg_1_1IPlugView.html#a9fbc345c1e87f7e6210a8a49fdb96793">IPlugView::attached()</a> with the parent pointer set to the wl_surface of the parent frame (with an unknown surface role). The plug-in creates a wl_surface and must assign the wl_subsurface role using the given parent pointer.<br />
|
||||
The plug-in is responsible for resizing the subsurface accordingly.<br />
|
||||
In order to create additional windows (dialogs, menus, tooltips etc.), the plug-in can use the <a class="el" href="classSteinberg_1_1IWaylandFrame.html" title="IWaylandFrame interface Interface to query additional information about the host plug-in frame in a W...">IWaylandFrame</a> interface, which is implemented by the host's <a class="elRef" href="../base/classSteinberg_1_1IPlugFrame.html">IPlugFrame</a> object.<br />
|
||||
The plug-in can use <a class="el" href="classSteinberg_1_1IWaylandFrame.html#a055c5ea82125e5669e662779a0b0c0ba" title="Get the parent XDG surface for creating popup windows.">IWaylandFrame::getParentSurface()</a> to query an xdg_surface, which can in turn be used as a parent in xdg_surface_get_popup. Likewise, the plug-in can use <a class="el" href="classSteinberg_1_1IWaylandFrame.html#a7f589ebeefa8cfdf33f5f2899a20c105" title="Get the XDG toplevel surface containing the plug-in frame.">IWaylandFrame::getParentToplevel()</a> to query an xdg_toplevel, which can be used in xdg_toplevel_set_parent. </p>
|
||||
</div><!-- contents -->
|
||||
</div><!-- doc-content -->
|
||||
<html>
|
||||
<head>
|
||||
<title>Empty</title>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
|
||||
<meta name="Author" content="Steinberg">
|
||||
</head>
|
||||
<body>
|
||||
<br/>
|
||||
<hr width="100%" size="2" align="left" />
|
||||
<div align=right>
|
||||
Copyright ©<span id="year"></span> <a href="http://www.steinberg.net" target="_blank"><u>Steinberg Media Technologies GmbH</u></a>.
|
||||
All Rights Reserved. This documentation is under this <a href="http://www.steinberg.net/sdklicenses" target="_blank"><u>license</u></a>.
|
||||
</div>
|
||||
<script>
|
||||
document.querySelector("#year").textContent = new Date().getFullYear();
|
||||
</script>
|
||||
</body>
|
||||
</html>
|
||||
Reference in New Issue
Block a user