Gjsify LogoGjsify Logo

Hierarchy

Index

Constructors

Properties

abyss_height: number
abyss_width: number
abyss_x: number
abyss_y: number
backend: Gegl.TileBackend
format: object
g_type_instance: TypeInstance
height: number
padding: object[]
parent_instance: any
path: string
pixels: number
px_size: number
shift_x: number
shift_y: number
tile_height: number
tile_width: number
width: number
x: number
y: number
$gtype: GType<Gegl.Buffer>
name: string

Methods

  • add_handler(handler: object): void
  • Add a new tile handler in the existing chain of tile handler of a GeglBuffer.

    Parameters

    • handler: object

      a #GeglTileHandler

    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

    • 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

  • connect(sigName: "changed", callback: Gegl.Buffer_ChangedSignalCallback): number
  • connect(sigName: "notify::abyss-height", callback: (($obj: Gegl.Buffer, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::abyss-width", callback: (($obj: Gegl.Buffer, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::abyss-x", callback: (($obj: Gegl.Buffer, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::abyss-y", callback: (($obj: Gegl.Buffer, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::backend", callback: (($obj: Gegl.Buffer, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::format", callback: (($obj: Gegl.Buffer, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::height", callback: (($obj: Gegl.Buffer, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::path", callback: (($obj: Gegl.Buffer, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::pixels", callback: (($obj: Gegl.Buffer, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::px-size", callback: (($obj: Gegl.Buffer, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::shift-x", callback: (($obj: Gegl.Buffer, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::shift-y", callback: (($obj: Gegl.Buffer, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::tile-height", callback: (($obj: Gegl.Buffer, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::tile-width", callback: (($obj: Gegl.Buffer, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::width", callback: (($obj: Gegl.Buffer, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::x", callback: (($obj: Gegl.Buffer, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::y", callback: (($obj: Gegl.Buffer, pspec: ParamSpec) => void)): number
  • connect(sigName: string, callback: ((...args: any[]) => void)): number
  • connect_after(sigName: "changed", callback: Gegl.Buffer_ChangedSignalCallback): number
  • connect_after(sigName: "notify::abyss-height", callback: (($obj: Gegl.Buffer, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::abyss-width", callback: (($obj: Gegl.Buffer, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::abyss-x", callback: (($obj: Gegl.Buffer, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::abyss-y", callback: (($obj: Gegl.Buffer, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::backend", callback: (($obj: Gegl.Buffer, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::format", callback: (($obj: Gegl.Buffer, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::height", callback: (($obj: Gegl.Buffer, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::path", callback: (($obj: Gegl.Buffer, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::pixels", callback: (($obj: Gegl.Buffer, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::px-size", callback: (($obj: Gegl.Buffer, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::shift-x", callback: (($obj: Gegl.Buffer, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::shift-y", callback: (($obj: Gegl.Buffer, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::tile-height", callback: (($obj: Gegl.Buffer, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::tile-width", callback: (($obj: Gegl.Buffer, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::width", callback: (($obj: Gegl.Buffer, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::x", callback: (($obj: Gegl.Buffer, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::y", callback: (($obj: Gegl.Buffer, pspec: ParamSpec) => void)): number
  • connect_after(sigName: string, callback: ((...args: any[]) => void)): number
  • Copy a region from source buffer to destination buffer.

    If the babl_formats of the buffers are the same, and the tile boundaries align, this will create copy-on-write tiles in the destination buffer.

    This function never does any scaling. When src_rect and dst_rect do not have the same width and height, the size of src_rect is used.

    Parameters

    • src_rect: Gegl.Rectangle

      source rectangle (or NULL to copy entire source buffer)

    • repeat_mode: Gegl.AbyssPolicy

      the abyss policy to be using if src_rect is outside src's extent.

    • dst: Gegl.Buffer

      destination buffer.

    • dst_rect: Gegl.Rectangle

      position of upper left destination pixel, or NULL for top left coordinates of the buffer extents.

    Returns void

  • disconnect(id: number): void
  • emit(sigName: "changed", object: Gegl.Rectangle, ...args: any[]): void
  • emit(sigName: "notify::abyss-height", ...args: any[]): void
  • emit(sigName: "notify::abyss-width", ...args: any[]): void
  • emit(sigName: "notify::abyss-x", ...args: any[]): void
  • emit(sigName: "notify::abyss-y", ...args: any[]): void
  • emit(sigName: "notify::backend", ...args: any[]): void
  • emit(sigName: "notify::format", ...args: any[]): void
  • emit(sigName: "notify::height", ...args: any[]): void
  • emit(sigName: "notify::path", ...args: any[]): void
  • emit(sigName: "notify::pixels", ...args: any[]): void
  • emit(sigName: "notify::px-size", ...args: any[]): void
  • emit(sigName: "notify::shift-x", ...args: any[]): void
  • emit(sigName: "notify::shift-y", ...args: any[]): void
  • emit(sigName: "notify::tile-height", ...args: any[]): void
  • emit(sigName: "notify::tile-width", ...args: any[]): void
  • emit(sigName: "notify::width", ...args: any[]): void
  • emit(sigName: "notify::x", ...args: any[]): void
  • emit(sigName: "notify::y", ...args: any[]): void
  • emit(sigName: string, ...args: any[]): void
  • flush(): void
  • Flushes all unsaved data to disk, this is not necessary for shared geglbuffers opened with gegl_buffer_open since they auto-sync on writes.

    Returns 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

  • Fetch a rectangular linear buffer of pixel data from the GeglBuffer.

    Parameters

    • rect: Gegl.Rectangle

      the coordinates we want to retrieve data from.

    • scale: number

      sampling scale, 1.0 = pixel for pixel 2.0 = magnify, 0.5 scale down.

    • format_name: string

      the format to store data in, if NULL the format of the buffer is used.

    • repeat_mode: Gegl.AbyssPolicy

      how requests outside the buffer extent are handled. Valid values: GEGL_ABYSS_NONE (abyss pixels are zeroed), GEGL_ABYSS_WHITE (abyss pixels are white), GEGL_ABYSS_BLACK (abyss pixels are black), GEGL_ABYSS_CLAMP (coordinates are clamped to the abyss rectangle), GEGL_ABYSS_LOOP (buffer contents are tiled if outside of the abyss rectangle).

    Returns Uint8Array

  • get_data(key?: string): object
  • Returns a pointer to a GeglRectangle structure defining the geometry of a specific GeglBuffer, this is also the default width/height of buffers passed in to gegl_buffer_set and gegl_buffer_get (with a scale of 1.0 at least).

    Returns Gegl.Rectangle

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

  • is_floating(): boolean
  • linear_close(linear: object): void
  • This function makes sure GeglBuffer and underlying code is aware of changes being made to the linear buffer. If the request was not a compatible one it is written back to the buffer. Multiple concurrent users can be handed the same buffer (both raw access and converted).

    Parameters

    • linear: object

      a previously returned buffer.

    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

  • remove_handler(handler: object): void
  • Remove the provided tile handler in the existing chain of tile handler of a GeglBuffer.

    Parameters

    • handler: object

      a #GeglTileHandler

    Returns void

  • run_dispose(): void
  • sample_cleanup(): void
  • Clean up resources used by sampling framework of buffer (will be freed automatically later when the buffer is destroyed, for long lived buffers cleaning up the sampling infrastructure when it has been used for its purpose will sometimes be more efficient).

    Returns void

  • Write a GeglBuffer to a file.

    Parameters

    • path: string

      the path where the gegl buffer will be saved, any writable GIO uri is valid.

    • roi: Gegl.Rectangle

      the region of interest to write, this is the tiles that will be collected and written to disk.

    Returns void

  • set(rect: Gegl.Rectangle, format_name: string, src: Uint8Array): void
  • Store a linear raster buffer into the GeglBuffer.

    Parameters

    • rect: Gegl.Rectangle

      the rectangle to write.

    • format_name: string

      the format of the input data.

    • src: Uint8Array

      pixel data to write to buffer.

    Returns void

  • Changes the size and position of the abyss rectangle of a buffer.

    Returns TRUE if the change of abyss was successful.

    Parameters

    Returns boolean

  • 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

  • Changes the size and position that is considered active in a buffer, this operation is valid on any buffer, reads on subbuffers outside the master buffer's extent are at the moment undefined.

    Returns TRUE if the change of extent was successful.

    Parameters

    Returns boolean

  • Fill a region with a repeating pattern. Offsets parameters are relative to the origin (0, 0) and not to the rectangle. So be carefull about the origin of pattern and buffer extents.

    Parameters

    • rect: Gegl.Rectangle

      the region of buffer to fill

    • pattern: Gegl.Buffer

      a #GeglBuffer to be repeated as a pattern

    • x_offset: number

      where the pattern starts horizontally

    • y_offset: number

      where the pattern starts vertical

    Returns void

  • set_property(property_name: string, value?: any): void
  • signal_connect(detailed_signal: string, c_handler: GObject.Callback): number
  • This function should be used instead of g_signal_connect when connecting to the GeglBuffer::changed signal handler, GeglBuffer contains additional machinery to avoid the overhead of changes when no signal handler have been connected, if regular g_signal_connect is used; then no signals will be emitted.

    Parameters

    • detailed_signal: string

      only "changed" expected for now

    • c_handler: GObject.Callback

      c function callback

    Returns number

  • steal_data(key?: string): 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

  • 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_finalize(): void
  • vfunc_get_property(property_id: number, value?: any, pspec?: ParamSpec): 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

  • vfunc_set_property(property_id: number, value?: any, pspec?: ParamSpec): 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[]

  • Loads an existing GeglBuffer from disk, if it has previously been saved with gegl_buffer_save it should be possible to open through any GIO transport, buffers that have been used as swap needs random access to be opened.

    Parameters

    • path: string

      the path to a gegl buffer on disk.

    Returns Gegl.Buffer

  • new(format_name: string, x: number, y: number, width: number, height: number): Gegl.Buffer
  • Create a new GeglBuffer with the given format and dimensions.

    Parameters

    • format_name: string

      The Babl format name for this buffer, e.g. "RGBA float"

    • x: number

      x origin of the buffer's extent

    • y: number

      y origin of the buffer's extent

    • width: number

      width of the buffer's extent

    • height: number

      height of the buffer's extent

    Returns Gegl.Buffer

  • Create a new GeglBuffer from a backend, if NULL is passed in the extent of the buffer will be inherited from the extent of the backend.

    returns a GeglBuffer, that holds a reference to the provided backend.

    Parameters

    • extent: Gegl.Rectangle

      the geometry of the buffer (origin, width and height) a GeglRectangle.

    • backend: Gegl.TileBackend

      an instance of a GeglTileBackend subclass.

    Returns Gegl.Buffer

  • 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

  • Open an existing on-disk GeglBuffer, this buffer is opened in a monitored state so multiple instances of gegl can share the same buffer. Sets on one buffer are reflected in the other.

    Parameters

    • path: string

      the path to a gegl buffer on disk.

    Returns Gegl.Buffer

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