mirror of
https://github.com/EmbarkStudios/rust-gpu.git
synced 2024-11-25 16:25:25 +00:00
Add Image! docs to book (#652)
This commit is contained in:
parent
0b23a4282f
commit
64380d609a
@ -10,5 +10,6 @@
|
|||||||
- [Features]()
|
- [Features]()
|
||||||
- [Attribute syntax](./attributes.md)
|
- [Attribute syntax](./attributes.md)
|
||||||
- [Inline Assembly](./inline-asm.md)
|
- [Inline Assembly](./inline-asm.md)
|
||||||
|
- [Image type syntax](./image.md)
|
||||||
- [RFCs]()
|
- [RFCs]()
|
||||||
- [001. Resource Binding Syntax](./rfcs/001-resource-binding-syntax.md)
|
- [001. Resource Binding Syntax](./rfcs/001-resource-binding-syntax.md)
|
||||||
|
26
docs/src/image.md
Normal file
26
docs/src/image.md
Normal file
@ -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"] }
|
||||||
|
```
|
Loading…
Reference in New Issue
Block a user