Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clarify immediate mode in Gizmos documentation #9183

Merged
merged 7 commits into from
Jul 31, 2023

Conversation

Selene-Amanita
Copy link
Member

Objective

  • Repeat in Gizmos that they are drawned in immediate mode, which is said at the module level but not here, and detail what it means.
  • Clarify for every method of Gizmos that they should be called for every frame.
  • Clarify which methods belong to 3D or 2D space (kinda obvious for 2D but still)

The first time I used gizmos I didn't understand how they work and was confused as to why nothing showed up.

@Selene-Amanita Selene-Amanita added C-Docs An addition or correction to our documentation A-Gizmos Visual editor and debug gizmos labels Jul 17, 2023
@Selene-Amanita Selene-Amanita added this to the 0.11.1 milestone Jul 17, 2023
Copy link
Contributor

@SpecificProtagonist SpecificProtagonist left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should be called every frame when the […] need to be rendered.

The 'when' suggests that these should be called specifically when rendering happens. So I'd remove the 'when' and add to the Gizmos doc that it needs to happen before Last.

Co-authored-by: François <mockersf@gmail.com>
@james7132 james7132 requested a review from mockersf July 17, 2023 17:19
@Selene-Amanita
Copy link
Member Author

Selene-Amanita commented Jul 17, 2023

The 'when' suggests that these should be called specifically when rendering happens. So I'd remove the 'when' and add to the Gizmos doc that it needs to happen before Last.

@SpecificProtagonist Maybe "This should be called for each frame the […] need to be rendered."?

Before the end of Last, or before a specific system in Last?

@SpecificProtagonist
Copy link
Contributor

Maybe "This should be called for each frame the […] need to be rendered."?

Sure, that's fine too.

Before the end of Last, or before a specific system in Last?

Before Last (during which update_gizmo_meshes, which isn't public, runs).

crates/bevy_gizmos/src/gizmos.rs Outdated Show resolved Hide resolved
crates/bevy_gizmos/src/gizmos.rs Outdated Show resolved Hide resolved
crates/bevy_gizmos/src/gizmos.rs Outdated Show resolved Hide resolved
crates/bevy_gizmos/src/gizmos.rs Outdated Show resolved Hide resolved
crates/bevy_gizmos/src/gizmos.rs Show resolved Hide resolved
Selene-Amanita and others added 2 commits July 17, 2023 23:52
Co-authored-by: SpecificProtagonist <vincentjunge@posteo.net>
Selene-Amanita and others added 2 commits July 18, 2023 10:04
Co-authored-by: Alice Cecile <alice.i.cecile@gmail.com>
@Selene-Amanita Selene-Amanita added the S-Ready-For-Final-Review This PR has been approved by the community. It's ready for a maintainer to consider merging it label Jul 18, 2023
@alice-i-cecile alice-i-cecile added this pull request to the merge queue Jul 31, 2023
Merged via the queue into bevyengine:main with commit 8320dc3 Jul 31, 2023
21 checks passed
@Selene-Amanita Selene-Amanita deleted the clarify-gizmos-doc branch July 31, 2023 19:52
cart pushed a commit that referenced this pull request Aug 10, 2023
# Objective

- Repeat in `Gizmos` that they are drawned in immediate mode, which is
said at the module level but not here, and detail what it means.
- Clarify for every method of `Gizmos` that they should be called for
every frame.
- Clarify which methods belong to 3D or 2D space (kinda obvious for 2D
but still)

The first time I used gizmos I didn't understand how they work and was
confused as to why nothing showed up.

---------

Co-authored-by: François <mockersf@gmail.com>
Co-authored-by: SpecificProtagonist <vincentjunge@posteo.net>
Co-authored-by: Alice Cecile <alice.i.cecile@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-Gizmos Visual editor and debug gizmos C-Docs An addition or correction to our documentation S-Ready-For-Final-Review This PR has been approved by the community. It's ready for a maintainer to consider merging it
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants