Skip to content

Commit 990bbf1

Browse files
authored
Update documentation regarding set_cursor_position (#3521)
1 parent 97cfdd4 commit 990bbf1

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

src/window.rs

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1353,15 +1353,16 @@ impl Window {
13531353
///
13541354
/// ## Platform-specific
13551355
///
1356-
/// - **iOS / Android / Web / Wayland / Orbital:** Always returns an [`ExternalError::NotSupported`].
1356+
/// - **Wayland**: Cursor must be in [`CursorGrabMode::Locked`].
1357+
/// - **iOS / Android / Web / Orbital:** Always returns an [`ExternalError::NotSupported`].
13571358
#[inline]
13581359
pub fn set_cursor_position<P: Into<Position>>(&self, position: P) -> Result<(), ExternalError> {
13591360
let position = position.into();
13601361
self.window
13611362
.maybe_wait_on_main(|w| w.set_cursor_position(position))
13621363
}
13631364

1364-
/// Set grabbing [mode]([`CursorGrabMode`]) on the cursor preventing it from leaving the window.
1365+
/// Set grabbing [mode](CursorGrabMode) on the cursor preventing it from leaving the window.
13651366
///
13661367
/// # Example
13671368
///

0 commit comments

Comments
 (0)