Constructor
GdkPixbufPixbufnew_from_file_at_scale
Declaration [src]
GdkPixbuf*
gdk_pixbuf_new_from_file_at_scale (
const char* filename,
int width,
int height,
gboolean preserve_aspect_ratio,
GError** error
)
Description [src]
Creates a new pixbuf by loading an image from a file.
The file format is detected automatically.
If NULL
is returned, then error
will be set. Possible errors are:
- the file could not be opened
- there is no loader for the file’s format
- there is not enough memory to allocate the image buffer
- the image buffer contains invalid data
The error domains are GDK_PIXBUF_ERROR
and G_FILE_ERROR
.
The image will be scaled to fit in the requested size, optionally preserving the image’s aspect ratio.
When preserving the aspect ratio, a width
of -1 will cause the image
to be scaled to the exact given height, and a height
of -1 will cause
the image to be scaled to the exact given width. When not preserving
aspect ratio, a width
or height
of -1 means to not scale the image
at all in that dimension. Negative values for width
and height
are
allowed since 2.8.
Available since: | 2.6 |
Parameters
filename |
const char* |
Name of file to load, in the GLib file name encoding. |
|
The data is owned by the caller of the function. | |
The value is a file system path, using the OS encoding. | |
width |
int |
The width the image should have or -1 to not constrain the width. |
|
height |
int |
The height the image should have or -1 to not constrain the height. |
|
preserve_aspect_ratio |
gboolean |
|
|
error |
GError ** |
The return location for a GError* , or NULL . |
Return value
Returns: | GdkPixbuf |
A newly-created pixbuf. |
|
The caller of the function takes ownership of the data, and is responsible for freeing it. | |
The return value can be NULL . |