fret-core 0.1.0

Core contracts, IDs, geometry, events, and shared data types for the Fret 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
83
84
85
86
87
88
89
90
91
92
93
94

use crate::EffectId;
use serde::{Deserialize, Serialize};

#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, Serialize, Deserialize)]
#[serde(rename_all = "snake_case")]
pub enum CustomEffectProgramLanguage {
    WgslUtf8,
}

/// Descriptor used to register a bounded custom effect (v1).
///
/// This is intentionally small and backend-agnostic. Backends may reject registration based on
/// capability gating.
#[derive(Debug, Clone, PartialEq, Eq, Hash, Serialize, Deserialize)]
pub struct CustomEffectDescriptorV1 {
    pub language: CustomEffectProgramLanguage,
    pub source: String,
}

impl CustomEffectDescriptorV1 {
    pub fn wgsl_utf8(source: impl Into<String>) -> Self {
        Self {
            language: CustomEffectProgramLanguage::WgslUtf8,
            source: source.into(),
        }
    }
}

#[derive(Debug, Clone, PartialEq, Eq)]
pub enum CustomEffectRegistrationError {
    Unsupported,
    InvalidSource,
}

/// Descriptor used to register a bounded custom effect (v2).
///
/// v2 programs may reference additional renderer-provided bindings (e.g. a single user image input)
/// via a versioned WGSL prelude, but remain fully backend-agnostic at the contract surface.
#[derive(Debug, Clone, PartialEq, Eq, Hash, Serialize, Deserialize)]
pub struct CustomEffectDescriptorV2 {
    pub language: CustomEffectProgramLanguage,
    pub source: String,
}

impl CustomEffectDescriptorV2 {
    pub fn wgsl_utf8(source: impl Into<String>) -> Self {
        Self {
            language: CustomEffectProgramLanguage::WgslUtf8,
            source: source.into(),
        }
    }
}

/// Descriptor used to register a bounded custom effect (v3).
///
/// V3 programs may reference additional renderer-provided sources (e.g. `src_raw`, optional pyramid)
/// via a versioned WGSL prelude, but remain fully backend-agnostic at the contract surface.
#[derive(Debug, Clone, PartialEq, Eq, Hash, Serialize, Deserialize)]
pub struct CustomEffectDescriptorV3 {
    pub language: CustomEffectProgramLanguage,
    pub source: String,
}

impl CustomEffectDescriptorV3 {
    pub fn wgsl_utf8(source: impl Into<String>) -> Self {
        Self {
            language: CustomEffectProgramLanguage::WgslUtf8,
            source: source.into(),
        }
    }
}

/// Renderer-owned registry for bounded custom effects.
///
/// This mirrors the material registration pattern: callers obtain an `EffectId` handle without
/// receiving backend handles. Backends may deterministically degrade unsupported effects.
pub trait CustomEffectService {
    fn register_custom_effect_v1(
        &mut self,
        desc: CustomEffectDescriptorV1,
    ) -> Result<EffectId, CustomEffectRegistrationError>;

    fn register_custom_effect_v2(
        &mut self,
        desc: CustomEffectDescriptorV2,
    ) -> Result<EffectId, CustomEffectRegistrationError>;

    fn register_custom_effect_v3(
        &mut self,
        desc: CustomEffectDescriptorV3,
    ) -> Result<EffectId, CustomEffectRegistrationError>;

    fn unregister_custom_effect(&mut self, id: EffectId) -> bool;
}