class: GskRenderNode

[19:7] extends: object

The basic block in a scene graph to be rendered using [class@Gsk.Renderer]. Each node has a parent, except the top-level node; each node may have children nodes. Each node has an associated drawing surface, which has the size of the rectangle set when creating it. Render nodes are meant to be transient; once they have been associated to a [class@Gsk.Renderer] it's safe to release any reference you have on them. All [class@Gsk.RenderNode]s are immutable, you can only specify their properties during construction.

Members

handleObj
lib
retainedCallbacks
signalHandlerNames
signalSetterHandlers

Methods

GskRenderNode (Handle = null)

Creates a new RenderNode by wrapping a native handle or another wrapper.
- @p Handle is the native handle or another wrapper whose handle to adopt.
toNativeHandle (Source)

Normalizes a constructor argument into a raw pointer carrier. Accepts a raw NativeHandle, a raw NativeBuffer returned from fn.call(...), another generated wrapper exposing handle(), or null. Returns null when the argument carries no pointer.
- @p Source is the raw handle, raw buffer, wrapper, or null.
- @r A raw pointer carrier or null when no pointer is present.
getLib ()

Returns the opened native library for this generated wrapper.
- @r The opened native library.
handle ()

Returns the wrapped NativeHandle.
- @r The wrapped NativeHandle.
isNull ()

Returns true when the wrapped handle is null.
- @r A bool.
describe ()

Returns a small string for debugging generated wrappers.
- @r A string.
draw (object cr)

Draws the contents of a render node on a cairo context. Typically, you'll use this function to implement fallback rendering of render nodes on an intermediate Cairo context, instead of using the drawing context associated to a [class@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.
- @p cr is cairo context to draw to.
- @r None.
get_bounds ()

Retrieves the boundaries of the @node. The node will not draw outside of its boundaries.
- @p bounds is return location for the boundaries.
- @r None.
get_children ()

Gets a list of all children nodes of the rendernode. Keep in mind that for various rendernodes, their children have different semantics, like the mask vs the source of a mask node. If you care about thse semantics, don't use this function, use the specific getters instead.
- @p n_children is the number of items in the returned array.
- @r The children.
get_node_type ()

Returns the type of the render node.
- @r the type of @node.
get_opaque_rect ()

Gets an opaque rectangle inside the node that GTK can determine to be fully opaque. There is no guarantee that this is indeed the largest opaque rectangle or that regions outside the rectangle are not opaque. This function is a best effort with that goal. The rectangle will be fully contained in the bounds of the node.
- @p out_opaque is return location for the opaque rect.
- @r true if part or all of the rendernode is opaque, false if no opaque region could be found..
ref ()

Acquires a reference on the given GskRenderNode.
- @r the render node with an additional reference.
serialize ()

Serializes the @node 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.
- @r a GBytes representing the node..
unref ()

Releases a reference on the given GskRenderNode. If the reference was the last, the resources associated to the @node are freed.
- @r None.
write_to_file (string filename)

This function is equivalent to calling [method@Gsk.RenderNode.serialize] followed by [func@GLib.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.
- @p filename is the file to save it to.
- @r true if saving was successful.