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

Document VertexAttribute and VertexBinding #96

Open
TheSpydog opened this issue Jul 16, 2024 · 0 comments
Open

Document VertexAttribute and VertexBinding #96

TheSpydog opened this issue Jul 16, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation Required to Ship

Comments

@TheSpydog
Copy link
Collaborator

It's not immediately clear how vertex bindings and attributes relate to each other, and the names of the struct members doesn't elucidate much. Some feedback:

Both have a Uint32 binding; field; I'm guessing the one in SDL_GpuVertexAttribute refers to a SDL_GpuVertexBinding and the one in SDL_GpuVertexBinding to a bound vertex buffer… maybe?

We should add some high-level documentation to the header and potentially rename the binding field of at least one of these structs.

@TheSpydog TheSpydog added the documentation Improvements or additions to documentation label Jul 16, 2024
@flibitijibibo flibitijibibo added Required to Ship and removed documentation Improvements or additions to documentation labels Aug 8, 2024
@flibitijibibo flibitijibibo added the documentation Improvements or additions to documentation label Aug 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation Required to Ship
Projects
None yet
Development

No branches or pull requests

2 participants