mirror of
https://github.com/neogeek23/rusty_snek_gaem.git
synced 2026-02-05 03:28:41 +00:00
54 lines
6.8 KiB
HTML
54 lines
6.8 KiB
HTML
<!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 `cursor` mod in crate `wayland_client`."><meta name="keywords" content="rust, rustlang, rust-lang, cursor"><title>wayland_client::cursor - 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">☰</div><p class='location'>Module cursor</p><div class="sidebar-elems"><div class="block items"><ul><li><a href="#structs">Structs</a></li><li><a href="#functions">Functions</a></li></ul></div><p class='location'><a href='../index.html'>wayland_client</a></p><script>window.sidebarCurrent = {name: 'cursor', 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=''>cursor</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'>−</span>]</a></span><a class='srclink' href='../../src/wayland_client/cursor.rs.html#1-234' title='goto source code'>[src]</a></span></h1><div class='docblock'><p>Cursor utilities</p>
|
||
<p>This module contains bindings to the <code>libwayland-cursor.so</code> library.</p>
|
||
<p>These utilities allows you to laod cursor images in order to match
|
||
your cursors to the ones of the system.</p>
|
||
<p>First of all, the function <code>load_theme</code> will allow you to load a
|
||
<code>CursorTheme</code>, which represents the full cursor theme.</p>
|
||
<p>From this theme, you can load a specific <code>Cursor</code>, which can each
|
||
contain several images if the cursor is animated. It provides you
|
||
with the means of knowing which frame of the animation shoudl be
|
||
displayed at which time, as well as handles to the buffers containing
|
||
these frames, to attach them to a wayland surface.</p>
|
||
</div><h2 id='structs' class='section-header'><a href="#structs">Structs</a></h2>
|
||
<table>
|
||
<tr class=' module-item'>
|
||
<td><a class="struct" href="struct.Cursor.html"
|
||
title='struct wayland_client::cursor::Cursor'>Cursor</a></td>
|
||
<td class='docblock-short'>
|
||
<p>A cursor from a theme. Can contain several images if animated.</p>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="struct" href="struct.CursorImageBuffer.html"
|
||
title='struct wayland_client::cursor::CursorImageBuffer'>CursorImageBuffer</a></td>
|
||
<td class='docblock-short'>
|
||
<p>A buffer containing a cursor image.</p>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="struct" href="struct.CursorTheme.html"
|
||
title='struct wayland_client::cursor::CursorTheme'>CursorTheme</a></td>
|
||
<td class='docblock-short'>
|
||
<p>Represents a cursor theme loaded from the system.</p>
|
||
|
||
</td>
|
||
</tr></table><h2 id='functions' class='section-header'><a href="#functions">Functions</a></h2>
|
||
<table>
|
||
<tr class=' module-item'>
|
||
<td><a class="fn" href="fn.is_available.html"
|
||
title='fn wayland_client::cursor::is_available'>is_available</a></td>
|
||
<td class='docblock-short'>
|
||
<p>Checks if the wayland-cursor lib is available and can be used</p>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="fn" href="fn.load_theme.html"
|
||
title='fn wayland_client::cursor::load_theme'>load_theme</a></td>
|
||
<td class='docblock-short'>
|
||
<p>Attempts to load a cursor theme from given name.</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>⏎</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> |