Skip to content

Commit 4089f8a

Browse files
More breadcrumbs
1 parent 44a4101 commit 4089f8a

File tree

1 file changed

+12
-2
lines changed

1 file changed

+12
-2
lines changed

crates/bevy_text/src/input.rs

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,12 @@
1919
//! * These are applied by the [`apply_text_edits` system.
2020
//! * [`TextInputTarget`] - Details of the render target the text input will be rendered to, such as size and scale factor.
2121
//!
22+
//!
23+
//! Layouting is done in:
24+
//!
25+
//! * [`update_text_input_layouts`] - Updates the `TextLayoutInfo` for each text input for rendering.
26+
//! * [`update_placeholder_layouts`] - Updates the `TextLayoutInfo` for each [`Placeholder`] for rendering.
27+
//!
2228
//! ## Configuring text input
2329
//!
2430
//! Several components are used to configure the text input, and belong on the [`TextInputBuffer`] entity:
@@ -337,9 +343,11 @@ impl TextInputFilter {
337343
/// Add this component to hide the text input buffer contents
338344
/// by replacing the characters with `mask_char`.
339345
///
340-
/// It is strongly recommended to only use a `PasswordMask` with fixed-width fonts.
346+
/// It is strongly recommended to only use a [`PasswordMask` with fixed-width fonts.
341347
/// With variable width fonts mouse picking and horizontal scrolling
342348
/// may not work correctly.
349+
///
350+
/// This is updated in [`update_password_masks`].
343351
#[derive(Component)]
344352
pub struct PasswordMask {
345353
/// If true the password will not be hidden
@@ -1143,7 +1151,9 @@ impl Placeholder {
11431151
}
11441152
}
11451153

1146-
/// Layout for the [`Placeholder`] text
1154+
/// Layout for the [`Placeholder`] text.
1155+
///
1156+
/// This is laid out in [`update_placeholder_layouts`].
11471157
#[derive(Component)]
11481158
pub struct PlaceholderLayout {
11491159
/// A [`Placeholder`] text's cosmic-text buffer (not an Editor as it isn't editable).

0 commit comments

Comments
 (0)