mirror of
https://gitlab.gnome.org/GNOME/gtk.git
synced 2024-10-01 03:27:36 +00:00
186 lines
4.8 KiB
Plaintext
186 lines
4.8 KiB
Plaintext
<!-- ##### SECTION Title ##### -->
|
|
Bitmaps and Pixmaps
|
|
|
|
<!-- ##### SECTION Short_Description ##### -->
|
|
Offscreen drawables
|
|
|
|
<!-- ##### SECTION Long_Description ##### -->
|
|
<para>
|
|
Pixmaps are offscreen drawables. They can be drawn upon with the
|
|
standard drawing primitives, then copied to another drawable (such as
|
|
a #GdkWindow) with gdk_pixmap_draw(). The depth of a pixmap
|
|
is the number of bits per pixels. Bitmaps are simply pixmaps
|
|
with a depth of 1. (That is, they are monochrome bitmaps - each
|
|
pixel can be either on or off).
|
|
</para>
|
|
<para>
|
|
GTK 3 will remove #GdkPixmap and #GdkBitmap. You should use cairo
|
|
surfaces instead. However, because a lot of functions still use these
|
|
types, they are not deprecated.
|
|
</para>
|
|
|
|
<!-- ##### SECTION See_Also ##### -->
|
|
<para>
|
|
</para>
|
|
|
|
<!-- ##### SECTION Stability_Level ##### -->
|
|
|
|
|
|
<!-- ##### SECTION Image ##### -->
|
|
|
|
|
|
<!-- ##### STRUCT GdkPixmap ##### -->
|
|
<para>
|
|
An opaque structure representing an offscreen drawable.
|
|
Pointers to structures of type #GdkPixmap, #GdkBitmap,
|
|
and #GdkWindow, can often be used interchangeably.
|
|
The type #GdkDrawable refers generically to any of
|
|
these types.
|
|
</para>
|
|
|
|
|
|
<!-- ##### FUNCTION gdk_pixmap_new ##### -->
|
|
<para>
|
|
Create a new pixmap with a given size and depth.
|
|
</para>
|
|
<para>
|
|
Please use gdk_window_create_similar_surface() instead of this
|
|
function if you're not forced to use a #GdkPixmap. It is intended
|
|
as the replacement function for this function in GTK 3.
|
|
</para>
|
|
|
|
@drawable: A #GdkDrawable, used to determine default values
|
|
for the new pixmap. Can be %NULL if @depth is specified,
|
|
@width: The width of the new pixmap in pixels.
|
|
@height: The height of the new pixmap in pixels.
|
|
@depth: The depth (number of bits per pixel) of the new pixmap.
|
|
If -1, and @drawable is not %NULL, the depth of the new
|
|
pixmap will be equal to that of @drawable.
|
|
@Returns: the #GdkPixmap
|
|
|
|
|
|
<!-- ##### FUNCTION gdk_bitmap_create_from_data ##### -->
|
|
<para>
|
|
Creates a new bitmap from data in XBM format.
|
|
</para>
|
|
|
|
@drawable: a #GdkDrawable, used to determine default values
|
|
for the new pixmap. Can be %NULL, in which case the root
|
|
window is used.
|
|
@data: a pointer to the XBM data.
|
|
@width: the width of the new pixmap in pixels.
|
|
@height: the height of the new pixmap in pixels.
|
|
@Returns: the #GdkBitmap
|
|
|
|
@Deprecated: 2.22: You can create a Cairo image surface using
|
|
cairo_image_surface_create_for_data() instead. Specify
|
|
%CAIRO_FORMAT_A1 as the format to get a bitmap. Keep in mind that
|
|
Cairo images must have a rowstride of 4 bytes, so you will need
|
|
to align your data properly. If you must use a pixmap, use
|
|
gdk_pixmap_new() with a depth of 1 to create a bitmap and then use
|
|
gdk_cairo_create(), cairo_set_source_surface() and cairo_paint()
|
|
to draw the image surface to the bitmap.
|
|
|
|
<!-- ##### FUNCTION gdk_pixmap_create_from_data ##### -->
|
|
<para>
|
|
Create a two-color pixmap from data in XBM data.
|
|
</para>
|
|
|
|
@drawable: a #GdkDrawable, used to determine default values
|
|
for the new pixmap. Can be %NULL, if the depth is given.
|
|
@data: a pointer to the data.
|
|
@width: the width of the new pixmap in pixels.
|
|
@height: the height of the new pixmap in pixels.
|
|
@depth: the depth (number of bits per pixel) of the new pixmap.
|
|
@fg: the foreground color.
|
|
@bg: the background color.
|
|
@Returns: the #GdkPixmap
|
|
|
|
@Deprecated: 2.22: If you must replicate the functionality of this
|
|
function, create a pixmap using gdk_pixmap_new(), cairo_paint() it
|
|
with the background color and then create a Cairo image surface as
|
|
pointed out in the docs to gdk_bitmap_create_from_data() and use
|
|
this surface with cairo_mask_surface() to paint the foreground color.
|
|
|
|
<!-- ##### FUNCTION gdk_pixmap_create_from_xpm ##### -->
|
|
|
|
|
|
@drawable:
|
|
@mask:
|
|
@transparent_color:
|
|
@filename:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gdk_pixmap_colormap_create_from_xpm ##### -->
|
|
|
|
|
|
@drawable:
|
|
@colormap:
|
|
@mask:
|
|
@transparent_color:
|
|
@filename:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gdk_pixmap_create_from_xpm_d ##### -->
|
|
|
|
|
|
@drawable:
|
|
@mask:
|
|
@transparent_color:
|
|
@data:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gdk_pixmap_colormap_create_from_xpm_d ##### -->
|
|
|
|
|
|
@drawable:
|
|
@colormap:
|
|
@mask:
|
|
@transparent_color:
|
|
@data:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### MACRO gdk_pixmap_ref ##### -->
|
|
<para>
|
|
Deprecated equivalent of g_object_ref().
|
|
</para>
|
|
|
|
@Returns: @pixmap
|
|
|
|
|
|
<!-- ##### MACRO gdk_pixmap_unref ##### -->
|
|
<para>
|
|
Deprecated equivalent of g_object_unref().
|
|
</para>
|
|
|
|
|
|
|
|
<!-- ##### TYPEDEF GdkBitmap ##### -->
|
|
<para>
|
|
An opaque structure representing an offscreen drawable of depth
|
|
1. Pointers to structures of type #GdkPixmap, #GdkBitmap, and
|
|
#GdkWindow, can often be used interchangeably. The type #GdkDrawable
|
|
refers generically to any of these types.
|
|
</para>
|
|
|
|
|
|
<!-- ##### MACRO gdk_bitmap_ref ##### -->
|
|
<para>
|
|
Deprecated equivalent of g_object_ref().
|
|
</para>
|
|
|
|
@Returns: @pixmap
|
|
|
|
|
|
<!-- ##### MACRO gdk_bitmap_unref ##### -->
|
|
<para>
|
|
Deprecated equivalent of g_object_unref().
|
|
</para>
|
|
|
|
|
|
|