Mercurial > hg > Members > kono > nitros9-code
changeset 973:07a25643d033
Added gfx2 information
| author | roug |
|---|---|
| date | Sat, 01 Feb 2003 16:04:39 +0000 |
| parents | 2ccaf038d1c6 |
| children | febcdde1466a |
| files | docs/basic09/basic09.docbook docs/basic09/gfx2.appendix |
| diffstat | 2 files changed, 1321 insertions(+), 62 deletions(-) [+] |
line wrap: on
line diff
--- a/docs/basic09/basic09.docbook Fri Jan 31 23:40:53 2003 +0000 +++ b/docs/basic09/basic09.docbook Sat Feb 01 16:04:39 2003 +0000 @@ -3,6 +3,7 @@ "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ <!ENTITY b09 "BASIC09"> <!ENTITY mdash "—"> + <!ENTITY gfx2app SYSTEM "gfx2.appendix"> ]> <book id="basic09" lang="en"> <bookinfo> @@ -106,7 +107,7 @@ <listitem> <para> -Graphics Interface Module for Access to Dragon Computer Colour +Graphics Interface Module for Access to Dragon Computer Color Graphics Functions </para> </listitem> @@ -7324,7 +7325,7 @@ <title>The &b09; Graphics Interface Module</title> <para> The Graphics Interface module provides a simple and convenient -way to access the colour graphics and joystick functions of the +way to access the color graphics and joystick functions of the Dragon Computer from &b09; programs. The module is a program written in assembly language and stored in a file called "GFX". It can be loaded into memory using the OS-9 "LOAD" command prior to or @@ -7335,24 +7336,24 @@ <para> "GFX" is called using the &b09; "RUN" statement. The first parameter passed is the name of the graphics function desired. -Other parameters are used to pass coordinates, colour modes, etc. -</para> -<para> -The are two basic graphics modes: 4-colour having 128 by 192 -pixel resolution, and 2-colour having 256 by 192 pixel resolution. +Other parameters are used to pass coordinates, color modes, etc. +</para> +<para> +The are two basic graphics modes: 4-color having 128 by 192 +pixel resolution, and 2-color having 256 by 192 pixel resolution. The display is treated as a 256 by 192 point grid with coordinates 0,0 in the lower left-hand corner. X (horizontal) coordinates in either mode must be in the range of 0 to 255. An X-coordinate greater than 255 will cause a run-time error. Y coordinates (vertical) must be in the range of 0 to 191. A number greater than 191 will be replaced by 191. Some of the graphics functions require -or optionally accept a colour mode which controls the foreground -colour and colour set. The mode and colour codes are given in the +or optionally accept a color mode which controls the foreground +color and color set. The mode and color codes are given in the table on the next page. </para> <beginpage/> <table frame="none"> - <title>Colour Graphics Modes and Colour Codes</title> + <title>Color Graphics Modes and Color Codes</title> <tgroup cols="6"> <colspec colname="c1" colwidth="0.6in"/> <colspec colname="c2" colwidth="0.4in"/> @@ -7362,9 +7363,9 @@ <colspec colname="c6" colwidth="1in"/> <thead> <row> -<entry morerows="1" namest="c2">Colour Code</entry> -<entry align="center" namest="c3" nameend="c4">Two Colour Format</entry> -<entry align="center" namest="c5" nameend="c6">Four Colour Format</entry> +<entry morerows="1" namest="c2">Color Code</entry> +<entry align="center" namest="c3" nameend="c4">Two Color Format</entry> +<entry align="center" namest="c5" nameend="c6">Four Color Format</entry> </row> <row> <entry namest="c3">Background</entry> @@ -7375,7 +7376,7 @@ </thead> <tbody> <row> -<entry morerows="3" valign="middle">Colour Set 1</entry> +<entry morerows="3" valign="middle">Color Set 1</entry> <entry align="center">00</entry> <entry align="left">Black</entry> <entry align="left">Black</entry> @@ -7400,7 +7401,7 @@ <entry align="left">Red</entry> </row> <row> -<entry morerows="3" valign="middle">Colour Set 2</entry> +<entry morerows="3" valign="middle">Color Set 2</entry> <entry align="center">04</entry> <entry align="left">Black</entry> <entry align="left">Black</entry> @@ -7425,7 +7426,7 @@ <entry align="left">Orange</entry> </row> <row> -<entry morerows="3" valign="middle">Colour Set 3*</entry> +<entry morerows="3" valign="middle">Color Set 3*</entry> <entry align="center">08</entry> <entry namest="c5" align="left">Black</entry> <entry align="left">Black</entry> @@ -7446,7 +7447,7 @@ <entry align="left">Light Green</entry> </row> <row> -<entry morerows="3" valign="middle">Colour Set 4*</entry> +<entry morerows="3" valign="middle">Color Set 4*</entry> <entry align="center">12</entry> <entry namest="c5" align="left">Black</entry> <entry align="left">Black</entry> @@ -7471,20 +7472,20 @@ </table> <note> <para> -Colour Sets 3 and 4 are not available on PAL video system +Color Sets 3 and 4 are not available on PAL video system (U.K. and European) models. </para> </note> <bridgehead renderas="sect2">MODE</bridgehead> <cmdsynopsis> -<command>Calling Syntax: RUN GFX("Mode",Format,Colour)</command> +<command>RUN GFX("Mode",<replaceable>format,color</replaceable>)</command> </cmdsynopsis> <para> MODE switches the screen from alphanumeric to graphics display mode, -and selects the screen mode and colour mode. "Format" determines -between two-colour (Format = 0), or four-colour (Format = 1) -graphics modes. "Colour" is the initial colour code that specifies -the foreground colour and colour set. +and selects the screen mode and color mode. "Format" determines +between two-color (Format = 0), or four-color (Format = 1) +graphics modes. "Color" is the initial color code that specifies +the foreground color and color set. </para> <para> This command must be given before aby other graphics command is @@ -7497,12 +7498,12 @@ <programlisting> RUN GFX("Mode",1,3) </programlisting> -selects four-colour mode graphics is used, and the initial -foreground colour is red. +selects four-color mode graphics is used, and the initial +foreground color is red. </para> <bridgehead renderas="sect2">MOVE</bridgehead> <cmdsynopsis> -<command>Calling Syntax: RUN GFX("Move",X,Y)</command> +<command>RUN GFX("Move",<replaceable>x,y</replaceable>)</command> </cmdsynopsis> <para> MOVE positions the (invisible) graphics cursor to the specified @@ -7518,58 +7519,58 @@ </para> <bridgehead renderas="sect2">COLOR</bridgehead> <cmdsynopsis> -<command>Calling Syntax: RUN GFX("Color",Colour)</command> +<command>RUN GFX("Color",<replaceable>color</replaceable>)</command> </cmdsynopsis> <para> -COLOR changes the current foreground colour (and possibly the colour +COLOR changes the current foreground color (and possibly the color set). The current graphics mode and cursor position are not changed. For example: <programlisting> RUN GFX("Color",0) </programlisting> -changes the foreground colour to green in four-colour format (or -black in two-colour format). +changes the foreground color to green in four-color format (or +black in two-color format). </para> <bridgehead renderas="sect2">POINT</bridgehead> <cmdsynopsis> -<command>Calling Syntax: RUN GFX("Point",X,Y) or</command><sbr/> -<command>RUN GFX("Point",X,Y,Colour)</command> +<command>RUN GFX("Point",<replaceable>x,y</replaceable>) or</command><sbr/> +<command>RUN GFX("Point",<replaceable>x,y,color</replaceable>)</command> </cmdsynopsis> <para> POINT moves the graphics cursor to the specified X.Y coordinate and -sets the pixel at that coordinate to the current foreground colour. -If the optional "Colour" is specified, the current foreground colour -is set to the given "Colour". For example: +sets the pixel at that coordinate to the current foreground color. +If the optional "Color" is specified, the current foreground color +is set to the given "Color". For example: <programlisting> RUN GFX("Point",0,192,1) </programlisting> Point moves the cursor to the upper left-hand corner and changes -the foreground colour to green in two-colour format, or it changes -the colour to yellow in the four-colour format. +the foreground color to green in two-color format, or it changes +the color to yellow in the four-color format. </para> <bridgehead renderas="sect2">CLEAR</bridgehead> <cmdsynopsis> -<command>Calling Syntax: RUN GFX("Clear") or</command><sbr/> -<command>RUN GFX("Clear",Colour)</command> +<command>RUN GFX("Clear") or</command><sbr/> +<command>RUN GFX("Clear",<replaceable>color</replaceable>)</command> </cmdsynopsis> <para> -CLEAR resets all points on the screen to the background colour, or -if the optional colour is given presets the screen to that colour. +CLEAR resets all points on the screen to the background color, or +if the optional color is given presets the screen to that color. The current graphics cursor is reset to (0,0). </para> <bridgehead renderas="sect2">LINE</bridgehead> <cmdsynopsis> -<command>Calling Syntax: RUN GFX("Line",x2,y2)</command><sbr/> -<command>RUN GFX("Line",x2,y2,Colour)</command><sbr/> -<command>RUN GFX("Line",x1,y1,x2,y2)</command><sbr/> -<command>RUN GFX("Line",x1,y1,x2,y2,Colour)</command> +<command>RUN GFX("Line",<replaceable>x2,y2</replaceable>)</command><sbr/> +<command>RUN GFX("Line",<replaceable>x2,y2,color</replaceable>)</command><sbr/> +<command>RUN GFX("Line",<replaceable>x1,y1,x2,y2</replaceable>)</command><sbr/> +<command>RUN GFX("Line",<replaceable>x1,y1,x2,y2,color</replaceable>)</command> </cmdsynopsis> <para> LINE draw lines in various ways. If one coordinate is given, the line will be drawn from the current graphics cursor position to the coordinates specified. If two sets of coordinates are given, they are used as the start and end points of the line. The line will be -drawn in the current foreground colour unless a new colour is given +drawn in the current foreground color unless a new color is given as a parameter. After the line is drawn the graphics cursor will be positioned at x2,y2. For example <programlisting> @@ -7579,24 +7580,24 @@ <programlisting> RUN GFX("line",24,65,2) </programlisting> -draws a blue line (4-colour mode) to point 24,65. +draws a blue line (4-color mode) to point 24,65. </para> <bridgehead renderas="sect2">CIRCLE</bridgehead> <cmdsynopsis> -<command>Calling Syntax: RUN GFX("Circle",Radius)</command><sbr/> -<command>RUN GFX("Circle",Radius,Colour)</command><sbr/> -<command>RUN GFX("Circle",X,Y,Radius)</command><sbr/> -<command>RUN GFX("Circle",X,Y,Radius,Colour)</command> +<command>RUN GFX("Circle",<replaceable>radius</replaceable>)</command><sbr/> +<command>RUN GFX("Circle",<replaceable>radius,color</replaceable>)</command><sbr/> +<command>RUN GFX("Circle",<replaceable>x,y,radius</replaceable>)</command><sbr/> +<command>RUN GFX("Circle",<replaceable>x,y,radius,color</replaceable>)</command> </cmdsynopsis> <para> CIRCLE draws a circle of the given radius. The current graphics cursor position is assumed if no X,Y value is given. The current -foreground colour is assumed if the Colour parameter is not used. +foreground color is assumed if the Color parameter is not used. The center of the circle must be on the screen. </para> <bridgehead renderas="sect2">ALPHA</bridgehead> <cmdsynopsis> -<command>Calling Syntax: RUN GFX("Alpha")</command> +<command>RUN GFX("Alpha")</command> </cmdsynopsis> <para> Alpha is a quick convenient way of getting the screen back to @@ -7605,7 +7606,7 @@ </para> <bridgehead renderas="sect2">QUIT</bridgehead> <cmdsynopsis> -<command>Calling Syntax: RUN GFX("Quit")</command> +<command>RUN GFX("Quit")</command> </cmdsynopsis> <para> QUIT switches the screen back to alpha mode and returns the 6K byte @@ -7613,7 +7614,7 @@ </para> <bridgehead renderas="sect2">GLOC</bridgehead> <cmdsynopsis> -<command>Calling Syntax: RUN GFX("Gloc",Vdisp)</command> +<command>RUN GFX("Gloc",<replaceable>vdisp</replaceable>)</command> </cmdsynopsis> <para> GLOC returns the address of the video display RAM as an integer number. @@ -7624,18 +7625,18 @@ </para> <bridgehead renderas="sect2">GCOLR</bridgehead> <cmdsynopsis> -<command>Calling Syntax: RUN GFX("Gcolr",Colour)</command><sbr/> -<command>RUN GFX("Gcolr",X,Y,Colour)</command> +<command>RUN GFX("Gcolr",<replaceable>color</replaceable>)</command><sbr/> +<command>RUN GFX("Gcolr",<replaceable>x,y,color</replaceable>)</command> </cmdsynopsis> <para> -GCOLR is used to read the colour of the pixel at the current +GCOLR is used to read the color of the pixel at the current graphics cursor position, or from the coordinates X,Y. The -parameter "Colour" may be an integer or a byte variable in which the -colour code is returned. +parameter "Color" may be an integer or a byte variable in which the +color code is returned. </para> <bridgehead renderas="sect2">JOYSTK</bridgehead> <cmdsynopsis> -<command>Calling Syntax: RUN GFX("Joystk",Stick,Fire,X,Y)</command> +<command>RUN GFX("Joystk",<replaceable>stick,fire,x,y</replaceable>)</command> </cmdsynopsis> <para> JOYSTK returns the status of the specified joystick's Fire button, @@ -7713,5 +7714,5 @@ </para> </appendix> - +&gfx2app; </book>
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/docs/basic09/gfx2.appendix Sat Feb 01 16:04:39 2003 +0000 @@ -0,0 +1,1258 @@ +<appendix> +<title>GFX2: CoCo3 Graphics Subroutine Module</title> + +<refentry id='arc'> +<refnamediv> +<refname>arc</refname> +<refpurpose>Draw an arc.</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<cmdsynopsis> +<command>RUN GFX2 ( [path,] "ARC" [,mx, my], xrad, yrad, xcor1, ycor1, +xcor2, ycor2)</command> +</cmdsynopsis> +</refsynopsisdiv> + +<refsect1><title>Parameters</title> +<para> + +<replaceable>path</replaceable> Route to the window you want to use. +<replaceable>mx, my</replaceable> X & Y coordinates for the center of the arc. +<replaceable>xrad</replaceable> Radius of the arcs width. +<replaceable>yrad</replaceable> Radius of the arcs height. +<replaceable>xcor1, ycor1</replaceable> Beginning and ending coordinates for an imaginary +<replaceable>xcor2, ycor2</replaceable> line relative to the center of the arc (0, 0) that + GFX2 uses for drawing the arc. Drawing starts at + the point of the arc closest to xcor1, ycor1. +</para> +</refsect1> +</refentry> +<refentry id='bar'> +<refnamediv> +<refname>bar</refname> +<refpurpose>Draws a filled in rectangle.</refpurpose> +</refnamediv> + + +<refsynopsisdiv> +<cmdsynopsis> +<command>RUN GFX2 ( [path,] "BAR" [,xcor1, ycor1], xcor2, ycor2)</command> +</cmdsynopsis> +</refsynopsisdiv> + +<refsect1><title>Parameters</title> +<para> + +<replaceable>path</replaceable> Route to the window to draw in. +<replaceable>xcor1, ycor1</replaceable> Beginning coordinates of the rectangle. +<replaceable>xcor2, ycor2</replaceable> Ending coordinates of the rectangle. +</para> +</refsect1> +</refentry> +<refentry id='bell'> +<refnamediv> +<refname>bell</refname> +<refpurpose>Produce a beep through the terminal's speaker.</refpurpose> +</refnamediv> + + +<refsynopsisdiv> +<cmdsynopsis> +<command>RUN GFX2 ("BELL")</command> +</cmdsynopsis> +</refsynopsisdiv> + +<refsect1><title>Parameters</title> +<para> + None +</para> +</refsect1> +</refentry> +<refentry id='blnkoff'> +<refnamediv> +<refname>blnkoff</refname> +<refpurpose>Turn off blinking for characters being sent to a text window.</refpurpose> +</refnamediv> + + +<refsynopsisdiv> +<cmdsynopsis> +<command>RUN GFX2 ( [path,] "BLNKOFF")</command> +</cmdsynopsis> +</refsynopsisdiv> + +<refsect1><title>Parameters</title> +<para> + +<replaceable>path</replaceable> Route to the window you want to use. +</para> +</refsect1> +</refentry> +<refentry id='blnkon'> +<refnamediv> +<refname>blnkon</refname> +<refpurpose>Turn on blinking for characters being sent to a text window.</refpurpose> +</refnamediv> + + +<refsynopsisdiv> +<cmdsynopsis> +<command>RUN GFX2 ( [path,] "BLNKON")</command> +</cmdsynopsis> +</refsynopsisdiv> + +<refsect1><title>Parameters</title> +<para> + +<replaceable>path</replaceable> Route to the window you want to use. +</para> +</refsect1> +<refsect1><title>Notes</title> +<para> + Does not work on a graphics window. +</para> +</refsect1> +</refentry> +<refentry id='boldsw'> +<refnamediv> +<refname>boldsw</refname> +<refpurpose>Turn bold printing on or off for characters being printed.</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<cmdsynopsis> +<command>RUN GFX2 ( [path,] "BOLDSW", "switch")</command> +</cmdsynopsis> +</refsynopsisdiv> + +<refsect1><title>Parameters</title> +<para> + +<replaceable>path</replaceable> Route to the window you want to use. +<replaceable>switch</replaceable> "ON" to turn bold on. "OFF" to turn bold off. +</para> +</refsect1> +<refsect1><title>Notes</title> +<para> + Only works on a graphics window. +</para> +</refsect1> +</refentry> +<refentry id='border'> +<refnamediv> +<refname>border</refname> +<refpurpose>Set the border color palette.</refpurpose> +</refnamediv> + + +<refsynopsisdiv> +<cmdsynopsis> +<command>RUN GFX2 ( [path,] "BORDER", color)</command> +</cmdsynopsis> +</refsynopsisdiv> + +<refsect1><title>Parameters</title> +<para> + +<replaceable>path</replaceable> Route to the window you want to use. +<replaceable>color</replaceable> Palette number to use. +</para> +</refsect1> +</refentry> +<refentry id='box'> +<refnamediv> +<refname>box</refname> +<refpurpose>Draw a rectangle on a graphics window.</refpurpose> +</refnamediv> + + +<refsynopsisdiv> +<cmdsynopsis> +<command>RUN GFX2 ( [path,] "BOX" [,xcor1, ycor1], xcor2, ycor2)</command> +</cmdsynopsis> +</refsynopsisdiv> + +<refsect1><title>Parameters</title> +<para> + +<replaceable>path</replaceable> Route to the window you want to use. +<replaceable>xcor1, ycor1</replaceable> Beginning coordinates for the box. +<replaceable>xcor2, ycor2</replaceable> Ending coordinates for the box. +</para> +</refsect1> +</refentry> +<refentry id='circle'> +<refnamediv> +<refname>circle</refname> +<refpurpose>Draw a circle on a graphics window.</refpurpose> +</refnamediv> + + +<refsynopsisdiv> +<cmdsynopsis> +<command>RUN GFX2 ( [path,] "CIRCLE" [,xcor, ycor], radius)</command> +</cmdsynopsis> +</refsynopsisdiv> + +<refsect1><title>Parameters</title> +<para> + +<replaceable>path</replaceable> Route to the window you want to use. +<replaceable>xcor, ycor</replaceable> Coordinates to use as the center point. +<replaceable>radius</replaceable> Radius of the circle. +</para> +</refsect1> +</refentry> +<refentry id='clear'> +<refnamediv> +<refname>clear</refname> +<refpurpose>Clear the screen.</refpurpose> +</refnamediv> + + +<refsynopsisdiv> +<cmdsynopsis> +<command>RUN GFX2 ( [path,] "CLEAR")</command> +</cmdsynopsis> +</refsynopsisdiv> + +<refsect1><title>Parameters</title> +<para> + +<replaceable>path</replaceable> Route to the window you want to use. +</para> +</refsect1> +</refentry> +<refentry id='color'> +<refnamediv> +<refname>color</refname> +<refpurpose>Set the window colors.</refpurpose> +</refnamediv> + + +<refsynopsisdiv> +<cmdsynopsis> +<command>RUN GFX2 ( [path,] "COLOR", foreground [,background] [,border] )</command> +</cmdsynopsis> +</refsynopsisdiv> + +<refsect1><title>Parameters</title> +<para> + +<replaceable>path</replaceable> Route to the window you want to use. +<replaceable>foreground</replaceable> Register number to use for the foreground color. +<replaceable>background</replaceable> Register number to use for the background color. +<replaceable>border</replaceable> Register number to use for the border color. +</para> +</refsect1> +</refentry> +<refentry id='crrtn'> +<refnamediv> +<refname>crrtn</refname> +<refpurpose>Sends a carriage return to the window.</refpurpose> +</refnamediv> + + +<refsynopsisdiv> +<cmdsynopsis> +<command>RUN GFX2 ( [path,] "CRRTN")</command> +</cmdsynopsis> +</refsynopsisdiv> + +<refsect1><title>Parameters</title> +<para> + +<replaceable>path</replaceable> Route to the window you want to use. +</para> +</refsect1> +</refentry> +<refentry id='curdwn'> +<refnamediv> +<refname>curdwn</refname> +<refpurpose>Moves the cursor down one text line.</refpurpose> +</refnamediv> + + +<refsynopsisdiv> +<cmdsynopsis> +<command>RUN GFX2 ( [path,] "CURDWN")</command> +</cmdsynopsis> +</refsynopsisdiv> + +<refsect1><title>Parameters</title> +<para> + +<replaceable>path</replaceable> Route to the window you want to use. +</para> +</refsect1> +</refentry> +<refentry id='curhome'> +<refnamediv> +<refname>curhome</refname> +<refpurpose>Move the text cursor to the top left corner of the window.</refpurpose> +</refnamediv> + + +<refsynopsisdiv> +<cmdsynopsis> +<command>RUN GFX2 ( [path,] "CURHOME")</command> +</cmdsynopsis> +</refsynopsisdiv> + +<refsect1><title>Parameters</title> +<para> + +<replaceable>path</replaceable> Route to the window you want to use. +</para> +</refsect1> +</refentry> +<refentry id='curlft'> +<refnamediv> +<refname>curlft</refname> +<refpurpose>Move the text cursor one character to the left.</refpurpose> +</refnamediv> + + +<refsynopsisdiv> +<cmdsynopsis> +<command>RUN GFX2 ( [path,] "CURLFT")</command> +</cmdsynopsis> +</refsynopsisdiv> + +<refsect1><title>Parameters</title> +<para> + +<replaceable>path</replaceable> Route to the window you want to use. +</para> +</refsect1> +</refentry> +<refentry id='curoff'> +<refnamediv> +<refname>curoff</refname> +<refpurpose>Make the cursor invisible.</refpurpose> +</refnamediv> + + +<refsynopsisdiv> +<cmdsynopsis> +<command>RUN GFX2 ( [path,] "CUROFF")</command> +</cmdsynopsis> +</refsynopsisdiv> + +<refsect1><title>Parameters</title> +<para> + +<replaceable>path</replaceable> Route to the window you want to use. +</para> +</refsect1> +</refentry> +<refentry id='curon'> +<refnamediv> +<refname>curon</refname> +<refpurpose>Makes the text cursor visible.</refpurpose> +</refnamediv> + + +<refsynopsisdiv> +<cmdsynopsis> +<command>RUN GFX2 ( [path,] "CURON")</command> +</cmdsynopsis> +</refsynopsisdiv> + +<refsect1><title>Parameters</title> +<para> + +<replaceable>path</replaceable> Route to the window you want to use. +</para> +</refsect1> +</refentry> +<refentry id='currgt'> +<refnamediv> +<refname>currgt</refname> +<refpurpose>Moves the text cursor one character to the right.</refpurpose> +</refnamediv> + + +<refsynopsisdiv> +<cmdsynopsis> +<command>RUN GFX2 ( [path,] "CURRGT")</command> +</cmdsynopsis> +</refsynopsisdiv> + +<refsect1><title>Parameters</title> +<para> + +<replaceable>path</replaceable> Route to the window you want to use. +</para> +</refsect1> +</refentry> +<refentry id='curup'> +<refnamediv> +<refname>curup</refname> +<refpurpose>Move the text cursor up one line.</refpurpose> +</refnamediv> + + +<refsynopsisdiv> +<cmdsynopsis> +<command>RUN GFX2 ( [path,] "CURUP")</command> +</cmdsynopsis> +</refsynopsisdiv> + +<refsect1><title>Parameters</title> +<para> + +<replaceable>path</replaceable> Route to the window you want to use. +</para> +</refsect1> +</refentry> +<refentry id='curxy'> +<refnamediv> +<refname>curxy</refname> +<refpurpose>Move the text cursor to X column and Y row.</refpurpose> +</refnamediv> + + +<refsynopsisdiv> +<cmdsynopsis> +<command>RUN GFX2 ( [path,] "CURXY", column, row)</command> +</cmdsynopsis> +</refsynopsisdiv> + +<refsect1><title>Parameters</title> +<para> + +<replaceable>path</replaceable> Route to the window you want to use. +<replaceable>column</replaceable> Horizontal position on the window. +<replaceable>row</replaceable> Vertical position on the window. + +</para> +</refsect1> +<refsect1><title>Notes</title> +<para> +column and row are limited to the text size of the current window. +</para> +</refsect1> +</refentry> +<refentry id='cwarea'> +<refnamediv> +<refname>cwarea</refname> +<refpurpose>Changes/sets the working area on the window.</refpurpose> +</refnamediv> + + +<refsynopsisdiv> +<cmdsynopsis> +<command>RUN GFX2 ( [path,] "CWAREA", xcor, ycor, sizex, sizey)</command> +</cmdsynopsis> +</refsynopsisdiv> + +<refsect1><title>Parameters</title> +<para> + +<replaceable>path</replaceable> Route to the window you want to use. +<replaceable>xcor, ycor</replaceable> Upper left corner of the new working area, relative to + the original window. Coordinates are based on character + positions - not graphics locations. +<replaceable>sizex</replaceable> Number of character positions wide for the new area. +<replaceable>sizey</replaceable> Number of rows down for the new area. +</para> +</refsect1> +</refentry> +<refentry id='defbuff'> +<refnamediv> +<refname>defbuff</refname> +<refpurpose>Define a buffer for get/put operations.</refpurpose> +</refnamediv> + + +<refsynopsisdiv> +<cmdsynopsis> +<command>RUN GFX2 ("DEFBUFF", group, buffer, size)</command> +</cmdsynopsis> +</refsynopsisdiv> + +<refsect1><title>Parameters</title> +<para> + +<replaceable>group</replaceable> A reference number you select. Range 1-199. +<replaceable>buffer</replaceable> A number you assign to this buffer. Range 1-255. +<replaceable>size</replaceable> Size of this buffer. Range 1-8192 depending on how + much memory is available in this group. +</para> +</refsect1> +</refentry> +<refentry id='defcol'> +<refnamediv> +<refname>defcol</refname> +<refpurpose>Set palette registers to the default values.</refpurpose> +</refnamediv> + + +<refsynopsisdiv> +<cmdsynopsis> +<command>RUN GFX2 ( [path,] "DEFCOL")</command> +</cmdsynopsis> +</refsynopsisdiv> + +<refsect1><title>Parameters</title> +<para> + +<replaceable>path</replaceable> Route to the window you want to use. +</para> +</refsect1> +</refentry> +<refentry id='dellin'> +<refnamediv> +<refname>dellin</refname> +<refpurpose>Delete the line of text the cursor is on.</refpurpose> +</refnamediv> + + +<refsynopsisdiv> +<cmdsynopsis> +<command>RUN GFX2 ( [path,] "DELLIN")</command> +</cmdsynopsis> +</refsynopsisdiv> + +<refsect1><title>Parameters</title> +<para> + +<replaceable>path</replaceable> Route to the window you want to use. +</para> +</refsect1> +</refentry> +<refentry id='draw'> +<refnamediv> +<refname>draw</refname> +<refpurpose>Draw a polyline figure based on information in an option list.</refpurpose> +</refnamediv> + + +<refsynopsisdiv> +<cmdsynopsis> +<command>RUN GFX2 ( [path,] "DRAW", option list)</command> +</cmdsynopsis> +</refsynopsisdiv> + +<refsect1><title>Parameters</title> +<para> + +<replaceable>path</replaceable> Route to the window you want to use. +<replaceable>option list</replaceable> A string containing the draw options/instructions. + +Options: +Nnum North (up) num units. +Snum South (down) num units. +Enum East (right) num units. +Wnum West (left) num units. +NEnum NorthEast (up & right) num units. +NWnum NorthWest (up & left) num units. +SEnum SouthEast (down & right) num units. +SWnum SouthWest (down & left) num units. +Aval Axis for north. 0=top 1=right 2=bottom 3=left +Uxcor, ycor Draw a line to x & y coordinates relative to the + current draw pointer position. +Bxcor, ycor Blank move to x & y coordinates relative to the current + draw pointer position. +</para> +</refsect1> +</refentry> +<refentry id='dwend'> +<refnamediv> +<refname>dwend</refname> +<refpurpose>Deallocates (ends) a device window.</refpurpose> +</refnamediv> + + +<refsynopsisdiv> +<cmdsynopsis> +<command>RUN GFX2 ( [path,] "DWEND")</command> +</cmdsynopsis> +</refsynopsisdiv> + +<refsect1><title>Parameters</title> +<para> + +<replaceable>path</replaceable> Route to the window you want to end. +</para> +</refsect1> +</refentry> +<refentry id='dwprotsw'> +<refnamediv> +<refname>dwprotsw</refname> +<refpurpose>Protect/unprotect a device window.</refpurpose> +</refnamediv> + + +<refsynopsisdiv> +<cmdsynopsis> +<command>RUN GFX2 ( [path,] "DWPROTSW", "switch")</command> +</cmdsynopsis> +</refsynopsisdiv> + +<refsect1><title>Parameters</title> +<para> + +<replaceable>path</replaceable> Route to the window you want to use. +<replaceable>switch</replaceable> "ON" to protect a window. "OFF" to unprotect. + +</para> +</refsect1> +<refsect1><title>Notes</title> +<para> +Unprotected windowscan be covered by another window. +</para> +</refsect1> +</refentry> +<refentry id='dwset'> +<refnamediv> +<refname>dwset</refname> +<refpurpose>Define a device window.</refpurpose> +</refnamediv> + + +<refsynopsisdiv> +<cmdsynopsis> +<command>RUN GFX2 ( [path,] "DWSET", format, xcor, ycor, width, length, + foreground, background, border)</command> +</cmdsynopsis> +</refsynopsisdiv> + +<refsect1><title>Parameters</title> +<para> + +<replaceable>path</replaceable> Route to the window you want to define. +<replaceable>format</replaceable> Code for the type of screen to use. +<replaceable>xcor, ycor</replaceable> Coordinates for the upper left corner of the window. +<replaceable>width</replaceable> Width of the window, in characters. +<replaceable>length</replaceable> Length of the window, in rows. +<replaceable>foreground,</replaceable> Palettes to use for foreground, background, and +<replaceable>background,</replaceable> border colors. +<replaceable>border</replaceable> +</para> +</refsect1> +</refentry> +<refentry id='ellipse'> +<refnamediv> +<refname>ellipse</refname> +<refpurpose>Draws an ellipse.</refpurpose> +</refnamediv> + + +<refsynopsisdiv> +<cmdsynopsis> +<command>RUN GFX2 ( [path,] "ELLIPSE" [,xcor, ycor], xrad, yrad)</command> +</cmdsynopsis> +</refsynopsisdiv> + +<refsect1><title>Parameters</title> +<para> + +<replaceable>path</replaceable> Route to the window you want to use. +<replaceable>xcor, ycor</replaceable> Coordinates for the center of the ellipse. +<replaceable>xrad, yrad</replaceable> Radii of the ellipse's length and height. +</para> +</refsect1> +</refentry> +<refentry id='ereoline'> +<refnamediv> +<refname>ereoline</refname> +<refpurpose>Erase from the cursor to the end of the line.</refpurpose> +</refnamediv> + + +<refsynopsisdiv> +<cmdsynopsis> +<command>RUN GFX2 ( [path,] "EREOLINE")</command> +</cmdsynopsis> +</refsynopsisdiv> + +<refsect1><title>Parameters</title> +<para> + +<replaceable>path</replaceable> Route to the window you want to use. +</para> +</refsect1> +</refentry> +<refentry id='ereowndw'> +<refnamediv> +<refname>ereowndw</refname> +<refpurpose>Erase from the line the cursor is on to the end of the window.</refpurpose> +</refnamediv> + + +<refsynopsisdiv> +<cmdsynopsis> +<command>RUN GFX2 ( [path,] "EREOWNDW")</command> +</cmdsynopsis> +</refsynopsisdiv> + +<refsect1><title>Parameters</title> +<para> + +<replaceable>path</replaceable> Route to the window you want to use. +</para> +</refsect1> +</refentry> +<refentry id='erline'> +<refnamediv> +<refname>erline</refname> +<refpurpose>Delete the line of text the cursor is on.</refpurpose> +</refnamediv> + + +<refsynopsisdiv> +<cmdsynopsis> +<command>RUN GFX2 ( [path,] "ERLINE")</command> +</cmdsynopsis> +</refsynopsisdiv> + +<refsect1><title>Parameters</title> +<para> + +<replaceable>path</replaceable> Route to the window you want to use. +</para> +</refsect1> +</refentry> +<refentry id='fill'> +<refnamediv> +<refname>fill</refname> +<refpurpose>Fill (paint) a window, or a portion of it.</refpurpose> +</refnamediv> + + +<refsynopsisdiv> +<cmdsynopsis> +<command>RUN GFX2 ( [path,] "FILL" [,xcor, ycor])</command> +</cmdsynopsis> +</refsynopsisdiv> + +<refsect1><title>Parameters</title> +<para> + +<replaceable>path</replaceable> Route to the window you want to use. +<replaceable>xcor, ycor</replaceable> X & Y coordinates to start the fill at. + +</para> +</refsect1> +<refsect1><title>Notes</title> +<para> +Paints with the current foreground color. Only fills the area that's the +same color as the point where it starts. +</para> +</refsect1> +</refentry> +<refentry id='font'> +<refnamediv> +<refname>font</refname> +<refpurpose>Defines which buffer is to be used for graphic text characters.</refpurpose> +</refnamediv> + + +<refsynopsisdiv> +<cmdsynopsis> +<command>RUN GFX2 ( [path,] "FONT", group, buffer)</command> +</cmdsynopsis> +</refsynopsisdiv> + +<refsect1><title>Parameters</title> +<para> + +<replaceable>path</replaceable> Route to the window to be tied to the selected buffer. +<replaceable>group</replaceable> Group number that contains the selected buffer. +<replaceable>buffer</replaceable> Buffer number to use. +</para> +</refsect1> +</refentry> +<refentry id='gcset'> +<refnamediv> +<refname>gcset</refname> +<refpurpose>Select which graphics cursor to use.</refpurpose> +</refnamediv> + + +<refsynopsisdiv> +<cmdsynopsis> +<command>RUN GFX2 ("GCSET", group, buffer)</command> +</cmdsynopsis> +</refsynopsisdiv> + +<refsect1><title>Parameters</title> +<para> + +<replaceable>group</replaceable> Group number that has the buffer you want to use. +<replaceable>buffer</replaceable> Buffer number of the cursor image to use. +</para> +</refsect1> +</refentry> +<refentry id='get'> +<refnamediv> +<refname>get</refname> +<refpurpose>Store a portion of the window in a GET/PUT buffer.</refpurpose> +</refnamediv> + + +<refsynopsisdiv> +<cmdsynopsis> +<command>RUN GFX2 ( [path,] "GET", group, buffer, xcor, ycor, xsize, ysize)</command> +</cmdsynopsis> +</refsynopsisdiv> + +<refsect1><title>Parameters</title> +<para> + +<replaceable>path</replaceable> Route to the window you want to use. +<replaceable>group</replaceable> Group number that has the buffer to use. +<replaceable>buffer</replaceable> Buffer number to store the data in. +<replaceable>xcor, ycor</replaceable> X & Y coordinates of the upper left corner to save. +<replaceable>xsize</replaceable> Horizontal size of the area to save. +<replaceable>ysize</replaceable> Vertical size of the area to save. +</para> +</refsect1> +</refentry> +<refentry id='gpload'> +<refnamediv> +<refname>gpload</refname> +<refpurpose>Load a GET/PUT buffer with image data.</refpurpose> +</refnamediv> + + +<refsynopsisdiv> +<cmdsynopsis> +<command>RUN GFX2 ("GPLOAD", group, buffer, format, xdim, ydim, size)</command> +</cmdsynopsis> +</refsynopsisdiv> + +<refsect1><title>Parameters</title> +<para> + +<replaceable>group</replaceable> Group number to associate this buffer with. +<replaceable>buffer</replaceable> Buffer number for the buffer you create. +<replaceable>format</replaceable> Type code for the screen format. +<replaceable>xdim, ydim</replaceable> X & Y dimensions of the stored block. +<replaceable>size</replaceable> Size of the buffer in bytes. 1 to 8 Kbytes. +</para> +</refsect1> +</refentry> +<refentry id='inslin'> +<refnamediv> +<refname>inslin</refname> +<refpurpose>Insert a blank line at the cursor position.</refpurpose> +</refnamediv> + + +<refsynopsisdiv> +<cmdsynopsis> +<command>RUN GFX2 ( [path,] "INSLIN")</command> +</cmdsynopsis> +</refsynopsisdiv> + +<refsect1><title>Parameters</title> +<para> + +<replaceable>path</replaceable> Route to the window you want to use. +</para> +</refsect1> +</refentry> +<refentry id='killbuff'> +<refnamediv> +<refname>killbuff</refname> +<refpurpose>Deallocate a GET/PUT buffer.</refpurpose> +</refnamediv> + + +<refsynopsisdiv> +<cmdsynopsis> +<command>RUN GFX2 ("KILLBUFF", group, buffer)</command> +</cmdsynopsis> +</refsynopsisdiv> + +<refsect1><title>Parameters</title> +<para> + +<replaceable>group</replaceable> Group number of the buffer to get rid of. 1 to 199. +<replaceable>buffer</replaceable> Buffer number to deallocate. 1 to 255. +</para> +</refsect1> +</refentry> +<refentry id='line'> +<refnamediv> +<refname>line</refname> +<refpurpose>Draw a line.</refpurpose> +</refnamediv> + + +<refsynopsisdiv> +<cmdsynopsis> +<command>RUN GFX2 ( [path,] "LINE" [,xcor1, ycor1], xcor2, ycor2)</command> +</cmdsynopsis> +</refsynopsisdiv> + +<refsect1><title>Parameters</title> +<para> + +<replaceable>path</replaceable> Route to the window you want to use. +<replaceable>xcor1, ycor1</replaceable> X & Y coordinates for the start of the line. +<replaceable>xcor2, ycor2</replaceable> X & Y coordinates for the end of the line. +</para> +</refsect1> +</refentry> +<refentry id='logic'> +<refnamediv> +<refname>logic</refname> +<refpurpose>Sets the logic type to be used on drawing functions.</refpurpose> +</refnamediv> + + +<refsynopsisdiv> +<cmdsynopsis> +<command>RUN GFX2 ("LOGIC", "function")</command> +</cmdsynopsis> +</refsynopsisdiv> + +<refsect1><title>Parameters</title> +<para> + +<replaceable>function</replaceable> "OFF" - no logic is used. + "AND" - AND logic is used. + "OR" - OR logic is used. + "XOR" - XOR logic is used. +</para> +</refsect1> +</refentry> +<refentry id='owend'> +<refnamediv> +<refname>owend</refname> +<refpurpose>Deallocate the specified overlay window.</refpurpose> +</refnamediv> + + +<refsynopsisdiv> +<cmdsynopsis> +<command>RUN GFX2 ([path,] "OWEND")</command> +</cmdsynopsis> +</refsynopsisdiv> + +<refsect1><title>Parameters</title> +<para> + +<replaceable>path</replaceable> Route to the window you want to end. + +</para> +</refsect1> +<refsect1><title>Notes</title> +<para> +The book doesn't give a specific example of this function. +</para> +</refsect1> +</refentry> +<refentry id='owset'> +<refnamediv> +<refname>owset</refname> +<refpurpose>Create an overlay window.</refpurpose> +</refnamediv> + + +<refsynopsisdiv> +<cmdsynopsis> +<command>RUN GFX2 ( [path,] "OWSET", save switch, xpos, ypos, xsize, ysize, + foreground, backgound)</command> +</cmdsynopsis> +</refsynopsisdiv> + +<refsect1><title>Parameters</title> +<para> + +<replaceable>path</replaceable> Route to the window to be overlaid. +<replaceable>save switch</replaceable> 0 = Don't save overlaid area. 1 = Save overlaid area. +<replaceable>xpos, ypos</replaceable> X & Y character positions for upper left corner. +<replaceable>xsize</replaceable> Width of overlay window in characters. +<replaceable>ysize</replaceable> Depth of overlay window in rows. +<replaceable>foreground,</replaceable> Palettes to use for overlay foreground & background. +<replaceable>background</replaceable> +</para> +</refsect1> +</refentry> +<refentry id='palette'> +<refnamediv> +<refname>palette</refname> +<refpurpose>Set the color of a palette register.</refpurpose> +</refnamediv> + + +<refsynopsisdiv> +<cmdsynopsis> +<command>RUN GFX2 ( [path,] "PALETTE", register, color)</command> +</cmdsynopsis> +</refsynopsisdiv> + +<refsect1><title>Parameters</title> +<para> + +<replaceable>path</replaceable> Route to the window you want to use. +<replaceable>register</replaceable> Palette register number to set. +<replaceable>color</replaceable> Value to set in register. 0 to 63. +</para> +</refsect1> +</refentry> +<refentry id='pattern'> +<refnamediv> +<refname>pattern</refname> +<refpurpose>Select the pattern buffer to use.</refpurpose> +</refnamediv> + + +<refsynopsisdiv> +<cmdsynopsis> +<command>RUN GFX2 ( [path,] "PATTERN", group, buffer)</command> +</cmdsynopsis> +</refsynopsisdiv> + +<refsect1><title>Parameters</title> +<para> + +<replaceable>path</replaceable> Route to the window to associate with the buffer. +<replaceable>group</replaceable> Group number that contains the buffer. +<replaceable>buffer</replaceable> Buffer number for the patterns. +</para> +</refsect1> +</refentry> +<refentry id='point'> +<refnamediv> +<refname>point</refname> +<refpurpose>Set a point to current foreground color.</refpurpose> +</refnamediv> + + +<refsynopsisdiv> +<cmdsynopsis> +<command>RUN GFX2 ( [path,] "POINT" [,xcor, ycor])</command> +</cmdsynopsis> +</refsynopsisdiv> + +<refsect1><title>Parameters</title> +<para> + +<replaceable>path</replaceable> Route to the window you want to use. +<replaceable>xcor, ycor</replaceable> X & Y coordinates of location to set. +</para> +</refsect1> +</refentry> +<refentry id='propsw'> +<refnamediv> +<refname>propsw</refname> +<refpurpose>Set/reset the proportional text switch.</refpurpose> +</refnamediv> + + +<refsynopsisdiv> +<cmdsynopsis> +<command>RUN GFX2 ( [path,] "PROPSW", "switch")</command> +</cmdsynopsis> +</refsynopsisdiv> + +<refsect1><title>Parameters</title> +<para> + +<replaceable>path</replaceable> Route to the window you want to use. +<replaceable>switch</replaceable> "ON" = proportional spacing. "OFF" = fixed spacing. +</para> +</refsect1> +</refentry> +<refentry id='putgc'> +<refnamediv> +<refname>putgc</refname> +<refpurpose>Place the graphics cursor anywhere on the screen.</refpurpose> +</refnamediv> + + +<refsynopsisdiv> +<cmdsynopsis> +<command>RUN GFX2 ( [path,] "PUTGC", xcor, ycor)</command> +</cmdsynopsis> +</refsynopsisdiv> + +<refsect1><title>Parameters</title> +<para> + +<replaceable>path</replaceable> Route to the screen you want to use. +<replaceable>xcor, ycor</replaceable> Screen X & Y coordinates for the cursor location. +</para> +</refsect1> +</refentry> +<refentry id='put'> +<refnamediv> +<refname>put</refname> +<refpurpose>Place a specified GET/PUT buffer on a window.</refpurpose> +</refnamediv> + + +<refsynopsisdiv> +<cmdsynopsis> +<command>RUN GFX2 ( [path,] "PUT", group, buffer, xcor, ycor)</command> +</cmdsynopsis> +</refsynopsisdiv> + +<refsect1><title>Parameters</title> +<para> + +<replaceable>path</replaceable> Route to the window you want to use. +<replaceable>group</replaceable> Group number containing the buffer you want to use. +<replaceable>buffer</replaceable> Buffer number to put on the window. +<replaceable>xcor, ycor</replaceable> X & Y coordinates of the upper left corner. +</para> +</refsect1> +</refentry> +<refentry id='revoff'> +<refnamediv> +<refname>revoff</refname> +<refpurpose>Turns reverse video off for characters.</refpurpose> +</refnamediv> + + +<refsynopsisdiv> +<cmdsynopsis> +<command>RUN GFX2 ( [path,] "REVOFF")</command> +</cmdsynopsis> +</refsynopsisdiv> + +<refsect1><title>Parameters</title> +<para> + +<replaceable>path</replaceable> Route to the window you want to use. +</para> +</refsect1> +</refentry> +<refentry id='revon'> +<refnamediv> +<refname>revon</refname> +<refpurpose>Turns reverse video on for characters.</refpurpose> +</refnamediv> + + +<refsynopsisdiv> +<cmdsynopsis> +<command>RUN GFX2 ( [path,] "REVON")</command> +</cmdsynopsis> +</refsynopsisdiv> + +<refsect1><title>Parameters</title> +<para> + +<replaceable>path</replaceable> Route to the window you want to use. +</para> +</refsect1> +</refentry> +<refentry id='scalesw'> +<refnamediv> +<refname>scalesw</refname> +<refpurpose>Turns scaling ON or OFF for graphics windows.</refpurpose> +</refnamediv> + + +<refsynopsisdiv> +<cmdsynopsis> +<command>RUN GFX2 ( [path,] "SCALESW", "switch")</command> +</cmdsynopsis> +</refsynopsisdiv> + +<refsect1><title>Parameters</title> +<para> + +<replaceable>path</replaceable> Route to the window you want to use. +<replaceable>switch</replaceable> "ON" = coordinates act as if the window was 640 x 192. + "OFF" = coordinates are relative to the window origin. + +</para> +</refsect1> +<refsect1><title>Notes</title> +<para> +Scaling does not affect text. +</para> +</refsect1> +</refentry> +<refentry id='select'> +<refnamediv> +<refname>select</refname> +<refpurpose>Select (change) which window is active for input/output.</refpurpose> +</refnamediv> + + +<refsynopsisdiv> +<cmdsynopsis> +<command>RUN GFX2 ( [path,] "SELECT")</command> +</cmdsynopsis> +</refsynopsisdiv> + +<refsect1><title>Parameters</title> +<para> + +<replaceable>path</replaceable> Route to the window you want to select. +</para> +</refsect1> +</refentry> +<refentry id='setdptr'> +<refnamediv> +<refname>setdptr</refname> +<refpurpose>Position the drawing pointer.</refpurpose> +</refnamediv> + + +<refsynopsisdiv> +<cmdsynopsis> +<command>RUN GFX2 ( [path,] "SETDPTR", xcor, ycor)</command> +</cmdsynopsis> +</refsynopsisdiv> + +<refsect1><title>Parameters</title> +<para> + +<replaceable>path</replaceable> Route to the window you want to use. +<replaceable>xcor, ycor</replaceable> X & Y coordinates to move the draw pointer to. +</para> +</refsect1> +</refentry> +<refentry id='undlnoff'> +<refnamediv> +<refname>undlnoff</refname> +<refpurpose>Turns character underlining off.</refpurpose> +</refnamediv> + + +<refsynopsisdiv> +<cmdsynopsis> +<command>RUN GFX2 ( [path,] "UNDLNOFF")</command> +</cmdsynopsis> +</refsynopsisdiv> + +<refsect1><title>Parameters</title> +<para> + +<replaceable>path</replaceable> Route to the window where you want underlining off. +</para> +</refsect1> +</refentry> +<refentry id='undlnon'> +<refnamediv> +<refname>undlnon</refname> +<refpurpose>Turns character underlining on.</refpurpose> +</refnamediv> + + +<refsynopsisdiv> +<cmdsynopsis> +<command>RUN GFX2 ( [path,] "UNDLNON")</command> +</cmdsynopsis> +</refsynopsisdiv> + +<refsect1><title>Parameters</title> +<para> + +<replaceable>path</replaceable> Route to the window where you want underlining on. +</para> +</refsect1> +</refentry> + +</appendix>