Blame docs/reference/gdk-pixbuf/html/gdk-pixbuf-File-saving.html

Packit a4058c
Packit a4058c
<html>
Packit a4058c
<head>
Packit a4058c
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
Packit a4058c
<title>File saving: GDK-PixBuf Reference Manual</title>
Packit a4058c
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
Packit a4058c
<link rel="home" href="index.html" title="GDK-PixBuf Reference Manual">
Packit a4058c
<link rel="up" href="rn01.html" title="API Reference">
Packit a4058c
<link rel="prev" href="gdk-pixbuf-File-Loading.html" title="File Loading">
Packit a4058c
<link rel="next" href="gdk-pixbuf-Image-Data-in-Memory.html" title="Image Data in Memory">
Packit a4058c
<meta name="generator" content="GTK-Doc V1.25.1 (XML mode)">
Packit a4058c
<link rel="stylesheet" href="style.css" type="text/css">
Packit a4058c
</head>
Packit a4058c
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
Packit a4058c
Packit a4058c
Packit a4058c
Top  | 
Packit a4058c
                  Description
Packit a4058c
Packit a4058c
Home
Packit a4058c
Up
Packit a4058c
Prev
Packit a4058c
Next
Packit a4058c
Packit a4058c
Packit a4058c
Packit a4058c
Packit a4058c
Packit a4058c

File saving

Packit a4058c

File saving — Saving a pixbuf to a file.

Packit a4058c
Packit a4058c
Packit a4058c
Packit a4058c
Packit a4058c

Functions

Packit a4058c
Packit a4058c
Packit a4058c
Packit a4058c
Packit a4058c
Packit a4058c
Packit a4058c
Packit a4058c
Packit a4058c
gboolean
Packit a4058c
Packit a4058c
Packit a4058c
gdk_pixbuf_savev ()
Packit a4058c
Packit a4058c
Packit a4058c
Packit a4058c
Packit a4058c
gboolean
Packit a4058c
Packit a4058c
Packit a4058c
gdk_pixbuf_save ()
Packit a4058c
Packit a4058c
Packit a4058c
Packit a4058c
Packit a4058c
gboolean
Packit a4058c
Packit a4058c
Packit a4058c
(*GdkPixbufSaveFunc) ()
Packit a4058c
Packit a4058c
Packit a4058c
Packit a4058c
Packit a4058c
gboolean
Packit a4058c
Packit a4058c
Packit a4058c
gdk_pixbuf_save_to_callback ()
Packit a4058c
Packit a4058c
Packit a4058c
Packit a4058c
Packit a4058c
gboolean
Packit a4058c
Packit a4058c
Packit a4058c
gdk_pixbuf_save_to_callbackv ()
Packit a4058c
Packit a4058c
Packit a4058c
Packit a4058c
Packit a4058c
gboolean
Packit a4058c
Packit a4058c
Packit a4058c
gdk_pixbuf_save_to_buffer ()
Packit a4058c
Packit a4058c
Packit a4058c
Packit a4058c
Packit a4058c
gboolean
Packit a4058c
Packit a4058c
Packit a4058c
gdk_pixbuf_save_to_bufferv ()
Packit a4058c
Packit a4058c
Packit a4058c
Packit a4058c
Packit a4058c
gboolean
Packit a4058c
Packit a4058c
Packit a4058c
gdk_pixbuf_save_to_stream ()
Packit a4058c
Packit a4058c
Packit a4058c
Packit a4058c
Packit a4058c
gboolean
Packit a4058c
Packit a4058c
Packit a4058c
gdk_pixbuf_save_to_streamv ()
Packit a4058c
Packit a4058c
Packit a4058c
Packit a4058c
Packit a4058c
void
Packit a4058c
Packit a4058c
Packit a4058c
gdk_pixbuf_save_to_stream_async ()
Packit a4058c
Packit a4058c
Packit a4058c
Packit a4058c
Packit a4058c
void
Packit a4058c
Packit a4058c
Packit a4058c
gdk_pixbuf_save_to_streamv_async ()
Packit a4058c
Packit a4058c
Packit a4058c
Packit a4058c
Packit a4058c
gboolean
Packit a4058c
Packit a4058c
Packit a4058c
gdk_pixbuf_save_to_stream_finish ()
Packit a4058c
Packit a4058c
Packit a4058c
Packit a4058c
Packit a4058c
Packit a4058c
Packit a4058c

