Struct librashader_runtime_mtl::FilterChainMetal

pub struct FilterChainMetal { /* private fields */ }

A Metal filter chain.

Implementations

impl FilterChainMetal

pub fn load_from_path( path: impl AsRef<Path>, queue: &ProtocolObject<dyn MTLCommandQueue>, options: Option<&FilterChainOptionsMetal> ) -> Result<FilterChainMetal>

Load the shader preset at the given path into a filter chain.

pub fn load_from_preset( preset: ShaderPreset, queue: &ProtocolObject<dyn MTLCommandQueue>, options: Option<&FilterChainOptionsMetal> ) -> Result<FilterChainMetal>

Load a filter chain from a pre-parsed ShaderPreset.

pub fn load_from_preset_deferred( preset: ShaderPreset, queue: &ProtocolObject<dyn MTLCommandQueue>, cmd: &ProtocolObject<dyn MTLCommandBuffer>, options: Option<&FilterChainOptionsMetal> ) -> Result<FilterChainMetal>

Load a filter chain from a pre-parsed ShaderPreset, deferring and GPU-side initialization to the caller. This function therefore requires no external synchronization of the device queue.

Safety

The provided command buffer must be ready for recording. The caller is responsible for ending the command buffer and immediately submitting it to a graphics queue. The command buffer must be completely executed before calling frame.

pub fn frame( &mut self, input: &ProtocolObject<dyn MTLTexture>, viewport: &Viewport<'_, MetalTextureRef<'_>>, cmd: &ProtocolObject<dyn MTLCommandBuffer>, frame_count: usize, options: Option<&FrameOptionsMetal> ) -> Result<()>

Records shader rendering commands to the provided command encoder.

SAFETY: The MTLCommandBuffer provided must not have an active encoder.

Trait Implementations

impl Debug for FilterChainMetal

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl FilterChainParameters for FilterChainMetal

fn get_enabled_pass_count(&self) -> usize

Gets the number of shader passes enabled at runtime.

fn set_enabled_pass_count(&mut self, count: usize)

Sets the number of shader passes enabled at runtime.

fn enumerate_parameters<'a>(&'a self) -> Iter<'_, String, f32>

Enumerates the active parameters as well as their values in the current filter chain.

fn get_parameter(&self, parameter: &str) -> Option<f32>

Get the value of the given parameter if present.

fn set_parameter(&mut self, parameter: &str, new_value: f32) -> Option<f32>

Set the value of the given parameter if present.