|
| 1 | +//! This module provides a `rust-gpu` shader crate builder |
| 2 | +//! usable inside of build scripts or as a part of CLI. |
| 3 | +
|
| 4 | +use std::{io, path::Path}; |
| 5 | + |
| 6 | +use crate::{ |
| 7 | + lockfile::{LockfileMismatchError, LockfileMismatchHandler}, |
| 8 | + spirv_builder::SpirvBuilder, |
| 9 | + spirv_cache::{ |
| 10 | + command::CommandExecError, |
| 11 | + install::{Install, InstallError, InstallParams, InstalledBackend}, |
| 12 | + toolchain::HaltToolchainInstallation, |
| 13 | + }, |
| 14 | +}; |
| 15 | + |
| 16 | +/// Creates shader crate builder, allowing to modify install and build parameters separately. |
| 17 | +/// |
| 18 | +/// # Errors |
| 19 | +/// |
| 20 | +/// Returns an error if: |
| 21 | +/// |
| 22 | +/// * the shader crate path is not valid, |
| 23 | +/// * the backend installation fails, |
| 24 | +/// * there is a lockfile version mismatch that cannot be resolved automatically. |
| 25 | +#[inline] |
| 26 | +#[expect(clippy::unreachable, reason = "target was already set")] |
| 27 | +pub fn shader_crate_builder<P, S, E, T, C, W>( |
| 28 | + shader_crate: P, |
| 29 | + target: S, |
| 30 | + mut build: SpirvBuilder, |
| 31 | + install: InstallParams, |
| 32 | + writer: W, |
| 33 | + halt_toolchain_installation: HaltToolchainInstallation<T, C>, |
| 34 | +) -> Result<ShaderCrateBuilder, MakeShaderBuilderError<E>> |
| 35 | +where |
| 36 | + P: AsRef<Path>, |
| 37 | + S: Into<String>, |
| 38 | + W: io::Write, |
| 39 | + E: From<CommandExecError>, |
| 40 | + T: FnOnce(&str) -> Result<(), E>, |
| 41 | + C: FnOnce(&str) -> Result<(), E>, |
| 42 | +{ |
| 43 | + let shader_crate_path = dunce::canonicalize(shader_crate)?; |
| 44 | + let backend_args = Install::from_shader_crate_with_params(shader_crate_path, install); |
| 45 | + let backend = backend_args.run(writer, halt_toolchain_installation)?; |
| 46 | + |
| 47 | + let lockfile_mismatch_handler = LockfileMismatchHandler::new( |
| 48 | + &backend_args.shader_crate, |
| 49 | + &backend.toolchain_channel, |
| 50 | + backend_args.params.force_overwrite_lockfiles_v4_to_v3, |
| 51 | + )?; |
| 52 | + |
| 53 | + build.path_to_crate = Some(backend_args.shader_crate.clone()); |
| 54 | + build.target = Some(target.into()); |
| 55 | + backend |
| 56 | + .configure_spirv_builder(&mut build) |
| 57 | + .unwrap_or_else(|_| unreachable!("we set target before calling this function")); |
| 58 | + |
| 59 | + Ok(ShaderCrateBuilder { |
| 60 | + builder: build, |
| 61 | + installed_backend_args: backend_args, |
| 62 | + installed_backend: backend, |
| 63 | + lockfile_mismatch_handler, |
| 64 | + }) |
| 65 | +} |
| 66 | + |
| 67 | +/// A builder for compiling a `rust-gpu` shader crate. |
| 68 | +#[derive(Debug, Clone)] |
| 69 | +#[non_exhaustive] |
| 70 | +pub struct ShaderCrateBuilder { |
| 71 | + /// The underlying builder for compiling the shader crate. |
| 72 | + pub builder: SpirvBuilder, |
| 73 | + /// The arguments used to install the backend. |
| 74 | + pub installed_backend_args: Install, |
| 75 | + /// The installed backend. |
| 76 | + pub installed_backend: InstalledBackend, |
| 77 | + /// The lockfile mismatch handler. |
| 78 | + pub lockfile_mismatch_handler: LockfileMismatchHandler, |
| 79 | +} |
| 80 | + |
| 81 | +/// An error indicating what went wrong when creating a [`ShaderCrateBuilder`]. |
| 82 | +#[derive(Debug, thiserror::Error)] |
| 83 | +#[non_exhaustive] |
| 84 | +pub enum MakeShaderBuilderError<E> { |
| 85 | + /// The given shader crate path is not valid. |
| 86 | + #[error("shader crate path is not valid: {0}")] |
| 87 | + InvalidCratePath(#[from] io::Error), |
| 88 | + /// The backend installation failed. |
| 89 | + #[error("could not install backend: {0}")] |
| 90 | + Install(#[from] InstallError<E>), |
| 91 | + /// There is a lockfile version mismatch that cannot be resolved automatically. |
| 92 | + #[error(transparent)] |
| 93 | + LockfileMismatch(#[from] LockfileMismatchError), |
| 94 | +} |
0 commit comments