diff options
| author | Leo Tenenbaum <pommicket@gmail.com> | 2018-08-20 21:12:06 -0400 |
|---|---|---|
| committer | Leo Tenenbaum <pommicket@gmail.com> | 2018-08-20 21:12:06 -0400 |
| commit | 63e87c2d0c9d263f14c77b68f85c67d46ece82a9 (patch) | |
| tree | 6260365cbf7d24f37d27669e8538227fcb72e243 /gtk+-mingw/share/gtk-doc/html/gdk-pixbuf/gdk-pixbuf-The-GdkPixbuf-Structure.html | |
| parent | a4460f6d9453bbd7e584937686449cef3e19f052 (diff) | |
Diffstat (limited to 'gtk+-mingw/share/gtk-doc/html/gdk-pixbuf/gdk-pixbuf-The-GdkPixbuf-Structure.html')
| -rw-r--r-- | gtk+-mingw/share/gtk-doc/html/gdk-pixbuf/gdk-pixbuf-The-GdkPixbuf-Structure.html | 717 |
1 files changed, 0 insertions, 717 deletions
diff --git a/gtk+-mingw/share/gtk-doc/html/gdk-pixbuf/gdk-pixbuf-The-GdkPixbuf-Structure.html b/gtk+-mingw/share/gtk-doc/html/gdk-pixbuf/gdk-pixbuf-The-GdkPixbuf-Structure.html deleted file mode 100644 index 3d946c5..0000000 --- a/gtk+-mingw/share/gtk-doc/html/gdk-pixbuf/gdk-pixbuf-The-GdkPixbuf-Structure.html +++ /dev/null @@ -1,717 +0,0 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> -<html> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>The GdkPixbuf Structure</title> -<meta name="generator" content="DocBook XSL Stylesheets V1.77.1"> -<link rel="home" href="index.html" title="GDK-PixBuf Reference Manual"> -<link rel="up" href="rn01.html" title="API Reference"> -<link rel="prev" href="gdk-pixbuf-Versioning.html" title="Initialization and Versions"> -<link rel="next" href="gdk-pixbuf-Reference-Counting-and-Memory-Mangement.html" title="Reference Counting and Memory Mangement"> -<meta name="generator" content="GTK-Doc V1.18.1 (XML mode)"> -<link rel="stylesheet" href="style.css" type="text/css"> -</head> -<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> -<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"> -<tr valign="middle"> -<td><a accesskey="p" href="gdk-pixbuf-Versioning.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> -<td><a accesskey="u" href="rn01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td> -<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td> -<th width="100%" align="center">GDK-PixBuf Reference Manual</th> -<td><a accesskey="n" href="gdk-pixbuf-Reference-Counting-and-Memory-Mangement.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> -</tr> -<tr><td colspan="5" class="shortcuts"> -<a href="#gdk-pixbuf-The-GdkPixbuf-Structure.synopsis" class="shortcut">Top</a> - | - <a href="#gdk-pixbuf-The-GdkPixbuf-Structure.description" class="shortcut">Description</a> - | - <a href="#gdk-pixbuf-The-GdkPixbuf-Structure.object-hierarchy" class="shortcut">Object Hierarchy</a> - | - <a href="#gdk-pixbuf-The-GdkPixbuf-Structure.implemented-interfaces" class="shortcut">Implemented Interfaces</a> - | - <a href="#gdk-pixbuf-The-GdkPixbuf-Structure.properties" class="shortcut">Properties</a> -</td></tr> -</table> -<div class="refentry"> -<a name="gdk-pixbuf-The-GdkPixbuf-Structure"></a><div class="titlepage"></div> -<div class="refnamediv"><table width="100%"><tr> -<td valign="top"> -<h2><span class="refentrytitle"><a name="gdk-pixbuf-The-GdkPixbuf-Structure.top_of_page"></a>The GdkPixbuf Structure</span></h2> -<p>The GdkPixbuf Structure — Information that describes an image.</p> -</td> -<td valign="top" align="right"></td> -</tr></table></div> -<div class="refsynopsisdiv"> -<a name="gdk-pixbuf-The-GdkPixbuf-Structure.synopsis"></a><h2>Synopsis</h2> -<a name="GdkPixbuf"></a><pre class="synopsis"> -#include <gdk-pixbuf/gdk-pixbuf.h> - -enum <a class="link" href="gdk-pixbuf-The-GdkPixbuf-Structure.html#GdkPixbufError" title="enum GdkPixbufError">GdkPixbufError</a>; -#define <a class="link" href="gdk-pixbuf-The-GdkPixbuf-Structure.html#GDK-PIXBUF-ERROR:CAPS" title="GDK_PIXBUF_ERROR">GDK_PIXBUF_ERROR</a> -enum <a class="link" href="gdk-pixbuf-The-GdkPixbuf-Structure.html#GdkColorspace" title="enum GdkColorspace">GdkColorspace</a>; -enum <a class="link" href="gdk-pixbuf-The-GdkPixbuf-Structure.html#GdkPixbufAlphaMode" title="enum GdkPixbufAlphaMode">GdkPixbufAlphaMode</a>; - <a class="link" href="gdk-pixbuf-The-GdkPixbuf-Structure.html#GdkPixbuf-struct" title="GdkPixbuf">GdkPixbuf</a>; -<a class="link" href="gdk-pixbuf-The-GdkPixbuf-Structure.html#GdkColorspace" title="enum GdkColorspace"><span class="returnvalue">GdkColorspace</span></a> <a class="link" href="gdk-pixbuf-The-GdkPixbuf-Structure.html#gdk-pixbuf-get-colorspace" title="gdk_pixbuf_get_colorspace ()">gdk_pixbuf_get_colorspace</a> (<em class="parameter"><code>const <a class="link" href="gdk-pixbuf-The-GdkPixbuf-Structure.html#GdkPixbuf"><span class="type">GdkPixbuf</span></a> *pixbuf</code></em>); -<span class="returnvalue">int</span> <a class="link" href="gdk-pixbuf-The-GdkPixbuf-Structure.html#gdk-pixbuf-get-n-channels" title="gdk_pixbuf_get_n_channels ()">gdk_pixbuf_get_n_channels</a> (<em class="parameter"><code>const <a class="link" href="gdk-pixbuf-The-GdkPixbuf-Structure.html#GdkPixbuf"><span class="type">GdkPixbuf</span></a> *pixbuf</code></em>); -<span class="returnvalue">gboolean</span> <a class="link" href="gdk-pixbuf-The-GdkPixbuf-Structure.html#gdk-pixbuf-get-has-alpha" title="gdk_pixbuf_get_has_alpha ()">gdk_pixbuf_get_has_alpha</a> (<em class="parameter"><code>const <a class="link" href="gdk-pixbuf-The-GdkPixbuf-Structure.html#GdkPixbuf"><span class="type">GdkPixbuf</span></a> *pixbuf</code></em>); -<span class="returnvalue">int</span> <a class="link" href="gdk-pixbuf-The-GdkPixbuf-Structure.html#gdk-pixbuf-get-bits-per-sample" title="gdk_pixbuf_get_bits_per_sample ()">gdk_pixbuf_get_bits_per_sample</a> (<em class="parameter"><code>const <a class="link" href="gdk-pixbuf-The-GdkPixbuf-Structure.html#GdkPixbuf"><span class="type">GdkPixbuf</span></a> *pixbuf</code></em>); -<span class="returnvalue">guchar</span> * <a class="link" href="gdk-pixbuf-The-GdkPixbuf-Structure.html#gdk-pixbuf-get-pixels" title="gdk_pixbuf_get_pixels ()">gdk_pixbuf_get_pixels</a> (<em class="parameter"><code>const <a class="link" href="gdk-pixbuf-The-GdkPixbuf-Structure.html#GdkPixbuf"><span class="type">GdkPixbuf</span></a> *pixbuf</code></em>); -<span class="returnvalue">guchar</span> * <a class="link" href="gdk-pixbuf-The-GdkPixbuf-Structure.html#gdk-pixbuf-get-pixels-with-length" title="gdk_pixbuf_get_pixels_with_length ()">gdk_pixbuf_get_pixels_with_length</a> (<em class="parameter"><code>const <a class="link" href="gdk-pixbuf-The-GdkPixbuf-Structure.html#GdkPixbuf"><span class="type">GdkPixbuf</span></a> *pixbuf</code></em>, - <em class="parameter"><code><span class="type">guint</span> *length</code></em>); -<span class="returnvalue">int</span> <a class="link" href="gdk-pixbuf-The-GdkPixbuf-Structure.html#gdk-pixbuf-get-width" title="gdk_pixbuf_get_width ()">gdk_pixbuf_get_width</a> (<em class="parameter"><code>const <a class="link" href="gdk-pixbuf-The-GdkPixbuf-Structure.html#GdkPixbuf"><span class="type">GdkPixbuf</span></a> *pixbuf</code></em>); -<span class="returnvalue">int</span> <a class="link" href="gdk-pixbuf-The-GdkPixbuf-Structure.html#gdk-pixbuf-get-height" title="gdk_pixbuf_get_height ()">gdk_pixbuf_get_height</a> (<em class="parameter"><code>const <a class="link" href="gdk-pixbuf-The-GdkPixbuf-Structure.html#GdkPixbuf"><span class="type">GdkPixbuf</span></a> *pixbuf</code></em>); -<span class="returnvalue">int</span> <a class="link" href="gdk-pixbuf-The-GdkPixbuf-Structure.html#gdk-pixbuf-get-rowstride" title="gdk_pixbuf_get_rowstride ()">gdk_pixbuf_get_rowstride</a> (<em class="parameter"><code>const <a class="link" href="gdk-pixbuf-The-GdkPixbuf-Structure.html#GdkPixbuf"><span class="type">GdkPixbuf</span></a> *pixbuf</code></em>); -<span class="returnvalue">gsize</span> <a class="link" href="gdk-pixbuf-The-GdkPixbuf-Structure.html#gdk-pixbuf-get-byte-length" title="gdk_pixbuf_get_byte_length ()">gdk_pixbuf_get_byte_length</a> (<em class="parameter"><code>const <a class="link" href="gdk-pixbuf-The-GdkPixbuf-Structure.html#GdkPixbuf"><span class="type">GdkPixbuf</span></a> *pixbuf</code></em>); -const <span class="returnvalue">gchar</span> * <a class="link" href="gdk-pixbuf-The-GdkPixbuf-Structure.html#gdk-pixbuf-get-option" title="gdk_pixbuf_get_option ()">gdk_pixbuf_get_option</a> (<em class="parameter"><code><a class="link" href="gdk-pixbuf-The-GdkPixbuf-Structure.html#GdkPixbuf"><span class="type">GdkPixbuf</span></a> *pixbuf</code></em>, - <em class="parameter"><code>const <span class="type">gchar</span> *key</code></em>); -</pre> -</div> -<div class="refsect1"> -<a name="gdk-pixbuf-The-GdkPixbuf-Structure.object-hierarchy"></a><h2>Object Hierarchy</h2> -<pre class="synopsis"> - GObject - +----GdkPixbuf -</pre> -</div> -<div class="refsect1"> -<a name="gdk-pixbuf-The-GdkPixbuf-Structure.implemented-interfaces"></a><h2>Implemented Interfaces</h2> -<p> -GdkPixbuf implements - GIcon.</p> -</div> -<div class="refsect1"> -<a name="gdk-pixbuf-The-GdkPixbuf-Structure.properties"></a><h2>Properties</h2> -<pre class="synopsis"> - "<a class="link" href="gdk-pixbuf-The-GdkPixbuf-Structure.html#GdkPixbuf--bits-per-sample" title='The "bits-per-sample" property'>bits-per-sample</a>" <span class="type">gint</span> : Read / Write / Construct Only - "<a class="link" href="gdk-pixbuf-The-GdkPixbuf-Structure.html#GdkPixbuf--colorspace" title='The "colorspace" property'>colorspace</a>" <a class="link" href="gdk-pixbuf-The-GdkPixbuf-Structure.html#GdkColorspace" title="enum GdkColorspace"><span class="type">GdkColorspace</span></a> : Read / Write / Construct Only - "<a class="link" href="gdk-pixbuf-The-GdkPixbuf-Structure.html#GdkPixbuf--has-alpha" title='The "has-alpha" property'>has-alpha</a>" <span class="type">gboolean</span> : Read / Write / Construct Only - "<a class="link" href="gdk-pixbuf-The-GdkPixbuf-Structure.html#GdkPixbuf--height" title='The "height" property'>height</a>" <span class="type">gint</span> : Read / Write / Construct Only - "<a class="link" href="gdk-pixbuf-The-GdkPixbuf-Structure.html#GdkPixbuf--n-channels" title='The "n-channels" property'>n-channels</a>" <span class="type">gint</span> : Read / Write / Construct Only - "<a class="link" href="gdk-pixbuf-The-GdkPixbuf-Structure.html#GdkPixbuf--pixels" title='The "pixels" property'>pixels</a>" <span class="type">gpointer</span> : Read / Write / Construct Only - "<a class="link" href="gdk-pixbuf-The-GdkPixbuf-Structure.html#GdkPixbuf--rowstride" title='The "rowstride" property'>rowstride</a>" <span class="type">gint</span> : Read / Write / Construct Only - "<a class="link" href="gdk-pixbuf-The-GdkPixbuf-Structure.html#GdkPixbuf--width" title='The "width" property'>width</a>" <span class="type">gint</span> : Read / Write / Construct Only -</pre> -</div> -<div class="refsect1"> -<a name="gdk-pixbuf-The-GdkPixbuf-Structure.description"></a><h2>Description</h2> -<p> -The <a class="link" href="gdk-pixbuf-The-GdkPixbuf-Structure.html#GdkPixbuf"><span class="type">GdkPixbuf</span></a> structure contains -information that describes an image in memory. -</p> -<p> -</p> -<div class="section"> -<div class="titlepage"><div><div><h2 class="title" style="clear: both"> -<a name="image-data"></a>Image Data</h2></div></div></div> -<p> -Image data in a pixbuf is stored in memory in uncompressed, -packed format. Rows in the image are stored top to bottom, and -in each row pixels are stored from left to right. There may be -padding at the end of a row. The "rowstride" value of a pixbuf, -as returned by <a class="link" href="gdk-pixbuf-The-GdkPixbuf-Structure.html#gdk-pixbuf-get-rowstride" title="gdk_pixbuf_get_rowstride ()"><code class="function">gdk_pixbuf_get_rowstride()</code></a>, indicates the number -of bytes between rows. -</p> -<p> -</p> -<div class="example"> -<a name="put-pixel"></a><p class="title"><b>Example 1. put_pixel() example</b></p> -<div class="example-contents"> -<p> -</p> -<p> -The following code illustrates a simple put_pixel() -function for RGB pixbufs with 8 bits per channel with an alpha -channel. It is not included in the gdk-pixbuf library for -performance reasons; rather than making several function calls -for each pixel, your own code can take shortcuts. -</p> -<p> -</p> -<pre class="programlisting"> -static void -put_pixel (GdkPixbuf *pixbuf, int x, int y, guchar red, guchar green, guchar blue, guchar alpha) -{ - int width, height, rowstride, n_channels; - guchar *pixels, *p; - - n_channels = gdk_pixbuf_get_n_channels (pixbuf); - - g_assert (gdk_pixbuf_get_colorspace (pixbuf) == GDK_COLORSPACE_RGB); - g_assert (gdk_pixbuf_get_bits_per_sample (pixbuf) == 8); - g_assert (gdk_pixbuf_get_has_alpha (pixbuf)); - g_assert (n_channels == 4); - - width = gdk_pixbuf_get_width (pixbuf); - height = gdk_pixbuf_get_height (pixbuf); - - g_assert (x >= 0 && x < width); - g_assert (y >= 0 && y < height); - - rowstride = gdk_pixbuf_get_rowstride (pixbuf); - pixels = gdk_pixbuf_get_pixels (pixbuf); - - p = pixels + y * rowstride + x * n_channels; - p[0] = red; - p[1] = green; - p[2] = blue; - p[3] = alpha; -} -</pre> -<p> -</p> -<p> -This function will not work for pixbufs with images that are -other than 8 bits per sample or channel, but it will work for -most of the pixbufs that GTK+ uses. -</p> -</div> -</div> -<p><br class="example-break"> -</p> -<p> -</p> -<div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"> -<h3 class="title">Note</h3> -If you are doing <code class="function">memcpy()</code> of raw pixbuf data, note that the -last row in the pixbuf may not be as wide as the full -rowstride, but rather just as wide as the pixel data needs to -be. That is, it is unsafe to do <code class="literal">memcpy (dest, -pixels, rowstride * height)</code> to copy a whole pixbuf. -Use <a class="link" href="gdk-pixbuf-Image-Data-in-Memory.html#gdk-pixbuf-copy" title="gdk_pixbuf_copy ()"><code class="function">gdk_pixbuf_copy()</code></a> instead, or compute the width in bytes -of the last row as <code class="literal">width * ((n_channels * -bits_per_sample + 7) / 8)</code>. -</div> -<p> -</p> -</div> -<p> -</p> -</div> -<div class="refsect1"> -<a name="gdk-pixbuf-The-GdkPixbuf-Structure.details"></a><h2>Details</h2> -<div class="refsect2"> -<a name="GdkPixbufError"></a><h3>enum GdkPixbufError</h3> -<pre class="programlisting">typedef enum { - /* image data hosed */ - GDK_PIXBUF_ERROR_CORRUPT_IMAGE, - /* no mem to load image */ - GDK_PIXBUF_ERROR_INSUFFICIENT_MEMORY, - /* bad option passed to save routine */ - GDK_PIXBUF_ERROR_BAD_OPTION, - /* unsupported image type (sort of an ENOSYS) */ - GDK_PIXBUF_ERROR_UNKNOWN_TYPE, - /* unsupported operation (load, save) for image type */ - GDK_PIXBUF_ERROR_UNSUPPORTED_OPERATION, - GDK_PIXBUF_ERROR_FAILED -} GdkPixbufError; -</pre> -<p> -An error code in the <a class="link" href="gdk-pixbuf-The-GdkPixbuf-Structure.html#GDK-PIXBUF-ERROR:CAPS" title="GDK_PIXBUF_ERROR"><span class="type">GDK_PIXBUF_ERROR</span></a> domain. Many &gdk-pixbuf; -operations can cause errors in this domain, or in the <span class="type">G_FILE_ERROR</span> -domain. -</p> -<div class="variablelist"><table border="0" class="variablelist"> -<colgroup> -<col align="left" valign="top"> -<col> -</colgroup> -<tbody> -<tr> -<td><p><a name="GDK-PIXBUF-ERROR-CORRUPT-IMAGE:CAPS"></a><span class="term"><code class="literal">GDK_PIXBUF_ERROR_CORRUPT_IMAGE</code></span></p></td> -<td>An image file was broken somehow. -</td> -</tr> -<tr> -<td><p><a name="GDK-PIXBUF-ERROR-INSUFFICIENT-MEMORY:CAPS"></a><span class="term"><code class="literal">GDK_PIXBUF_ERROR_INSUFFICIENT_MEMORY</code></span></p></td> -<td>Not enough memory. -</td> -</tr> -<tr> -<td><p><a name="GDK-PIXBUF-ERROR-BAD-OPTION:CAPS"></a><span class="term"><code class="literal">GDK_PIXBUF_ERROR_BAD_OPTION</code></span></p></td> -<td>A bad option was passed to a pixbuf save module. -</td> -</tr> -<tr> -<td><p><a name="GDK-PIXBUF-ERROR-UNKNOWN-TYPE:CAPS"></a><span class="term"><code class="literal">GDK_PIXBUF_ERROR_UNKNOWN_TYPE</code></span></p></td> -<td>Unknown image type. -</td> -</tr> -<tr> -<td><p><a name="GDK-PIXBUF-ERROR-UNSUPPORTED-OPERATION:CAPS"></a><span class="term"><code class="literal">GDK_PIXBUF_ERROR_UNSUPPORTED_OPERATION</code></span></p></td> -<td>Don't know how to perform the - given operation on the type of image at hand. -</td> -</tr> -<tr> -<td><p><a name="GDK-PIXBUF-ERROR-FAILED:CAPS"></a><span class="term"><code class="literal">GDK_PIXBUF_ERROR_FAILED</code></span></p></td> -<td>Generic failure code, something went wrong. -</td> -</tr> -</tbody> -</table></div> -</div> -<hr> -<div class="refsect2"> -<a name="GDK-PIXBUF-ERROR:CAPS"></a><h3>GDK_PIXBUF_ERROR</h3> -<pre class="programlisting">#define GDK_PIXBUF_ERROR gdk_pixbuf_error_quark () -</pre> -<p> -Error domain used for pixbuf operations. Indicates that the error code -will be in the <a class="link" href="gdk-pixbuf-The-GdkPixbuf-Structure.html#GdkPixbufError" title="enum GdkPixbufError"><span class="type">GdkPixbufError</span></a> enumeration. See <span class="type">GError</span> for -information on error domains and error codes. -</p> -</div> -<hr> -<div class="refsect2"> -<a name="GdkColorspace"></a><h3>enum GdkColorspace</h3> -<pre class="programlisting">typedef enum { - GDK_COLORSPACE_RGB -} GdkColorspace; -</pre> -<p> -This enumeration defines the color spaces that are supported by -the &gdk-pixbuf; library. Currently only RGB is supported. -</p> -<div class="variablelist"><table border="0" class="variablelist"> -<colgroup> -<col align="left" valign="top"> -<col> -</colgroup> -<tbody><tr> -<td><p><a name="GDK-COLORSPACE-RGB:CAPS"></a><span class="term"><code class="literal">GDK_COLORSPACE_RGB</code></span></p></td> -<td>Indicates a red/green/blue additive color space. -</td> -</tr></tbody> -</table></div> -</div> -<hr> -<div class="refsect2"> -<a name="GdkPixbufAlphaMode"></a><h3>enum GdkPixbufAlphaMode</h3> -<pre class="programlisting">typedef enum { - GDK_PIXBUF_ALPHA_BILEVEL, - GDK_PIXBUF_ALPHA_FULL -} GdkPixbufAlphaMode; -</pre> -<p> -These values can be passed to -<a href="http://library.gnome.org/devel/gdk3/gdk-Pixbufs.html#gdk-pixbuf-render-to-drawable-alpha"><code class="function">gdk_pixbuf_render_to_drawable_alpha()</code></a> to control how the alpha -channel of an image should be handled. This function can create a -bilevel clipping mask (black and white) and use it while painting -the image. In the future, when the X Window System gets an alpha -channel extension, it will be possible to do full alpha -compositing onto arbitrary drawables. For now both cases fall -back to a bilevel clipping mask. -</p> -<div class="variablelist"><table border="0" class="variablelist"> -<colgroup> -<col align="left" valign="top"> -<col> -</colgroup> -<tbody> -<tr> -<td><p><a name="GDK-PIXBUF-ALPHA-BILEVEL:CAPS"></a><span class="term"><code class="literal">GDK_PIXBUF_ALPHA_BILEVEL</code></span></p></td> -<td>A bilevel clipping mask (black and white) - will be created and used to draw the image. Pixels below 0.5 opacity - will be considered fully transparent, and all others will be - considered fully opaque. -</td> -</tr> -<tr> -<td><p><a name="GDK-PIXBUF-ALPHA-FULL:CAPS"></a><span class="term"><code class="literal">GDK_PIXBUF_ALPHA_FULL</code></span></p></td> -<td>For now falls back to <a class="link" href="gdk-pixbuf-The-GdkPixbuf-Structure.html#GDK-PIXBUF-ALPHA-BILEVEL:CAPS"><span class="type">GDK_PIXBUF_ALPHA_BILEVEL</span></a>. - In the future it will do full alpha compositing. -</td> -</tr> -</tbody> -</table></div> -</div> -<hr> -<div class="refsect2"> -<a name="GdkPixbuf-struct"></a><h3>GdkPixbuf</h3> -<pre class="programlisting">typedef struct _GdkPixbuf GdkPixbuf;</pre> -<p> -This is the main structure in the &gdk-pixbuf; library. It is -used to represent images. It contains information about the -image's pixel data, its color space, bits per sample, width and -height, and the rowstride (the number of bytes between the start of -one row and the start of the next). -</p> -</div> -<hr> -<div class="refsect2"> -<a name="gdk-pixbuf-get-colorspace"></a><h3>gdk_pixbuf_get_colorspace ()</h3> -<pre class="programlisting"><a class="link" href="gdk-pixbuf-The-GdkPixbuf-Structure.html#GdkColorspace" title="enum GdkColorspace"><span class="returnvalue">GdkColorspace</span></a> gdk_pixbuf_get_colorspace (<em class="parameter"><code>const <a class="link" href="gdk-pixbuf-The-GdkPixbuf-Structure.html#GdkPixbuf"><span class="type">GdkPixbuf</span></a> *pixbuf</code></em>);</pre> -<p> -Queries the color space of a pixbuf. -</p> -<div class="variablelist"><table border="0" class="variablelist"> -<colgroup> -<col align="left" valign="top"> -<col> -</colgroup> -<tbody> -<tr> -<td><p><span class="term"><em class="parameter"><code>pixbuf</code></em> :</span></p></td> -<td>A pixbuf.</td> -</tr> -<tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>Color space.</td> -</tr> -</tbody> -</table></div> -</div> -<hr> -<div class="refsect2"> -<a name="gdk-pixbuf-get-n-channels"></a><h3>gdk_pixbuf_get_n_channels ()</h3> -<pre class="programlisting"><span class="returnvalue">int</span> gdk_pixbuf_get_n_channels (<em class="parameter"><code>const <a class="link" href="gdk-pixbuf-The-GdkPixbuf-Structure.html#GdkPixbuf"><span class="type">GdkPixbuf</span></a> *pixbuf</code></em>);</pre> -<p> -Queries the number of channels of a pixbuf. -</p> -<div class="variablelist"><table border="0" class="variablelist"> -<colgroup> -<col align="left" valign="top"> -<col> -</colgroup> -<tbody> -<tr> -<td><p><span class="term"><em class="parameter"><code>pixbuf</code></em> :</span></p></td> -<td>A pixbuf.</td> -</tr> -<tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>Number of channels.</td> -</tr> -</tbody> -</table></div> -</div> -<hr> -<div class="refsect2"> -<a name="gdk-pixbuf-get-has-alpha"></a><h3>gdk_pixbuf_get_has_alpha ()</h3> -<pre class="programlisting"><span class="returnvalue">gboolean</span> gdk_pixbuf_get_has_alpha (<em class="parameter"><code>const <a class="link" href="gdk-pixbuf-The-GdkPixbuf-Structure.html#GdkPixbuf"><span class="type">GdkPixbuf</span></a> *pixbuf</code></em>);</pre> -<p> -Queries whether a pixbuf has an alpha channel (opacity information). -</p> -<div class="variablelist"><table border="0" class="variablelist"> -<colgroup> -<col align="left" valign="top"> -<col> -</colgroup> -<tbody> -<tr> -<td><p><span class="term"><em class="parameter"><code>pixbuf</code></em> :</span></p></td> -<td>A pixbuf.</td> -</tr> -<tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td> -<code class="literal">TRUE</code> if it has an alpha channel, <code class="literal">FALSE</code> otherwise.</td> -</tr> -</tbody> -</table></div> -</div> -<hr> -<div class="refsect2"> -<a name="gdk-pixbuf-get-bits-per-sample"></a><h3>gdk_pixbuf_get_bits_per_sample ()</h3> -<pre class="programlisting"><span class="returnvalue">int</span> gdk_pixbuf_get_bits_per_sample (<em class="parameter"><code>const <a class="link" href="gdk-pixbuf-The-GdkPixbuf-Structure.html#GdkPixbuf"><span class="type">GdkPixbuf</span></a> *pixbuf</code></em>);</pre> -<p> -Queries the number of bits per color sample in a pixbuf. -</p> -<div class="variablelist"><table border="0" class="variablelist"> -<colgroup> -<col align="left" valign="top"> -<col> -</colgroup> -<tbody> -<tr> -<td><p><span class="term"><em class="parameter"><code>pixbuf</code></em> :</span></p></td> -<td>A pixbuf.</td> -</tr> -<tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>Number of bits per color sample.</td> -</tr> -</tbody> -</table></div> -</div> -<hr> -<div class="refsect2"> -<a name="gdk-pixbuf-get-pixels"></a><h3>gdk_pixbuf_get_pixels ()</h3> -<pre class="programlisting"><span class="returnvalue">guchar</span> * gdk_pixbuf_get_pixels (<em class="parameter"><code>const <a class="link" href="gdk-pixbuf-The-GdkPixbuf-Structure.html#GdkPixbuf"><span class="type">GdkPixbuf</span></a> *pixbuf</code></em>);</pre> -<p> -Queries a pointer to the pixel data of a pixbuf. -</p> -<div class="variablelist"><table border="0" class="variablelist"> -<colgroup> -<col align="left" valign="top"> -<col> -</colgroup> -<tbody> -<tr> -<td><p><span class="term"><em class="parameter"><code>pixbuf</code></em> :</span></p></td> -<td>A pixbuf.</td> -</tr> -<tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>A pointer to the pixbuf's pixel data. -Please see <a class="xref" href="gdk-pixbuf-The-GdkPixbuf-Structure.html#image-data" title="Image Data">the section called “Image Data”</a> for information about how -the pixel data is stored in memory. <span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym>]</span> -</td> -</tr> -</tbody> -</table></div> -</div> -<hr> -<div class="refsect2"> -<a name="gdk-pixbuf-get-pixels-with-length"></a><h3>gdk_pixbuf_get_pixels_with_length ()</h3> -<pre class="programlisting"><span class="returnvalue">guchar</span> * gdk_pixbuf_get_pixels_with_length (<em class="parameter"><code>const <a class="link" href="gdk-pixbuf-The-GdkPixbuf-Structure.html#GdkPixbuf"><span class="type">GdkPixbuf</span></a> *pixbuf</code></em>, - <em class="parameter"><code><span class="type">guint</span> *length</code></em>);</pre> -<p> -Queries a pointer to the pixel data of a pixbuf. -</p> -<div class="variablelist"><table border="0" class="variablelist"> -<colgroup> -<col align="left" valign="top"> -<col> -</colgroup> -<tbody> -<tr> -<td><p><span class="term"><em class="parameter"><code>pixbuf</code></em> :</span></p></td> -<td>A pixbuf.</td> -</tr> -<tr> -<td><p><span class="term"><em class="parameter"><code>length</code></em> :</span></p></td> -<td>The length of the binary data. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span> -</td> -</tr> -<tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>A pointer to the pixbuf's -pixel data. Please see <a class="xref" href="gdk-pixbuf-The-GdkPixbuf-Structure.html#image-data" title="Image Data">the section called “Image Data”</a> -for information about how the pixel data is stored in -memory. -Rename to: gdk_pixbuf_get_pixels. <span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> length=length]</span> -</td> -</tr> -</tbody> -</table></div> -<p class="since">Since 2.26</p> -</div> -<hr> -<div class="refsect2"> -<a name="gdk-pixbuf-get-width"></a><h3>gdk_pixbuf_get_width ()</h3> -<pre class="programlisting"><span class="returnvalue">int</span> gdk_pixbuf_get_width (<em class="parameter"><code>const <a class="link" href="gdk-pixbuf-The-GdkPixbuf-Structure.html#GdkPixbuf"><span class="type">GdkPixbuf</span></a> *pixbuf</code></em>);</pre> -<p> -Queries the width of a pixbuf. -</p> -<div class="variablelist"><table border="0" class="variablelist"> -<colgroup> -<col align="left" valign="top"> -<col> -</colgroup> -<tbody> -<tr> -<td><p><span class="term"><em class="parameter"><code>pixbuf</code></em> :</span></p></td> -<td>A pixbuf.</td> -</tr> -<tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>Width in pixels.</td> -</tr> -</tbody> -</table></div> -</div> -<hr> -<div class="refsect2"> -<a name="gdk-pixbuf-get-height"></a><h3>gdk_pixbuf_get_height ()</h3> -<pre class="programlisting"><span class="returnvalue">int</span> gdk_pixbuf_get_height (<em class="parameter"><code>const <a class="link" href="gdk-pixbuf-The-GdkPixbuf-Structure.html#GdkPixbuf"><span class="type">GdkPixbuf</span></a> *pixbuf</code></em>);</pre> -<p> -Queries the height of a pixbuf. -</p> -<div class="variablelist"><table border="0" class="variablelist"> -<colgroup> -<col align="left" valign="top"> -<col> -</colgroup> -<tbody> -<tr> -<td><p><span class="term"><em class="parameter"><code>pixbuf</code></em> :</span></p></td> -<td>A pixbuf.</td> -</tr> -<tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>Height in pixels.</td> -</tr> -</tbody> -</table></div> -</div> -<hr> -<div class="refsect2"> -<a name="gdk-pixbuf-get-rowstride"></a><h3>gdk_pixbuf_get_rowstride ()</h3> -<pre class="programlisting"><span class="returnvalue">int</span> gdk_pixbuf_get_rowstride (<em class="parameter"><code>const <a class="link" href="gdk-pixbuf-The-GdkPixbuf-Structure.html#GdkPixbuf"><span class="type">GdkPixbuf</span></a> *pixbuf</code></em>);</pre> -<p> -Queries the rowstride of a pixbuf, which is the number of bytes between the start of a row -and the start of the next row. -</p> -<div class="variablelist"><table border="0" class="variablelist"> -<colgroup> -<col align="left" valign="top"> -<col> -</colgroup> -<tbody> -<tr> -<td><p><span class="term"><em class="parameter"><code>pixbuf</code></em> :</span></p></td> -<td>A pixbuf.</td> -</tr> -<tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>Distance between row starts.</td> -</tr> -</tbody> -</table></div> -</div> -<hr> -<div class="refsect2"> -<a name="gdk-pixbuf-get-byte-length"></a><h3>gdk_pixbuf_get_byte_length ()</h3> -<pre class="programlisting"><span class="returnvalue">gsize</span> gdk_pixbuf_get_byte_length (<em class="parameter"><code>const <a class="link" href="gdk-pixbuf-The-GdkPixbuf-Structure.html#GdkPixbuf"><span class="type">GdkPixbuf</span></a> *pixbuf</code></em>);</pre> -<p> -Returns the length of the pixel data, in bytes. -</p> -<div class="variablelist"><table border="0" class="variablelist"> -<colgroup> -<col align="left" valign="top"> -<col> -</colgroup> -<tbody> -<tr> -<td><p><span class="term"><em class="parameter"><code>pixbuf</code></em> :</span></p></td> -<td>A pixbuf</td> -</tr> -<tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>The length of the pixel data.</td> -</tr> -</tbody> -</table></div> -<p class="since">Since 2.26</p> -</div> -<hr> -<div class="refsect2"> -<a name="gdk-pixbuf-get-option"></a><h3>gdk_pixbuf_get_option ()</h3> -<pre class="programlisting">const <span class="returnvalue">gchar</span> * gdk_pixbuf_get_option (<em class="parameter"><code><a class="link" href="gdk-pixbuf-The-GdkPixbuf-Structure.html#GdkPixbuf"><span class="type">GdkPixbuf</span></a> *pixbuf</code></em>, - <em class="parameter"><code>const <span class="type">gchar</span> *key</code></em>);</pre> -<p> -Looks up <em class="parameter"><code>key</code></em> in the list of options that may have been attached to the -<em class="parameter"><code>pixbuf</code></em> when it was loaded, or that may have been attached by another -function using <a class="link" href="gdk-pixbuf-Module-Interface.html#gdk-pixbuf-set-option" title="gdk_pixbuf_set_option ()"><code class="function">gdk_pixbuf_set_option()</code></a>. -</p> -<p> -For instance, the ANI loader provides "Title" and "Artist" options. -The ICO, XBM, and XPM loaders provide "x_hot" and "y_hot" hot-spot -options for cursor definitions. The PNG loader provides the tEXt ancillary -chunk key/value pairs as options. Since 2.12, the TIFF and JPEG loaders -return an "orientation" option string that corresponds to the embedded -TIFF/Exif orientation tag (if present). -</p> -<div class="variablelist"><table border="0" class="variablelist"> -<colgroup> -<col align="left" valign="top"> -<col> -</colgroup> -<tbody> -<tr> -<td><p><span class="term"><em class="parameter"><code>pixbuf</code></em> :</span></p></td> -<td>a <a class="link" href="gdk-pixbuf-The-GdkPixbuf-Structure.html#GdkPixbuf"><span class="type">GdkPixbuf</span></a> -</td> -</tr> -<tr> -<td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td> -<td>a nul-terminated string.</td> -</tr> -<tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>the value associated with <em class="parameter"><code>key</code></em>. This is a nul-terminated -string that should not be freed or <a href="/home/mclasen/gnome/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a> if <em class="parameter"><code>key</code></em> was not found.</td> -</tr> -</tbody> -</table></div> -</div> -</div> -<div class="refsect1"> -<a name="gdk-pixbuf-The-GdkPixbuf-Structure.property-details"></a><h2>Property Details</h2> -<div class="refsect2"> -<a name="GdkPixbuf--bits-per-sample"></a><h3>The <code class="literal">"bits-per-sample"</code> property</h3> -<pre class="programlisting"> "bits-per-sample" <span class="type">gint</span> : Read / Write / Construct Only</pre> -<p> -The number of bits per sample. -Currently only 8 bit per sample are supported. -</p> -<p>Allowed values: [1,16]</p> -<p>Default value: 8</p> -</div> -<hr> -<div class="refsect2"> -<a name="GdkPixbuf--colorspace"></a><h3>The <code class="literal">"colorspace"</code> property</h3> -<pre class="programlisting"> "colorspace" <a class="link" href="gdk-pixbuf-The-GdkPixbuf-Structure.html#GdkColorspace" title="enum GdkColorspace"><span class="type">GdkColorspace</span></a> : Read / Write / Construct Only</pre> -<p>The colorspace in which the samples are interpreted.</p> -<p>Default value: GDK_COLORSPACE_RGB</p> -</div> -<hr> -<div class="refsect2"> -<a name="GdkPixbuf--has-alpha"></a><h3>The <code class="literal">"has-alpha"</code> property</h3> -<pre class="programlisting"> "has-alpha" <span class="type">gboolean</span> : Read / Write / Construct Only</pre> -<p>Whether the pixbuf has an alpha channel.</p> -<p>Default value: FALSE</p> -</div> -<hr> -<div class="refsect2"> -<a name="GdkPixbuf--height"></a><h3>The <code class="literal">"height"</code> property</h3> -<pre class="programlisting"> "height" <span class="type">gint</span> : Read / Write / Construct Only</pre> -<p>The number of rows of the pixbuf.</p> -<p>Allowed values: >= 1</p> -<p>Default value: 1</p> -</div> -<hr> -<div class="refsect2"> -<a name="GdkPixbuf--n-channels"></a><h3>The <code class="literal">"n-channels"</code> property</h3> -<pre class="programlisting"> "n-channels" <span class="type">gint</span> : Read / Write / Construct Only</pre> -<p> -The number of samples per pixel. -Currently, only 3 or 4 samples per pixel are supported. -</p> -<p>Allowed values: >= 0</p> -<p>Default value: 3</p> -</div> -<hr> -<div class="refsect2"> -<a name="GdkPixbuf--pixels"></a><h3>The <code class="literal">"pixels"</code> property</h3> -<pre class="programlisting"> "pixels" <span class="type">gpointer</span> : Read / Write / Construct Only</pre> -<p>A pointer to the pixel data of the pixbuf.</p> -</div> -<hr> -<div class="refsect2"> -<a name="GdkPixbuf--rowstride"></a><h3>The <code class="literal">"rowstride"</code> property</h3> -<pre class="programlisting"> "rowstride" <span class="type">gint</span> : Read / Write / Construct Only</pre> -<p> -The number of bytes between the start of a row and -the start of the next row. This number must (obviously) -be at least as large as the width of the pixbuf. -</p> -<p>Allowed values: >= 1</p> -<p>Default value: 1</p> -</div> -<hr> -<div class="refsect2"> -<a name="GdkPixbuf--width"></a><h3>The <code class="literal">"width"</code> property</h3> -<pre class="programlisting"> "width" <span class="type">gint</span> : Read / Write / Construct Only</pre> -<p>The number of columns of the pixbuf.</p> -<p>Allowed values: >= 1</p> -<p>Default value: 1</p> -</div> -</div> -</div> -<div class="footer"> -<hr> - Generated by GTK-Doc V1.18.1</div> -</body> -</html>
\ No newline at end of file |