Includes

Packit a4058c
#include <gdk-pixbuf/gdk-pixbuf.h>
Packit a4058c
Packit a4058c
Packit a4058c
Packit a4058c

Description

Packit a4058c

These functions allow to save a GdkPixbuf in a number of

Packit a4058c
file formats. The formatted data can be written to a file
Packit a4058c
or to a memory buffer. GdkPixBuf can also call a user-defined
Packit a4058c
callback on the data, which allows to e.g. write the image 
Packit a4058c
to a socket or store it in a database.

Packit a4058c
Packit a4058c
Packit a4058c

Functions

Packit a4058c
Packit a4058c

gdk_pixbuf_savev ()

Packit a4058c
gboolean
Packit a4058c
gdk_pixbuf_savev (GdkPixbuf *pixbuf,
Packit a4058c
                  const char *filename,
Packit a4058c
                  const char *type,
Packit a4058c
                  char **option_keys,
Packit a4058c
                  char **option_values,
Packit a4058c
                  GError **error);
Packit a4058c

Saves pixbuf to a file in type

Packit a4058c
, which is currently "jpeg", "png", "tiff", "ico" or "bmp".
Packit a4058c
If error
Packit a4058c
 is set, FALSE will be returned. 
Packit a4058c
See gdk_pixbuf_save() for more details.

Packit a4058c
Packit a4058c

Parameters

Packit a4058c
Packit a4058c
Packit a4058c
Packit a4058c
Packit a4058c
Packit a4058c
Packit a4058c
Packit a4058c
Packit a4058c

pixbuf

Packit a4058c

a GdkPixbuf.

Packit a4058c
 
Packit a4058c
Packit a4058c
Packit a4058c

filename

Packit a4058c

name of file to save.

Packit a4058c
 
Packit a4058c
Packit a4058c
Packit a4058c

type

Packit a4058c

name of file format.

Packit a4058c
 
Packit a4058c
Packit a4058c
Packit a4058c

option_keys

Packit a4058c

name of options to set, NULL-terminated.

Packit a4058c
[array zero-terminated=1]
Packit a4058c
Packit a4058c
Packit a4058c

option_values

Packit a4058c

values for named options.

Packit a4058c
[array zero-terminated=1]
Packit a4058c
Packit a4058c
Packit a4058c

error

Packit a4058c

return location for error, or NULL.

Packit a4058c
[allow-none]
Packit a4058c
Packit a4058c
Packit a4058c
Packit a4058c
Packit a4058c
Packit a4058c

Returns

Packit a4058c

whether an error was set

Packit a4058c
Packit a4058c
Packit a4058c

Packit a4058c
Packit a4058c

gdk_pixbuf_save ()

Packit a4058c
gboolean
Packit a4058c
gdk_pixbuf_save (GdkPixbuf *pixbuf,
Packit a4058c
                 const char *filename,
Packit a4058c
                 const char *type,
Packit a4058c
                 GError **error,
Packit a4058c
                 ...);
Packit a4058c

Saves pixbuf to a file in format type

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

Packit a4058c
Packit a4058c
  
Packit a4058c
    
Packit a4058c
      
Packit a4058c
        
1
Packit a4058c
2
Packit a4058c
3
Packit a4058c
4
Packit a4058c
5
Packit a4058c
6
Packit a4058c
7
Packit a4058c
8
Packit a4058c
9
Packit a4058c
10
Packit a4058c
        
void add_if_writable (GdkPixbufFormat *data, GSList **list)
Packit a4058c
{
Packit a4058c
  if (gdk_pixbuf_format_is_writable (data))
Packit a4058c
    *list = g_slist_prepend (*list, data);
Packit a4058c
}
Packit a4058c
Packit a4058c
GSList *formats = gdk_pixbuf_get_formats ();
Packit a4058c
GSList *writable_formats = NULL;
Packit a4058c
g_slist_foreach (formats, add_if_writable, &writable_formats);
Packit a4058c
g_slist_free (formats);
Packit a4058c
      
Packit a4058c
    
Packit a4058c
  
Packit a4058c
Packit a4058c
Packit a4058c

Packit a4058c

If error

Packit a4058c
 is set, FALSE will be returned. Possible errors include 
Packit a4058c
those in the GDK_PIXBUF_ERROR domain and those in the G_FILE_ERROR domain.

