summaryrefslogtreecommitdiff
path: root/docs/reference/gdk/tmpl/pixmaps.sgml
blob: bb53be726d446f1cfff298f756cf1e0e3884ba4e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
<!-- ##### 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>

<!-- ##### SECTION See_Also ##### -->
<para>
</para>

<!-- ##### SECTION Stability_Level ##### -->


<!-- ##### SECTION Image ##### -->


<!-- ##### TYPEDEF 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>

@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


<!-- ##### 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


<!-- ##### 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: 


<!-- ##### 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>