Basics

Guides

API Reference

Menu

Basics

Guides

API Reference

class: GdkPixbufFormat

[14:7] extends: object

A GdkPixbufFormat contains information about the image format accepted by a module. Only modules should access the fields directly, applications should use the gdk_pixbuf_format_* family of functions.

Members

  • handleObj
  • lib
  • retainedCallbacks
  • signalHandlerNames
  • signalSetterHandlers

Methods

  • GdkPixbufFormat (Handle = null)

    Creates a new PixbufFormat by wrapping a native handle or another wrapper.

    • @p Handle is the native handle or another wrapper whose handle to adopt.
  • toNativeHandle (Source)

    Normalizes a constructor argument into a raw pointer carrier. Accepts a raw NativeHandle, a raw NativeBuffer returned from fn.call(...), another generated wrapper exposing handle(), or null. Returns null when the argument carries no pointer.

    • @p Source is the raw handle, raw buffer, wrapper, or null.
    • @r A raw pointer carrier or null when no pointer is present.
  • getLib ()

    Returns the opened native library for this generated wrapper.

    • @r The opened native library.
  • handle ()

    Returns the wrapped NativeHandle.

    • @r The wrapped NativeHandle.
  • isNull ()

    Returns true when the wrapped handle is null.

    • @r A bool.
  • describe ()

    Returns a small string for debugging generated wrappers.

    • @r A string.
  • copy ()

    Creates a copy of format.

    • @r the newly allocated copy of a GdkPixbufFormat. Use gdk_pixbuf_format_free() to free the resources when done.
  • free ()

    Frees the resources allocated when copying a GdkPixbufFormat using gdk_pixbuf_format_copy()

    • @r None.
  • get_description ()

    Returns a description of the format.

    • @r a description of the format..
  • get_extensions ()

    Returns the filename extensions typically used for files in the given format.

    • @r an array of filename extensions.
  • get_license ()

    Returns information about the license of the image loader for the format. The returned string should be a shorthand for a well known license, e.g. "LGPL", "GPL", "QPL", "GPL/QPL", or "other" to indicate some other license.

    • @r a string describing the license of the pixbuf format.
  • get_mime_types ()

    Returns the mime types supported by the format.

    • @r an array of mime types.
  • get_name ()

    Returns the name of the format.

    • @r the name of the format..
  • is_disabled ()

    Returns whether this image format is disabled. See gdk_pixbuf_format_set_disabled().

    • @r whether this image format is disabled..
  • is_save_option_supported (string option_key)

    Returns TRUE if the save option specified by @option_key is supported when saving a pixbuf using the module implementing @format. See gdk_pixbuf_save() for more information about option keys.

    • @p option_key is the name of an option.
    • @r TRUE if the specified option is supported.
  • is_scalable ()

    Returns whether this image format is scalable. If a file is in a scalable format, it is preferable to load it at the desired size, rather than loading it at the default size and scaling the resulting pixbuf to the desired size.

    • @r whether this image format is scalable..
  • is_writable ()

    Returns whether pixbufs can be saved in the given format.

    • @r whether pixbufs can be saved in the given format..
  • set_disabled (bool disabled)

    Disables or enables an image format. If a format is disabled, GdkPixbuf won't use the image loader for this format to load images. Applications can use this to avoid using image loaders with an inappropriate license, see gdk_pixbuf_format_get_license().

    • @p disabled is TRUE to disable the format @format.
    • @r None.