gsk4/auto/
cairo_node.rs

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
// This file was generated by gir (https://github.com/gtk-rs/gir)
// from gir-files (https://github.com/gtk-rs/gir-files)
// DO NOT EDIT

use crate::ffi;
use glib::{prelude::*, translate::*};

glib::wrapper! {
    /// A render node for a Cairo surface.
    #[doc(alias = "GskCairoNode")]
    pub struct CairoNode(Shared<ffi::GskCairoNode>);

    match fn {
        ref => |ptr| ffi::gsk_render_node_ref(ptr as *mut ffi::GskRenderNode),
        unref => |ptr| ffi::gsk_render_node_unref(ptr as *mut ffi::GskRenderNode),
    }
}

impl StaticType for CairoNode {
    fn static_type() -> glib::Type {
        unsafe { from_glib(ffi::gsk_cairo_node_get_type()) }
    }
}

impl CairoNode {
    /// Creates a [`RenderNode`][crate::RenderNode] that will render a cairo surface
    /// into the area given by @bounds.
    ///
    /// You can draw to the cairo surface using [`draw_context()`][Self::draw_context()].
    /// ## `bounds`
    /// the rectangle to render to
    ///
    /// # Returns
    ///
    /// A new [`RenderNode`][crate::RenderNode]
    #[doc(alias = "gsk_cairo_node_new")]
    pub fn new(bounds: &graphene::Rect) -> CairoNode {
        assert_initialized_main_thread!();
        unsafe { from_glib_full(ffi::gsk_cairo_node_new(bounds.to_glib_none().0)) }
    }

    /// Creates a Cairo context for drawing using the surface associated
    /// to the render node.
    ///
    /// If no surface exists yet, a surface will be created optimized for
    /// rendering to @renderer.
    ///
    /// # Returns
    ///
    /// a Cairo context used for drawing; use
    ///   cairo_destroy() when done drawing
    #[doc(alias = "gsk_cairo_node_get_draw_context")]
    #[doc(alias = "get_draw_context")]
    pub fn draw_context(&self) -> cairo::Context {
        unsafe { from_glib_full(ffi::gsk_cairo_node_get_draw_context(self.to_glib_none().0)) }
    }

    /// Retrieves the Cairo surface used by the render node.
    ///
    /// # Returns
    ///
    /// a Cairo surface
    #[doc(alias = "gsk_cairo_node_get_surface")]
    #[doc(alias = "get_surface")]
    pub fn surface(&self) -> cairo::Surface {
        unsafe { from_glib_none(ffi::gsk_cairo_node_get_surface(self.to_glib_none().0)) }
    }
}