Pileus Git - ~andy/gtk/blob - docs/reference/gdk-pixbuf/tmpl/gdk-pixbuf.sgml

   1 <!-- ##### SECTION Title ##### -->
   2 The GdkPixbuf Structure
   3
   4 <!-- ##### SECTION Short_Description ##### -->
   5 Information that describes an image.
   6
   7 <!-- ##### SECTION Long_Description ##### -->
   8
   9   <para><anchor id="GdkPixbuf">
  10     The <structname>GdkPixbuf</structname> structure contains
  11     information that describes an image in memory.
  12   </para>
  13
  14 <!-- ##### SECTION See_Also ##### -->
  15   <para>
  16   </para>
  17
  18 <!-- ##### ENUM GdkPixbufError ##### -->
  19 <para>
  20 An error code in the #GDK_PIXBUF_ERROR domain. Many &gdk-pixbuf;
  21 operations can cause errors in this domain, or in the #G_FILE_ERROR
  22 domain.
  23 </para>
  24
  25 @GDK_PIXBUF_ERROR_CORRUPT_IMAGE: An image file was broken somehow.
  26 @GDK_PIXBUF_ERROR_INSUFFICIENT_MEMORY: Not enough memory.
  27 @GDK_PIXBUF_ERROR_BAD_OPTION: A bad option was passed to a pixbuf save module.
  28 @GDK_PIXBUF_ERROR_UNKNOWN_TYPE: Unknown image type.
  29 @GDK_PIXBUF_ERROR_UNSUPPORTED_OPERATION: Don't know how to perform the
  30 given operation on the type of image at hand.
  31 @GDK_PIXBUF_ERROR_FAILED: Generic failure code, something went wrong.
  32
  33 <!-- ##### MACRO GDK_PIXBUF_ERROR ##### -->
  34 <para>
  35 Error domain used for pixbuf operations. Indicates that the error code
  36 will be in the #GdkPixbufError enumeration. See #GError for
  37 information on error domains and error codes.
  38 </para>
  39
  40
  41
  42 <!-- ##### ENUM GdkColorspace ##### -->
  43   <para>
  44     This enumeration defines the color spaces that are supported by
  45     the &gdk-pixbuf; library.  Currently only RGB is supported.
  46   </para>
  47
  48 @GDK_COLORSPACE_RGB: Indicates a red/green/blue additive color space.
  49
  50 <!-- ##### ENUM GdkPixbufAlphaMode ##### -->
  51   <para>
  52     These values can be passed to
  53     gdk_pixbuf_render_to_drawable_alpha() to control how the alpha
  54     chanel of an image should be handled.  This function can create a
  55     bilevel clipping mask (black and white) and use it while painting
  56     the image.  In the future, when the X Window System gets an alpha
  57     channel extension, it will be possible to do full alpha
  58     compositing onto arbitrary drawables.  For now both cases fall
  59     back to a bilevel clipping mask.
  60   </para>
  61
  62 @GDK_PIXBUF_ALPHA_BILEVEL: A bilevel clipping mask (black and white)
  63 will be created and used to draw the image.  Pixels below 0.5 opacity
  64 will be considered fully transparent, and all others will be
  65 considered fully opaque.
  66 @GDK_PIXBUF_ALPHA_FULL: For now falls back to #GDK_PIXBUF_ALPHA_BILEVEL.
  67 In the future it will do full alpha compositing.
  68
  69 <!-- ##### STRUCT GdkPixbuf ##### -->
  70   <para>
  71     This is the main structure in the &gdk-pixbuf; library.  It is
  72     used to represent images.  It contains information about the
  73     image's pixel data, its color space, bits per sample, width and
  74     height, and the rowstride or number of bytes between rows.
  75   </para>
  76
  77
  78 <!-- ##### FUNCTION gdk_pixbuf_get_colorspace ##### -->
  79 <para>
  80
  81 </para>
  82
  83 @pixbuf:
  84 @Returns:
  85
  86
  87 <!-- ##### FUNCTION gdk_pixbuf_get_n_channels ##### -->
  88 <para>
  89
  90 </para>
  91
  92 @pixbuf:
  93 @Returns:
  94
  95
  96 <!-- ##### FUNCTION gdk_pixbuf_get_has_alpha ##### -->
  97 <para>
  98
  99 </para>
 100
 101 @pixbuf:
 102 @Returns:
 103
 104
 105 <!-- ##### FUNCTION gdk_pixbuf_get_bits_per_sample ##### -->
 106 <para>
 107
 108 </para>
 109
 110 @pixbuf:
 111 @Returns:
 112
 113
 114 <!-- ##### FUNCTION gdk_pixbuf_get_pixels ##### -->
 115 <para>
 116
 117 </para>
 118
 119 @pixbuf:
 120 @Returns:
 121
 122
 123 <!-- ##### FUNCTION gdk_pixbuf_get_width ##### -->
 124 <para>
 125
 126 </para>
 127
 128 @pixbuf:
 129 @Returns:
 130
 131
 132 <!-- ##### FUNCTION gdk_pixbuf_get_height ##### -->
 133 <para>
 134
 135 </para>
 136
 137 @pixbuf:
 138 @Returns:
 139
 140
 141 <!-- ##### FUNCTION gdk_pixbuf_get_rowstride ##### -->
 142 <para>
 143
 144 </para>
 145
 146 @pixbuf:
 147 @Returns: <!--
 148 Local variables:
 149 mode: sgml
 150 sgml-parent-document: ("../gdk-pixbuf.sgml" "book" "refsect2" "")
 151 End:
 152 -->
 153
 154
 155 <!-- ##### FUNCTION gdk_pixbuf_get_option ##### -->
 156 <para>
 157
 158 </para>
 159
 160 @pixbuf:
 161 @key:
 162 @Returns:
 163
 164