skyler
/
egui
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Improve docstring of `Ui::new_child`

This commit is contained in:
Emil Ernerfeldt 2024-09-19 14:41:18 +02:00
parent 00cb50ebad
commit 5cc35d2212
1 changed files with 8 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
crates/egui/src/ui.rs
View File

@ -222,6 +222,14 @@ impl Ui {
} }
/// Create a child `Ui` with the properties of the given builder. /// Create a child `Ui` with the properties of the given builder.
///
/// This is a very low-level function.
/// Usually you are better off using [`Self::scope_builder`].
///
/// Note that calling this does not allocate any space in the parent `Ui`,
/// so after adding widgets to the child `Ui` you probably want to allocate
/// the [`Ui::min_rect`] of the child in the parent `Ui` using e.g.
/// [`Ui::advance_cursor_after_rect`].
pub fn new_child(&mut self, ui_builder: UiBuilder) -> Self { pub fn new_child(&mut self, ui_builder: UiBuilder) -> Self {
let UiBuilder { let UiBuilder {
id_salt, id_salt,