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

   1 <!-- ##### SECTION Title ##### -->
   2 Drawing Primitives
   3
   4 <!-- ##### SECTION Short_Description ##### -->
   5 functions for drawing points, lines, arcs, and text.
   6
   7 <!-- ##### SECTION Long_Description ##### -->
   8 <para>
   9 These functions provide support for drawing points, lines, arcs and text
  10 onto what are called 'drawables'. Drawables, as the name suggests, are things
  11 which support drawing onto them, and are either #GdkWindow or #GdkPixmap
  12 objects.
  13 </para>
  14 <para>
  15 Many of the drawing operations take a #GdkGC argument, which represents a
  16 graphics context. This #GdkGC contains a number of drawing attributes such
  17 as foreground color, background color and line width, and is used to reduce
  18 the number of arguments needed for each drawing operation. See the
  19 <link linkend="gdk-Graphics-Contexts">Graphics Contexts</link> section for
  20 more information.
  21 </para>
  22
  23 <!-- ##### SECTION See_Also ##### -->
  24 <para>
  25
  26 </para>
  27
  28 <!-- ##### STRUCT GdkDrawable ##### -->
  29 <para>
  30 An opaque structure representing an object that can be
  31 drawn onto. This can be a #GdkPixmap, a #GdkBitmap,
  32 or a #GdkWindow.
  33 </para>
  34
  35
  36 <!-- ##### FUNCTION gdk_drawable_ref ##### -->
  37 <para>
  38
  39 </para>
  40
  41 @drawable:
  42 @Returns:
  43
  44
  45 <!-- ##### FUNCTION gdk_drawable_unref ##### -->
  46 <para>
  47
  48 </para>
  49
  50 @drawable:
  51
  52
  53 <!-- ##### FUNCTION gdk_drawable_set_data ##### -->
  54 <para>
  55
  56 </para>
  57
  58 @drawable:
  59 @key:
  60 @data:
  61 @destroy_func:
  62
  63
  64 <!-- ##### FUNCTION gdk_drawable_get_data ##### -->
  65 <para>
  66
  67 </para>
  68
  69 @drawable:
  70 @key:
  71 @Returns:
  72
  73
  74 <!-- ##### FUNCTION gdk_drawable_get_display ##### -->
  75 <para>
  76
  77 </para>
  78
  79 @drawable:
  80 @Returns:
  81
  82
  83 <!-- ##### FUNCTION gdk_drawable_get_screen ##### -->
  84 <para>
  85
  86 </para>
  87
  88 @drawable:
  89 @Returns:
  90
  91
  92 <!-- ##### FUNCTION gdk_drawable_get_visual ##### -->
  93 <para>
  94
  95 </para>
  96
  97 @drawable:
  98 @Returns:
  99
 100
 101 <!-- ##### FUNCTION gdk_drawable_set_colormap ##### -->
 102 <para>
 103
 104 </para>
 105
 106 @drawable:
 107 @colormap:
 108
 109
 110 <!-- ##### FUNCTION gdk_drawable_get_colormap ##### -->
 111 <para>
 112
 113 </para>
 114
 115 @drawable:
 116 @Returns:
 117
 118
 119 <!-- ##### FUNCTION gdk_drawable_get_depth ##### -->
 120 <para>
 121
 122 </para>
 123
 124 @drawable:
 125 @Returns:
 126
 127
 128 <!-- ##### FUNCTION gdk_drawable_get_size ##### -->
 129 <para>
 130
 131 </para>
 132
 133 @drawable:
 134 @width:
 135 @height:
 136
 137
 138 <!-- ##### FUNCTION gdk_drawable_get_clip_region ##### -->
 139 <para>
 140
 141 </para>
 142
 143 @drawable:
 144 @Returns:
 145
 146
 147 <!-- ##### FUNCTION gdk_drawable_get_visible_region ##### -->
 148 <para>
 149
 150 </para>
 151
 152 @drawable:
 153 @Returns:
 154
 155
 156 <!-- ##### FUNCTION gdk_draw_point ##### -->
 157 <para>
 158 </para>
 159
 160 @drawable:
 161 @gc:
 162 @x:
 163 @y:
 164
 165
 166 <!-- ##### FUNCTION gdk_draw_points ##### -->
 167 <para>
 168 </para>
 169
 170 @drawable:
 171 @gc:
 172 @points:
 173 @npoints:
 174
 175
 176 <!-- ##### FUNCTION gdk_draw_line ##### -->
 177 <para>
 178 </para>
 179
 180 @drawable:
 181 @gc:
 182 @x1:
 183 @y1:
 184 @x2:
 185 @y2:
 186
 187
 188 <!-- ##### FUNCTION gdk_draw_lines ##### -->
 189 <para>
 190 </para>
 191
 192 @drawable:
 193 @gc:
 194 @points:
 195 lines.
 196 @npoints:
 197
 198
 199 <!-- ##### FUNCTION gdk_draw_pixbuf ##### -->
 200 <para>
 201
 202 </para>
 203
 204 @drawable:
 205 @gc:
 206 @pixbuf:
 207 @src_x:
 208 @src_y:
 209 @dest_x:
 210 @dest_y:
 211 @width:
 212 @height:
 213 @dither:
 214 @x_dither:
 215 @y_dither:
 216
 217
 218 <!-- ##### FUNCTION gdk_draw_segments ##### -->
 219 <para>
 220 </para>
 221
 222 @drawable:
 223 @gc:
 224 @segs:
 225 @nsegs:
 226
 227
 228 <!-- ##### STRUCT GdkSegment ##### -->
 229 <para>
 230 Specifies the start and end point of a line for use by the gdk_draw_segments()
 231 function.
 232 </para>
 233
 234 @x1: the x coordinate of the start point.
 235 @y1: the y coordinate of the start point.
 236 @x2: the x coordinate of the end point.
 237 @y2: the y coordinate of the end point.
 238
 239 <!-- ##### FUNCTION gdk_draw_rectangle ##### -->
 240 <para>
 241 </para>
 242 <note>
 243 <para>
 244 </para>
 245 </note>
 246
 247 @drawable:
 248 @gc:
 249 @filled:
 250 @x:
 251 @y:
 252 @width:
 253 @height:
 254
 255
 256 <!-- ##### FUNCTION gdk_draw_arc ##### -->
 257 <para>
 258 </para>
 259
 260 @drawable:
 261 @gc:
 262 @filled:
 263 @x:
 264 @y:
 265 @width:
 266 @height:
 267 @angle1:
 268 @angle2:
 269
 270
 271 <!-- ##### FUNCTION gdk_draw_polygon ##### -->
 272 <para>
 273 </para>
 274
 275 @drawable:
 276 @gc:
 277 @filled:
 278 @points:
 279 @npoints:
 280
 281
 282 <!-- ##### FUNCTION gdk_draw_glyphs ##### -->
 283 <para>
 284
 285 </para>
 286
 287 @drawable:
 288 @gc:
 289 @font:
 290 @x:
 291 @y:
 292 @glyphs:
 293
 294
 295 <!-- ##### FUNCTION gdk_draw_layout_line ##### -->
 296 <para>
 297
 298 </para>
 299
 300 @drawable:
 301 @gc:
 302 @x:
 303 @y:
 304 @line:
 305
 306
 307 <!-- ##### FUNCTION gdk_draw_layout_line_with_colors ##### -->
 308 <para>
 309
 310 </para>
 311
 312 @drawable:
 313 @gc:
 314 @x:
 315 @y:
 316 @line:
 317 @foreground:
 318 @background:
 319
 320
 321 <!-- ##### FUNCTION gdk_draw_layout ##### -->
 322 <para>
 323
 324 </para>
 325
 326 @drawable:
 327 @gc:
 328 @x:
 329 @y:
 330 @layout:
 331
 332
 333 <!-- ##### FUNCTION gdk_draw_layout_with_colors ##### -->
 334 <para>
 335
 336 </para>
 337
 338 @drawable:
 339 @gc:
 340 @x:
 341 @y:
 342 @layout:
 343 @foreground:
 344 @background:
 345
 346
 347 <!-- ##### FUNCTION gdk_draw_string ##### -->
 348 <para>
 349 </para>
 350
 351 @drawable:
 352 @font:
 353 @gc:
 354 @x:
 355 @y:
 356 @string:
 357
 358
 359 <!-- ##### FUNCTION gdk_draw_text ##### -->
 360 <para>
 361 </para>
 362
 363 @drawable:
 364 @font:
 365 @gc:
 366 @x:
 367 @y:
 368 @text:
 369 @text_length:
 370
 371
 372 <!-- ##### FUNCTION gdk_draw_text_wc ##### -->
 373 <para>
 374 </para>
 375
 376 @drawable:
 377 @font:
 378 @gc:
 379 @x:
 380 @y:
 381 @text:
 382 @text_length:
 383
 384
 385 <!-- ##### MACRO gdk_draw_pixmap ##### -->
 386 <para>
 387 Draws a pixmap, or a part of a pixmap, onto another drawable.
 388 </para>
 389
 390 <!-- ##### FUNCTION gdk_draw_drawable ##### -->
 391 <para>
 392
 393 </para>
 394
 395 @drawable:
 396 @gc:
 397 @src:
 398 @xsrc:
 399 @ysrc:
 400 @xdest:
 401 @ydest:
 402 @width:
 403 @height:
 404
 405
 406 <!-- ##### FUNCTION gdk_draw_image ##### -->
 407 <para>
 408 </para>
 409
 410 @drawable:
 411 @gc:
 412 @image:
 413 @xsrc:
 414 @ysrc:
 415 @xdest:
 416 @ydest:
 417 @width:
 418 @height:
 419
 420
 421 <!-- ##### FUNCTION gdk_drawable_get_image ##### -->
 422 <para>
 423
 424 </para>
 425
 426 @drawable:
 427 @x:
 428 @y:
 429 @width:
 430 @height:
 431 @Returns:
 432
 433