scenix-texture 1.3.0

CPU-side texture data, samplers, atlases, and mipmap helpers for scenix.
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

use scenix_core::ValidationError;

use crate::Texture2D;

/// Mutable CPU-side texture updated frame by frame.
#[derive(Clone, Debug, PartialEq)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub struct VideoTexture {
    /// Current texture frame.
    pub texture: Texture2D,
    /// Number of successfully uploaded frames.
    pub frame_index: u64,
    /// Whether the texture has changed since the last upload.
    pub dirty: bool,
}

impl VideoTexture {
    /// Creates a video texture from an initial frame.
    #[inline]
    pub fn new(texture: Texture2D) -> Self {
        Self {
            texture,
            frame_index: 0,
            dirty: true,
        }
    }

    /// Replaces the current frame and marks the texture dirty.
    pub fn update_frame(&mut self, data: &[u8]) -> Result<(), ValidationError> {
        if data.len() != self.texture.base_level_len()? {
            return Err(ValidationError::OutOfRange);
        }
        self.texture.data.clear();
        self.texture.data.extend_from_slice(data);
        self.frame_index = self.frame_index.saturating_add(1);
        self.dirty = true;
        Ok(())
    }

    /// Clears the dirty flag.
    #[inline]
    pub fn mark_clean(&mut self) {
        self.dirty = false;
    }
}