#[repr(transparent)]pub struct MaskNode { /* private fields */ }
v4_10
only.Expand description
A render node masking one child node with another.
Implementations§
source§impl MaskNode
impl MaskNode
sourcepub fn new(
source: impl AsRef<RenderNode>,
mask: impl AsRef<RenderNode>,
mask_mode: MaskMode
) -> MaskNode
pub fn new( source: impl AsRef<RenderNode>, mask: impl AsRef<RenderNode>, mask_mode: MaskMode ) -> MaskNode
Creates a RenderNode
that will mask a given node by another.
The @mask_mode determines how the ‘mask values’ are derived from the colors of the @mask. Applying the mask consists of multiplying the ‘mask value’ with the alpha of the source.
source
The source node to be drawn
mask
The node to be used as mask
mask_mode
The mask mode to use
Returns
A new RenderNode
sourcepub fn mask(&self) -> RenderNode
pub fn mask(&self) -> RenderNode
sourcepub fn source(&self) -> RenderNode
pub fn source(&self) -> RenderNode
Methods from Deref<Target = RenderNode>§
pub const NONE: Option<&'static RenderNode> = None
sourcepub fn draw(&self, cr: &Context)
pub fn draw(&self, cr: &Context)
Draw the contents of @self to the given cairo context.
Typically, you’ll use this function to implement fallback rendering
of RenderNode
s on an intermediate Cairo context, instead of using
the drawing context associated to a gdk::Surface
’s rendering buffer.
For advanced nodes that cannot be supported using Cairo, in particular for nodes doing 3D operations, this function may fail.
cr
cairo context to draw to
sourcepub fn node_type(&self) -> RenderNodeType
pub fn node_type(&self) -> RenderNodeType
sourcepub fn serialize(&self) -> Bytes
pub fn serialize(&self) -> Bytes
Serializes the @self for later deserialization via gsk_render_node_deserialize(). No guarantees are made about the format used other than that the same version of GTK will be able to deserialize the result of a call to gsk_render_node_serialize() and gsk_render_node_deserialize() will correctly reject files it cannot open that were created with previous versions of GTK.
The intended use of this functions is testing, benchmarking and debugging. The format is not meant as a permanent storage format.
Returns
a GBytes
representing the node.
sourcepub fn write_to_file(&self, filename: impl AsRef<Path>) -> Result<(), Error>
pub fn write_to_file(&self, filename: impl AsRef<Path>) -> Result<(), Error>
This function is equivalent to calling serialize()
followed by file_set_contents()
.
See those two functions for details on the arguments.
It is mostly intended for use inside a debugger to quickly dump a render node to a file for later inspection.
filename
the file to save it to.
Returns
true
if saving was successful
pub fn is<T: IsRenderNode>(&self) -> bool
pub fn type_(&self) -> Type
pub fn downcast_ref<T: IsRenderNode>(&self) -> Option<&T>
Trait Implementations§
source§impl AsRef<RenderNode> for MaskNode
impl AsRef<RenderNode> for MaskNode
source§fn as_ref(&self) -> &RenderNode
fn as_ref(&self) -> &RenderNode
source§impl<'a> FromValue<'a> for MaskNode
Available on crate feature v4_6
only.
impl<'a> FromValue<'a> for MaskNode
v4_6
only.§type Checker = GenericValueTypeOrNoneChecker<MaskNode>
type Checker = GenericValueTypeOrNoneChecker<MaskNode>
source§unsafe fn from_value(value: &'a Value) -> Self
unsafe fn from_value(value: &'a Value) -> Self
Value
. Read moresource§impl IsRenderNode for MaskNode
impl IsRenderNode for MaskNode
const NODE_TYPE: RenderNodeType = RenderNodeType::MaskNode
fn upcast(self) -> RenderNode
fn upcast_ref(&self) -> &RenderNode
source§impl StaticType for MaskNode
impl StaticType for MaskNode
source§fn static_type() -> Type
fn static_type() -> Type
Self
.source§impl ToValueOptional for MaskNode
Available on crate feature v4_6
only.
impl ToValueOptional for MaskNode
v4_6
only.