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

Add docs to custom vertex attribute example #17422

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

ChristopherBiscardi
Copy link
Contributor

Objective

The gltf-json crate seems like it strips/adds an _ when doing the name comparison for custom vertex attributes.

The bevy example gltf: barycentric.gltf, includes two underscores: __BARYCENTRIC in the gltf file, resulting in needing _BARYCENTRIC (one underscore) as the attribute name in Bevy. This extra underscore is redundant and does not appear if exporting from blender, which only requires a single underscore to trigger the attribute export.

I'm not sure if we want to change the example itself (maybe there's a reason it has two underscores, I couldn't find a reason), but a docs comment would help.

Solution

add docs detailing the behavior

@ChristopherBiscardi ChristopherBiscardi added C-Docs An addition or correction to our documentation S-Needs-Review Needs reviewer attention (from anyone!) to move forward labels Jan 18, 2025
@alice-i-cecile alice-i-cecile added A-Rendering Drawing game state to the screen and removed S-Needs-Review Needs reviewer attention (from anyone!) to move forward labels Jan 19, 2025
Copy link
Member

@alice-i-cecile alice-i-cecile left a comment

Choose a reason for hiding this comment

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

That's... aggravating. It's better to call this out than doing nothing, but I hate this behavior.

@alice-i-cecile alice-i-cecile 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 Jan 19, 2025
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-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
Status: No status
Development

Successfully merging this pull request may close these issues.

3 participants