Packit a4058c

The variable argument list should be NULL-terminated; if not empty,

Packit a4058c
it should contain pairs of strings that modify the save
Packit a4058c
parameters. For example:

Packit a4058c
Packit a4058c
  
Packit a4058c
    
Packit a4058c
      
Packit a4058c
        
1
Packit a4058c
        
gdk_pixbuf_save (pixbuf, handle, "jpeg", &error, "quality", "100", NULL);
Packit a4058c
      
Packit a4058c
    
Packit a4058c
  
Packit a4058c
Packit a4058c
Packit a4058c

Packit a4058c

Currently only few parameters exist. JPEG images can be saved with a

Packit a4058c
"quality" parameter; its value should be in the range [0,100]. JPEG
Packit a4058c
and PNG density can be set by setting the "x-dpi" and "y-dpi" parameters
Packit a4058c
to the appropriate values in dots per inch.

Packit a4058c

Text chunks can be attached to PNG images by specifying parameters of

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

Packit a4058c

ICC color profiles can also be embedded into PNG, JPEG and TIFF images.

Packit a4058c
The "icc-profile" value should be the complete ICC profile encoded
Packit a4058c
into base64.

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

Packit a4058c

TIFF images recognize: (1) a "bits-per-sample" option (integer) which

Packit a4058c
can be either 1 for saving bi-level CCITTFAX4 images, or 8 for saving
Packit a4058c
8-bits per sample; (2) a "compression" option (integer) which can be
Packit a4058c
1 for no compression, 2 for Huffman, 5 for LZW, 7 for JPEG and 8 for
Packit a4058c
DEFLATE (see the libtiff documentation and tiff.h for all supported
Packit a4058c
codec values); (3) an "icc-profile" option (zero-terminated string)
Packit a4058c
containing a base64 encoded ICC color profile.

Packit a4058c

ICO images can be saved in depth 16, 24, or 32, by using the "depth"

Packit a4058c
parameter. When the ICO saver is given "x_hot" and "y_hot" parameters,
Packit a4058c
it produces a CUR instead of an ICO.

Packit a4058c
Packit a4058c

Parameters

Packit a4058c
Packit a4058c
Packit a4058c
Packit a4058c
Packit a4058c
Packit a4058c
Packit a4058c
Packit a4058c
Packit a4058c

pixbuf

Packit a4058c

a GdkPixbuf.

Packit a4058c
 
Packit a4058c
Packit a4058c
Packit a4058c

filename

Packit a4058c

name of file to save.

Packit a4058c
 
Packit a4058c
Packit a4058c
Packit a4058c

type

Packit a4058c

name of file format.

Packit a4058c
 
Packit a4058c
Packit a4058c
Packit a4058c

error

Packit a4058c

return location for error, or NULL.

Packit a4058c
[allow-none]
Packit a4058c
Packit a4058c
Packit a4058c

...

Packit a4058c

list of key-value save options, followed by NULL

Packit a4058c
 
Packit a4058c
Packit a4058c
Packit a4058c
Packit a4058c
Packit a4058c
Packit a4058c

Returns

Packit a4058c

whether an error was set

Packit a4058c
Packit a4058c
Packit a4058c

Packit a4058c
Packit a4058c

GdkPixbufSaveFunc ()

Packit a4058c
gboolean
Packit a4058c
(*GdkPixbufSaveFunc) (const gchar *buf,
Packit a4058c
                      gsize count,
Packit a4058c
                      GError **error,
Packit a4058c
                      gpointer data);
Packit a4058c

Specifies the type of the function passed to

Packit a4058c
gdk_pixbuf_save_to_callback().  It is called once for each block of
Packit a4058c
bytes that is "written" by gdk_pixbuf_save_to_callback().  If
Packit a4058c
successful it should return TRUE.  If an error occurs it should set
Packit a4058c
error
Packit a4058c
 and return FALSE, in which case gdk_pixbuf_save_to_callback()
Packit a4058c
will fail with the same error.

Packit a4058c
Packit a4058c

Parameters

Packit a4058c
Packit a4058c
Packit a4058c
Packit a4058c
Packit a4058c
Packit a4058c
Packit a4058c
Packit a4058c
Packit a4058c

buf

Packit a4058c

bytes to be written.

Packit a4058c
[array length=count][element-type guint8]
Packit a4058c
Packit a4058c
Packit a4058c

