Skip to content

Clarify purpose of shader_instancing example#15456

Merged
alice-i-cecile merged 6 commits intobevyengine:mainfrom
IceSentry:gpu-instancing-example-docs
Sep 30, 2024
Merged

Clarify purpose of shader_instancing example#15456
alice-i-cecile merged 6 commits intobevyengine:mainfrom
IceSentry:gpu-instancing-example-docs

Conversation

@IceSentry
Copy link
Copy Markdown
Contributor

@IceSentry IceSentry commented Sep 26, 2024

Objective

  • The shader_instancing example can be misleading since it doesn't explain that bevy has built in automatic instancing.

Solution

  • Explain that bevy has built in instancing and that this example is for advanced users.
  • Add a new automatic_instancing example that shows how to use the built in automatic instancing
  • Rename the shader_instancing example to custom_shader_instancing to highlight that this is a more advanced implementation

@IceSentry IceSentry changed the title Clarify gpu instancing example Clarify purpose of shader_instancing example Sep 26, 2024
@IceSentry IceSentry added A-Rendering Drawing game state to the screen C-Examples An addition or correction to our examples labels Sep 26, 2024
Copy link
Copy Markdown
Contributor

@ChristopherBiscardi ChristopherBiscardi left a comment

Choose a reason for hiding this comment

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

common question answered in the place the people asking are likely looking

@IceSentry IceSentry requested a review from JMS55 September 26, 2024 20:38
Copy link
Copy Markdown
Member

@tychedelia tychedelia left a comment

Choose a reason for hiding this comment

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

Hopefully will avoid a lot of confusion in the future!

@tychedelia tychedelia 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 Sep 26, 2024
Copy link
Copy Markdown
Contributor

@JMS55 JMS55 left a comment

Choose a reason for hiding this comment

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

Approved with some minor suggested tweaks to wording

Co-authored-by: JMS55 <47158642+JMS55@users.noreply.github.com>
@alice-i-cecile alice-i-cecile added this pull request to the merge queue Sep 30, 2024
Merged via the queue into bevyengine:main with commit 120d664 Sep 30, 2024
robtfm pushed a commit to robtfm/bevy that referenced this pull request Oct 4, 2024
# Objective

- The shader_instancing example can be misleading since it doesn't
explain that bevy has built in automatic instancing.

## Solution

- Explain that bevy has built in instancing and that this example is for
advanced users.
- Add a new automatic_instancing example that shows how to use the built
in automatic instancing
- Rename the shader_instancing example to custom_shader_instancing to
highlight that this is a more advanced implementation

---------

Co-authored-by: JMS55 <47158642+JMS55@users.noreply.github.com>
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 C-Examples An addition or correction to our examples S-Ready-For-Final-Review This PR has been approved by the community. It's ready for a maintainer to consider merging it

Projects

No open projects
Status: Done

Development

Successfully merging this pull request may close these issues.

5 participants