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

UiTargetCamera doc comment correction #18216

Merged

Conversation

ickshonpe
Copy link
Contributor

@ickshonpe ickshonpe commented Mar 9, 2025

Objective

As pointed out in #18177 this line in the doc comment for UiTargetCamera:

/// Optional if there is only one camera in the world. Required otherwise.

is incorrect. UiTargetCamera component is only needed when you want to display UI nodes using a camera other than the default camera.

Solution

Change it to:

/// Root node's without an explicit [`UiTargetCamera`] will be rendered to the default UI camera,
/// which is either a single camera with the [`IsDefaultUiCamera`] marker component or the highest
/// order camera targeting the primary window.

@ickshonpe ickshonpe added C-Docs An addition or correction to our documentation A-Rendering Drawing game state to the screen A-UI Graphical user interfaces, styles, layouts, and widgets S-Needs-Review Needs reviewer attention (from anyone!) to move forward D-Trivial Nice and easy! A great choice to get started with Bevy labels Mar 9, 2025
@alice-i-cecile alice-i-cecile enabled auto-merge March 9, 2025 22:42
@alice-i-cecile alice-i-cecile added S-Ready-For-Final-Review This PR has been approved by the community. It's ready for a maintainer to consider merging it and removed S-Needs-Review Needs reviewer attention (from anyone!) to move forward labels Mar 9, 2025
@alice-i-cecile alice-i-cecile added this pull request to the merge queue Mar 9, 2025
Merged via the queue into bevyengine:main with commit 8980be9 Mar 9, 2025
37 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-Rendering Drawing game state to the screen A-UI Graphical user interfaces, styles, layouts, and widgets C-Docs An addition or correction to our documentation D-Trivial Nice and easy! A great choice to get started with Bevy S-Ready-For-Final-Review This PR has been approved by the community. It's ready for a maintainer to consider merging it
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

2 participants