count

Packit a4058c

number of bytes in buf

Packit a4058c
. 

Packit a4058c
 
Packit a4058c
Packit a4058c
Packit a4058c

error

Packit a4058c

A location to return an error.

Packit a4058c
[out]
Packit a4058c
Packit a4058c
Packit a4058c

data

Packit a4058c

user data passed to gdk_pixbuf_save_to_callback().

Packit a4058c
[closure]
Packit a4058c
Packit a4058c
Packit a4058c
Packit a4058c
Packit a4058c
Packit a4058c

Returns

Packit a4058c

TRUE if successful, FALSE (with error

Packit a4058c
set) if failed.

Packit a4058c
Packit a4058c

Since: 2.4

Packit a4058c
Packit a4058c

Packit a4058c
Packit a4058c

gdk_pixbuf_save_to_callback ()

Packit a4058c
gboolean
Packit a4058c
gdk_pixbuf_save_to_callback (GdkPixbuf *pixbuf,
Packit a4058c
                             GdkPixbufSaveFunc save_func,
Packit a4058c
                             gpointer user_data,
Packit a4058c
                             const char *type,
Packit a4058c
                             GError **error,
Packit a4058c
                             ...);
Packit a4058c

Saves pixbuf in format type

Packit a4058c
 by feeding the produced data to a 
Packit a4058c
callback. Can be used when you want to store the image to something 
Packit a4058c
other than a file, such as an in-memory buffer or a socket.  
Packit a4058c
If error
Packit a4058c
 is set, FALSE will be returned. Possible errors
Packit a4058c
include those in the GDK_PIXBUF_ERROR domain and whatever the save
Packit a4058c
function generates.

Packit a4058c

See gdk_pixbuf_save() for more details.

Packit a4058c
Packit a4058c

Parameters

Packit a4058c
Packit a4058c
Packit a4058c
Packit a4058c
Packit a4058c
Packit a4058c
Packit a4058c
Packit a4058c
Packit a4058c

pixbuf

Packit a4058c

a GdkPixbuf.

Packit a4058c
 
Packit a4058c
Packit a4058c
Packit a4058c

save_func

Packit a4058c

a function that is called to save each block of data that

Packit a4058c
the save routine generates. 

Packit a4058c
[scope call]
Packit a4058c
Packit a4058c
Packit a4058c

user_data

Packit a4058c

user data to pass to the save function.

Packit a4058c
 
Packit a4058c
Packit a4058c
Packit a4058c

type

Packit a4058c

name of file format.

Packit a4058c
 
Packit a4058c
Packit a4058c
Packit a4058c

error

Packit a4058c

return location for error, or NULL.

Packit a4058c
[allow-none]
Packit a4058c
Packit a4058c
Packit a4058c

...

Packit a4058c

list of key-value save options

Packit a4058c
 
Packit a4058c
Packit a4058c
Packit a4058c
Packit a4058c
Packit a4058c
Packit a4058c

Returns

Packit a4058c

whether an error was set

Packit a4058c
Packit a4058c

Since: 2.4

Packit a4058c
Packit a4058c

Packit a4058c
Packit a4058c

gdk_pixbuf_save_to_callbackv ()

Packit a4058c
gboolean
Packit a4058c
gdk_pixbuf_save_to_callbackv (GdkPixbuf *pixbuf,
Packit a4058c
                              GdkPixbufSaveFunc save_func,
Packit a4058c
                              gpointer user_data,
Packit a4058c
                              const char *type,
Packit a4058c
                              char **option_keys,
Packit a4058c
                              char **option_values,
Packit a4058c
                              GError **error);
Packit a4058c

Saves pixbuf to a callback in format type

Packit a4058c
, which is currently "jpeg",
Packit a4058c
"png", "tiff", "ico" or "bmp".  If error
Packit a4058c
 is set, FALSE will be returned. See
Packit a4058c
gdk_pixbuf_save_to_callback() for more details.

Packit a4058c
Packit a4058c

Parameters

Packit a4058c
Packit a4058c
Packit a4058c
Packit a4058c
Packit a4058c
Packit a4058c
Packit a4058c
Packit a4058c
Packit a4058c

pixbuf

Packit a4058c

a GdkPixbuf.

Packit a4058c
 
Packit a4058c
Packit a4058c
Packit a4058c

save_func

