bevy/examples/stress_tests
ickshonpe 166686e0f2
Rename TextAlignment to JustifyText. (#10854)
# Objective

The name `TextAlignment` is really deceptive and almost every new user
gets confused about the differences between aligning text with
`TextAlignment`, aligning text with `Style` and aligning text with
anchor (when using `Text2d`).

## Solution

* Rename `TextAlignment` to `JustifyText`. The associated helper methods
are also renamed.
* Improve the doc comments for text explaining explicitly how the
`JustifyText` component affects the arrangement of text.
* Add some extra cases to the `text_debug` example that demonstate the
differences between alignment using `JustifyText` and alignment using
`Style`.
<img width="757" alt="text_debug_2"
src="https://github.com/bevyengine/bevy/assets/27962798/9d53e647-93f9-4bc7-8a20-0d9f783304d2">

---

## Changelog
* `TextAlignment` has been renamed to `JustifyText`
* `TextBundle::with_text_alignment` has been renamed to
`TextBundle::with_text_justify`
* `Text::with_alignment` has been renamed to `Text::with_justify`
* The `text_alignment` field of `TextMeasureInfo` has been renamed to
`justification`

## Migration Guide
* `TextAlignment` has been renamed to `JustifyText`
* `TextBundle::with_text_alignment` has been renamed to
`TextBundle::with_text_justify`
* `Text::with_alignment` has been renamed to `Text::with_justify`
* The `text_alignment` field of `TextMeasureInfo` has been renamed to
`justification`
2023-12-05 03:00:41 +00:00
..
bevymark.rs Substitute get(0) with first() (#10847) 2023-12-02 22:13:42 +00:00
many_animated_sprites.rs Use a consistent scale factor and resolution in stress tests (#10474) 2023-11-09 22:05:32 +00:00
many_buttons.rs Override QueryIter::fold to port Query::for_each perf gains to select Iterator combinators (#6773) 2023-12-01 09:09:55 +00:00
many_cubes.rs Substitute get(0) with first() (#10847) 2023-12-02 22:13:42 +00:00
many_foxes.rs Use a consistent scale factor and resolution in stress tests (#10474) 2023-11-09 22:05:32 +00:00
many_gizmos.rs Use a consistent scale factor and resolution in stress tests (#10474) 2023-11-09 22:05:32 +00:00
many_glyphs.rs Rename TextAlignment to JustifyText. (#10854) 2023-12-05 03:00:41 +00:00
many_lights.rs Add clippy::manual_let_else at warn level to lints (#10684) 2023-11-28 04:15:27 +00:00
many_sprites.rs Use a consistent scale factor and resolution in stress tests (#10474) 2023-11-09 22:05:32 +00:00
README.md Add a stress test profile (#6901) 2022-12-20 15:59:41 +00:00
text_pipeline.rs Rename TextAlignment to JustifyText. (#10854) 2023-12-05 03:00:41 +00:00
transform_hierarchy.rs Remove some old references to CoreSet (#9833) 2023-09-18 01:07:11 +00:00
warning_string.txt Added performance warning when running stress test examples in debug mode (#5029) 2022-07-13 19:13:46 +00:00

Stress tests

These examples are used to stress test Bevy's performance in various ways. These should be run with the "stress-test" profile to accurately represent performance in production, otherwise they will run in cargo's default "dev" profile which is very slow.

Example Command

cargo run --profile stress-test --example <EXAMPLE>