12 lines
6.3 KiB
HTML
12 lines
6.3 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="This module provides unsurprising default inputs to `bevy_picking` through `PointerInput`. The included systems are responsible for sending mouse and touch inputs to their respective `Pointer`s."><title>bevy_picking::input - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-42caa33d.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="bevy_picking" data-themes="" data-resource-suffix="" data-rustdoc-version="1.84.0 (9fc6b4312 2025-01-07)" data-channel="1.84.0" data-search-js="search-92e6798f.js" data-settings-js="settings-0f613d39.js" ><script src="../../static.files/storage-59e33391.js"></script><script defer src="../sidebar-items.js"></script><script defer src="../../static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-044be391.svg"></head><body class="rustdoc mod"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../bevy_picking/index.html">bevy_<wbr>picking</a><span class="version">0.15.1</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Module input</a></h2><h3><a href="#modules">Module Items</a></h3><ul class="block"><li><a href="#modules" title="Modules">Modules</a></li><li><a href="#structs" title="Structs">Structs</a></li><li><a href="#functions" title="Functions">Functions</a></li></ul></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="../index.html">In crate bevy_<wbr>picking</a></h2></div></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><span class="rustdoc-breadcrumbs"><a href="../index.html">bevy_picking</a></span><h1>Module <span>input</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../../src/bevy_picking/input.rs.html#1-272">Source</a> </span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>This module provides unsurprising default inputs to <code>bevy_picking</code> through <a href="../pointer/struct.PointerInput.html" title="struct bevy_picking::pointer::PointerInput"><code>PointerInput</code></a>.
|
||
The included systems are responsible for sending mouse and touch inputs to their
|
||
respective <code>Pointer</code>s.</p>
|
||
<p>Because this has it’s own plugin, it’s easy to omit it, and provide your own inputs as
|
||
needed. Because <code>Pointer</code>s aren’t coupled to the underlying input hardware, you can easily mock
|
||
inputs, and allow users full accessibility to map whatever inputs they need to pointer input.</p>
|
||
<p>If, for example, you wanted to add support for VR input, all you need to do is spawn a pointer
|
||
entity with a custom <a href="../pointer/enum.PointerId.html" title="enum bevy_picking::pointer::PointerId"><code>PointerId</code></a>, and write a system
|
||
that updates its position. If you want this to work properly with the existing interaction events,
|
||
you need to be sure that you also write a <a href="../pointer/struct.PointerInput.html" title="struct bevy_picking::pointer::PointerInput"><code>PointerInput</code></a> event stream.</p>
|
||
</div></details><h2 id="modules" class="section-header">Modules<a href="#modules" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="mod" href="prelude/index.html" title="mod bevy_picking::input::prelude">prelude</a></div><div class="desc docblock-short">The picking input prelude.</div></li></ul><h2 id="structs" class="section-header">Structs<a href="#structs" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="struct" href="struct.PointerInputPlugin.html" title="struct bevy_picking::input::PointerInputPlugin">Pointer<wbr>Input<wbr>Plugin</a></div><div class="desc docblock-short">Adds mouse and touch inputs for picking pointers to your app. This is a default input plugin,
|
||
that you can replace with your own plugin as needed.</div></li></ul><h2 id="functions" class="section-header">Functions<a href="#functions" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="fn" href="fn.deactivate_touch_pointers.html" title="fn bevy_picking::input::deactivate_touch_pointers">deactivate_<wbr>touch_<wbr>pointers</a></div><div class="desc docblock-short">Deactivates unused touch pointers.</div></li><li><div class="item-name"><a class="fn" href="fn.mouse_pick_events.html" title="fn bevy_picking::input::mouse_pick_events">mouse_<wbr>pick_<wbr>events</a></div><div class="desc docblock-short">Sends mouse pointer events to be processed by the core plugin</div></li><li><div class="item-name"><a class="fn" href="fn.spawn_mouse_pointer.html" title="fn bevy_picking::input::spawn_mouse_pointer">spawn_<wbr>mouse_<wbr>pointer</a></div><div class="desc docblock-short">Spawns the default mouse pointer.</div></li><li><div class="item-name"><a class="fn" href="fn.touch_pick_events.html" title="fn bevy_picking::input::touch_pick_events">touch_<wbr>pick_<wbr>events</a></div><div class="desc docblock-short">Sends touch pointer events to be consumed by the core plugin</div></li></ul></section></div></main></body></html> |