Packit a4058c

a function that is called to save each block of data that

Packit a4058c
the save routine generates. 

Packit a4058c
[scope call]
Packit a4058c
Packit a4058c
Packit a4058c

user_data

Packit a4058c

user data to pass to the save function.

Packit a4058c
[closure]
Packit a4058c
Packit a4058c
Packit a4058c

type

Packit a4058c

name of file format.

Packit a4058c
 
Packit a4058c
Packit a4058c
Packit a4058c

option_keys

Packit a4058c

name of options to set, NULL-terminated.

Packit a4058c
[array zero-terminated=1][element-type utf8]
Packit a4058c
Packit a4058c
Packit a4058c

option_values

Packit a4058c

values for named options.

Packit a4058c
[array zero-terminated=1][element-type utf8]
Packit a4058c
Packit a4058c
Packit a4058c

error

Packit a4058c

return location for error, or NULL.

Packit a4058c
[allow-none]
Packit a4058c
Packit a4058c
Packit a4058c
Packit a4058c
Packit a4058c
Packit a4058c

Returns

Packit a4058c

whether an error was set

Packit a4058c
Packit a4058c

Since: 2.4

Packit a4058c
Packit a4058c

Packit a4058c
Packit a4058c

gdk_pixbuf_save_to_buffer ()

Packit a4058c
gboolean
Packit a4058c
gdk_pixbuf_save_to_buffer (GdkPixbuf *pixbuf,
Packit a4058c
                           gchar **buffer,
Packit a4058c
                           gsize *buffer_size,
Packit a4058c
                           const char *type,
Packit a4058c
                           GError **error,
Packit a4058c
                           ...);
Packit a4058c

Saves pixbuf to a new buffer in format type

Packit a4058c
, which is currently "jpeg",
Packit a4058c
"png", "tiff", "ico" or "bmp".  This is a convenience function that uses
Packit a4058c
gdk_pixbuf_save_to_callback() to do the real work. Note that the buffer 
Packit a4058c
is not nul-terminated and may contain embedded  nuls.
Packit a4058c
If error
Packit a4058c
 is set, FALSE will be returned and buffer
Packit a4058c
 will be set to
Packit a4058c
NULL. Possible errors include those in the GDK_PIXBUF_ERROR
Packit a4058c
domain.

Packit a4058c

See gdk_pixbuf_save() for more details.

Packit a4058c
Packit a4058c

Parameters

Packit a4058c
Packit a4058c
Packit a4058c
Packit a4058c
Packit a4058c
Packit a4058c
Packit a4058c
Packit a4058c
Packit a4058c

pixbuf

Packit a4058c

a GdkPixbuf.

Packit a4058c
 
Packit a4058c
Packit a4058c
Packit a4058c

buffer

Packit a4058c

location to receive a pointer

Packit a4058c
to the new buffer. 

Packit a4058c
[array length=buffer_size][out][element-type guint8]
Packit a4058c
Packit a4058c
Packit a4058c

buffer_size

Packit a4058c

location to receive the size of the new buffer.

Packit a4058c
 
Packit a4058c
Packit a4058c
Packit a4058c

type

Packit a4058c

name of file format.

Packit a4058c
 
Packit a4058c
Packit a4058c
Packit a4058c

error

Packit a4058c

return location for error, or NULL.

Packit a4058c
[allow-none]
Packit a4058c
Packit a4058c
Packit a4058c

...

Packit a4058c

list of key-value save options

Packit a4058c
 
Packit a4058c
Packit a4058c
Packit a4058c
Packit a4058c
Packit a4058c
Packit a4058c

Returns

Packit a4058c

whether an error was set

Packit a4058c
Packit a4058c

Since: 2.4

Packit a4058c
Packit a4058c

Packit a4058c
Packit a4058c

gdk_pixbuf_save_to_bufferv ()

Packit a4058c
gboolean
Packit a4058c
gdk_pixbuf_save_to_bufferv (GdkPixbuf *pixbuf,
Packit a4058c
                            gchar **buffer,
Packit a4058c
                            gsize *buffer_size,
Packit a4058c
                            const char *type,
Packit a4058c
                            char **option_keys,
Packit a4058c
                            char **option_values,
Packit a4058c
                            GError **error);
Packit a4058c

Saves pixbuf to a new buffer in format type

