gdkPixbufSave {RGtk2} | R Documentation

## gdkPixbufSave

### Description

Saves pixbuf to a file in format `type`. By default, "jpeg", "png", "ico" and "bmp" are possible file formats to save in, but more formats may be installed. The list of all writable formats can be determined in the following way:

### Usage

    gdkPixbufSave(object, filename, type, ..., .errwarn = TRUE)

### Arguments

``object`` | a `GdkPixbuf`.
``filename`` | name of file to save.
``type`` | name of file format.
``...`` | list of key-value save options
`.errwarn` | Whether to issue a warning on error or fail silently

### Details

    formats <- gdkPixbufGetFormats()
    writeable_formats <- formats[sapply(formats, gdkPixbufFormatIsWritable)]

If `error` is set, `FALSE` will be returned. Possible errors include those in the `GDK_PIXBUF_ERROR` domain and those in the `G_FILE_ERROR` domain.

The variable argument list should be `NULL`-terminated; if not empty, it should contain pairs of strings that modify the save parameters. For example:

    # (R does not require vararg lists)
    pixbuf$save(handle, "jpeg", "quality", "100")

Currently only few parameters exist. JPEG images can be saved with a "quality" parameter; its value should be in the range [0,100].

Text chunks can be attached to PNG images by specifying parameters of the form "tEXt::key", where key is an ASCII string of length 1-79. The values are UTF-8 encoded strings. The PNG compression level can be specified using the "compression" parameter; it's value is in an integer in the range of [0,9].

ICC color profiles can also be embedded into PNG and TIFF images. The "icc-profile" value should be the complete ICC profile encoded into base64.

    gchar *contents;
    gchar *contents_encode;
    gsize length;
    g_file_get_contents ("/home/hughsie/.color/icc/L225W.icm", &contents, &length, NULL);
    contents_encode = g_base64_encode ((const guchar *) contents, length);
    gdk_pixbuf_save (pixbuf, handle, "png", &error,
                     "icc-profile", contents_encode,
                     NULL);

TIFF images recognize a "compression" option which acceps an integer value. Among the codecs are 1 None, 2 Huffman, 5 LZW, 7 JPEG and 8 Deflate, see the libtiff documentation and tiff.h for all supported codec values.

ICO images can be saved in depth 16, 24, or 32, by using the "depth" parameter. When the ICO saver is given "x_hot" and "y_hot" parameters, it produces a CUR instead of an ICO.

### Value

A list containing the following elements:

`retval` | [logical] whether an error was set
``error`` | return location for error, or `NULL`. [ allow-none ]

### Author(s)

Derived by RGtkGen from GTK+ documentation

[Package RGtk2 version 2.20.36.3 Index]