Make the get function on InstanceInputUniformBuffer less error prone
#17131
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Welcome, new contributor! Please make sure you've read our contributing guide and we look forward to reviewing your pull request shortly ✨ |
BenjaminBrienen
approved these changes
Jan 3, 2025
BenjaminBrienen
added
C-Feature
|
It looks like your PR is a breaking change, but you didn't provide a migration guide. Could you add some context on what users should update when this change get released in a new version of Bevy? |
IceSentry
approved these changes
Jan 4, 2025
IceSentry
added
S-Ready-For-Final-Review
LikeLakers2
reviewed
Jan 4, 2025
mrchantey
pushed a commit
to mrchantey/bevy
that referenced
this pull request
Feb 4, 2025
…one (bevyengine#17131) # Objective the `get` function on [`InstanceInputUniformBuffer`] seems very error-prone. This PR hopes to fix this. ## Solution Do a few checks to ensure the index is in bounds and that the `BDI` is not removed. Return `Option<BDI>` instead of `BDI`. ## Testing - Did you test these changes? If so, how? added a test to verify that the instance buffer works correctly ## Future Work Performance decreases when using .binary_search(). However this is likely due to the fact that [`InstanceInputUniformBuffer::get`] for now is never used, and only get_unchecked. ## Migration Guide `InstanceInputUniformBuffer::get` now returns `Option<BDI>` instead of `BDI` to reduce panics. If you require the old functionality of `InstanceInputUniformBuffer::get` consider using `InstanceInputUniformBuffer::get_unchecked`. --------- Co-authored-by: Tim Overbeek <oorbeck@gmail.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Objective
the
getfunction on [InstanceInputUniformBuffer] seems very error-prone. This PR hopes to fix this.Solution
Do a few checks to ensure the index is in bounds and that the
BDIis not removed.Return
Option<BDI>instead ofBDI.Testing
added a test to verify that the instance buffer works correctly
Future Work
Performance decreases when using .binary_search(). However this is likely due to the fact that [
InstanceInputUniformBuffer::get] for now is never used, and only get_unchecked.Migration Guide
InstanceInputUniformBuffer::getnow returnsOption<BDI>instead ofBDIto reduce panics. If you require the old functionality ofInstanceInputUniformBuffer::getconsider usingInstanceInputUniformBuffer::get_unchecked.