Packit a4058c
, which is currently "jpeg",
Packit a4058c
"tiff", "png", "ico" or "bmp".  See gdk_pixbuf_save_to_buffer() 
Packit a4058c
for more details.

Packit a4058c
Packit a4058c

Parameters

Packit a4058c
Packit a4058c
Packit a4058c
Packit a4058c
Packit a4058c
Packit a4058c
Packit a4058c
Packit a4058c
Packit a4058c

pixbuf

Packit a4058c

a GdkPixbuf.

Packit a4058c
 
Packit a4058c
Packit a4058c
Packit a4058c

buffer

Packit a4058c

location to receive a pointer to the new buffer.

Packit a4058c
[array length=buffer_size][out][element-type guint8]
Packit a4058c
Packit a4058c
Packit a4058c

buffer_size

Packit a4058c

location to receive the size of the new buffer.

Packit a4058c
 
Packit a4058c
Packit a4058c
Packit a4058c

type

Packit a4058c

name of file format.

Packit a4058c
 
Packit a4058c
Packit a4058c
Packit a4058c

option_keys

Packit a4058c

name of options to set, NULL-terminated.

Packit a4058c
[array zero-terminated=1]
Packit a4058c
Packit a4058c
Packit a4058c

option_values

Packit a4058c

values for named options.

Packit a4058c
[array zero-terminated=1]
Packit a4058c
Packit a4058c
Packit a4058c

error

Packit a4058c

return location for error, or NULL.

Packit a4058c
[allow-none]
Packit a4058c
Packit a4058c
Packit a4058c
Packit a4058c
Packit a4058c
Packit a4058c

Returns

Packit a4058c

whether an error was set

Packit a4058c
Packit a4058c

Since: 2.4

Packit a4058c
Packit a4058c

Packit a4058c
Packit a4058c

gdk_pixbuf_save_to_stream ()

Packit a4058c
gboolean
Packit a4058c
gdk_pixbuf_save_to_stream (GdkPixbuf *pixbuf,
Packit a4058c
                           GOutputStream *stream,
Packit a4058c
                           const char *type,
Packit a4058c
                           GCancellable *cancellable,
Packit a4058c
                           GError **error,
Packit a4058c
                           ...);
Packit a4058c

Saves pixbuf

Packit a4058c
 to an output stream.

Packit a4058c

Supported file formats are currently "jpeg", "tiff", "png", "ico" or

Packit a4058c
"bmp". See gdk_pixbuf_save_to_buffer() for more details.

Packit a4058c

The cancellable

Packit a4058c
 can be used to abort the operation from another 
Packit a4058c
thread. If the operation was cancelled, the error G_IO_ERROR_CANCELLED 
Packit a4058c
will be returned. Other possible errors are in the GDK_PIXBUF_ERROR 
Packit a4058c
and G_IO_ERROR domains. 

Packit a4058c

The stream is not closed.

Packit a4058c
Packit a4058c

Parameters

Packit a4058c
Packit a4058c
Packit a4058c
Packit a4058c
Packit a4058c
Packit a4058c
Packit a4058c
Packit a4058c
Packit a4058c

pixbuf

Packit a4058c

a GdkPixbuf

Packit a4058c
 
Packit a4058c
Packit a4058c
Packit a4058c

stream

Packit a4058c

a GOutputStream to save the pixbuf to

Packit a4058c
 
Packit a4058c
Packit a4058c
Packit a4058c

type

Packit a4058c

name of file format

Packit a4058c
 
Packit a4058c
Packit a4058c
Packit a4058c

cancellable

Packit a4058c

optional GCancellable object, NULL to ignore.

Packit a4058c
[allow-none]
Packit a4058c
Packit a4058c
Packit a4058c

error

Packit a4058c

return location for error, or NULL.

Packit a4058c
[allow-none]
Packit a4058c
Packit a4058c
Packit a4058c

...

Packit a4058c

list of key-value save options

Packit a4058c
 
Packit a4058c
Packit a4058c
Packit a4058c
Packit a4058c
Packit a4058c
Packit a4058c

Returns

Packit a4058c

TRUE if the pixbuf was saved successfully, FALSE if an

Packit a4058c
error was set.

Packit a4058c
Packit a4058c

Since: 2.14

Packit a4058c
Packit a4058c

Packit a4058c
Packit a4058c

gdk_pixbuf_save_to_streamv ()

