1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441
use crate::sealed::Sealed;
use spirv_cross_sys::{spvc_constant, spvc_specialization_constant, TypeId};
use std::mem::MaybeUninit;
use std::ops::{Index, IndexMut};
use std::slice;
use crate::error::{SpirvCrossError, ToContextError};
use crate::handle::{ConstantId, Handle};
use crate::iter::impl_iterator;
use crate::{error, Compiler, PhantomCompiler};
use spirv_cross_sys as sys;
mod gfx_maths;
mod half;
mod glam;
/// A marker trait for types that can be represented as a scalar SPIR-V constant.
pub trait ConstantScalar: Default + Sealed + Copy {
#[doc(hidden)]
unsafe fn get(constant: spvc_constant, column: u32, row: u32) -> Self;
#[doc(hidden)]
unsafe fn set(constant: spvc_constant, column: u32, row: u32, value: Self);
}
macro_rules! impl_spvc_constant {
($get:ident $set:ident $prim:ty) => {
impl Sealed for $prim {}
impl ConstantScalar for $prim {
unsafe fn get(constant: spvc_constant, column: u32, row: u32) -> Self {
unsafe { ::spirv_cross_sys::$get(constant, column, row) as Self }
}
unsafe fn set(constant: spvc_constant, column: u32, row: u32, value: Self) {
unsafe { ::spirv_cross_sys::$set(constant, column, row, value) }
}
}
};
}
macro_rules! impl_vec_constant {
($vec_ty:ty [$base_ty:ty; $len:literal] for [$($component:ident),*]) => {
impl $crate::sealed::Sealed for $vec_ty {}
impl $crate::reflect::constants::ConstantValue for $vec_ty {
const COLUMNS: usize = 1;
const VECSIZE: usize = $len;
type BaseArrayType = [$base_ty; $len];
type ArrayType = [[$base_ty; $len]; 1];
type BaseType = $base_ty;
fn from_array(value: Self::ArrayType) -> Self {
value[0].into()
}
fn to_array(value: Self) -> Self::ArrayType {
[[$(value.$component),*]]
}
}
};
}
impl_spvc_constant!(spvc_constant_get_scalar_i8 spvc_constant_set_scalar_i8 i8);
impl_spvc_constant!(spvc_constant_get_scalar_i16 spvc_constant_set_scalar_i16 i16);
impl_spvc_constant!(spvc_constant_get_scalar_i32 spvc_constant_set_scalar_i32 i32);
impl_spvc_constant!(spvc_constant_get_scalar_i64 spvc_constant_set_scalar_i64 i64);
impl_spvc_constant!(spvc_constant_get_scalar_u8 spvc_constant_set_scalar_u8 u8);
impl_spvc_constant!(spvc_constant_get_scalar_u16 spvc_constant_set_scalar_u16 u16);
impl_spvc_constant!(spvc_constant_get_scalar_u32 spvc_constant_set_scalar_u32 u32);
impl_spvc_constant!(spvc_constant_get_scalar_u64 spvc_constant_set_scalar_u64 u64);
impl_spvc_constant!(spvc_constant_get_scalar_fp32 spvc_constant_set_scalar_fp32 f32);
impl_spvc_constant!(spvc_constant_get_scalar_fp64 spvc_constant_set_scalar_fp64 f64);
// implement manually for bool
impl Sealed for bool {}
impl ConstantScalar for bool {
unsafe fn get(constant: spvc_constant, column: u32, row: u32) -> Self {
unsafe {
sys::spvc_constant_get_scalar_u8(constant, column, row) != 0
}
}
unsafe fn set(constant: spvc_constant, column: u32, row: u32, value: Self) {
sys::spvc_constant_set_scalar_u8(constant, column, row, if value { 1 } else { 0 });
}
}
/// A SPIR-V specialization constant
#[derive(Debug, Clone)]
pub struct SpecializationConstant {
/// The handle to the constant.
pub id: Handle<ConstantId>,
/// The declared `constant_id` of the constant.
pub constant_id: u32,
}
/// Specialization constants for a workgroup size.
#[derive(Debug, Clone)]
pub struct WorkgroupSizeSpecializationConstants {
/// Workgroup size in _x_.
pub x: Option<SpecializationConstant>,
/// Workgroup size in _y_.
pub y: Option<SpecializationConstant>,
/// Workgroup size in _z_.
pub z: Option<SpecializationConstant>,
/// The constant ID of the builtin `WorkGroupSize`
pub builtin_workgroup_size_handle: Option<Handle<ConstantId>>,
}
/// An iterator over specialization constants, created by [`Compiler::specialization_constants`].
pub struct SpecializationConstantIter<'a>(
PhantomCompiler,
slice::Iter<'a, spvc_specialization_constant>,
);
impl_iterator!(SpecializationConstantIter<'_>: SpecializationConstant as map |s, o: &spvc_specialization_constant| {
SpecializationConstant {
id: s.0.create_handle(o.id),
constant_id: o.constant_id,
}
} for [1]);
/// Iterator for specialization subconstants created by
/// [`Compiler::specialization_sub_constants`].
pub struct SpecializationSubConstantIter<'a>(PhantomCompiler, slice::Iter<'a, ConstantId>);
impl_iterator!(SpecializationSubConstantIter<'_>: Handle<ConstantId> as map |s, o: &ConstantId| {
s.0.create_handle(*o)
} for [1]);
/// Reflection of specialization constants.
impl<T> Compiler<T> {
// check bounds of the constant, otherwise you can write to arbitrary memory.
unsafe fn bounds_check_constant(
handle: spvc_constant,
column: u32,
row: u32,
) -> error::Result<()> {
// SPIRConstant is at most mat4, so anything above that is OOB.
if column >= 4 || row >= 4 {
return Err(SpirvCrossError::IndexOutOfBounds { row, column });
}
let vecsize = sys::spvc_rs_constant_get_vecsize(handle);
let colsize = sys::spvc_rs_constant_get_matrix_colsize(handle);
if column >= colsize || row >= vecsize {
return Err(SpirvCrossError::IndexOutOfBounds { row, column });
}
Ok(())
}
/// Set the value of the specialization value at the given column and row.
///
/// The type is inferred from the input, but it is not type checked against the SPIR-V.
///
/// Using this function wrong is not unsafe, but could cause the output shader to
/// be invalid.
///
/// [`Compiler::set_specialization_constant_value`] is more efficient and easier to use in
/// most cases, which will handle row and column for vector and matrix scalars. This function
/// remains to deal with more esoteric matrix shapes, or for getting only a single
/// element of a vector or matrix.
pub fn set_specialization_constant_scalar<S: ConstantScalar>(
&mut self,
handle: Handle<ConstantId>,
column: u32,
row: u32,
value: S,
) -> error::Result<()> {
let constant = self.yield_id(handle)?;
unsafe {
// SAFETY: yield_id ensures safety.
let handle = sys::spvc_compiler_get_constant_handle(self.ptr.as_ptr(), constant);
Self::bounds_check_constant(handle, column, row)?;
S::set(handle, column, row, value)
}
Ok(())
}
/// Get the value of the specialization value at the given column and row.
///
/// The type is inferred from the return value, and is not type-checked
/// against the input SPIR-V.
///
/// If the inferred type differs from what is expected, an indeterminate
/// but initialized value will be returned.
///
/// [`Compiler::specialization_constant_value`] is more efficient and easier to use in
/// most cases, which will handle row and column for vector and matrix scalars. This function
/// remains to deal with more esoteric matrix shapes, or for getting only a single
/// element of a vector or matrix.
pub fn specialization_constant_scalar<S: ConstantScalar>(
&self,
handle: Handle<ConstantId>,
column: u32,
row: u32,
) -> error::Result<S> {
let constant = self.yield_id(handle)?;
unsafe {
// SAFETY: yield_id ensures safety.
let handle = sys::spvc_compiler_get_constant_handle(self.ptr.as_ptr(), constant);
Self::bounds_check_constant(handle, column, row)?;
Ok(S::get(handle, column, row))
}
}
/// Query declared specialization constants.
pub fn specialization_constants(&self) -> error::Result<SpecializationConstantIter<'static>> {
unsafe {
let mut constants = std::ptr::null();
let mut size = 0;
sys::spvc_compiler_get_specialization_constants(
self.ptr.as_ptr(),
&mut constants,
&mut size,
)
.ok(self)?;
// SAFETY: 'static is sound here.
// https://github.com/KhronosGroup/SPIRV-Cross/blob/main/spirv_cross_c.cpp#L2522
let slice = slice::from_raw_parts(constants, size);
Ok(SpecializationConstantIter(self.phantom(), slice.iter()))
}
}
/// Get subconstants for composite type specialization constants.
pub fn specialization_sub_constants(
&self,
constant: Handle<ConstantId>,
) -> error::Result<SpecializationSubConstantIter> {
let id = self.yield_id(constant)?;
unsafe {
let constant = sys::spvc_compiler_get_constant_handle(self.ptr.as_ptr(), id);
let mut constants = std::ptr::null();
let mut size = 0;
sys::spvc_constant_get_subconstants(constant, &mut constants, &mut size);
Ok(SpecializationSubConstantIter(
self.phantom(),
slice::from_raw_parts(constants, size).iter(),
))
}
}
/// In SPIR-V, the compute work group size can be represented by a constant vector, in which case
/// the LocalSize execution mode is ignored.
///
/// This constant vector can be a constant vector, specialization constant vector, or partly specialized constant vector.
/// To modify and query work group dimensions which are specialization constants, constant values must be modified
/// directly via [`Compiler::set_specialization_constant_value`] rather than using LocalSize directly.
/// This function will return which constants should be modified.
///
/// To modify dimensions which are *not* specialization constants, set_execution_mode should be used directly.
/// Arguments to set_execution_mode which are specialization constants are effectively ignored during compilation.
/// NOTE: This is somewhat different from how SPIR-V works. In SPIR-V, the constant vector will completely replace LocalSize,
/// while in this interface, LocalSize is only ignored for specialization constants.
///
/// The specialization constant will be written to x, y and z arguments.
/// If the component is not a specialization constant, a zeroed out struct will be written.
/// The return value is the constant ID of the builtin WorkGroupSize, but this is not expected to be useful
/// for most use cases.
///
/// If `LocalSizeId` is used, there is no uvec3 value representing the workgroup size, so the return value is 0,
/// but _x_, _y_ and _z_ are written as normal if the components are specialization constants.
pub fn work_group_size_specialization_constants(&self) -> WorkgroupSizeSpecializationConstants {
unsafe {
let mut x = MaybeUninit::zeroed();
let mut y = MaybeUninit::zeroed();
let mut z = MaybeUninit::zeroed();
let constant = sys::spvc_compiler_get_work_group_size_specialization_constants(
self.ptr.as_ptr(),
x.as_mut_ptr(),
y.as_mut_ptr(),
z.as_mut_ptr(),
);
let constant = self.create_handle_if_not_zero(constant);
let x = x.assume_init();
let y = y.assume_init();
let z = z.assume_init();
let x = self
.create_handle_if_not_zero(x.id)
.map(|id| SpecializationConstant {
id,
constant_id: x.constant_id,
});
let y = self
.create_handle_if_not_zero(y.id)
.map(|id| SpecializationConstant {
id,
constant_id: y.constant_id,
});
let z = self
.create_handle_if_not_zero(z.id)
.map(|id| SpecializationConstant {
id,
constant_id: z.constant_id,
});
WorkgroupSizeSpecializationConstants {
x,
y,
z,
builtin_workgroup_size_handle: constant,
}
}
}
/// Get the type of the specialization constant.
pub fn specialization_constant_type(
&self,
constant: Handle<ConstantId>,
) -> error::Result<Handle<TypeId>> {
let constant = self.yield_id(constant)?;
let type_id = unsafe {
// SAFETY: yield_id ensures this is valid for the ID
let constant = sys::spvc_compiler_get_constant_handle(self.ptr.as_ptr(), constant);
self.create_handle(sys::spvc_constant_get_type(constant))
};
Ok(type_id)
}
}
/// A marker trait for types that can be represented as a SPIR-V constant.
pub trait ConstantValue: Sealed + Sized {
// None of anything here is a public API.
// As soon as generic_const_expr is stable, we can get rid of
// almost all of this silliness.
#[doc(hidden)]
const COLUMNS: usize;
#[doc(hidden)]
const VECSIZE: usize;
#[doc(hidden)]
type BaseArrayType: Default + Index<usize, Output = Self::BaseType> + IndexMut<usize>;
#[doc(hidden)]
type ArrayType: Default + Index<usize, Output = Self::BaseArrayType> + IndexMut<usize>;
#[doc(hidden)]
type BaseType: ConstantScalar;
#[doc(hidden)]
fn from_array(value: Self::ArrayType) -> Self;
#[doc(hidden)]
fn to_array(value: Self) -> Self::ArrayType;
}
impl<T: ConstantScalar> ConstantValue for T {
const COLUMNS: usize = 1;
const VECSIZE: usize = 1;
type BaseArrayType = [T; 1];
type ArrayType = [[T; 1]; 1];
type BaseType = T;
fn from_array(value: Self::ArrayType) -> Self {
value[0][0]
}
fn to_array(value: Self) -> Self::ArrayType {
[[value]]
}
}
impl<T> Compiler<T> {
/// Get the value of the specialization value.
///
/// The type is inferred from the return value, and is not type-checked
/// against the input SPIR-V.
///
/// If the output type dimensions are too large for the constant,
/// [`SpirvCrossError::IndexOutOfBounds`] will be returned.
///
/// If the inferred type differs from what is expected, an indeterminate
/// but initialized value will be returned.
pub fn specialization_constant_value<S: ConstantValue>(
&self,
handle: Handle<ConstantId>,
) -> error::Result<S> {
let constant = self.yield_id(handle)?;
unsafe {
// SAFETY: yield_id ensures safety.
let handle = sys::spvc_compiler_get_constant_handle(self.ptr.as_ptr(), constant);
// Self::bounds_check_constant(handle, column, row)?;
let mut output = S::ArrayType::default();
// bounds check the limits of the type.
Self::bounds_check_constant(handle, S::COLUMNS as u32 - 1, S::VECSIZE as u32 - 1)?;
for column in 0..S::COLUMNS {
for row in 0..S::VECSIZE {
let value = S::BaseType::get(handle, column as u32, row as u32);
output[column][row] = value;
}
}
Ok(S::from_array(output))
}
}
/// Set the value of the specialization value.
///
/// The type is inferred from the input, but it is not type checked against the SPIR-V.
///
/// Using this function wrong is not unsafe, but could cause the output shader to
/// be invalid.
///
/// If the input dimensions are too large for the constant type,
/// [`SpirvCrossError::IndexOutOfBounds`] will be returned.
pub fn set_specialization_constant_value<S: ConstantValue>(
&mut self,
handle: Handle<ConstantId>,
value: S,
) -> error::Result<()> {
let constant = self.yield_id(handle)?;
unsafe {
// SAFETY: yield_id ensures safety.
let handle = sys::spvc_compiler_get_constant_handle(self.ptr.as_ptr(), constant);
// bounds check the limits of the type.
Self::bounds_check_constant(handle, S::COLUMNS as u32 - 1, S::VECSIZE as u32 - 1)?;
let value = S::to_array(value);
for column in 0..S::COLUMNS {
for row in 0..S::VECSIZE {
S::BaseType::set(handle, column as u32, row as u32, value[column][row]);
}
}
}
Ok(())
}
}
pub(self) use impl_vec_constant;