9b32e09551
# Objective Now that #13432 has been merged, it's important we update our reflected types to properly opt into this feature. If we do not, then this could cause issues for users downstream who want to make use of reflection-based cloning. ## Solution This PR is broken into 4 commits: 1. Add `#[reflect(Clone)]` on all types marked `#[reflect(opaque)]` that are also `Clone`. This is mandatory as these types would otherwise cause the cloning operation to fail for any type that contains it at any depth. 2. Update the reflection example to suggest adding `#[reflect(Clone)]` on opaque types. 3. Add `#[reflect(clone)]` attributes on all fields marked `#[reflect(ignore)]` that are also `Clone`. This prevents the ignored field from causing the cloning operation to fail. Note that some of the types that contain these fields are also `Clone`, and thus can be marked `#[reflect(Clone)]`. This makes the `#[reflect(clone)]` attribute redundant. However, I think it's safer to keep it marked in the case that the `Clone` impl/derive is ever removed. I'm open to removing them, though, if people disagree. 4. Finally, I added `#[reflect(Clone)]` on all types that are also `Clone`. While not strictly necessary, it enables us to reduce the generated output since we can just call `Clone::clone` directly instead of calling `PartialReflect::reflect_clone` on each variant/field. It also means we benefit from any optimizations or customizations made in the `Clone` impl, including directly dereferencing `Copy` values and increasing reference counters. Along with that change I also took the liberty of adding any missing registrations that I saw could be applied to the type as well, such as `Default`, `PartialEq`, and `Hash`. There were hundreds of these to edit, though, so it's possible I missed quite a few. That last commit is **_massive_**. There were nearly 700 types to update. So it's recommended to review the first three before moving onto that last one. Additionally, I can break the last commit off into its own PR or into smaller PRs, but I figured this would be the easiest way of doing it (and in a timely manner since I unfortunately don't have as much time as I used to for code contributions). ## Testing You can test locally with a `cargo check`: ``` cargo check --workspace --all-features ```
81 lines
2.7 KiB
Rust
81 lines
2.7 KiB
Rust
use alloc::{string::String, vec::Vec};
|
|
use bevy_ecs::component::Component;
|
|
use bevy_math::{IVec2, UVec2};
|
|
|
|
#[cfg(feature = "bevy_reflect")]
|
|
use {bevy_ecs::prelude::ReflectComponent, bevy_reflect::Reflect};
|
|
|
|
#[cfg(all(feature = "serialize", feature = "bevy_reflect"))]
|
|
use bevy_reflect::{ReflectDeserialize, ReflectSerialize};
|
|
|
|
/// Represents an available monitor as reported by the user's operating system, which can be used
|
|
/// to query information about the display, such as its size, position, and video modes.
|
|
///
|
|
/// Each monitor corresponds to an entity and can be used to position a monitor using
|
|
/// [`crate::window::MonitorSelection::Entity`].
|
|
///
|
|
/// # Warning
|
|
///
|
|
/// This component is synchronized with `winit` through `bevy_winit`, but is effectively
|
|
/// read-only as `winit` does not support changing monitor properties.
|
|
#[derive(Component, Debug, Clone)]
|
|
#[cfg_attr(
|
|
feature = "bevy_reflect",
|
|
derive(Reflect),
|
|
reflect(Component, Debug, Clone)
|
|
)]
|
|
#[cfg_attr(feature = "serialize", derive(serde::Serialize, serde::Deserialize))]
|
|
#[cfg_attr(
|
|
all(feature = "serialize", feature = "bevy_reflect"),
|
|
reflect(Serialize, Deserialize)
|
|
)]
|
|
pub struct Monitor {
|
|
/// The name of the monitor
|
|
pub name: Option<String>,
|
|
/// The height of the monitor in physical pixels
|
|
pub physical_height: u32,
|
|
/// The width of the monitor in physical pixels
|
|
pub physical_width: u32,
|
|
/// The position of the monitor in physical pixels
|
|
pub physical_position: IVec2,
|
|
/// The refresh rate of the monitor in millihertz
|
|
pub refresh_rate_millihertz: Option<u32>,
|
|
/// The scale factor of the monitor
|
|
pub scale_factor: f64,
|
|
/// The video modes that the monitor supports
|
|
pub video_modes: Vec<VideoMode>,
|
|
}
|
|
|
|
/// A marker component for the primary monitor
|
|
#[derive(Component, Debug, Clone)]
|
|
#[cfg_attr(
|
|
feature = "bevy_reflect",
|
|
derive(Reflect),
|
|
reflect(Component, Debug, Clone)
|
|
)]
|
|
pub struct PrimaryMonitor;
|
|
|
|
impl Monitor {
|
|
/// Returns the physical size of the monitor in pixels
|
|
pub fn physical_size(&self) -> UVec2 {
|
|
UVec2::new(self.physical_width, self.physical_height)
|
|
}
|
|
}
|
|
|
|
/// Represents a video mode that a monitor supports
|
|
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
|
|
#[cfg_attr(feature = "bevy_reflect", derive(Reflect), reflect(Debug, Clone))]
|
|
#[cfg_attr(feature = "serialize", derive(serde::Serialize, serde::Deserialize))]
|
|
#[cfg_attr(
|
|
all(feature = "serialize", feature = "bevy_reflect"),
|
|
reflect(Serialize, Deserialize)
|
|
)]
|
|
pub struct VideoMode {
|
|
/// The resolution of the video mode
|
|
pub physical_size: UVec2,
|
|
/// The bit depth of the video mode
|
|
pub bit_depth: u16,
|
|
/// The refresh rate in millihertz
|
|
pub refresh_rate_millihertz: u32,
|
|
}
|