gsk4/auto/repeating_linear_gradient_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
// 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, ColorStop};
use glib::{prelude::*, translate::*};
glib::wrapper! {
/// A render node for a repeating linear gradient.
#[doc(alias = "GskRepeatingLinearGradientNode")]
pub struct RepeatingLinearGradientNode(Shared<ffi::GskRepeatingLinearGradientNode>);
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 RepeatingLinearGradientNode {
fn static_type() -> glib::Type {
unsafe { from_glib(ffi::gsk_repeating_linear_gradient_node_get_type()) }
}
}
impl RepeatingLinearGradientNode {
/// Creates a [`RenderNode`][crate::RenderNode] that will create a repeating linear gradient
/// from the given points and color stops, and render that into the area
/// given by @bounds.
/// ## `bounds`
/// the rectangle to render the linear gradient into
/// ## `start`
/// the point at which the linear gradient will begin
/// ## `end`
/// the point at which the linear gradient will finish
/// ## `color_stops`
/// a pointer to an array of
/// [`ColorStop`][crate::ColorStop] defining the gradient. The offsets of all color stops
/// must be increasing. The first stop's offset must be >= 0 and the last
/// stop's offset must be <= 1.
///
/// # Returns
///
/// A new [`RenderNode`][crate::RenderNode]
#[doc(alias = "gsk_repeating_linear_gradient_node_new")]
pub fn new(
bounds: &graphene::Rect,
start: &graphene::Point,
end: &graphene::Point,
color_stops: &[ColorStop],
) -> RepeatingLinearGradientNode {
assert_initialized_main_thread!();
let n_color_stops = color_stops.len() as _;
unsafe {
from_glib_full(ffi::gsk_repeating_linear_gradient_node_new(
bounds.to_glib_none().0,
start.to_glib_none().0,
end.to_glib_none().0,
color_stops.to_glib_none().0,
n_color_stops,
))
}
}
}