spirv_std/
lib.rs

1#![no_std]
2#![cfg_attr(
3    target_arch = "spirv",
4    allow(internal_features),
5    feature(asm_experimental_arch, core_intrinsics, lang_items, repr_simd)
6)]
7// FIXME(eddyb) update/review these lints.
8//
9// BEGIN - Embark standard lints v0.4
10// do not change or add/remove here, but one can add exceptions after this section
11// for more info see: <https://github.com/EmbarkStudios/rust-ecosystem/issues/59>
12#![deny(unsafe_code)]
13#![warn(
14    clippy::all,
15    clippy::await_holding_lock,
16    clippy::char_lit_as_u8,
17    clippy::checked_conversions,
18    clippy::dbg_macro,
19    clippy::debug_assert_with_mut_call,
20    clippy::doc_markdown,
21    clippy::empty_enum,
22    clippy::enum_glob_use,
23    clippy::exit,
24    clippy::expl_impl_clone_on_copy,
25    clippy::explicit_deref_methods,
26    clippy::explicit_into_iter_loop,
27    clippy::fallible_impl_from,
28    clippy::filter_map_next,
29    clippy::float_cmp_const,
30    clippy::fn_params_excessive_bools,
31    clippy::if_let_mutex,
32    clippy::implicit_clone,
33    clippy::imprecise_flops,
34    clippy::inefficient_to_string,
35    clippy::invalid_upcast_comparisons,
36    clippy::large_types_passed_by_value,
37    clippy::let_unit_value,
38    clippy::linkedlist,
39    clippy::lossy_float_literal,
40    clippy::macro_use_imports,
41    clippy::manual_ok_or,
42    clippy::map_err_ignore,
43    clippy::map_flatten,
44    clippy::map_unwrap_or,
45    clippy::match_same_arms,
46    clippy::match_wildcard_for_single_variants,
47    clippy::mem_forget,
48    clippy::mut_mut,
49    clippy::mutex_integer,
50    clippy::needless_borrow,
51    clippy::needless_continue,
52    clippy::option_option,
53    clippy::path_buf_push_overwrite,
54    clippy::ptr_as_ptr,
55    clippy::ref_option_ref,
56    clippy::rest_pat_in_fully_bound_structs,
57    clippy::same_functions_in_if_condition,
58    clippy::semicolon_if_nothing_returned,
59    clippy::string_add_assign,
60    clippy::string_add,
61    clippy::string_lit_as_bytes,
62    clippy::string_to_string,
63    clippy::todo,
64    clippy::trait_duplication_in_bounds,
65    clippy::unimplemented,
66    clippy::unnested_or_patterns,
67    clippy::unused_self,
68    clippy::useless_transmute,
69    clippy::verbose_file_reads,
70    clippy::zero_sized_map_values,
71    future_incompatible,
72    nonstandard_style,
73    rust_2018_idioms
74)]
75// END - Embark standard lints v0.4
76// crate-specific exceptions:
77#![allow(
78    // Needed for `asm!`.
79    unsafe_code,
80    // We deblierately provide an unimplemented version of our API on CPU
81    // platforms so that code completion still works.
82    clippy::unimplemented,
83)]
84#![warn(missing_docs)]
85#![doc = include_str!("../README.md")]
86
87/// Public re-export of the `spirv-std-macros` crate.
88#[macro_use]
89pub extern crate spirv_std_macros as macros;
90pub use macros::spirv;
91
92pub mod arch;
93pub mod byte_addressable_buffer;
94pub mod float;
95pub mod image;
96pub mod indirect_command;
97pub mod integer;
98pub mod memory;
99pub mod number;
100pub mod ray_tracing;
101mod runtime_array;
102mod sampler;
103pub mod scalar;
104pub(crate) mod sealed;
105mod typed_buffer;
106pub mod vector;
107
108pub use self::sampler::Sampler;
109pub use crate::macros::Image;
110pub use byte_addressable_buffer::ByteAddressableBuffer;
111pub use num_traits;
112pub use runtime_array::*;
113pub use typed_buffer::*;
114
115pub use glam;
116
117#[cfg(all(not(test), target_arch = "spirv"))]
118#[panic_handler]
119fn panic(_: &core::panic::PanicInfo<'_>) -> ! {
120    loop {}
121}
122
123#[cfg(all(not(test), target_arch = "spirv"))]
124#[lang = "eh_personality"]
125extern "C" fn rust_eh_personality() {}
126
127// See: https://github.com/rust-lang/rust/issues/84738
128#[doc(hidden)]
129/// [spirv_std_types]
130pub fn workaround_rustdoc_ice_84738() {}
131
132#[doc(hidden)]
133pub fn debug_printf_assert_is_type<T>(ty: T) -> T {
134    ty
135}
136
137#[doc(hidden)]
138pub fn debug_printf_assert_is_vector<
139    TY: crate::scalar::Scalar,
140    V: crate::vector::Vector<TY, SIZE>,
141    const SIZE: usize,
142>(
143    vec: V,
144) -> V {
145    vec
146}