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

Documentation todos #1920

Merged
merged 6 commits into from Jul 13, 2022
Merged

Documentation todos #1920

merged 6 commits into from Jul 13, 2022

Conversation

JMicheli
Copy link
Contributor

@JMicheli JMicheli commented Jul 4, 2022

This PR addresses a number of items (mostly) related to documentation/commenting and marked "TODO" in the repository.

Specifically it:

  • Shortens the syntax for specifying image attachment usage in examples/src/bin/deferred/frame/system.rs as noted in a TODO.
    • This required adding a new function to ImageUseage, transient_input_attachment(), which creates an ImageUseage with the appropriate settings for that use. This is likely to be useful in other instances as well (see vulkano/src/image/usage.rs).
  • Adds a small paragraph describing push constants to examples/src/bin/push-constants.rs (note that the language used was borrowed and adapted from the Vulkan specification for accuracy).
  • Removes a TODO that was directed at users instead of maintainers in examples/src/bin/texture_array/main.rs.
  • Adds a detailed explanation of the shader! macro to examples/src/bin/triangle-v1_3.rs and examples/src/bin/triangle.rs.
  • Adds an actual example of generating a command buffer that would do something to the documentation in vulkano/src/command_buffer/mod.rs.
  • Adds checks for max_framebuffer_height, max_framebuffer_width, and max_framebuffer_layers compliance to the constructor for ImageAttachment (see vulkano/src/image/attachment.rs).

All tests pass on my machine. This is my first ever pull request to a team project, so please forgive any errors I may have made. I am happy to make changes as needed to get this into shape for inclusion in the master branch.

@Rua Rua merged commit e8cf282 into vulkano-rs:master Jul 13, 2022
@JMicheli JMicheli deleted the documentation-todos branch July 18, 2022 15:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants