-
Notifications
You must be signed in to change notification settings - Fork 244
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 Image! docs to book #652
Merged
+27
−0
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains 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
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
# Image type syntax | ||
|
||
There are a huge number of combinations of image types in SPIR-V. They are represented by a const | ||
generic type called `spirv_std::image::Image`, however, specifying the generic parameters of this | ||
type is incredibly tedious, so a wrapper macro, `spirv_std::Image!` can be used to write the type | ||
instead. | ||
|
||
The specific syntax and meaning of the arguments to the `Image!` macro can be found in | ||
[rustdoc](https://embarkstudios.github.io/rust-gpu/api/spirv_std/macro.Image.html). | ||
|
||
Some type aliases for common image formats can be found in the | ||
[`spirv_std::image`](https://embarkstudios.github.io/rust-gpu/api/spirv_std/image/index.html) | ||
module. For example, `Image2d` is a very commonly used type, corresponding to `texture2D` in GLSL, | ||
and is likely what you want if you want a regular old sampled texture. | ||
|
||
```rust,no_run | ||
type Image2d = Image!(2D, type=f32, sampled); | ||
``` | ||
|
||
Note that the `const-generics` cargo feature in spirv-std must be enabled to use the `Image!` macro | ||
at the moment. This will likely change in the near future. | ||
|
||
```toml | ||
[dependencies] | ||
spirv-std = { ..., features = ["const-generics"] } | ||
``` |
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.