Mercurial > hg > Members > kono > nitros9-code

comparison docs/basic09/gfx2.appendix @ 973:07a25643d033

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Added gfx2 information
author roug
date Sat, 01 Feb 2003 16:04:39 +0000
parents
children
comparison
equal deleted inserted replaced
972:2ccaf038d1c6 973:07a25643d033
1 <appendix>
2 <title>GFX2: CoCo3 Graphics Subroutine Module</title>
3
4 <refentry id='arc'>
5 <refnamediv>
6 <refname>arc</refname>
7 <refpurpose>Draw an arc.</refpurpose>
8 </refnamediv>
9
10 <refsynopsisdiv>
11 <cmdsynopsis>
12 <command>RUN GFX2 ( [path,] "ARC" [,mx, my], xrad, yrad, xcor1, ycor1,
13 xcor2, ycor2)</command>
14 </cmdsynopsis>
15 </refsynopsisdiv>
16
17 <refsect1><title>Parameters</title>
18 <para>
19
20 <replaceable>path</replaceable> Route to the window you want to use.
21 <replaceable>mx, my</replaceable> X &amp; Y coordinates for the center of the arc.
22 <replaceable>xrad</replaceable> Radius of the arcs width.
23 <replaceable>yrad</replaceable> Radius of the arcs height.
24 <replaceable>xcor1, ycor1</replaceable> Beginning and ending coordinates for an imaginary
25 <replaceable>xcor2, ycor2</replaceable> line relative to the center of the arc (0, 0) that
26 GFX2 uses for drawing the arc. Drawing starts at
27 the point of the arc closest to xcor1, ycor1.
28 </para>
29 </refsect1>
30 </refentry>
31 <refentry id='bar'>
32 <refnamediv>
33 <refname>bar</refname>
34 <refpurpose>Draws a filled in rectangle.</refpurpose>
35 </refnamediv>
36
37
38 <refsynopsisdiv>
39 <cmdsynopsis>
40 <command>RUN GFX2 ( [path,] "BAR" [,xcor1, ycor1], xcor2, ycor2)</command>
41 </cmdsynopsis>
42 </refsynopsisdiv>
43
44 <refsect1><title>Parameters</title>
45 <para>
46
47 <replaceable>path</replaceable> Route to the window to draw in.
48 <replaceable>xcor1, ycor1</replaceable> Beginning coordinates of the rectangle.
49 <replaceable>xcor2, ycor2</replaceable> Ending coordinates of the rectangle.
50 </para>
51 </refsect1>
52 </refentry>
53 <refentry id='bell'>
54 <refnamediv>
55 <refname>bell</refname>
56 <refpurpose>Produce a beep through the terminal's speaker.</refpurpose>
57 </refnamediv>
58
59
60 <refsynopsisdiv>
61 <cmdsynopsis>
62 <command>RUN GFX2 ("BELL")</command>
63 </cmdsynopsis>
64 </refsynopsisdiv>
65
66 <refsect1><title>Parameters</title>
67 <para>
68 None
69 </para>
70 </refsect1>
71 </refentry>
72 <refentry id='blnkoff'>
73 <refnamediv>
74 <refname>blnkoff</refname>
75 <refpurpose>Turn off blinking for characters being sent to a text window.</refpurpose>
76 </refnamediv>
77
78
79 <refsynopsisdiv>
80 <cmdsynopsis>
81 <command>RUN GFX2 ( [path,] "BLNKOFF")</command>
82 </cmdsynopsis>
83 </refsynopsisdiv>
84
85 <refsect1><title>Parameters</title>
86 <para>
87
88 <replaceable>path</replaceable> Route to the window you want to use.
89 </para>
90 </refsect1>
91 </refentry>
92 <refentry id='blnkon'>
93 <refnamediv>
94 <refname>blnkon</refname>
95 <refpurpose>Turn on blinking for characters being sent to a text window.</refpurpose>
96 </refnamediv>
97
98
99 <refsynopsisdiv>
100 <cmdsynopsis>
101 <command>RUN GFX2 ( [path,] "BLNKON")</command>
102 </cmdsynopsis>
103 </refsynopsisdiv>
104
105 <refsect1><title>Parameters</title>
106 <para>
107
108 <replaceable>path</replaceable> Route to the window you want to use.
109 </para>
110 </refsect1>
111 <refsect1><title>Notes</title>
112 <para>
113 Does not work on a graphics window.
114 </para>
115 </refsect1>
116 </refentry>
117 <refentry id='boldsw'>
118 <refnamediv>
119 <refname>boldsw</refname>
120 <refpurpose>Turn bold printing on or off for characters being printed.</refpurpose>
121 </refnamediv>
122
123 <refsynopsisdiv>
124 <cmdsynopsis>
125 <command>RUN GFX2 ( [path,] "BOLDSW", "switch")</command>
126 </cmdsynopsis>
127 </refsynopsisdiv>
128
129 <refsect1><title>Parameters</title>
130 <para>
131
132 <replaceable>path</replaceable> Route to the window you want to use.
133 <replaceable>switch</replaceable> "ON" to turn bold on. "OFF" to turn bold off.
134 </para>
135 </refsect1>
136 <refsect1><title>Notes</title>
137 <para>
138 Only works on a graphics window.
139 </para>
140 </refsect1>
141 </refentry>
142 <refentry id='border'>
143 <refnamediv>
144 <refname>border</refname>
145 <refpurpose>Set the border color palette.</refpurpose>
146 </refnamediv>
147
148
149 <refsynopsisdiv>
150 <cmdsynopsis>
151 <command>RUN GFX2 ( [path,] "BORDER", color)</command>
152 </cmdsynopsis>
153 </refsynopsisdiv>
154
155 <refsect1><title>Parameters</title>
156 <para>
157
158 <replaceable>path</replaceable> Route to the window you want to use.
159 <replaceable>color</replaceable> Palette number to use.
160 </para>
161 </refsect1>
162 </refentry>
163 <refentry id='box'>
164 <refnamediv>
165 <refname>box</refname>
166 <refpurpose>Draw a rectangle on a graphics window.</refpurpose>
167 </refnamediv>
168
169
170 <refsynopsisdiv>
171 <cmdsynopsis>
172 <command>RUN GFX2 ( [path,] "BOX" [,xcor1, ycor1], xcor2, ycor2)</command>
173 </cmdsynopsis>
174 </refsynopsisdiv>
175
176 <refsect1><title>Parameters</title>
177 <para>
178
179 <replaceable>path</replaceable> Route to the window you want to use.
180 <replaceable>xcor1, ycor1</replaceable> Beginning coordinates for the box.
181 <replaceable>xcor2, ycor2</replaceable> Ending coordinates for the box.
182 </para>
183 </refsect1>
184 </refentry>
185 <refentry id='circle'>
186 <refnamediv>
187 <refname>circle</refname>
188 <refpurpose>Draw a circle on a graphics window.</refpurpose>
189 </refnamediv>
190
191
192 <refsynopsisdiv>
193 <cmdsynopsis>
194 <command>RUN GFX2 ( [path,] "CIRCLE" [,xcor, ycor], radius)</command>
195 </cmdsynopsis>
196 </refsynopsisdiv>
197
198 <refsect1><title>Parameters</title>
199 <para>
200
201 <replaceable>path</replaceable> Route to the window you want to use.
202 <replaceable>xcor, ycor</replaceable> Coordinates to use as the center point.
203 <replaceable>radius</replaceable> Radius of the circle.
204 </para>
205 </refsect1>
206 </refentry>
207 <refentry id='clear'>
208 <refnamediv>
209 <refname>clear</refname>
210 <refpurpose>Clear the screen.</refpurpose>
211 </refnamediv>
212
213
214 <refsynopsisdiv>
215 <cmdsynopsis>
216 <command>RUN GFX2 ( [path,] "CLEAR")</command>
217 </cmdsynopsis>
218 </refsynopsisdiv>
219
220 <refsect1><title>Parameters</title>
221 <para>
222
223 <replaceable>path</replaceable> Route to the window you want to use.
224 </para>
225 </refsect1>
226 </refentry>
227 <refentry id='color'>
228 <refnamediv>
229 <refname>color</refname>
230 <refpurpose>Set the window colors.</refpurpose>
231 </refnamediv>
232
233
234 <refsynopsisdiv>
235 <cmdsynopsis>
236 <command>RUN GFX2 ( [path,] "COLOR", foreground [,background] [,border] )</command>
237 </cmdsynopsis>
238 </refsynopsisdiv>
239
240 <refsect1><title>Parameters</title>
241 <para>
242
243 <replaceable>path</replaceable> Route to the window you want to use.
244 <replaceable>foreground</replaceable> Register number to use for the foreground color.
245 <replaceable>background</replaceable> Register number to use for the background color.
246 <replaceable>border</replaceable> Register number to use for the border color.
247 </para>
248 </refsect1>
249 </refentry>
250 <refentry id='crrtn'>
251 <refnamediv>
252 <refname>crrtn</refname>
253 <refpurpose>Sends a carriage return to the window.</refpurpose>
254 </refnamediv>
255
256
257 <refsynopsisdiv>
258 <cmdsynopsis>
259 <command>RUN GFX2 ( [path,] "CRRTN")</command>
260 </cmdsynopsis>
261 </refsynopsisdiv>
262
263 <refsect1><title>Parameters</title>
264 <para>
265
266 <replaceable>path</replaceable> Route to the window you want to use.
267 </para>
268 </refsect1>
269 </refentry>
270 <refentry id='curdwn'>
271 <refnamediv>
272 <refname>curdwn</refname>
273 <refpurpose>Moves the cursor down one text line.</refpurpose>
274 </refnamediv>
275
276
277 <refsynopsisdiv>
278 <cmdsynopsis>
279 <command>RUN GFX2 ( [path,] "CURDWN")</command>
280 </cmdsynopsis>
281 </refsynopsisdiv>
282
283 <refsect1><title>Parameters</title>
284 <para>
285
286 <replaceable>path</replaceable> Route to the window you want to use.
287 </para>
288 </refsect1>
289 </refentry>
290 <refentry id='curhome'>
291 <refnamediv>
292 <refname>curhome</refname>
293 <refpurpose>Move the text cursor to the top left corner of the window.</refpurpose>
294 </refnamediv>
295
296
297 <refsynopsisdiv>
298 <cmdsynopsis>
299 <command>RUN GFX2 ( [path,] "CURHOME")</command>
300 </cmdsynopsis>
301 </refsynopsisdiv>
302
303 <refsect1><title>Parameters</title>
304 <para>
305
306 <replaceable>path</replaceable> Route to the window you want to use.
307 </para>
308 </refsect1>
309 </refentry>
310 <refentry id='curlft'>
311 <refnamediv>
312 <refname>curlft</refname>
313 <refpurpose>Move the text cursor one character to the left.</refpurpose>
314 </refnamediv>
315
316
317 <refsynopsisdiv>
318 <cmdsynopsis>
319 <command>RUN GFX2 ( [path,] "CURLFT")</command>
320 </cmdsynopsis>
321 </refsynopsisdiv>
322
323 <refsect1><title>Parameters</title>
324 <para>
325
326 <replaceable>path</replaceable> Route to the window you want to use.
327 </para>
328 </refsect1>
329 </refentry>
330 <refentry id='curoff'>
331 <refnamediv>
332 <refname>curoff</refname>
333 <refpurpose>Make the cursor invisible.</refpurpose>
334 </refnamediv>
335
336
337 <refsynopsisdiv>
338 <cmdsynopsis>
339 <command>RUN GFX2 ( [path,] "CUROFF")</command>
340 </cmdsynopsis>
341 </refsynopsisdiv>
342
343 <refsect1><title>Parameters</title>
344 <para>
345
346 <replaceable>path</replaceable> Route to the window you want to use.
347 </para>
348 </refsect1>
349 </refentry>
350 <refentry id='curon'>
351 <refnamediv>
352 <refname>curon</refname>
353 <refpurpose>Makes the text cursor visible.</refpurpose>
354 </refnamediv>
355
356
357 <refsynopsisdiv>
358 <cmdsynopsis>
359 <command>RUN GFX2 ( [path,] "CURON")</command>
360 </cmdsynopsis>
361 </refsynopsisdiv>
362
363 <refsect1><title>Parameters</title>
364 <para>
365
366 <replaceable>path</replaceable> Route to the window you want to use.
367 </para>
368 </refsect1>
369 </refentry>
370 <refentry id='currgt'>
371 <refnamediv>
372 <refname>currgt</refname>
373 <refpurpose>Moves the text cursor one character to the right.</refpurpose>
374 </refnamediv>
375
376
377 <refsynopsisdiv>
378 <cmdsynopsis>
379 <command>RUN GFX2 ( [path,] "CURRGT")</command>
380 </cmdsynopsis>
381 </refsynopsisdiv>
382
383 <refsect1><title>Parameters</title>
384 <para>
385
386 <replaceable>path</replaceable> Route to the window you want to use.
387 </para>
388 </refsect1>
389 </refentry>
390 <refentry id='curup'>
391 <refnamediv>
392 <refname>curup</refname>
393 <refpurpose>Move the text cursor up one line.</refpurpose>
394 </refnamediv>
395
396
397 <refsynopsisdiv>
398 <cmdsynopsis>
399 <command>RUN GFX2 ( [path,] "CURUP")</command>
400 </cmdsynopsis>
401 </refsynopsisdiv>
402
403 <refsect1><title>Parameters</title>
404 <para>
405
406 <replaceable>path</replaceable> Route to the window you want to use.
407 </para>
408 </refsect1>
409 </refentry>
410 <refentry id='curxy'>
411 <refnamediv>
412 <refname>curxy</refname>
413 <refpurpose>Move the text cursor to X column and Y row.</refpurpose>
414 </refnamediv>
415
416
417 <refsynopsisdiv>
418 <cmdsynopsis>
419 <command>RUN GFX2 ( [path,] "CURXY", column, row)</command>
420 </cmdsynopsis>
421 </refsynopsisdiv>
422
423 <refsect1><title>Parameters</title>
424 <para>
425
426 <replaceable>path</replaceable> Route to the window you want to use.
427 <replaceable>column</replaceable> Horizontal position on the window.
428 <replaceable>row</replaceable> Vertical position on the window.
429
430 </para>
431 </refsect1>
432 <refsect1><title>Notes</title>
433 <para>
434 column and row are limited to the text size of the current window.
435 </para>
436 </refsect1>
437 </refentry>
438 <refentry id='cwarea'>
439 <refnamediv>
440 <refname>cwarea</refname>
441 <refpurpose>Changes/sets the working area on the window.</refpurpose>
442 </refnamediv>
443
444
445 <refsynopsisdiv>
446 <cmdsynopsis>
447 <command>RUN GFX2 ( [path,] "CWAREA", xcor, ycor, sizex, sizey)</command>
448 </cmdsynopsis>
449 </refsynopsisdiv>
450
451 <refsect1><title>Parameters</title>
452 <para>
453
454 <replaceable>path</replaceable> Route to the window you want to use.
455 <replaceable>xcor, ycor</replaceable> Upper left corner of the new working area, relative to
456 the original window. Coordinates are based on character
457 positions - not graphics locations.
458 <replaceable>sizex</replaceable> Number of character positions wide for the new area.
459 <replaceable>sizey</replaceable> Number of rows down for the new area.
460 </para>
461 </refsect1>
462 </refentry>
463 <refentry id='defbuff'>
464 <refnamediv>
465 <refname>defbuff</refname>
466 <refpurpose>Define a buffer for get/put operations.</refpurpose>
467 </refnamediv>
468
469
470 <refsynopsisdiv>
471 <cmdsynopsis>
472 <command>RUN GFX2 ("DEFBUFF", group, buffer, size)</command>
473 </cmdsynopsis>
474 </refsynopsisdiv>
475
476 <refsect1><title>Parameters</title>
477 <para>
478
479 <replaceable>group</replaceable> A reference number you select. Range 1-199.
480 <replaceable>buffer</replaceable> A number you assign to this buffer. Range 1-255.
481 <replaceable>size</replaceable> Size of this buffer. Range 1-8192 depending on how
482 much memory is available in this group.
483 </para>
484 </refsect1>
485 </refentry>
486 <refentry id='defcol'>
487 <refnamediv>
488 <refname>defcol</refname>
489 <refpurpose>Set palette registers to the default values.</refpurpose>
490 </refnamediv>
491
492
493 <refsynopsisdiv>
494 <cmdsynopsis>
495 <command>RUN GFX2 ( [path,] "DEFCOL")</command>
496 </cmdsynopsis>
497 </refsynopsisdiv>
498
499 <refsect1><title>Parameters</title>
500 <para>
501
502 <replaceable>path</replaceable> Route to the window you want to use.
503 </para>
504 </refsect1>
505 </refentry>
506 <refentry id='dellin'>
507 <refnamediv>
508 <refname>dellin</refname>
509 <refpurpose>Delete the line of text the cursor is on.</refpurpose>
510 </refnamediv>
511
512
513 <refsynopsisdiv>
514 <cmdsynopsis>
515 <command>RUN GFX2 ( [path,] "DELLIN")</command>
516 </cmdsynopsis>
517 </refsynopsisdiv>
518
519 <refsect1><title>Parameters</title>
520 <para>
521
522 <replaceable>path</replaceable> Route to the window you want to use.
523 </para>
524 </refsect1>
525 </refentry>
526 <refentry id='draw'>
527 <refnamediv>
528 <refname>draw</refname>
529 <refpurpose>Draw a polyline figure based on information in an option list.</refpurpose>
530 </refnamediv>
531
532
533 <refsynopsisdiv>
534 <cmdsynopsis>
535 <command>RUN GFX2 ( [path,] "DRAW", option list)</command>
536 </cmdsynopsis>
537 </refsynopsisdiv>
538
539 <refsect1><title>Parameters</title>
540 <para>
541
542 <replaceable>path</replaceable> Route to the window you want to use.
543 <replaceable>option list</replaceable> A string containing the draw options/instructions.
544
545 Options:
546 Nnum North (up) num units.
547 Snum South (down) num units.
548 Enum East (right) num units.
549 Wnum West (left) num units.
550 NEnum NorthEast (up &amp; right) num units.
551 NWnum NorthWest (up &amp; left) num units.
552 SEnum SouthEast (down &amp; right) num units.
553 SWnum SouthWest (down &amp; left) num units.
554 Aval Axis for north. 0=top 1=right 2=bottom 3=left
555 Uxcor, ycor Draw a line to x &amp; y coordinates relative to the
556 current draw pointer position.
557 Bxcor, ycor Blank move to x &amp; y coordinates relative to the current
558 draw pointer position.
559 </para>
560 </refsect1>
561 </refentry>
562 <refentry id='dwend'>
563 <refnamediv>
564 <refname>dwend</refname>
565 <refpurpose>Deallocates (ends) a device window.</refpurpose>
566 </refnamediv>
567
568
569 <refsynopsisdiv>
570 <cmdsynopsis>
571 <command>RUN GFX2 ( [path,] "DWEND")</command>
572 </cmdsynopsis>
573 </refsynopsisdiv>
574
575 <refsect1><title>Parameters</title>
576 <para>
577
578 <replaceable>path</replaceable> Route to the window you want to end.
579 </para>
580 </refsect1>
581 </refentry>
582 <refentry id='dwprotsw'>
583 <refnamediv>
584 <refname>dwprotsw</refname>
585 <refpurpose>Protect/unprotect a device window.</refpurpose>
586 </refnamediv>
587
588
589 <refsynopsisdiv>
590 <cmdsynopsis>
591 <command>RUN GFX2 ( [path,] "DWPROTSW", "switch")</command>
592 </cmdsynopsis>
593 </refsynopsisdiv>
594
595 <refsect1><title>Parameters</title>
596 <para>
597
598 <replaceable>path</replaceable> Route to the window you want to use.
599 <replaceable>switch</replaceable> "ON" to protect a window. "OFF" to unprotect.
600
601 </para>
602 </refsect1>
603 <refsect1><title>Notes</title>
604 <para>
605 Unprotected windowscan be covered by another window.
606 </para>
607 </refsect1>
608 </refentry>
609 <refentry id='dwset'>
610 <refnamediv>
611 <refname>dwset</refname>
612 <refpurpose>Define a device window.</refpurpose>
613 </refnamediv>
614
615
616 <refsynopsisdiv>
617 <cmdsynopsis>
618 <command>RUN GFX2 ( [path,] "DWSET", format, xcor, ycor, width, length,
619 foreground, background, border)</command>
620 </cmdsynopsis>
621 </refsynopsisdiv>
622
623 <refsect1><title>Parameters</title>
624 <para>
625
626 <replaceable>path</replaceable> Route to the window you want to define.
627 <replaceable>format</replaceable> Code for the type of screen to use.
628 <replaceable>xcor, ycor</replaceable> Coordinates for the upper left corner of the window.
629 <replaceable>width</replaceable> Width of the window, in characters.
630 <replaceable>length</replaceable> Length of the window, in rows.
631 <replaceable>foreground,</replaceable> Palettes to use for foreground, background, and
632 <replaceable>background,</replaceable> border colors.
633 <replaceable>border</replaceable>
634 </para>
635 </refsect1>
636 </refentry>
637 <refentry id='ellipse'>
638 <refnamediv>
639 <refname>ellipse</refname>
640 <refpurpose>Draws an ellipse.</refpurpose>
641 </refnamediv>
642
643
644 <refsynopsisdiv>
645 <cmdsynopsis>
646 <command>RUN GFX2 ( [path,] "ELLIPSE" [,xcor, ycor], xrad, yrad)</command>
647 </cmdsynopsis>
648 </refsynopsisdiv>
649
650 <refsect1><title>Parameters</title>
651 <para>
652
653 <replaceable>path</replaceable> Route to the window you want to use.
654 <replaceable>xcor, ycor</replaceable> Coordinates for the center of the ellipse.
655 <replaceable>xrad, yrad</replaceable> Radii of the ellipse's length and height.
656 </para>
657 </refsect1>
658 </refentry>
659 <refentry id='ereoline'>
660 <refnamediv>
661 <refname>ereoline</refname>
662 <refpurpose>Erase from the cursor to the end of the line.</refpurpose>
663 </refnamediv>
664
665
666 <refsynopsisdiv>
667 <cmdsynopsis>
668 <command>RUN GFX2 ( [path,] "EREOLINE")</command>
669 </cmdsynopsis>
670 </refsynopsisdiv>
671
672 <refsect1><title>Parameters</title>
673 <para>
674
675 <replaceable>path</replaceable> Route to the window you want to use.
676 </para>
677 </refsect1>
678 </refentry>
679 <refentry id='ereowndw'>
680 <refnamediv>
681 <refname>ereowndw</refname>
682 <refpurpose>Erase from the line the cursor is on to the end of the window.</refpurpose>
683 </refnamediv>
684
685
686 <refsynopsisdiv>
687 <cmdsynopsis>
688 <command>RUN GFX2 ( [path,] "EREOWNDW")</command>
689 </cmdsynopsis>
690 </refsynopsisdiv>
691
692 <refsect1><title>Parameters</title>
693 <para>
694
695 <replaceable>path</replaceable> Route to the window you want to use.
696 </para>
697 </refsect1>
698 </refentry>
699 <refentry id='erline'>
700 <refnamediv>
701 <refname>erline</refname>
702 <refpurpose>Delete the line of text the cursor is on.</refpurpose>
703 </refnamediv>
704
705
706 <refsynopsisdiv>
707 <cmdsynopsis>
708 <command>RUN GFX2 ( [path,] "ERLINE")</command>
709 </cmdsynopsis>
710 </refsynopsisdiv>
711
712 <refsect1><title>Parameters</title>
713 <para>
714
715 <replaceable>path</replaceable> Route to the window you want to use.
716 </para>
717 </refsect1>
718 </refentry>
719 <refentry id='fill'>
720 <refnamediv>
721 <refname>fill</refname>
722 <refpurpose>Fill (paint) a window, or a portion of it.</refpurpose>
723 </refnamediv>
724
725
726 <refsynopsisdiv>
727 <cmdsynopsis>
728 <command>RUN GFX2 ( [path,] "FILL" [,xcor, ycor])</command>
729 </cmdsynopsis>
730 </refsynopsisdiv>
731
732 <refsect1><title>Parameters</title>
733 <para>
734
735 <replaceable>path</replaceable> Route to the window you want to use.
736 <replaceable>xcor, ycor</replaceable> X &amp; Y coordinates to start the fill at.
737
738 </para>
739 </refsect1>
740 <refsect1><title>Notes</title>
741 <para>
742 Paints with the current foreground color. Only fills the area that's the
743 same color as the point where it starts.
744 </para>
745 </refsect1>
746 </refentry>
747 <refentry id='font'>
748 <refnamediv>
749 <refname>font</refname>
750 <refpurpose>Defines which buffer is to be used for graphic text characters.</refpurpose>
751 </refnamediv>
752
753
754 <refsynopsisdiv>
755 <cmdsynopsis>
756 <command>RUN GFX2 ( [path,] "FONT", group, buffer)</command>
757 </cmdsynopsis>
758 </refsynopsisdiv>
759
760 <refsect1><title>Parameters</title>
761 <para>
762
763 <replaceable>path</replaceable> Route to the window to be tied to the selected buffer.
764 <replaceable>group</replaceable> Group number that contains the selected buffer.
765 <replaceable>buffer</replaceable> Buffer number to use.
766 </para>
767 </refsect1>
768 </refentry>
769 <refentry id='gcset'>
770 <refnamediv>
771 <refname>gcset</refname>
772 <refpurpose>Select which graphics cursor to use.</refpurpose>
773 </refnamediv>
774
775
776 <refsynopsisdiv>
777 <cmdsynopsis>
778 <command>RUN GFX2 ("GCSET", group, buffer)</command>
779 </cmdsynopsis>
780 </refsynopsisdiv>
781
782 <refsect1><title>Parameters</title>
783 <para>
784
785 <replaceable>group</replaceable> Group number that has the buffer you want to use.
786 <replaceable>buffer</replaceable> Buffer number of the cursor image to use.
787 </para>
788 </refsect1>
789 </refentry>
790 <refentry id='get'>
791 <refnamediv>
792 <refname>get</refname>
793 <refpurpose>Store a portion of the window in a GET/PUT buffer.</refpurpose>
794 </refnamediv>
795
796
797 <refsynopsisdiv>
798 <cmdsynopsis>
799 <command>RUN GFX2 ( [path,] "GET", group, buffer, xcor, ycor, xsize, ysize)</command>
800 </cmdsynopsis>
801 </refsynopsisdiv>
802
803 <refsect1><title>Parameters</title>
804 <para>
805
806 <replaceable>path</replaceable> Route to the window you want to use.
807 <replaceable>group</replaceable> Group number that has the buffer to use.
808 <replaceable>buffer</replaceable> Buffer number to store the data in.
809 <replaceable>xcor, ycor</replaceable> X &amp; Y coordinates of the upper left corner to save.
810 <replaceable>xsize</replaceable> Horizontal size of the area to save.
811 <replaceable>ysize</replaceable> Vertical size of the area to save.
812 </para>
813 </refsect1>
814 </refentry>
815 <refentry id='gpload'>
816 <refnamediv>
817 <refname>gpload</refname>
818 <refpurpose>Load a GET/PUT buffer with image data.</refpurpose>
819 </refnamediv>
820
821
822 <refsynopsisdiv>
823 <cmdsynopsis>
824 <command>RUN GFX2 ("GPLOAD", group, buffer, format, xdim, ydim, size)</command>
825 </cmdsynopsis>
826 </refsynopsisdiv>
827
828 <refsect1><title>Parameters</title>
829 <para>
830
831 <replaceable>group</replaceable> Group number to associate this buffer with.
832 <replaceable>buffer</replaceable> Buffer number for the buffer you create.
833 <replaceable>format</replaceable> Type code for the screen format.
834 <replaceable>xdim, ydim</replaceable> X &amp; Y dimensions of the stored block.
835 <replaceable>size</replaceable> Size of the buffer in bytes. 1 to 8 Kbytes.
836 </para>
837 </refsect1>
838 </refentry>
839 <refentry id='inslin'>
840 <refnamediv>
841 <refname>inslin</refname>
842 <refpurpose>Insert a blank line at the cursor position.</refpurpose>
843 </refnamediv>
844
845
846 <refsynopsisdiv>
847 <cmdsynopsis>
848 <command>RUN GFX2 ( [path,] "INSLIN")</command>
849 </cmdsynopsis>
850 </refsynopsisdiv>
851
852 <refsect1><title>Parameters</title>
853 <para>
854
855 <replaceable>path</replaceable> Route to the window you want to use.
856 </para>
857 </refsect1>
858 </refentry>
859 <refentry id='killbuff'>
860 <refnamediv>
861 <refname>killbuff</refname>
862 <refpurpose>Deallocate a GET/PUT buffer.</refpurpose>
863 </refnamediv>
864
865
866 <refsynopsisdiv>
867 <cmdsynopsis>
868 <command>RUN GFX2 ("KILLBUFF", group, buffer)</command>
869 </cmdsynopsis>
870 </refsynopsisdiv>
871
872 <refsect1><title>Parameters</title>
873 <para>
874
875 <replaceable>group</replaceable> Group number of the buffer to get rid of. 1 to 199.
876 <replaceable>buffer</replaceable> Buffer number to deallocate. 1 to 255.
877 </para>
878 </refsect1>
879 </refentry>
880 <refentry id='line'>
881 <refnamediv>
882 <refname>line</refname>
883 <refpurpose>Draw a line.</refpurpose>
884 </refnamediv>
885
886
887 <refsynopsisdiv>
888 <cmdsynopsis>
889 <command>RUN GFX2 ( [path,] "LINE" [,xcor1, ycor1], xcor2, ycor2)</command>
890 </cmdsynopsis>
891 </refsynopsisdiv>
892
893 <refsect1><title>Parameters</title>
894 <para>
895
896 <replaceable>path</replaceable> Route to the window you want to use.
897 <replaceable>xcor1, ycor1</replaceable> X &amp; Y coordinates for the start of the line.
898 <replaceable>xcor2, ycor2</replaceable> X &amp; Y coordinates for the end of the line.
899 </para>
900 </refsect1>
901 </refentry>
902 <refentry id='logic'>
903 <refnamediv>
904 <refname>logic</refname>
905 <refpurpose>Sets the logic type to be used on drawing functions.</refpurpose>
906 </refnamediv>
907
908
909 <refsynopsisdiv>
910 <cmdsynopsis>
911 <command>RUN GFX2 ("LOGIC", "function")</command>
912 </cmdsynopsis>
913 </refsynopsisdiv>
914
915 <refsect1><title>Parameters</title>
916 <para>
917
918 <replaceable>function</replaceable> "OFF" - no logic is used.
919 "AND" - AND logic is used.
920 "OR" - OR logic is used.
921 "XOR" - XOR logic is used.
922 </para>
923 </refsect1>
924 </refentry>
925 <refentry id='owend'>
926 <refnamediv>
927 <refname>owend</refname>
928 <refpurpose>Deallocate the specified overlay window.</refpurpose>
929 </refnamediv>
930
931
932 <refsynopsisdiv>
933 <cmdsynopsis>
934 <command>RUN GFX2 ([path,] "OWEND")</command>
935 </cmdsynopsis>
936 </refsynopsisdiv>
937
938 <refsect1><title>Parameters</title>
939 <para>
940
941 <replaceable>path</replaceable> Route to the window you want to end.
942
943 </para>
944 </refsect1>
945 <refsect1><title>Notes</title>
946 <para>
947 The book doesn't give a specific example of this function.
948 </para>
949 </refsect1>
950 </refentry>
951 <refentry id='owset'>
952 <refnamediv>
953 <refname>owset</refname>
954 <refpurpose>Create an overlay window.</refpurpose>
955 </refnamediv>
956
957
958 <refsynopsisdiv>
959 <cmdsynopsis>
960 <command>RUN GFX2 ( [path,] "OWSET", save switch, xpos, ypos, xsize, ysize,
961 foreground, backgound)</command>
962 </cmdsynopsis>
963 </refsynopsisdiv>
964
965 <refsect1><title>Parameters</title>
966 <para>
967
968 <replaceable>path</replaceable> Route to the window to be overlaid.
969 <replaceable>save switch</replaceable> 0 = Don't save overlaid area. 1 = Save overlaid area.
970 <replaceable>xpos, ypos</replaceable> X &amp; Y character positions for upper left corner.
971 <replaceable>xsize</replaceable> Width of overlay window in characters.
972 <replaceable>ysize</replaceable> Depth of overlay window in rows.
973 <replaceable>foreground,</replaceable> Palettes to use for overlay foreground &amp; background.
974 <replaceable>background</replaceable>
975 </para>
976 </refsect1>
977 </refentry>
978 <refentry id='palette'>
979 <refnamediv>
980 <refname>palette</refname>
981 <refpurpose>Set the color of a palette register.</refpurpose>
982 </refnamediv>
983
984
985 <refsynopsisdiv>
986 <cmdsynopsis>
987 <command>RUN GFX2 ( [path,] "PALETTE", register, color)</command>
988 </cmdsynopsis>
989 </refsynopsisdiv>
990
991 <refsect1><title>Parameters</title>
992 <para>
993
994 <replaceable>path</replaceable> Route to the window you want to use.
995 <replaceable>register</replaceable> Palette register number to set.
996 <replaceable>color</replaceable> Value to set in register. 0 to 63.
997 </para>
998 </refsect1>
999 </refentry>
1000 <refentry id='pattern'>
1001 <refnamediv>
1002 <refname>pattern</refname>
1003 <refpurpose>Select the pattern buffer to use.</refpurpose>
1004 </refnamediv>
1005
1006
1007 <refsynopsisdiv>
1008 <cmdsynopsis>
1009 <command>RUN GFX2 ( [path,] "PATTERN", group, buffer)</command>
1010 </cmdsynopsis>
1011 </refsynopsisdiv>
1012
1013 <refsect1><title>Parameters</title>
1014 <para>
1015
1016 <replaceable>path</replaceable> Route to the window to associate with the buffer.
1017 <replaceable>group</replaceable> Group number that contains the buffer.
1018 <replaceable>buffer</replaceable> Buffer number for the patterns.
1019 </para>
1020 </refsect1>
1021 </refentry>
1022 <refentry id='point'>
1023 <refnamediv>
1024 <refname>point</refname>
1025 <refpurpose>Set a point to current foreground color.</refpurpose>
1026 </refnamediv>
1027
1028
1029 <refsynopsisdiv>
1030 <cmdsynopsis>
1031 <command>RUN GFX2 ( [path,] "POINT" [,xcor, ycor])</command>
1032 </cmdsynopsis>
1033 </refsynopsisdiv>
1034
1035 <refsect1><title>Parameters</title>
1036 <para>
1037
1038 <replaceable>path</replaceable> Route to the window you want to use.
1039 <replaceable>xcor, ycor</replaceable> X &amp; Y coordinates of location to set.
1040 </para>
1041 </refsect1>
1042 </refentry>
1043 <refentry id='propsw'>
1044 <refnamediv>
1045 <refname>propsw</refname>
1046 <refpurpose>Set/reset the proportional text switch.</refpurpose>
1047 </refnamediv>
1048
1049
1050 <refsynopsisdiv>
1051 <cmdsynopsis>
1052 <command>RUN GFX2 ( [path,] "PROPSW", "switch")</command>
1053 </cmdsynopsis>
1054 </refsynopsisdiv>
1055
1056 <refsect1><title>Parameters</title>
1057 <para>
1058
1059 <replaceable>path</replaceable> Route to the window you want to use.
1060 <replaceable>switch</replaceable> "ON" = proportional spacing. "OFF" = fixed spacing.
1061 </para>
1062 </refsect1>
1063 </refentry>
1064 <refentry id='putgc'>
1065 <refnamediv>
1066 <refname>putgc</refname>
1067 <refpurpose>Place the graphics cursor anywhere on the screen.</refpurpose>
1068 </refnamediv>
1069
1070
1071 <refsynopsisdiv>
1072 <cmdsynopsis>
1073 <command>RUN GFX2 ( [path,] "PUTGC", xcor, ycor)</command>
1074 </cmdsynopsis>
1075 </refsynopsisdiv>
1076
1077 <refsect1><title>Parameters</title>
1078 <para>
1079
1080 <replaceable>path</replaceable> Route to the screen you want to use.
1081 <replaceable>xcor, ycor</replaceable> Screen X &amp; Y coordinates for the cursor location.
1082 </para>
1083 </refsect1>
1084 </refentry>
1085 <refentry id='put'>
1086 <refnamediv>
1087 <refname>put</refname>
1088 <refpurpose>Place a specified GET/PUT buffer on a window.</refpurpose>
1089 </refnamediv>
1090
1091
1092 <refsynopsisdiv>
1093 <cmdsynopsis>
1094 <command>RUN GFX2 ( [path,] "PUT", group, buffer, xcor, ycor)</command>
1095 </cmdsynopsis>
1096 </refsynopsisdiv>
1097
1098 <refsect1><title>Parameters</title>
1099 <para>
1100
1101 <replaceable>path</replaceable> Route to the window you want to use.
1102 <replaceable>group</replaceable> Group number containing the buffer you want to use.
1103 <replaceable>buffer</replaceable> Buffer number to put on the window.
1104 <replaceable>xcor, ycor</replaceable> X &amp; Y coordinates of the upper left corner.
1105 </para>
1106 </refsect1>
1107 </refentry>
1108 <refentry id='revoff'>
1109 <refnamediv>
1110 <refname>revoff</refname>
1111 <refpurpose>Turns reverse video off for characters.</refpurpose>
1112 </refnamediv>
1113
1114
1115 <refsynopsisdiv>
1116 <cmdsynopsis>
1117 <command>RUN GFX2 ( [path,] "REVOFF")</command>
1118 </cmdsynopsis>
1119 </refsynopsisdiv>
1120
1121 <refsect1><title>Parameters</title>
1122 <para>
1123
1124 <replaceable>path</replaceable> Route to the window you want to use.
1125 </para>
1126 </refsect1>
1127 </refentry>
1128 <refentry id='revon'>
1129 <refnamediv>
1130 <refname>revon</refname>
1131 <refpurpose>Turns reverse video on for characters.</refpurpose>
1132 </refnamediv>
1133
1134
1135 <refsynopsisdiv>
1136 <cmdsynopsis>
1137 <command>RUN GFX2 ( [path,] "REVON")</command>
1138 </cmdsynopsis>
1139 </refsynopsisdiv>
1140
1141 <refsect1><title>Parameters</title>
1142 <para>
1143
1144 <replaceable>path</replaceable> Route to the window you want to use.
1145 </para>
1146 </refsect1>
1147 </refentry>
1148 <refentry id='scalesw'>
1149 <refnamediv>
1150 <refname>scalesw</refname>
1151 <refpurpose>Turns scaling ON or OFF for graphics windows.</refpurpose>
1152 </refnamediv>
1153
1154
1155 <refsynopsisdiv>
1156 <cmdsynopsis>
1157 <command>RUN GFX2 ( [path,] "SCALESW", "switch")</command>
1158 </cmdsynopsis>
1159 </refsynopsisdiv>
1160
1161 <refsect1><title>Parameters</title>
1162 <para>
1163
1164 <replaceable>path</replaceable> Route to the window you want to use.
1165 <replaceable>switch</replaceable> "ON" = coordinates act as if the window was 640 x 192.
1166 "OFF" = coordinates are relative to the window origin.
1167
1168 </para>
1169 </refsect1>
1170 <refsect1><title>Notes</title>
1171 <para>
1172 Scaling does not affect text.
1173 </para>
1174 </refsect1>
1175 </refentry>
1176 <refentry id='select'>
1177 <refnamediv>
1178 <refname>select</refname>
1179 <refpurpose>Select (change) which window is active for input/output.</refpurpose>
1180 </refnamediv>
1181
1182
1183 <refsynopsisdiv>
1184 <cmdsynopsis>
1185 <command>RUN GFX2 ( [path,] "SELECT")</command>
1186 </cmdsynopsis>
1187 </refsynopsisdiv>
1188
1189 <refsect1><title>Parameters</title>
1190 <para>
1191
1192 <replaceable>path</replaceable> Route to the window you want to select.
1193 </para>
1194 </refsect1>
1195 </refentry>
1196 <refentry id='setdptr'>
1197 <refnamediv>
1198 <refname>setdptr</refname>
1199 <refpurpose>Position the drawing pointer.</refpurpose>
1200 </refnamediv>
1201
1202
1203 <refsynopsisdiv>
1204 <cmdsynopsis>
1205 <command>RUN GFX2 ( [path,] "SETDPTR", xcor, ycor)</command>
1206 </cmdsynopsis>
1207 </refsynopsisdiv>
1208
1209 <refsect1><title>Parameters</title>
1210 <para>
1211
1212 <replaceable>path</replaceable> Route to the window you want to use.
1213 <replaceable>xcor, ycor</replaceable> X &amp; Y coordinates to move the draw pointer to.
1214 </para>
1215 </refsect1>
1216 </refentry>
1217 <refentry id='undlnoff'>
1218 <refnamediv>
1219 <refname>undlnoff</refname>
1220 <refpurpose>Turns character underlining off.</refpurpose>
1221 </refnamediv>
1222
1223
1224 <refsynopsisdiv>
1225 <cmdsynopsis>
1226 <command>RUN GFX2 ( [path,] "UNDLNOFF")</command>
1227 </cmdsynopsis>
1228 </refsynopsisdiv>
1229
1230 <refsect1><title>Parameters</title>
1231 <para>
1232
1233 <replaceable>path</replaceable> Route to the window where you want underlining off.
1234 </para>
1235 </refsect1>
1236 </refentry>
1237 <refentry id='undlnon'>
1238 <refnamediv>
1239 <refname>undlnon</refname>
1240 <refpurpose>Turns character underlining on.</refpurpose>
1241 </refnamediv>
1242
1243
1244 <refsynopsisdiv>
1245 <cmdsynopsis>
1246 <command>RUN GFX2 ( [path,] "UNDLNON")</command>
1247 </cmdsynopsis>
1248 </refsynopsisdiv>
1249
1250 <refsect1><title>Parameters</title>
1251 <para>
1252
1253 <replaceable>path</replaceable> Route to the window where you want underlining on.
1254 </para>
1255 </refsect1>
1256 </refentry>
1257
1258 </appendix>