molgfx-render 0.3.3

The render graph, passes and the engine that drives a frame.
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
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112

use super::{ChunkPlacementError, ChunkPlacementId};
use molgfx_core::ResidencyTicket;

macro_rules! validate_interpolation {
    ($value:expr) => {
        if !$value.is_finite() || !(0.0..=1.0).contains(&$value) {
            return Err(ChunkPlacementError::InvalidInterpolation);
        }
    };
}

/// Bounded two-frame window for one topology-stable structure chunk.
#[derive(Clone, Copy, Debug, PartialEq)]
pub struct TrajectoryChunkWindow {
    /// Exact resident structure generation receiving interpolated coordinates.
    pub structure: ResidencyTicket,
    /// Exact resident provider-frame generation at interpolation zero.
    pub start: ResidencyTicket,
    /// Exact resident provider-frame generation at interpolation one.
    pub end: ResidencyTicket,
    /// Closed-interval interpolation factor.
    pub interpolation: f32,
}

/// Bounded two-frame window for one declared rigid-instance occurrence.
#[derive(Clone, Copy, Debug, PartialEq)]
pub struct InstanceChunkWindow {
    /// Stable placement whose transform stream is animated.
    pub placement: ChunkPlacementId,
    /// Exact resident rigid-transform generation at interpolation zero.
    pub start: ResidencyTicket,
    /// Exact resident rigid-transform generation at interpolation one.
    pub end: ResidencyTicket,
    /// Closed-interval interpolation factor.
    pub interpolation: f32,
}

/// Bounded two-frame window for one scene-independent attribute column.
#[derive(Clone, Copy, Debug, PartialEq)]
pub struct AttributeChunkWindow {
    /// Stable attribute ticket referenced by visual descriptors.
    pub attribute: ResidencyTicket,
    /// Exact resident attribute generation at interpolation zero.
    pub start: ResidencyTicket,
    /// Exact resident attribute generation at interpolation one.
    pub end: ResidencyTicket,
    /// Closed-interval interpolation factor.
    pub interpolation: f32,
}

impl AttributeChunkWindow {
    /// Creates a topology- and type-stable paged attribute window.
    ///
    /// # Errors
    /// Rejects interpolation outside the closed unit interval.
    pub fn new(
        attribute: ResidencyTicket,
        start: ResidencyTicket,
        end: ResidencyTicket,
        interpolation: f32,
    ) -> Result<Self, ChunkPlacementError> {
        validate_interpolation!(interpolation);
        Ok(Self {
            attribute,
            start,
            end,
            interpolation,
        })
    }
}

impl InstanceChunkWindow {
    /// Creates a topology-stable paged rigid-transform window.
    ///
    /// # Errors
    /// Rejects interpolation outside the closed unit interval.
    pub fn new(
        placement: ChunkPlacementId,
        start: ResidencyTicket,
        end: ResidencyTicket,
        interpolation: f32,
    ) -> Result<Self, ChunkPlacementError> {
        validate_interpolation!(interpolation);
        Ok(Self {
            placement,
            start,
            end,
            interpolation,
        })
    }
}

impl TrajectoryChunkWindow {
    /// Creates a topology-stable two-frame window.
    ///
    /// # Errors
    /// Rejects interpolation outside the closed unit interval.
    pub fn new(
        structure: ResidencyTicket,
        start: ResidencyTicket,
        end: ResidencyTicket,
        interpolation: f32,
    ) -> Result<Self, ChunkPlacementError> {
        validate_interpolation!(interpolation);
        Ok(Self {
            structure,
            start,
            end,
            interpolation,
        })
    }
}