← Back to branch summary

~ubuntu-branches/ubuntu/trusty/gdk-pixbuf/trusty-updates

« back to all changes in this revision

Viewing changes to gdk-pixbuf/gdk-pixbuf-io.c

  • Committer: Package Import Robot
  • Author(s): Sebastien Bacher
  • Date: 2012-08-06 22:01:05 UTC
  • mfrom: (1.3.4)
  • Revision ID: package-import@ubuntu.com-20120806220105-v5xmrretoyk0w2xr
Tags: 2.26.2-0ubuntu1
New upstream version

Show diffs side-by-side

added added

removed removed

Lines of Context:
gdk-pixbuf/gdk-pixbuf-io.c
56
56
 * @Title: File Loading
57
57
 * @See_also: #GdkPixbufLoader.
58
58
 * 
59
 
 * The &gdk-pixbuf; library provides a simple mechanism for loading
 
59
 * The GdkPixBuf library provides a simple mechanism for loading
60
60
 * an image from a file in synchronous fashion.  This means that the
61
61
 * library takes control of the application while the file is being
62
62
 * loaded; from the user's point of view, the application will block
76
76
 * 
77
77
 * These functions allow to save a #GdkPixbuf in a number of 
78
78
 * file formats. The formatted data can be written to a file
79
 
 * or to a memory buffer. &gdk-pixbuf; can also call a user-defined
 
79
 * or to a memory buffer. GdkPixBuf can also call a user-defined
80
80
 * callback on the data, which allows to e.g. write the image 
81
81
 * to a socket or store it in a database.
82
82
 */
83
83
 
84
84
/**
85
85
 * SECTION:module_interface
86
 
 * @Short_description: Extending &gdk-pixbuf;
 
86
 * @Short_description: Extending GdkPixBuf
87
87
 * @Title: Module Interface
88
88
 * 
89
 
 * If &gdk-pixbuf; has been compiled with GModule support, it can be extended by
 
89
 * If GdkPixBuf has been compiled with GModule support, it can be extended by
90
90
 * modules which can load (and perhaps also save) new image and animation
91
91
 * formats. Each loadable module must export a
92
92
 * #GdkPixbufModuleFillInfoFunc function named <function>fill_info</function> and
99
99
 * signatures (and other information) via the <function>fill_info</function>
100
100
 * function. An external utility, <command>gdk-pixbuf-query-loaders</command>, 
101
101
 * uses this to create a text file containing a list of all available loaders and 
102
 
 * their signatures. This file is then read at runtime by &gdk-pixbuf; to obtain
 
102
 * their signatures. This file is then read at runtime by GdkPixBuf to obtain
103
103
 * the list of available loaders and their signatures. 
104
104
 * 
105
105
 * 
108
108
 * <function>fill_vtable</function> function will simply not set the corresponding
109
109
 * function pointers of the #GdkPixbufModule structure. If a module supports
110
110
 * incremental loading (i.e. provides #begin_load, #stop_load and
111
 
 * #load_increment), it doesn't have to implement #load, since &gdk-pixbuf; can 
 
111
 * #load_increment), it doesn't have to implement #load, since GdkPixBuf can
112
112
 * supply a generic #load implementation wrapping the incremental loading. 
113
113
 * 
114
114
 * 
128
128
 * </itemizedlist>
129
129
 * 
130
130
 * 
131
 
 * The &gdk-pixbuf; interfaces needed for implementing modules are contained in 
 
131
 * The GdkPixBuf interfaces needed for implementing modules are contained in
132
132
 * <filename>gdk-pixbuf-io.h</filename> (and
133
133
 * <filename>gdk-pixbuf-animation.h</filename> if the module supports animations).
134
134
 * They are not covered by the same stability guarantees as the regular 
135
 
 * &gdk-pixbuf; API. To underline this fact, they are protected by 
 
135
 * GdkPixBuf API. To underline this fact, they are protected by
136
136
 * <literal>#ifdef GDK_PIXBUF_ENABLE_BACKEND</literal>.
137
137
 */
138
138
 
1928
1928
 
1929
1929
/**
1930
1930
 * gdk_pixbuf_new_from_xpm_data:
1931
 
 * @data: Pointer to inline XPM data.
 
1931
 * @data: (array zero-terminated=1): Pointer to inline XPM data.
1932
1932
 *
1933
1933
 * Creates a new pixbuf by parsing XPM data in memory.  This data is commonly
1934
1934
 * the result of including an XPM file into a program's C source.
2217
2217
 * @filename: name of file to save.
2218
2218
 * @type: name of file format.
2219
2219
 * @error: (allow-none): return location for error, or %NULL
2220
 
 * @Varargs: list of key-value save options
 
2220
 * @...: list of key-value save options, followed by %NULL
2221
2221
 *
2222
2222
 * Saves pixbuf to a file in format @type. By default, "jpeg", "png", "ico" 
2223
2223
 * and "bmp" are possible file formats to save in, but more formats may be
2472
2472
 * @user_data: user data to pass to the save function.
2473
2473
 * @type: name of file format.
2474
2474
 * @error: (allow-none): return location for error, or %NULL
2475
 
 * @Varargs: list of key-value save options
 
2475
 * @...: list of key-value save options
2476
2476
 *
2477
2477
 * Saves pixbuf in format @type by feeding the produced data to a 
2478
2478
 * callback. Can be used when you want to store the image to something 
2574
2574
 * @buffer_size: location to receive the size of the new buffer.
2575
2575
 * @type: name of file format.
2576
2576
 * @error: (allow-none): return location for error, or %NULL
2577
 
 * @Varargs: list of key-value save options
 
2577
 * @...: list of key-value save options
2578
2578
 *
2579
2579
 * Saves pixbuf to a new buffer in format @type, which is currently "jpeg",
2580
2580
 * "png", "tiff", "ico" or "bmp".  This is a convenience function that uses
2760
2760
 * @type: name of file format
2761
2761
 * @cancellable: optional #GCancellable object, %NULL to ignore
2762
2762
 * @error: (allow-none): return location for error, or %NULL
2763
 
 * @Varargs: list of key-value save options
 
2763
 * @...: list of key-value save options
2764
2764
 *
2765
2765
 * Saves @pixbuf to an output stream.
2766
2766
 *
2864
2864
 * @cancellable: optional #GCancellable object, %NULL to ignore
2865
2865
 * @callback: a #GAsyncReadyCallback to call when the the pixbuf is loaded
2866
2866
 * @user_data: the data to pass to the callback function
2867
 
 * @Varargs: list of key-value save options
 
2867
 * @...: list of key-value save options
2868
2868
 *
2869
2869
 * Saves @pixbuf to an output stream asynchronously.
2870
2870
 *