leyoda/winit
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

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
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
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
/// ///