Packit a4058c
gboolean
Packit a4058c
gdk_pixbuf_save_to_streamv (GdkPixbuf *pixbuf,
Packit a4058c
                            GOutputStream *stream,
Packit a4058c
                            const char *type,
Packit a4058c
                            char **option_keys,
Packit a4058c
                            char **option_values,
Packit a4058c
                            GCancellable *cancellable,
Packit a4058c
                            GError **error);
Packit a4058c

Saves pixbuf

Packit a4058c
 to an output stream.

Packit a4058c

Supported file formats are currently "jpeg", "tiff", "png", "ico" or

Packit a4058c
"bmp". See gdk_pixbuf_save_to_stream() for more details.

Packit a4058c
Packit a4058c

Parameters

Packit a4058c
Packit a4058c
Packit a4058c
Packit a4058c
Packit a4058c
Packit a4058c
Packit a4058c
Packit a4058c
Packit a4058c

pixbuf

Packit a4058c

a GdkPixbuf

Packit a4058c
 
Packit a4058c
Packit a4058c
Packit a4058c

stream

Packit a4058c

a GOutputStream to save the pixbuf to

Packit a4058c
 
Packit a4058c
Packit a4058c
Packit a4058c

type

Packit a4058c

name of file format

Packit a4058c
 
Packit a4058c
Packit a4058c
Packit a4058c

option_keys

Packit a4058c

name of options to set, NULL-terminated.

Packit a4058c
[array zero-terminated=1]
Packit a4058c
Packit a4058c
Packit a4058c

option_values

Packit a4058c

values for named options.

Packit a4058c
[array zero-terminated=1]
Packit a4058c
Packit a4058c
Packit a4058c

cancellable

Packit a4058c

optional GCancellable object, NULL to ignore.

Packit a4058c
[allow-none]
Packit a4058c
Packit a4058c
Packit a4058c

error

Packit a4058c

return location for error, or NULL.

Packit a4058c
[allow-none]
Packit a4058c
Packit a4058c
Packit a4058c
Packit a4058c
Packit a4058c
Packit a4058c

Returns

Packit a4058c

TRUE if the pixbuf was saved successfully, FALSE if an

Packit a4058c
error was set.

Packit a4058c
Packit a4058c

Since: 2.36

Packit a4058c
Packit a4058c

Packit a4058c
Packit a4058c

gdk_pixbuf_save_to_stream_async ()

Packit a4058c
void
Packit a4058c
gdk_pixbuf_save_to_stream_async (GdkPixbuf *pixbuf,
Packit a4058c
                                 GOutputStream *stream,
Packit a4058c
                                 const gchar *type,
Packit a4058c
                                 GCancellable *cancellable,
Packit a4058c
                                 GAsyncReadyCallback callback,
Packit a4058c
                                 gpointer user_data,
Packit a4058c
                                 ...);
Packit a4058c

Saves pixbuf

Packit a4058c
 to an output stream asynchronously.

Packit a4058c

For more details see gdk_pixbuf_save_to_stream(), which is the synchronous

Packit a4058c
version of this function.

Packit a4058c

When the operation is finished, callback

Packit a4058c
 will be called in the main thread.
Packit a4058c
You can then call gdk_pixbuf_save_to_stream_finish() to get the result of the operation.

Packit a4058c
Packit a4058c

Parameters

Packit a4058c
Packit a4058c
Packit a4058c
Packit a4058c
Packit a4058c
Packit a4058c
Packit a4058c
Packit a4058c
Packit a4058c

pixbuf

Packit a4058c

a GdkPixbuf

Packit a4058c
 
Packit a4058c
Packit a4058c
Packit a4058c

stream

Packit a4058c

a GOutputStream to which to save the pixbuf

Packit a4058c
 
Packit a4058c
Packit a4058c
Packit a4058c

type

Packit a4058c

name of file format

Packit a4058c
 
Packit a4058c
Packit a4058c
Packit a4058c

cancellable

Packit a4058c

optional GCancellable object, NULL to ignore.

Packit a4058c
[allow-none]
Packit a4058c
Packit a4058c
Packit a4058c

callback

Packit a4058c

a GAsyncReadyCallback to call when the pixbuf is saved

Packit a4058c
 
Packit a4058c
Packit a4058c
Packit a4058c

user_data

Packit a4058c

the data to pass to the callback function

Packit a4058c
 
