librashader-runtime 0.10.1

RetroArch shaders for all.
Documentation
use arc_swap::ArcSwap;
use librashader_common::map::{FastHashMap, ShortString};
use librashader_pack::ShaderPresetPack;
use librashader_presets::ParameterMeta;
use std::sync::atomic::{AtomicUsize, Ordering};
use std::sync::Arc;

/// Trait for filter chains that allow runtime reflection of shader parameters.
pub trait FilterChainParameters {
    /// Get the runtime parameters for this filter chain.
    fn parameters(&self) -> &RuntimeParameters;
}

/// Runtime reflection of shader parameters for filter chains.
///
/// All operations on runtime parameters are atomic and can be done on
/// any thread.
pub struct RuntimeParameters {
    passes_enabled: AtomicUsize,
    pub(crate) parameters: ArcSwap<FastHashMap<ShortString, f32>>,
}

impl RuntimeParameters {
    /// Create a new instance of runtime parameters from a `Vec` of
    /// shader parameters from a [`ShaderPreset`](librashader_presets::ShaderPreset).
    pub fn new(pack: &ShaderPresetPack) -> Self {
        let pass_count = pack.pass_count as usize;
        let preset_params = &pack.parameters;
        let mut map = FastHashMap::default();
        map.reserve(preset_params.len());

        for pass in &pack.passes {
            for (name, param) in &pass.data.parameters {
                map.insert(name.clone(), param.initial);
            }
        }

        // slangp takes precedence
        for &ParameterMeta { ref name, value } in preset_params {
            if let Some(entry) = map.get_mut(name) {
                *entry = value;
            }
        }

        RuntimeParameters {
            passes_enabled: AtomicUsize::new(pass_count),
            parameters: ArcSwap::new(Arc::new(map)),
        }
    }

    /// Get the value of a runtime parameter
    pub fn parameter_value(&self, name: &str) -> Option<f32> {
        self.parameters.load().get::<str>(name.as_ref()).copied()
    }

    /// Set a runtime parameter.
    ///
    /// This is a relatively slow operation as it will be synchronized across threads.
    /// If updating multiple parameters, see [`RuntimeParameters::update_parameters`].
    pub fn set_parameter_value(&self, name: &str, new_value: f32) -> Option<f32> {
        let mut updated_map = FastHashMap::clone(&self.parameters.load());

        if let Some(value) = updated_map.get_mut::<str>(name.as_ref()) {
            let old = *value;
            *value = new_value;

            self.parameters.store(Arc::new(updated_map));

            Some(old)
        } else {
            updated_map.insert(ShortString::from(name), new_value);
            self.parameters.store(Arc::new(updated_map));

            None
        }
    }

    /// Update multiple runtime parameters atomically through a function.
    pub fn update_parameters(&self, updater: impl FnOnce(&mut FastHashMap<ShortString, f32>)) {
        let mut updated_map = FastHashMap::clone(&self.parameters.load());
        updater(&mut updated_map);
        self.parameters.store(Arc::new(updated_map));
    }

    /// Get a reference to the runtime parameters.
    pub fn parameters(&self) -> Arc<FastHashMap<ShortString, f32>> {
        self.parameters.load_full()
    }

    /// Get the number of passes enabled.
    ///
    /// If set from [`RuntimeParameters::set_passes_enabled`] from a different thread,
    /// it is not guaranteed to be immediately visible.
    #[inline(always)]
    pub fn passes_enabled(&self) -> usize {
        self.passes_enabled.load(Ordering::Relaxed)
    }

    /// Set the number of passes enabled.
    ///
    /// This is an atomic operation and is thread-safe.
    #[inline(always)]
    pub fn set_passes_enabled(&self, count: usize) {
        self.passes_enabled.store(count, Ordering::Relaxed);
    }
}

#[macro_export]
macro_rules! impl_filter_chain_parameters {
    ($ty:ty) => {
        impl ::librashader_runtime::parameters::FilterChainParameters for $ty {
            fn parameters(&self) -> &::librashader_runtime::parameters::RuntimeParameters {
                &self.common.config
            }
        }
    };
}