add doc-comments

This commit is contained in:
Gered 2023-03-07 22:41:21 -05:00
parent d437755a9f
commit 7896146914
2 changed files with 4 additions and 1 deletions

View file

@ -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,

View file

@ -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