Text2d visibility fix by ickshonpe · Pull Request #9708 · bevyengine/bevy

ickshonpe · 2023-09-06T00:15:56Z

Objective

Text drawn with Text2d isn't visible in main.

Solution

Add an ExtractedSpriteBatches resource that allows the extraction of sprites in batches that all share the same entity for visibility checks.

In extract_text2d_sprite extract to ExtractedSpriteBatches rather than ExtractedSprites.

This is a bit of a hack but it's harmless and minimal.

My first attempt had three buffers:

Set of all Text2d entities with their Entity, Transform, and a range into buffer 2.
Vec of ExtractedGlyphSections. Each ExtractedGlyphSection has a handle for the font's atlas texture, color, and a range of indices into buffer 3.
Vec of ExtractedGlyphs. Each ExtractedGlyph has a position (relative to the transform) and a Rect containing coords of the glyph in the font's atlas texture.

I struggled to get it to work though. It was almost there but there were some weird texturing issues I couldn't work out even after spending half a day on it:

---

I still don't understand Bevy's rendering internals very well, so it could be anything.

Anyway, I decided to switch approach. This PR is deliberately as simple as I could make it. It fixes Text2d rendering and shouldn't introduce any new problems or have any significant performance costs. The implementations of ExtractedSpriteBatches and extract_text2d_sprites aren't super efficient, but naive benchmarks suggest this Text2d is faster than 0.11.2's Text2d by about 5-10% (probably entirely due to the improvements in bevy_sprites).

cargo run --profile stress-test --features trace_tracy --example many_sprites

(yellow is this PR, red is main)

The main drawback is that ExtractedSpriteBatches is exposed as public, I'd rather have kept it private as it's not really suitable for much else except text rendering.

Changelog

Added ExtractedSpriteBatches.
Modified queue_sprites and prepare_sprites so they also add the sprites from ExtractedSpriteBatches.
extract_text2d_sprite extracts to ExtractedSpriteBatches instead of ExtractedSprites.

…that all share the same entity for visibility checks. Then `extracted_text2d_sprite` extracts into `ExtractedSpriteBatches` instead of `ExtractedSprites` and text drawn with `Text2d` is visible again.

crates/bevy_sprite/src/render/mod.rs

alice-i-cecile · 2023-09-06T00:20:28Z

crates/bevy_sprite/src/render/mod.rs

        }
