mirror of
https://github.com/encounter/rust-sdl2.git
synced 2026-07-10 21:18:41 -07:00
18 lines
4.6 KiB
HTML
18 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_GetGlobalMouseState` fn in crate `sdl2_sys`."><meta name="keywords" content="rust, rustlang, rust-lang, SDL_GetGlobalMouseState"><title>sdl2_sys::SDL_GetGlobalMouseState - 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_GetGlobalMouseState', 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#9596' 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_GetGlobalMouseState</a></span></h1><pre class='rust fn'>pub unsafe extern "C" fn SDL_GetGlobalMouseState(<br> x: *mut <a class="type" href="../libc/unix/type.c_int.html" title="type libc::unix::c_int">c_int</a>, <br> y: *mut <a class="type" href="../libc/unix/type.c_int.html" title="type libc::unix::c_int">c_int</a><br>) -> <a class="type" href="../sdl2_sys/type.Uint32.html" title="type sdl2_sys::Uint32">Uint32</a></pre><div class='docblock'><p>\brief Get the current state of the mouse, in relation to the desktop</p>
|
||
<p>This works just like SDL_GetMouseState(), but the coordinates will be
|
||
reported relative to the top-left of the desktop. This can be useful if
|
||
you need to track the mouse outside of a specific window and
|
||
SDL_CaptureMouse() doesn't fit your needs. For example, it could be
|
||
useful if you need to track the mouse while dragging a window, where
|
||
coordinates relative to a window might not be in sync at all times.</p>
|
||
<p>\note SDL_GetMouseState() returns the mouse position as SDL understands
|
||
it from the last pump of the event queue. This function, however,
|
||
queries the OS for the current mouse position, and as such, might
|
||
be a slightly less efficient function. Unless you know what you're
|
||
doing and have a good reason to use this function, you probably want
|
||
SDL_GetMouseState() instead.</p>
|
||
<p>\param x Returns the current X coord, relative to the desktop. Can be NULL.
|
||
\param y Returns the current Y coord, relative to the desktop. Can be NULL.
|
||
\return The current button state as a bitmask, which can be tested using the SDL_BUTTON(X) macros.</p>
|
||
<p>\sa SDL_GetMouseState</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> |