Optionalproperties: Partial<Gtk.Snapshot.ConstructorProps>Internal$signalsCompile-time signal type information.
This instance property is generated only for TypeScript type checking. It is not defined at runtime and should not be accessed in JS code.
Static$gtypeAppends a stroked border rectangle inside the given outline.
The four sides of the border can have different widths and colors.
the outline of the border
the stroke width of the border on the top, right, bottom and left side respectively.
the color used on the top, right, bottom and left side.
Creates a new Gsk.CairoNode and appends it to the current
render node of snapshot, without changing the current node.
a cairo_t suitable for drawing the contents of the newly created render node
A convenience method to fill a path with a color.
See Gtk.Snapshot.push_fill if you need to fill a path with more complex content than a color.
Appends an inset shadow into the box given by outline.
outline of the region surrounded by shadow
color of the shadow
horizontal offset of shadow
vertical offset of shadow
how far the shadow spreads towards the inside
how much blur to apply to the shadow
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 Gtk.Widget.get_color.
Note that if the layout does not produce any visible output, then nodes
may not be added to the snapshot.
the Pango.Layout to render
the foreground color to render the layout in
Appends node to the current render node of snapshot,
without changing the current node.
If snapshot does not have a current node yet, node
will become the initial node.
Appends an outset shadow node around the box given by outline.
outline of the region surrounded by shadow
color of the shadow
horizontal offset of shadow
vertical offset of shadow
how far the shadow spreads towards the outside
how much blur to apply to the shadow
Appends a radial gradient node with the given stops to snapshot.
the rectangle to render the readial gradient into
the center point for the radial gradient
the horizontal radius
the vertical radius
the start position (on the horizontal axis)
the end position (on the horizontal axis)
the color stops defining the gradient
Appends a repeating radial gradient node with the given stops to snapshot.
the rectangle to render the readial gradient into
the center point for the radial gradient
the horizontal radius
the vertical radius
the start position (on the horizontal axis)
the end position (on the horizontal axis)
the color stops defining the gradient
Creates a new render node drawing the texture
into the given bounds and appends it to the
current render node of snapshot.
In contrast to Gtk.Snapshot.append_texture, this function provides control about how the filter that is used when scaling.
A convenience method to stroke a path with a color.
See Gtk.Snapshot.push_stroke if you need to stroke a path with more complex content than a color.
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 Gtk.Snapshot.append_scaled_texture
if you need other filtering, such as nearest-neighbour.
SignalconnectSignalconnect_SignalemitRemoves the top element from the stack of render nodes and adds it to the nearest Gsk.GLShaderNode below it.
This must be called the same number of times as the number of textures is needed for the shader in Gtk.Snapshot.push_gl_shader.
Applies a perspective projection transform.
See Gsk.Transform.perspective for a discussion on the details.
distance of the z=0 plane
Removes the top element from the stack of render nodes, and appends it to the node underneath it.
Blends together two images with the given blend mode.
Until the first call to Gtk.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 Gtk.Snapshot.pop.
Calling this function requires two subsequent calls to Gtk.Snapshot.pop.
Blurs an image.
The image is recorded until the next call to Gtk.Snapshot.pop.
the blur radius to use. Must be positive
Clips an image to a rectangle.
The image is recorded until the next call to Gtk.Snapshot.pop.
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 Gtk.Snapshot.pop.
Modifies the colors of an image by applying a transfer function for each component.
The transfer functions operate on unpremultiplied colors.
The image is recorded until the next call to Gtk.Snapshot.pop.
the transfer for the red component
the transfer for the green component
the transfer for the blue component
the transfer for the alpha component
Snapshots a cross-fade operation between two images with the
given progress.
Until the first call to Gtk.Snapshot.pop, the start image will be snapshot. After that call, the end image will be recorded until the second call to Gtk.Snapshot.pop.
Calling this function requires two subsequent calls to Gtk.Snapshot.pop.
progress between 0.0 and 1.0
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 Gtk.Snapshot.pop.
If you want to fill the path with a color, Gtk.Snapshot.append_fill than rendering new ones, use Gtk.Snapshot.append_fill may be more convenient.
Push a Gsk.GLShaderNode.
The node uses the given Gsk.GLShader and uniform values
Additionally this takes a list of n_children other nodes
which will be passed to the Gsk.GLShaderNode.
The take_args argument is a block of data to use for uniform
arguments, as per types and offsets defined by the shader.
Normally this is generated by Gsk.GLShader.format_args
or Gsk.ShaderArgsBuilder.
The snapshotter takes ownership of take_args, so the caller should
not free it after this.
If the renderer doesn't support GL shaders, or if there is any
problem when compiling the shader, then the node will draw pink.
You should use Gsk.GLShader.compile to ensure the shader
will work for the renderer before using it.
If the shader requires textures (see Gsk.GLShader.get_n_textures), then it is expected that you call Gtk.Snapshot.gl_shader_pop_texture the number of times that are required. Each of these calls will generate a node that is added as a child to the Gsk.GLShaderNode, which in turn will render these offscreen and pass as a texture to the shader.
Once all textures (if any) are pop:ed, you must call the regular Gtk.Snapshot.pop.
If you want to use pre-existing textures as input to the shader rather than rendering new ones, use Gtk.Snapshot.append_texture to push a texture node. These will be used directly rather than being re-rendered.
For details on how to write shaders, see Gsk.GLShader.
Until the first call to Gtk.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 Gtk.Snapshot.pop.
Calling this function requires 2 subsequent calls to gtk_snapshot_pop().
Modifies the opacity of an image.
The image is recorded until the next call to Gtk.Snapshot.pop.
the opacity to use
Creates a node that repeats the child node.
The child is recorded until the next call to Gtk.Snapshot.pop.
Clips an image to a rounded rectangle.
The image is recorded until the next call to Gtk.Snapshot.pop.
the rounded rectangle to clip to
Applies a shadow to an image.
The image is recorded until the next call to Gtk.Snapshot.pop.
the first shadow specification
Strokes the given path with the attributes given by stroke and
an image.
The image is recorded until the next call to Gtk.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, Gtk.Snapshot.append_stroke may be more convenient.
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.
the style context that defines the background
X origin of the rectangle
Y origin of the rectangle
rectangle width
rectangle height
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.
the style context that defines the focus ring
X origin of the rectangle
Y origin of the rectangle
rectangle width
rectangle height
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.
the style context that defines the frame
X origin of the rectangle
Y origin of the rectangle
rectangle width
rectangle height
Draws a text caret using snapshot at the specified index of layout.
X origin
Y origin
the Pango.Layout of the text
the index in the Pango.Layout
the Pango.Direction of the text
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.
the style context that defines the text
X origin of the rectangle
Y origin of the rectangle
the Pango.Layout to render
Restores snapshot to the state saved by a preceding call to
Snapshot.save and removes that state from the stack of
saved states.
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 Gsk.Transform.rotate_3d.
the rotation angle, in degrees (clockwise)
Rotates snapshot's coordinate system by angle degrees around axis.
For a rotation in 2D space, use Gsk.Transform.rotate.
the rotation angle, in degrees (clockwise)
The rotation axis
Makes a copy of the current state of snapshot and saves it
on an internal stack.
When Gtk.Snapshot.restore is called, snapshot will
be restored to the saved state.
Multiple calls to Gtk.Snapshot.save and Gtk.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().
Scales snapshot's coordinate system in 2-dimensional space by
the given factors.
Use Gtk.Snapshot.scale_3d to scale in all 3 dimensions.
scaling factor on the X axis
scaling factor on the Y axis
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
Returns the render node that was constructed
by snapshot.
Note that this function may return null if nothing has been
added to the snapshot or if its content does not produce pixels
to be rendered.
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 GObject.Object.unref.
the constructed Gsk.RenderNode or null if there are no nodes to render.
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 GObject.Object.unref.
Optionalsize: SizeThe size of the resulting paintable or null to use the bounds of the snapshot
a new Gdk.Paintable
Transforms snapshot's coordinate system with the given transform.
Optionaltransform: Transformthe transform to apply
Translates snapshot's coordinate system by point.
the point to translate the snapshot by
StaticnewCreates a binding between source_property on source and target_property
on target.
Whenever the source_property is changed the target_property is
updated using the same value. For instance:
g_object_bind_property (action, "active", widget, "sensitive", 0);
Will result in the "sensitive" property of the widget GObject.Object instance to be updated with the same value of the "active" property of the action GObject.Object instance.
If flags contains GObject.BindingFlags.BIDIRECTIONAL then the binding will be mutual:
if target_property on target changes then the source_property on source
will be updated as well.
The binding will automatically be removed when either the source or the
target instances are finalized. To remove the binding without affecting the
source and the target you can just call g_object_unref() on the returned
GObject.Binding instance.
Removing the binding by calling g_object_unref() on it must only be done if
the binding, source and target are only used from a single thread and it
is clear that both source and target outlive the binding. Especially it
is not safe to rely on this if the binding, source or target can be
finalized from different threads. Keep another reference to the binding and
use g_binding_unbind() instead to be on the safe side.
A GObject.Object can have multiple bindings.
the property on source to bind
the target GObject.Object
the property on target to bind
flags to pass to GObject.Binding
the GObject.Binding instance representing the binding between the two GObject.Object instances. The binding is released whenever the GObject.Binding reference count reaches zero.
Complete version of g_object_bind_property().
Creates a binding between source_property on source and target_property
on target, allowing you to set the transformation functions to be used by
the binding.
If flags contains GObject.BindingFlags.BIDIRECTIONAL then the binding will be mutual:
if target_property on target changes then the source_property on source
will be updated as well. The transform_from function is only used in case
of bidirectional bindings, otherwise it will be ignored
The binding will automatically be removed when either the source or the
target instances are finalized. This will release the reference that is
being held on the GObject.Binding instance; if you want to hold on to the
GObject.Binding instance, you will need to hold a reference to it.
To remove the binding, call g_binding_unbind().
A GObject.Object can have multiple bindings.
The same user_data parameter will be used for both transform_to
and transform_from transformation functions; the notify function will
be called once, when the binding is removed. If you need different data
for each transformation function, please use
g_object_bind_property_with_closures() instead.
the property on source to bind
the target GObject.Object
the property on target to bind
flags to pass to GObject.Binding
Optionaltransform_to: BindingTransformFuncthe transformation function from the source to the target, or null to use the default
Optionaltransform_from: BindingTransformFuncthe transformation function from the target to the source, or null to use the default
Optionalnotify: DestroyNotifya function to call when disposing the binding, to free resources used by the transformation functions, or null if not required
the GObject.Binding instance representing the binding between the two GObject.Object instances. The binding is released whenever the GObject.Binding reference count reaches zero.
Creates a binding between source_property on source and target_property
on target, allowing you to set the transformation functions to be used by
the binding.
This function is the language bindings friendly version of
g_object_bind_property_full(), using GClosures instead of
function pointers.
the property on source to bind
the target GObject.Object
the property on target to bind
flags to pass to GObject.Binding
a GObject.Closure wrapping the transformation function from the source to the target, or null to use the default
a GObject.Closure wrapping the transformation function from the target to the source, or null to use the default
the GObject.Binding instance representing the binding between the two GObject.Object instances. The binding is released whenever the GObject.Binding reference count reaches zero.
Blocks a handler of an instance so it will not be called during any signal emissions
Handler ID of the handler to be blocked
Disconnects a handler from an instance so it will not be called during any future or currently ongoing emissions of the signal it has been connected to.
Handler ID of the handler to be disconnected
This function is intended for GObject.Object implementations to re-enforce
a [floating][floating-ref] object reference. Doing this is seldom
required: all GInitiallyUnowneds are created with a floating reference
which usually just needs to be sunken by calling g_object_ref_sink().
Increases the freeze count on object. If the freeze count is
non-zero, the emission of "notify" signals on object is
stopped. The signals are queued until the freeze count is decreased
to zero. Duplicate notifications are squashed so that at most one
GObject.Object::notify signal is emitted for each property modified while the
object is frozen.
This is necessary for accessors that modify multiple properties to prevent premature notification while the object is still being modified.
Gets a named field from the objects table of associations (see g_object_set_data()).
name of the key for that association
the data if found, or null if no such data exists.
Gets a property of an object.
The value can be:
In general, a copy is made of the property contents and the caller is responsible for freeing the memory by calling GObject.Value.unset.
Note that GObject.Object.get_property is really intended for language bindings, GObject.Object.get is much more convenient for C programming.
The name of the property to get
Return location for the property value. Can be an empty GObject.Value initialized by G_VALUE_INIT (auto-initialized with expected type since GLib 2.60), a GObject.Value initialized with the expected property type, or a GObject.Value initialized with a transformable type
This function gets back user data pointers stored via
g_object_set_qdata().
A GLib.Quark, naming the user data pointer
The user data pointer set, or null
Gets n_properties properties for an object.
Obtained properties will be set to values. All properties must be valid.
Warnings will be emitted and undefined behaviour may result if invalid
properties are passed in.
the names of each property to get
the values of each property to get
Checks whether object has a [floating][floating-ref] reference.
true if object has a floating reference
Emits a "notify" signal for the property property_name on object.
When possible, eg. when signaling a property change from within the class
that registered the property, you should use g_object_notify_by_pspec()
instead.
Note that emission of the notify signal may be blocked with
g_object_freeze_notify(). In this case, the signal emissions are queued
and will be emitted (in reverse order) when g_object_thaw_notify() is
called.
the name of a property installed on the class of object.
Emits a "notify" signal for the property specified by pspec on object.
This function omits the property name lookup, hence it is faster than
g_object_notify().
One way to avoid using g_object_notify() from within the
class that registered the properties, and using g_object_notify_by_pspec()
instead, is to store the GParamSpec used with
g_object_class_install_property() inside a static array, e.g.:
typedef enum
{
PROP_FOO = 1,
PROP_LAST
} MyObjectProperty;
static GParamSpec *properties[PROP_LAST];
static void
my_object_class_init (MyObjectClass *klass)
{
properties[PROP_FOO] = g_param_spec_int ("foo", NULL, NULL,
0, 100,
50,
G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS);
g_object_class_install_property (gobject_class,
PROP_FOO,
properties[PROP_FOO]);
}
and then notify a change on the "foo" property with:
g_object_notify_by_pspec (self, properties[PROP_FOO]);
the GObject.ParamSpec of a property installed on the class of object.
Increases the reference count of object.
Since GLib 2.56, if GLIB_VERSION_MAX_ALLOWED is 2.56 or greater, the type
of object will be propagated to the return type (using the GCC typeof()
extension), so any casting the caller needs to do on the return type must be
explicit.
the same object
Increase the reference count of object, and possibly remove the
[floating][floating-ref] reference, if object has a floating reference.
In other words, if the object is floating, then this call "assumes ownership" of the floating reference, converting it to a normal reference by clearing the floating flag while leaving the reference count unchanged. If the object is not floating, then this call adds a new normal reference increasing the reference count by one.
Since GLib 2.56, the type of object will be propagated to the return type
under the same conditions as for g_object_ref().
object
Releases all references to other objects. This can be used to break reference cycles.
This function should only be called from object system implementations.
Sets multiple properties of an object at once. The properties argument should be a dictionary mapping property names to values.
Object containing the properties to set
Each object carries around a table of associations from strings to pointers. This function lets you set an association.
If the object already had an association with that name, the old association will be destroyed.
Internally, the key is converted to a GLib.Quark using g_quark_from_string().
This means a copy of key is kept permanently (even after object has been
finalized) — so it is recommended to only use a small, bounded set of values
for key in your program, to avoid the GLib.Quark storage growing unbounded.
name of the key
Optionaldata: anydata to associate with that key
Sets a property on an object.
The name of the property to set
The value to set the property to
Remove a specified datum from the object's data associations, without invoking the association's destroy handler.
name of the key
the data if found, or null if no such data exists.
This function gets back user data pointers stored via
g_object_set_qdata() and removes the data from object
without invoking its destroy() function (if any was
set).
Usually, calling this function is only required to update
user data pointers with a destroy notifier, for example:
void
object_add_to_user_list (GObject *object,
const gchar *new_string)
{
// the quark, naming the object data
GQuark quark_string_list = g_quark_from_static_string ("my-string-list");
// retrieve the old string list
GList *list = g_object_steal_qdata (object, quark_string_list);
// prepend new string
list = g_list_prepend (list, g_strdup (new_string));
// this changed 'list', so we need to set it again
g_object_set_qdata_full (object, quark_string_list, list, free_string_list);
}
static void
free_string_list (gpointer data)
{
GList *node, *list = data;
for (node = list; node; node = node->next)
g_free (node->data);
g_list_free (list);
}
Using g_object_get_qdata() in the above example, instead of
g_object_steal_qdata() would have left the destroy function set,
and thus the partial string list would have been freed upon
g_object_set_qdata_full().
A GLib.Quark, naming the user data pointer
The user data pointer set, or null
Stops a signal's emission by the given signal name. This will prevent the default handler and any subsequent signal handlers from being invoked.
Name of the signal to stop emission of
Reverts the effect of a previous call to
g_object_freeze_notify(). The freeze count is decreased on object
and when it reaches zero, queued "notify" signals are emitted.
Duplicate notifications for each property are squashed so that at most one GObject.Object::notify signal is emitted for each property, in the reverse order in which they have been queued.
It is an error to call this function when the freeze count is zero.
Unblocks a handler so it will be called again during any signal emissions
Handler ID of the handler to be unblocked
Decreases the reference count of object. When its reference count
drops to 0, the object is finalized (i.e. its memory is freed).
If the pointer to the GObject.Object may be reused in future (for example, if it is
an instance variable of another object), it is recommended to clear the
pointer to null rather than retain a dangling pointer to a potentially
invalid GObject.Object instance. Use g_clear_object() for this.
Virtualvfunc_the constructed function is called by g_object_new() as the
final step of the object creation process. At the point of the call, all
construction properties have been set on the object. The purpose of this
call is to allow for object initialisation steps that can only be performed
after construction properties have been set. constructed implementors
should chain up to the constructed call of their parent class to allow it
to complete its initialisation.
Virtualvfunc_Virtualvfunc_the dispose function is supposed to drop all references to other
objects, but keep the instance otherwise intact, so that client method
invocations still work. It may be run multiple times (due to reference
loops). Before returning, dispose should chain up to the dispose method
of the parent class.
Virtualvfunc_instance finalization function, should finish the finalization of
the instance begun in dispose and chain up to the finalize method of the
parent class.
Virtualvfunc_Virtualvfunc_Emits a "notify" signal for the property property_name on object.
When possible, eg. when signaling a property change from within the class
that registered the property, you should use g_object_notify_by_pspec()
instead.
Note that emission of the notify signal may be blocked with
g_object_freeze_notify(). In this case, the signal emissions are queued
and will be emitted (in reverse order) when g_object_thaw_notify() is
called.
Virtualvfunc_the generic setter for all properties of this type. Should be
overridden for every type with properties. If implementations of
set_property don't emit property change notification explicitly, this will
be done implicitly by the type system. However, if the notify signal is
emitted explicitly, the type system will not emit it a second time.
This function essentially limits the life time of the closure to
the life time of the object. That is, when the object is finalized,
the closure is invalidated by calling g_closure_invalidate() on
it, in order to prevent invocations of the closure with a finalized
(nonexisting) object. Also, g_object_ref() and g_object_unref() are
added as marshal guards to the closure, to ensure that an extra
reference count is held on object during invocation of the
closure. Usually, this function will be called on closures that
use this object as closure data.
GObject.Closure to watch
Static_Staticcompat_Optionaldata: anyStaticfind_Staticinstall_Staticinstall_the id for the new property
the GObject.ParamSpec for the new property
Staticinterface_Find the GObject.ParamSpec with the given name for an
interface. Generally, the interface vtable passed in as g_iface
will be the default vtable from g_type_default_interface_ref(), or,
if you know the interface has already been loaded,
g_type_default_interface_peek().
any interface vtable for the interface, or the default vtable for the interface
name of a property to look up.
Staticinterface_Add a property to an interface; this is only useful for interfaces
that are added to GObject-derived types. Adding a property to an
interface forces all objects classes with that interface to have a
compatible property. The compatible property could be a newly
created GObject.ParamSpec, but normally
g_object_class_override_property() will be used so that the object
class only needs to provide an implementation and inherits the
property description, default value, bounds, and so forth from the
interface property.
This function is meant to be called from the interface's default
vtable initialization function (the class_init member of
GObject.TypeInfo.) It must not be called after after class_init has
been called for any object types implementing this interface.
If pspec is a floating reference, it will be consumed.
any interface vtable for the interface, or the default vtable for the interface.
the GObject.ParamSpec for the new property
Staticinterface_Lists the properties of an interface.Generally, the interface
vtable passed in as g_iface will be the default vtable from
g_type_default_interface_ref(), or, if you know the interface has
already been loaded, g_type_default_interface_peek().
any interface vtable for the interface, or the default vtable for the interface
Staticlist_StaticnewvStaticoverride_the new property ID
the name of a property registered in a parent class or in an interface of this class.
Assists in creating Gsk.RenderNodes 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 thegtk_snapshot_push_…()functions and Snapshot.pop to change the current node.The typical way to obtain a Gtk.Snapshot object is as an argument to the Gtk.Widget.snapshot vfunc. If you need to create your own Gtk.Snapshot, use Gtk.Snapshot.new.