1 cfa37a7b 2004-04-10 devnull .TH GRAPHICS 3
3 cfa37a7b 2004-04-10 devnull Display, Point, Rectangle, Cursor, initdraw, geninitdraw, drawerror, initdisplay, closedisplay, getdefont, getwindow, gengetwindow, flushimage, bufimage, lockdisplay, unlockdisplay, cursorswitch, cursorset, openfont, buildfont, freefont, Pfmt, Rfmt, strtochan, chantostr, chantodepth \- interactive graphics
4 cfa37a7b 2004-04-10 devnull .SH SYNOPSIS
8 cfa37a7b 2004-04-10 devnull #include <u.h>
9 cfa37a7b 2004-04-10 devnull #include <libc.h>
10 cfa37a7b 2004-04-10 devnull #include <draw.h>
11 cfa37a7b 2004-04-10 devnull #include <cursor.h>
14 cfa37a7b 2004-04-10 devnull .ta \w'\fLFont* 'u
16 cfa37a7b 2004-04-10 devnull int initdraw(void (*errfun)(Display*, char*), char *font,
18 cfa37a7b 2004-04-10 devnull char *label)
21 cfa37a7b 2004-04-10 devnull int geninitdraw(char *devdir, void(*errfun)(Display*, char*),
24 cfa37a7b 2004-04-10 devnull char *font, char *label, char *mousedir, char *windir,
29 cfa37a7b 2004-04-10 devnull int newwindow(char *str)
32 cfa37a7b 2004-04-10 devnull void drawerror(Display *d, char *msg)
35 cfa37a7b 2004-04-10 devnull Display* initdisplay(char *devdir, char *win, void(*errfun)(Display*, char*))
38 cfa37a7b 2004-04-10 devnull void closedisplay(Display *d)
41 cfa37a7b 2004-04-10 devnull Font* getdefont(Display *d)
44 cfa37a7b 2004-04-10 devnull int flushimage(Display *d, int vis)
47 cfa37a7b 2004-04-10 devnull int bufimage(Display *d, int n)
50 cfa37a7b 2004-04-10 devnull int lockdisplay(Display *d)
53 cfa37a7b 2004-04-10 devnull int unlockdisplay(Display *d)
56 cfa37a7b 2004-04-10 devnull int getwindow(Display *d, int ref)
59 cfa37a7b 2004-04-10 devnull int gengetwindow(Display *d, char *winname,
62 cfa37a7b 2004-04-10 devnull Image **ip, Screen **sp, int ref)
65 9f385187 2012-11-26 rsc int scalesize(Display *d, int n)
68 cfa37a7b 2004-04-10 devnull void cursorswitch(Cursor *curs)
71 cfa37a7b 2004-04-10 devnull void cursorset(Point p)
74 cfa37a7b 2004-04-10 devnull Font* openfont(Display *d, char *name)
77 cfa37a7b 2004-04-10 devnull Font* buildfont(Display *d, char *desc, char *name)
80 cfa37a7b 2004-04-10 devnull void freefont(Font *f)
83 cfa37a7b 2004-04-10 devnull int Pfmt(Fmt*)
86 cfa37a7b 2004-04-10 devnull int Rfmt(Fmt*)
89 cfa37a7b 2004-04-10 devnull ulong strtochan(char *s)
92 cfa37a7b 2004-04-10 devnull char* chantostr(char *s, ulong chan)
95 cfa37a7b 2004-04-10 devnull int chantodepth(ulong chan)
98 cfa37a7b 2004-04-10 devnull extern Display *display
101 cfa37a7b 2004-04-10 devnull extern Image *screen
104 cfa37a7b 2004-04-10 devnull extern Screen *_screen
107 cfa37a7b 2004-04-10 devnull extern Font *font
109 cfa37a7b 2004-04-10 devnull .SH DESCRIPTION
111 cfa37a7b 2004-04-10 devnull .B Display
112 cfa37a7b 2004-04-10 devnull structure represents a connection to the graphics device,
113 cfa37a7b 2004-04-10 devnull .IR draw (3),
114 cfa37a7b 2004-04-10 devnull holding all graphics resources associated with the connection,
115 cfa37a7b 2004-04-10 devnull including in particular raster image data in use by the client program.
116 cfa37a7b 2004-04-10 devnull The structure is defined (in part) as:
119 cfa37a7b 2004-04-10 devnull .ta 6n +10n
121 cfa37a7b 2004-04-10 devnull struct Display
124 cfa37a7b 2004-04-10 devnull void (*error)(Display*, char*);
126 cfa37a7b 2004-04-10 devnull Image *black;
127 cfa37a7b 2004-04-10 devnull Image *white;
128 cfa37a7b 2004-04-10 devnull Image *opaque;
129 cfa37a7b 2004-04-10 devnull Image *transparent;
130 cfa37a7b 2004-04-10 devnull Image *image;
131 cfa37a7b 2004-04-10 devnull Font *defaultfont;
132 cfa37a7b 2004-04-10 devnull Subfont *defaultsubfont;
138 cfa37a7b 2004-04-10 devnull .B Point
139 cfa37a7b 2004-04-10 devnull is a location in an Image
140 cfa37a7b 2004-04-10 devnull (see below and
141 bf8a59fa 2004-04-11 devnull .IR draw (3)),
142 cfa37a7b 2004-04-10 devnull such as the display, and is defined as:
147 cfa37a7b 2004-04-10 devnull struct Point {
150 cfa37a7b 2004-04-10 devnull } Point;
153 cfa37a7b 2004-04-10 devnull The coordinate system has
155 cfa37a7b 2004-04-10 devnull increasing to the right and
157 cfa37a7b 2004-04-10 devnull increasing down.
160 cfa37a7b 2004-04-10 devnull .B Rectangle
161 cfa37a7b 2004-04-10 devnull is a rectangular area in an image.
166 cfa37a7b 2004-04-10 devnull struct Rectangle {
167 cfa37a7b 2004-04-10 devnull Point min; /* upper left */
168 cfa37a7b 2004-04-10 devnull Point max; /* lower right */
169 cfa37a7b 2004-04-10 devnull } Rectangle;
172 cfa37a7b 2004-04-10 devnull By definition,
173 cfa37a7b 2004-04-10 devnull .BR min.x ≤ max.x
175 cfa37a7b 2004-04-10 devnull .BR min.y ≤ max.y .
176 cfa37a7b 2004-04-10 devnull By convention, the right (maximum
178 cfa37a7b 2004-04-10 devnull and bottom (maximum
180 cfa37a7b 2004-04-10 devnull edges are
181 cfa37a7b 2004-04-10 devnull excluded from the represented rectangle, so abutting rectangles have no
182 cfa37a7b 2004-04-10 devnull points in common.
185 cfa37a7b 2004-04-10 devnull contains the coordinates of the first point beyond the rectangle.
188 cfa37a7b 2004-04-10 devnull .B Image
189 cfa37a7b 2004-04-10 devnull data structure is defined in
190 bf8a59fa 2004-04-11 devnull .IR draw (3).
194 cfa37a7b 2004-04-10 devnull is a set of character images, indexed by runes (see
195 058b0118 2005-01-03 devnull .IR utf (7)).
196 cfa37a7b 2004-04-10 devnull The images are organized into
197 cfa37a7b 2004-04-10 devnull .BR Subfonts ,
198 cfa37a7b 2004-04-10 devnull each containing the images for a small, contiguous set of runes.
199 cfa37a7b 2004-04-10 devnull The detailed format of these data structures,
200 cfa37a7b 2004-04-10 devnull which are described in detail in
201 bf8a59fa 2004-04-11 devnull .IR cachechars (3),
202 cfa37a7b 2004-04-10 devnull is immaterial for most applications.
205 cfa37a7b 2004-04-10 devnull .B Subfont
206 cfa37a7b 2004-04-10 devnull structures contain two interrelated fields:
207 cfa37a7b 2004-04-10 devnull .LR ascent ,
208 cfa37a7b 2004-04-10 devnull the distance from the top of the highest character
209 cfa37a7b 2004-04-10 devnull (actually the top of the image holding all the characters)
210 cfa37a7b 2004-04-10 devnull to the baseline,
212 cfa37a7b 2004-04-10 devnull .LR height ,
213 cfa37a7b 2004-04-10 devnull the distance from the top of the highest character to the bottom of
214 cfa37a7b 2004-04-10 devnull the lowest character (and hence, the interline spacing).
216 bf8a59fa 2004-04-11 devnull .IR cachechars (3)
217 cfa37a7b 2004-04-10 devnull for more details.
219 cfa37a7b 2004-04-10 devnull .I Buildfont
220 cfa37a7b 2004-04-10 devnull parses the font description in the buffer
221 cfa37a7b 2004-04-10 devnull .BR desc ,
222 cfa37a7b 2004-04-10 devnull returning a
223 cfa37a7b 2004-04-10 devnull .B Font*
224 cfa37a7b 2004-04-10 devnull pointer that can be used by
225 cfa37a7b 2004-04-10 devnull .B string
227 bf8a59fa 2004-04-11 devnull .IR draw (3))
228 cfa37a7b 2004-04-10 devnull to draw characters from the font.
229 cfa37a7b 2004-04-10 devnull .I Openfont
230 cfa37a7b 2004-04-10 devnull does the same, but reads the description
231 b3a110af 2015-02-17 rsc from the named font.
232 cfa37a7b 2004-04-10 devnull .I Freefont
233 cfa37a7b 2004-04-10 devnull frees a font.
234 b3a110af 2015-02-17 rsc In contrast to Plan 9, font names in Plan 9 from User Space are
235 b3a110af 2015-02-17 rsc a small language describing the desired font.
237 b3a110af 2015-02-17 rsc .IR font (7)
238 b3a110af 2015-02-17 rsc for details.
241 cfa37a7b 2004-04-10 devnull .I Cursor
242 cfa37a7b 2004-04-10 devnull is defined:
245 cfa37a7b 2004-04-10 devnull .ta 6n +\w'Point 'u
246 cfa37a7b 2004-04-10 devnull typedef struct
247 cfa37a7b 2004-04-10 devnull Cursor {
248 cfa37a7b 2004-04-10 devnull Point offset;
249 cfa37a7b 2004-04-10 devnull uchar clr[2*16];
250 cfa37a7b 2004-04-10 devnull uchar set[2*16];
251 cfa37a7b 2004-04-10 devnull } Cursor;
254 cfa37a7b 2004-04-10 devnull The arrays are arranged in rows, two bytes per row, left to
255 cfa37a7b 2004-04-10 devnull right in big-endian order to give 16 rows
256 cfa37a7b 2004-04-10 devnull of 16 bits each.
257 cfa37a7b 2004-04-10 devnull A cursor is displayed on the screen by adding
258 cfa37a7b 2004-04-10 devnull .B offset
259 cfa37a7b 2004-04-10 devnull to the current mouse position, using
261 cfa37a7b 2004-04-10 devnull as a mask to draw white at the pixels where
263 cfa37a7b 2004-04-10 devnull is one, and then drawing black at the pixels where
267 cfa37a7b 2004-04-10 devnull The routine
268 cfa37a7b 2004-04-10 devnull .I initdraw
269 cfa37a7b 2004-04-10 devnull connects to the display; it returns \-1 if it fails and sets the error string.
270 cfa37a7b 2004-04-10 devnull .I Initdraw
271 cfa37a7b 2004-04-10 devnull sets up the global variables
272 cfa37a7b 2004-04-10 devnull .B display
274 cfa37a7b 2004-04-10 devnull .B Display
275 cfa37a7b 2004-04-10 devnull structure representing the connection),
276 cfa37a7b 2004-04-10 devnull .B screen
278 cfa37a7b 2004-04-10 devnull .B Image
279 cfa37a7b 2004-04-10 devnull representing the display memory itself or, if
280 cfa37a7b 2004-04-10 devnull .IR rio (1)
281 cfa37a7b 2004-04-10 devnull is running, the client's window),
284 cfa37a7b 2004-04-10 devnull (the default font for text).
285 cfa37a7b 2004-04-10 devnull The arguments to
286 cfa37a7b 2004-04-10 devnull .I initdraw
287 cfa37a7b 2004-04-10 devnull include a
288 cfa37a7b 2004-04-10 devnull .IR label ,
289 cfa37a7b 2004-04-10 devnull which is written to
290 cfa37a7b 2004-04-10 devnull .B /dev/label
291 cfa37a7b 2004-04-10 devnull if non-nil
292 cfa37a7b 2004-04-10 devnull so that it can be used to identify the window when hidden (see
293 cfa37a7b 2004-04-10 devnull .IR rio (1)).
294 cfa37a7b 2004-04-10 devnull The font is created by reading the named
296 cfa37a7b 2004-04-10 devnull file. If
298 cfa37a7b 2004-04-10 devnull is null,
299 cfa37a7b 2004-04-10 devnull .I initdraw
300 cfa37a7b 2004-04-10 devnull reads the file named in the environment variable
301 cfa37a7b 2004-04-10 devnull .BR $font ;
303 cfa37a7b 2004-04-10 devnull .B $font
304 cfa37a7b 2004-04-10 devnull is not set, it imports the default (usually minimal)
305 cfa37a7b 2004-04-10 devnull font from the operating system.
307 b3a110af 2015-02-17 rsc .IR font (7)
308 b3a110af 2015-02-17 rsc for a full discussion of font syntaxes.)
309 cfa37a7b 2004-04-10 devnull The global
311 cfa37a7b 2004-04-10 devnull will be set to point to the resulting
313 cfa37a7b 2004-04-10 devnull structure.
315 cfa37a7b 2004-04-10 devnull .I errfun
316 cfa37a7b 2004-04-10 devnull argument is a
317 cfa37a7b 2004-04-10 devnull .I graphics error function
318 cfa37a7b 2004-04-10 devnull to call in the event of a fatal error in the library; it must never return.
319 cfa37a7b 2004-04-10 devnull Its arguments are the
320 cfa37a7b 2004-04-10 devnull display pointer and an error string.
322 cfa37a7b 2004-04-10 devnull .I errfun
323 cfa37a7b 2004-04-10 devnull is nil, the library provides a default, called
324 cfa37a7b 2004-04-10 devnull .IR drawerror .
325 cfa37a7b 2004-04-10 devnull Another effect of
326 cfa37a7b 2004-04-10 devnull .I initdraw
327 cfa37a7b 2004-04-10 devnull is that it installs
328 bf8a59fa 2004-04-11 devnull .IR print (3)
337 cfa37a7b 2004-04-10 devnull for printing
338 cfa37a7b 2004-04-10 devnull .B Points
340 cfa37a7b 2004-04-10 devnull .BR Rectangles .
343 cfa37a7b 2004-04-10 devnull .I geninitdraw
344 cfa37a7b 2004-04-10 devnull function provides a less automated way to establish a connection, for programs
345 cfa37a7b 2004-04-10 devnull that wish to connect to multiple displays.
346 cfa37a7b 2004-04-10 devnull .I Devdir
347 cfa37a7b 2004-04-10 devnull is the name of the directory containing the device files for the display
348 cfa37a7b 2004-04-10 devnull (if nil, default
349 cfa37a7b 2004-04-10 devnull .BR /dev );
350 cfa37a7b 2004-04-10 devnull .IR errfun ,
351 cfa37a7b 2004-04-10 devnull .IR font ,
353 cfa37a7b 2004-04-10 devnull .I label
354 cfa37a7b 2004-04-10 devnull are as in
355 cfa37a7b 2004-04-10 devnull .IR initdraw ;
356 cfa37a7b 2004-04-10 devnull .I mousedir
358 cfa37a7b 2004-04-10 devnull .I windir
359 cfa37a7b 2004-04-10 devnull are the directories holding the
360 cfa37a7b 2004-04-10 devnull .B mouse
362 cfa37a7b 2004-04-10 devnull .B winname
363 cfa37a7b 2004-04-10 devnull files; and
365 cfa37a7b 2004-04-10 devnull specifies the refresh function to be used to create the window, if running under
366 cfa37a7b 2004-04-10 devnull .IR rio (1)
368 bf8a59fa 2004-04-11 devnull .IR window (3)).
370 058b0118 2005-01-03 devnull .\" The function
371 058b0118 2005-01-03 devnull .\" .I newwindow
372 058b0118 2005-01-03 devnull .\" may be called before
373 058b0118 2005-01-03 devnull .\" .I initdraw
375 058b0118 2005-01-03 devnull .\" .IR geninitdraw
376 058b0118 2005-01-03 devnull .\" to cause the program to occupy a newly created window rather than take over the one in
377 058b0118 2005-01-03 devnull .\" which it is running when it starts.
379 058b0118 2005-01-03 devnull .\" .I str
380 058b0118 2005-01-03 devnull .\" argument, if non-null, is concatenated to the string \f5\&"new\ "\fP
381 058b0118 2005-01-03 devnull .\" that is used to create the window (see
382 058b0118 2005-01-03 devnull .\" .IR rio (4)).
383 058b0118 2005-01-03 devnull .\" For example,
384 058b0118 2005-01-03 devnull .\" .B newwindow("-hide -dy 100")
385 058b0118 2005-01-03 devnull .\" will cause the program to run in a newly created, hidden window
386 058b0118 2005-01-03 devnull .\" 100 pixels high.
388 cfa37a7b 2004-04-10 devnull .I Initdisplay
389 cfa37a7b 2004-04-10 devnull is part of
390 cfa37a7b 2004-04-10 devnull .IR geninitdraw ;
391 cfa37a7b 2004-04-10 devnull it sets up the display structures but does not allocate any fonts or call
392 cfa37a7b 2004-04-10 devnull .IR getwindow .
393 cfa37a7b 2004-04-10 devnull The arguments are similar to those of
394 cfa37a7b 2004-04-10 devnull .IR initdraw ;
396 cfa37a7b 2004-04-10 devnull names the directory, default
397 cfa37a7b 2004-04-10 devnull .BR /dev ,
398 cfa37a7b 2004-04-10 devnull in which the files associated with the window reside.
399 cfa37a7b 2004-04-10 devnull .I Closedisplay
400 cfa37a7b 2004-04-10 devnull disconnects the display and frees the associated data structures.
401 cfa37a7b 2004-04-10 devnull .I Getdefont
402 cfa37a7b 2004-04-10 devnull builds a
404 cfa37a7b 2004-04-10 devnull structure from in-core data describing a default font.
405 cfa37a7b 2004-04-10 devnull None of these routines is needed by most programs, since
406 cfa37a7b 2004-04-10 devnull .I initdraw
407 cfa37a7b 2004-04-10 devnull calls them as needed.
409 cfa37a7b 2004-04-10 devnull The data structures associated with the display must be protected in a multi-process program,
410 cfa37a7b 2004-04-10 devnull because they assume only one process will be using them at a time.
411 cfa37a7b 2004-04-10 devnull Multi-process programs should set
412 cfa37a7b 2004-04-10 devnull .B display->locking
415 cfa37a7b 2004-04-10 devnull to notify the library to use a locking protocol for its own accesses,
416 cfa37a7b 2004-04-10 devnull and call
417 cfa37a7b 2004-04-10 devnull .I lockdisplay
419 cfa37a7b 2004-04-10 devnull .I unlockdisplay
420 cfa37a7b 2004-04-10 devnull around any calls to the graphics library that will cause messages to be sent to the display device.
421 cfa37a7b 2004-04-10 devnull .I Initdraw
423 cfa37a7b 2004-04-10 devnull .I geninitdraw
424 cfa37a7b 2004-04-10 devnull initialize the display to the locked state.
426 cfa37a7b 2004-04-10 devnull .I Getwindow
427 cfa37a7b 2004-04-10 devnull returns a pointer to the window associated with the application; it is called
428 cfa37a7b 2004-04-10 devnull automatically by
429 cfa37a7b 2004-04-10 devnull .I initdraw
430 cfa37a7b 2004-04-10 devnull to establish the
431 cfa37a7b 2004-04-10 devnull .B screen
432 cfa37a7b 2004-04-10 devnull pointer but must be called after each resizing of the window to restore
433 cfa37a7b 2004-04-10 devnull the library's connection to the window.
436 cfa37a7b 2004-04-10 devnull is not running, it returns
437 cfa37a7b 2004-04-10 devnull .BR display->image ;
438 cfa37a7b 2004-04-10 devnull otherwise it negotiates with
440 cfa37a7b 2004-04-10 devnull by looking in
441 cfa37a7b 2004-04-10 devnull .B /dev/winname
442 cfa37a7b 2004-04-10 devnull to find the name of the window and opening it using
443 cfa37a7b 2004-04-10 devnull .B namedimage
445 bf8a59fa 2004-04-11 devnull .IR allocimage (3)).
446 cfa37a7b 2004-04-10 devnull The resulting window will be created using the refresh method
449 bf8a59fa 2004-04-11 devnull .IR window (3));
450 cfa37a7b 2004-04-10 devnull this should almost always be
451 cfa37a7b 2004-04-10 devnull .B Refnone
454 cfa37a7b 2004-04-10 devnull provides backing store for the window.
456 cfa37a7b 2004-04-10 devnull .I Getwindow
457 cfa37a7b 2004-04-10 devnull overwrites the global variables
458 cfa37a7b 2004-04-10 devnull .BR screen ,
459 cfa37a7b 2004-04-10 devnull a pointer to the
460 cfa37a7b 2004-04-10 devnull .B Image
461 cfa37a7b 2004-04-10 devnull defining the window (or the overall display, if no window system is running); and
462 cfa37a7b 2004-04-10 devnull .BR _screen ,
463 cfa37a7b 2004-04-10 devnull a pointer to the
464 cfa37a7b 2004-04-10 devnull .B Screen
465 cfa37a7b 2004-04-10 devnull representing the root of the window's hierarchy. (See
466 bf8a59fa 2004-04-11 devnull .IR window (3).
467 cfa37a7b 2004-04-10 devnull The overloading of the
468 cfa37a7b 2004-04-10 devnull .B screen
469 cfa37a7b 2004-04-10 devnull word is an unfortunate historical accident.)
470 cfa37a7b 2004-04-10 devnull .I Getwindow
471 cfa37a7b 2004-04-10 devnull arranges that
472 cfa37a7b 2004-04-10 devnull .B screen
473 cfa37a7b 2004-04-10 devnull point to the portion of the window inside the border;
474 cfa37a7b 2004-04-10 devnull sophisticated clients may use
475 cfa37a7b 2004-04-10 devnull .B _screen
476 cfa37a7b 2004-04-10 devnull to make further subwindows.
478 213fc4f6 2015-02-17 rsc .I getwindow
479 213fc4f6 2015-02-17 rsc is being called due to a resizing of the window,
480 213fc4f6 2015-02-17 rsc the resize may be accompanied by a change in screen pixel density (DPI),
481 213fc4f6 2015-02-17 rsc in which case the value of the
482 213fc4f6 2015-02-17 rsc .BR Display 's
484 213fc4f6 2015-02-17 rsc field and any open
489 213fc4f6 2015-02-17 rsc fields may be updated during the call to
490 213fc4f6 2015-02-17 rsc .IR getwindow .
491 213fc4f6 2015-02-17 rsc Programs should discard any cached information about display or font sizes.
492 058b0118 2005-01-03 devnull .\" Programs desiring multiple independent windows
493 058b0118 2005-01-03 devnull .\" may use the mechanisms of
494 058b0118 2005-01-03 devnull .\" .IR rio (4)
495 058b0118 2005-01-03 devnull .\" to create more windows (usually by a fresh mount of the window sytem
496 058b0118 2005-01-03 devnull .\" in a directory other than
497 058b0118 2005-01-03 devnull .\" .BR /dev ),
498 058b0118 2005-01-03 devnull .\" then use
499 058b0118 2005-01-03 devnull .\" .I gengetwindow
500 058b0118 2005-01-03 devnull .\" to connect to them.
501 cfa37a7b 2004-04-10 devnull .IR Gengetwindow 's
502 cfa37a7b 2004-04-10 devnull extra arguments are the full path of the window's
503 cfa37a7b 2004-04-10 devnull .B winname
504 cfa37a7b 2004-04-10 devnull file and pointers to be overwritten with the values of the `global'
505 cfa37a7b 2004-04-10 devnull .B Image
507 cfa37a7b 2004-04-10 devnull .B Screen
508 cfa37a7b 2004-04-10 devnull variables for the new window.
510 9f385187 2012-11-26 rsc Historically, Plan 9 graphics programs have used fixed-size graphics features that assume a narrow range of display densities, around 100 dpi: pixels (or dots) per inch.
511 9f385187 2012-11-26 rsc The new field
512 9f385187 2012-11-26 rsc .B display->dpi
513 9f385187 2012-11-26 rsc contains the display's actual density if known, or else
514 9f385187 2012-11-26 rsc .B DefaultDPI
516 9f385187 2012-11-26 rsc .I Scalesize
517 9f385187 2012-11-26 rsc scales the fixed pixel count
520 9f385187 2012-11-26 rsc .BR display->dpi / DefaultDPI ,
521 9f385187 2012-11-26 rsc rounding appropriately.
523 cfa37a7b 2004-04-10 devnull The mouse cursor is always displayed.
524 cfa37a7b 2004-04-10 devnull The initial cursor is an arrow.
525 cfa37a7b 2004-04-10 devnull .I Cursorswitch
526 cfa37a7b 2004-04-10 devnull causes the argument cursor to be displayed instead.
527 cfa37a7b 2004-04-10 devnull A zero argument causes a switch back to the arrow cursor.
528 cfa37a7b 2004-04-10 devnull .I Cursorset
529 cfa37a7b 2004-04-10 devnull moves the mouse cursor to position
531 cfa37a7b 2004-04-10 devnull provided (if in a window) that the requesting program is
532 cfa37a7b 2004-04-10 devnull executing in the current window and the mouse is within
533 cfa37a7b 2004-04-10 devnull the window boundaries; otherwise
534 cfa37a7b 2004-04-10 devnull .I cursorset
535 cfa37a7b 2004-04-10 devnull is a no-op.
537 cfa37a7b 2004-04-10 devnull The graphics functions described in
538 bf8a59fa 2004-04-11 devnull .IR draw (3),
539 bf8a59fa 2004-04-11 devnull .IR allocimage (3),
540 bf8a59fa 2004-04-11 devnull .IR cachechars (3),
542 bf8a59fa 2004-04-11 devnull .IR subfont (3)
543 cfa37a7b 2004-04-10 devnull are implemented by writing commands to files under
544 cfa37a7b 2004-04-10 devnull .B /dev/draw
546 cfa37a7b 2004-04-10 devnull .IR draw (3));
547 cfa37a7b 2004-04-10 devnull the writes are buffered, so the functions may not take effect immediately.
548 cfa37a7b 2004-04-10 devnull .I Flushimage
549 cfa37a7b 2004-04-10 devnull flushes the buffer, doing all pending graphics operations.
552 cfa37a7b 2004-04-10 devnull is non-zero, any changes are also copied from the `soft screen' (if any) in the
553 cfa37a7b 2004-04-10 devnull driver to the visible frame buffer.
554 cfa37a7b 2004-04-10 devnull The various allocation routines in the library flush automatically, as does the event
555 cfa37a7b 2004-04-10 devnull package (see
556 bf8a59fa 2004-04-11 devnull .IR event (3));
557 cfa37a7b 2004-04-10 devnull most programs do not need to call
558 cfa37a7b 2004-04-10 devnull .IR flushimage .
559 cfa37a7b 2004-04-10 devnull It returns \-1 on error.
561 cfa37a7b 2004-04-10 devnull .I Bufimage
562 cfa37a7b 2004-04-10 devnull is used to allocate space for
564 cfa37a7b 2004-04-10 devnull bytes in the display buffer.
565 cfa37a7b 2004-04-10 devnull It is used by all the graphics routines to send messages to the display.
567 cfa37a7b 2004-04-10 devnull The functions
568 cfa37a7b 2004-04-10 devnull .I strtochan
570 cfa37a7b 2004-04-10 devnull .I chantostr
571 cfa37a7b 2004-04-10 devnull convert between the channel descriptor strings
573 058b0118 2005-01-03 devnull .IR image (7)
574 cfa37a7b 2004-04-10 devnull and the internal
575 cfa37a7b 2004-04-10 devnull .B ulong
576 cfa37a7b 2004-04-10 devnull representation
577 cfa37a7b 2004-04-10 devnull used by the graphics protocol
579 cfa37a7b 2004-04-10 devnull .IR draw (3)'s
581 cfa37a7b 2004-04-10 devnull message).
582 cfa37a7b 2004-04-10 devnull .B Chantostr
583 cfa37a7b 2004-04-10 devnull writes at most nine bytes into the buffer pointed at by
585 cfa37a7b 2004-04-10 devnull and returns
587 cfa37a7b 2004-04-10 devnull on success,
589 cfa37a7b 2004-04-10 devnull on failure.
590 cfa37a7b 2004-04-10 devnull .B Chantodepth
591 cfa37a7b 2004-04-10 devnull returns the number of bits per pixel used by the
592 cfa37a7b 2004-04-10 devnull format specified by
593 cfa37a7b 2004-04-10 devnull .IR chan .
595 cfa37a7b 2004-04-10 devnull .B chantodepth
597 cfa37a7b 2004-04-10 devnull .B strtochan
598 cfa37a7b 2004-04-10 devnull return 0 when presented
599 cfa37a7b 2004-04-10 devnull with bad input.
600 cfa37a7b 2004-04-10 devnull .SH EXAMPLES
601 cfa37a7b 2004-04-10 devnull To reconnect to the window after a resize event,
604 cfa37a7b 2004-04-10 devnull if(getwindow(display, Refnone) < 0)
605 cfa37a7b 2004-04-10 devnull sysfatal("resize failed: %r");
608 cfa37a7b 2004-04-10 devnull To create and set up a new
609 cfa37a7b 2004-04-10 devnull .IR rio (1)
613 cfa37a7b 2004-04-10 devnull Image *screen2;
614 cfa37a7b 2004-04-10 devnull Screen *_screen2;
616 cfa37a7b 2004-04-10 devnull srvwsys = getenv("wsys");
617 cfa37a7b 2004-04-10 devnull if(srvwsys == nil)
618 cfa37a7b 2004-04-10 devnull sysfatal("can't find $wsys: %r");
619 cfa37a7b 2004-04-10 devnull rfork(RFNAMEG); /* keep mount of rio private */
621 cfa37a7b 2004-04-10 devnull fd = open(srvwsys, ORDWR);
622 cfa37a7b 2004-04-10 devnull if(fd < 0)
623 cfa37a7b 2004-04-10 devnull sysfatal("can't open $wsys: %r");
625 cfa37a7b 2004-04-10 devnull /* mount creates window; see \f2rio\fP(4) */
626 cfa37a7b 2004-04-10 devnull if(mount(fd, -1, "/tmp", MREPL, "new -dx 300-dy 200") < 0)
627 cfa37a7b 2004-04-10 devnull sysfatal("can't mount new window: %r");
628 cfa37a7b 2004-04-10 devnull if(gengetwindow(display, "/tmp/winname",
629 cfa37a7b 2004-04-10 devnull &screen2, &_screen2, Refnone) < 0)
630 cfa37a7b 2004-04-10 devnull sysfatal("resize failed: %r");
632 cfa37a7b 2004-04-10 devnull /* now open /tmp/cons, /tmp/mouse */
635 cfa37a7b 2004-04-10 devnull .SH FILES
636 c8b6342d 2005-01-13 devnull .BR \*9/font/bit " directory of fonts
637 cfa37a7b 2004-04-10 devnull .SH SOURCE
638 c3674de4 2005-01-11 devnull .B \*9/src/libdraw
639 cfa37a7b 2004-04-10 devnull .SH "SEE ALSO"
640 cfa37a7b 2004-04-10 devnull .IR rio (1),
641 bf8a59fa 2004-04-11 devnull .IR addpt (3),
642 bf8a59fa 2004-04-11 devnull .IR allocimage (3),
643 bf8a59fa 2004-04-11 devnull .IR cachechars (3),
644 bf8a59fa 2004-04-11 devnull .IR subfont (3),
645 cfa37a7b 2004-04-10 devnull .IR draw (3),
646 bf8a59fa 2004-04-11 devnull .IR event (3),
647 bf8a59fa 2004-04-11 devnull .IR frame (3),
648 bf8a59fa 2004-04-11 devnull .IR print (3),
649 bf8a59fa 2004-04-11 devnull .IR window (3),
650 bf8a59fa 2004-04-11 devnull .IR draw (3),
651 058b0118 2005-01-03 devnull .\" .IR rio (4),
652 058b0118 2005-01-03 devnull .IR image (7),
653 058b0118 2005-01-03 devnull .IR font (7)
654 cfa37a7b 2004-04-10 devnull .SH DIAGNOSTICS
655 cfa37a7b 2004-04-10 devnull An error function may call
656 bf8a59fa 2004-04-11 devnull .IR errstr (3)
657 cfa37a7b 2004-04-10 devnull for further diagnostics.
658 cfa37a7b 2004-04-10 devnull .SH BUGS
659 cfa37a7b 2004-04-10 devnull The names
664 cfa37a7b 2004-04-10 devnull .B Cursor
665 cfa37a7b 2004-04-10 devnull structure are reminders of an archaic color map
666 cfa37a7b 2004-04-10 devnull and might be more appropriately called
667 cfa37a7b 2004-04-10 devnull .B white
669 cfa37a7b 2004-04-10 devnull .BR black .
671 c8b6342d 2005-01-13 devnull These manual pages contain many references to
672 c8b6342d 2005-01-13 devnull the now-fictitious
673 c8b6342d 2005-01-13 devnull .BR /dev/draw .