+
+        for (batch_entity, sprite_entities) in extracted_batches.batches.iter() {
+            if !view_entities.contains(batch_entity.index() as usize) {


This could use a bit of a comment: it's really quite unusual to care about the index of an Entity.

The original code wasn't commented either, I'm confident these changes work and don't mess anything up but I don't know enough about the rendering internals to be explaining anything to anyone I think.

…e vec for each batch.

mnmaita · 2023-09-13T01:16:37Z

crates/bevy_sprite/src/render/mod.rs

    pub sprites: SparseSet<Entity, ExtractedSprite>,
 }

+/// Allows extraction of multiply sprites for a single entity that all share that entity's id for visibility resolution.


Suggested change

/// Allows extraction of multiply sprites for a single entity that all share that entity's id for visibility resolution.

/// Allows the extraction of multiple sprites sharing the same entity id for visibility resolution.

I think there's a typo here (multiply -> multiple). I'm also leaving a suggestion to rephrase the comment, hopefully it still conveys the same meaning.

rparrett · 2023-10-12T15:33:19Z

I'm assuming that this needs a major rework after #9685 and #9903?

superdump · 2023-10-13T19:05:05Z

I prefer #10100 if it fixes the same problem.

superdump · 2023-10-13T19:15:58Z

Closing due to merging #10100 If that PR doesn’t address the problem, you’re welcome to come shout at me. 💜

# Objective Fixes #9676 Possible alternative to #9708 `Text2dBundles` are not currently drawn because the render-world-only entities for glyphs that are created in `extract_text2d_sprite` are not tracked by the per-view `VisibleEntities`. ## Solution Add an `Option<Entity>` to `ExtractedSprite` that keeps track of the original entity that caused a "glyph entity" to be created. Use that in `queue_sprites` if it exists when checking view visibility. ## Benchmarks Quick benchmarks. Average FPS over 1500 frames. | bench | before fps | after fps | diff | |-|-|-|-| |many_sprites|884.93|879.00|🟡 -0.7%| |bevymark -- --benchmark --waves 100 --per-wave 1000 --mode sprite|75.99|75.93|🟡 -0.1%| |bevymark -- --benchmark --waves 50 --per-wave 1000 --mode mesh2d|32.85|32.58|🟡 -0.8%|

# Objective Fixes bevyengine#9676 Possible alternative to bevyengine#9708 `Text2dBundles` are not currently drawn because the render-world-only entities for glyphs that are created in `extract_text2d_sprite` are not tracked by the per-view `VisibleEntities`. ## Solution Add an `Option<Entity>` to `ExtractedSprite` that keeps track of the original entity that caused a "glyph entity" to be created. Use that in `queue_sprites` if it exists when checking view visibility. ## Benchmarks Quick benchmarks. Average FPS over 1500 frames. | bench | before fps | after fps | diff | |-|-|-|-| |many_sprites|884.93|879.00|🟡 -0.7%| |bevymark -- --benchmark --waves 100 --per-wave 1000 --mode sprite|75.99|75.93|🟡 -0.1%| |bevymark -- --benchmark --waves 50 --per-wave 1000 --mode mesh2d|32.85|32.58|🟡 -0.8%|

ickshonpe added 3 commits September 5, 2023 21:50

Almost working but corrupted text with multiple fonts

fb0f05e

Adds ExtractedSpriteBatches. This allows adding sprites in batches …

edfdbaf

…that all share the same entity for visibility checks. Then `extracted_text2d_sprite` extracts into `ExtractedSpriteBatches` instead of `ExtractedSprites` and text drawn with `Text2d` is visible again.

cargo fmt --all

068098f

alice-i-cecile added C-Bug An unexpected or incorrect behavior A-Rendering Drawing game state to the screen A-UI Graphical user interfaces, styles, layouts, and widgets P-High This is particularly urgent, and deserves immediate attention labels Sep 6, 2023

alice-i-cecile added this to the 0.12 milestone Sep 6, 2023

alice-i-cecile reviewed Sep 6, 2023

View reviewed changes

crates/bevy_sprite/src/render/mod.rs Show resolved Hide resolved

alice-i-cecile reviewed Sep 6, 2023

View reviewed changes

cargo fmt, reduced changes

87c1b1e

JMS55 requested a review from superdump September 6, 2023 00:30

ickshonpe added 2 commits September 8, 2023 13:21

Batches now hold a range into a vec of entities, instead of a separat…

0b76079

…e vec for each batch.

cargo fmt

033d1c5

mockersf approved these changes Sep 8, 2023

View reviewed changes

ickshonpe mentioned this pull request Sep 9, 2023

TextLayoutInfo::size should hold the drawn size of the text, and not a scaled value. #7794

Merged

mnmaita reviewed Sep 13, 2023

View reviewed changes

rparrett mentioned this pull request Oct 12, 2023

Fix text2d view-visibility #10100

Merged

antoniacobaeus mentioned this pull request Oct 13, 2023

Update texture_atlas example with different padding and sampling #10073

Merged

superdump closed this Oct 13, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Text2d visibility fix#9708

Text2d visibility fix#9708
ickshonpe wants to merge 6 commits intobevyengine:mainfrom
ickshonpe:text2d-visibility-fix

ickshonpe commented Sep 6, 2023 •

edited

Loading

Uh oh!

Uh oh!

alice-i-cecile Sep 6, 2023

Uh oh!

ickshonpe Sep 7, 2023

Uh oh!

mnmaita Sep 13, 2023

Uh oh!

rparrett commented Oct 12, 2023

Uh oh!

superdump commented Oct 13, 2023

Uh oh!

superdump commented Oct 13, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

	/// Allows extraction of multiply sprites for a single entity that all share that entity's id for visibility resolution.
	/// Allows the extraction of multiple sprites sharing the same entity id for visibility resolution.

Uh oh!

Conversation

ickshonpe commented Sep 6, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Objective

Solution

Changelog

Uh oh!

Uh oh!

alice-i-cecile Sep 6, 2023

Choose a reason for hiding this comment

Uh oh!

ickshonpe Sep 7, 2023

Choose a reason for hiding this comment

Uh oh!

mnmaita Sep 13, 2023

Choose a reason for hiding this comment

Uh oh!

rparrett commented Oct 12, 2023

Uh oh!

superdump commented Oct 13, 2023

Uh oh!

superdump commented Oct 13, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

ickshonpe commented Sep 6, 2023 •

edited

Loading