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>
  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
  21 </para>
  22
  23 @GDK_PIXBUF_ERROR_HEADER_CORRUPT:
  24 @GDK_PIXBUF_ERROR_PIXEL_CORRUPT:
  25 @GDK_PIXBUF_ERROR_UNKNOWN_FORMAT:
  26 @GDK_PIXBUF_ERROR_CORRUPT_IMAGE:
  27 @GDK_PIXBUF_ERROR_INSUFFICIENT_MEMORY:
  28 @GDK_PIXBUF_ERROR_BAD_OPTION_VALUE:
  29 @GDK_PIXBUF_ERROR_UNKNOWN_TYPE:
  30 @GDK_PIXBUF_ERROR_UNSUPPORTED_OPERATION:
  31 @GDK_PIXBUF_ERROR_FAILED:
  32
  33 <!-- ##### MACRO GDK_PIXBUF_ERROR ##### -->
  34 <para>
  35
  36 </para>
  37
  38
  39
  40 <!-- ##### ENUM GdkColorspace ##### -->
  41   <para>
  42     This enumeration defines the color spaces that are supported by
  43     the &gdk-pixbuf; library.  Currently only RGB is supported.
  44   </para>
  45
  46 @GDK_COLORSPACE_RGB: Indicates a red/green/blue additive color space.
  47
  48 <!-- ##### ENUM GdkPixbufAlphaMode ##### -->
  49   <para>
  50     These values can be passed to
  51     gdk_pixbuf_render_to_drawable_alpha() to control how the alpha
  52     chanel of an image should be handled.  This function can create a
  53     bilevel clipping mask (black and white) and use it while painting
  54     the image.  In the future, when the X Window System gets an alpha
  55     channel extension, it will be possible to do full alpha
  56     compositing onto arbitrary drawables.  For now both cases fall
  57     back to a bilevel clipping mask.
  58   </para>
  59
  60 @GDK_PIXBUF_ALPHA_BILEVEL: A bilevel clipping mask (black and white)
  61 will be created and used to draw the image.  Pixels below 0.5 opacity
  62 will be considered fully transparent, and all others will be
  63 considered fully opaque.
  64 @GDK_PIXBUF_ALPHA_FULL: For now falls back to #GDK_PIXBUF_ALPHA_BILEVEL.
  65 In the future it will do full alpha compositing.
  66
  67 <!-- ##### STRUCT GdkPixbuf ##### -->
  68   <para>
  69     This is the main structure in the &gdk-pixbuf; library.  It is
  70     used to represent images.  It contains information about the
  71     image's pixel data, its color space, bits per sample, width and
  72     height, and the rowstride or number of bytes between rows.
  73   </para>
  74
  75
  76 <!-- ##### FUNCTION gdk_pixbuf_get_colorspace ##### -->
  77 <para>
  78
  79 </para>
  80
  81 @pixbuf:
  82 @Returns:
  83
  84
  85 <!-- ##### FUNCTION gdk_pixbuf_get_n_channels ##### -->
  86 <para>
  87
  88 </para>
  89
  90 @pixbuf:
  91 @Returns:
  92
  93
  94 <!-- ##### FUNCTION gdk_pixbuf_get_has_alpha ##### -->
  95 <para>
  96
  97 </para>
  98
  99 @pixbuf:
 100 @Returns:
 101
 102
 103 <!-- ##### FUNCTION gdk_pixbuf_get_bits_per_sample ##### -->
 104 <para>
 105
 106 </para>
 107
 108 @pixbuf:
 109 @Returns:
 110
 111
 112 <!-- ##### FUNCTION gdk_pixbuf_get_pixels ##### -->
 113 <para>
 114
 115 </para>
 116
 117 @pixbuf:
 118 @Returns:
 119
 120
 121 <!-- ##### FUNCTION gdk_pixbuf_get_width ##### -->
 122 <para>
 123
 124 </para>
 125
 126 @pixbuf:
 127 @Returns:
 128
 129
 130 <!-- ##### FUNCTION gdk_pixbuf_get_height ##### -->
 131 <para>
 132
 133 </para>
 134
 135 @pixbuf:
 136 @Returns:
 137
 138
 139 <!-- ##### FUNCTION gdk_pixbuf_get_rowstride ##### -->
 140 <para>
 141
 142 </para>
 143
 144 @pixbuf:
 145 @Returns: <!--
 146 Local variables:
 147 mode: sgml
 148 sgml-parent-document: ("../gdk-pixbuf.sgml" "book" "refsect2" "")
 149 End:
 150 -->
 151
 152