Assists in creating [classGsk.RenderNode]s for widgets.
It functions in a similar way to a cairo context, and maintains a stack of render nodes and their associated transformations.
The node at the top of the stack is the one that gtk_snapshot_append_⦠functions operate on. Use the gtk_snapshot_push_⦠functions and [methodSnapshot.pop] to change the current node.
The typical way to obtain a GtkSnapshot object is as an argument to the [vfuncGtk.Widget.snapshot] vfunc. If you need to create your own GtkSnapshot, use [ctorGtk.Snapshot.new].
Note that GtkSnapshot applies some optimizations, so the node it produces may not match the API calls 1:1. For example, it will omit clip nodes if the child node is entirely contained within the clip rectangle.
function Append_Cairo
(Self : not null access Gtk_Snapshot_Record;
Bounds : not null access Graphene.Rect.Graphene_Rect_T)
return Cairo.Cairo_Context
Creates a new [classGsk.CairoNode] and appends it to the current render node of Snapshot, without changing the current node.
the bounds for the new node
a cairo_t suitable for drawing the contents of the newly created render node
procedure Append_Color
(Self : not null access Gtk_Snapshot_Record;
Color : Gdk.RGBA.Gdk_RGBA;
Bounds : not null access Graphene.Rect.Graphene_Rect_T)
Creates a new render node drawing the Color into the given Bounds and appends it to the current render node of Snapshot. You should try to avoid calling this function if Color is transparent.
the color to draw
the bounds for the new node
procedure Append_Fill
(Self : not null access Gtk_Snapshot_Record;
Path : Gsk.Path.Gsk_Path;
Fill_Rule : Gsk.Enums.Gsk_Fill_Rule;
Color : Gdk.RGBA.Gdk_RGBA)
A convenience method to fill a path with a color. See [methodGtk.Snapshot.push_fill] if you need to fill a path with more complex content than a color. Since: gtk+ 4.14
The path describing the area to fill
The fill rule to use
the color to fill the path with
procedure Append_Layout
(Self : not null access Gtk_Snapshot_Record;
Layout : not null access Pango.Layout.Pango_Layout_Record'Class;
Color : Gdk.RGBA.Gdk_RGBA)
Creates render nodes for rendering Layout in the given foregound Color and appends them to the current node of Snapshot without changing the current node. The current theme's foreground color for a widget can be obtained with [methodGtk.Widget.get_color]. Note that if the layout does not produce any visible output, then nodes may not be added to the Snapshot.
the PangoLayout to render
the foreground color to render the layout in
procedure Append_Paste
(Self : not null access Gtk_Snapshot_Record;
Bounds : not null access Graphene.Rect.Graphene_Rect_T;
Nth : Gsize)
Creates a new render node that pastes the contents copied by a previous call to [methodGtk.Snapshot.push_copy] Since: gtk+ 4.22
the bounds for the new node
the index of the copy, with 0 being the latest copy, 1 being the copy before that, and so on.
procedure Append_Stroke
(Self : not null access Gtk_Snapshot_Record;
Path : Gsk.Path.Gsk_Path;
Stroke : Gsk.Stroke.Gsk_Stroke;
Color : Gdk.RGBA.Gdk_RGBA)
A convenience method to stroke a path with a color. See [methodGtk.Snapshot.push_stroke] if you need to stroke a path with more complex content than a color. Since: gtk+ 4.14
The path describing the area to fill
The stroke attributes
the color to fill the path with
procedure Append_Texture
(Self : not null access Gtk_Snapshot_Record;
Texture : not null access Gdk.Texture.Gdk_Texture_Record'Class;
Bounds : not null access Graphene.Rect.Graphene_Rect_T)
Creates a new render node drawing the Texture into the given Bounds and appends it to the current render node of Snapshot. If the texture needs to be scaled to fill Bounds, linear filtering is used. See [methodGtk.Snapshot.append_scaled_texture] if you need other filtering, such as nearest-neighbour.
the texture to render
the bounds for the new node
function Get_Type return Glib.GType
procedure Gl_Shader_Pop_Texture
(Self : not null access Gtk_Snapshot_Record)
Removes the top element from the stack of render nodes and adds it to the nearest [classGsk.GLShaderNode] below it. This must be called the same number of times as the number of textures is needed for the shader in [methodGtk.Snapshot.push_gl_shader]. Deprecated since 4.16, 1
procedure Gtk_New (Self : out Gtk_Snapshot)
Creates a new GtkSnapshot. Initialize does nothing if the object was already created with another call to Initialize* or G_New.
type Gtk_Snapshot is access all Gtk_Snapshot_Record'Class;
function Gtk_Snapshot_New return Gtk_Snapshot
Creates a new GtkSnapshot.
type Gtk_Snapshot_Record is new Gdk_Snapshot_Record with null record;
procedure Initialize (Self : not null access Gtk_Snapshot_Record'Class)
Creates a new GtkSnapshot. Initialize does nothing if the object was already created with another call to Initialize* or G_New.
procedure Perspective
(Self : not null access Gtk_Snapshot_Record;
Depth : Interfaces.C.C_float)
Applies a perspective projection transform. See [methodGsk.Transform.perspective] for a discussion on the details.
distance of the z=0 plane
procedure Pop (Self : not null access Gtk_Snapshot_Record)
Removes the top element from the stack of render nodes, and appends it to the node underneath it.
procedure Push_Blend
(Self : not null access Gtk_Snapshot_Record;
Blend_Mode : Gsk.Enums.Gsk_Blend_Mode)
Blends together two images with the given blend mode. Until the first call to [methodGtk.Snapshot.pop], the bottom image for the blend operation will be recorded. After that call, the top image to be blended will be recorded until the second call to [methodGtk.Snapshot.pop]. Calling this function requires two subsequent calls to [methodGtk.Snapshot.pop].
blend mode to use
procedure Push_Blur
(Self : not null access Gtk_Snapshot_Record;
Radius : Gdouble)
Blurs an image. The image is recorded until the next call to [methodGtk.Snapshot.pop].
the blur radius to use. Must be positive
procedure Push_Clip
(Self : not null access Gtk_Snapshot_Record;
Bounds : not null access Graphene.Rect.Graphene_Rect_T)
Clips an image to a rectangle. The image is recorded until the next call to [methodGtk.Snapshot.pop].
the rectangle to clip to
procedure Push_Color_Matrix
(Self : not null access Gtk_Snapshot_Record;
Color_Matrix : not null access Graphene.Matrix.Graphene_Matrix_T;
Color_Offset : not null access Graphene.Vec4.Graphene_Vec4_T)
Modifies the colors of an image by applying an affine transformation in RGB space. In particular, the colors will be transformed by applying pixel = transpose(color_matrix) * pixel + color_offset for every pixel. The transformation operates on unpremultiplied colors, with color components ordered R, G, B, A. The image is recorded until the next call to [methodGtk.Snapshot.pop].
the color matrix to use
the color offset to use
procedure Push_Composite
(Self : not null access Gtk_Snapshot_Record;
Op : Gsk.Enums.Gsk_Porter_Duff)
Until the first call to [methodGtk.Snapshot.pop], the mask image for the mask operation will be recorded. After that call, the child image will be recorded until the second call to [methodGtk.Snapshot.pop]. Calling this function requires 2 subsequent calls to Gtk.Snapshot.Pop. Since: gtk+ 4.22
The Porter/Duff compositing operator to use
procedure Push_Copy (Self : not null access Gtk_Snapshot_Record)
Stores the current rendering state for later pasting via [methodGtk.Snapshot.append_paste]. Pasting is possible until the matching call to [methodGtk.Snapshot.pop]. Since: gtk+ 4.22
procedure Push_Cross_Fade
(Self : not null access Gtk_Snapshot_Record;
Progress : Gdouble)
Snapshots a cross-fade operation between two images with the given Progress. Until the first call to [methodGtk.Snapshot.pop], the start image will be snapshot. After that call, the end image will be recorded until the second call to [methodGtk.Snapshot.pop]. Calling this function requires two subsequent calls to [methodGtk.Snapshot.pop].
progress between 0.0 and 1.0
procedure Push_Fill
(Self : not null access Gtk_Snapshot_Record;
Path : Gsk.Path.Gsk_Path;
Fill_Rule : Gsk.Enums.Gsk_Fill_Rule)
Fills the area given by Path and Fill_Rule with an image and discards everything outside of it. The image is recorded until the next call to [methodGtk.Snapshot.pop]. If you want to fill the path with a color, [methodGtk.Snapshot.append_fill] than rendering new ones, use [methodGtk.Snapshot.append_fill] may be more convenient. Since: gtk+ 4.14
The path describing the area to fill
The fill rule to use
procedure Push_Isolation
(Self : not null access Gtk_Snapshot_Record;
Features : Gsk.Enums.Gsk_Isolation)
Isolates the following drawing operations from previous ones. You can express "everything but these flags" in a forward compatible way by using bit math: GSK_ISOLATION_ALL & ~(GSK_ISOLATION_BACKGROUND | GSK_ISOLATION_COPY_PASTE) will isolate everything but background and copy/paste. For what isolation features exist, see [flagsGsk.Isolation]. Content is isolated until the next call to [methodGtk.Snapshot.pop]. Since: gtk+ 4.22
features that are isolated
procedure Push_Mask
(Self : not null access Gtk_Snapshot_Record;
Mask_Mode : Gsk.Enums.Gsk_Mask_Mode)
Until the first call to [methodGtk.Snapshot.pop], the mask image for the mask operation will be recorded. After that call, the source image will be recorded until the second call to [methodGtk.Snapshot.pop]. Calling this function requires 2 subsequent calls to Gtk.Snapshot.Pop. Since: gtk+ 4.10
mask mode to use
procedure Push_Opacity
(Self : not null access Gtk_Snapshot_Record;
Opacity : Gdouble)
Modifies the opacity of an image. The image is recorded until the next call to [methodGtk.Snapshot.pop].
the opacity to use
procedure Push_Repeat
(Self : not null access Gtk_Snapshot_Record;
Bounds : not null access Graphene.Rect.Graphene_Rect_T;
Child_Bounds : access Graphene.Rect.Graphene_Rect_T)
Creates a node that repeats the child node. The child is recorded until the next call to [methodGtk.Snapshot.pop].
the bounds within which to repeat
the bounds of the child or null to use the full size of the collected child node
procedure Push_Stroke
(Self : not null access Gtk_Snapshot_Record;
Path : Gsk.Path.Gsk_Path;
Stroke : Gsk.Stroke.Gsk_Stroke)
Strokes the given Path with the attributes given by Stroke and an image. The image is recorded until the next call to [methodGtk.Snapshot.pop]. Note that the strokes are subject to the same transformation as everything else, so uneven scaling will cause horizontal and vertical strokes to have different widths. If you want to stroke the path with a color, [methodGtk.Snapshot.append_stroke] may be more convenient. Since: gtk+ 4.14
The path to stroke
The stroke attributes
procedure Render_Background
(Self : not null access Gtk_Snapshot_Record;
Context : not null access Gtk.Style_Context.Gtk_Style_Context_Record'Class;
X : Gdouble;
Y : Gdouble;
Width : Gdouble;
Height : Gdouble)
Creates a render node for the CSS background according to Context, and appends it to the current node of Snapshot, without changing the current node. Deprecated since 4.10, 1
the style context that defines the background
X origin of the rectangle
Y origin of the rectangle
rectangle width
rectangle height
procedure Render_Focus
(Self : not null access Gtk_Snapshot_Record;
Context : not null access Gtk.Style_Context.Gtk_Style_Context_Record'Class;
X : Gdouble;
Y : Gdouble;
Width : Gdouble;
Height : Gdouble)
Creates a render node for the focus outline according to Context, and appends it to the current node of Snapshot, without changing the current node. Deprecated since 4.10, 1
the style context that defines the focus ring
X origin of the rectangle
Y origin of the rectangle
rectangle width
rectangle height
procedure Render_Frame
(Self : not null access Gtk_Snapshot_Record;
Context : not null access Gtk.Style_Context.Gtk_Style_Context_Record'Class;
X : Gdouble;
Y : Gdouble;
Width : Gdouble;
Height : Gdouble)
Creates a render node for the CSS border according to Context, and appends it to the current node of Snapshot, without changing the current node. Deprecated since 4.10, 1
the style context that defines the frame
X origin of the rectangle
Y origin of the rectangle
rectangle width
rectangle height
procedure Render_Insertion_Cursor
(Self : not null access Gtk_Snapshot_Record;
Context : not null access Gtk.Style_Context.Gtk_Style_Context_Record'Class;
X : Gdouble;
Y : Gdouble;
Layout : not null access Pango.Layout.Pango_Layout_Record'Class;
Index : Glib.Gint;
Direction : Pango.Enums.Direction)
Draws a text caret using Snapshot at the specified index of Layout. Deprecated since 4.10, 1
a GtkStyleContext
X origin
Y origin
the PangoLayout of the text
the index in the PangoLayout
the PangoDirection of the text
procedure Render_Layout
(Self : not null access Gtk_Snapshot_Record;
Context : not null access Gtk.Style_Context.Gtk_Style_Context_Record'Class;
X : Gdouble;
Y : Gdouble;
Layout : not null access Pango.Layout.Pango_Layout_Record'Class)
Creates a render node for rendering Layout according to the style information in Context, and appends it to the current node of Snapshot, without changing the current node. Deprecated since 4.10, 1
the style context that defines the text
X origin of the rectangle
Y origin of the rectangle
the PangoLayout to render
procedure Restore (Self : not null access Gtk_Snapshot_Record)
Restores Snapshot to the state saved by a preceding call to [methodSnapshot.save] and removes that state from the stack of saved states.
procedure Rotate
(Self : not null access Gtk_Snapshot_Record;
Angle : Interfaces.C.C_float)
Rotates @Snapshot's coordinate system by Angle degrees in 2D space - or in 3D speak, rotates around the Z axis. The rotation happens around the origin point of (0, 0) in the Snapshot's current coordinate system. To rotate around axes other than the Z axis, use [methodGsk.Transform.rotate_3d].
the rotation angle, in degrees (clockwise)
procedure Rotate_3D
(Self : not null access Gtk_Snapshot_Record;
Angle : Interfaces.C.C_float;
Axis : not null access Graphene.Vec3.Graphene_Vec3_T)
Rotates Snapshot's coordinate system by Angle degrees around Axis. For a rotation in 2D space, use [methodGsk.Transform.rotate].
the rotation angle, in degrees (clockwise)
The rotation axis
procedure Save (Self : not null access Gtk_Snapshot_Record)
Makes a copy of the current state of Snapshot and saves it on an internal stack. When [methodGtk.Snapshot.restore] is called, Snapshot will be restored to the saved state. Multiple calls to [methodGtk.Snapshot.save] and [methodGtk.Snapshot.restore] can be nested; each call to gtk_snapshot_restore restores the state from the matching paired gtk_snapshot_save. It is necessary to clear all saved states with corresponding calls to gtk_snapshot_restore.
procedure Scale
(Self : not null access Gtk_Snapshot_Record;
Factor_X : Interfaces.C.C_float;
Factor_Y : Interfaces.C.C_float)
Scales Snapshot's coordinate system in 2-dimensional space by the given factors. Use [methodGtk.Snapshot.scale_3d] to scale in all 3 dimensions.
scaling factor on the X axis
scaling factor on the Y axis
procedure Scale_3D
(Self : not null access Gtk_Snapshot_Record;
Factor_X : Interfaces.C.C_float;
Factor_Y : Interfaces.C.C_float;
Factor_Z : Interfaces.C.C_float)
Scales Snapshot's coordinate system by the given factors.
scaling factor on the X axis
scaling factor on the Y axis
scaling factor on the Z axis
function To_Paintable
(Self : not null access Gtk_Snapshot_Record;
Size : access Graphene.Size.Graphene_Size_T)
return Gdk.Paintable.Gdk_Paintable
Returns a paintable encapsulating the render node that was constructed by Snapshot. After calling this function, it is no longer possible to add more nodes to Snapshot. The only function that should be called after this is [methodGobject.Object.unref].
The size of the resulting paintable or null to use the bounds of the snapshot
a new GdkPaintable
procedure Transform
(Self : not null access Gtk_Snapshot_Record;
Transform : Gsk.Transform.Gsk_Transform)
Transforms Snapshot's coordinate system with the given Transform.
the transform to apply
procedure Transform_Matrix
(Self : not null access Gtk_Snapshot_Record;
Matrix : not null access Graphene.Matrix.Graphene_Matrix_T)
Transforms Snapshot's coordinate system with the given Matrix.
the matrix to multiply the transform with
procedure Translate
(Self : not null access Gtk_Snapshot_Record;
Point : not null access Graphene.Point.Graphene_Point_T)
Translates Snapshot's coordinate system by Point in 2-dimensional space.
the point to translate the snapshot by
procedure Translate_3D
(Self : not null access Gtk_Snapshot_Record;
Point : not null access Graphene.Point3d.Graphene_Point3D_T)
Translates Snapshot's coordinate system by Point.
the point to translate the snapshot by