Packit a4058c
Packit a4058c
Packit a4058c

...

Packit a4058c

list of key-value save options

Packit a4058c
 
Packit a4058c
Packit a4058c
Packit a4058c
Packit a4058c
Packit a4058c

Since: 2.24

Packit a4058c
Packit a4058c

Packit a4058c
Packit a4058c

gdk_pixbuf_save_to_streamv_async ()

Packit a4058c
void
Packit a4058c
gdk_pixbuf_save_to_streamv_async (GdkPixbuf *pixbuf,
Packit a4058c
                                  GOutputStream *stream,
Packit a4058c
                                  const gchar *type,
Packit a4058c
                                  gchar **option_keys,
Packit a4058c
                                  gchar **option_values,
Packit a4058c
                                  GCancellable *cancellable,
Packit a4058c
                                  GAsyncReadyCallback callback,
Packit a4058c
                                  gpointer user_data);
Packit a4058c

Saves pixbuf

Packit a4058c
 to an output stream asynchronously.

Packit a4058c

For more details see gdk_pixbuf_save_to_streamv(), which is the synchronous

Packit a4058c
version of this function.

Packit a4058c

When the operation is finished, callback

Packit a4058c
 will be called in the main thread.
Packit a4058c
You can then call gdk_pixbuf_save_to_stream_finish() to get the result of the operation.

Packit a4058c
Packit a4058c

Parameters

Packit a4058c
Packit a4058c
Packit a4058c
Packit a4058c
Packit a4058c
Packit a4058c
Packit a4058c
Packit a4058c
Packit a4058c

pixbuf

Packit a4058c

a GdkPixbuf

Packit a4058c
 
Packit a4058c
Packit a4058c
Packit a4058c

stream

Packit a4058c

a GOutputStream to which to save the pixbuf

Packit a4058c
 
Packit a4058c
Packit a4058c
Packit a4058c

type

Packit a4058c

name of file format

Packit a4058c
 
Packit a4058c
Packit a4058c
Packit a4058c

option_keys

Packit a4058c

name of options to set, NULL-terminated.

Packit a4058c
[array zero-terminated=1]
Packit a4058c
Packit a4058c
Packit a4058c

option_values

Packit a4058c

values for named options.

Packit a4058c
[array zero-terminated=1]
Packit a4058c
Packit a4058c
Packit a4058c

cancellable

Packit a4058c

optional GCancellable object, NULL to ignore.

Packit a4058c
[allow-none]
Packit a4058c
Packit a4058c
Packit a4058c

callback

Packit a4058c

a GAsyncReadyCallback to call when the pixbuf is saved

Packit a4058c
 
Packit a4058c
Packit a4058c
Packit a4058c

user_data

Packit a4058c

the data to pass to the callback function

Packit a4058c
 
Packit a4058c
Packit a4058c
Packit a4058c
Packit a4058c
Packit a4058c

Since: 2.36

Packit a4058c
Packit a4058c

Packit a4058c
Packit a4058c

gdk_pixbuf_save_to_stream_finish ()

Packit a4058c
gboolean
Packit a4058c
gdk_pixbuf_save_to_stream_finish (GAsyncResult *async_result,
Packit a4058c
                                  GError **error);
Packit a4058c

Finishes an asynchronous pixbuf save operation started with

Packit a4058c
gdk_pixbuf_save_to_stream_async().

Packit a4058c
Packit a4058c

Parameters

Packit a4058c
Packit a4058c
Packit a4058c
Packit a4058c
Packit a4058c
Packit a4058c
Packit a4058c
Packit a4058c
Packit a4058c

async_result

Packit a4058c

a GAsyncResult

Packit a4058c
 
Packit a4058c
Packit a4058c
Packit a4058c

error

Packit a4058c

a GError, or NULL

Packit a4058c
 
Packit a4058c
Packit a4058c
Packit a4058c
Packit a4058c
Packit a4058c
Packit a4058c

Returns

Packit a4058c

TRUE if the pixbuf was saved successfully, FALSE if an error was set.

Packit a4058c
Packit a4058c

Since: 2.24

Packit a4058c
Packit a4058c
Packit a4058c
Packit a4058c

Types and Values

Packit a4058c
Packit a4058c
Packit a4058c
Packit a4058c

Generated by GTK-Doc V1.25.1
Packit a4058c
</body>
Packit a4058c
</html>