naga/back/glsl/writer.rs
1use super::*;
2
3/// Writer responsible for all code generation.
4#[expect(missing_debug_implementations, reason = "would be way too verbose?")]
5pub struct Writer<'a, W> {
6 // Inputs
7 /// The module being written.
8 pub(in crate::back::glsl) module: &'a crate::Module,
9 /// The module analysis.
10 pub(in crate::back::glsl) info: &'a valid::ModuleInfo,
11 /// The output writer.
12 out: W,
13 /// User defined configuration to be used.
14 pub(in crate::back::glsl) options: &'a Options,
15 /// The bound checking policies to be used
16 pub(in crate::back::glsl) policies: proc::BoundsCheckPolicies,
17
18 // Internal State
19 /// Features manager used to store all the needed features and write them.
20 pub(in crate::back::glsl) features: FeaturesManager,
21 namer: proc::Namer,
22 /// A map with all the names needed for writing the module
23 /// (generated by a [`Namer`](crate::proc::Namer)).
24 names: crate::FastHashMap<NameKey, String>,
25 /// A map with the names of global variables needed for reflections.
26 reflection_names_globals: crate::FastHashMap<Handle<crate::GlobalVariable>, String>,
27 /// The selected entry point.
28 pub(in crate::back::glsl) entry_point: &'a crate::EntryPoint,
29 /// The index of the selected entry point.
30 pub(in crate::back::glsl) entry_point_idx: proc::EntryPointIndex,
31 /// A generator for unique block numbers.
32 block_id: IdGenerator,
33 /// Set of expressions that have associated temporary variables.
34 named_expressions: crate::NamedExpressions,
35 /// Set of expressions that need to be baked to avoid unnecessary repetition in output
36 need_bake_expressions: back::NeedBakeExpressions,
37 /// Information about nesting of loops and switches.
38 ///
39 /// Used for forwarding continue statements in switches that have been
40 /// transformed to `do {} while(false);` loops.
41 continue_ctx: back::continue_forward::ContinueCtx,
42 /// How many views to render to, if doing multiview rendering.
43 pub(in crate::back::glsl) multiview: Option<core::num::NonZeroU32>,
44 /// Mapping of varying variables to their location. Needed for reflections.
45 varying: crate::FastHashMap<String, VaryingLocation>,
46 /// Number of user-defined clip planes. Only non-zero for vertex shaders.
47 clip_distance_count: u32,
48}
49
50impl<'a, W: Write> Writer<'a, W> {
51 /// Creates a new [`Writer`] instance.
52 ///
53 /// # Errors
54 /// - If the version specified is invalid or supported.
55 /// - If the entry point couldn't be found in the module.
56 /// - If the version specified doesn't support some used features.
57 pub fn new(
58 out: W,
59 module: &'a crate::Module,
60 info: &'a valid::ModuleInfo,
61 options: &'a Options,
62 pipeline_options: &'a PipelineOptions,
63 policies: proc::BoundsCheckPolicies,
64 ) -> Result<Self, Error> {
65 // Check if the requested version is supported
66 if !options.version.is_supported() {
67 log::error!("Version {}", options.version);
68 return Err(Error::VersionNotSupported);
69 }
70
71 // Try to find the entry point and corresponding index
72 let ep_idx = module
73 .entry_points
74 .iter()
75 .position(|ep| {
76 pipeline_options.shader_stage == ep.stage && pipeline_options.entry_point == ep.name
77 })
78 .ok_or(Error::EntryPointNotFound)?;
79
80 // Generate a map with names required to write the module
81 let mut names = crate::FastHashMap::default();
82 let mut namer = proc::Namer::default();
83 namer.reset(
84 module,
85 &keywords::RESERVED_KEYWORD_SET,
86 proc::KeywordSet::empty(),
87 proc::CaseInsensitiveKeywordSet::empty(),
88 &[
89 "gl_", // all GL built-in variables
90 "_group", // all normal bindings
91 "_immediates_binding_", // all immediate data bindings
92 ],
93 &mut names,
94 );
95
96 // Build the instance
97 let mut this = Self {
98 module,
99 info,
100 out,
101 options,
102 policies,
103
104 namer,
105 features: FeaturesManager::new(),
106 names,
107 reflection_names_globals: crate::FastHashMap::default(),
108 entry_point: &module.entry_points[ep_idx],
109 entry_point_idx: ep_idx as u16,
110 multiview: pipeline_options.multiview,
111 block_id: IdGenerator::default(),
112 named_expressions: Default::default(),
113 need_bake_expressions: Default::default(),
114 continue_ctx: back::continue_forward::ContinueCtx::default(),
115 varying: Default::default(),
116 clip_distance_count: 0,
117 };
118
119 // Find all features required to print this module
120 this.collect_required_features()?;
121
122 Ok(this)
123 }
124
125 /// Writes the [`Module`](crate::Module) as glsl to the output
126 ///
127 /// # Notes
128 /// If an error occurs while writing, the output might have been written partially
129 ///
130 /// # Panics
131 /// Might panic if the module is invalid
132 pub fn write(&mut self) -> Result<ReflectionInfo, Error> {
133 // We use `writeln!(self.out)` throughout the write to add newlines
134 // to make the output more readable
135
136 let es = self.options.version.is_es();
137
138 // Write the version (It must be the first thing or it isn't a valid glsl output)
139 writeln!(self.out, "#version {}", self.options.version)?;
140 // Write all the needed extensions
141 //
142 // This used to be the last thing being written as it allowed to search for features while
143 // writing the module saving some loops but some older versions (420 or less) required the
144 // extensions to appear before being used, even though extensions are part of the
145 // preprocessor not the processor ¯\_(ツ)_/¯
146 self.features.write(self.options, &mut self.out)?;
147
148 // glsl es requires a precision to be specified for floats and ints
149 // TODO: Should this be user configurable?
150 if es {
151 writeln!(self.out)?;
152 writeln!(self.out, "precision highp float;")?;
153 writeln!(self.out, "precision highp int;")?;
154 writeln!(self.out)?;
155 }
156
157 if self.entry_point.stage == ShaderStage::Compute {
158 let workgroup_size = self.entry_point.workgroup_size;
159 writeln!(
160 self.out,
161 "layout(local_size_x = {}, local_size_y = {}, local_size_z = {}) in;",
162 workgroup_size[0], workgroup_size[1], workgroup_size[2]
163 )?;
164 writeln!(self.out)?;
165 }
166
167 if self.entry_point.stage == ShaderStage::Vertex
168 && !self
169 .options
170 .writer_flags
171 .contains(WriterFlags::DRAW_PARAMETERS)
172 && self.features.contains(Features::INSTANCE_INDEX)
173 {
174 writeln!(self.out, "uniform uint {FIRST_INSTANCE_BINDING};")?;
175 writeln!(self.out)?;
176 }
177
178 // Enable early depth tests if needed
179 if let Some(early_depth_test) = self.entry_point.early_depth_test {
180 // If early depth test is supported for this version of GLSL
181 if self.options.version.supports_early_depth_test() {
182 match early_depth_test {
183 crate::EarlyDepthTest::Force => {
184 writeln!(self.out, "layout(early_fragment_tests) in;")?;
185 }
186 crate::EarlyDepthTest::Allow { conservative, .. } => {
187 use crate::ConservativeDepth as Cd;
188 let depth = match conservative {
189 Cd::GreaterEqual => "greater",
190 Cd::LessEqual => "less",
191 Cd::Unchanged => "unchanged",
192 };
193 writeln!(self.out, "layout (depth_{depth}) out float gl_FragDepth;")?;
194 }
195 }
196 } else {
197 log::warn!(
198 "Early depth testing is not supported for this version of GLSL: {}",
199 self.options.version
200 );
201 }
202 }
203
204 if self.entry_point.stage == ShaderStage::Vertex && self.options.version.is_webgl() {
205 if let Some(multiview) = self.multiview.as_ref() {
206 writeln!(self.out, "layout(num_views = {multiview}) in;")?;
207 writeln!(self.out)?;
208 }
209 }
210
211 // Write struct types.
212 //
213 // This are always ordered because the IR is structured in a way that
214 // you can't make a struct without adding all of its members first.
215 for (handle, ty) in self.module.types.iter() {
216 if let TypeInner::Struct { ref members, .. } = ty.inner {
217 let struct_name = &self.names[&NameKey::Type(handle)];
218
219 // Structures ending with runtime-sized arrays can only be
220 // rendered as shader storage blocks in GLSL, not stand-alone
221 // struct types.
222 if !self.module.types[members.last().unwrap().ty]
223 .inner
224 .is_dynamically_sized(&self.module.types)
225 {
226 write!(self.out, "struct {struct_name} ")?;
227 self.write_struct_body(handle, members)?;
228 writeln!(self.out, ";")?;
229 }
230 }
231 }
232
233 // Write functions for special types.
234 for (type_key, struct_ty) in self.module.special_types.predeclared_types.iter() {
235 match type_key {
236 &crate::PredeclaredType::ModfResult { size, scalar }
237 | &crate::PredeclaredType::FrexpResult { size, scalar } => {
238 let struct_name = &self.names[&NameKey::Type(*struct_ty)];
239 let arg_type_name_owner;
240 let arg_type_name = if let Some(size) = size {
241 arg_type_name_owner = format!(
242 "{}vec{}",
243 if scalar.width == 8 { "d" } else { "" },
244 size as u8
245 );
246 &arg_type_name_owner
247 } else if scalar.width == 8 {
248 "double"
249 } else {
250 "float"
251 };
252
253 let other_type_name_owner;
254 let (defined_func_name, called_func_name, other_type_name) =
255 if matches!(type_key, &crate::PredeclaredType::ModfResult { .. }) {
256 (MODF_FUNCTION, "modf", arg_type_name)
257 } else {
258 let other_type_name = if let Some(size) = size {
259 other_type_name_owner = format!("ivec{}", size as u8);
260 &other_type_name_owner
261 } else {
262 "int"
263 };
264 (FREXP_FUNCTION, "frexp", other_type_name)
265 };
266
267 writeln!(self.out)?;
268 if !self.options.version.supports_frexp_function()
269 && matches!(type_key, &crate::PredeclaredType::FrexpResult { .. })
270 {
271 writeln!(
272 self.out,
273 "{struct_name} {defined_func_name}({arg_type_name} arg) {{
274 {other_type_name} other = arg == {arg_type_name}(0) ? {other_type_name}(0) : {other_type_name}({arg_type_name}(1) + log2(arg));
275 {arg_type_name} fract = arg * exp2({arg_type_name}(-other));
276 return {struct_name}(fract, other);
277}}",
278 )?;
279 } else {
280 writeln!(
281 self.out,
282 "{struct_name} {defined_func_name}({arg_type_name} arg) {{
283 {other_type_name} other;
284 {arg_type_name} fract = {called_func_name}(arg, other);
285 return {struct_name}(fract, other);
286}}",
287 )?;
288 }
289 }
290 &crate::PredeclaredType::AtomicCompareExchangeWeakResult(_) => {
291 // Handled by the general struct writing loop earlier.
292 }
293 }
294 }
295
296 // Write all named constants
297 let mut constants = self
298 .module
299 .constants
300 .iter()
301 .filter(|&(_, c)| c.name.is_some())
302 .peekable();
303 while let Some((handle, _)) = constants.next() {
304 self.write_global_constant(handle)?;
305 // Add extra newline for readability on last iteration
306 if constants.peek().is_none() {
307 writeln!(self.out)?;
308 }
309 }
310
311 let ep_info = self.info.get_entry_point(self.entry_point_idx as usize);
312
313 // Write the globals
314 //
315 // Unless explicitly disabled with WriterFlags::INCLUDE_UNUSED_ITEMS,
316 // we filter all globals that aren't used by the selected entry point as they might be
317 // interfere with each other (i.e. two globals with the same location but different with
318 // different classes)
319 let include_unused = self
320 .options
321 .writer_flags
322 .contains(WriterFlags::INCLUDE_UNUSED_ITEMS);
323 for (handle, global) in self.module.global_variables.iter() {
324 let is_unused = ep_info[handle].is_empty();
325 if !include_unused && is_unused {
326 continue;
327 }
328
329 match self.module.types[global.ty].inner {
330 // We treat images separately because they might require
331 // writing the storage format
332 TypeInner::Image {
333 mut dim,
334 arrayed,
335 class,
336 } => {
337 // Gather the storage format if needed
338 let storage_format_access = match self.module.types[global.ty].inner {
339 TypeInner::Image {
340 class: crate::ImageClass::Storage { format, access },
341 ..
342 } => Some((format, access)),
343 _ => None,
344 };
345
346 if dim == crate::ImageDimension::D1 && es {
347 dim = crate::ImageDimension::D2
348 }
349
350 // Gether the location if needed
351 let layout_binding = if self.options.version.supports_explicit_locations() {
352 let br = global.binding.as_ref().unwrap();
353 self.options.binding_map.get(br).cloned()
354 } else {
355 None
356 };
357
358 // Write all the layout qualifiers
359 if layout_binding.is_some() || storage_format_access.is_some() {
360 write!(self.out, "layout(")?;
361 if let Some(binding) = layout_binding {
362 write!(self.out, "binding = {binding}")?;
363 }
364 if let Some((format, _)) = storage_format_access {
365 let format_str = glsl_storage_format(format)?;
366 let separator = match layout_binding {
367 Some(_) => ",",
368 None => "",
369 };
370 write!(self.out, "{separator}{format_str}")?;
371 }
372 write!(self.out, ") ")?;
373 }
374
375 if let Some((_, access)) = storage_format_access {
376 self.write_storage_access(access)?;
377 }
378
379 // All images in glsl are `uniform`
380 // The trailing space is important
381 write!(self.out, "uniform ")?;
382
383 // write the type
384 //
385 // This is way we need the leading space because `write_image_type` doesn't add
386 // any spaces at the beginning or end
387 self.write_image_type(dim, arrayed, class)?;
388
389 // Finally write the name and end the global with a `;`
390 // The leading space is important
391 let global_name = self.get_global_name(handle, global);
392 writeln!(self.out, " {global_name};")?;
393 writeln!(self.out)?;
394
395 self.reflection_names_globals.insert(handle, global_name);
396 }
397 // glsl has no concept of samplers so we just ignore it
398 TypeInner::Sampler { .. } => continue,
399 // All other globals are written by `write_global`
400 _ => {
401 self.write_global(handle, global)?;
402 // Add a newline (only for readability)
403 writeln!(self.out)?;
404 }
405 }
406 }
407
408 for arg in self.entry_point.function.arguments.iter() {
409 self.write_varying(arg.binding.as_ref(), arg.ty, false)?;
410 }
411 if let Some(ref result) = self.entry_point.function.result {
412 self.write_varying(result.binding.as_ref(), result.ty, true)?;
413 }
414 writeln!(self.out)?;
415
416 // Write all regular functions
417 for (handle, function) in self.module.functions.iter() {
418 // Check that the function doesn't use globals that aren't supported
419 // by the current entry point
420 if !include_unused && !ep_info.dominates_global_use(&self.info[handle]) {
421 continue;
422 }
423
424 let fun_info = &self.info[handle];
425
426 // Skip functions that that are not compatible with this entry point's stage.
427 //
428 // When validation is enabled, it rejects modules whose entry points try to call
429 // incompatible functions, so if we got this far, then any functions incompatible
430 // with our selected entry point must not be used.
431 //
432 // When validation is disabled, `fun_info.available_stages` is always just
433 // `ShaderStages::all()`, so this will write all functions in the module, and
434 // the downstream GLSL compiler will catch any problems.
435 if !fun_info.available_stages.contains(ep_info.available_stages) {
436 continue;
437 }
438
439 // Write the function
440 self.write_function(back::FunctionType::Function(handle), function, fun_info)?;
441
442 writeln!(self.out)?;
443 }
444
445 self.write_function(
446 back::FunctionType::EntryPoint(self.entry_point_idx),
447 &self.entry_point.function,
448 ep_info,
449 )?;
450
451 // Add newline at the end of file
452 writeln!(self.out)?;
453
454 // Collect all reflection info and return it to the user
455 self.collect_reflection_info()
456 }
457
458 fn write_array_size(
459 &mut self,
460 base: Handle<crate::Type>,
461 size: crate::ArraySize,
462 ) -> BackendResult {
463 write!(self.out, "[")?;
464
465 // Write the array size
466 // Writes nothing if `IndexableLength::Dynamic`
467 match size.resolve(self.module.to_ctx())? {
468 proc::IndexableLength::Known(size) => {
469 write!(self.out, "{size}")?;
470 }
471 proc::IndexableLength::Dynamic => (),
472 }
473
474 write!(self.out, "]")?;
475
476 if let TypeInner::Array {
477 base: next_base,
478 size: next_size,
479 ..
480 } = self.module.types[base].inner
481 {
482 self.write_array_size(next_base, next_size)?;
483 }
484
485 Ok(())
486 }
487
488 /// Helper method used to write value types
489 ///
490 /// # Notes
491 /// Adds no trailing or leading whitespace
492 fn write_value_type(&mut self, inner: &TypeInner) -> BackendResult {
493 match *inner {
494 // Scalars are simple we just get the full name from `glsl_scalar`
495 TypeInner::Scalar(scalar)
496 | TypeInner::Atomic(scalar)
497 | TypeInner::ValuePointer {
498 size: None,
499 scalar,
500 space: _,
501 } => write!(self.out, "{}", glsl_scalar(scalar)?.full)?,
502 // Vectors are just `gvecN` where `g` is the scalar prefix and `N` is the vector size
503 TypeInner::Vector { size, scalar }
504 | TypeInner::ValuePointer {
505 size: Some(size),
506 scalar,
507 space: _,
508 } => write!(self.out, "{}vec{}", glsl_scalar(scalar)?.prefix, size as u8)?,
509 // Matrices are written with `gmatMxN` where `g` is the scalar prefix (only floats and
510 // doubles are allowed), `M` is the columns count and `N` is the rows count
511 //
512 // glsl supports a matrix shorthand `gmatN` where `N` = `M` but it doesn't justify the
513 // extra branch to write matrices this way
514 TypeInner::Matrix {
515 columns,
516 rows,
517 scalar,
518 } => write!(
519 self.out,
520 "{}mat{}x{}",
521 glsl_scalar(scalar)?.prefix,
522 columns as u8,
523 rows as u8
524 )?,
525 // GLSL arrays are written as `type name[size]`
526 // Here we only write the size of the array i.e. `[size]`
527 // Base `type` and `name` should be written outside
528 TypeInner::Array { base, size, .. } => self.write_array_size(base, size)?,
529 // Write all variants instead of `_` so that if new variants are added a
530 // no exhaustiveness error is thrown
531 TypeInner::Pointer { .. }
532 | TypeInner::Struct { .. }
533 | TypeInner::Image { .. }
534 | TypeInner::Sampler { .. }
535 | TypeInner::AccelerationStructure { .. }
536 | TypeInner::RayQuery { .. }
537 | TypeInner::BindingArray { .. }
538 | TypeInner::CooperativeMatrix { .. } => {
539 return Err(Error::Custom(format!("Unable to write type {inner:?}")))
540 }
541 }
542
543 Ok(())
544 }
545
546 /// Helper method used to write non image/sampler types
547 ///
548 /// # Notes
549 /// Adds no trailing or leading whitespace
550 fn write_type(&mut self, ty: Handle<crate::Type>) -> BackendResult {
551 match self.module.types[ty].inner {
552 // glsl has no pointer types so just write types as normal and loads are skipped
553 TypeInner::Pointer { base, .. } => self.write_type(base),
554 // glsl structs are written as just the struct name
555 TypeInner::Struct { .. } => {
556 // Get the struct name
557 let name = &self.names[&NameKey::Type(ty)];
558 write!(self.out, "{name}")?;
559 Ok(())
560 }
561 // glsl array has the size separated from the base type
562 TypeInner::Array { base, .. } => self.write_type(base),
563 ref other => self.write_value_type(other),
564 }
565 }
566
567 /// Helper method to write a image type
568 ///
569 /// # Notes
570 /// Adds no leading or trailing whitespace
571 fn write_image_type(
572 &mut self,
573 dim: crate::ImageDimension,
574 arrayed: bool,
575 class: crate::ImageClass,
576 ) -> BackendResult {
577 // glsl images consist of four parts the scalar prefix, the image "type", the dimensions
578 // and modifiers
579 //
580 // There exists two image types
581 // - sampler - for sampled images
582 // - image - for storage images
583 //
584 // There are three possible modifiers that can be used together and must be written in
585 // this order to be valid
586 // - MS - used if it's a multisampled image
587 // - Array - used if it's an image array
588 // - Shadow - used if it's a depth image
589 use crate::ImageClass as Ic;
590 use crate::Scalar as S;
591 let float = S {
592 kind: crate::ScalarKind::Float,
593 width: 4,
594 };
595 let (base, scalar, ms, comparison) = match class {
596 Ic::Sampled { kind, multi: true } => ("sampler", S { kind, width: 4 }, "MS", ""),
597 Ic::Sampled { kind, multi: false } => ("sampler", S { kind, width: 4 }, "", ""),
598 Ic::Depth { multi: true } => ("sampler", float, "MS", ""),
599 Ic::Depth { multi: false } => ("sampler", float, "", "Shadow"),
600 Ic::Storage { format, .. } => ("image", format.into(), "", ""),
601 Ic::External => unimplemented!(),
602 };
603
604 let precision = if self.options.version.is_es() {
605 "highp "
606 } else {
607 ""
608 };
609
610 write!(
611 self.out,
612 "{}{}{}{}{}{}{}",
613 precision,
614 glsl_scalar(scalar)?.prefix,
615 base,
616 glsl_dimension(dim),
617 ms,
618 if arrayed { "Array" } else { "" },
619 comparison
620 )?;
621
622 Ok(())
623 }
624
625 /// Helper method used by [Self::write_global] to write just the layout part of
626 /// a non image/sampler global variable, if applicable.
627 ///
628 /// # Notes
629 ///
630 /// Adds trailing whitespace if any layout qualifier is written
631 fn write_global_layout(&mut self, global: &crate::GlobalVariable) -> BackendResult {
632 // Determine which (if any) explicit memory layout to use, and whether we support it
633 let layout = match global.space {
634 crate::AddressSpace::Uniform => {
635 if !self.options.version.supports_std140_layout() {
636 return Err(Error::Custom(
637 "Uniform address space requires std140 layout support".to_string(),
638 ));
639 }
640
641 Some("std140")
642 }
643 crate::AddressSpace::Storage { .. } => {
644 if !self.options.version.supports_std430_layout() {
645 return Err(Error::Custom(
646 "Storage address space requires std430 layout support".to_string(),
647 ));
648 }
649
650 Some("std430")
651 }
652 _ => None,
653 };
654
655 // If our version supports explicit layouts, we can also output the explicit binding
656 // if we have it
657 if self.options.version.supports_explicit_locations() {
658 if let Some(ref br) = global.binding {
659 match self.options.binding_map.get(br) {
660 Some(binding) => {
661 write!(self.out, "layout(")?;
662
663 if let Some(layout) = layout {
664 write!(self.out, "{layout}, ")?;
665 }
666
667 write!(self.out, "binding = {binding}) ")?;
668
669 return Ok(());
670 }
671 None => {
672 log::debug!("unassigned binding for {:?}", global.name);
673 }
674 }
675 }
676 }
677
678 // Either no explicit bindings are supported or we didn't have any.
679 // Write just the memory layout.
680 if let Some(layout) = layout {
681 write!(self.out, "layout({layout}) ")?;
682 }
683
684 Ok(())
685 }
686
687 /// Helper method used to write non images/sampler globals
688 ///
689 /// # Notes
690 /// Adds a newline
691 ///
692 /// # Panics
693 /// If the global has type sampler
694 fn write_global(
695 &mut self,
696 handle: Handle<crate::GlobalVariable>,
697 global: &crate::GlobalVariable,
698 ) -> BackendResult {
699 self.write_global_layout(global)?;
700
701 if let crate::AddressSpace::Storage { access } = global.space {
702 self.write_storage_access(access)?;
703 if global
704 .memory_decorations
705 .contains(crate::MemoryDecorations::COHERENT)
706 {
707 write!(self.out, "coherent ")?;
708 }
709 if global
710 .memory_decorations
711 .contains(crate::MemoryDecorations::VOLATILE)
712 {
713 write!(self.out, "volatile ")?;
714 }
715 }
716
717 if let Some(storage_qualifier) = glsl_storage_qualifier(global.space) {
718 write!(self.out, "{storage_qualifier} ")?;
719 }
720
721 match global.space {
722 crate::AddressSpace::Private => {
723 self.write_simple_global(handle, global)?;
724 }
725 crate::AddressSpace::WorkGroup => {
726 self.write_simple_global(handle, global)?;
727 }
728 crate::AddressSpace::Immediate => {
729 self.write_simple_global(handle, global)?;
730 }
731 crate::AddressSpace::Uniform => {
732 self.write_interface_block(handle, global)?;
733 }
734 crate::AddressSpace::Storage { .. } => {
735 self.write_interface_block(handle, global)?;
736 }
737 crate::AddressSpace::TaskPayload => {
738 self.write_interface_block(handle, global)?;
739 }
740 // A global variable in the `Function` address space is a
741 // contradiction in terms.
742 crate::AddressSpace::Function => unreachable!(),
743 // Textures and samplers are handled directly in `Writer::write`.
744 crate::AddressSpace::Handle => unreachable!(),
745 // ray tracing pipelines unsupported
746 crate::AddressSpace::RayPayload | crate::AddressSpace::IncomingRayPayload => {
747 unreachable!()
748 }
749 }
750
751 Ok(())
752 }
753
754 fn write_simple_global(
755 &mut self,
756 handle: Handle<crate::GlobalVariable>,
757 global: &crate::GlobalVariable,
758 ) -> BackendResult {
759 self.write_type(global.ty)?;
760 write!(self.out, " ")?;
761 self.write_global_name(handle, global)?;
762
763 if let TypeInner::Array { base, size, .. } = self.module.types[global.ty].inner {
764 self.write_array_size(base, size)?;
765 }
766
767 if global.space.initializable() && is_value_init_supported(self.module, global.ty) {
768 write!(self.out, " = ")?;
769 if let Some(init) = global.init {
770 self.write_const_expr(init, &self.module.global_expressions)?;
771 } else {
772 self.write_zero_init_value(global.ty)?;
773 }
774 }
775
776 writeln!(self.out, ";")?;
777
778 if let crate::AddressSpace::Immediate = global.space {
779 let global_name = self.get_global_name(handle, global);
780 self.reflection_names_globals.insert(handle, global_name);
781 }
782
783 Ok(())
784 }
785
786 /// Write an interface block for a single Naga global.
787 ///
788 /// Write `block_name { members }`. Since `block_name` must be unique
789 /// between blocks and structs, we add `_block_ID` where `ID` is a
790 /// `IdGenerator` generated number. Write `members` in the same way we write
791 /// a struct's members.
792 fn write_interface_block(
793 &mut self,
794 handle: Handle<crate::GlobalVariable>,
795 global: &crate::GlobalVariable,
796 ) -> BackendResult {
797 // Write the block name, it's just the struct name appended with `_block_ID`
798 let ty_name = &self.names[&NameKey::Type(global.ty)];
799 let block_name = format!(
800 "{}_block_{}{:?}",
801 // avoid double underscores as they are reserved in GLSL
802 ty_name.trim_end_matches('_'),
803 self.block_id.generate(),
804 self.entry_point.stage,
805 );
806 write!(self.out, "{block_name} ")?;
807 self.reflection_names_globals.insert(handle, block_name);
808
809 match self.module.types[global.ty].inner {
810 TypeInner::Struct { ref members, .. }
811 if self.module.types[members.last().unwrap().ty]
812 .inner
813 .is_dynamically_sized(&self.module.types) =>
814 {
815 // Structs with dynamically sized arrays must have their
816 // members lifted up as members of the interface block. GLSL
817 // can't write such struct types anyway.
818 self.write_struct_body(global.ty, members)?;
819 write!(self.out, " ")?;
820 self.write_global_name(handle, global)?;
821 }
822 _ => {
823 // A global of any other type is written as the sole member
824 // of the interface block. Since the interface block is
825 // anonymous, this becomes visible in the global scope.
826 write!(self.out, "{{ ")?;
827 self.write_type(global.ty)?;
828 write!(self.out, " ")?;
829 self.write_global_name(handle, global)?;
830 if let TypeInner::Array { base, size, .. } = self.module.types[global.ty].inner {
831 self.write_array_size(base, size)?;
832 }
833 write!(self.out, "; }}")?;
834 }
835 }
836
837 writeln!(self.out, ";")?;
838
839 Ok(())
840 }
841
842 /// Helper method used to find which expressions of a given function require baking
843 ///
844 /// # Notes
845 /// Clears `need_bake_expressions` set before adding to it
846 fn update_expressions_to_bake(&mut self, func: &crate::Function, info: &valid::FunctionInfo) {
847 use crate::Expression;
848 self.need_bake_expressions.clear();
849 for (fun_handle, expr) in func.expressions.iter() {
850 let expr_info = &info[fun_handle];
851 let min_ref_count = func.expressions[fun_handle].bake_ref_count();
852 if min_ref_count <= expr_info.ref_count {
853 self.need_bake_expressions.insert(fun_handle);
854 }
855
856 let inner = expr_info.ty.inner_with(&self.module.types);
857
858 if let Expression::Math {
859 fun,
860 arg,
861 arg1,
862 arg2,
863 ..
864 } = *expr
865 {
866 match fun {
867 crate::MathFunction::Dot => {
868 // if the expression is a Dot product with integer arguments,
869 // then the args needs baking as well
870 if let TypeInner::Scalar(crate::Scalar {
871 kind: crate::ScalarKind::Sint | crate::ScalarKind::Uint,
872 ..
873 }) = *inner
874 {
875 self.need_bake_expressions.insert(arg);
876 self.need_bake_expressions.insert(arg1.unwrap());
877 }
878 }
879 crate::MathFunction::Dot4U8Packed | crate::MathFunction::Dot4I8Packed => {
880 self.need_bake_expressions.insert(arg);
881 self.need_bake_expressions.insert(arg1.unwrap());
882 }
883 crate::MathFunction::Pack4xI8
884 | crate::MathFunction::Pack4xU8
885 | crate::MathFunction::Pack4xI8Clamp
886 | crate::MathFunction::Pack4xU8Clamp
887 | crate::MathFunction::Unpack4xI8
888 | crate::MathFunction::Unpack4xU8
889 | crate::MathFunction::QuantizeToF16 => {
890 self.need_bake_expressions.insert(arg);
891 }
892 /* crate::MathFunction::Pack4x8unorm | */
893 crate::MathFunction::Unpack4x8snorm
894 if !self.options.version.supports_pack_unpack_4x8() =>
895 {
896 // We have a fallback if the platform doesn't natively support these
897 self.need_bake_expressions.insert(arg);
898 }
899 /* crate::MathFunction::Pack4x8unorm | */
900 crate::MathFunction::Unpack4x8unorm
901 if !self.options.version.supports_pack_unpack_4x8() =>
902 {
903 self.need_bake_expressions.insert(arg);
904 }
905 /* crate::MathFunction::Pack2x16snorm | */
906 crate::MathFunction::Unpack2x16snorm
907 if !self.options.version.supports_pack_unpack_snorm_2x16() =>
908 {
909 self.need_bake_expressions.insert(arg);
910 }
911 /* crate::MathFunction::Pack2x16unorm | */
912 crate::MathFunction::Unpack2x16unorm
913 if !self.options.version.supports_pack_unpack_unorm_2x16() =>
914 {
915 self.need_bake_expressions.insert(arg);
916 }
917 crate::MathFunction::ExtractBits => {
918 // Only argument 1 is re-used.
919 self.need_bake_expressions.insert(arg1.unwrap());
920 }
921 crate::MathFunction::InsertBits => {
922 // Only argument 2 is re-used.
923 self.need_bake_expressions.insert(arg2.unwrap());
924 }
925 crate::MathFunction::CountLeadingZeros => {
926 if let Some(crate::ScalarKind::Sint) = inner.scalar_kind() {
927 self.need_bake_expressions.insert(arg);
928 }
929 }
930 _ => {}
931 }
932 }
933
934 if let Expression::Binary {
935 op: crate::BinaryOperator::Modulo,
936 left,
937 right,
938 } = *expr
939 {
940 // Integer `%` is lowered to `left - right * (left / right)` in
941 // write_expr (`BinaryOperation::ModuloInt`), which references each
942 // operand twice, so bake both to avoid re-evaluating them.
943 if let Some(crate::ScalarKind::Sint | crate::ScalarKind::Uint) = inner.scalar_kind()
944 {
945 self.need_bake_expressions.insert(left);
946 self.need_bake_expressions.insert(right);
947 }
948 }
949 }
950
951 for statement in func.body.iter() {
952 match *statement {
953 crate::Statement::Atomic {
954 fun: crate::AtomicFunction::Exchange { compare: Some(cmp) },
955 ..
956 } => {
957 self.need_bake_expressions.insert(cmp);
958 }
959 _ => {}
960 }
961 }
962 }
963
964 /// Helper method used to get a name for a global
965 ///
966 /// Globals have different naming schemes depending on their binding:
967 /// - Globals without bindings use the name from the [`Namer`](crate::proc::Namer)
968 /// - Globals with resource binding are named `_group_X_binding_Y` where `X`
969 /// is the group and `Y` is the binding
970 fn get_global_name(
971 &self,
972 handle: Handle<crate::GlobalVariable>,
973 global: &crate::GlobalVariable,
974 ) -> String {
975 match (&global.binding, global.space) {
976 (&Some(ref br), _) => {
977 format!(
978 "_group_{}_binding_{}_{}",
979 br.group,
980 br.binding,
981 shader_stage_to_str(self.entry_point.stage)
982 )
983 }
984 (&None, crate::AddressSpace::Immediate) => {
985 format!(
986 "_immediates_binding_{}",
987 shader_stage_to_str(self.entry_point.stage)
988 )
989 }
990 (&None, _) => self.names[&NameKey::GlobalVariable(handle)].clone(),
991 }
992 }
993
994 /// Helper method used to write a name for a global without additional heap allocation
995 fn write_global_name(
996 &mut self,
997 handle: Handle<crate::GlobalVariable>,
998 global: &crate::GlobalVariable,
999 ) -> BackendResult {
1000 match (&global.binding, global.space) {
1001 (&Some(ref br), _) => write!(
1002 self.out,
1003 "_group_{}_binding_{}_{}",
1004 br.group,
1005 br.binding,
1006 shader_stage_to_str(self.entry_point.stage)
1007 )?,
1008 (&None, crate::AddressSpace::Immediate) => write!(
1009 self.out,
1010 "_immediates_binding_{}",
1011 shader_stage_to_str(self.entry_point.stage)
1012 )?,
1013 (&None, _) => write!(
1014 self.out,
1015 "{}",
1016 &self.names[&NameKey::GlobalVariable(handle)]
1017 )?,
1018 }
1019
1020 Ok(())
1021 }
1022
1023 /// Write a GLSL global that will carry a Naga entry point's argument or return value.
1024 ///
1025 /// A Naga entry point's arguments and return value are rendered in GLSL as
1026 /// variables at global scope with the `in` and `out` storage qualifiers.
1027 /// The code we generate for `main` loads from all the `in` globals into
1028 /// appropriately named locals. Before it returns, `main` assigns the
1029 /// components of its return value into all the `out` globals.
1030 ///
1031 /// This function writes a declaration for one such GLSL global,
1032 /// representing a value passed into or returned from [`self.entry_point`]
1033 /// that has a [`Location`] binding. The global's name is generated based on
1034 /// the location index and the shader stages being connected; see
1035 /// [`VaryingName`]. This means we don't need to know the names of
1036 /// arguments, just their types and bindings.
1037 ///
1038 /// Emit nothing for entry point arguments or return values with [`BuiltIn`]
1039 /// bindings; `main` will read from or assign to the appropriate GLSL
1040 /// special variable; these are pre-declared. As an exception, we do declare
1041 /// `gl_Position` or `gl_FragCoord` with the `invariant` qualifier if
1042 /// needed.
1043 ///
1044 /// Use `output` together with [`self.entry_point.stage`] to determine which
1045 /// shader stages are being connected, and choose the `in` or `out` storage
1046 /// qualifier.
1047 ///
1048 /// [`self.entry_point`]: Writer::entry_point
1049 /// [`self.entry_point.stage`]: crate::EntryPoint::stage
1050 /// [`Location`]: crate::Binding::Location
1051 /// [`BuiltIn`]: crate::Binding::BuiltIn
1052 fn write_varying(
1053 &mut self,
1054 binding: Option<&crate::Binding>,
1055 ty: Handle<crate::Type>,
1056 output: bool,
1057 ) -> Result<(), Error> {
1058 // For a struct, emit a separate global for each member with a binding.
1059 if let TypeInner::Struct { ref members, .. } = self.module.types[ty].inner {
1060 for member in members {
1061 self.write_varying(member.binding.as_ref(), member.ty, output)?;
1062 }
1063 return Ok(());
1064 }
1065
1066 let binding = match binding {
1067 None => return Ok(()),
1068 Some(binding) => binding,
1069 };
1070
1071 let (location, interpolation, sampling, blend_src) = match *binding {
1072 crate::Binding::Location {
1073 location,
1074 interpolation,
1075 sampling,
1076 blend_src,
1077 per_primitive: _,
1078 } => (location, interpolation, sampling, blend_src),
1079 crate::Binding::BuiltIn(built_in) => {
1080 match built_in {
1081 crate::BuiltIn::Position { invariant: true } => {
1082 match (self.options.version, self.entry_point.stage) {
1083 (
1084 Version::Embedded {
1085 version: 300,
1086 is_webgl: true,
1087 },
1088 ShaderStage::Fragment,
1089 ) => {
1090 // `invariant gl_FragCoord` is not allowed in WebGL2 and possibly
1091 // OpenGL ES in general (waiting on confirmation).
1092 //
1093 // See https://github.com/KhronosGroup/WebGL/issues/3518
1094 }
1095 _ => {
1096 writeln!(
1097 self.out,
1098 "invariant {};",
1099 glsl_built_in(
1100 built_in,
1101 VaryingOptions::from_writer_options(self.options, output)
1102 )
1103 )?;
1104 }
1105 }
1106 }
1107 crate::BuiltIn::ClipDistances => {
1108 // Re-declare `gl_ClipDistance` with number of clip planes.
1109 let TypeInner::Array { size, .. } = self.module.types[ty].inner else {
1110 unreachable!();
1111 };
1112 let proc::IndexableLength::Known(size) =
1113 size.resolve(self.module.to_ctx())?
1114 else {
1115 unreachable!();
1116 };
1117 self.clip_distance_count = size;
1118 writeln!(self.out, "out float gl_ClipDistance[{size}];")?;
1119 }
1120 _ => {}
1121 }
1122 return Ok(());
1123 }
1124 };
1125
1126 // Write the interpolation modifier if needed
1127 //
1128 // We ignore all interpolation and auxiliary modifiers that aren't used in fragment
1129 // shaders' input globals or vertex shaders' output globals.
1130 let emit_interpolation_and_auxiliary = match self.entry_point.stage {
1131 ShaderStage::Vertex => output,
1132 ShaderStage::Fragment => !output,
1133 ShaderStage::Compute => false,
1134 ShaderStage::Task
1135 | ShaderStage::Mesh
1136 | ShaderStage::RayGeneration
1137 | ShaderStage::AnyHit
1138 | ShaderStage::ClosestHit
1139 | ShaderStage::Miss => unreachable!(),
1140 };
1141
1142 // Write the I/O locations, if allowed
1143 let io_location = if self.options.version.supports_explicit_locations()
1144 || !emit_interpolation_and_auxiliary
1145 {
1146 if self.options.version.supports_io_locations() {
1147 if let Some(blend_src) = blend_src {
1148 write!(
1149 self.out,
1150 "layout(location = {location}, index = {blend_src}) "
1151 )?;
1152 } else {
1153 write!(self.out, "layout(location = {location}) ")?;
1154 }
1155 None
1156 } else {
1157 Some(VaryingLocation {
1158 location,
1159 index: blend_src.unwrap_or(0),
1160 })
1161 }
1162 } else {
1163 None
1164 };
1165
1166 // Write the interpolation qualifier.
1167 if let Some(interp) = interpolation {
1168 if emit_interpolation_and_auxiliary {
1169 write!(self.out, "{} ", glsl_interpolation(interp))?;
1170 }
1171 }
1172
1173 // Write the sampling auxiliary qualifier.
1174 //
1175 // Before GLSL 4.2, the `centroid` and `sample` qualifiers were required to appear
1176 // immediately before the `in` / `out` qualifier, so we'll just follow that rule
1177 // here, regardless of the version.
1178 if let Some(sampling) = sampling {
1179 if emit_interpolation_and_auxiliary {
1180 if let Some(qualifier) = glsl_sampling(sampling)? {
1181 write!(self.out, "{qualifier} ")?;
1182 }
1183 }
1184 }
1185
1186 // Write the input/output qualifier.
1187 write!(self.out, "{} ", if output { "out" } else { "in" })?;
1188
1189 // Write the type
1190 // `write_type` adds no leading or trailing spaces
1191 self.write_type(ty)?;
1192
1193 // Finally write the global name and end the global with a `;` and a newline
1194 // Leading space is important
1195 let vname = VaryingName {
1196 binding: &crate::Binding::Location {
1197 location,
1198 interpolation: None,
1199 sampling: None,
1200 blend_src,
1201 per_primitive: false,
1202 },
1203 stage: self.entry_point.stage,
1204 options: VaryingOptions::from_writer_options(self.options, output),
1205 };
1206 writeln!(self.out, " {vname};")?;
1207
1208 if let Some(location) = io_location {
1209 self.varying.insert(vname.to_string(), location);
1210 }
1211
1212 Ok(())
1213 }
1214
1215 /// Helper method used to write functions (both entry points and regular functions)
1216 ///
1217 /// # Notes
1218 /// Adds a newline
1219 fn write_function(
1220 &mut self,
1221 ty: back::FunctionType,
1222 func: &crate::Function,
1223 info: &valid::FunctionInfo,
1224 ) -> BackendResult {
1225 // Create a function context for the function being written
1226 let ctx = back::FunctionCtx {
1227 ty,
1228 info,
1229 expressions: &func.expressions,
1230 named_expressions: &func.named_expressions,
1231 };
1232
1233 self.named_expressions.clear();
1234 self.update_expressions_to_bake(func, info);
1235
1236 // Write the function header
1237 //
1238 // glsl headers are the same as in c:
1239 // `ret_type name(args)`
1240 // `ret_type` is the return type
1241 // `name` is the function name
1242 // `args` is a comma separated list of `type name`
1243 // | - `type` is the argument type
1244 // | - `name` is the argument name
1245
1246 // Start by writing the return type if any otherwise write void
1247 // This is the only place where `void` is a valid type
1248 // (though it's more a keyword than a type)
1249 if let back::FunctionType::EntryPoint(_) = ctx.ty {
1250 write!(self.out, "void")?;
1251 } else if let Some(ref result) = func.result {
1252 self.write_type(result.ty)?;
1253 if let TypeInner::Array { base, size, .. } = self.module.types[result.ty].inner {
1254 self.write_array_size(base, size)?
1255 }
1256 } else {
1257 write!(self.out, "void")?;
1258 }
1259
1260 // Write the function name and open parentheses for the argument list
1261 let function_name = match ctx.ty {
1262 back::FunctionType::Function(handle) => &self.names[&NameKey::Function(handle)],
1263 back::FunctionType::EntryPoint(_) => "main",
1264 };
1265 write!(self.out, " {function_name}(")?;
1266
1267 // Write the comma separated argument list
1268 //
1269 // We need access to `Self` here so we use the reference passed to the closure as an
1270 // argument instead of capturing as that would cause a borrow checker error
1271 let arguments = match ctx.ty {
1272 back::FunctionType::EntryPoint(_) => &[][..],
1273 back::FunctionType::Function(_) => &func.arguments,
1274 };
1275 let arguments: Vec<_> = arguments
1276 .iter()
1277 .enumerate()
1278 .filter(|&(_, arg)| match self.module.types[arg.ty].inner {
1279 TypeInner::Sampler { .. } => false,
1280 _ => true,
1281 })
1282 .collect();
1283 self.write_slice(&arguments, |this, _, &(i, arg)| {
1284 // Write the argument type
1285 match this.module.types[arg.ty].inner {
1286 // We treat images separately because they might require
1287 // writing the storage format
1288 TypeInner::Image {
1289 dim,
1290 arrayed,
1291 class,
1292 } => {
1293 // Write the storage format if needed
1294 if let TypeInner::Image {
1295 class: crate::ImageClass::Storage { format, .. },
1296 ..
1297 } = this.module.types[arg.ty].inner
1298 {
1299 write!(this.out, "layout({}) ", glsl_storage_format(format)?)?;
1300 }
1301
1302 // write the type
1303 //
1304 // This is way we need the leading space because `write_image_type` doesn't add
1305 // any spaces at the beginning or end
1306 this.write_image_type(dim, arrayed, class)?;
1307 }
1308 TypeInner::Pointer { base, .. } => {
1309 // write parameter qualifiers
1310 write!(this.out, "inout ")?;
1311 this.write_type(base)?;
1312 }
1313 // All other types are written by `write_type`
1314 _ => {
1315 this.write_type(arg.ty)?;
1316 }
1317 }
1318
1319 // Write the argument name
1320 // The leading space is important
1321 write!(this.out, " {}", &this.names[&ctx.argument_key(i as u32)])?;
1322
1323 // Write array size
1324 match this.module.types[arg.ty].inner {
1325 TypeInner::Array { base, size, .. } => {
1326 this.write_array_size(base, size)?;
1327 }
1328 TypeInner::Pointer { base, .. } => {
1329 if let TypeInner::Array { base, size, .. } = this.module.types[base].inner {
1330 this.write_array_size(base, size)?;
1331 }
1332 }
1333 _ => {}
1334 }
1335
1336 Ok(())
1337 })?;
1338
1339 // Close the parentheses and open braces to start the function body
1340 writeln!(self.out, ") {{")?;
1341
1342 if self.options.zero_initialize_workgroup_memory
1343 && ctx.ty.is_compute_like_entry_point(self.module)
1344 {
1345 self.write_workgroup_variables_initialization(&ctx)?;
1346 }
1347
1348 // Compose the function arguments from globals, in case of an entry point.
1349 if let back::FunctionType::EntryPoint(ep_index) = ctx.ty {
1350 let stage = self.module.entry_points[ep_index as usize].stage;
1351 for (index, arg) in func.arguments.iter().enumerate() {
1352 write!(self.out, "{}", back::INDENT)?;
1353 self.write_type(arg.ty)?;
1354 let name = &self.names[&NameKey::EntryPointArgument(ep_index, index as u32)];
1355 write!(self.out, " {name}")?;
1356 write!(self.out, " = ")?;
1357 match self.module.types[arg.ty].inner {
1358 TypeInner::Struct { ref members, .. } => {
1359 self.write_type(arg.ty)?;
1360 write!(self.out, "(")?;
1361 for (index, member) in members.iter().enumerate() {
1362 let varying_name = VaryingName {
1363 binding: member.binding.as_ref().unwrap(),
1364 stage,
1365 options: VaryingOptions::from_writer_options(self.options, false),
1366 };
1367 if index != 0 {
1368 write!(self.out, ", ")?;
1369 }
1370 write!(self.out, "{varying_name}")?;
1371 }
1372 writeln!(self.out, ");")?;
1373 }
1374 _ => {
1375 let varying_name = VaryingName {
1376 binding: arg.binding.as_ref().unwrap(),
1377 stage,
1378 options: VaryingOptions::from_writer_options(self.options, false),
1379 };
1380 writeln!(self.out, "{varying_name};")?;
1381 }
1382 }
1383 }
1384 }
1385
1386 // Write all function locals
1387 // Locals are `type name (= init)?;` where the init part (including the =) are optional
1388 //
1389 // Always adds a newline
1390 for (handle, local) in func.local_variables.iter() {
1391 // Write indentation (only for readability) and the type
1392 // `write_type` adds no trailing space
1393 write!(self.out, "{}", back::INDENT)?;
1394 self.write_type(local.ty)?;
1395
1396 // Write the local name
1397 // The leading space is important
1398 write!(self.out, " {}", self.names[&ctx.name_key(handle)])?;
1399 // Write size for array type
1400 if let TypeInner::Array { base, size, .. } = self.module.types[local.ty].inner {
1401 self.write_array_size(base, size)?;
1402 }
1403 // Write the local initializer if needed
1404 if let Some(init) = local.init {
1405 // Put the equal signal only if there's a initializer
1406 // The leading and trailing spaces aren't needed but help with readability
1407 write!(self.out, " = ")?;
1408
1409 // Write the constant
1410 // `write_constant` adds no trailing or leading space/newline
1411 self.write_expr(init, &ctx)?;
1412 } else if is_value_init_supported(self.module, local.ty) {
1413 write!(self.out, " = ")?;
1414 self.write_zero_init_value(local.ty)?;
1415 }
1416
1417 // Finish the local with `;` and add a newline (only for readability)
1418 writeln!(self.out, ";")?
1419 }
1420
1421 // Write the function body (statement list)
1422 for sta in func.body.iter() {
1423 // Write a statement, the indentation should always be 1 when writing the function body
1424 // `write_stmt` adds a newline
1425 self.write_stmt(sta, &ctx, back::Level(1))?;
1426 }
1427
1428 // Close braces and add a newline
1429 writeln!(self.out, "}}")?;
1430
1431 Ok(())
1432 }
1433
1434 fn write_workgroup_variables_initialization(
1435 &mut self,
1436 ctx: &back::FunctionCtx,
1437 ) -> BackendResult {
1438 let mut vars = self
1439 .module
1440 .global_variables
1441 .iter()
1442 .filter(|&(handle, var)| {
1443 !ctx.info[handle].is_empty() && var.space == crate::AddressSpace::WorkGroup
1444 })
1445 .peekable();
1446
1447 if vars.peek().is_some() {
1448 let level = back::Level(1);
1449
1450 writeln!(self.out, "{level}if (gl_LocalInvocationID == uvec3(0u)) {{")?;
1451
1452 for (handle, var) in vars {
1453 let name = &self.names[&NameKey::GlobalVariable(handle)];
1454 write!(self.out, "{}{} = ", level.next(), name)?;
1455 self.write_zero_init_value(var.ty)?;
1456 writeln!(self.out, ";")?;
1457 }
1458
1459 writeln!(self.out, "{level}}}")?;
1460 self.write_control_barrier(crate::Barrier::WORK_GROUP, level)?;
1461 }
1462
1463 Ok(())
1464 }
1465
1466 /// Write a list of comma separated `T` values using a writer function `F`.
1467 ///
1468 /// The writer function `F` receives a mutable reference to `self` that if needed won't cause
1469 /// borrow checker issues (using for example a closure with `self` will cause issues), the
1470 /// second argument is the 0 based index of the element on the list, and the last element is
1471 /// a reference to the element `T` being written
1472 ///
1473 /// # Notes
1474 /// - Adds no newlines or leading/trailing whitespace
1475 /// - The last element won't have a trailing `,`
1476 fn write_slice<T, F: FnMut(&mut Self, u32, &T) -> BackendResult>(
1477 &mut self,
1478 data: &[T],
1479 mut f: F,
1480 ) -> BackendResult {
1481 // Loop through `data` invoking `f` for each element
1482 for (index, item) in data.iter().enumerate() {
1483 if index != 0 {
1484 write!(self.out, ", ")?;
1485 }
1486 f(self, index as u32, item)?;
1487 }
1488
1489 Ok(())
1490 }
1491
1492 /// Helper method used to write global constants
1493 fn write_global_constant(&mut self, handle: Handle<crate::Constant>) -> BackendResult {
1494 write!(self.out, "const ")?;
1495 let constant = &self.module.constants[handle];
1496 self.write_type(constant.ty)?;
1497 let name = &self.names[&NameKey::Constant(handle)];
1498 write!(self.out, " {name}")?;
1499 if let TypeInner::Array { base, size, .. } = self.module.types[constant.ty].inner {
1500 self.write_array_size(base, size)?;
1501 }
1502 write!(self.out, " = ")?;
1503 self.write_const_expr(constant.init, &self.module.global_expressions)?;
1504 writeln!(self.out, ";")?;
1505 Ok(())
1506 }
1507
1508 /// Helper method used to output a dot product as an arithmetic expression
1509 ///
1510 fn write_dot_product(
1511 &mut self,
1512 arg: Handle<crate::Expression>,
1513 arg1: Handle<crate::Expression>,
1514 size: usize,
1515 ctx: &back::FunctionCtx,
1516 ) -> BackendResult {
1517 // Write parentheses around the dot product expression to prevent operators
1518 // with different precedences from applying earlier.
1519 write!(self.out, "(")?;
1520
1521 // Cycle through all the components of the vector
1522 for index in 0..size {
1523 let component = back::COMPONENTS[index];
1524 // Write the addition to the previous product
1525 // This will print an extra '+' at the beginning but that is fine in glsl
1526 write!(self.out, " + ")?;
1527 // Write the first vector expression, this expression is marked to be
1528 // cached so unless it can't be cached (for example, it's a Constant)
1529 // it shouldn't produce large expressions.
1530 self.write_expr(arg, ctx)?;
1531 // Access the current component on the first vector
1532 write!(self.out, ".{component} * ")?;
1533 // Write the second vector expression, this expression is marked to be
1534 // cached so unless it can't be cached (for example, it's a Constant)
1535 // it shouldn't produce large expressions.
1536 self.write_expr(arg1, ctx)?;
1537 // Access the current component on the second vector
1538 write!(self.out, ".{component}")?;
1539 }
1540
1541 write!(self.out, ")")?;
1542 Ok(())
1543 }
1544
1545 /// Helper method used to write structs
1546 ///
1547 /// # Notes
1548 /// Ends in a newline
1549 fn write_struct_body(
1550 &mut self,
1551 handle: Handle<crate::Type>,
1552 members: &[crate::StructMember],
1553 ) -> BackendResult {
1554 // glsl structs are written as in C
1555 // `struct name() { members };`
1556 // | `struct` is a keyword
1557 // | `name` is the struct name
1558 // | `members` is a semicolon separated list of `type name`
1559 // | `type` is the member type
1560 // | `name` is the member name
1561 writeln!(self.out, "{{")?;
1562
1563 for (idx, member) in members.iter().enumerate() {
1564 // The indentation is only for readability
1565 write!(self.out, "{}", back::INDENT)?;
1566
1567 match self.module.types[member.ty].inner {
1568 TypeInner::Array {
1569 base,
1570 size,
1571 stride: _,
1572 } => {
1573 self.write_type(base)?;
1574 write!(
1575 self.out,
1576 " {}",
1577 &self.names[&NameKey::StructMember(handle, idx as u32)]
1578 )?;
1579 // Write [size]
1580 self.write_array_size(base, size)?;
1581 // Newline is important
1582 writeln!(self.out, ";")?;
1583 }
1584 _ => {
1585 // Write the member type
1586 // Adds no trailing space
1587 self.write_type(member.ty)?;
1588
1589 // Write the member name and put a semicolon
1590 // The leading space is important
1591 // All members must have a semicolon even the last one
1592 writeln!(
1593 self.out,
1594 " {};",
1595 &self.names[&NameKey::StructMember(handle, idx as u32)]
1596 )?;
1597 }
1598 }
1599 }
1600
1601 write!(self.out, "}}")?;
1602 Ok(())
1603 }
1604
1605 /// Helper method used to write statements
1606 ///
1607 /// # Notes
1608 /// Always adds a newline
1609 fn write_stmt(
1610 &mut self,
1611 sta: &crate::Statement,
1612 ctx: &back::FunctionCtx,
1613 level: back::Level,
1614 ) -> BackendResult {
1615 use crate::Statement;
1616
1617 match *sta {
1618 // This is where we can generate intermediate constants for some expression types.
1619 Statement::Emit(ref range) => {
1620 for handle in range.clone() {
1621 let ptr_class = ctx.resolve_type(handle, &self.module.types).pointer_space();
1622 let expr_name = if ptr_class.is_some() {
1623 // GLSL can't save a pointer-valued expression in a variable,
1624 // but we shouldn't ever need to: they should never be named expressions,
1625 // and none of the expression types flagged by bake_ref_count can be pointer-valued.
1626 None
1627 } else if let Some(name) = ctx.named_expressions.get(&handle) {
1628 // Front end provides names for all variables at the start of writing.
1629 // But we write them to step by step. We need to recache them
1630 // Otherwise, we could accidentally write variable name instead of full expression.
1631 // Also, we use sanitized names! It defense backend from generating variable with name from reserved keywords.
1632 Some(self.namer.call(name))
1633 } else if self.need_bake_expressions.contains(&handle) {
1634 Some(Baked(handle).to_string())
1635 } else {
1636 None
1637 };
1638
1639 // If we are going to write an `ImageLoad` next and the target image
1640 // is sampled and we are using the `Restrict` policy for bounds
1641 // checking images we need to write a local holding the clamped lod.
1642 if let crate::Expression::ImageLoad {
1643 image,
1644 level: Some(level_expr),
1645 ..
1646 } = ctx.expressions[handle]
1647 {
1648 if let TypeInner::Image {
1649 class: crate::ImageClass::Sampled { .. },
1650 ..
1651 } = *ctx.resolve_type(image, &self.module.types)
1652 {
1653 if let proc::BoundsCheckPolicy::Restrict = self.policies.image_load {
1654 write!(self.out, "{level}")?;
1655 self.write_clamped_lod(ctx, handle, image, level_expr)?
1656 }
1657 }
1658 }
1659
1660 if let Some(name) = expr_name {
1661 write!(self.out, "{level}")?;
1662 self.write_named_expr(handle, name, handle, ctx)?;
1663 }
1664 }
1665 }
1666 // Blocks are simple we just need to write the block statements between braces
1667 // We could also just print the statements but this is more readable and maps more
1668 // closely to the IR
1669 Statement::Block(ref block) => {
1670 write!(self.out, "{level}")?;
1671 writeln!(self.out, "{{")?;
1672 for sta in block.iter() {
1673 // Increase the indentation to help with readability
1674 self.write_stmt(sta, ctx, level.next())?
1675 }
1676 writeln!(self.out, "{level}}}")?
1677 }
1678 // Ifs are written as in C:
1679 // ```
1680 // if(condition) {
1681 // accept
1682 // } else {
1683 // reject
1684 // }
1685 // ```
1686 Statement::If {
1687 condition,
1688 ref accept,
1689 ref reject,
1690 } => {
1691 write!(self.out, "{level}")?;
1692 write!(self.out, "if (")?;
1693 self.write_expr(condition, ctx)?;
1694 writeln!(self.out, ") {{")?;
1695
1696 for sta in accept {
1697 // Increase indentation to help with readability
1698 self.write_stmt(sta, ctx, level.next())?;
1699 }
1700
1701 // If there are no statements in the reject block we skip writing it
1702 // This is only for readability
1703 if !reject.is_empty() {
1704 writeln!(self.out, "{level}}} else {{")?;
1705
1706 for sta in reject {
1707 // Increase indentation to help with readability
1708 self.write_stmt(sta, ctx, level.next())?;
1709 }
1710 }
1711
1712 writeln!(self.out, "{level}}}")?
1713 }
1714 // Switch are written as in C:
1715 // ```
1716 // switch (selector) {
1717 // // Fallthrough
1718 // case label:
1719 // block
1720 // // Non fallthrough
1721 // case label:
1722 // block
1723 // break;
1724 // default:
1725 // block
1726 // }
1727 // ```
1728 // Where the `default` case happens isn't important but we put it last
1729 // so that we don't need to print a `break` for it
1730 Statement::Switch {
1731 selector,
1732 ref cases,
1733 } => {
1734 let l2 = level.next();
1735 // Some GLSL consumers may not handle switches with a single
1736 // body correctly: See wgpu#4514. Write such switch statements
1737 // as a `do {} while(false);` loop instead.
1738 //
1739 // Since doing so may inadvertently capture `continue`
1740 // statements in the switch body, we must apply continue
1741 // forwarding. See the `naga::back::continue_forward` module
1742 // docs for details.
1743 let one_body = cases
1744 .iter()
1745 .rev()
1746 .skip(1)
1747 .all(|case| case.fall_through && case.body.is_empty());
1748 if one_body {
1749 // Unlike HLSL, in GLSL `continue_ctx` only needs to know
1750 // about [`Switch`] statements that are being rendered as
1751 // `do-while` loops.
1752 if let Some(variable) = self.continue_ctx.enter_switch(&mut self.namer) {
1753 writeln!(self.out, "{level}bool {variable} = false;",)?;
1754 };
1755 writeln!(self.out, "{level}do {{")?;
1756 // Note: Expressions have no side-effects so we don't need to emit selector expression.
1757
1758 // Body
1759 if let Some(case) = cases.last() {
1760 for sta in case.body.iter() {
1761 self.write_stmt(sta, ctx, l2)?;
1762 }
1763 }
1764 // End do-while
1765 writeln!(self.out, "{level}}} while(false);")?;
1766
1767 // Handle any forwarded continue statements.
1768 use back::continue_forward::ExitControlFlow;
1769 let op = match self.continue_ctx.exit_switch() {
1770 ExitControlFlow::None => None,
1771 ExitControlFlow::Continue { variable } => Some(("continue", variable)),
1772 ExitControlFlow::Break { variable } => Some(("break", variable)),
1773 };
1774 if let Some((control_flow, variable)) = op {
1775 writeln!(self.out, "{level}if ({variable}) {{")?;
1776 writeln!(self.out, "{l2}{control_flow};")?;
1777 writeln!(self.out, "{level}}}")?;
1778 }
1779 } else {
1780 // Start the switch
1781 write!(self.out, "{level}")?;
1782 write!(self.out, "switch(")?;
1783 self.write_expr(selector, ctx)?;
1784 writeln!(self.out, ") {{")?;
1785
1786 // Write all cases
1787 for case in cases {
1788 match case.value {
1789 crate::SwitchValue::I32(value) => {
1790 write!(self.out, "{l2}case {value}:")?
1791 }
1792 crate::SwitchValue::U32(value) => {
1793 write!(self.out, "{l2}case {value}u:")?
1794 }
1795 crate::SwitchValue::Default => write!(self.out, "{l2}default:")?,
1796 }
1797
1798 let write_block_braces = !(case.fall_through && case.body.is_empty());
1799 if write_block_braces {
1800 writeln!(self.out, " {{")?;
1801 } else {
1802 writeln!(self.out)?;
1803 }
1804
1805 for sta in case.body.iter() {
1806 self.write_stmt(sta, ctx, l2.next())?;
1807 }
1808
1809 if !case.fall_through && case.body.last().is_none_or(|s| !s.is_terminator())
1810 {
1811 writeln!(self.out, "{}break;", l2.next())?;
1812 }
1813
1814 if write_block_braces {
1815 writeln!(self.out, "{l2}}}")?;
1816 }
1817 }
1818
1819 writeln!(self.out, "{level}}}")?
1820 }
1821 }
1822 // Loops in naga IR are based on wgsl loops, glsl can emulate the behaviour by using a
1823 // while true loop and appending the continuing block to the body resulting on:
1824 // ```
1825 // bool loop_init = true;
1826 // while(true) {
1827 // if (!loop_init) { <continuing> }
1828 // loop_init = false;
1829 // <body>
1830 // }
1831 // ```
1832 Statement::Loop {
1833 ref body,
1834 ref continuing,
1835 break_if,
1836 } => {
1837 self.continue_ctx.enter_loop();
1838 if !continuing.is_empty() || break_if.is_some() {
1839 let gate_name = self.namer.call("loop_init");
1840 writeln!(self.out, "{level}bool {gate_name} = true;")?;
1841 writeln!(self.out, "{level}while(true) {{")?;
1842 let l2 = level.next();
1843 let l3 = l2.next();
1844 writeln!(self.out, "{l2}if (!{gate_name}) {{")?;
1845 for sta in continuing {
1846 self.write_stmt(sta, ctx, l3)?;
1847 }
1848 if let Some(condition) = break_if {
1849 write!(self.out, "{l3}if (")?;
1850 self.write_expr(condition, ctx)?;
1851 writeln!(self.out, ") {{")?;
1852 writeln!(self.out, "{}break;", l3.next())?;
1853 writeln!(self.out, "{l3}}}")?;
1854 }
1855 writeln!(self.out, "{l2}}}")?;
1856 writeln!(self.out, "{}{} = false;", level.next(), gate_name)?;
1857 } else {
1858 writeln!(self.out, "{level}while(true) {{")?;
1859 }
1860 for sta in body {
1861 self.write_stmt(sta, ctx, level.next())?;
1862 }
1863 writeln!(self.out, "{level}}}")?;
1864 self.continue_ctx.exit_loop();
1865 }
1866 // Break, continue and return as written as in C
1867 // `break;`
1868 Statement::Break => {
1869 write!(self.out, "{level}")?;
1870 writeln!(self.out, "break;")?
1871 }
1872 // `continue;`
1873 Statement::Continue => {
1874 // Sometimes we must render a `Continue` statement as a `break`.
1875 // See the docs for the `back::continue_forward` module.
1876 if let Some(variable) = self.continue_ctx.continue_encountered() {
1877 writeln!(self.out, "{level}{variable} = true;",)?;
1878 writeln!(self.out, "{level}break;")?
1879 } else {
1880 writeln!(self.out, "{level}continue;")?
1881 }
1882 }
1883 // `return expr;`, `expr` is optional
1884 Statement::Return { value } => {
1885 write!(self.out, "{level}")?;
1886 match ctx.ty {
1887 back::FunctionType::Function(_) => {
1888 write!(self.out, "return")?;
1889 // Write the expression to be returned if needed
1890 if let Some(expr) = value {
1891 write!(self.out, " ")?;
1892 self.write_expr(expr, ctx)?;
1893 }
1894 writeln!(self.out, ";")?;
1895 }
1896 back::FunctionType::EntryPoint(ep_index) => {
1897 let mut has_point_size = false;
1898 let ep = &self.module.entry_points[ep_index as usize];
1899 if let Some(ref result) = ep.function.result {
1900 let value = value.unwrap();
1901 match self.module.types[result.ty].inner {
1902 TypeInner::Struct { ref members, .. } => {
1903 let temp_struct_name = match ctx.expressions[value] {
1904 crate::Expression::Compose { .. } => {
1905 let return_struct = "_tmp_return";
1906 write!(
1907 self.out,
1908 "{} {} = ",
1909 &self.names[&NameKey::Type(result.ty)],
1910 return_struct
1911 )?;
1912 self.write_expr(value, ctx)?;
1913 writeln!(self.out, ";")?;
1914 write!(self.out, "{level}")?;
1915 Some(return_struct)
1916 }
1917 _ => None,
1918 };
1919
1920 for (index, member) in members.iter().enumerate() {
1921 if let Some(crate::Binding::BuiltIn(
1922 crate::BuiltIn::PointSize,
1923 )) = member.binding
1924 {
1925 has_point_size = true;
1926 }
1927
1928 let varying_name = VaryingName {
1929 binding: member.binding.as_ref().unwrap(),
1930 stage: ep.stage,
1931 options: VaryingOptions::from_writer_options(
1932 self.options,
1933 true,
1934 ),
1935 };
1936 write!(self.out, "{varying_name} = ")?;
1937
1938 if let Some(struct_name) = temp_struct_name {
1939 write!(self.out, "{struct_name}")?;
1940 } else {
1941 self.write_expr(value, ctx)?;
1942 }
1943
1944 // Write field name
1945 writeln!(
1946 self.out,
1947 ".{};",
1948 &self.names
1949 [&NameKey::StructMember(result.ty, index as u32)]
1950 )?;
1951 write!(self.out, "{level}")?;
1952 }
1953 }
1954 _ => {
1955 let name = VaryingName {
1956 binding: result.binding.as_ref().unwrap(),
1957 stage: ep.stage,
1958 options: VaryingOptions::from_writer_options(
1959 self.options,
1960 true,
1961 ),
1962 };
1963 write!(self.out, "{name} = ")?;
1964 self.write_expr(value, ctx)?;
1965 writeln!(self.out, ";")?;
1966 write!(self.out, "{level}")?;
1967 }
1968 }
1969 }
1970
1971 let is_vertex_stage = self.module.entry_points[ep_index as usize].stage
1972 == ShaderStage::Vertex;
1973 if is_vertex_stage
1974 && self
1975 .options
1976 .writer_flags
1977 .contains(WriterFlags::ADJUST_COORDINATE_SPACE)
1978 {
1979 writeln!(
1980 self.out,
1981 "gl_Position.yz = vec2(-gl_Position.y, gl_Position.z * 2.0 - gl_Position.w);",
1982 )?;
1983 write!(self.out, "{level}")?;
1984 }
1985
1986 if is_vertex_stage
1987 && self
1988 .options
1989 .writer_flags
1990 .contains(WriterFlags::FORCE_POINT_SIZE)
1991 && !has_point_size
1992 {
1993 writeln!(self.out, "gl_PointSize = 1.0;")?;
1994 write!(self.out, "{level}")?;
1995 }
1996 writeln!(self.out, "return;")?;
1997 }
1998 }
1999 }
2000 // This is one of the places were glsl adds to the syntax of C in this case the discard
2001 // keyword which ceases all further processing in a fragment shader, it's called OpKill
2002 // in spir-v that's why it's called `Statement::Kill`
2003 Statement::Kill => writeln!(self.out, "{level}discard;")?,
2004 Statement::ControlBarrier(flags) => {
2005 self.write_control_barrier(flags, level)?;
2006 }
2007 Statement::MemoryBarrier(flags) => {
2008 self.write_memory_barrier(flags, level)?;
2009 }
2010 // Stores in glsl are just variable assignments written as `pointer = value;`
2011 Statement::Store { pointer, value } => {
2012 write!(self.out, "{level}")?;
2013 let is_atomic_pointer = ctx
2014 .resolve_type(pointer, &self.module.types)
2015 .is_atomic_pointer(&self.module.types);
2016 if is_atomic_pointer {
2017 write!(self.out, "atomicExchange(")?;
2018 self.write_expr(pointer, ctx)?;
2019 write!(self.out, ", ")?;
2020 self.write_expr(value, ctx)?;
2021 writeln!(self.out, ");")?
2022 } else {
2023 self.write_expr(pointer, ctx)?;
2024 write!(self.out, " = ")?;
2025 self.write_expr(value, ctx)?;
2026 writeln!(self.out, ";")?
2027 }
2028 }
2029 Statement::WorkGroupUniformLoad { pointer, result } => {
2030 // GLSL doesn't have pointers, which means that this backend needs to ensure that
2031 // the actual "loading" is happening between the two barriers.
2032 // This is done in `Emit` by never emitting a variable name for pointer variables
2033 self.write_control_barrier(crate::Barrier::WORK_GROUP, level)?;
2034
2035 let result_name = Baked(result).to_string();
2036 write!(self.out, "{level}")?;
2037 // Expressions cannot have side effects, so just writing the expression here is fine.
2038 self.write_named_expr(pointer, result_name, result, ctx)?;
2039
2040 self.write_control_barrier(crate::Barrier::WORK_GROUP, level)?;
2041 }
2042 // Stores a value into an image.
2043 Statement::ImageStore {
2044 image,
2045 coordinate,
2046 array_index,
2047 value,
2048 } => {
2049 write!(self.out, "{level}")?;
2050 self.write_image_store(ctx, image, coordinate, array_index, value)?
2051 }
2052 // A `Call` is written `name(arguments)` where `arguments` is a comma separated expressions list
2053 Statement::Call {
2054 function,
2055 ref arguments,
2056 result,
2057 } => {
2058 write!(self.out, "{level}")?;
2059 if let Some(expr) = result {
2060 let name = Baked(expr).to_string();
2061 let result = self.module.functions[function].result.as_ref().unwrap();
2062 self.write_type(result.ty)?;
2063 write!(self.out, " {name}")?;
2064 if let TypeInner::Array { base, size, .. } = self.module.types[result.ty].inner
2065 {
2066 self.write_array_size(base, size)?
2067 }
2068 write!(self.out, " = ")?;
2069 self.named_expressions.insert(expr, name);
2070 }
2071 write!(self.out, "{}(", &self.names[&NameKey::Function(function)])?;
2072 let arguments: Vec<_> = arguments
2073 .iter()
2074 .enumerate()
2075 .filter_map(|(i, arg)| {
2076 let arg_ty = self.module.functions[function].arguments[i].ty;
2077 match self.module.types[arg_ty].inner {
2078 TypeInner::Sampler { .. } => None,
2079 _ => Some(*arg),
2080 }
2081 })
2082 .collect();
2083 self.write_slice(&arguments, |this, _, arg| this.write_expr(*arg, ctx))?;
2084 writeln!(self.out, ");")?
2085 }
2086 Statement::Atomic {
2087 pointer,
2088 ref fun,
2089 value,
2090 result,
2091 } => {
2092 write!(self.out, "{level}")?;
2093
2094 match *fun {
2095 crate::AtomicFunction::Exchange {
2096 compare: Some(compare_expr),
2097 } => {
2098 let result_handle = result.expect("CompareExchange must have a result");
2099 let res_name = Baked(result_handle).to_string();
2100 self.write_type(ctx.info[result_handle].ty.handle().unwrap())?;
2101 write!(self.out, " {res_name};")?;
2102 write!(self.out, " {res_name}.old_value = atomicCompSwap(")?;
2103 self.write_expr(pointer, ctx)?;
2104 write!(self.out, ", ")?;
2105 self.write_expr(compare_expr, ctx)?;
2106 write!(self.out, ", ")?;
2107 self.write_expr(value, ctx)?;
2108 writeln!(self.out, ");")?;
2109
2110 write!(
2111 self.out,
2112 "{level}{res_name}.exchanged = ({res_name}.old_value == "
2113 )?;
2114 self.write_expr(compare_expr, ctx)?;
2115 writeln!(self.out, ");")?;
2116 self.named_expressions.insert(result_handle, res_name);
2117 }
2118 _ => {
2119 if let Some(result) = result {
2120 let res_name = Baked(result).to_string();
2121 self.write_type(ctx.info[result].ty.handle().unwrap())?;
2122 write!(self.out, " {res_name} = ")?;
2123 self.named_expressions.insert(result, res_name);
2124 }
2125 let fun_str = fun.to_glsl();
2126 write!(self.out, "atomic{fun_str}(")?;
2127 self.write_expr(pointer, ctx)?;
2128 write!(self.out, ", ")?;
2129 if let crate::AtomicFunction::Subtract = *fun {
2130 // Emulate `atomicSub` with `atomicAdd` by negating the value.
2131 write!(self.out, "-")?;
2132 }
2133 self.write_expr(value, ctx)?;
2134 writeln!(self.out, ");")?;
2135 }
2136 }
2137 }
2138 // Stores a value into an image.
2139 Statement::ImageAtomic {
2140 image,
2141 coordinate,
2142 array_index,
2143 fun,
2144 value,
2145 } => {
2146 write!(self.out, "{level}")?;
2147 self.write_image_atomic(ctx, image, coordinate, array_index, fun, value)?
2148 }
2149 Statement::RayQuery { .. } => unreachable!(),
2150 Statement::SubgroupBallot { result, predicate } => {
2151 write!(self.out, "{level}")?;
2152 let res_name = Baked(result).to_string();
2153 let res_ty = ctx.info[result].ty.inner_with(&self.module.types);
2154 self.write_value_type(res_ty)?;
2155 write!(self.out, " {res_name} = ")?;
2156 self.named_expressions.insert(result, res_name);
2157
2158 write!(self.out, "subgroupBallot(")?;
2159 match predicate {
2160 Some(predicate) => self.write_expr(predicate, ctx)?,
2161 None => write!(self.out, "true")?,
2162 }
2163 writeln!(self.out, ");")?;
2164 }
2165 Statement::SubgroupCollectiveOperation {
2166 op,
2167 collective_op,
2168 argument,
2169 result,
2170 } => {
2171 write!(self.out, "{level}")?;
2172 let res_name = Baked(result).to_string();
2173 let res_ty = ctx.info[result].ty.inner_with(&self.module.types);
2174 self.write_value_type(res_ty)?;
2175 write!(self.out, " {res_name} = ")?;
2176 self.named_expressions.insert(result, res_name);
2177
2178 match (collective_op, op) {
2179 (crate::CollectiveOperation::Reduce, crate::SubgroupOperation::All) => {
2180 write!(self.out, "subgroupAll(")?
2181 }
2182 (crate::CollectiveOperation::Reduce, crate::SubgroupOperation::Any) => {
2183 write!(self.out, "subgroupAny(")?
2184 }
2185 (crate::CollectiveOperation::Reduce, crate::SubgroupOperation::Add) => {
2186 write!(self.out, "subgroupAdd(")?
2187 }
2188 (crate::CollectiveOperation::Reduce, crate::SubgroupOperation::Mul) => {
2189 write!(self.out, "subgroupMul(")?
2190 }
2191 (crate::CollectiveOperation::Reduce, crate::SubgroupOperation::Max) => {
2192 write!(self.out, "subgroupMax(")?
2193 }
2194 (crate::CollectiveOperation::Reduce, crate::SubgroupOperation::Min) => {
2195 write!(self.out, "subgroupMin(")?
2196 }
2197 (crate::CollectiveOperation::Reduce, crate::SubgroupOperation::And) => {
2198 write!(self.out, "subgroupAnd(")?
2199 }
2200 (crate::CollectiveOperation::Reduce, crate::SubgroupOperation::Or) => {
2201 write!(self.out, "subgroupOr(")?
2202 }
2203 (crate::CollectiveOperation::Reduce, crate::SubgroupOperation::Xor) => {
2204 write!(self.out, "subgroupXor(")?
2205 }
2206 (crate::CollectiveOperation::ExclusiveScan, crate::SubgroupOperation::Add) => {
2207 write!(self.out, "subgroupExclusiveAdd(")?
2208 }
2209 (crate::CollectiveOperation::ExclusiveScan, crate::SubgroupOperation::Mul) => {
2210 write!(self.out, "subgroupExclusiveMul(")?
2211 }
2212 (crate::CollectiveOperation::InclusiveScan, crate::SubgroupOperation::Add) => {
2213 write!(self.out, "subgroupInclusiveAdd(")?
2214 }
2215 (crate::CollectiveOperation::InclusiveScan, crate::SubgroupOperation::Mul) => {
2216 write!(self.out, "subgroupInclusiveMul(")?
2217 }
2218 _ => unimplemented!(),
2219 }
2220 self.write_expr(argument, ctx)?;
2221 writeln!(self.out, ");")?;
2222 }
2223 Statement::SubgroupGather {
2224 mode,
2225 argument,
2226 result,
2227 } => {
2228 write!(self.out, "{level}")?;
2229 let res_name = Baked(result).to_string();
2230 let res_ty = ctx.info[result].ty.inner_with(&self.module.types);
2231 self.write_value_type(res_ty)?;
2232 write!(self.out, " {res_name} = ")?;
2233 self.named_expressions.insert(result, res_name);
2234
2235 match mode {
2236 crate::GatherMode::BroadcastFirst => {
2237 write!(self.out, "subgroupBroadcastFirst(")?;
2238 }
2239 crate::GatherMode::Broadcast(_) => {
2240 write!(self.out, "subgroupBroadcast(")?;
2241 }
2242 crate::GatherMode::Shuffle(_) => {
2243 write!(self.out, "subgroupShuffle(")?;
2244 }
2245 crate::GatherMode::ShuffleDown(_) => {
2246 write!(self.out, "subgroupShuffleDown(")?;
2247 }
2248 crate::GatherMode::ShuffleUp(_) => {
2249 write!(self.out, "subgroupShuffleUp(")?;
2250 }
2251 crate::GatherMode::ShuffleXor(_) => {
2252 write!(self.out, "subgroupShuffleXor(")?;
2253 }
2254 crate::GatherMode::QuadBroadcast(_) => {
2255 write!(self.out, "subgroupQuadBroadcast(")?;
2256 }
2257 crate::GatherMode::QuadSwap(direction) => match direction {
2258 crate::Direction::X => {
2259 write!(self.out, "subgroupQuadSwapHorizontal(")?;
2260 }
2261 crate::Direction::Y => {
2262 write!(self.out, "subgroupQuadSwapVertical(")?;
2263 }
2264 crate::Direction::Diagonal => {
2265 write!(self.out, "subgroupQuadSwapDiagonal(")?;
2266 }
2267 },
2268 }
2269 self.write_expr(argument, ctx)?;
2270 match mode {
2271 crate::GatherMode::BroadcastFirst => {}
2272 crate::GatherMode::Broadcast(index)
2273 | crate::GatherMode::Shuffle(index)
2274 | crate::GatherMode::ShuffleDown(index)
2275 | crate::GatherMode::ShuffleUp(index)
2276 | crate::GatherMode::ShuffleXor(index)
2277 | crate::GatherMode::QuadBroadcast(index) => {
2278 write!(self.out, ", ")?;
2279 self.write_expr(index, ctx)?;
2280 }
2281 crate::GatherMode::QuadSwap(_) => {}
2282 }
2283 writeln!(self.out, ");")?;
2284 }
2285 Statement::CooperativeStore { .. } => unimplemented!(),
2286 Statement::RayPipelineFunction(_) => unimplemented!(),
2287 }
2288
2289 Ok(())
2290 }
2291
2292 /// Write a const expression.
2293 ///
2294 /// Write `expr`, a handle to an [`Expression`] in the current [`Module`]'s
2295 /// constant expression arena, as GLSL expression.
2296 ///
2297 /// # Notes
2298 /// Adds no newlines or leading/trailing whitespace
2299 ///
2300 /// [`Expression`]: crate::Expression
2301 /// [`Module`]: crate::Module
2302 fn write_const_expr(
2303 &mut self,
2304 expr: Handle<crate::Expression>,
2305 arena: &crate::Arena<crate::Expression>,
2306 ) -> BackendResult {
2307 self.write_possibly_const_expr(
2308 expr,
2309 arena,
2310 |expr| &self.info[expr],
2311 |writer, expr| writer.write_const_expr(expr, arena),
2312 )
2313 }
2314
2315 /// Write [`Expression`] variants that can occur in both runtime and const expressions.
2316 ///
2317 /// Write `expr`, a handle to an [`Expression`] in the arena `expressions`,
2318 /// as as GLSL expression. This must be one of the [`Expression`] variants
2319 /// that is allowed to occur in constant expressions.
2320 ///
2321 /// Use `write_expression` to write subexpressions.
2322 ///
2323 /// This is the common code for `write_expr`, which handles arbitrary
2324 /// runtime expressions, and `write_const_expr`, which only handles
2325 /// const-expressions. Each of those callers passes itself (essentially) as
2326 /// the `write_expression` callback, so that subexpressions are restricted
2327 /// to the appropriate variants.
2328 ///
2329 /// # Notes
2330 /// Adds no newlines or leading/trailing whitespace
2331 ///
2332 /// [`Expression`]: crate::Expression
2333 fn write_possibly_const_expr<'w, I, E>(
2334 &'w mut self,
2335 expr: Handle<crate::Expression>,
2336 expressions: &crate::Arena<crate::Expression>,
2337 info: I,
2338 write_expression: E,
2339 ) -> BackendResult
2340 where
2341 I: Fn(Handle<crate::Expression>) -> &'w proc::TypeResolution,
2342 E: Fn(&mut Self, Handle<crate::Expression>) -> BackendResult,
2343 {
2344 use crate::Expression;
2345
2346 match expressions[expr] {
2347 Expression::Literal(literal) => {
2348 match literal {
2349 // Floats are written using `Debug` instead of `Display` because it always appends the
2350 // decimal part even it's zero which is needed for a valid glsl float constant
2351 crate::Literal::F64(value) => write!(self.out, "{value:?}LF")?,
2352 crate::Literal::F32(value) => write!(self.out, "{value:?}")?,
2353 crate::Literal::F16(_) => {
2354 return Err(Error::Custom("GLSL has no 16-bit float type".into()));
2355 }
2356 // Unsigned integers need a `u` at the end
2357 //
2358 // While `core` doesn't necessarily need it, it's allowed and since `es` needs it we
2359 // always write it as the extra branch wouldn't have any benefit in readability
2360 crate::Literal::U16(value) => write!(self.out, "uint16_t({value})")?,
2361 crate::Literal::I16(value) => write!(self.out, "int16_t({value})")?,
2362 crate::Literal::U32(value) => write!(self.out, "{value}u")?,
2363 crate::Literal::I32(value) => write!(self.out, "{value}")?,
2364 crate::Literal::Bool(value) => write!(self.out, "{value}")?,
2365 crate::Literal::I64(_) => {
2366 return Err(Error::Custom("GLSL has no 64-bit integer type".into()));
2367 }
2368 crate::Literal::U64(_) => {
2369 return Err(Error::Custom("GLSL has no 64-bit integer type".into()));
2370 }
2371 crate::Literal::AbstractInt(_) | crate::Literal::AbstractFloat(_) => {
2372 return Err(Error::Custom(
2373 "Abstract types should not appear in IR presented to backends".into(),
2374 ));
2375 }
2376 }
2377 }
2378 Expression::Constant(handle) => {
2379 let constant = &self.module.constants[handle];
2380 if constant.name.is_some() {
2381 write!(self.out, "{}", self.names[&NameKey::Constant(handle)])?;
2382 } else {
2383 self.write_const_expr(constant.init, &self.module.global_expressions)?;
2384 }
2385 }
2386 Expression::ZeroValue(ty) => {
2387 self.write_zero_init_value(ty)?;
2388 }
2389 Expression::Compose { ty, ref components } => {
2390 self.write_type(ty)?;
2391
2392 if let TypeInner::Array { base, size, .. } = self.module.types[ty].inner {
2393 self.write_array_size(base, size)?;
2394 }
2395
2396 write!(self.out, "(")?;
2397 for (index, component) in components.iter().enumerate() {
2398 if index != 0 {
2399 write!(self.out, ", ")?;
2400 }
2401 write_expression(self, *component)?;
2402 }
2403 write!(self.out, ")")?
2404 }
2405 // `Splat` needs to actually write down a vector, it's not always inferred in GLSL.
2406 Expression::Splat { size: _, value } => {
2407 let resolved = info(expr).inner_with(&self.module.types);
2408 self.write_value_type(resolved)?;
2409 write!(self.out, "(")?;
2410 write_expression(self, value)?;
2411 write!(self.out, ")")?
2412 }
2413 _ => {
2414 return Err(Error::Override);
2415 }
2416 }
2417
2418 Ok(())
2419 }
2420
2421 /// Helper method to write expressions
2422 ///
2423 /// # Notes
2424 /// Doesn't add any newlines or leading/trailing spaces
2425 #[allow(clippy::large_stack_frames)] // TODO(https://github.com/gfx-rs/wgpu/issues/9456)
2426 fn write_expr(
2427 &mut self,
2428 expr: Handle<crate::Expression>,
2429 ctx: &back::FunctionCtx,
2430 ) -> BackendResult {
2431 use crate::Expression;
2432
2433 if let Some(name) = self.named_expressions.get(&expr) {
2434 write!(self.out, "{name}")?;
2435 return Ok(());
2436 }
2437
2438 match ctx.expressions[expr] {
2439 Expression::Literal(_)
2440 | Expression::Constant(_)
2441 | Expression::ZeroValue(_)
2442 | Expression::Compose { .. }
2443 | Expression::Splat { .. } => {
2444 self.write_possibly_const_expr(
2445 expr,
2446 ctx.expressions,
2447 |expr| &ctx.info[expr].ty,
2448 |writer, expr| writer.write_expr(expr, ctx),
2449 )?;
2450 }
2451 Expression::Override(_) => return Err(Error::Override),
2452 // `Access` is applied to arrays, vectors and matrices and is written as indexing
2453 Expression::Access { base, index } => {
2454 self.write_expr(base, ctx)?;
2455 write!(self.out, "[")?;
2456 self.write_expr(index, ctx)?;
2457 write!(self.out, "]")?
2458 }
2459 // `AccessIndex` is the same as `Access` except that the index is a constant and it can
2460 // be applied to structs, in this case we need to find the name of the field at that
2461 // index and write `base.field_name`
2462 Expression::AccessIndex { base, index } => {
2463 self.write_expr(base, ctx)?;
2464
2465 let base_ty_res = &ctx.info[base].ty;
2466 let mut resolved = base_ty_res.inner_with(&self.module.types);
2467 let base_ty_handle = match *resolved {
2468 TypeInner::Pointer { base, space: _ } => {
2469 resolved = &self.module.types[base].inner;
2470 Some(base)
2471 }
2472 _ => base_ty_res.handle(),
2473 };
2474
2475 match *resolved {
2476 TypeInner::Vector { .. } => {
2477 // Write vector access as a swizzle
2478 write!(self.out, ".{}", back::COMPONENTS[index as usize])?
2479 }
2480 TypeInner::Matrix { .. }
2481 | TypeInner::Array { .. }
2482 | TypeInner::ValuePointer { .. } => write!(self.out, "[{index}]")?,
2483 TypeInner::Struct { .. } => {
2484 // This will never panic in case the type is a `Struct`, this is not true
2485 // for other types so we can only check while inside this match arm
2486 let ty = base_ty_handle.unwrap();
2487
2488 write!(
2489 self.out,
2490 ".{}",
2491 &self.names[&NameKey::StructMember(ty, index)]
2492 )?
2493 }
2494 ref other => return Err(Error::Custom(format!("Cannot index {other:?}"))),
2495 }
2496 }
2497 // `Swizzle` adds a few letters behind the dot.
2498 Expression::Swizzle {
2499 size,
2500 vector,
2501 pattern,
2502 } => {
2503 self.write_expr(vector, ctx)?;
2504 write!(self.out, ".")?;
2505 for &sc in pattern[..size as usize].iter() {
2506 self.out.write_char(back::COMPONENTS[sc as usize])?;
2507 }
2508 }
2509 // Function arguments are written as the argument name
2510 Expression::FunctionArgument(pos) => {
2511 write!(self.out, "{}", &self.names[&ctx.argument_key(pos)])?
2512 }
2513 // Global variables need some special work for their name but
2514 // `get_global_name` does the work for us
2515 Expression::GlobalVariable(handle) => {
2516 let global = &self.module.global_variables[handle];
2517 self.write_global_name(handle, global)?
2518 }
2519 // A local is written as it's name
2520 Expression::LocalVariable(handle) => {
2521 write!(self.out, "{}", self.names[&ctx.name_key(handle)])?
2522 }
2523 // glsl has no pointers so there's no load operation, just write the pointer expression
2524 Expression::Load { pointer } => {
2525 let ty_inner = ctx.resolve_type(pointer, &self.module.types);
2526 if ty_inner.is_atomic_pointer(&self.module.types) {
2527 let mut suffix = "";
2528 if let TypeInner::Pointer { base, .. } = *ty_inner {
2529 if let TypeInner::Atomic(scalar) = self.module.types[base].inner {
2530 suffix = match (scalar.kind, scalar.width) {
2531 (crate::ScalarKind::Uint, 8) => "ul",
2532 (crate::ScalarKind::Sint, 8) => "l",
2533 (crate::ScalarKind::Uint, _) => "u",
2534 _ => "",
2535 };
2536 }
2537 }
2538 write!(self.out, "atomicOr(")?;
2539 self.write_expr(pointer, ctx)?;
2540 write!(self.out, ", 0{})", suffix)?
2541 } else {
2542 self.write_expr(pointer, ctx)?
2543 }
2544 }
2545 // `ImageSample` is a bit complicated compared to the rest of the IR.
2546 //
2547 // First there are three variations depending whether the sample level is explicitly set,
2548 // if it's automatic or it it's bias:
2549 // `texture(image, coordinate)` - Automatic sample level
2550 // `texture(image, coordinate, bias)` - Bias sample level
2551 // `textureLod(image, coordinate, level)` - Zero or Exact sample level
2552 //
2553 // Furthermore if `depth_ref` is some we need to append it to the coordinate vector
2554 Expression::ImageSample {
2555 image,
2556 sampler: _, //TODO?
2557 gather,
2558 coordinate,
2559 array_index,
2560 offset,
2561 level,
2562 depth_ref,
2563 clamp_to_edge: _,
2564 } => {
2565 let (dim, class, arrayed) = match *ctx.resolve_type(image, &self.module.types) {
2566 TypeInner::Image {
2567 dim,
2568 class,
2569 arrayed,
2570 ..
2571 } => (dim, class, arrayed),
2572 _ => unreachable!(),
2573 };
2574 let mut err = None;
2575 if dim == crate::ImageDimension::Cube {
2576 if offset.is_some() {
2577 err = Some("gsamplerCube[Array][Shadow] doesn't support texture sampling with offsets");
2578 }
2579 if arrayed
2580 && matches!(class, crate::ImageClass::Depth { .. })
2581 && matches!(level, crate::SampleLevel::Gradient { .. })
2582 {
2583 err = Some("samplerCubeArrayShadow don't support textureGrad");
2584 }
2585 }
2586 if gather.is_some() && level != crate::SampleLevel::Zero {
2587 err = Some("textureGather doesn't support LOD parameters");
2588 }
2589 if let Some(err) = err {
2590 return Err(Error::Custom(String::from(err)));
2591 }
2592
2593 // `textureLod[Offset]` on `sampler2DArrayShadow` and `samplerCubeShadow` does not exist in GLSL,
2594 // unless `GL_EXT_texture_shadow_lod` is present.
2595 // But if the target LOD is zero, we can emulate that by using `textureGrad[Offset]` with a constant gradient of 0.
2596 let workaround_lod_with_grad = ((dim == crate::ImageDimension::Cube && !arrayed)
2597 || (dim == crate::ImageDimension::D2 && arrayed))
2598 && level == crate::SampleLevel::Zero
2599 && matches!(class, crate::ImageClass::Depth { .. })
2600 && !self.features.contains(Features::TEXTURE_SHADOW_LOD);
2601
2602 // Write the function to be used depending on the sample level
2603 let fun_name = match level {
2604 crate::SampleLevel::Zero if gather.is_some() => "textureGather",
2605 crate::SampleLevel::Zero if workaround_lod_with_grad => "textureGrad",
2606 crate::SampleLevel::Auto | crate::SampleLevel::Bias(_) => "texture",
2607 crate::SampleLevel::Zero | crate::SampleLevel::Exact(_) => "textureLod",
2608 crate::SampleLevel::Gradient { .. } => "textureGrad",
2609 };
2610 let offset_name = match offset {
2611 Some(_) => "Offset",
2612 None => "",
2613 };
2614
2615 write!(self.out, "{fun_name}{offset_name}(")?;
2616
2617 // Write the image that will be used
2618 self.write_expr(image, ctx)?;
2619 // The space here isn't required but it helps with readability
2620 write!(self.out, ", ")?;
2621
2622 // TODO: handle clamp_to_edge
2623 // https://github.com/gfx-rs/wgpu/issues/7791
2624
2625 // We need to get the coordinates vector size to later build a vector that's `size + 1`
2626 // if `depth_ref` is some, if it isn't a vector we panic as that's not a valid expression
2627 let mut coord_dim = match *ctx.resolve_type(coordinate, &self.module.types) {
2628 TypeInner::Vector { size, .. } => size as u8,
2629 TypeInner::Scalar { .. } => 1,
2630 _ => unreachable!(),
2631 };
2632
2633 if array_index.is_some() {
2634 coord_dim += 1;
2635 }
2636 let merge_depth_ref = depth_ref.is_some() && gather.is_none() && coord_dim < 4;
2637 if merge_depth_ref {
2638 coord_dim += 1;
2639 }
2640
2641 let tex_1d_hack = dim == crate::ImageDimension::D1 && self.options.version.is_es();
2642 let is_vec = tex_1d_hack || coord_dim != 1;
2643 // Compose a new texture coordinates vector
2644 if is_vec {
2645 write!(self.out, "vec{}(", coord_dim + tex_1d_hack as u8)?;
2646 }
2647 self.write_expr(coordinate, ctx)?;
2648 if tex_1d_hack {
2649 write!(self.out, ", 0.0")?;
2650 }
2651 if let Some(expr) = array_index {
2652 write!(self.out, ", ")?;
2653 self.write_expr(expr, ctx)?;
2654 }
2655 if merge_depth_ref {
2656 write!(self.out, ", ")?;
2657 self.write_expr(depth_ref.unwrap(), ctx)?;
2658 }
2659 if is_vec {
2660 write!(self.out, ")")?;
2661 }
2662
2663 if let (Some(expr), false) = (depth_ref, merge_depth_ref) {
2664 write!(self.out, ", ")?;
2665 self.write_expr(expr, ctx)?;
2666 }
2667
2668 match level {
2669 // Auto needs no more arguments
2670 crate::SampleLevel::Auto => (),
2671 // Zero needs level set to 0
2672 crate::SampleLevel::Zero => {
2673 if workaround_lod_with_grad {
2674 let vec_dim = match dim {
2675 crate::ImageDimension::Cube => 3,
2676 _ => 2,
2677 };
2678 write!(self.out, ", vec{vec_dim}(0.0), vec{vec_dim}(0.0)")?;
2679 } else if gather.is_none() {
2680 write!(self.out, ", 0.0")?;
2681 }
2682 }
2683 // Exact and bias require another argument
2684 crate::SampleLevel::Exact(expr) => {
2685 write!(self.out, ", ")?;
2686 self.write_expr(expr, ctx)?;
2687 }
2688 crate::SampleLevel::Bias(_) => {
2689 // This needs to be done after the offset writing
2690 }
2691 crate::SampleLevel::Gradient { x, y } => {
2692 // If we are using sampler2D to replace sampler1D, we also
2693 // need to make sure to use vec2 gradients
2694 if tex_1d_hack {
2695 write!(self.out, ", vec2(")?;
2696 self.write_expr(x, ctx)?;
2697 write!(self.out, ", 0.0)")?;
2698 write!(self.out, ", vec2(")?;
2699 self.write_expr(y, ctx)?;
2700 write!(self.out, ", 0.0)")?;
2701 } else {
2702 write!(self.out, ", ")?;
2703 self.write_expr(x, ctx)?;
2704 write!(self.out, ", ")?;
2705 self.write_expr(y, ctx)?;
2706 }
2707 }
2708 }
2709
2710 if let Some(constant) = offset {
2711 write!(self.out, ", ")?;
2712 if tex_1d_hack {
2713 write!(self.out, "ivec2(")?;
2714 }
2715 self.write_const_expr(constant, ctx.expressions)?;
2716 if tex_1d_hack {
2717 write!(self.out, ", 0)")?;
2718 }
2719 }
2720
2721 // Bias is always the last argument
2722 if let crate::SampleLevel::Bias(expr) = level {
2723 write!(self.out, ", ")?;
2724 self.write_expr(expr, ctx)?;
2725 }
2726
2727 if let (Some(component), None) = (gather, depth_ref) {
2728 write!(self.out, ", {}", component as usize)?;
2729 }
2730
2731 // End the function
2732 write!(self.out, ")")?
2733 }
2734 Expression::ImageLoad {
2735 image,
2736 coordinate,
2737 array_index,
2738 sample,
2739 level,
2740 } => self.write_image_load(expr, ctx, image, coordinate, array_index, sample, level)?,
2741 // Query translates into one of the:
2742 // - textureSize/imageSize
2743 // - textureQueryLevels
2744 // - textureSamples/imageSamples
2745 Expression::ImageQuery { image, query } => {
2746 use crate::ImageClass;
2747
2748 // This will only panic if the module is invalid
2749 let (dim, class) = match *ctx.resolve_type(image, &self.module.types) {
2750 TypeInner::Image {
2751 dim,
2752 arrayed: _,
2753 class,
2754 } => (dim, class),
2755 _ => unreachable!(),
2756 };
2757 let components = match dim {
2758 crate::ImageDimension::D1 => 1,
2759 crate::ImageDimension::D2 => 2,
2760 crate::ImageDimension::D3 => 3,
2761 crate::ImageDimension::Cube => 2,
2762 };
2763
2764 if let crate::ImageQuery::Size { .. } = query {
2765 match components {
2766 1 => write!(self.out, "uint(")?,
2767 _ => write!(self.out, "uvec{components}(")?,
2768 }
2769 } else {
2770 write!(self.out, "uint(")?;
2771 }
2772
2773 match query {
2774 crate::ImageQuery::Size { level } => {
2775 match class {
2776 ImageClass::Sampled { multi, .. } | ImageClass::Depth { multi } => {
2777 write!(self.out, "textureSize(")?;
2778 self.write_expr(image, ctx)?;
2779 if let Some(expr) = level {
2780 let cast_to_int = matches!(
2781 *ctx.resolve_type(expr, &self.module.types),
2782 TypeInner::Scalar(crate::Scalar {
2783 kind: crate::ScalarKind::Uint,
2784 ..
2785 })
2786 );
2787
2788 write!(self.out, ", ")?;
2789
2790 if cast_to_int {
2791 write!(self.out, "int(")?;
2792 }
2793
2794 self.write_expr(expr, ctx)?;
2795
2796 if cast_to_int {
2797 write!(self.out, ")")?;
2798 }
2799 } else if !multi {
2800 // All textureSize calls requires an lod argument
2801 // except for multisampled samplers
2802 write!(self.out, ", 0")?;
2803 }
2804 }
2805 ImageClass::Storage { .. } => {
2806 write!(self.out, "imageSize(")?;
2807 self.write_expr(image, ctx)?;
2808 }
2809 ImageClass::External => unimplemented!(),
2810 }
2811 write!(self.out, ")")?;
2812 if components != 1 || self.options.version.is_es() {
2813 write!(self.out, ".{}", &"xyz"[..components])?;
2814 }
2815 }
2816 crate::ImageQuery::NumLevels => {
2817 write!(self.out, "textureQueryLevels(",)?;
2818 self.write_expr(image, ctx)?;
2819 write!(self.out, ")",)?;
2820 }
2821 crate::ImageQuery::NumLayers => {
2822 let fun_name = match class {
2823 ImageClass::Sampled { .. } | ImageClass::Depth { .. } => "textureSize",
2824 ImageClass::Storage { .. } => "imageSize",
2825 ImageClass::External => unimplemented!(),
2826 };
2827 write!(self.out, "{fun_name}(")?;
2828 self.write_expr(image, ctx)?;
2829 // All textureSize calls requires an lod argument
2830 // except for multisampled samplers
2831 if !class.is_multisampled() {
2832 write!(self.out, ", 0")?;
2833 }
2834 write!(self.out, ")")?;
2835 if components != 1 || self.options.version.is_es() {
2836 write!(self.out, ".{}", back::COMPONENTS[components])?;
2837 }
2838 }
2839 crate::ImageQuery::NumSamples => {
2840 let fun_name = match class {
2841 ImageClass::Sampled { .. } | ImageClass::Depth { .. } => {
2842 "textureSamples"
2843 }
2844 ImageClass::Storage { .. } => "imageSamples",
2845 ImageClass::External => unimplemented!(),
2846 };
2847 write!(self.out, "{fun_name}(")?;
2848 self.write_expr(image, ctx)?;
2849 write!(self.out, ")",)?;
2850 }
2851 }
2852
2853 write!(self.out, ")")?;
2854 }
2855 Expression::Unary { op, expr } => {
2856 let operator_or_fn = match op {
2857 crate::UnaryOperator::Negate => "-",
2858 crate::UnaryOperator::LogicalNot => {
2859 match *ctx.resolve_type(expr, &self.module.types) {
2860 TypeInner::Vector { .. } => "not",
2861 _ => "!",
2862 }
2863 }
2864 crate::UnaryOperator::BitwiseNot => "~",
2865 };
2866 write!(self.out, "{operator_or_fn}(")?;
2867
2868 self.write_expr(expr, ctx)?;
2869
2870 write!(self.out, ")")?
2871 }
2872 // `Binary` we just write `left op right`, except when dealing with
2873 // comparison operations on vectors as they are implemented with
2874 // builtin functions.
2875 // Once again we wrap everything in parentheses to avoid precedence issues
2876 Expression::Binary {
2877 mut op,
2878 left,
2879 right,
2880 } => {
2881 // Holds `Some(function_name)` if the binary operation is
2882 // implemented as a function call
2883 use crate::{BinaryOperator as Bo, ScalarKind as Sk, TypeInner as Ti};
2884
2885 let left_inner = ctx.resolve_type(left, &self.module.types);
2886 let right_inner = ctx.resolve_type(right, &self.module.types);
2887
2888 let function = match (left_inner, right_inner) {
2889 (&Ti::Vector { scalar, .. }, &Ti::Vector { .. }) => match op {
2890 Bo::Less
2891 | Bo::LessEqual
2892 | Bo::Greater
2893 | Bo::GreaterEqual
2894 | Bo::Equal
2895 | Bo::NotEqual => BinaryOperation::VectorCompare,
2896 Bo::Modulo if scalar.kind == Sk::Float => BinaryOperation::Modulo,
2897 Bo::Modulo if scalar.kind == Sk::Sint || scalar.kind == Sk::Uint => {
2898 BinaryOperation::ModuloInt
2899 }
2900 Bo::And if scalar.kind == Sk::Bool => {
2901 op = crate::BinaryOperator::LogicalAnd;
2902 BinaryOperation::VectorComponentWise
2903 }
2904 Bo::InclusiveOr if scalar.kind == Sk::Bool => {
2905 op = crate::BinaryOperator::LogicalOr;
2906 BinaryOperation::VectorComponentWise
2907 }
2908 _ => BinaryOperation::Other,
2909 },
2910 _ => match (left_inner.scalar_kind(), right_inner.scalar_kind()) {
2911 (Some(Sk::Float), _) | (_, Some(Sk::Float)) => match op {
2912 Bo::Modulo => BinaryOperation::Modulo,
2913 _ => BinaryOperation::Other,
2914 },
2915 (Some(Sk::Sint | Sk::Uint), _) | (_, Some(Sk::Sint | Sk::Uint))
2916 if op == Bo::Modulo =>
2917 {
2918 BinaryOperation::ModuloInt
2919 }
2920 (Some(Sk::Bool), Some(Sk::Bool)) => match op {
2921 Bo::InclusiveOr => {
2922 op = crate::BinaryOperator::LogicalOr;
2923 BinaryOperation::Other
2924 }
2925 Bo::And => {
2926 op = crate::BinaryOperator::LogicalAnd;
2927 BinaryOperation::Other
2928 }
2929 _ => BinaryOperation::Other,
2930 },
2931 _ => BinaryOperation::Other,
2932 },
2933 };
2934
2935 match function {
2936 BinaryOperation::VectorCompare => {
2937 let op_str = match op {
2938 Bo::Less => "lessThan(",
2939 Bo::LessEqual => "lessThanEqual(",
2940 Bo::Greater => "greaterThan(",
2941 Bo::GreaterEqual => "greaterThanEqual(",
2942 Bo::Equal => "equal(",
2943 Bo::NotEqual => "notEqual(",
2944 _ => unreachable!(),
2945 };
2946 write!(self.out, "{op_str}")?;
2947 self.write_expr(left, ctx)?;
2948 write!(self.out, ", ")?;
2949 self.write_expr(right, ctx)?;
2950 write!(self.out, ")")?;
2951 }
2952 BinaryOperation::VectorComponentWise => {
2953 self.write_value_type(left_inner)?;
2954 write!(self.out, "(")?;
2955
2956 let size = match *left_inner {
2957 Ti::Vector { size, .. } => size,
2958 _ => unreachable!(),
2959 };
2960
2961 for i in 0..size as usize {
2962 if i != 0 {
2963 write!(self.out, ", ")?;
2964 }
2965
2966 self.write_expr(left, ctx)?;
2967 write!(self.out, ".{}", back::COMPONENTS[i])?;
2968
2969 write!(self.out, " {} ", back::binary_operation_str(op))?;
2970
2971 self.write_expr(right, ctx)?;
2972 write!(self.out, ".{}", back::COMPONENTS[i])?;
2973 }
2974
2975 write!(self.out, ")")?;
2976 }
2977 // Signed/unsigned integer `%` with a negative operand is handled by
2978 // `BinaryOperation::ModuloInt` below. Remaining TODO: the degenerate
2979 // div-by-zero / `INT_MIN % -1` cases (this backend also leaves integer
2980 // `/` unguarded), and float `% 0` (see
2981 // https://github.com/gpuweb/gpuweb/issues/2798).
2982 BinaryOperation::Modulo => {
2983 write!(self.out, "(")?;
2984
2985 // write `e1 - e2 * trunc(e1 / e2)`
2986 self.write_expr(left, ctx)?;
2987 write!(self.out, " - ")?;
2988 self.write_expr(right, ctx)?;
2989 write!(self.out, " * ")?;
2990 write!(self.out, "trunc(")?;
2991 self.write_expr(left, ctx)?;
2992 write!(self.out, " / ")?;
2993 self.write_expr(right, ctx)?;
2994 write!(self.out, ")")?;
2995
2996 write!(self.out, ")")?;
2997 }
2998 BinaryOperation::ModuloInt => {
2999 // GLSL's `%` is undefined when either operand is negative.
3000 // Integer division truncates toward zero (which is well
3001 // defined), so reconstruct the remainder as `e1 - e2 * (e1 / e2)`.
3002 // This matches WGSL's truncated `%` for all operands; the
3003 // degenerate `x % 0` / `INT_MIN % -1` cases stay consistent
3004 // with this backend's unguarded integer `/`.
3005 write!(self.out, "(")?;
3006 self.write_expr(left, ctx)?;
3007 write!(self.out, " - ")?;
3008 self.write_expr(right, ctx)?;
3009 write!(self.out, " * (")?;
3010 self.write_expr(left, ctx)?;
3011 write!(self.out, " / ")?;
3012 self.write_expr(right, ctx)?;
3013 write!(self.out, "))")?;
3014 }
3015 BinaryOperation::Other => {
3016 write!(self.out, "(")?;
3017
3018 self.write_expr(left, ctx)?;
3019 write!(self.out, " {} ", back::binary_operation_str(op))?;
3020 self.write_expr(right, ctx)?;
3021
3022 write!(self.out, ")")?;
3023 }
3024 }
3025 }
3026 // `Select` is written as `condition ? accept : reject`
3027 // We wrap everything in parentheses to avoid precedence issues
3028 Expression::Select {
3029 condition,
3030 accept,
3031 reject,
3032 } => {
3033 let cond_ty = ctx.resolve_type(condition, &self.module.types);
3034 let vec_select = if let TypeInner::Vector { .. } = *cond_ty {
3035 true
3036 } else {
3037 false
3038 };
3039
3040 // TODO: Boolean mix on desktop required GL_EXT_shader_integer_mix
3041 if vec_select {
3042 // Glsl defines that for mix when the condition is a boolean the first element
3043 // is picked if condition is false and the second if condition is true
3044 write!(self.out, "mix(")?;
3045 self.write_expr(reject, ctx)?;
3046 write!(self.out, ", ")?;
3047 self.write_expr(accept, ctx)?;
3048 write!(self.out, ", ")?;
3049 self.write_expr(condition, ctx)?;
3050 } else {
3051 write!(self.out, "(")?;
3052 self.write_expr(condition, ctx)?;
3053 write!(self.out, " ? ")?;
3054 self.write_expr(accept, ctx)?;
3055 write!(self.out, " : ")?;
3056 self.write_expr(reject, ctx)?;
3057 }
3058
3059 write!(self.out, ")")?
3060 }
3061 // `Derivative` is a function call to a glsl provided function
3062 Expression::Derivative { axis, ctrl, expr } => {
3063 use crate::{DerivativeAxis as Axis, DerivativeControl as Ctrl};
3064 let fun_name = if self.options.version.supports_derivative_control() {
3065 match (axis, ctrl) {
3066 (Axis::X, Ctrl::Coarse) => "dFdxCoarse",
3067 (Axis::X, Ctrl::Fine) => "dFdxFine",
3068 (Axis::X, Ctrl::None) => "dFdx",
3069 (Axis::Y, Ctrl::Coarse) => "dFdyCoarse",
3070 (Axis::Y, Ctrl::Fine) => "dFdyFine",
3071 (Axis::Y, Ctrl::None) => "dFdy",
3072 (Axis::Width, Ctrl::Coarse) => "fwidthCoarse",
3073 (Axis::Width, Ctrl::Fine) => "fwidthFine",
3074 (Axis::Width, Ctrl::None) => "fwidth",
3075 }
3076 } else {
3077 match axis {
3078 Axis::X => "dFdx",
3079 Axis::Y => "dFdy",
3080 Axis::Width => "fwidth",
3081 }
3082 };
3083 write!(self.out, "{fun_name}(")?;
3084 self.write_expr(expr, ctx)?;
3085 write!(self.out, ")")?
3086 }
3087 // `Relational` is a normal function call to some glsl provided functions
3088 Expression::Relational { fun, argument } => {
3089 use crate::RelationalFunction as Rf;
3090
3091 let fun_name = match fun {
3092 Rf::IsInf => "isinf",
3093 Rf::IsNan => "isnan",
3094 Rf::All => "all",
3095 Rf::Any => "any",
3096 };
3097 write!(self.out, "{fun_name}(")?;
3098
3099 self.write_expr(argument, ctx)?;
3100
3101 write!(self.out, ")")?
3102 }
3103 Expression::Math {
3104 fun,
3105 arg,
3106 arg1,
3107 arg2,
3108 arg3,
3109 } => {
3110 use crate::MathFunction as Mf;
3111
3112 let fun_name = match fun {
3113 // comparison
3114 Mf::Abs => "abs",
3115 Mf::Min => "min",
3116 Mf::Max => "max",
3117 Mf::Clamp => {
3118 let scalar_kind = ctx
3119 .resolve_type(arg, &self.module.types)
3120 .scalar_kind()
3121 .unwrap();
3122 match scalar_kind {
3123 crate::ScalarKind::Float => "clamp",
3124 // Clamp is undefined if min > max. In practice this means it can use a median-of-three
3125 // instruction to determine the value. This is fine according to the WGSL spec for float
3126 // clamp, but integer clamp _must_ use min-max. As such we write out min/max.
3127 _ => {
3128 write!(self.out, "min(max(")?;
3129 self.write_expr(arg, ctx)?;
3130 write!(self.out, ", ")?;
3131 self.write_expr(arg1.unwrap(), ctx)?;
3132 write!(self.out, "), ")?;
3133 self.write_expr(arg2.unwrap(), ctx)?;
3134 write!(self.out, ")")?;
3135
3136 return Ok(());
3137 }
3138 }
3139 }
3140 Mf::Saturate => {
3141 write!(self.out, "clamp(")?;
3142
3143 self.write_expr(arg, ctx)?;
3144
3145 match *ctx.resolve_type(arg, &self.module.types) {
3146 TypeInner::Vector { size, .. } => write!(
3147 self.out,
3148 ", vec{}(0.0), vec{0}(1.0)",
3149 common::vector_size_str(size)
3150 )?,
3151 _ => write!(self.out, ", 0.0, 1.0")?,
3152 }
3153
3154 write!(self.out, ")")?;
3155
3156 return Ok(());
3157 }
3158 // trigonometry
3159 Mf::Cos => "cos",
3160 Mf::Cosh => "cosh",
3161 Mf::Sin => "sin",
3162 Mf::Sinh => "sinh",
3163 Mf::Tan => "tan",
3164 Mf::Tanh => "tanh",
3165 Mf::Acos => "acos",
3166 Mf::Asin => "asin",
3167 Mf::Atan => "atan",
3168 Mf::Asinh => "asinh",
3169 Mf::Acosh => "acosh",
3170 Mf::Atanh => "atanh",
3171 Mf::Radians => "radians",
3172 Mf::Degrees => "degrees",
3173 // glsl doesn't have atan2 function
3174 // use two-argument variation of the atan function
3175 Mf::Atan2 => "atan",
3176 // decomposition
3177 Mf::Ceil => "ceil",
3178 Mf::Floor => "floor",
3179 Mf::Round => "roundEven",
3180 Mf::Fract => "fract",
3181 Mf::Trunc => "trunc",
3182 Mf::Modf => MODF_FUNCTION,
3183 Mf::Frexp => FREXP_FUNCTION,
3184 Mf::Ldexp => "ldexp",
3185 // exponent
3186 Mf::Exp => "exp",
3187 Mf::Exp2 => "exp2",
3188 Mf::Log => "log",
3189 Mf::Log2 => "log2",
3190 Mf::Pow => "pow",
3191 // geometry
3192 Mf::Dot => match *ctx.resolve_type(arg, &self.module.types) {
3193 TypeInner::Vector {
3194 scalar:
3195 crate::Scalar {
3196 kind: crate::ScalarKind::Float,
3197 ..
3198 },
3199 ..
3200 } => "dot",
3201 TypeInner::Vector { size, .. } => {
3202 return self.write_dot_product(arg, arg1.unwrap(), size as usize, ctx)
3203 }
3204 _ => unreachable!(
3205 "Correct TypeInner for dot product should be already validated"
3206 ),
3207 },
3208 fun @ (Mf::Dot4I8Packed | Mf::Dot4U8Packed) => {
3209 let conversion = match fun {
3210 Mf::Dot4I8Packed => "int",
3211 Mf::Dot4U8Packed => "",
3212 _ => unreachable!(),
3213 };
3214
3215 let arg1 = arg1.unwrap();
3216
3217 // Write parentheses around the dot product expression to prevent operators
3218 // with different precedences from applying earlier.
3219 write!(self.out, "(")?;
3220 for i in 0..4 {
3221 // Since `bitfieldExtract` only sign extends if the value is signed, we
3222 // need to convert the inputs to `int` in case of `Dot4I8Packed`. For
3223 // `Dot4U8Packed`, the code below only introduces parenthesis around
3224 // each factor, which aren't strictly needed because both operands are
3225 // baked, but which don't hurt either.
3226 write!(self.out, "bitfieldExtract({conversion}(")?;
3227 self.write_expr(arg, ctx)?;
3228 write!(self.out, "), {}, 8)", i * 8)?;
3229
3230 write!(self.out, " * bitfieldExtract({conversion}(")?;
3231 self.write_expr(arg1, ctx)?;
3232 write!(self.out, "), {}, 8)", i * 8)?;
3233
3234 if i != 3 {
3235 write!(self.out, " + ")?;
3236 }
3237 }
3238 write!(self.out, ")")?;
3239
3240 return Ok(());
3241 }
3242 Mf::Outer => "outerProduct",
3243 Mf::Cross => "cross",
3244 Mf::Distance => "distance",
3245 Mf::Length => "length",
3246 Mf::Normalize => "normalize",
3247 Mf::FaceForward => "faceforward",
3248 Mf::Reflect => "reflect",
3249 Mf::Refract => "refract",
3250 // computational
3251 Mf::Sign => "sign",
3252 Mf::Fma => {
3253 if self.options.version.supports_fma_function() {
3254 // Use the fma function when available
3255 "fma"
3256 } else {
3257 // No fma support. Transform the function call into an arithmetic expression
3258 write!(self.out, "(")?;
3259
3260 self.write_expr(arg, ctx)?;
3261 write!(self.out, " * ")?;
3262
3263 let arg1 =
3264 arg1.ok_or_else(|| Error::Custom("Missing fma arg1".to_owned()))?;
3265 self.write_expr(arg1, ctx)?;
3266 write!(self.out, " + ")?;
3267
3268 let arg2 =
3269 arg2.ok_or_else(|| Error::Custom("Missing fma arg2".to_owned()))?;
3270 self.write_expr(arg2, ctx)?;
3271 write!(self.out, ")")?;
3272
3273 return Ok(());
3274 }
3275 }
3276 Mf::Mix => "mix",
3277 Mf::Step => "step",
3278 Mf::SmoothStep => "smoothstep",
3279 Mf::Sqrt => "sqrt",
3280 Mf::InverseSqrt => "inversesqrt",
3281 Mf::Inverse => "inverse",
3282 Mf::Transpose => "transpose",
3283 Mf::Determinant => "determinant",
3284 Mf::QuantizeToF16 => match *ctx.resolve_type(arg, &self.module.types) {
3285 TypeInner::Scalar { .. } => {
3286 write!(self.out, "unpackHalf2x16(packHalf2x16(vec2(")?;
3287 self.write_expr(arg, ctx)?;
3288 write!(self.out, "))).x")?;
3289 return Ok(());
3290 }
3291 TypeInner::Vector {
3292 size: crate::VectorSize::Bi,
3293 ..
3294 } => {
3295 write!(self.out, "unpackHalf2x16(packHalf2x16(")?;
3296 self.write_expr(arg, ctx)?;
3297 write!(self.out, "))")?;
3298 return Ok(());
3299 }
3300 TypeInner::Vector {
3301 size: crate::VectorSize::Tri,
3302 ..
3303 } => {
3304 write!(self.out, "vec3(unpackHalf2x16(packHalf2x16(")?;
3305 self.write_expr(arg, ctx)?;
3306 write!(self.out, ".xy)), unpackHalf2x16(packHalf2x16(")?;
3307 self.write_expr(arg, ctx)?;
3308 write!(self.out, ".zz)).x)")?;
3309 return Ok(());
3310 }
3311 TypeInner::Vector {
3312 size: crate::VectorSize::Quad,
3313 ..
3314 } => {
3315 write!(self.out, "vec4(unpackHalf2x16(packHalf2x16(")?;
3316 self.write_expr(arg, ctx)?;
3317 write!(self.out, ".xy)), unpackHalf2x16(packHalf2x16(")?;
3318 self.write_expr(arg, ctx)?;
3319 write!(self.out, ".zw)))")?;
3320 return Ok(());
3321 }
3322 _ => unreachable!(
3323 "Correct TypeInner for QuantizeToF16 should be already validated"
3324 ),
3325 },
3326 // bits
3327 Mf::CountTrailingZeros => {
3328 match *ctx.resolve_type(arg, &self.module.types) {
3329 TypeInner::Vector { size, scalar, .. } => {
3330 let s = common::vector_size_str(size);
3331 if let crate::ScalarKind::Uint = scalar.kind {
3332 write!(self.out, "min(uvec{s}(findLSB(")?;
3333 self.write_expr(arg, ctx)?;
3334 write!(self.out, ")), uvec{s}(32u))")?;
3335 } else {
3336 write!(self.out, "ivec{s}(min(uvec{s}(findLSB(")?;
3337 self.write_expr(arg, ctx)?;
3338 write!(self.out, ")), uvec{s}(32u)))")?;
3339 }
3340 }
3341 TypeInner::Scalar(scalar) => {
3342 if let crate::ScalarKind::Uint = scalar.kind {
3343 write!(self.out, "min(uint(findLSB(")?;
3344 self.write_expr(arg, ctx)?;
3345 write!(self.out, ")), 32u)")?;
3346 } else {
3347 write!(self.out, "int(min(uint(findLSB(")?;
3348 self.write_expr(arg, ctx)?;
3349 write!(self.out, ")), 32u))")?;
3350 }
3351 }
3352 _ => unreachable!(),
3353 };
3354 return Ok(());
3355 }
3356 Mf::CountLeadingZeros => {
3357 if self.options.version.supports_integer_functions() {
3358 match *ctx.resolve_type(arg, &self.module.types) {
3359 TypeInner::Vector { size, scalar } => {
3360 let s = common::vector_size_str(size);
3361
3362 if let crate::ScalarKind::Uint = scalar.kind {
3363 write!(self.out, "uvec{s}(ivec{s}(31) - findMSB(")?;
3364 self.write_expr(arg, ctx)?;
3365 write!(self.out, "))")?;
3366 } else {
3367 write!(self.out, "mix(ivec{s}(31) - findMSB(")?;
3368 self.write_expr(arg, ctx)?;
3369 write!(self.out, "), ivec{s}(0), lessThan(")?;
3370 self.write_expr(arg, ctx)?;
3371 write!(self.out, ", ivec{s}(0)))")?;
3372 }
3373 }
3374 TypeInner::Scalar(scalar) => {
3375 if let crate::ScalarKind::Uint = scalar.kind {
3376 write!(self.out, "uint(31 - findMSB(")?;
3377 } else {
3378 write!(self.out, "(")?;
3379 self.write_expr(arg, ctx)?;
3380 write!(self.out, " < 0 ? 0 : 31 - findMSB(")?;
3381 }
3382
3383 self.write_expr(arg, ctx)?;
3384 write!(self.out, "))")?;
3385 }
3386 _ => unreachable!(),
3387 };
3388 } else {
3389 match *ctx.resolve_type(arg, &self.module.types) {
3390 TypeInner::Vector { size, scalar } => {
3391 let s = common::vector_size_str(size);
3392
3393 if let crate::ScalarKind::Uint = scalar.kind {
3394 write!(self.out, "uvec{s}(")?;
3395 write!(self.out, "vec{s}(31.0) - floor(log2(vec{s}(")?;
3396 self.write_expr(arg, ctx)?;
3397 write!(self.out, ") + 0.5)))")?;
3398 } else {
3399 write!(self.out, "ivec{s}(")?;
3400 write!(self.out, "mix(vec{s}(31.0) - floor(log2(vec{s}(")?;
3401 self.write_expr(arg, ctx)?;
3402 write!(self.out, ") + 0.5)), ")?;
3403 write!(self.out, "vec{s}(0.0), lessThan(")?;
3404 self.write_expr(arg, ctx)?;
3405 write!(self.out, ", ivec{s}(0u))))")?;
3406 }
3407 }
3408 TypeInner::Scalar(scalar) => {
3409 if let crate::ScalarKind::Uint = scalar.kind {
3410 write!(self.out, "uint(31.0 - floor(log2(float(")?;
3411 self.write_expr(arg, ctx)?;
3412 write!(self.out, ") + 0.5)))")?;
3413 } else {
3414 write!(self.out, "(")?;
3415 self.write_expr(arg, ctx)?;
3416 write!(self.out, " < 0 ? 0 : int(")?;
3417 write!(self.out, "31.0 - floor(log2(float(")?;
3418 self.write_expr(arg, ctx)?;
3419 write!(self.out, ") + 0.5))))")?;
3420 }
3421 }
3422 _ => unreachable!(),
3423 };
3424 }
3425
3426 return Ok(());
3427 }
3428 Mf::CountOneBits => "bitCount",
3429 Mf::ReverseBits => "bitfieldReverse",
3430 Mf::ExtractBits => {
3431 // The behavior of ExtractBits is undefined when offset + count > bit_width. We need
3432 // to first sanitize the offset and count first. If we don't do this, AMD and Intel chips
3433 // will return out-of-spec values if the extracted range is not within the bit width.
3434 //
3435 // This encodes the exact formula specified by the wgsl spec, without temporary values:
3436 // https://gpuweb.github.io/gpuweb/wgsl/#extractBits-unsigned-builtin
3437 //
3438 // w = sizeof(x) * 8
3439 // o = min(offset, w)
3440 // c = min(count, w - o)
3441 //
3442 // bitfieldExtract(x, o, c)
3443 //
3444 // extract_bits(e, min(offset, w), min(count, w - min(offset, w))))
3445 let scalar_bits = ctx
3446 .resolve_type(arg, &self.module.types)
3447 .scalar_width()
3448 .unwrap()
3449 * 8;
3450
3451 write!(self.out, "bitfieldExtract(")?;
3452 self.write_expr(arg, ctx)?;
3453 write!(self.out, ", int(min(")?;
3454 self.write_expr(arg1.unwrap(), ctx)?;
3455 write!(self.out, ", {scalar_bits}u)), int(min(",)?;
3456 self.write_expr(arg2.unwrap(), ctx)?;
3457 write!(self.out, ", {scalar_bits}u - min(")?;
3458 self.write_expr(arg1.unwrap(), ctx)?;
3459 write!(self.out, ", {scalar_bits}u))))")?;
3460
3461 return Ok(());
3462 }
3463 Mf::InsertBits => {
3464 // InsertBits has the same considerations as ExtractBits above
3465 let scalar_bits = ctx
3466 .resolve_type(arg, &self.module.types)
3467 .scalar_width()
3468 .unwrap()
3469 * 8;
3470
3471 write!(self.out, "bitfieldInsert(")?;
3472 self.write_expr(arg, ctx)?;
3473 write!(self.out, ", ")?;
3474 self.write_expr(arg1.unwrap(), ctx)?;
3475 write!(self.out, ", int(min(")?;
3476 self.write_expr(arg2.unwrap(), ctx)?;
3477 write!(self.out, ", {scalar_bits}u)), int(min(",)?;
3478 self.write_expr(arg3.unwrap(), ctx)?;
3479 write!(self.out, ", {scalar_bits}u - min(")?;
3480 self.write_expr(arg2.unwrap(), ctx)?;
3481 write!(self.out, ", {scalar_bits}u))))")?;
3482
3483 return Ok(());
3484 }
3485 Mf::FirstTrailingBit => "findLSB",
3486 Mf::FirstLeadingBit => "findMSB",
3487 // data packing
3488 Mf::Pack4x8snorm => {
3489 if self.options.version.supports_pack_unpack_4x8() {
3490 "packSnorm4x8"
3491 } else {
3492 // polyfill should go here. Needs a corresponding entry in `need_bake_expression`
3493 return Err(Error::UnsupportedExternal("packSnorm4x8".into()));
3494 }
3495 }
3496 Mf::Pack4x8unorm => {
3497 if self.options.version.supports_pack_unpack_4x8() {
3498 "packUnorm4x8"
3499 } else {
3500 return Err(Error::UnsupportedExternal("packUnorm4x8".to_owned()));
3501 }
3502 }
3503 Mf::Pack2x16snorm => {
3504 if self.options.version.supports_pack_unpack_snorm_2x16() {
3505 "packSnorm2x16"
3506 } else {
3507 return Err(Error::UnsupportedExternal("packSnorm2x16".to_owned()));
3508 }
3509 }
3510 Mf::Pack2x16unorm => {
3511 if self.options.version.supports_pack_unpack_unorm_2x16() {
3512 "packUnorm2x16"
3513 } else {
3514 return Err(Error::UnsupportedExternal("packUnorm2x16".to_owned()));
3515 }
3516 }
3517 Mf::Pack2x16float => {
3518 if self.options.version.supports_pack_unpack_half_2x16() {
3519 "packHalf2x16"
3520 } else {
3521 return Err(Error::UnsupportedExternal("packHalf2x16".to_owned()));
3522 }
3523 }
3524
3525 fun @ (Mf::Pack4xI8 | Mf::Pack4xU8 | Mf::Pack4xI8Clamp | Mf::Pack4xU8Clamp) => {
3526 let was_signed = matches!(fun, Mf::Pack4xI8 | Mf::Pack4xI8Clamp);
3527 let clamp_bounds = match fun {
3528 Mf::Pack4xI8Clamp => Some(("-128", "127")),
3529 Mf::Pack4xU8Clamp => Some(("0", "255")),
3530 _ => None,
3531 };
3532 let const_suffix = if was_signed { "" } else { "u" };
3533 if was_signed {
3534 write!(self.out, "uint(")?;
3535 }
3536 let write_arg = |this: &mut Self| -> BackendResult {
3537 if let Some((min, max)) = clamp_bounds {
3538 write!(this.out, "clamp(")?;
3539 this.write_expr(arg, ctx)?;
3540 write!(this.out, ", {min}{const_suffix}, {max}{const_suffix})")?;
3541 } else {
3542 this.write_expr(arg, ctx)?;
3543 }
3544 Ok(())
3545 };
3546 write!(self.out, "(")?;
3547 write_arg(self)?;
3548 write!(self.out, "[0] & 0xFF{const_suffix}) | ((")?;
3549 write_arg(self)?;
3550 write!(self.out, "[1] & 0xFF{const_suffix}) << 8) | ((")?;
3551 write_arg(self)?;
3552 write!(self.out, "[2] & 0xFF{const_suffix}) << 16) | ((")?;
3553 write_arg(self)?;
3554 write!(self.out, "[3] & 0xFF{const_suffix}) << 24)")?;
3555 if was_signed {
3556 write!(self.out, ")")?;
3557 }
3558
3559 return Ok(());
3560 }
3561 // data unpacking
3562 Mf::Unpack2x16float => {
3563 if self.options.version.supports_pack_unpack_half_2x16() {
3564 "unpackHalf2x16"
3565 } else {
3566 return Err(Error::UnsupportedExternal("unpackHalf2x16".into()));
3567 }
3568 }
3569 Mf::Unpack2x16snorm => {
3570 if self.options.version.supports_pack_unpack_snorm_2x16() {
3571 "unpackSnorm2x16"
3572 } else {
3573 let scale = 32767;
3574
3575 write!(self.out, "(vec2(ivec2(")?;
3576 self.write_expr(arg, ctx)?;
3577 write!(self.out, " << 16, ")?;
3578 self.write_expr(arg, ctx)?;
3579 write!(self.out, ") >> 16) / {scale}.0)")?;
3580 return Ok(());
3581 }
3582 }
3583 Mf::Unpack2x16unorm => {
3584 if self.options.version.supports_pack_unpack_unorm_2x16() {
3585 "unpackUnorm2x16"
3586 } else {
3587 let scale = 65535;
3588
3589 write!(self.out, "(vec2(")?;
3590 self.write_expr(arg, ctx)?;
3591 write!(self.out, " & 0xFFFFu, ")?;
3592 self.write_expr(arg, ctx)?;
3593 write!(self.out, " >> 16) / {scale}.0)")?;
3594 return Ok(());
3595 }
3596 }
3597 Mf::Unpack4x8snorm => {
3598 if self.options.version.supports_pack_unpack_4x8() {
3599 "unpackSnorm4x8"
3600 } else {
3601 let scale = 127;
3602
3603 write!(self.out, "(vec4(ivec4(")?;
3604 self.write_expr(arg, ctx)?;
3605 write!(self.out, " << 24, ")?;
3606 self.write_expr(arg, ctx)?;
3607 write!(self.out, " << 16, ")?;
3608 self.write_expr(arg, ctx)?;
3609 write!(self.out, " << 8, ")?;
3610 self.write_expr(arg, ctx)?;
3611 write!(self.out, ") >> 24) / {scale}.0)")?;
3612 return Ok(());
3613 }
3614 }
3615 Mf::Unpack4x8unorm => {
3616 if self.options.version.supports_pack_unpack_4x8() {
3617 "unpackUnorm4x8"
3618 } else {
3619 let scale = 255;
3620
3621 write!(self.out, "(vec4(")?;
3622 self.write_expr(arg, ctx)?;
3623 write!(self.out, " & 0xFFu, ")?;
3624 self.write_expr(arg, ctx)?;
3625 write!(self.out, " >> 8 & 0xFFu, ")?;
3626 self.write_expr(arg, ctx)?;
3627 write!(self.out, " >> 16 & 0xFFu, ")?;
3628 self.write_expr(arg, ctx)?;
3629 write!(self.out, " >> 24) / {scale}.0)")?;
3630 return Ok(());
3631 }
3632 }
3633 fun @ (Mf::Unpack4xI8 | Mf::Unpack4xU8) => {
3634 let sign_prefix = match fun {
3635 Mf::Unpack4xI8 => 'i',
3636 Mf::Unpack4xU8 => 'u',
3637 _ => unreachable!(),
3638 };
3639 write!(self.out, "{sign_prefix}vec4(")?;
3640 for i in 0..4 {
3641 write!(self.out, "bitfieldExtract(")?;
3642 // Since bitfieldExtract only sign extends if the value is signed, this
3643 // cast is needed
3644 match fun {
3645 Mf::Unpack4xI8 => {
3646 write!(self.out, "int(")?;
3647 self.write_expr(arg, ctx)?;
3648 write!(self.out, ")")?;
3649 }
3650 Mf::Unpack4xU8 => self.write_expr(arg, ctx)?,
3651 _ => unreachable!(),
3652 };
3653 write!(self.out, ", {}, 8)", i * 8)?;
3654 if i != 3 {
3655 write!(self.out, ", ")?;
3656 }
3657 }
3658 write!(self.out, ")")?;
3659
3660 return Ok(());
3661 }
3662 };
3663
3664 let extract_bits = fun == Mf::ExtractBits;
3665 let insert_bits = fun == Mf::InsertBits;
3666
3667 // Some GLSL functions always return signed integers (like findMSB),
3668 // so they need to be cast to uint if the argument is also an uint.
3669 let ret_might_need_int_to_uint = matches!(
3670 fun,
3671 Mf::FirstTrailingBit | Mf::FirstLeadingBit | Mf::CountOneBits | Mf::Abs
3672 );
3673
3674 // Some GLSL functions only accept signed integers (like abs),
3675 // so they need their argument cast from uint to int.
3676 let arg_might_need_uint_to_int = matches!(fun, Mf::Abs);
3677
3678 // Check if the argument is an unsigned integer and return the vector size
3679 // in case it's a vector
3680 let maybe_uint_size = match *ctx.resolve_type(arg, &self.module.types) {
3681 TypeInner::Scalar(crate::Scalar {
3682 kind: crate::ScalarKind::Uint,
3683 ..
3684 }) => Some(None),
3685 TypeInner::Vector {
3686 scalar:
3687 crate::Scalar {
3688 kind: crate::ScalarKind::Uint,
3689 ..
3690 },
3691 size,
3692 } => Some(Some(size)),
3693 _ => None,
3694 };
3695
3696 // Cast to uint if the function needs it
3697 if ret_might_need_int_to_uint {
3698 if let Some(maybe_size) = maybe_uint_size {
3699 match maybe_size {
3700 Some(size) => write!(self.out, "uvec{}(", size as u8)?,
3701 None => write!(self.out, "uint(")?,
3702 }
3703 }
3704 }
3705
3706 write!(self.out, "{fun_name}(")?;
3707
3708 // Cast to int if the function needs it
3709 if arg_might_need_uint_to_int {
3710 if let Some(maybe_size) = maybe_uint_size {
3711 match maybe_size {
3712 Some(size) => write!(self.out, "ivec{}(", size as u8)?,
3713 None => write!(self.out, "int(")?,
3714 }
3715 }
3716 }
3717
3718 self.write_expr(arg, ctx)?;
3719
3720 // Close the cast from uint to int
3721 if arg_might_need_uint_to_int && maybe_uint_size.is_some() {
3722 write!(self.out, ")")?
3723 }
3724
3725 if let Some(arg) = arg1 {
3726 write!(self.out, ", ")?;
3727 if extract_bits {
3728 write!(self.out, "int(")?;
3729 self.write_expr(arg, ctx)?;
3730 write!(self.out, ")")?;
3731 } else {
3732 self.write_expr(arg, ctx)?;
3733 }
3734 }
3735 if let Some(arg) = arg2 {
3736 write!(self.out, ", ")?;
3737 if extract_bits || insert_bits {
3738 write!(self.out, "int(")?;
3739 self.write_expr(arg, ctx)?;
3740 write!(self.out, ")")?;
3741 } else {
3742 self.write_expr(arg, ctx)?;
3743 }
3744 }
3745 if let Some(arg) = arg3 {
3746 write!(self.out, ", ")?;
3747 if insert_bits {
3748 write!(self.out, "int(")?;
3749 self.write_expr(arg, ctx)?;
3750 write!(self.out, ")")?;
3751 } else {
3752 self.write_expr(arg, ctx)?;
3753 }
3754 }
3755 write!(self.out, ")")?;
3756
3757 // Close the cast from int to uint
3758 if ret_might_need_int_to_uint && maybe_uint_size.is_some() {
3759 write!(self.out, ")")?
3760 }
3761 }
3762 // `As` is always a call.
3763 // If `convert` is true the function name is the type
3764 // Else the function name is one of the glsl provided bitcast functions
3765 Expression::As {
3766 expr,
3767 kind: target_kind,
3768 convert,
3769 } => {
3770 let inner = ctx.resolve_type(expr, &self.module.types);
3771 match convert {
3772 Some(width) => {
3773 // this is similar to `write_type`, but with the target kind
3774 let scalar = glsl_scalar(crate::Scalar {
3775 kind: target_kind,
3776 width,
3777 })?;
3778 match *inner {
3779 TypeInner::Matrix { columns, rows, .. } => write!(
3780 self.out,
3781 "{}mat{}x{}",
3782 scalar.prefix, columns as u8, rows as u8
3783 )?,
3784 TypeInner::Vector { size, .. } => {
3785 write!(self.out, "{}vec{}", scalar.prefix, size as u8)?
3786 }
3787 _ => write!(self.out, "{}", scalar.full)?,
3788 }
3789
3790 write!(self.out, "(")?;
3791 self.write_expr(expr, ctx)?;
3792 write!(self.out, ")")?
3793 }
3794 None => {
3795 use crate::ScalarKind as Sk;
3796
3797 let target_vector_type = match *inner {
3798 TypeInner::Vector { size, scalar } => Some(TypeInner::Vector {
3799 size,
3800 scalar: crate::Scalar {
3801 kind: target_kind,
3802 width: scalar.width,
3803 },
3804 }),
3805 _ => None,
3806 };
3807
3808 let source_kind = inner.scalar_kind().unwrap();
3809
3810 match (source_kind, target_kind, target_vector_type) {
3811 // No conversion needed
3812 (Sk::Sint, Sk::Sint, _)
3813 | (Sk::Uint, Sk::Uint, _)
3814 | (Sk::Float, Sk::Float, _)
3815 | (Sk::Bool, Sk::Bool, _) => {
3816 self.write_expr(expr, ctx)?;
3817 return Ok(());
3818 }
3819
3820 // Cast to/from floats
3821 (Sk::Float, Sk::Sint, _) => write!(self.out, "floatBitsToInt")?,
3822 (Sk::Float, Sk::Uint, _) => write!(self.out, "floatBitsToUint")?,
3823 (Sk::Sint, Sk::Float, _) => write!(self.out, "intBitsToFloat")?,
3824 (Sk::Uint, Sk::Float, _) => write!(self.out, "uintBitsToFloat")?,
3825
3826 // Cast between vector types
3827 (_, _, Some(vector)) => {
3828 self.write_value_type(&vector)?;
3829 }
3830
3831 // There is no way to bitcast between Uint/Sint in glsl. Use constructor conversion
3832 (Sk::Uint | Sk::Bool, Sk::Sint, None) => write!(self.out, "int")?,
3833 (Sk::Sint | Sk::Bool, Sk::Uint, None) => write!(self.out, "uint")?,
3834 (Sk::Bool, Sk::Float, None) => write!(self.out, "float")?,
3835 (Sk::Sint | Sk::Uint | Sk::Float, Sk::Bool, None) => {
3836 write!(self.out, "bool")?
3837 }
3838
3839 (Sk::AbstractInt | Sk::AbstractFloat, _, _)
3840 | (_, Sk::AbstractInt | Sk::AbstractFloat, _) => unreachable!(),
3841 };
3842
3843 write!(self.out, "(")?;
3844 self.write_expr(expr, ctx)?;
3845 write!(self.out, ")")?;
3846 }
3847 }
3848 }
3849 // These expressions never show up in `Emit`.
3850 Expression::CallResult(_)
3851 | Expression::AtomicResult { .. }
3852 | Expression::RayQueryProceedResult
3853 | Expression::WorkGroupUniformLoadResult { .. }
3854 | Expression::SubgroupOperationResult { .. }
3855 | Expression::SubgroupBallotResult => unreachable!(),
3856 // `ArrayLength` is written as `expr.length()` and we convert it to a uint
3857 Expression::ArrayLength(expr) => {
3858 write!(self.out, "uint(")?;
3859 self.write_expr(expr, ctx)?;
3860 write!(self.out, ".length())")?
3861 }
3862 // not supported yet
3863 Expression::RayQueryGetIntersection { .. }
3864 | Expression::RayQueryVertexPositions { .. }
3865 | Expression::CooperativeLoad { .. }
3866 | Expression::CooperativeMultiplyAdd { .. } => unreachable!(),
3867 }
3868
3869 Ok(())
3870 }
3871
3872 /// Helper function to write the local holding the clamped lod
3873 fn write_clamped_lod(
3874 &mut self,
3875 ctx: &back::FunctionCtx,
3876 expr: Handle<crate::Expression>,
3877 image: Handle<crate::Expression>,
3878 level_expr: Handle<crate::Expression>,
3879 ) -> Result<(), Error> {
3880 // Define our local and start a call to `clamp`
3881 write!(
3882 self.out,
3883 "int {}{} = clamp(",
3884 Baked(expr),
3885 CLAMPED_LOD_SUFFIX
3886 )?;
3887 // Write the lod that will be clamped
3888 self.write_expr(level_expr, ctx)?;
3889 // Set the min value to 0 and start a call to `textureQueryLevels` to get
3890 // the maximum value
3891 write!(self.out, ", 0, textureQueryLevels(")?;
3892 // Write the target image as an argument to `textureQueryLevels`
3893 self.write_expr(image, ctx)?;
3894 // Close the call to `textureQueryLevels` subtract 1 from it since
3895 // the lod argument is 0 based, close the `clamp` call and end the
3896 // local declaration statement.
3897 writeln!(self.out, ") - 1);")?;
3898
3899 Ok(())
3900 }
3901
3902 // Helper method used to retrieve how many elements a coordinate vector
3903 // for the images operations need.
3904 fn get_coordinate_vector_size(&self, dim: crate::ImageDimension, arrayed: bool) -> u8 {
3905 // openGL es doesn't have 1D images so we need workaround it
3906 let tex_1d_hack = dim == crate::ImageDimension::D1 && self.options.version.is_es();
3907 // Get how many components the coordinate vector needs for the dimensions only
3908 let tex_coord_size = match dim {
3909 crate::ImageDimension::D1 => 1,
3910 crate::ImageDimension::D2 => 2,
3911 crate::ImageDimension::D3 => 3,
3912 crate::ImageDimension::Cube => 2,
3913 };
3914 // Calculate the true size of the coordinate vector by adding 1 for arrayed images
3915 // and another 1 if we need to workaround 1D images by making them 2D
3916 tex_coord_size + tex_1d_hack as u8 + arrayed as u8
3917 }
3918
3919 /// Helper method to write the coordinate vector for image operations
3920 fn write_texture_coord(
3921 &mut self,
3922 ctx: &back::FunctionCtx,
3923 vector_size: u8,
3924 coordinate: Handle<crate::Expression>,
3925 array_index: Option<Handle<crate::Expression>>,
3926 // Emulate 1D images as 2D for profiles that don't support it (glsl es)
3927 tex_1d_hack: bool,
3928 ) -> Result<(), Error> {
3929 match array_index {
3930 // If the image needs an array indice we need to add it to the end of our
3931 // coordinate vector, to do so we will use the `ivec(ivec, scalar)`
3932 // constructor notation (NOTE: the inner `ivec` can also be a scalar, this
3933 // is important for 1D arrayed images).
3934 Some(layer_expr) => {
3935 write!(self.out, "ivec{vector_size}(")?;
3936 self.write_expr(coordinate, ctx)?;
3937 write!(self.out, ", ")?;
3938 // If we are replacing sampler1D with sampler2D we also need
3939 // to add another zero to the coordinates vector for the y component
3940 if tex_1d_hack {
3941 write!(self.out, "0, ")?;
3942 }
3943 self.write_expr(layer_expr, ctx)?;
3944 write!(self.out, ")")?;
3945 }
3946 // Otherwise write just the expression (and the 1D hack if needed)
3947 None => {
3948 let uvec_size = match *ctx.resolve_type(coordinate, &self.module.types) {
3949 TypeInner::Scalar(crate::Scalar {
3950 kind: crate::ScalarKind::Uint,
3951 ..
3952 }) => Some(None),
3953 TypeInner::Vector {
3954 size,
3955 scalar:
3956 crate::Scalar {
3957 kind: crate::ScalarKind::Uint,
3958 ..
3959 },
3960 } => Some(Some(size as u32)),
3961 _ => None,
3962 };
3963 if tex_1d_hack {
3964 write!(self.out, "ivec2(")?;
3965 } else if uvec_size.is_some() {
3966 match uvec_size {
3967 Some(None) => write!(self.out, "int(")?,
3968 Some(Some(size)) => write!(self.out, "ivec{size}(")?,
3969 _ => {}
3970 }
3971 }
3972 self.write_expr(coordinate, ctx)?;
3973 if tex_1d_hack {
3974 write!(self.out, ", 0)")?;
3975 } else if uvec_size.is_some() {
3976 write!(self.out, ")")?;
3977 }
3978 }
3979 }
3980
3981 Ok(())
3982 }
3983
3984 /// Helper method to write the `ImageStore` statement
3985 fn write_image_store(
3986 &mut self,
3987 ctx: &back::FunctionCtx,
3988 image: Handle<crate::Expression>,
3989 coordinate: Handle<crate::Expression>,
3990 array_index: Option<Handle<crate::Expression>>,
3991 value: Handle<crate::Expression>,
3992 ) -> Result<(), Error> {
3993 use crate::ImageDimension as IDim;
3994
3995 // NOTE: openGL requires that `imageStore`s have no effects when the texel is invalid
3996 // so we don't need to generate bounds checks (OpenGL 4.2 Core §3.9.20)
3997
3998 // This will only panic if the module is invalid
3999 let dim = match *ctx.resolve_type(image, &self.module.types) {
4000 TypeInner::Image { dim, .. } => dim,
4001 _ => unreachable!(),
4002 };
4003
4004 // Begin our call to `imageStore`
4005 write!(self.out, "imageStore(")?;
4006 self.write_expr(image, ctx)?;
4007 // Separate the image argument from the coordinates
4008 write!(self.out, ", ")?;
4009
4010 // openGL es doesn't have 1D images so we need workaround it
4011 let tex_1d_hack = dim == IDim::D1 && self.options.version.is_es();
4012 // Write the coordinate vector
4013 self.write_texture_coord(
4014 ctx,
4015 // Get the size of the coordinate vector
4016 self.get_coordinate_vector_size(dim, array_index.is_some()),
4017 coordinate,
4018 array_index,
4019 tex_1d_hack,
4020 )?;
4021
4022 // Separate the coordinate from the value to write and write the expression
4023 // of the value to write.
4024 write!(self.out, ", ")?;
4025 self.write_expr(value, ctx)?;
4026 // End the call to `imageStore` and the statement.
4027 writeln!(self.out, ");")?;
4028
4029 Ok(())
4030 }
4031
4032 /// Helper method to write the `ImageAtomic` statement
4033 fn write_image_atomic(
4034 &mut self,
4035 ctx: &back::FunctionCtx,
4036 image: Handle<crate::Expression>,
4037 coordinate: Handle<crate::Expression>,
4038 array_index: Option<Handle<crate::Expression>>,
4039 fun: crate::AtomicFunction,
4040 value: Handle<crate::Expression>,
4041 ) -> Result<(), Error> {
4042 use crate::ImageDimension as IDim;
4043
4044 // NOTE: openGL requires that `imageAtomic`s have no effects when the texel is invalid
4045 // so we don't need to generate bounds checks (OpenGL 4.2 Core §3.9.20)
4046
4047 // This will only panic if the module is invalid
4048 let dim = match *ctx.resolve_type(image, &self.module.types) {
4049 TypeInner::Image { dim, .. } => dim,
4050 _ => unreachable!(),
4051 };
4052
4053 // Begin our call to `imageAtomic`
4054 let fun_str = fun.to_glsl();
4055 write!(self.out, "imageAtomic{fun_str}(")?;
4056 self.write_expr(image, ctx)?;
4057 // Separate the image argument from the coordinates
4058 write!(self.out, ", ")?;
4059
4060 // openGL es doesn't have 1D images so we need workaround it
4061 let tex_1d_hack = dim == IDim::D1 && self.options.version.is_es();
4062 // Write the coordinate vector
4063 self.write_texture_coord(
4064 ctx,
4065 // Get the size of the coordinate vector
4066 self.get_coordinate_vector_size(dim, false),
4067 coordinate,
4068 array_index,
4069 tex_1d_hack,
4070 )?;
4071
4072 // Separate the coordinate from the value to write and write the expression
4073 // of the value to write.
4074 write!(self.out, ", ")?;
4075 self.write_expr(value, ctx)?;
4076 // End the call to `imageAtomic` and the statement.
4077 writeln!(self.out, ");")?;
4078
4079 Ok(())
4080 }
4081
4082 /// Helper method for writing an `ImageLoad` expression.
4083 #[allow(clippy::too_many_arguments)]
4084 fn write_image_load(
4085 &mut self,
4086 handle: Handle<crate::Expression>,
4087 ctx: &back::FunctionCtx,
4088 image: Handle<crate::Expression>,
4089 coordinate: Handle<crate::Expression>,
4090 array_index: Option<Handle<crate::Expression>>,
4091 sample: Option<Handle<crate::Expression>>,
4092 level: Option<Handle<crate::Expression>>,
4093 ) -> Result<(), Error> {
4094 use crate::ImageDimension as IDim;
4095
4096 // `ImageLoad` is a bit complicated.
4097 // There are two functions one for sampled
4098 // images another for storage images, the former uses `texelFetch` and the
4099 // latter uses `imageLoad`.
4100 //
4101 // Furthermore we have `level` which is always `Some` for sampled images
4102 // and `None` for storage images, so we end up with two functions:
4103 // - `texelFetch(image, coordinate, level)` for sampled images
4104 // - `imageLoad(image, coordinate)` for storage images
4105 //
4106 // Finally we also have to consider bounds checking, for storage images
4107 // this is easy since openGL requires that invalid texels always return
4108 // 0, for sampled images we need to either verify that all arguments are
4109 // in bounds (`ReadZeroSkipWrite`) or make them a valid texel (`Restrict`).
4110
4111 // This will only panic if the module is invalid
4112 let (dim, class) = match *ctx.resolve_type(image, &self.module.types) {
4113 TypeInner::Image {
4114 dim,
4115 arrayed: _,
4116 class,
4117 } => (dim, class),
4118 _ => unreachable!(),
4119 };
4120
4121 // Get the name of the function to be used for the load operation
4122 // and the policy to be used with it.
4123 let (fun_name, policy) = match class {
4124 // Sampled images inherit the policy from the user passed policies
4125 crate::ImageClass::Sampled { .. } => ("texelFetch", self.policies.image_load),
4126 crate::ImageClass::Storage { .. } => {
4127 // OpenGL ES 3.1 mentions in Chapter "8.22 Texture Image Loads and Stores" that:
4128 // "Invalid image loads will return a vector where the value of R, G, and B components
4129 // is 0 and the value of the A component is undefined."
4130 //
4131 // OpenGL 4.2 Core mentions in Chapter "3.9.20 Texture Image Loads and Stores" that:
4132 // "Invalid image loads will return zero."
4133 //
4134 // So, we only inject bounds checks for ES
4135 let policy = if self.options.version.is_es() {
4136 self.policies.image_load
4137 } else {
4138 proc::BoundsCheckPolicy::Unchecked
4139 };
4140 ("imageLoad", policy)
4141 }
4142 // TODO: Is there even a function for this?
4143 crate::ImageClass::Depth { multi: _ } => {
4144 return Err(Error::Custom(
4145 "WGSL `textureLoad` from depth textures is not supported in GLSL".to_string(),
4146 ))
4147 }
4148 crate::ImageClass::External => unimplemented!(),
4149 };
4150
4151 // openGL es doesn't have 1D images so we need workaround it
4152 let tex_1d_hack = dim == IDim::D1 && self.options.version.is_es();
4153 // Get the size of the coordinate vector
4154 let vector_size = self.get_coordinate_vector_size(dim, array_index.is_some());
4155
4156 if let proc::BoundsCheckPolicy::ReadZeroSkipWrite = policy {
4157 // To write the bounds checks for `ReadZeroSkipWrite` we will use a
4158 // ternary operator since we are in the middle of an expression and
4159 // need to return a value.
4160 //
4161 // NOTE: glsl does short circuit when evaluating logical
4162 // expressions so we can be sure that after we test a
4163 // condition it will be true for the next ones
4164
4165 // Write parentheses around the ternary operator to prevent problems with
4166 // expressions emitted before or after it having more precedence
4167 write!(self.out, "(",)?;
4168
4169 // The lod check needs to precede the size check since we need
4170 // to use the lod to get the size of the image at that level.
4171 if let Some(level_expr) = level {
4172 self.write_expr(level_expr, ctx)?;
4173 write!(self.out, " < textureQueryLevels(",)?;
4174 self.write_expr(image, ctx)?;
4175 // Chain the next check
4176 write!(self.out, ") && ")?;
4177 }
4178
4179 // Check that the sample arguments doesn't exceed the number of samples
4180 if let Some(sample_expr) = sample {
4181 self.write_expr(sample_expr, ctx)?;
4182 write!(self.out, " < textureSamples(",)?;
4183 self.write_expr(image, ctx)?;
4184 // Chain the next check
4185 write!(self.out, ") && ")?;
4186 }
4187
4188 // We now need to write the size checks for the coordinates and array index
4189 // first we write the comparison function in case the image is 1D non arrayed
4190 // (and no 1D to 2D hack was needed) we are comparing scalars so the less than
4191 // operator will suffice, but otherwise we'll be comparing two vectors so we'll
4192 // need to use the `lessThan` function but it returns a vector of booleans (one
4193 // for each comparison) so we need to fold it all in one scalar boolean, since
4194 // we want all comparisons to pass we use the `all` function which will only
4195 // return `true` if all the elements of the boolean vector are also `true`.
4196 //
4197 // So we'll end with one of the following forms
4198 // - `coord < textureSize(image, lod)` for 1D images
4199 // - `all(lessThan(coord, textureSize(image, lod)))` for normal images
4200 // - `all(lessThan(ivec(coord, array_index), textureSize(image, lod)))`
4201 // for arrayed images
4202 // - `all(lessThan(coord, textureSize(image)))` for multi sampled images
4203
4204 if vector_size != 1 {
4205 write!(self.out, "all(lessThan(")?;
4206 }
4207
4208 // Write the coordinate vector
4209 self.write_texture_coord(ctx, vector_size, coordinate, array_index, tex_1d_hack)?;
4210
4211 if vector_size != 1 {
4212 // If we used the `lessThan` function we need to separate the
4213 // coordinates from the image size.
4214 write!(self.out, ", ")?;
4215 } else {
4216 // If we didn't use it (ie. 1D images) we perform the comparison
4217 // using the less than operator.
4218 write!(self.out, " < ")?;
4219 }
4220
4221 // Call `textureSize` to get our image size
4222 write!(self.out, "textureSize(")?;
4223 self.write_expr(image, ctx)?;
4224 // `textureSize` uses the lod as a second argument for mipmapped images
4225 if let Some(level_expr) = level {
4226 // Separate the image from the lod
4227 write!(self.out, ", ")?;
4228 self.write_expr(level_expr, ctx)?;
4229 }
4230 // Close the `textureSize` call
4231 write!(self.out, ")")?;
4232
4233 if vector_size != 1 {
4234 // Close the `all` and `lessThan` calls
4235 write!(self.out, "))")?;
4236 }
4237
4238 // Finally end the condition part of the ternary operator
4239 write!(self.out, " ? ")?;
4240 }
4241
4242 // Begin the call to the function used to load the texel
4243 write!(self.out, "{fun_name}(")?;
4244 self.write_expr(image, ctx)?;
4245 write!(self.out, ", ")?;
4246
4247 // If we are using `Restrict` bounds checking we need to pass valid texel
4248 // coordinates, to do so we use the `clamp` function to get a value between
4249 // 0 and the image size - 1 (indexing begins at 0)
4250 if let proc::BoundsCheckPolicy::Restrict = policy {
4251 write!(self.out, "clamp(")?;
4252 }
4253
4254 // Write the coordinate vector
4255 self.write_texture_coord(ctx, vector_size, coordinate, array_index, tex_1d_hack)?;
4256
4257 // If we are using `Restrict` bounds checking we need to write the rest of the
4258 // clamp we initiated before writing the coordinates.
4259 if let proc::BoundsCheckPolicy::Restrict = policy {
4260 // Write the min value 0
4261 if vector_size == 1 {
4262 write!(self.out, ", 0")?;
4263 } else {
4264 write!(self.out, ", ivec{vector_size}(0)")?;
4265 }
4266 // Start the `textureSize` call to use as the max value.
4267 write!(self.out, ", textureSize(")?;
4268 self.write_expr(image, ctx)?;
4269 // If the image is mipmapped we need to add the lod argument to the
4270 // `textureSize` call, but this needs to be the clamped lod, this should
4271 // have been generated earlier and put in a local.
4272 if class.is_mipmapped() {
4273 write!(self.out, ", {}{}", Baked(handle), CLAMPED_LOD_SUFFIX)?;
4274 }
4275 // Close the `textureSize` call
4276 write!(self.out, ")")?;
4277
4278 // Subtract 1 from the `textureSize` call since the coordinates are zero based.
4279 if vector_size == 1 {
4280 write!(self.out, " - 1")?;
4281 } else {
4282 write!(self.out, " - ivec{vector_size}(1)")?;
4283 }
4284
4285 // Close the `clamp` call
4286 write!(self.out, ")")?;
4287
4288 // Add the clamped lod (if present) as the second argument to the
4289 // image load function.
4290 if level.is_some() {
4291 write!(self.out, ", {}{}", Baked(handle), CLAMPED_LOD_SUFFIX)?;
4292 }
4293
4294 // If a sample argument is needed we need to clamp it between 0 and
4295 // the number of samples the image has.
4296 if let Some(sample_expr) = sample {
4297 write!(self.out, ", clamp(")?;
4298 self.write_expr(sample_expr, ctx)?;
4299 // Set the min value to 0 and start the call to `textureSamples`
4300 write!(self.out, ", 0, textureSamples(")?;
4301 self.write_expr(image, ctx)?;
4302 // Close the `textureSamples` call, subtract 1 from it since the sample
4303 // argument is zero based, and close the `clamp` call
4304 writeln!(self.out, ") - 1)")?;
4305 }
4306 } else if let Some(sample_or_level) = sample.or(level) {
4307 // GLSL only support SInt on this field while WGSL support also UInt
4308 let cast_to_int = matches!(
4309 *ctx.resolve_type(sample_or_level, &self.module.types),
4310 TypeInner::Scalar(crate::Scalar {
4311 kind: crate::ScalarKind::Uint,
4312 ..
4313 })
4314 );
4315
4316 // If no bounds checking is need just add the sample or level argument
4317 // after the coordinates
4318 write!(self.out, ", ")?;
4319
4320 if cast_to_int {
4321 write!(self.out, "int(")?;
4322 }
4323
4324 self.write_expr(sample_or_level, ctx)?;
4325
4326 if cast_to_int {
4327 write!(self.out, ")")?;
4328 }
4329 }
4330
4331 // Close the image load function.
4332 write!(self.out, ")")?;
4333
4334 // If we were using the `ReadZeroSkipWrite` policy we need to end the first branch
4335 // (which is taken if the condition is `true`) with a colon (`:`) and write the
4336 // second branch which is just a 0 value.
4337 if let proc::BoundsCheckPolicy::ReadZeroSkipWrite = policy {
4338 // Get the kind of the output value.
4339 let kind = match class {
4340 // Only sampled images can reach here since storage images
4341 // don't need bounds checks and depth images aren't implemented
4342 crate::ImageClass::Sampled { kind, .. } => kind,
4343 _ => unreachable!(),
4344 };
4345
4346 // End the first branch
4347 write!(self.out, " : ")?;
4348 // Write the 0 value
4349 write!(
4350 self.out,
4351 "{}vec4(",
4352 glsl_scalar(crate::Scalar { kind, width: 4 })?.prefix,
4353 )?;
4354 self.write_zero_init_scalar(kind)?;
4355 // Close the zero value constructor
4356 write!(self.out, ")")?;
4357 // Close the parentheses surrounding our ternary
4358 write!(self.out, ")")?;
4359 }
4360
4361 Ok(())
4362 }
4363
4364 fn write_named_expr(
4365 &mut self,
4366 handle: Handle<crate::Expression>,
4367 name: String,
4368 // The expression which is being named.
4369 // Generally, this is the same as handle, except in WorkGroupUniformLoad
4370 named: Handle<crate::Expression>,
4371 ctx: &back::FunctionCtx,
4372 ) -> BackendResult {
4373 match ctx.info[named].ty {
4374 proc::TypeResolution::Handle(ty_handle) => match self.module.types[ty_handle].inner {
4375 TypeInner::Struct { .. } => {
4376 let ty_name = &self.names[&NameKey::Type(ty_handle)];
4377 write!(self.out, "{ty_name}")?;
4378 }
4379 _ => {
4380 self.write_type(ty_handle)?;
4381 }
4382 },
4383 proc::TypeResolution::Value(ref inner) => {
4384 self.write_value_type(inner)?;
4385 }
4386 }
4387
4388 let resolved = ctx.resolve_type(named, &self.module.types);
4389
4390 write!(self.out, " {name}")?;
4391 if let TypeInner::Array { base, size, .. } = *resolved {
4392 self.write_array_size(base, size)?;
4393 }
4394 write!(self.out, " = ")?;
4395 self.write_expr(handle, ctx)?;
4396 writeln!(self.out, ";")?;
4397 self.named_expressions.insert(named, name);
4398
4399 Ok(())
4400 }
4401
4402 /// Helper function that write string with default zero initialization for supported types
4403 fn write_zero_init_value(&mut self, ty: Handle<crate::Type>) -> BackendResult {
4404 let inner = &self.module.types[ty].inner;
4405 match *inner {
4406 TypeInner::Scalar(scalar) | TypeInner::Atomic(scalar) => {
4407 self.write_zero_init_scalar(scalar.kind)?;
4408 }
4409 TypeInner::Vector { scalar, .. } => {
4410 self.write_value_type(inner)?;
4411 write!(self.out, "(")?;
4412 self.write_zero_init_scalar(scalar.kind)?;
4413 write!(self.out, ")")?;
4414 }
4415 TypeInner::Matrix { .. } => {
4416 self.write_value_type(inner)?;
4417 write!(self.out, "(")?;
4418 self.write_zero_init_scalar(crate::ScalarKind::Float)?;
4419 write!(self.out, ")")?;
4420 }
4421 TypeInner::Array { base, size, .. } => {
4422 let count = match size.resolve(self.module.to_ctx())? {
4423 proc::IndexableLength::Known(count) => count,
4424 proc::IndexableLength::Dynamic => return Ok(()),
4425 };
4426 self.write_type(base)?;
4427 self.write_array_size(base, size)?;
4428 write!(self.out, "(")?;
4429 for _ in 1..count {
4430 self.write_zero_init_value(base)?;
4431 write!(self.out, ", ")?;
4432 }
4433 // write last parameter without comma and space
4434 self.write_zero_init_value(base)?;
4435 write!(self.out, ")")?;
4436 }
4437 TypeInner::Struct { ref members, .. } => {
4438 let name = &self.names[&NameKey::Type(ty)];
4439 write!(self.out, "{name}(")?;
4440 for (index, member) in members.iter().enumerate() {
4441 if index != 0 {
4442 write!(self.out, ", ")?;
4443 }
4444 self.write_zero_init_value(member.ty)?;
4445 }
4446 write!(self.out, ")")?;
4447 }
4448 _ => unreachable!(),
4449 }
4450
4451 Ok(())
4452 }
4453
4454 /// Helper function that write string with zero initialization for scalar
4455 fn write_zero_init_scalar(&mut self, kind: crate::ScalarKind) -> BackendResult {
4456 match kind {
4457 crate::ScalarKind::Bool => write!(self.out, "false")?,
4458 crate::ScalarKind::Uint => write!(self.out, "0u")?,
4459 crate::ScalarKind::Float => write!(self.out, "0.0")?,
4460 crate::ScalarKind::Sint => write!(self.out, "0")?,
4461 crate::ScalarKind::AbstractInt | crate::ScalarKind::AbstractFloat => {
4462 return Err(Error::Custom(
4463 "Abstract types should not appear in IR presented to backends".to_string(),
4464 ))
4465 }
4466 }
4467
4468 Ok(())
4469 }
4470
4471 /// Issue a control barrier.
4472 fn write_control_barrier(
4473 &mut self,
4474 flags: crate::Barrier,
4475 level: back::Level,
4476 ) -> BackendResult {
4477 self.write_memory_barrier(flags, level)?;
4478 writeln!(self.out, "{level}barrier();")?;
4479 Ok(())
4480 }
4481
4482 /// Issue a memory barrier.
4483 fn write_memory_barrier(&mut self, flags: crate::Barrier, level: back::Level) -> BackendResult {
4484 if flags.contains(crate::Barrier::STORAGE) {
4485 writeln!(self.out, "{level}memoryBarrierBuffer();")?;
4486 }
4487 if flags.contains(crate::Barrier::WORK_GROUP) {
4488 writeln!(self.out, "{level}memoryBarrierShared();")?;
4489 }
4490 if flags.contains(crate::Barrier::SUB_GROUP) {
4491 writeln!(self.out, "{level}subgroupMemoryBarrier();")?;
4492 }
4493 if flags.contains(crate::Barrier::TEXTURE) {
4494 writeln!(self.out, "{level}memoryBarrierImage();")?;
4495 }
4496 Ok(())
4497 }
4498
4499 /// Helper function that return the glsl storage access string of [`StorageAccess`](crate::StorageAccess)
4500 ///
4501 /// glsl allows adding both `readonly` and `writeonly` but this means that
4502 /// they can only be used to query information about the resource which isn't what
4503 /// we want here so when storage access is both `LOAD` and `STORE` add no modifiers
4504 fn write_storage_access(&mut self, storage_access: crate::StorageAccess) -> BackendResult {
4505 if storage_access.contains(crate::StorageAccess::ATOMIC) {
4506 return Ok(());
4507 }
4508 if !storage_access.contains(crate::StorageAccess::STORE) {
4509 write!(self.out, "readonly ")?;
4510 }
4511 if !storage_access.contains(crate::StorageAccess::LOAD) {
4512 write!(self.out, "writeonly ")?;
4513 }
4514 Ok(())
4515 }
4516
4517 /// Helper method used to produce the reflection info that's returned to the user
4518 fn collect_reflection_info(&mut self) -> Result<ReflectionInfo, Error> {
4519 let info = self.info.get_entry_point(self.entry_point_idx as usize);
4520 let mut texture_mapping = crate::FastHashMap::default();
4521 let mut uniforms = crate::FastHashMap::default();
4522
4523 for sampling in info.sampling_set.iter() {
4524 let tex_name = self.reflection_names_globals[&sampling.image].clone();
4525
4526 match texture_mapping.entry(tex_name) {
4527 hash_map::Entry::Vacant(v) => {
4528 v.insert(TextureMapping {
4529 texture: sampling.image,
4530 sampler: Some(sampling.sampler),
4531 });
4532 }
4533 hash_map::Entry::Occupied(e) => {
4534 if e.get().sampler != Some(sampling.sampler) {
4535 log::error!("Conflicting samplers for {}", e.key());
4536 return Err(Error::ImageMultipleSamplers);
4537 }
4538 }
4539 }
4540 }
4541
4542 let mut immediates_info = None;
4543 for (handle, var) in self.module.global_variables.iter() {
4544 if info[handle].is_empty() {
4545 continue;
4546 }
4547 match self.module.types[var.ty].inner {
4548 TypeInner::Image { .. } => {
4549 let tex_name = self.reflection_names_globals[&handle].clone();
4550 match texture_mapping.entry(tex_name) {
4551 hash_map::Entry::Vacant(v) => {
4552 v.insert(TextureMapping {
4553 texture: handle,
4554 sampler: None,
4555 });
4556 }
4557 hash_map::Entry::Occupied(_) => {
4558 // already used with a sampler, do nothing
4559 }
4560 }
4561 }
4562 _ => match var.space {
4563 crate::AddressSpace::Uniform | crate::AddressSpace::Storage { .. } => {
4564 let name = self.reflection_names_globals[&handle].clone();
4565 uniforms.insert(handle, name);
4566 }
4567 crate::AddressSpace::Immediate => {
4568 let name = self.reflection_names_globals[&handle].clone();
4569 immediates_info = Some((name, var.ty));
4570 }
4571 _ => (),
4572 },
4573 }
4574 }
4575
4576 let mut immediates_segments = Vec::new();
4577 let mut immediates_items = vec![];
4578
4579 if let Some((name, ty)) = immediates_info {
4580 // We don't have a layouter available to us, so we need to create one.
4581 //
4582 // This is potentially a bit wasteful, but the set of types in the program
4583 // shouldn't be too large.
4584 let mut layouter = proc::Layouter::default();
4585 layouter.update(self.module.to_ctx()).unwrap();
4586
4587 // We start with the name of the binding itself.
4588 immediates_segments.push(name);
4589
4590 // We then recursively collect all the uniform fields of the immediate data.
4591 self.collect_immediates_items(
4592 ty,
4593 &mut immediates_segments,
4594 &layouter,
4595 &mut 0,
4596 &mut immediates_items,
4597 );
4598 }
4599
4600 Ok(ReflectionInfo {
4601 texture_mapping,
4602 uniforms,
4603 varying: mem::take(&mut self.varying),
4604 immediates_items,
4605 clip_distance_count: self.clip_distance_count,
4606 })
4607 }
4608
4609 fn collect_immediates_items(
4610 &mut self,
4611 ty: Handle<crate::Type>,
4612 segments: &mut Vec<String>,
4613 layouter: &proc::Layouter,
4614 offset: &mut u32,
4615 items: &mut Vec<ImmediateItem>,
4616 ) {
4617 // At this point in the recursion, `segments` contains the path
4618 // needed to access `ty` from the root.
4619
4620 let layout = &layouter[ty];
4621 *offset = layout.alignment.round_up(*offset);
4622 match self.module.types[ty].inner {
4623 // All these types map directly to GL uniforms.
4624 TypeInner::Scalar { .. } | TypeInner::Vector { .. } | TypeInner::Matrix { .. } => {
4625 // Build the full name, by combining all current segments.
4626 let name: String = segments.iter().map(String::as_str).collect();
4627 items.push(ImmediateItem {
4628 access_path: name,
4629 offset: *offset,
4630 ty: (&self.module.types[ty].inner).try_into().unwrap(),
4631 size_bytes: layout.size,
4632 });
4633 *offset += layout.size;
4634 }
4635 // Arrays are recursed into.
4636 TypeInner::Array { base, size, .. } => {
4637 let crate::ArraySize::Constant(count) = size else {
4638 unreachable!("Cannot have dynamic arrays in immediates");
4639 };
4640
4641 for i in 0..count.get() {
4642 // Add the array accessor and recurse.
4643 segments.push(format!("[{i}]"));
4644 self.collect_immediates_items(base, segments, layouter, offset, items);
4645 segments.pop();
4646 }
4647
4648 // Ensure the stride is kept by rounding up to the alignment.
4649 *offset = layout.alignment.round_up(*offset)
4650 }
4651 TypeInner::Struct { ref members, .. } => {
4652 for (index, member) in members.iter().enumerate() {
4653 // Add struct accessor and recurse.
4654 segments.push(format!(
4655 ".{}",
4656 self.names[&NameKey::StructMember(ty, index as u32)]
4657 ));
4658 self.collect_immediates_items(member.ty, segments, layouter, offset, items);
4659 segments.pop();
4660 }
4661
4662 // Ensure ending padding is kept by rounding up to the alignment.
4663 *offset = layout.alignment.round_up(*offset)
4664 }
4665 _ => unreachable!(),
4666 }
4667 }
4668}