Add Image! docs to book #652
Conversation
docs/src/image.md
Outdated
| 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` module. For |
There was a problem hiding this comment.
Could this also link to the module docs? i.e. something like
| Some type aliases for common image formats can be found in the `spirv_std::image` module. For | |
| Some type aliases for common image formats can be found in the [`spirv_std::image`](https://embarkstudios.github.io/rust-gpu/api/spirv_std/index.html) module. For |
However, something strange is afoot. That page lists the version as 0.4.0-alpha.9, the latest version. However, it does not list the image module as a seperate module, and lists all the image types as types at the root.
Also, the [src] of Image2d is shown as this, which is afaik not correct.
There was a problem hiding this comment.
This is because the docs are not generated with the const_generics feature, and so the new Image2d doesn't show up (the new one is in the image module)
There was a problem hiding this comment.
Oh, I see sorry. That also solves my other confusion.
| what you want if you want a regular old sampled texture. | ||
|
|
||
| ```rust,no_run | ||
| type Image2d = Image!(2D, type=f32, sampled); |
There was a problem hiding this comment.
| type Image2d = Image!(2D, type=f32, sampled); | |
| // In spirv_std::image | |
| pub type Image2d = Image!(2D, type=f32, sampled); |
docs/src/image.md
Outdated
| type Image2d = Image!(2D, type=f32, sampled); | ||
| ``` | ||
|
|
||
| Note that the `const-generics` feature must be enabled to use the `Image!` macro at the moment. |
There was a problem hiding this comment.
It looks like the feature name is const_generics.
| Note that the `const-generics` feature must be enabled to use the `Image!` macro at the moment. | |
| Note that the `const-generics` cargo feature must be enabled to use the `Image!` macro at the moment. | |
| ```toml | |
| [dependencies] | |
| spirv-std={..., features=["const-generics"]} | |
| ``` |
There was a problem hiding this comment.
I see now that this is a cargo feature, so this would be a Cargo.toml example instead.
Fixes #603