migrations/winit
1
0
Fork 0
mirror of https://github.com/rust-windowing/winit.git synced 2026-09-01 06:10:07 -04:00
Code Issues Packages Projects Releases Wiki Activity

Update documentation regarding set_cursor_position (#3521)

Browse Source
This commit is contained in:
Friz64
2024-02-24 23:15:38 +01:00
committed by GitHub
parent 97cfdd4b09
commit 990bbf178f
1 changed files with 3 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
src/window.rs
View File

@@ -1353,7 +1353,8 @@ impl Window {
/// ///
/// ## Platform-specific /// ## Platform-specific
/// ///
/// - **iOS / Android / Web / Wayland / Orbital:** Always returns an [`ExternalError::NotSupported`]. /// - **Wayland**: Cursor must be in [`CursorGrabMode::Locked`].
/// - **iOS / Android / Web / Orbital:** Always returns an [`ExternalError::NotSupported`].
#[inline] #[inline]
pub fn set_cursor_position<P: Into<Position>>(&self, position: P) -> Result<(), ExternalError> { pub fn set_cursor_position<P: Into<Position>>(&self, position: P) -> Result<(), ExternalError> {
let position = position.into(); let position = position.into();
@@ -1361,7 +1362,7 @@ impl Window {
.maybe_wait_on_main(|w| w.set_cursor_position(position)) .maybe_wait_on_main(|w| w.set_cursor_position(position))
} }
/// Set grabbing [mode]([`CursorGrabMode`]) on the cursor preventing it from leaving the window. /// Set grabbing [mode](CursorGrabMode) on the cursor preventing it from leaving the window.
/// ///
/// # Example /// # Example
/// ///