forestia/bevy
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Change the Node doc comments to state that it stores the size in logical pixels (#7896)

Browse Source 
# Objective

Current `Node` doc comment:
```rust
/// The size of the node as width and height in pixels
/// automatically calculated by [`super::flex::flex_node_system`]
```

It should be changed to make it clear that `Node` stores the size in logical pixels, not physical.
This commit is contained in:
ickshonpe 2023-03-04 19:24:56 +00:00
parent f9226a382e
commit cfc280cbef
2 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
crates/bevy_ui/src/node_bundles.rs
View File

@ -18,7 +18,7 @@ use bevy_transform::prelude::{GlobalTransform, Transform};
/// Useful as a container for a variety of child nodes. /// Useful as a container for a variety of child nodes.
#[derive(Bundle, Clone, Debug)] #[derive(Bundle, Clone, Debug)]
pub struct NodeBundle { pub struct NodeBundle {
/// Describes the size of the node /// Describes the logical size of the node
pub node: Node, pub node: Node,
/// Describes the style including flexbox settings /// Describes the style including flexbox settings
pub style: Style, pub style: Style,
@ -64,7 +64,7 @@ impl Default for NodeBundle {
/// A UI node that is an image /// A UI node that is an image
#[derive(Bundle, Clone, Debug, Default)] #[derive(Bundle, Clone, Debug, Default)]
pub struct ImageBundle { pub struct ImageBundle {
/// Describes the size of the node /// Describes the logical size of the node
pub node: Node, pub node: Node,
/// Describes the style including flexbox settings /// Describes the style including flexbox settings
pub style: Style, pub style: Style,
@ -100,7 +100,7 @@ pub struct ImageBundle {
/// A UI node that is text /// A UI node that is text
#[derive(Bundle, Clone, Debug)] #[derive(Bundle, Clone, Debug)]
pub struct TextBundle { pub struct TextBundle {
/// Describes the size of the node /// Describes the logical size of the node
pub node: Node, pub node: Node,
/// Describes the style including flexbox settings /// Describes the style including flexbox settings
pub style: Style, pub style: Style,
@ -194,7 +194,7 @@ impl TextBundle {
/// A UI node that is a button /// A UI node that is a button
#[derive(Bundle, Clone, Debug)] #[derive(Bundle, Clone, Debug)]
pub struct ButtonBundle { pub struct ButtonBundle {
/// Describes the size of the node /// Describes the logical size of the node
pub node: Node, pub node: Node,
/// Marker component that signals this node is a button /// Marker component that signals this node is a button
pub button: Button, pub button: Button,

4
crates/bevy_ui/src/ui_node.rs
View File

@ -15,13 +15,13 @@ use thiserror::Error;
#[derive(Component, Debug, Clone, Reflect)] #[derive(Component, Debug, Clone, Reflect)]
#[reflect(Component, Default)] #[reflect(Component, Default)]
pub struct Node { pub struct Node {
/// The size of the node as width and height in pixels /// The size of the node as width and height in logical pixels
/// automatically calculated by [`super::flex::flex_node_system`] /// automatically calculated by [`super::flex::flex_node_system`]
pub(crate) calculated_size: Vec2, pub(crate) calculated_size: Vec2,
} }
impl Node { impl Node {
/// The calculated node size as width and height in pixels /// The calculated node size as width and height in logical pixels
/// automatically calculated by [`super::flex::flex_node_system`] /// automatically calculated by [`super::flex::flex_node_system`]
pub fn size(&self) -> Vec2 { pub fn size(&self) -> Vec2 {
self.calculated_size self.calculated_size