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 cfa37a7b 2004-04-10 devnull void cursorswitch(Cursor *curs)
68 cfa37a7b 2004-04-10 devnull void cursorset(Point p)
71 cfa37a7b 2004-04-10 devnull Font* openfont(Display *d, char *name)
74 cfa37a7b 2004-04-10 devnull Font* buildfont(Display *d, char *desc, char *name)
77 cfa37a7b 2004-04-10 devnull void freefont(Font *f)
80 cfa37a7b 2004-04-10 devnull int Pfmt(Fmt*)
83 cfa37a7b 2004-04-10 devnull int Rfmt(Fmt*)
86 cfa37a7b 2004-04-10 devnull ulong strtochan(char *s)
89 cfa37a7b 2004-04-10 devnull char* chantostr(char *s, ulong chan)
92 cfa37a7b 2004-04-10 devnull int chantodepth(ulong chan)
95 cfa37a7b 2004-04-10 devnull extern Display *display
98 cfa37a7b 2004-04-10 devnull extern Image *screen
101 cfa37a7b 2004-04-10 devnull extern Screen *_screen
104 cfa37a7b 2004-04-10 devnull extern Font *font
106 cfa37a7b 2004-04-10 devnull .SH DESCRIPTION
108 cfa37a7b 2004-04-10 devnull .B Display
109 cfa37a7b 2004-04-10 devnull structure represents a connection to the graphics device,
110 cfa37a7b 2004-04-10 devnull .IR draw (3),
111 cfa37a7b 2004-04-10 devnull holding all graphics resources associated with the connection,
112 cfa37a7b 2004-04-10 devnull including in particular raster image data in use by the client program.
113 cfa37a7b 2004-04-10 devnull The structure is defined (in part) as:
116 cfa37a7b 2004-04-10 devnull .ta 6n +10n
118 cfa37a7b 2004-04-10 devnull struct Display
121 cfa37a7b 2004-04-10 devnull void (*error)(Display*, char*);
123 cfa37a7b 2004-04-10 devnull Image *black;
124 cfa37a7b 2004-04-10 devnull Image *white;
125 cfa37a7b 2004-04-10 devnull Image *opaque;
126 cfa37a7b 2004-04-10 devnull Image *transparent;
127 cfa37a7b 2004-04-10 devnull Image *image;
128 cfa37a7b 2004-04-10 devnull Font *defaultfont;
129 cfa37a7b 2004-04-10 devnull Subfont *defaultsubfont;
135 cfa37a7b 2004-04-10 devnull .B Point
136 cfa37a7b 2004-04-10 devnull is a location in an Image
137 cfa37a7b 2004-04-10 devnull (see below and
138 bf8a59fa 2004-04-11 devnull .IR draw (3)),
139 cfa37a7b 2004-04-10 devnull such as the display, and is defined as:
144 cfa37a7b 2004-04-10 devnull struct Point {
147 cfa37a7b 2004-04-10 devnull } Point;
150 cfa37a7b 2004-04-10 devnull The coordinate system has
152 cfa37a7b 2004-04-10 devnull increasing to the right and
154 cfa37a7b 2004-04-10 devnull increasing down.
157 cfa37a7b 2004-04-10 devnull .B Rectangle
158 cfa37a7b 2004-04-10 devnull is a rectangular area in an image.
163 cfa37a7b 2004-04-10 devnull struct Rectangle {
164 cfa37a7b 2004-04-10 devnull Point min; /* upper left */
165 cfa37a7b 2004-04-10 devnull Point max; /* lower right */
166 cfa37a7b 2004-04-10 devnull } Rectangle;
169 cfa37a7b 2004-04-10 devnull By definition,
170 cfa37a7b 2004-04-10 devnull .BR min.x ≤ max.x
172 cfa37a7b 2004-04-10 devnull .BR min.y ≤ max.y .
173 cfa37a7b 2004-04-10 devnull By convention, the right (maximum
175 cfa37a7b 2004-04-10 devnull and bottom (maximum
177 cfa37a7b 2004-04-10 devnull edges are
178 cfa37a7b 2004-04-10 devnull excluded from the represented rectangle, so abutting rectangles have no
179 cfa37a7b 2004-04-10 devnull points in common.
182 cfa37a7b 2004-04-10 devnull contains the coordinates of the first point beyond the rectangle.
185 cfa37a7b 2004-04-10 devnull .B Image
186 cfa37a7b 2004-04-10 devnull data structure is defined in
187 bf8a59fa 2004-04-11 devnull .IR draw (3).
191 cfa37a7b 2004-04-10 devnull is a set of character images, indexed by runes (see
192 058b0118 2005-01-03 devnull .IR utf (7)).
193 cfa37a7b 2004-04-10 devnull The images are organized into
194 cfa37a7b 2004-04-10 devnull .BR Subfonts ,
195 cfa37a7b 2004-04-10 devnull each containing the images for a small, contiguous set of runes.
196 cfa37a7b 2004-04-10 devnull The detailed format of these data structures,
197 cfa37a7b 2004-04-10 devnull which are described in detail in
198 bf8a59fa 2004-04-11 devnull .IR cachechars (3),
199 cfa37a7b 2004-04-10 devnull is immaterial for most applications.
202 cfa37a7b 2004-04-10 devnull .B Subfont
203 cfa37a7b 2004-04-10 devnull structures contain two interrelated fields:
204 cfa37a7b 2004-04-10 devnull .LR ascent ,
205 cfa37a7b 2004-04-10 devnull the distance from the top of the highest character
206 cfa37a7b 2004-04-10 devnull (actually the top of the image holding all the characters)
207 cfa37a7b 2004-04-10 devnull to the baseline,
209 cfa37a7b 2004-04-10 devnull .LR height ,
210 cfa37a7b 2004-04-10 devnull the distance from the top of the highest character to the bottom of
211 cfa37a7b 2004-04-10 devnull the lowest character (and hence, the interline spacing).
213 bf8a59fa 2004-04-11 devnull .IR cachechars (3)
214 cfa37a7b 2004-04-10 devnull for more details.
216 cfa37a7b 2004-04-10 devnull .I Buildfont
217 cfa37a7b 2004-04-10 devnull parses the font description in the buffer
218 cfa37a7b 2004-04-10 devnull .BR desc ,
219 cfa37a7b 2004-04-10 devnull returning a
220 cfa37a7b 2004-04-10 devnull .B Font*
221 cfa37a7b 2004-04-10 devnull pointer that can be used by
222 cfa37a7b 2004-04-10 devnull .B string
224 bf8a59fa 2004-04-11 devnull .IR draw (3))
225 cfa37a7b 2004-04-10 devnull to draw characters from the font.
226 cfa37a7b 2004-04-10 devnull .I Openfont
227 cfa37a7b 2004-04-10 devnull does the same, but reads the description
228 cfa37a7b 2004-04-10 devnull from the named file.
229 cfa37a7b 2004-04-10 devnull .I Freefont
230 cfa37a7b 2004-04-10 devnull frees a font.
231 cfa37a7b 2004-04-10 devnull The convention for naming font files is:
233 cfa37a7b 2004-04-10 devnull .B /lib/font/bit/\fIname\fP/\fIrange\fP.\fIsize\fP.font
238 cfa37a7b 2004-04-10 devnull is approximately the height in pixels of the lower case letters
239 cfa37a7b 2004-04-10 devnull (without ascenders or descenders).
240 cfa37a7b 2004-04-10 devnull .I Range
241 cfa37a7b 2004-04-10 devnull gives some indication of which characters will be available: for example
242 cfa37a7b 2004-04-10 devnull .BR ascii ,
243 cfa37a7b 2004-04-10 devnull .BR latin1 ,
244 cfa37a7b 2004-04-10 devnull .BR euro ,
246 cfa37a7b 2004-04-10 devnull .BR unicode .
248 cfa37a7b 2004-04-10 devnull includes most European languages, punctuation marks, the International Phonetic
249 cfa37a7b 2004-04-10 devnull Alphabet, etc., but no Oriental languages.
250 cfa37a7b 2004-04-10 devnull .B Unicode
251 cfa37a7b 2004-04-10 devnull includes every character for which appropriate-sized images exist on the system.
254 cfa37a7b 2004-04-10 devnull .I Cursor
255 cfa37a7b 2004-04-10 devnull is defined:
258 cfa37a7b 2004-04-10 devnull .ta 6n +\w'Point 'u
259 cfa37a7b 2004-04-10 devnull typedef struct
260 cfa37a7b 2004-04-10 devnull Cursor {
261 cfa37a7b 2004-04-10 devnull Point offset;
262 cfa37a7b 2004-04-10 devnull uchar clr[2*16];
263 cfa37a7b 2004-04-10 devnull uchar set[2*16];
264 cfa37a7b 2004-04-10 devnull } Cursor;
267 cfa37a7b 2004-04-10 devnull The arrays are arranged in rows, two bytes per row, left to
268 cfa37a7b 2004-04-10 devnull right in big-endian order to give 16 rows
269 cfa37a7b 2004-04-10 devnull of 16 bits each.
270 cfa37a7b 2004-04-10 devnull A cursor is displayed on the screen by adding
271 cfa37a7b 2004-04-10 devnull .B offset
272 cfa37a7b 2004-04-10 devnull to the current mouse position, using
274 cfa37a7b 2004-04-10 devnull as a mask to draw white at the pixels where
276 cfa37a7b 2004-04-10 devnull is one, and then drawing black at the pixels where
280 cfa37a7b 2004-04-10 devnull The routine
281 cfa37a7b 2004-04-10 devnull .I initdraw
282 cfa37a7b 2004-04-10 devnull connects to the display; it returns \-1 if it fails and sets the error string.
283 cfa37a7b 2004-04-10 devnull .I Initdraw
284 cfa37a7b 2004-04-10 devnull sets up the global variables
285 cfa37a7b 2004-04-10 devnull .B display
287 cfa37a7b 2004-04-10 devnull .B Display
288 cfa37a7b 2004-04-10 devnull structure representing the connection),
289 cfa37a7b 2004-04-10 devnull .B screen
291 cfa37a7b 2004-04-10 devnull .B Image
292 cfa37a7b 2004-04-10 devnull representing the display memory itself or, if
293 cfa37a7b 2004-04-10 devnull .IR rio (1)
294 cfa37a7b 2004-04-10 devnull is running, the client's window),
297 cfa37a7b 2004-04-10 devnull (the default font for text).
298 cfa37a7b 2004-04-10 devnull The arguments to
299 cfa37a7b 2004-04-10 devnull .I initdraw
300 cfa37a7b 2004-04-10 devnull include a
301 cfa37a7b 2004-04-10 devnull .IR label ,
302 cfa37a7b 2004-04-10 devnull which is written to
303 cfa37a7b 2004-04-10 devnull .B /dev/label
304 cfa37a7b 2004-04-10 devnull if non-nil
305 cfa37a7b 2004-04-10 devnull so that it can be used to identify the window when hidden (see
306 cfa37a7b 2004-04-10 devnull .IR rio (1)).
307 cfa37a7b 2004-04-10 devnull The font is created by reading the named
309 cfa37a7b 2004-04-10 devnull file. If
311 cfa37a7b 2004-04-10 devnull is null,
312 cfa37a7b 2004-04-10 devnull .I initdraw
313 cfa37a7b 2004-04-10 devnull reads the file named in the environment variable
314 cfa37a7b 2004-04-10 devnull .BR $font ;
316 cfa37a7b 2004-04-10 devnull .B $font
317 cfa37a7b 2004-04-10 devnull is not set, it imports the default (usually minimal)
318 cfa37a7b 2004-04-10 devnull font from the operating system.
319 cfa37a7b 2004-04-10 devnull The global
321 cfa37a7b 2004-04-10 devnull will be set to point to the resulting
323 cfa37a7b 2004-04-10 devnull structure.
325 cfa37a7b 2004-04-10 devnull .I errfun
326 cfa37a7b 2004-04-10 devnull argument is a
327 cfa37a7b 2004-04-10 devnull .I graphics error function
328 cfa37a7b 2004-04-10 devnull to call in the event of a fatal error in the library; it must never return.
329 cfa37a7b 2004-04-10 devnull Its arguments are the
330 cfa37a7b 2004-04-10 devnull display pointer and an error string.
332 cfa37a7b 2004-04-10 devnull .I errfun
333 cfa37a7b 2004-04-10 devnull is nil, the library provides a default, called
334 cfa37a7b 2004-04-10 devnull .IR drawerror .
335 cfa37a7b 2004-04-10 devnull Another effect of
336 cfa37a7b 2004-04-10 devnull .I initdraw
337 cfa37a7b 2004-04-10 devnull is that it installs
338 bf8a59fa 2004-04-11 devnull .IR print (3)
347 cfa37a7b 2004-04-10 devnull for printing
348 cfa37a7b 2004-04-10 devnull .B Points
350 cfa37a7b 2004-04-10 devnull .BR Rectangles .
353 cfa37a7b 2004-04-10 devnull .I geninitdraw
354 cfa37a7b 2004-04-10 devnull function provides a less automated way to establish a connection, for programs
355 cfa37a7b 2004-04-10 devnull that wish to connect to multiple displays.
356 cfa37a7b 2004-04-10 devnull .I Devdir
357 cfa37a7b 2004-04-10 devnull is the name of the directory containing the device files for the display
358 cfa37a7b 2004-04-10 devnull (if nil, default
359 cfa37a7b 2004-04-10 devnull .BR /dev );
360 cfa37a7b 2004-04-10 devnull .IR errfun ,
361 cfa37a7b 2004-04-10 devnull .IR font ,
363 cfa37a7b 2004-04-10 devnull .I label
364 cfa37a7b 2004-04-10 devnull are as in
365 cfa37a7b 2004-04-10 devnull .IR initdraw ;
366 cfa37a7b 2004-04-10 devnull .I mousedir
368 cfa37a7b 2004-04-10 devnull .I windir
369 cfa37a7b 2004-04-10 devnull are the directories holding the
370 cfa37a7b 2004-04-10 devnull .B mouse
372 cfa37a7b 2004-04-10 devnull .B winname
373 cfa37a7b 2004-04-10 devnull files; and
375 cfa37a7b 2004-04-10 devnull specifies the refresh function to be used to create the window, if running under
376 cfa37a7b 2004-04-10 devnull .IR rio (1)
378 bf8a59fa 2004-04-11 devnull .IR window (3)).
380 058b0118 2005-01-03 devnull .\" The function
381 058b0118 2005-01-03 devnull .\" .I newwindow
382 058b0118 2005-01-03 devnull .\" may be called before
383 058b0118 2005-01-03 devnull .\" .I initdraw
385 058b0118 2005-01-03 devnull .\" .IR geninitdraw
386 058b0118 2005-01-03 devnull .\" to cause the program to occupy a newly created window rather than take over the one in
387 058b0118 2005-01-03 devnull .\" which it is running when it starts.
389 058b0118 2005-01-03 devnull .\" .I str
390 058b0118 2005-01-03 devnull .\" argument, if non-null, is concatenated to the string \f5\&"new\ "\fP
391 058b0118 2005-01-03 devnull .\" that is used to create the window (see
392 058b0118 2005-01-03 devnull .\" .IR rio (4)).
393 058b0118 2005-01-03 devnull .\" For example,
394 058b0118 2005-01-03 devnull .\" .B newwindow("-hide -dy 100")
395 058b0118 2005-01-03 devnull .\" will cause the program to run in a newly created, hidden window
396 058b0118 2005-01-03 devnull .\" 100 pixels high.
398 cfa37a7b 2004-04-10 devnull .I Initdisplay
399 cfa37a7b 2004-04-10 devnull is part of
400 cfa37a7b 2004-04-10 devnull .IR geninitdraw ;
401 cfa37a7b 2004-04-10 devnull it sets up the display structures but does not allocate any fonts or call
402 cfa37a7b 2004-04-10 devnull .IR getwindow .
403 cfa37a7b 2004-04-10 devnull The arguments are similar to those of
404 cfa37a7b 2004-04-10 devnull .IR initdraw ;
406 cfa37a7b 2004-04-10 devnull names the directory, default
407 cfa37a7b 2004-04-10 devnull .BR /dev ,
408 cfa37a7b 2004-04-10 devnull in which the files associated with the window reside.
409 cfa37a7b 2004-04-10 devnull .I Closedisplay
410 cfa37a7b 2004-04-10 devnull disconnects the display and frees the associated data structures.
411 cfa37a7b 2004-04-10 devnull .I Getdefont
412 cfa37a7b 2004-04-10 devnull builds a
414 cfa37a7b 2004-04-10 devnull structure from in-core data describing a default font.
415 cfa37a7b 2004-04-10 devnull None of these routines is needed by most programs, since
416 cfa37a7b 2004-04-10 devnull .I initdraw
417 cfa37a7b 2004-04-10 devnull calls them as needed.
419 cfa37a7b 2004-04-10 devnull The data structures associated with the display must be protected in a multi-process program,
420 cfa37a7b 2004-04-10 devnull because they assume only one process will be using them at a time.
421 cfa37a7b 2004-04-10 devnull Multi-process programs should set
422 cfa37a7b 2004-04-10 devnull .B display->locking
425 cfa37a7b 2004-04-10 devnull to notify the library to use a locking protocol for its own accesses,
426 cfa37a7b 2004-04-10 devnull and call
427 cfa37a7b 2004-04-10 devnull .I lockdisplay
429 cfa37a7b 2004-04-10 devnull .I unlockdisplay
430 cfa37a7b 2004-04-10 devnull around any calls to the graphics library that will cause messages to be sent to the display device.
431 cfa37a7b 2004-04-10 devnull .I Initdraw
433 cfa37a7b 2004-04-10 devnull .I geninitdraw
434 cfa37a7b 2004-04-10 devnull initialize the display to the locked state.
436 cfa37a7b 2004-04-10 devnull .I Getwindow
437 cfa37a7b 2004-04-10 devnull returns a pointer to the window associated with the application; it is called
438 cfa37a7b 2004-04-10 devnull automatically by
439 cfa37a7b 2004-04-10 devnull .I initdraw
440 cfa37a7b 2004-04-10 devnull to establish the
441 cfa37a7b 2004-04-10 devnull .B screen
442 cfa37a7b 2004-04-10 devnull pointer but must be called after each resizing of the window to restore
443 cfa37a7b 2004-04-10 devnull the library's connection to the window.
446 cfa37a7b 2004-04-10 devnull is not running, it returns
447 cfa37a7b 2004-04-10 devnull .BR display->image ;
448 cfa37a7b 2004-04-10 devnull otherwise it negotiates with
450 cfa37a7b 2004-04-10 devnull by looking in
451 cfa37a7b 2004-04-10 devnull .B /dev/winname
452 cfa37a7b 2004-04-10 devnull to find the name of the window and opening it using
453 cfa37a7b 2004-04-10 devnull .B namedimage
455 bf8a59fa 2004-04-11 devnull .IR allocimage (3)).
456 cfa37a7b 2004-04-10 devnull The resulting window will be created using the refresh method
459 bf8a59fa 2004-04-11 devnull .IR window (3));
460 cfa37a7b 2004-04-10 devnull this should almost always be
461 cfa37a7b 2004-04-10 devnull .B Refnone
464 cfa37a7b 2004-04-10 devnull provides backing store for the window.
466 cfa37a7b 2004-04-10 devnull .I Getwindow
467 cfa37a7b 2004-04-10 devnull overwrites the global variables
468 cfa37a7b 2004-04-10 devnull .BR screen ,
469 cfa37a7b 2004-04-10 devnull a pointer to the
470 cfa37a7b 2004-04-10 devnull .B Image
471 cfa37a7b 2004-04-10 devnull defining the window (or the overall display, if no window system is running); and
472 cfa37a7b 2004-04-10 devnull .BR _screen ,
473 cfa37a7b 2004-04-10 devnull a pointer to the
474 cfa37a7b 2004-04-10 devnull .B Screen
475 cfa37a7b 2004-04-10 devnull representing the root of the window's hierarchy. (See
476 bf8a59fa 2004-04-11 devnull .IR window (3).
477 cfa37a7b 2004-04-10 devnull The overloading of the
478 cfa37a7b 2004-04-10 devnull .B screen
479 cfa37a7b 2004-04-10 devnull word is an unfortunate historical accident.)
480 cfa37a7b 2004-04-10 devnull .I Getwindow
481 cfa37a7b 2004-04-10 devnull arranges that
482 cfa37a7b 2004-04-10 devnull .B screen
483 cfa37a7b 2004-04-10 devnull point to the portion of the window inside the border;
484 cfa37a7b 2004-04-10 devnull sophisticated clients may use
485 cfa37a7b 2004-04-10 devnull .B _screen
486 cfa37a7b 2004-04-10 devnull to make further subwindows.
487 058b0118 2005-01-03 devnull .\" Programs desiring multiple independent windows
488 058b0118 2005-01-03 devnull .\" may use the mechanisms of
489 058b0118 2005-01-03 devnull .\" .IR rio (4)
490 058b0118 2005-01-03 devnull .\" to create more windows (usually by a fresh mount of the window sytem
491 058b0118 2005-01-03 devnull .\" in a directory other than
492 058b0118 2005-01-03 devnull .\" .BR /dev ),
493 058b0118 2005-01-03 devnull .\" then use
494 058b0118 2005-01-03 devnull .\" .I gengetwindow
495 058b0118 2005-01-03 devnull .\" to connect to them.
496 cfa37a7b 2004-04-10 devnull .IR Gengetwindow 's
497 cfa37a7b 2004-04-10 devnull extra arguments are the full path of the window's
498 cfa37a7b 2004-04-10 devnull .B winname
499 cfa37a7b 2004-04-10 devnull file and pointers to be overwritten with the values of the `global'
500 cfa37a7b 2004-04-10 devnull .B Image
502 cfa37a7b 2004-04-10 devnull .B Screen
503 cfa37a7b 2004-04-10 devnull variables for the new window.
505 cfa37a7b 2004-04-10 devnull The mouse cursor is always displayed.
506 cfa37a7b 2004-04-10 devnull The initial cursor is an arrow.
507 cfa37a7b 2004-04-10 devnull .I Cursorswitch
508 cfa37a7b 2004-04-10 devnull causes the argument cursor to be displayed instead.
509 cfa37a7b 2004-04-10 devnull A zero argument causes a switch back to the arrow cursor.
510 cfa37a7b 2004-04-10 devnull .I Cursorset
511 cfa37a7b 2004-04-10 devnull moves the mouse cursor to position
513 cfa37a7b 2004-04-10 devnull provided (if in a window) that the requesting program is
514 cfa37a7b 2004-04-10 devnull executing in the current window and the mouse is within
515 cfa37a7b 2004-04-10 devnull the window boundaries; otherwise
516 cfa37a7b 2004-04-10 devnull .I cursorset
517 cfa37a7b 2004-04-10 devnull is a no-op.
519 cfa37a7b 2004-04-10 devnull The graphics functions described in
520 bf8a59fa 2004-04-11 devnull .IR draw (3),
521 bf8a59fa 2004-04-11 devnull .IR allocimage (3),
522 bf8a59fa 2004-04-11 devnull .IR cachechars (3),
524 bf8a59fa 2004-04-11 devnull .IR subfont (3)
525 cfa37a7b 2004-04-10 devnull are implemented by writing commands to files under
526 cfa37a7b 2004-04-10 devnull .B /dev/draw
528 cfa37a7b 2004-04-10 devnull .IR draw (3));
529 cfa37a7b 2004-04-10 devnull the writes are buffered, so the functions may not take effect immediately.
530 cfa37a7b 2004-04-10 devnull .I Flushimage
531 cfa37a7b 2004-04-10 devnull flushes the buffer, doing all pending graphics operations.
534 cfa37a7b 2004-04-10 devnull is non-zero, any changes are also copied from the `soft screen' (if any) in the
535 cfa37a7b 2004-04-10 devnull driver to the visible frame buffer.
536 cfa37a7b 2004-04-10 devnull The various allocation routines in the library flush automatically, as does the event
537 cfa37a7b 2004-04-10 devnull package (see
538 bf8a59fa 2004-04-11 devnull .IR event (3));
539 cfa37a7b 2004-04-10 devnull most programs do not need to call
540 cfa37a7b 2004-04-10 devnull .IR flushimage .
541 cfa37a7b 2004-04-10 devnull It returns \-1 on error.
543 cfa37a7b 2004-04-10 devnull .I Bufimage
544 cfa37a7b 2004-04-10 devnull is used to allocate space for
546 cfa37a7b 2004-04-10 devnull bytes in the display buffer.
547 cfa37a7b 2004-04-10 devnull It is used by all the graphics routines to send messages to the display.
549 cfa37a7b 2004-04-10 devnull The functions
550 cfa37a7b 2004-04-10 devnull .I strtochan
552 cfa37a7b 2004-04-10 devnull .I chantostr
553 cfa37a7b 2004-04-10 devnull convert between the channel descriptor strings
555 058b0118 2005-01-03 devnull .IR image (7)
556 cfa37a7b 2004-04-10 devnull and the internal
557 cfa37a7b 2004-04-10 devnull .B ulong
558 cfa37a7b 2004-04-10 devnull representation
559 cfa37a7b 2004-04-10 devnull used by the graphics protocol
561 cfa37a7b 2004-04-10 devnull .IR draw (3)'s
563 cfa37a7b 2004-04-10 devnull message).
564 cfa37a7b 2004-04-10 devnull .B Chantostr
565 cfa37a7b 2004-04-10 devnull writes at most nine bytes into the buffer pointed at by
567 cfa37a7b 2004-04-10 devnull and returns
569 cfa37a7b 2004-04-10 devnull on success,
571 cfa37a7b 2004-04-10 devnull on failure.
572 cfa37a7b 2004-04-10 devnull .B Chantodepth
573 cfa37a7b 2004-04-10 devnull returns the number of bits per pixel used by the
574 cfa37a7b 2004-04-10 devnull format specified by
575 cfa37a7b 2004-04-10 devnull .IR chan .
577 cfa37a7b 2004-04-10 devnull .B chantodepth
579 cfa37a7b 2004-04-10 devnull .B strtochan
580 cfa37a7b 2004-04-10 devnull return 0 when presented
581 cfa37a7b 2004-04-10 devnull with bad input.
582 cfa37a7b 2004-04-10 devnull .SH EXAMPLES
583 cfa37a7b 2004-04-10 devnull To reconnect to the window after a resize event,
586 cfa37a7b 2004-04-10 devnull if(getwindow(display, Refnone) < 0)
587 cfa37a7b 2004-04-10 devnull sysfatal("resize failed: %r");
590 cfa37a7b 2004-04-10 devnull To create and set up a new
591 cfa37a7b 2004-04-10 devnull .IR rio (1)
595 cfa37a7b 2004-04-10 devnull Image *screen2;
596 cfa37a7b 2004-04-10 devnull Screen *_screen2;
598 cfa37a7b 2004-04-10 devnull srvwsys = getenv("wsys");
599 cfa37a7b 2004-04-10 devnull if(srvwsys == nil)
600 cfa37a7b 2004-04-10 devnull sysfatal("can't find $wsys: %r");
601 cfa37a7b 2004-04-10 devnull rfork(RFNAMEG); /* keep mount of rio private */
603 cfa37a7b 2004-04-10 devnull fd = open(srvwsys, ORDWR);
604 cfa37a7b 2004-04-10 devnull if(fd < 0)
605 cfa37a7b 2004-04-10 devnull sysfatal("can't open $wsys: %r");
607 cfa37a7b 2004-04-10 devnull /* mount creates window; see \f2rio\fP(4) */
608 cfa37a7b 2004-04-10 devnull if(mount(fd, -1, "/tmp", MREPL, "new -dx 300-dy 200") < 0)
609 cfa37a7b 2004-04-10 devnull sysfatal("can't mount new window: %r");
610 cfa37a7b 2004-04-10 devnull if(gengetwindow(display, "/tmp/winname",
611 cfa37a7b 2004-04-10 devnull &screen2, &_screen2, Refnone) < 0)
612 cfa37a7b 2004-04-10 devnull sysfatal("resize failed: %r");
614 cfa37a7b 2004-04-10 devnull /* now open /tmp/cons, /tmp/mouse */
617 cfa37a7b 2004-04-10 devnull .SH FILES
618 c8b6342d 2005-01-13 devnull .BR \*9/font/bit " directory of fonts
619 cfa37a7b 2004-04-10 devnull .SH SOURCE
620 c3674de4 2005-01-11 devnull .B \*9/src/libdraw
621 cfa37a7b 2004-04-10 devnull .SH "SEE ALSO"
622 cfa37a7b 2004-04-10 devnull .IR rio (1),
623 bf8a59fa 2004-04-11 devnull .IR addpt (3),
624 bf8a59fa 2004-04-11 devnull .IR allocimage (3),
625 bf8a59fa 2004-04-11 devnull .IR cachechars (3),
626 bf8a59fa 2004-04-11 devnull .IR subfont (3),
627 cfa37a7b 2004-04-10 devnull .IR draw (3),
628 bf8a59fa 2004-04-11 devnull .IR event (3),
629 bf8a59fa 2004-04-11 devnull .IR frame (3),
630 bf8a59fa 2004-04-11 devnull .IR print (3),
631 bf8a59fa 2004-04-11 devnull .IR window (3),
632 bf8a59fa 2004-04-11 devnull .IR draw (3),
633 058b0118 2005-01-03 devnull .\" .IR rio (4),
634 058b0118 2005-01-03 devnull .IR image (7),
635 058b0118 2005-01-03 devnull .IR font (7)
636 cfa37a7b 2004-04-10 devnull .SH DIAGNOSTICS
637 cfa37a7b 2004-04-10 devnull An error function may call
638 bf8a59fa 2004-04-11 devnull .IR errstr (3)
639 cfa37a7b 2004-04-10 devnull for further diagnostics.
640 cfa37a7b 2004-04-10 devnull .SH BUGS
641 cfa37a7b 2004-04-10 devnull The names
646 cfa37a7b 2004-04-10 devnull .B Cursor
647 cfa37a7b 2004-04-10 devnull structure are reminders of an archaic color map
648 cfa37a7b 2004-04-10 devnull and might be more appropriately called
649 cfa37a7b 2004-04-10 devnull .B white
651 cfa37a7b 2004-04-10 devnull .BR black .
653 c8b6342d 2005-01-13 devnull These manual pages contain many references to
654 c8b6342d 2005-01-13 devnull the now-fictitious
655 c8b6342d 2005-01-13 devnull .BR /dev/draw .
