Gjsify LogoGjsify Logo

A GdkTexture representing a GL texture object.

Hierarchy

Index

Constructors

  • Parameters

    Returns GLTexture

  • Creates a new texture for an existing GL texture.

    Note that the GL texture must not be modified until destroy is called, which will happen when the GdkTexture object is finalized, or due to an explicit call of [methodGdk.GLTexture.release].

    Parameters

    • context: Gdk.GLContext

      a GdkGLContext

    • id: number

      the ID of a texture that was created with context

    • width: number

      the nominal width of the texture

    • height: number

      the nominal height of the texture

    • destroy: GLib.DestroyNotify

      a destroy notify that will be called when the GL resources are released

    • data: object

      data that gets passed to destroy

    Returns GLTexture

Properties

g_type_instance: TypeInstance
height: number

The height of the texture, in pixels.

width: number

The width of the texture, in pixels.

$gtype: GType<GLTexture>
name: string

Methods

  • 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

    • source_property: string

      the property on source to bind

    • target: GObject.Object

      the target #GObject

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

    • source_property: string

      the property on source to bind

    • target: GObject.Object

      the target #GObject

    • target_property: string

      the property on target to bind

    • flags: BindingFlags

      flags to pass to #GBinding

    • transform_to: TClosure<any, any>

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

    • transform_from: TClosure<any, any>

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

    Returns Binding

  • compute_concrete_size(specified_width: number, specified_height: number, default_width: number, default_height: number): [number, number]
  • Compute a concrete size for the GdkPaintable.

    Applies the sizing algorithm outlined in the CSS Image spec to the given paintable. See that link for more details.

    It is not necessary to call this function when both specified_width and specified_height are known, but it is useful to call this function in GtkWidget:measure implementations to compute the other dimension when only one dimension is given.

    Parameters

    • specified_width: number

      the width paintable could be drawn into or 0.0 if unknown

    • specified_height: number

      the height paintable could be drawn into or 0.0 if unknown

    • default_width: number

      the width paintable would be drawn into if no other constraints were given

    • default_height: number

      the height paintable would be drawn into if no other constraints were given

    Returns [number, number]

  • connect(sigName: "notify::height", callback: (($obj: GLTexture, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::width", callback: (($obj: GLTexture, pspec: ParamSpec) => void)): number
  • connect(sigName: string, callback: ((...args: any[]) => void)): number
  • connect_after(sigName: "notify::height", callback: (($obj: GLTexture, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::width", callback: (($obj: GLTexture, pspec: ParamSpec) => void)): number
  • connect_after(sigName: string, callback: ((...args: any[]) => void)): number
  • disconnect(id: number): void
  • download(data: Uint8Array, stride: number): void
  • Downloads the texture into local memory.

    This may be an expensive operation, as the actual texture data may reside on a GPU or on a remote display server.

    The data format of the downloaded data is equivalent to %CAIRO_FORMAT_ARGB32, so every downloaded pixel requires 4 bytes of memory.

    Downloading a texture into a Cairo image surface:

    surface = cairo_image_surface_create (CAIRO_FORMAT_ARGB32,
    gdk_texture_get_width (texture),
    gdk_texture_get_height (texture));
    gdk_texture_download (texture,
    cairo_image_surface_get_data (surface),
    cairo_image_surface_get_stride (surface));
    cairo_surface_mark_dirty (surface);

    Parameters

    • data: Uint8Array

      pointer to enough memory to be filled with the downloaded data of texture

    • stride: number

      rowstride in bytes

    Returns void

  • emit(sigName: "notify::height", ...args: any[]): void
  • emit(sigName: "notify::width", ...args: any[]): void
  • emit(sigName: string, ...args: any[]): void
  • force_floating(): 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

  • freeze_notify(): 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

  • Gets an immutable paintable for the current contents displayed by paintable.

    This is useful when you want to retain the current state of an animation, for example to take a screenshot of a running animation.

    If the paintable is already immutable, it will return itself.

    Returns Paintable

  • get_data(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

  • get_height(): number
  • get_intrinsic_aspect_ratio(): number
  • Gets the preferred aspect ratio the paintable would like to be displayed at.

    The aspect ratio is the width divided by the height, so a value of 0.5 means that the paintable prefers to be displayed twice as high as it is wide. Consumers of this interface can use this to preserve aspect ratio when displaying the paintable.

    This is a purely informational value and does not in any way limit the values that may be passed to [methodGdk.Paintable.snapshot].

    Usually when a paintable returns nonzero values from [methodGdk.Paintable.get_intrinsic_width] and [methodGdk.Paintable.get_intrinsic_height] the aspect ratio should conform to those values, though that is not required.

    If the paintable does not have a preferred aspect ratio, it returns 0. Negative values are never returned.

    Returns number

  • get_intrinsic_height(): number
  • Gets the preferred height the paintable would like to be displayed at.

    Consumers of this interface can use this to reserve enough space to draw the paintable.

    This is a purely informational value and does not in any way limit the values that may be passed to [methodGdk.Paintable.snapshot].

    If the paintable does not have a preferred height, it returns 0. Negative values are never returned.

    Returns number

  • get_intrinsic_width(): number
  • Gets the preferred width the paintable would like to be displayed at.

    Consumers of this interface can use this to reserve enough space to draw the paintable.

    This is a purely informational value and does not in any way limit the values that may be passed to [methodGdk.Paintable.snapshot].

    If the paintable does not have a preferred width, it returns 0. Negative values are never returned.

    Returns number

  • get_property(property_name?: 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 property_name: string

      the name of the property to get

    • Optional value: any

      return location for the property value

    Returns void

  • get_qdata(quark: number): object
  • get_width(): number
  • 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

  • invalidate_contents(): void
  • Called by implementations of GdkPaintable to invalidate their contents.

    Unless the contents are invalidated, implementations must guarantee that multiple calls of [methodGdk.Paintable.snapshot] produce the same output.

    This function will emit the [signalGdk.Paintable::invalidate-contents] signal.

    If a paintable reports the %GDK_PAINTABLE_STATIC_CONTENTS flag, it must not call this function.

    Returns void

  • invalidate_size(): void
  • Called by implementations of GdkPaintable to invalidate their size.

    As long as the size is not invalidated, paintable must return the same values for its intrinsic width, height and aspect ratio.

    This function will emit the [signalGdk.Paintable::invalidate-size] signal.

    If a paintable reports the %GDK_PAINTABLE_STATIC_SIZE flag, it must not call this function.

    Returns void

  • is_floating(): boolean
  • Loads an icon asynchronously. To finish this function, see g_loadable_icon_load_finish(). For the synchronous, blocking version of this function, see g_loadable_icon_load().

    Parameters

    • size: number

      an integer.

    • cancellable: Gio.Cancellable

      optional #GCancellable object, %NULL to ignore.

    • callback: AsyncReadyCallback

      a #GAsyncReadyCallback to call when the request is satisfied

    Returns void

  • notify(property_name: 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

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

  • 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

  • release(): void
  • Releases the GL resources held by a GdkGLTexture.

    The texture contents are still available via the [methodGdk.Texture.download] function, after this function has been called.

    Returns void

  • run_dispose(): void
  • save_to_png(filename: string): boolean
  • Store the given texture to the filename as a PNG file.

    This is a utility function intended for debugging and testing. If you want more control over formats, proper error handling or want to store to a [ifaceGio.File] or other location, you might want to use [methodGdk.Texture.save_to_png_bytes] or look into the gdk-pixbuf library.

    Parameters

    • filename: string

      the filename to store to

    Returns boolean

  • save_to_png_bytes(): Bytes
  • Store the given texture in memory as a PNG file.

    Use [ctorGdk.Texture.new_from_bytes] to read it back.

    If you want to serialize a texture, this is a convenient and portable way to do that.

    If you need more control over the generated image, such as attaching metadata, you should look into an image handling library such as the gdk-pixbuf library.

    If you are dealing with high dynamic range float data, you might also want to consider [methodGdk.Texture.save_to_tiff_bytes] instead.

    Returns Bytes

  • save_to_tiff(filename: string): boolean
  • Store the given texture to the filename as a TIFF file.

    GTK will attempt to store data without loss.

    Parameters

    • filename: string

      the filename to store to

    Returns boolean

  • save_to_tiff_bytes(): Bytes
  • Store the given texture in memory as a TIFF file.

    Use [ctorGdk.Texture.new_from_bytes] to read it back.

    This function is intended to store a representation of the texture's data that is as accurate as possible. This is particularly relevant when working with high dynamic range images and floating-point texture data.

    If that is not your concern and you are interested in a smaller size and a more portable format, you might want to use [methodGdk.Texture.save_to_png_bytes].

    Returns Bytes

  • Serializes a #GIcon into a #GVariant. An equivalent #GIcon can be retrieved back by calling g_icon_deserialize() on the returned value. As serialization will avoid using raw icon data when possible, it only makes sense to transfer the #GVariant between processes on the same machine, (as opposed to over the network), and within the same file system namespace.

    Returns GLib.Variant

  • set_data(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

  • set_property(property_name: string, value?: any): void
  • snapshot(snapshot: Gdk.Snapshot, width: number, height: number): void
  • Snapshots the given paintable with the given width and height.

    The paintable is drawn at the current (0,0) offset of the snapshot. If width and height are not larger than zero, this function will do nothing.

    Parameters

    • snapshot: Gdk.Snapshot

      a GdkSnapshot to snapshot to

    • width: number

      width to snapshot in

    • height: number

      height to snapshot in

    Returns void

  • steal_data(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

  • steal_qdata(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

  • thaw_notify(): 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

  • to_string(): string
  • Generates a textual representation of icon that can be used for serialization such as when passing icon to a different process or saving it to persistent storage. Use g_icon_new_for_string() to get icon back from the returned string.

    The encoding of the returned string is proprietary to #GIcon except in the following two cases

    • If icon is a #GFileIcon, the returned string is a native path (such as /path/to/my icon.png) without escaping if the #GFile for icon is a native file. If the file is not native, the returned string is the result of g_file_get_uri() (such as sftp://path/to/my%20icon.png).

    • If icon is a #GThemedIcon with exactly one name and no fallbacks, the encoding is simply the name (such as network-server).

    Returns string

  • 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

  • vfunc_constructed(): void
  • vfunc_dispatch_properties_changed(n_pspecs: number, pspecs: ParamSpec): void
  • vfunc_dispose(): void
  • vfunc_equal(icon2: Gio.Icon): boolean
  • vfunc_finalize(): void
  • Gets an immutable paintable for the current contents displayed by paintable.

    This is useful when you want to retain the current state of an animation, for example to take a screenshot of a running animation.

    If the paintable is already immutable, it will return itself.

    virtual

    Returns Paintable

  • vfunc_get_intrinsic_aspect_ratio(): number
  • Gets the preferred aspect ratio the paintable would like to be displayed at.

    The aspect ratio is the width divided by the height, so a value of 0.5 means that the paintable prefers to be displayed twice as high as it is wide. Consumers of this interface can use this to preserve aspect ratio when displaying the paintable.

    This is a purely informational value and does not in any way limit the values that may be passed to [methodGdk.Paintable.snapshot].

    Usually when a paintable returns nonzero values from [methodGdk.Paintable.get_intrinsic_width] and [methodGdk.Paintable.get_intrinsic_height] the aspect ratio should conform to those values, though that is not required.

    If the paintable does not have a preferred aspect ratio, it returns 0. Negative values are never returned.

    virtual

    Returns number

  • vfunc_get_intrinsic_height(): number
  • Gets the preferred height the paintable would like to be displayed at.

    Consumers of this interface can use this to reserve enough space to draw the paintable.

    This is a purely informational value and does not in any way limit the values that may be passed to [methodGdk.Paintable.snapshot].

    If the paintable does not have a preferred height, it returns 0. Negative values are never returned.

    virtual

    Returns number

  • vfunc_get_intrinsic_width(): number
  • Gets the preferred width the paintable would like to be displayed at.

    Consumers of this interface can use this to reserve enough space to draw the paintable.

    This is a purely informational value and does not in any way limit the values that may be passed to [methodGdk.Paintable.snapshot].

    If the paintable does not have a preferred width, it returns 0. Negative values are never returned.

    virtual

    Returns number

  • vfunc_get_property(property_id: number, value?: any, pspec?: ParamSpec): void
  • vfunc_hash(): number
  • Loads an icon asynchronously. To finish this function, see g_loadable_icon_load_finish(). For the synchronous, blocking version of this function, see g_loadable_icon_load().

    virtual

    Parameters

    • size: number

      an integer.

    • cancellable: Gio.Cancellable

      optional #GCancellable object, %NULL to ignore.

    • callback: AsyncReadyCallback

      a #GAsyncReadyCallback to call when the request is satisfied

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

    virtual

    Parameters

    Returns void

  • Serializes a #GIcon into a #GVariant. An equivalent #GIcon can be retrieved back by calling g_icon_deserialize() on the returned value. As serialization will avoid using raw icon data when possible, it only makes sense to transfer the #GVariant between processes on the same machine, (as opposed to over the network), and within the same file system namespace.

    virtual

    Returns GLib.Variant

  • vfunc_set_property(property_id: number, value?: any, pspec?: ParamSpec): void
  • vfunc_snapshot(snapshot: Gdk.Snapshot, width: number, height: number): void
  • Snapshots the given paintable with the given width and height.

    The paintable is drawn at the current (0,0) offset of the snapshot. If width and height are not larger than zero, this function will do nothing.

    virtual

    Parameters

    • snapshot: Gdk.Snapshot

      a GdkSnapshot to snapshot to

    • width: number

      width to snapshot in

    • height: number

      height to snapshot in

    Returns void

  • watch_closure(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

  • compat_control(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

    • g_iface: TypeInterface

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

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

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

    • g_iface: TypeInterface

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

    Returns ParamSpec[]

  • Creates a new texture for an existing GL texture.

    Note that the GL texture must not be modified until destroy is called, which will happen when the GdkTexture object is finalized, or due to an explicit call of [methodGdk.GLTexture.release].

    Parameters

    • context: Gdk.GLContext

      a GdkGLContext

    • id: number

      the ID of a texture that was created with context

    • width: number

      the nominal width of the texture

    • height: number

      the nominal height of the texture

    • destroy: GLib.DestroyNotify

      a destroy notify that will be called when the GL resources are released

    • data: object

      data that gets passed to destroy

    Returns GLTexture

  • Creates a new texture object representing the GdkPixbuf.

    This function is threadsafe, so that you can e.g. use GTask and [methodGio.Task.run_in_thread] to avoid blocking the main thread while loading a big image.

    Parameters

    Returns Gdk.Texture

  • Creates a new texture by loading an image from memory,

    The file format is detected automatically. The supported formats are PNG and JPEG, though more formats might be available.

    If %NULL is returned, then error will be set.

    This function is threadsafe, so that you can e.g. use GTask and [methodGio.Task.run_in_thread] to avoid blocking the main thread while loading a big image.

    Parameters

    • bytes: Bytes

      a GBytes containing the data to load

    Returns Gdk.Texture

  • Creates a new texture by loading an image from a file.

    The file format is detected automatically. The supported formats are PNG and JPEG, though more formats might be available.

    If %NULL is returned, then error will be set.

    This function is threadsafe, so that you can e.g. use GTask and [methodGio.Task.run_in_thread] to avoid blocking the main thread while loading a big image.

    Parameters

    Returns Gdk.Texture

  • Creates a new texture by loading an image from a file.

    The file format is detected automatically. The supported formats are PNG and JPEG, though more formats might be available.

    If %NULL is returned, then error will be set.

    This function is threadsafe, so that you can e.g. use GTask and [methodGio.Task.run_in_thread] to avoid blocking the main thread while loading a big image.

    Parameters

    • path: string

      the filename to load

    Returns Gdk.Texture

  • new_from_resource(resource_path: string): Gdk.Texture
  • Creates a new texture by loading an image from a resource.

    The file format is detected automatically. The supported formats are PNG and JPEG, though more formats might be available.

    It is a fatal error if resource_path does not specify a valid image resource and the program will abort if that happens. If you are unsure about the validity of a resource, use [ctorGdk.Texture.new_from_file] to load it.

    This function is threadsafe, so that you can e.g. use GTask and [methodGio.Task.run_in_thread] to avoid blocking the main thread while loading a big image.

    Parameters

    • resource_path: string

      the path of the resource file

    Returns Gdk.Texture

  • 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

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