Gjsify LogoGjsify Logo

GtkSnapshot 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].

Hierarchy

Index

Constructors

Properties

gTypeInstance: TypeInstance
$gtype: GType<Gtk.Snapshot>
name: string

Methods

  • Appends a stroked border rectangle inside the given outline.

    The four sides of the border can have different widths and colors.

    Parameters

    • outline: RoundedRect

      the outline of the border

    • borderWidth: number[]

      the stroke width of the border on the top, right, bottom and left side respectively.

    • borderColor: Gdk.RGBA[]

      the color used on the top, right, bottom and left side.

    Returns void

  • Creates a new [classGsk.CairoNode] and appends it to the current render node of snapshot, without changing the current node.

    Parameters

    Returns cairo.Context

  • 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.

    Parameters

    Returns void

  • Appends a conic gradient node with the given stops to snapshot.

    Parameters

    • bounds: Graphene.Rect

      the rectangle to render the gradient into

    • center: Graphene.Point

      the center point of the conic gradient

    • rotation: number

      the clockwise rotation in degrees of the starting angle. 0 means the starting angle is the top.

    • stops: ColorStop[]

      the color stops defining the gradient

    Returns void

  • appendInsetShadow(outline: RoundedRect, color: Gdk.RGBA, dx: number, dy: number, spread: number, blurRadius: number): void
  • Appends an inset shadow into the box given by outline.

    Parameters

    • outline: RoundedRect

      outline of the region surrounded by shadow

    • color: Gdk.RGBA

      color of the shadow

    • dx: number

      horizontal offset of shadow

    • dy: number

      vertical offset of shadow

    • spread: number

      how far the shadow spreads towards the inside

    • blurRadius: number

      how much blur to apply to the shadow

    Returns void

  • Appends a linear gradient node with the given stops to snapshot.

    Parameters

    • bounds: Graphene.Rect

      the rectangle to render the linear gradient into

    • startPoint: Graphene.Point

      the point at which the linear gradient will begin

    • endPoint: Graphene.Point

      the point at which the linear gradient will finish

    • stops: ColorStop[]

      the color stops defining the gradient

    Returns void

  • 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.

    Parameters

    Returns void

  • appendOutsetShadow(outline: RoundedRect, color: Gdk.RGBA, dx: number, dy: number, spread: number, blurRadius: number): void
  • Appends an outset shadow node around the box given by outline.

    Parameters

    • outline: RoundedRect

      outline of the region surrounded by shadow

    • color: Gdk.RGBA

      color of the shadow

    • dx: number

      horizontal offset of shadow

    • dy: number

      vertical offset of shadow

    • spread: number

      how far the shadow spreads towards the outside

    • blurRadius: number

      how much blur to apply to the shadow

    Returns void

  • Appends a radial gradient node with the given stops to snapshot.

    Parameters

    • bounds: Graphene.Rect

      the rectangle to render the readial gradient into

    • center: Graphene.Point

      the center point for the radial gradient

    • hradius: number

      the horizontal radius

    • vradius: number

      the vertical radius

    • start: number

      the start position (on the horizontal axis)

    • end: number

      the end position (on the horizontal axis)

    • stops: ColorStop[]

      the color stops defining the gradient

    Returns void

  • Appends a repeating linear gradient node with the given stops to snapshot.

    Parameters

    • bounds: Graphene.Rect

      the rectangle to render the linear gradient into

    • startPoint: Graphene.Point

      the point at which the linear gradient will begin

    • endPoint: Graphene.Point

      the point at which the linear gradient will finish

    • stops: ColorStop[]

      the color stops defining the gradient

    Returns void

  • Appends a repeating radial gradient node with the given stops to snapshot.

    Parameters

    • bounds: Graphene.Rect

      the rectangle to render the readial gradient into

    • center: Graphene.Point

      the center point for the radial gradient

    • hradius: number

      the horizontal radius

    • vradius: number

      the vertical radius

    • start: number

      the start position (on the horizontal axis)

    • end: number

      the end position (on the horizontal axis)

    • stops: ColorStop[]

      the color stops defining the gradient

    Returns void

  • Creates a new render node drawing the texture into the given bounds and appends it to the current render node of snapshot.

    Parameters

    Returns void

  • Creates 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 instance to be updated with the same value of the "active" property of the action #GObject instance.

    If flags contains %G_BINDING_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 #GBinding 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 can have multiple bindings.

    Parameters

    • sourceProperty: string

      the property on source to bind

    • target: GObject.Object

      the target #GObject

    • targetProperty: string

      the property on target to bind

    • flags: BindingFlags

      flags to pass to #GBinding

    Returns Binding

  • 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.

    Parameters

    • sourceProperty: string

      the property on source to bind

    • target: GObject.Object

      the target #GObject

    • targetProperty: string

      the property on target to bind

    • flags: BindingFlags

      flags to pass to #GBinding

    • transformTo: TClosure<any, any>

      a #GClosure wrapping the transformation function from the source to the target, or %NULL to use the default

    • transformFrom: TClosure<any, any>

      a #GClosure wrapping the transformation function from the target to the source, or %NULL to use the default

    Returns Binding

  • connect(sigName: string, callback: ((...args: any[]) => void)): number
  • Parameters

    • sigName: string
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns number

  • emit(sigName: string, ...args: any[]): void
  • forceFloating(): void
  • This function is intended for #GObject 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().

    Returns void

  • freezeNotify(): void
  • 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::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.

    Returns void

  • getData(key?: string): object
  • Gets a named field from the objects table of associations (see g_object_set_data()).

    Parameters

    • Optional key: string

      name of the key for that association

    Returns object

  • getProperty(propertyName?: string, value?: any): void
  • Gets a property of an object.

    The value can be:

    • an empty #GValue initialized by %G_VALUE_INIT, which will be automatically initialized with the expected type of the property (since GLib 2.60)
    • a #GValue initialized with the expected type of the property
    • a #GValue initialized with a type to which the expected type of the property can be transformed

    In general, a copy is made of the property contents and the caller is responsible for freeing the memory by calling g_value_unset().

    Note that g_object_get_property() is really intended for language bindings, g_object_get() is much more convenient for C programming.

    Parameters

    • Optional propertyName: string

      the name of the property to get

    • Optional value: any

      return location for the property value

    Returns void

  • getQdata(quark: number): object
  • This function gets back user data pointers stored via g_object_set_qdata().

    Parameters

    • quark: number

      A #GQuark, naming the user data pointer

    Returns object

  • getv(names: string[], values: any[]): void
  • 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.

    Parameters

    • names: string[]

      the names of each property to get

    • values: any[]

      the values of each property to get

    Returns void

  • glShaderPopTexture(): void
  • 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].

    Returns void

  • isFloating(): boolean
  • notify(propertyName: string): void
  • 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.

    Parameters

    • propertyName: string

      the name of a property installed on the class of object.

    Returns void

  • 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.:

      enum
    {
    PROP_0,
    PROP_FOO,
    PROP_LAST
    };

    static GParamSpec *properties[PROP_LAST];

    static void
    my_object_class_init (MyObjectClass *klass)
    {
    properties[PROP_FOO] = g_param_spec_int ("foo", "Foo", "The foo",
    0, 100,
    50,
    G_PARAM_READWRITE);
    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]);
    

    Parameters

    • pspec: ParamSpec

      the #GParamSpec of a property installed on the class of object.

    Returns void

  • off(sigName: string, callback: ((...args: any[]) => void)): EventEmitter
  • Parameters

    • sigName: string
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns EventEmitter

  • on(sigName: string, callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • Parameters

    • sigName: string
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • once(sigName: string, callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • Parameters

    • sigName: string
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • perspective(depth: number): void
  • Applies a perspective projection transform.

    See [methodGsk.Transform.perspective] for a discussion on the details.

    Parameters

    • depth: number

      distance of the z=0 plane

    Returns void

  • pop(): void
  • Removes the top element from the stack of render nodes, and appends it to the node underneath it.

    Returns void

  • 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].

    Parameters

    Returns void

  • pushBlur(radius: number): void
  • Blurs an image.

    The image is recorded until the next call to [methodGtk.Snapshot.pop].

    Parameters

    • radius: number

      the blur radius to use. Must be positive

    Returns void

  • Clips an image to a rectangle.

    The image is recorded until the next call to [methodGtk.Snapshot.pop].

    Parameters

    Returns void

  • Modifies the colors of an image by applying an affine transformation in RGB space.

    The image is recorded until the next call to [methodGtk.Snapshot.pop].

    Parameters

    • colorMatrix: Graphene.Matrix

      the color matrix to use

    • colorOffset: Vec4

      the color offset to use

    Returns void

  • pushCrossFade(progress: number): void
  • 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].

    Parameters

    • progress: number

      progress between 0.0 and 1.0

    Returns void

  • Push a [classGsk.GLShaderNode].

    The node uses the given [classGsk.GLShader] and uniform values Additionally this takes a list of n_children other nodes which will be passed to the [classGsk.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 [methodGsk.GLShader.format_args] or [structGsk.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 [methodGsk.GLShader.compile] to ensure the shader will work for the renderer before using it.

    If the shader requires textures (see [methodGsk.GLShader.get_n_textures]), then it is expected that you call [methodGtk.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 GskGLShaderNode, 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 [methodGtk.Snapshot.pop].

    If you want to use pre-existing textures as input to the shader rather than rendering new ones, use [methodGtk.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 [classGsk.GLShader].

    Parameters

    • shader: Gsk.GLShader

      The code to run

    • bounds: Graphene.Rect

      the rectangle to render into

    • takeArgs: any

      Data block with arguments for the shader.

    Returns void

  • pushOpacity(opacity: number): void
  • Modifies the opacity of an image.

    The image is recorded until the next call to [methodGtk.Snapshot.pop].

    Parameters

    • opacity: number

      the opacity to use

    Returns void

  • Creates a node that repeats the child node.

    The child is recorded until the next call to [methodGtk.Snapshot.pop].

    Parameters

    • bounds: Graphene.Rect

      the bounds within which to repeat

    • childBounds: Graphene.Rect

      the bounds of the child or %NULL to use the full size of the collected child node

    Returns void

  • Clips an image to a rounded rectangle.

    The image is recorded until the next call to [methodGtk.Snapshot.pop].

    Parameters

    Returns void

  • pushShadow(shadow: Shadow[]): void
  • Applies a shadow to an image.

    The image is recorded until the next call to [methodGtk.Snapshot.pop].

    Parameters

    • shadow: Shadow[]

      the first shadow specification

    Returns void

  • 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.

    Returns GObject.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().

    Returns GObject.Object

  • renderBackground(context: Gtk.StyleContext, x: number, y: number, width: number, height: number): void
  • 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.

    Parameters

    • context: Gtk.StyleContext

      the style context that defines the background

    • x: number

      X origin of the rectangle

    • y: number

      Y origin of the rectangle

    • width: number

      rectangle width

    • height: number

      rectangle height

    Returns void

  • renderFocus(context: Gtk.StyleContext, x: number, y: number, width: number, height: number): void
  • 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.

    Parameters

    • context: Gtk.StyleContext

      the style context that defines the focus ring

    • x: number

      X origin of the rectangle

    • y: number

      Y origin of the rectangle

    • width: number

      rectangle width

    • height: number

      rectangle height

    Returns void

  • renderFrame(context: Gtk.StyleContext, x: number, y: number, width: number, height: number): void
  • 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.

    Parameters

    • context: Gtk.StyleContext

      the style context that defines the frame

    • x: number

      X origin of the rectangle

    • y: number

      Y origin of the rectangle

    • width: number

      rectangle width

    • height: number

      rectangle height

    Returns void

  • Draws a text caret using snapshot at the specified index of layout.

    Parameters

    • context: Gtk.StyleContext

      a GtkStyleContext

    • x: number

      X origin

    • y: number

      Y origin

    • layout: Pango.Layout

      the PangoLayout of the text

    • index: number

      the index in the PangoLayout

    • direction: Pango.Direction

      the PangoDirection of the text

    Returns void

  • 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.

    Parameters

    • context: Gtk.StyleContext

      the style context that defines the text

    • x: number

      X origin of the rectangle

    • y: number

      Y origin of the rectangle

    • layout: Pango.Layout

      the PangoLayout to render

    Returns void

  • restore(): void
  • Restores snapshot to the state saved by a preceding call to [methodSnapshot.save] and removes that state from the stack of saved states.

    Returns void

  • rotate(angle: number): void
  • Rotates @snapshot's coordinate system by angle degrees in 2D space - or in 3D speak, rotates around the Z axis.

    To rotate around other axes, use [methodGsk.Transform.rotate_3d].

    Parameters

    • angle: number

      the rotation angle, in degrees (clockwise)

    Returns void

  • Rotates snapshot's coordinate system by angle degrees around axis.

    For a rotation in 2D space, use [methodGsk.Transform.rotate].

    Parameters

    • angle: number

      the rotation angle, in degrees (clockwise)

    • axis: Graphene.Vec3

      The rotation axis

    Returns void

  • runDispose(): void
  • Releases all references to other objects. This can be used to break reference cycles.

    This function should only be called from object system implementations.

    Returns void

  • save(): void
  • 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 [methodSnapshot.save] and [classSnapshot.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().

    Returns void

  • scale(factorX: number, factorY: number): void
  • Scales snapshot's coordinate system in 2-dimensional space by the given factors.

    Use [methodGtk.Snapshot.scale_3d] to scale in all 3 dimensions.

    Parameters

    • factorX: number

      scaling factor on the X axis

    • factorY: number

      scaling factor on the Y axis

    Returns void

  • scale3d(factorX: number, factorY: number, factorZ: number): void
  • Scales snapshot's coordinate system by the given factors.

    Parameters

    • factorX: number

      scaling factor on the X axis

    • factorY: number

      scaling factor on the Y axis

    • factorZ: number

      scaling factor on the Z axis

    Returns void

  • setData(key: string, data?: object): void
  • 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 #GQuark 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 #GQuark storage growing unbounded.

    Parameters

    • key: string

      name of the key

    • Optional data: object

      data to associate with that key

    Returns void

  • setProperty(propertyName: string, value?: any): void
  • Sets a property on an object.

    Parameters

    • propertyName: string

      the name of the property to set

    • Optional value: any

      the value

    Returns void

  • stealData(key?: string): object
  • Remove a specified datum from the object's data associations, without invoking the association's destroy handler.

    Parameters

    • Optional key: string

      name of the key

    Returns object

  • stealQdata(quark: number): object
  • 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().

    Parameters

    • quark: number

      A #GQuark, naming the user data pointer

    Returns object

  • thawNotify(): void
  • 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::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.

    Returns void

  • Returns 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].

    Returns RenderNode

  • 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].

    Parameters

    • size: Graphene.Size

      The size of the resulting paintable or %NULL to use the bounds of the snapshot

    Returns Paintable

  • Transforms snapshot's coordinate system with the given transform.

    Parameters

    Returns void

  • Transforms snapshot's coordinate system with the given matrix.

    Parameters

    Returns void

  • Translates snapshot's coordinate system by point in 2-dimensional space.

    Parameters

    Returns void

  • Translates snapshot's coordinate system by point.

    Parameters

    • point: Point3D

      the point to translate the snapshot by

    Returns void

  • unref(): void
  • 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 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 instance. Use g_clear_object() for this.

    Returns void

  • watchClosure(closure: TClosure<any, any>): void
  • 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.

    Parameters

    • closure: TClosure<any, any>

      #GClosure to watch

    Returns void

  • compatControl(what: number, data: object): number
  • Find the #GParamSpec 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().

    Parameters

    • gIface: TypeInterface

      any interface vtable for the interface, or the default vtable for the interface

    • propertyName: string

      name of a property to look up.

    Returns ParamSpec

  • 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 #GParamSpec, 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 #GTypeInfo.) 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.

    Parameters

    • gIface: TypeInterface

      any interface vtable for the interface, or the default vtable for the interface.

    • pspec: ParamSpec

      the #GParamSpec for the new property

    Returns void

  • 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().

    Parameters

    • gIface: TypeInterface

      any interface vtable for the interface, or the default vtable for the interface

    Returns ParamSpec[]

  • Creates a new instance of a #GObject subtype and sets its properties.

    Construction parameters (see %G_PARAM_CONSTRUCT, %G_PARAM_CONSTRUCT_ONLY) which are not explicitly specified are set to their default values.

    Parameters

    • objectType: GType<unknown>

      the type id of the #GObject subtype to instantiate

    • parameters: GObject.Parameter[]

      an array of #GParameter

    Returns GObject.Object

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method