Package org.gnome.gsk

Class MaskNode

java.lang.Object

org.javagi.base.ProxyInstance

org.gnome.gobject.TypeInstance

org.gnome.gsk.RenderNode

org.gnome.gsk.MaskNode

All Implemented Interfaces:

Proxy

@Generated("io.github.jwharm.JavaGI")
public class MaskNode
extends RenderNode

A render node masking one child node with another.

Since:

4.10

Nested Class Summary

Nested classes/interfaces inherited from class org.gnome.gsk.RenderNode

RenderNode.RenderNode$Impl

Constructor Summary

Constructors

Constructor	Description
MaskNode(MemorySegment address)	Create a MaskNode proxy instance for the provided memory address.
MaskNode(RenderNode source, RenderNode mask, MaskMode maskMode)	Creates a GskRenderNode that will mask a given node by another.

Method Summary

Modifier and Type	Method	Description
protected MaskNode	asParent()	Returns this instance as if it were its parent type.
RenderNode	getMask()	Retrieves the mask GskRenderNode child of the node.
MaskMode	getMaskMode()	Retrieves the mask mode used by node.
RenderNode	getSource()	Retrieves the source GskRenderNode child of the node.
static @Nullable Type	getType()	Get the GType of the MaskNode class

Methods inherited from class org.gnome.gsk.RenderNode

deserialize, draw, getBounds, getNodeType, getOpaqueRect, ref, serialize, unref, writeToFile

Methods inherited from class org.gnome.gobject.TypeInstance

callParent, callParent, cast, getMemoryLayout, getPrivate, readGClass, writeGClass

Methods inherited from class org.javagi.base.ProxyInstance

equals, handle, hashCode

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Details

MaskNode

public MaskNode(MemorySegment address)

Create a MaskNode proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

MaskNode

public MaskNode(RenderNode source,
 RenderNode mask,
 MaskMode maskMode)

Creates a GskRenderNode that will mask a given node by another.

The maskMode 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.

Parameters:

source - The source node to be drawn

mask - The node to be used as mask

maskMode - The mask mode to use

Since:

4.10

Method Details

getType

public static @Nullable Type getType()

Get the GType of the MaskNode class

Returns:

the GType

asParent

protected MaskNode asParent()

Returns this instance as if it were its parent type. This is mostly synonymous to the Java super keyword, but will set the native typeclass function pointers to the parent type. When overriding a native virtual method in Java, "chaining up" with super.methodName() doesn't work, because it invokes the overridden function pointer again. To chain up, call asParent().methodName(). This will call the native function pointer of this virtual method in the typeclass of the parent type.

Overrides:

asParent in class RenderNode

getMask

public RenderNode getMask()

Retrieves the mask GskRenderNode child of the node.

Returns:

the mask child node

Since:

4.10

getMaskMode

public MaskMode getMaskMode()

Retrieves the mask mode used by node.

Returns:

the mask mode

Since:

4.10

getSource

public RenderNode getSource()

Retrieves the source GskRenderNode child of the node.

Returns:

the source child node

Since:

4.10