Add sampled to example (#659)

This commit is contained in:
Ashley Hauck 2021-06-09 12:17:08 +02:00 committed by GitHub
parent 56722c72d6
commit 0b23a4282f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -81,7 +81,7 @@ use quote::ToTokens;
/// A basic example looks like this:
/// ```no_compile
/// #[spirv(vertex)]
/// fn main(#[spirv(descriptor_set = 0, binding = 0)] image: &Image!(2D, type=f32)) {}
/// fn main(#[spirv(descriptor_set = 0, binding = 0)] image: &Image!(2D, type=f32, sampled)) {}
/// ```
///
/// ## Arguments
@ -91,15 +91,15 @@ use quote::ToTokens;
/// - `type` — The sampled type of an image, mutually exclusive with `format`,
/// when set the image format is unknown. Accepted values: `f32`, `f64`,
/// `u8`, `u16`, `u32`, `u64`, `i8`, `i16`, `i32`, `i64`.
/// - `format` — The image format of the image, mutually exclusive with `type`,
/// - `format` — The image format of the image, mutually exclusive with `type`.
/// Accepted values: Camel case versions of [`ImageFormat`].
/// - `sampled` — Whether it is known that the image will be used with a sampler
/// at compile time, Accepted values: `true` or `false`. Default: `unknown`.
/// at compile time. Accepted values: `true` or `false`. Default: `unknown`.
/// - `multisampled` — Whether the image contains multisampled content. Accepted
/// values: `true` or `false`. Default: `false`.
/// - `arrayed` — Whether the image contains arrayed content. Accepted
/// values: `true` or `false`. Default: `false`.
/// - `depth` — Whether it is known that the image is a depth image,
/// - `depth` — Whether it is known that the image is a depth image.
/// Accepted values: `true` or `false`. Default: `unknown`.
///
/// [`ImageFormat`]: spirv_types::image_params::ImageFormat