From 789614691415ccb884af597c2bb7a4d0773963ed Mon Sep 17 00:00:00 2001 From: gered Date: Tue, 7 Mar 2023 22:41:21 -0500 Subject: [PATCH] add doc-comments --- ggdt/src/system/input_devices/mouse/cursor.rs | 2 ++ ggdt/src/system/mod.rs | 3 ++- 2 files changed, 4 insertions(+), 1 deletion(-) diff --git a/ggdt/src/system/input_devices/mouse/cursor.rs b/ggdt/src/system/input_devices/mouse/cursor.rs index 14d8bd9..bca0ec7 100644 --- a/ggdt/src/system/input_devices/mouse/cursor.rs +++ b/ggdt/src/system/input_devices/mouse/cursor.rs @@ -32,6 +32,8 @@ const DEFAULT_MOUSE_CURSOR: [u8; DEFAULT_MOUSE_CURSOR_WIDTH * DEFAULT_MOUSE_CURS 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0x00, 0x00, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff ]; +/// Provides custom mouse cursor rendering functionality via application provided [`Bitmap`]s (or falling back +/// to a default cursor if none is set by the application). Custom cursor rendering is disabled by default. #[derive(Debug)] pub struct CustomMouseCursor { last_x: i32, diff --git a/ggdt/src/system/mod.rs b/ggdt/src/system/mod.rs index 1bb534f..3d91002 100644 --- a/ggdt/src/system/mod.rs +++ b/ggdt/src/system/mod.rs @@ -123,7 +123,8 @@ impl SystemBuilder { /// Enables or disables mouse cursor display by the operating system when the cursor is over /// the window for the [`System`] being built. Disable this if you intend to render your own - /// custom mouse cursor. + /// custom mouse cursor (either via [`CustomMouseCursor`] or otherwise), otherwise you will + /// end up with two cursors being visible. pub fn show_mouse(mut self, enable: bool) -> Self { self.show_mouse = enable; self