Skip to content

Commit

Permalink
Doc fixes (#3312)
Browse files Browse the repository at this point in the history
  • Loading branch information
daxpedda authored Dec 24, 2023
1 parent 775c8ec commit 34dd2cd
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 10 deletions.
5 changes: 0 additions & 5 deletions src/cursor.rs
Original file line number Diff line number Diff line change
Expand Up @@ -54,11 +54,6 @@ pub struct CustomCursor {

impl CustomCursor {
/// Creates a new cursor from an rgba buffer.
///
/// ## Platform-specific
///
/// - **Web:** Setting cursor could be delayed due to the creation of `Blob` objects,
/// which are async by nature.
pub fn from_rgba(
rgba: impl Into<Vec<u8>>,
width: u16,
Expand Down
11 changes: 6 additions & 5 deletions src/platform/web.rs
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,8 @@ use crate::SendSyncWrapper;
use web_sys::HtmlCanvasElement;

pub trait WindowExtWebSys {
/// Only returns the canvas if called from inside the window.
/// Only returns the canvas if called from inside the window context (the
/// main thread).
fn canvas(&self) -> Option<HtmlCanvasElement>;
}

Expand All @@ -59,11 +60,11 @@ pub trait WindowBuilderExtWebSys {
/// [`None`] by default.
fn with_canvas(self, canvas: Option<HtmlCanvasElement>) -> Self;

/// Whether `event.preventDefault` should be automatically called to prevent event propagation
/// when appropriate.
/// Whether `event.preventDefault()` should be called on events on the
/// canvas that have side effects.
///
/// For example, mouse wheel events are only handled by the canvas by default. This avoids
/// the default behavior of scrolling the page.
/// For example, by default using the mouse wheel would cause the page to scroll, enabling this
/// would prevent that.
///
/// Some events are impossible to prevent. E.g. Firefox allows to access the native browser
/// context menu with Shift+Rightclick.
Expand Down
2 changes: 2 additions & 0 deletions src/window.rs
Original file line number Diff line number Diff line change
Expand Up @@ -1353,6 +1353,8 @@ impl Window {
/// ## Platform-specific
///
/// - **iOS / Android / Orbital:** Unsupported.
/// - **Web:** Cursor have to be loaded and decoded first, which introduces
/// a delay until cursors are shown.
#[inline]
pub fn set_custom_cursor(&self, cursor: &CustomCursor) {
let cursor = cursor.inner.clone();
Expand Down

0 comments on commit 34dd2cd

Please sign in to comment.