package ocgtk

  1. Overview
  2. Docs
OCaml bindings for GTK 4

Install 

dune-project
 Dependency

github.com Edit opam file Versions (2)

Authors

  1. C
    Chris Armstrong

Maintainers

  1. H
    hello@chrisarmstrong.dev

Sources

v0.1-preview2.tar.gz
sha256=4e50fdb5093136a10fc8ffbe388e44cbcb70d52f8afdd48863ec7e22580ff054

doc/ocgtk.gsk/Ocgtk_gsk/Gsk/Wrappers/Render_node/index.html

Module Wrappers.Render_node

type t = [ `render_node ] Gobject.obj
val write_to_file : t -> string -> (bool, GError.t) result

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.

val unref : t -> unit

Releases a reference on the given `GskRenderNode`.

If the reference was the last, the resources associated to the @node are freed.

val serialize : t -> Glib_bytes.t

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.

val ref : t -> t

Acquires a reference on the given `GskRenderNode`.

val get_node_type : t -> Gsk_enums.rendernodetype

Returns the type of the @node.

Retrieves the boundaries of the @node.

The node will not draw outside of its boundaries.

Draw the contents of @node to the given cairo context.

Typically, you'll use this function to implement fallback rendering of `GskRenderNode`s 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.