Zig 0.17.0-dev (Split by item) This is an example of documentation generated by
ZigDoc , an alternative to Zig's built-in
Auto Doc feature. See also
examples in other modes/formats . The project being documented here (as the example) is the Zig standard library.
std › spirv › imageQuerySize Public Function imageQuerySize Doc Source Public Function std.spirv.imageQuerySize
pub fn imageQuerySize (
image : anytype ,
) ImageCoordinate (std .meta .Child (@TypeOf (image )), u32 ) Params File spirv.zig: 186
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216 pub fn imageQuerySize (
image : anytype ,
) ImageCoordinate (std .meta .Child (@TypeOf (image )), u32 ) {
const Image = switch (@typeInfo (@TypeOf (image ))) {
.pointer => |pointer | pointer .child ,
else => @compileError ("Expected a pointer to SPIR-V image type, found '" ++ @typeName (@TypeOf (image )) ++ "'" ),
};
const image_info = switch (@typeInfo (Image )) {
.spirv => |spirv | switch (spirv ) {
.image => |info | info ,
else => @compileError ("Expected SPIR-V image type, found '" ++ @typeName (Image ) ++ "'" ),
},
else => @compileError ("Expected SPIR-V image type, found '" ++ @typeName (Image ) ++ "'" ),
};
// TODO: Remove this check if dimension is not 1d, 2d, 3d, or cube (in case buffer is added).
if (!image_info .multisampled and image_info .usage != .unknown and image_info .usage != .storage )
@compileError ("SPIR-V image must be either be multisampled or have an unknown or storage usage" );
const Result = ImageCoordinate (std .meta .Child (@TypeOf (image )), u32 );
return asm volatile (
\\%loaded_image = OpLoad %Image %image
\\%ret = OpImageQuerySize %Result %loaded_image
: [ret ] "" (-> Result ),
: [Image ] "t" (Image ),
[image ] "" (image ),
[Result ] "t" (Result ),
);
}
Query the dimensions of
image, with no level of detail.