mirror of
https://github.com/encounter/rust-sdl2.git
synced 2026-07-10 21:18:41 -07:00
22 lines
4.6 KiB
HTML
22 lines
4.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="API documentation for the Rust `SDL_CaptureMouse` fn in crate `sdl2_sys`."><meta name="keywords" content="rust, rustlang, rust-lang, SDL_CaptureMouse"><title>sdl2_sys::SDL_CaptureMouse - 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><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="shortcut icon" href="../favicon.ico"><style type="text/css">#crate-search{background-image:url("../down-arrow.svg");}</style></head><body class="rustdoc fn"><!--[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><a href='../sdl2_sys/index.html'><div class='logo-container'><img src='../rust-logo.png' alt='logo'></div></a><div class="sidebar-elems"><p class='location'><a href='index.html'>sdl2_sys</a></p><script>window.sidebarCurrent = {name: 'SDL_CaptureMouse', ty: 'fn', 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"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><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='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/sdl2_sys/Users/travis/build/Rust-SDL2/rust-sdl2/target/debug/build/sdl2-sys-f32779682524d647/out/sdl_bindings.rs.html#9671' title='goto source code'>[src]</a></span><span class='in-band'>Function <a href='index.html'>sdl2_sys</a>::<wbr><a class="fn" href=''>SDL_CaptureMouse</a></span></h1><pre class='rust fn'>pub unsafe extern "C" fn SDL_CaptureMouse(enabled: <a class="enum" href="../sdl2_sys/enum.SDL_bool.html" title="enum sdl2_sys::SDL_bool">SDL_bool</a>) -> <a class="type" href="../libc/unix/type.c_int.html" title="type libc::unix::c_int">c_int</a></pre><div class='docblock'><p>\brief Capture the mouse, to track input outside an SDL window.</p>
|
||
<p>\param enabled Whether or not to enable capturing</p>
|
||
<p>Capturing enables your app to obtain mouse events globally, instead of
|
||
just within your window. Not all video targets support this function.
|
||
When capturing is enabled, the current window will get all mouse events,
|
||
but unlike relative mode, no change is made to the cursor and it is
|
||
not restrained to your window.</p>
|
||
<p>This function may also deny mouse input to other windows--both those in
|
||
your application and others on the system--so you should use this
|
||
function sparingly, and in small bursts. For example, you might want to
|
||
track the mouse while the user is dragging something, until the user
|
||
releases a mouse button. It is not recommended that you capture the mouse
|
||
for long periods of time, such as the entire time your app is running.</p>
|
||
<p>While captured, mouse events still report coordinates relative to the
|
||
current (foreground) window, but those coordinates may be outside the
|
||
bounds of the window (including negative values). Capturing is only
|
||
allowed for the foreground window. If the window loses focus while
|
||
capturing, the capture will be disabled automatically.</p>
|
||
<p>While capturing is enabled, the current window will have the
|
||
SDL_WINDOW_MOUSE_CAPTURE flag set.</p>
|
||
<p>\return 0 on success, or -1 if not supported.</p>
|
||
</div></section><section id="search" class="content hidden"></section><section class="footer"></section><script>window.rootPath = "../";window.currentCrate = "sdl2_sys";</script><script src="../aliases.js"></script><script src="../main.js"></script><script defer src="../search-index.js"></script></body></html> |