waterkit-screen 0.1.1

Screen capture with wgpu texture output
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

//! GPU-backed screen capture frame.

use std::sync::Arc;
use wgpu::{Texture, TextureFormat, TextureView, TextureViewDescriptor};

/// GPU-backed screen capture frame.
///
/// The frame data lives in GPU memory and can be used directly for rendering
/// through [`wgpu::Texture`] views.
#[derive(Debug)]
pub struct ScreenFrame {
    texture: Arc<Texture>,
    width: u32,
    height: u32,
    format: TextureFormat,
    timestamp_ns: u64,
}

impl ScreenFrame {
    /// Create a new frame from an existing wgpu texture.
    #[must_use]
    pub const fn from_texture(
        texture: Arc<Texture>,
        width: u32,
        height: u32,
        format: TextureFormat,
        timestamp_ns: u64,
    ) -> Self {
        Self {
            texture,
            width,
            height,
            format,
            timestamp_ns,
        }
    }

    /// Get a reference to the underlying wgpu texture.
    #[must_use]
    pub fn texture(&self) -> &Texture {
        &self.texture
    }

    /// Get the frame width in pixels.
    #[must_use]
    pub const fn width(&self) -> u32 {
        self.width
    }

    /// Get the frame height in pixels.
    #[must_use]
    pub const fn height(&self) -> u32 {
        self.height
    }

    /// Get the texture format.
    #[must_use]
    pub const fn format(&self) -> TextureFormat {
        self.format
    }

    /// Get the capture timestamp in nanoseconds.
    #[must_use]
    pub const fn timestamp_ns(&self) -> u64 {
        self.timestamp_ns
    }

    /// Create a texture view for rendering.
    #[must_use]
    pub fn create_view(&self) -> TextureView {
        self.texture.create_view(&TextureViewDescriptor::default())
    }
}