GdkPixbuf-2.0 ▶ GdkPixbuf ▶ PixbufFormatSince 2.2

constructor

• new PixbufFormat(
      properties?: Partial<
          {
              description: string;
              disabled: boolean;
              domain: string;
              extensions: string[];
              flags: number;
              license: string;
              mime_types: string[];
              name: string;
          },
      >,
  ): PixbufFormat

  Parameters

  • Optionalproperties: Partial<
        {
            description: string;
            disabled: boolean;
            domain: string;
            extensions: string[];
            flags: number;
            license: string;
            mime_types: string[];
            name: string;
        },
    >

  Returns PixbufFormat

description

disabled

domain

extensions

flags

license

mime_types

name

signature

Static$gtype

Since 2.22copy

• copy(): PixbufFormat

  Creates a copy of format.

  Returns PixbufFormat

  the newly allocated copy of a GdkPixbuf.PixbufFormat. Use gdk_pixbuf_format_free() to free the resources when done

  Since

  2.22

Since 2.22free

• free(): void

  Frees the resources allocated when copying a GdkPixbuf.PixbufFormat using gdk_pixbuf_format_copy()

  Returns void

  Since

  2.22

Since 2.2get_description

• get_description(): string

  Returns a description of the format.

  Returns string

  a description of the format.

  Since

  2.2

Since 2.2get_extensions

• get_extensions(): string[]

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

  Returns string[]

  an array of filename extensions

  Since

  2.2

Since 2.6get_license

• 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

  a string describing the license of the pixbuf format

  Since

  2.6

Since 2.2get_mime_types

• get_mime_types(): string[]

  Returns the mime types supported by the format.

  Returns string[]

  an array of mime types

  Since

  2.2

Since 2.2get_name

• get_name(): string

  Returns the name of the format.

  Returns string

  the name of the format.

  Since

  2.2

Since 2.6is_disabled

• is_disabled(): boolean

  Returns whether this image format is disabled.

  See gdk_pixbuf_format_set_disabled().

  Returns boolean

  whether this image format is disabled.

  Since

  2.6

Since 2.36is_save_option_supported

• 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

  TRUE if the specified option is supported

  Since

  2.36

Since 2.6is_scalable

• 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

  whether this image format is scalable.

  Since

  2.6

Since 2.2is_writable

• is_writable(): boolean

  Returns whether pixbufs can be saved in the given format.

  Returns boolean

  whether pixbufs can be saved in the given format.

  Since

  2.2

Since 2.6set_disabled

• 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

  Since

  2.6