Gjsify LogoGjsify Logo

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.

record

Hierarchy

  • PixbufFormat

Index

Constructors

Properties

description: string

a description of the image format

field
disabled: boolean

a boolean determining whether the loader is disabled`

field
domain: string

the message domain for the description

field
extensions: string[]

typical filename extensions for the image format

field
flags: number

a combination of GdkPixbufFormatFlags

field
license: string

a string containing license information, typically set to shorthands like "GPL", "LGPL", etc.

field
mime_types: string[]

the MIME types for the image format

field
name: string

the name of the image format

field

the signature of the module

field
name: string

Methods

  • free(): void
  • get_description(): string
  • get_extensions(): string[]
  • get_license(): string
  • 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.

    Returns string

  • get_mime_types(): string[]
  • get_name(): string
  • is_disabled(): boolean
  • is_save_option_supported(option_key: string): boolean
  • 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.

    Parameters

    • option_key: string

      the name of an option

    Returns boolean

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

    Returns boolean

  • is_writable(): boolean
  • set_disabled(disabled: boolean): void
  • 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().

    Parameters

    • disabled: boolean

      TRUE to disable the format format

    Returns void

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