From 8ee3c414f086a83136d61bfdcf46ac246474f5dc Mon Sep 17 00:00:00 2001 From: Jim Blandy Date: Wed, 6 Mar 2024 07:38:45 -0800 Subject: [PATCH] [naga] Document return types of image query operations. --- naga/src/lib.rs | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/naga/src/lib.rs b/naga/src/lib.rs index 8773f1225d..b3e1e585df 100644 --- a/naga/src/lib.rs +++ b/naga/src/lib.rs @@ -1256,15 +1256,18 @@ pub enum SampleLevel { #[cfg_attr(feature = "arbitrary", derive(Arbitrary))] pub enum ImageQuery { /// Get the size at the specified level. + /// + /// The return value is a `u32` for 1D images, and a `vecN` + /// for an image with dimensions N > 2. Size { /// If `None`, the base level is considered. level: Option>, }, - /// Get the number of mipmap levels. + /// Get the number of mipmap levels, a `u32`. NumLevels, - /// Get the number of array layers. + /// Get the number of array layers, a `u32`. NumLayers, - /// Get the number of samples. + /// Get the number of samples, a `u32`. NumSamples, }