10 lines
7.6 KiB
HTML
10 lines
7.6 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="Types and systems for pointer inputs, such as position and buttons."><title>bevy_picking::pointer - 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 pointer</a></h2><h3><a href="#structs">Module Items</a></h3><ul class="block"><li><a href="#structs" title="Structs">Structs</a></li><li><a href="#enums" title="Enums">Enums</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>pointer</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/pointer.rs.html#1-341">Source</a> </span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Types and systems for pointer inputs, such as position and buttons.</p>
|
||
<p>The picking system is built around the concept of a ‘Pointer’, which is an
|
||
abstract representation of a user input with a specific screen location. The cursor
|
||
and touch input is provided under <a href="../input/index.html" title="mod bevy_picking::input"><code>crate::input</code></a>, but you can also implement
|
||
your own custom pointers by supplying a unique ID.</p>
|
||
<p>The purpose of this module is primarily to provide a common interface that can be
|
||
driven by lower-level input devices and consumed by higher-level interaction systems.</p>
|
||
</div></details><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.Location.html" title="struct bevy_picking::pointer::Location">Location</a></div><div class="desc docblock-short">The location of a pointer, including the current <a href="../../bevy_render/camera/camera/enum.NormalizedRenderTarget.html" title="enum bevy_render::camera::camera::NormalizedRenderTarget"><code>NormalizedRenderTarget</code></a>, and the x/y
|
||
position of the pointer on this render target.</div></li><li><div class="item-name"><a class="struct" href="struct.PointerInput.html" title="struct bevy_picking::pointer::PointerInput">Pointer<wbr>Input</a></div><div class="desc docblock-short">An input event effecting a pointer.</div></li><li><div class="item-name"><a class="struct" href="struct.PointerInteraction.html" title="struct bevy_picking::pointer::PointerInteraction">Pointer<wbr>Interaction</a></div><div class="desc docblock-short">Holds a list of entities this pointer is currently interacting with, sorted from nearest to
|
||
farthest.</div></li><li><div class="item-name"><a class="struct" href="struct.PointerLocation.html" title="struct bevy_picking::pointer::PointerLocation">Pointer<wbr>Location</a></div><div class="desc docblock-short">Component that tracks a pointer’s current <a href="struct.Location.html" title="struct bevy_picking::pointer::Location"><code>Location</code></a>.</div></li><li><div class="item-name"><a class="struct" href="struct.PointerMap.html" title="struct bevy_picking::pointer::PointerMap">Pointer<wbr>Map</a></div><div class="desc docblock-short">A resource that maps each <a href="enum.PointerId.html" title="enum bevy_picking::pointer::PointerId"><code>PointerId</code></a> to their <a href="../../bevy_ecs/entity/struct.Entity.html" title="struct bevy_ecs::entity::Entity"><code>Entity</code></a> for easy lookups.</div></li><li><div class="item-name"><a class="struct" href="struct.PointerPress.html" title="struct bevy_picking::pointer::PointerPress">Pointer<wbr>Press</a></div><div class="desc docblock-short">Tracks the state of the pointer’s buttons in response to <a href="struct.PointerInput.html" title="struct bevy_picking::pointer::PointerInput"><code>PointerInput</code></a> events.</div></li></ul><h2 id="enums" class="section-header">Enums<a href="#enums" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="enum" href="enum.PointerAction.html" title="enum bevy_picking::pointer::PointerAction">Pointer<wbr>Action</a></div><div class="desc docblock-short">Types of actions that can be taken by pointers.</div></li><li><div class="item-name"><a class="enum" href="enum.PointerButton.html" title="enum bevy_picking::pointer::PointerButton">Pointer<wbr>Button</a></div><div class="desc docblock-short">The button that was just pressed or released</div></li><li><div class="item-name"><a class="enum" href="enum.PointerId.html" title="enum bevy_picking::pointer::PointerId">Pointer<wbr>Id</a></div><div class="desc docblock-short">Identifies a unique pointer entity. <code>Mouse</code> and <code>Touch</code> pointers are automatically spawned.</div></li><li><div class="item-name"><a class="enum" href="enum.PressDirection.html" title="enum bevy_picking::pointer::PressDirection">Press<wbr>Direction</a></div><div class="desc docblock-short">The stage of the pointer button press event</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.update_pointer_map.html" title="fn bevy_picking::pointer::update_pointer_map">update_<wbr>pointer_<wbr>map</a></div><div class="desc docblock-short">Update the <a href="struct.PointerMap.html" title="struct bevy_picking::pointer::PointerMap"><code>PointerMap</code></a> resource with the current frame’s data.</div></li></ul></section></div></main></body></html> |