ffgl-core 0.2.6

FFGL plugin framework
Documentation 
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

//! This module provides a simplified way to implement a plugin
//! 1. Implement [SimpleFFGLInstance] for your plugin
//! 2. Call [crate::plugin_main] with a [SimpleFFGLHandler] and your instance type, such as:
//!     ```rust plugin_main!(SimpleFFGLHandler<MyInstanceType>);```

use super::FFGLHandler;

use crate::parameters::{ParamInfo, SimpleParamInfo};

use crate::{FFGLData, GLInput};

use super::FFGLInstance;

///This is a handler that just delegates to a SimpleFFGLInstance
pub struct SimpleFFGLHandler<T: SimpleFFGLInstance> {
    pub(crate) _marker: std::marker::PhantomData<T>,
}

///Implement this trait for a plugin without any static state
pub trait SimpleFFGLInstance: FFGLInstance {
    fn new(inst_data: &FFGLData) -> Self;

    fn num_params() -> usize {
        0
    }
    fn param_info(_index: usize) -> &'static dyn ParamInfo {
        panic!("No params")
    }

    fn plugin_info() -> crate::info::PluginInfo;

    fn get_param(&self, _index: usize) -> f32 {
        panic!("No params")
    }
    fn set_param(&mut self, _index: usize, _value: f32) {
        panic!("No params")
    }

    ///Called by [crate::conversions::Op::ProcessOpenGL] to draw the plugin
    fn draw(&mut self, inst_data: &FFGLData, frame_data: GLInput);
}

impl<T: SimpleFFGLInstance> FFGLInstance for T {
    fn get_param(&self, index: usize) -> f32 {
        SimpleFFGLInstance::get_param(self, index)
    }

    fn set_param(&mut self, index: usize, value: f32) {
        SimpleFFGLInstance::set_param(self, index, value)
    }

    fn draw(&mut self, inst_data: &FFGLData, frame_data: GLInput) {
        SimpleFFGLInstance::draw(self, inst_data, frame_data)
    }
}

impl<T: SimpleFFGLInstance> FFGLHandler for SimpleFFGLHandler<T> {
    type Instance = T;
    type NewInstanceError = std::convert::Infallible;

    fn init() -> Self {
        Self {
            _marker: std::marker::PhantomData,
        }
    }

    fn num_params(&self) -> usize {
        T::num_params()
    }

    fn param_info(&'static self, index: usize) -> &'static dyn ParamInfo {
        T::param_info(index)
    }

    fn plugin_info(&self) -> crate::info::PluginInfo {
        T::plugin_info()
    }

    fn new_instance(&self, inst_data: &FFGLData) -> Result<Self::Instance, Self::NewInstanceError> {
        Ok(T::new(inst_data))
    }
}