Fix the doc warning attribute and document remaining items for bevy_window (#9933)
# Objective Complete the documentation for `bevy_window`. ## Solution The `warn(missing_doc)` attribute was only applying to the `cursor` module as it was declared as an inner attribute. I switched it to an outer attribute and documented the remaining items.
This commit is contained in:
parent
df899d2ba2
commit
35d3213071
@ -313,7 +313,7 @@ pub struct WindowMoved {
|
|||||||
pub position: IVec2,
|
pub position: IVec2,
|
||||||
}
|
}
|
||||||
|
|
||||||
/// An event sent when system changed window theme.
|
/// An event sent when the system theme changes for a window.
|
||||||
///
|
///
|
||||||
/// This event is only sent when the window is relying on the system theme to control its appearance.
|
/// This event is only sent when the window is relying on the system theme to control its appearance.
|
||||||
/// i.e. It is only sent when [`Window::window_theme`](crate::window::Window::window_theme) is `None` and the system theme changes.
|
/// i.e. It is only sent when [`Window::window_theme`](crate::window::Window::window_theme) is `None` and the system theme changes.
|
||||||
@ -325,6 +325,8 @@ pub struct WindowMoved {
|
|||||||
reflect(Serialize, Deserialize)
|
reflect(Serialize, Deserialize)
|
||||||
)]
|
)]
|
||||||
pub struct WindowThemeChanged {
|
pub struct WindowThemeChanged {
|
||||||
|
/// Window for which the system theme has changed.
|
||||||
pub window: Entity,
|
pub window: Entity,
|
||||||
|
/// The new system theme.
|
||||||
pub theme: WindowTheme,
|
pub theme: WindowTheme,
|
||||||
}
|
}
|
||||||
|
|||||||
@ -1,6 +1,12 @@
|
|||||||
#![allow(clippy::type_complexity)]
|
#![allow(clippy::type_complexity)]
|
||||||
|
#![warn(missing_docs)]
|
||||||
|
//! `bevy_window` provides a platform-agnostic interface for windowing in Bevy.
|
||||||
|
//!
|
||||||
|
//! This crate contains types for window management and events,
|
||||||
|
//! used by windowing implementors such as `bevy_winit`.
|
||||||
|
//! The [`WindowPlugin`] sets up some global window-related parameters and
|
||||||
|
//! is part of the [`DefaultPlugins`](https://docs.rs/bevy/latest/bevy/struct.DefaultPlugins.html).
|
||||||
|
|
||||||
#[warn(missing_docs)]
|
|
||||||
mod cursor;
|
mod cursor;
|
||||||
mod event;
|
mod event;
|
||||||
mod raw_handle;
|
mod raw_handle;
|
||||||
@ -14,6 +20,7 @@ pub use event::*;
|
|||||||
pub use system::*;
|
pub use system::*;
|
||||||
pub use window::*;
|
pub use window::*;
|
||||||
|
|
||||||
|
#[allow(missing_docs)]
|
||||||
pub mod prelude {
|
pub mod prelude {
|
||||||
#[doc(hidden)]
|
#[doc(hidden)]
|
||||||
pub use crate::{
|
pub use crate::{
|
||||||
|
|||||||
@ -10,7 +10,9 @@ use raw_window_handle::{
|
|||||||
/// thread-safe.
|
/// thread-safe.
|
||||||
#[derive(Debug, Clone, Component)]
|
#[derive(Debug, Clone, Component)]
|
||||||
pub struct RawHandleWrapper {
|
pub struct RawHandleWrapper {
|
||||||
|
/// Raw handle to a window.
|
||||||
pub window_handle: RawWindowHandle,
|
pub window_handle: RawWindowHandle,
|
||||||
|
/// Raw handle to the display server.
|
||||||
pub display_handle: RawDisplayHandle,
|
pub display_handle: RawDisplayHandle,
|
||||||
}
|
}
|
||||||
|
|
||||||
@ -24,14 +26,6 @@ impl RawHandleWrapper {
|
|||||||
pub unsafe fn get_handle(&self) -> ThreadLockedRawWindowHandleWrapper {
|
pub unsafe fn get_handle(&self) -> ThreadLockedRawWindowHandleWrapper {
|
||||||
ThreadLockedRawWindowHandleWrapper(self.clone())
|
ThreadLockedRawWindowHandleWrapper(self.clone())
|
||||||
}
|
}
|
||||||
|
|
||||||
pub fn get_display_handle(&self) -> RawDisplayHandle {
|
|
||||||
self.display_handle
|
|
||||||
}
|
|
||||||
|
|
||||||
pub fn get_window_handle(&self) -> RawWindowHandle {
|
|
||||||
self.window_handle
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// SAFETY: [`RawHandleWrapper`] is just a normal "raw pointer", which doesn't impl Send/Sync. However the pointer is only
|
// SAFETY: [`RawHandleWrapper`] is just a normal "raw pointer", which doesn't impl Send/Sync. However the pointer is only
|
||||||
@ -59,7 +53,7 @@ pub struct ThreadLockedRawWindowHandleWrapper(RawHandleWrapper);
|
|||||||
// and so exposing a safe method to get a [`RawWindowHandle`] directly would be UB.
|
// and so exposing a safe method to get a [`RawWindowHandle`] directly would be UB.
|
||||||
unsafe impl HasRawWindowHandle for ThreadLockedRawWindowHandleWrapper {
|
unsafe impl HasRawWindowHandle for ThreadLockedRawWindowHandleWrapper {
|
||||||
fn raw_window_handle(&self) -> RawWindowHandle {
|
fn raw_window_handle(&self) -> RawWindowHandle {
|
||||||
self.0.get_window_handle()
|
self.0.window_handle
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@ -71,6 +65,6 @@ unsafe impl HasRawWindowHandle for ThreadLockedRawWindowHandleWrapper {
|
|||||||
// and so exposing a safe method to get a [`RawDisplayHandle`] directly would be UB.
|
// and so exposing a safe method to get a [`RawDisplayHandle`] directly would be UB.
|
||||||
unsafe impl HasRawDisplayHandle for ThreadLockedRawWindowHandleWrapper {
|
unsafe impl HasRawDisplayHandle for ThreadLockedRawWindowHandleWrapper {
|
||||||
fn raw_display_handle(&self) -> RawDisplayHandle {
|
fn raw_display_handle(&self) -> RawDisplayHandle {
|
||||||
self.0.get_display_handle()
|
self.0.display_handle
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user