2018-10-28 21:14:05 -05:00

179 lines
13 KiB
HTML
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="API documentation for the Rust `protocol` mod in crate `wayland_client`."><meta name="keywords" content="rust, rustlang, rust-lang, protocol"><title>wayland_client::protocol - Rust</title><link rel="stylesheet" type="text/css" href="../../normalize.css"><link rel="stylesheet" type="text/css" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../dark.css"><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><script src="../../storage.js"></script></head><body class="rustdoc mod"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">&#9776;</div><p class='location'>Module protocol</p><div class="sidebar-elems"><div class="block items"><ul><li><a href="#modules">Modules</a></li></ul></div><p class='location'><a href='../index.html'>wayland_client</a></p><script>window.sidebarCurrent = {name: 'protocol', ty: 'mod', relpath: '../'};</script><script defer src="../sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!"><img src="../../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices"></div></div><script src="../../theme.js"></script><nav class="sub"><form class="search-form js-only"><div class="search-container"><input class="search-input" name="search" autocomplete="off" placeholder="Click or press S to search, ? for more options…" type="search"><a id="settings-menu" href="../../settings.html"><img src="../../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class='fqn'><span class='in-band'>Module <a href='../index.html'>wayland_client</a>::<wbr><a class="mod" href=''>protocol</a></span><span class='out-of-band'><span id='render-detail'><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class='inner'>&#x2212;</span>]</a></span><a class='srclink' href='../../src/wayland_client/lib.rs.html#168-171' title='goto source code'>[src]</a></span></h1><div class='docblock'><p>Generated interfaces for the core wayland protocol</p>
</div><h2 id='modules' class='section-header'><a href="#modules">Modules</a></h2>
<table>
<tr class=' module-item'>
<td><a class="mod" href="wl_buffer/index.html"
title='mod wayland_client::protocol::wl_buffer'>wl_buffer</a></td>
<td class='docblock-short'>
<p>content for a wl_surface</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="mod" href="wl_callback/index.html"
title='mod wayland_client::protocol::wl_callback'>wl_callback</a></td>
<td class='docblock-short'>
<p>callback object</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="mod" href="wl_compositor/index.html"
title='mod wayland_client::protocol::wl_compositor'>wl_compositor</a></td>
<td class='docblock-short'>
<p>the compositor singleton</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="mod" href="wl_data_device/index.html"
title='mod wayland_client::protocol::wl_data_device'>wl_data_device</a></td>
<td class='docblock-short'>
<p>data transfer device</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="mod" href="wl_data_device_manager/index.html"
title='mod wayland_client::protocol::wl_data_device_manager'>wl_data_device_manager</a></td>
<td class='docblock-short'>
<p>data transfer interface</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="mod" href="wl_data_offer/index.html"
title='mod wayland_client::protocol::wl_data_offer'>wl_data_offer</a></td>
<td class='docblock-short'>
<p>offer to transfer data</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="mod" href="wl_data_source/index.html"
title='mod wayland_client::protocol::wl_data_source'>wl_data_source</a></td>
<td class='docblock-short'>
<p>offer to transfer data</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="mod" href="wl_display/index.html"
title='mod wayland_client::protocol::wl_display'>wl_display</a></td>
<td class='docblock-short'>
<p>core global object</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="mod" href="wl_keyboard/index.html"
title='mod wayland_client::protocol::wl_keyboard'>wl_keyboard</a></td>
<td class='docblock-short'>
<p>keyboard input device</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="mod" href="wl_output/index.html"
title='mod wayland_client::protocol::wl_output'>wl_output</a></td>
<td class='docblock-short'>
<p>compositor output region</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="mod" href="wl_pointer/index.html"
title='mod wayland_client::protocol::wl_pointer'>wl_pointer</a></td>
<td class='docblock-short'>
<p>pointer input device</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="mod" href="wl_region/index.html"
title='mod wayland_client::protocol::wl_region'>wl_region</a></td>
<td class='docblock-short'>
<p>region interface</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="mod" href="wl_registry/index.html"
title='mod wayland_client::protocol::wl_registry'>wl_registry</a></td>
<td class='docblock-short'>
<p>global registry object</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="mod" href="wl_seat/index.html"
title='mod wayland_client::protocol::wl_seat'>wl_seat</a></td>
<td class='docblock-short'>
<p>group of input devices</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="mod" href="wl_shell/index.html"
title='mod wayland_client::protocol::wl_shell'>wl_shell</a></td>
<td class='docblock-short'>
<p>create desktop-style surfaces</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="mod" href="wl_shell_surface/index.html"
title='mod wayland_client::protocol::wl_shell_surface'>wl_shell_surface</a></td>
<td class='docblock-short'>
<p>desktop-style metadata interface</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="mod" href="wl_shm/index.html"
title='mod wayland_client::protocol::wl_shm'>wl_shm</a></td>
<td class='docblock-short'>
<p>shared memory support</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="mod" href="wl_shm_pool/index.html"
title='mod wayland_client::protocol::wl_shm_pool'>wl_shm_pool</a></td>
<td class='docblock-short'>
<p>a shared memory pool</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="mod" href="wl_subcompositor/index.html"
title='mod wayland_client::protocol::wl_subcompositor'>wl_subcompositor</a></td>
<td class='docblock-short'>
<p>sub-surface compositing</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="mod" href="wl_subsurface/index.html"
title='mod wayland_client::protocol::wl_subsurface'>wl_subsurface</a></td>
<td class='docblock-short'>
<p>sub-surface interface to a wl_surface</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="mod" href="wl_surface/index.html"
title='mod wayland_client::protocol::wl_surface'>wl_surface</a></td>
<td class='docblock-short'>
<p>an onscreen surface</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="mod" href="wl_touch/index.html"
title='mod wayland_client::protocol::wl_touch'>wl_touch</a></td>
<td class='docblock-short'>
<p>touchscreen input device</p>
</td>
</tr></table></section><section id="search" class="content hidden"></section><section class="footer"></section><aside id="help" class="hidden"><div><h1 class="hidden">Help</h1><div class="shortcuts"><h2>Keyboard Shortcuts</h2><dl><dt><kbd>?</kbd></dt><dd>Show this help dialog</dd><dt><kbd>S</kbd></dt><dd>Focus the search field</dd><dt><kbd></kbd></dt><dd>Move up in search results</dd><dt><kbd></kbd></dt><dd>Move down in search results</dd><dt><kbd></kbd></dt><dd>Switch tab</dd><dt><kbd>&#9166;</kbd></dt><dd>Go to active search result</dd><dt><kbd>+</kbd></dt><dd>Expand all sections</dd><dt><kbd>-</kbd></dt><dd>Collapse all sections</dd></dl></div><div class="infos"><h2>Search Tricks</h2><p>Prefix searches with a type followed by a colon (e.g. <code>fn:</code>) to restrict the search to a given type.</p><p>Accepted types are: <code>fn</code>, <code>mod</code>, <code>struct</code>, <code>enum</code>, <code>trait</code>, <code>type</code>, <code>macro</code>, and <code>const</code>.</p><p>Search functions by type signature (e.g. <code>vec -> usize</code> or <code>* -> vec</code>)</p><p>Search multiple things at once by splitting your query with comma (e.g. <code>str,u8</code> or <code>String,struct:Vec,test</code>)</p></div></div></aside><script>window.rootPath = "../../";window.currentCrate = "wayland_client";</script><script src="../../aliases.js"></script><script src="../../main.js"></script><script defer src="../../search-index.js"></script></body></html>