v_arc()

VOID v_arc( handle, x, y, radius, startangle, endangle )

WORD handle, x, y, radius, startangle, endangle;

	v_arc() outputs an arc to the specified workstation.
Opcode	11
Sub-Opcode	2
Availability	Supported by all drivers. This function composes one of the 10 VDI GDP's (Generalized Drawing Primitives). Although all current drivers support all GDP's, their availability is not guaranteed and may vary. To check for a particular GDP refer to the table returned by v_opnvwk() or v_opnwk().
Parameters	handle is a valid workstation handle. x and y specify the center of an arc with a radius of radius and starting and ending angles of startangle and endangle specified in tenths of degrees as follows:
Binding	contrl[0] = 11; contrl[1] = 4; contrl[3] = contrl[5] = 2; contrl[6] = handle; intin[0] = startangle; intin[1] = endangle; ptsin[0] = x; ptsin[1] = y; ptsin[2] = ptsin[3] = ptsin[4] = ptsin[5] = 0; ptsin[6] = radius; ptsin[7] = 0; vdi();
See Also	vsl_color()

v_bar()

VOID v_bar( handle, pxy )

WORD handle;

WORD *pxy;

	v_bar() outputs a filled rectangle to the specified workstation.
Opcode	11
Sub-Opcode	1
Availability	Supported by all drivers. This function composes one of the 10 VDI GDP's (Generalized Drawing Primitives). Although all current drivers support all GDP's, their availability is not guaranteed and may vary. To check for a particular GDP refer to the table returned by v_opnvwk() or v_opnwk().
Parameters	handle is a valid workstation handle. pxy points to an array of four WORDs specifying a VDI format rectangle to output.
Binding	contrl[0] = 11; contrl[1] = 2; contrl[3] = 0; contrl[5] = 1; contrl[6] = handle; ptsin[0] = pxy[0]; ptsin[1] = pxy[1]; ptsin[2] = pxy[2]; ptsin[3] = pxy[3]; vdi();
Comments	This function, as opposed to vr_recfl(), does take the setting of vsf_perimeter() into consideration.
See Also	vsf_interior(), vsf_style(), vsf_color(), vsf_perimeter(), vsf_udpat()

v_bez()

VOID v_bez( handle, count, pxy, bezarr, extent, totpts, totmoves )

WORD handle, count;

WORD *pxy, *extent;

char *bezarr;

WORD *totpts, *totmoves;

	v_bez() outputs a bezier curve path.
Opcode	6
Sub-Opcode	13
Availability	Available only with FONTGDOS, FSMGDOS or SpeedoGDOS.
Parameters	handle is a valid workstation handle. count specifies the number of vertices in the path. pxy is a pointer to a WORD array (count * 2) WORDs long containing the vertices where pxy[0] is the X coordinate of the first point, pxy[1] is the Y coordinate of the first point and so on. bezarr is a pointer to a character array count BYTEs long where each byte is a bit mask with two flags that dictate the interpretation of each vertice as follows:
	Name	Bit	Meaning
	BEZ_BEZIER (0x01) BEZ_POLYLINE (0x00)	0	If set, begin a 4-point bezier segment (two anchor points followed by two control points), otherwise, begin a polyline segment.
	BEZ_NODRAW (0x02)	1	If set, jump to this point without drawing.
	-	2-7	Currently unused (set to 0).
	Upon exit, a 4 WORD array pointed to by extent is filled in with a VDI format rectangle defining a bounding box of the path drawn. The WORD pointed to by totpts is filled in with the number of points in the resulting path whereas the total number of moves is stored in the WORD pointed to by totmoves.
Binding	WORD i; contrl[0] = 6; contrl[1] = count; contrl[3] = (count + 1)/2; contrl[5] = 13; contrl[6] = handle; for(i = 0;i < count; i++) { intin[i] = (WORD)bezarr[i]; ptsin[ i*2 ] = pxy[ i*2 ]; ptsin[ (i*2) + 1 ] = pxy[ (i*2) + 1]; } vdi(); *totpts = intin[0]; *totmoves = intin[1]; for(i = 0; i < 4; i++) extent[i] = ptsout[i];
See Also	v_bez_fill(), v_bez_on(), v_bez_off(), v_bez_qual(), v_set_app_buff()

v_bez_fill()

VOID v_bez_fill( handle, count, pxy, bezarr, extent, totpts, totmoves )

WORD handle, count;

WORD *pxy, *extent;

char *bezarr;

WORD *totpts, *totmoves;

	v_bez_fill() outputs a filled bezier path.
Opcode	9
Sub-Opcode	13
Availability	Available only with FONTGDOS, FSMGDOS or SpeedoGDOS.
Parameters	Same as v_bez().
Binding	WORD i; contrl[0] = 9; contrl[1] = count; contrl[3] = (count + 1)/2; contrl[5] = 13; contrl[6] = handle; for(i = 0;i < count * 2; i++) ptsin[i] = pxy[i]; for(i = 0;i < count; i++) intin[i] = (WORD)bezarr[i]; vdi(); *totpts = intin[0]; *totmoves = intin[1]; for(i = 0; i < 4; i++) extent[i] = ptsout[i];
See Also	v_bez(), v_bez_on(), v_bez_off(), v_bez_qual(), v_set_app_buff()

v_bez_off()

VOID v_bez_off( handle )

WORD handle;

	v_bez_off() disables bezier capabilities and frees associated memory.
Opcode	11
Sub-Opcode	13
Availability	Available only with FONTGDOS, FSM, or SpeedoGDOS.
Parameters	handle is a valid workstation handle.
Binding	contrl[0] = 11; contrl[1] = 0; contrl[3] = 0; contrl[5] = 13; contrl[6] = handle; vdi();
Comments	This function should be called to free any memory reserved by the bezier functions.
See Also	v_bez_on()

v_bez_on()

WORD v_bez_on( handle )

WORD handle;

	v_bez_on() enables bezier capabilities.
Opcode	11
Sub-Opcode	13
Availability	Available only with FONTGDOS, FSM, or SpeedoGDOS.
Parameters	handle is a valid workstation handle.
Binding	contrl[0] = 11; contrl[1] = 0; contrl[3] = 0; contrl[5] = 13; contrl[6] = handle; vdi(); return intout[0];
Return Value	v_bez_on() returns a WORD value indicating the number of line segments each curve is composed of (smoothness). The value returned (0-7) is a power of 2 meaning that a return value of 7 indicates 128 line segments per curve.
See Also	v_bez_off()

v_bez_qual()

VOID v_bez_qual( handle, percent, actual )

WORD handle, percent;

WORD *actual;

	v_bez_qual() sets the speed/quality ratio of the bezier curve rendering engine.
Opcode	5
Sub-Opcode	99
Availability	Available only with FONTGDOS, FSM, or SpeedoGDOS.
Parameters	handle specifies a valid workstation handle. percent is a value (0-100) specifying the tradeoff between bezier quality and speed. A value of 0 renders a bezier fastest with the lowest quality while a value of 100 renders a bezier slowest with the highest possible quality. On return, the WORD pointed to by actual will contain the actual value used.
Binding	contrl[0] = 5; contrl[1] = 0; contrl[3] = 3; contrl[5] = 99; contrl[6] = handle; intin[0] = 32; intin[1] = 1; intin[2] = percent; vdi(); *actual = intout[0];
Comments	actual may not be an exact percentage as the rendering engine may not actually support every value possible between 1-99.
See Also	v_bez(), v_bez_fill(), v_bez_on()

v_bit_image()

VOID v_bit_image( handle, fname, ratio, xscale, yscale, halign, valign, pxy )

WORD handle;

char *fname;

WORD aspect, xscale, yscale, halign, valign;

WORD *pxy;

	v_bit_image() outputs a disk-based GEM '.IMG' file.
Opcode	5
Sub-Opcode	23
Availability	Supported by all printer, metafile, and memory drivers.
Parameters	handle is a valid workstation handle. fname specifies the GEMDOS file specification for the GEM bit-image file to print. ratio should be 0 to ignore the aspect ratio of the image and 1 to adhere to it. xscale and yscale specify the method of scaling to apply to the image. Fractional scaling is specified by a value of 0 whereas a value of 1 represents integer scaling. If fractional scaling is used, the image will be displayed at the coordinates given by the VDI format rectangle pointed to by pxy. If integer scaling is applied, the image will be displayed as large as possible within the given coordinates using halign and valign to specify the image justification as follows:
		Value	halign	valign
		0	Left IMAGE_LEFT	Top IMAGE_TOP
		1	Center IMAGE_CENTER	Center IMAGE_CENTER
		2	Right IMAGE_RIGHT	Bottom IMAGE_BOTTOM
Binding	WORD tmp = 5; intin[0] = ratio; intin[1] = xscale; intin[2] = yscale; intin[3] = halign; intin[4] = valign; while(intin[tmp++] = (WORD)*fname++); contrl[0] = 5; contrl[1] = 2; contrl[3] = --tmp; contrl[5] = 23; contrl[6] = handle; ptsin[0] = pxy[0]; ptsin[1] = pxy[1]; ptsin[2] = pxy[2]; ptsin[3] = pxy[3]; vdi();
Comments	A flag indicating whether the device supports scaling can be found in vq_extnd(). This call used with the memory driver can provide image scaling for transfer to the screen with vrt_cpyfm().
See Also	vq_scan()

v_cellarray()

VOID v_cellarray( handle, pxy, rowlen, elements, num_rows, wrmode, colarray )

WORD handle;

WORD *pxy;

WORD rowlen, elements, num_rows, wrmode;

WORD *colarray;

	v_cellarray() outputs an array of colored cells.
Opcode	10
Availability	Not supported by any current drivers.
Parameters	handle specifies a valid workstation handle. pxy points to a WORD array with 4 entries specifying a VDI format rectangle giving the extent of the array to output. rowlen specifies the length of each color array row. elements specifies the total number of color array elements. num_rows specifies the number of rows in the color array. wrmode specifies a valid writing mode (1-4) and colarray points to an array of WORDs (num_rows * elements) long.
Binding	WORD i; intin[i] = colarray[i] contrl[0] = 10; contrl[1] = 2; contrl[3] = num_rows * elements; contrl[6] = handle; contrl[7] = rowlen; contrl[8] = elements; contrl[9] = num_rows; contrl[10] = wrt_mode; for(i = 0;i < (num_rows * elements);i++) intin[i] = colarray; ptsin[0] = pxy[0]; ptsin[1] = pxy[1]; ptsin[2] = pxy[2]; ptsin[3] = pxy[3]; vdi();
Caveats	This function is not guaranteed available in any driver and should therefore be avoided unless you are sure the driver you are utilizing understands it.
See Also	vq_cellarray()

v_circle()

VOID v_circle( handle, x, y, radius )

WORD handle, x, y, radius;

	v_circle() outputs a filled circle.
Opcode	11
Sub-Opcode	4
Availability	Supported by all drivers. This function composes one of the 10 VDI GDP's (Generalized Drawing Primitives). Although all current drivers support all GDP's, their availability is not guaranteed and may vary. To check for a particular GDP refer to the table returned by v_opnvwk() or v_opnwk().
Parameters	handle specifies a valid workstation. x and y specify the center of a circle with a radius of radius.
Binding	contrl[0] = 11; contrl[1] = 3; contrl[3] = 0; contrl[5] = 4; contrl[6] = handle; ptsin[0] = x; ptsin[1] = y; ptsin[2] = ptsin[3] = 0; ptsin[4] = radius; ptsin[5] = 0; vdi();
See Also	vsf_color(), vsf_interior(), vsf_style(), vsf_udpat()

v_clear_disp_list()

VOID v_clear_disp_list( handle )

WORD handle;

	v_clear_disp_list() clears the display list of a workstation.
Opcode	5
Sub-Opcode	22
Availability	Supported by printer, plotter, metafile, and camera drivers.
Parameters	handle specifies a valid workstation handle.
Binding	contrl[0] = 5; contrl[1] = contrl[3] = 0; contrl[5] = 22; contrl[6] = handle; vdi();
Comments	v_clear_disp_list() is essentially the same as v_clrwk() except that no form feed is issued.
See Also	v_clrwk()

v_clrwk()

VOID v_clrwk( handle )

WORD handle;

	v_clrwk() clears a physical workstation.
Opcode	3
Availability	Supported by all drivers.
Parameters	handle specifies a valid workstation.
Binding	contrl[0] = 3; contrl[1] = contrl[3] = 0; contrl[6] = handle; vdi();
Comments	Physical workstations are cleared automatically when they are opened. This call will generate a form feed on page-oriented devices.Using this command on a virtual workstation will clear the underlying physical workstation. This is generally not recommended because it will effect all virtual workstations not simply your own.
See Also	v_clear_disp_list(), v_updwk()

v_clsvwk()

VOID v_clsvwk( handle )

WORD handle;

	v_clsvwk() closes a virtual workstation.
Opcode	101
Availability	Supported by all drivers.
Parameters	handle specifies a valid virtual workstation to close.
Binding	contrl[0] = 101; contrl[1] = contrl[3] = 0; contrl[6] = handle; vdi();
See Also	v_opnvwk()

v_clswk()

VOID v_clswk( handle )

WORD handle;

	v_clswk() closes a physical workstation.
Opcode	2
Availability	Available only with some form of GDOS.
Parameters	handle specifies a valid physical workstation to close.
Binding	contrl[0] = 2; contrl[1] = contrl[3] = 0; contrl[6] = handle; vdi();
See Also	v_opnvwk()

v_contourfill()

VOID v_contourfill( handle, x, y, color )

WORD handle, x, y, color;

	v_countourfill() outputs a 'seed' fill.
Opcode	103
Availability	Supported by all current screen, printer and metafile drivers. The availability of this call can be checked for using vq_extnd().
Parameters	handle specifies a valid workstation handle. x and y specify the starting point for the fill. If color is OTHER_COLOR (-1) then the fill continues in all directions until a color other than that found in x and y is found. If color is positive then the fill continues in all directions until color color is found.
Binding	contrl[0] = 103; contrl[1] = contrl[3] = 0; contrl[6] = handle; intin[0] = color; ptsin[0] = x; ptsin[1] = y; vdi();
Comments	In true-color mode if a positive value for color is used, the fill spreads until a pixel is found with the same color as 'virtual pen' color.
See Also	vsf_color(), vsf_interior(), vsf_style(), vsf_udpat()

v_curdown()

VOID v_curdown( handle )

WORD handle;

	v_curdown() moves the text cursor down one line.
Opcode	5
Sub-Opcode	5
Availability	Supported by all screen drivers.
Parameters	handle specifies a valid workstation handle.
Binding	contrl[0] = 5; contrl[1] = contrl[3] = 0; contrl[5] = 5; contrl[6] = handle; vdi();
Comments	This call is equivalent to the esc-b VT-52 code.
See Also	v_curup()

v_curhome()

VOID v_curdown( handle )

WORD handle;

	v_curhome() moves the text cursor to the upper-left of the screen.
Opcode	5
Sub-Opcode	8
Availability	Supported by all screen drivers.
Parameters	handle specifies a valid workstation handle.
Binding	contrl[0] = 5; contrl[1] = contrl[3] = 0; contrl[5] = 8; contrl[6] = handle; vdi();
Comments	This call is equivalent to the esc-h VT-52 code.

v_curleft()

VOID v_curleft( handle )

WORD handle;

	v_curleft() moves the text cursor left one character position.
Opcode	5
Sub-Opcode	7
Availability	Supported by all screen drivers.
Parameters	handle is a valid workstation handle.
Binding	contrl[0] = 5; contrl[1] = contrl[3] = 0; contrl[5] = 7; contrl[6] = handle; vdi();
Comments	This call is equivalent to the esc-d VT-52 code.
See Also	v_curright()

v_curright()

VOID v_curright( handle )

WORD handle;

	v_curright() moves the text cursor one position to the right.
Opcode	5
Sub-Opcode	6
Availability	Supported by all screen drivers.
Parameters	handle specifies a valid workstation handle.
Binding	contrl[0] = 5; contrl[1] = contrl[3] = 0; contrl[5] = 6; contrl[6] = handle; vdi();
Comments	This call is equivalent to the esc-c VT-52 code.
See Also	v_curleft()

v_curtext()

VOID v_curtext( handle, str )

WORD handle;

char *str;

	v_curtext() outputs a line of text to the screen in text mode.
Opcode	5
Sub-Opcode	12
Availability	Supported by all screen drivers.
Parameters	handle is a valid workstation handle. str is a character pointer to a string no more than 127 characters long.
Binding	WORD i = 0; while(intin[i++] = (WORD)*str++); intin[i] = 0; contrl[0] = 5; contrl[1] = 0; contrl[3] = --i; contrl[5] = 12; contrl[6] = handle; vdi();
Comments	The line of text must not exceed the maximum length of the intin array as returned by vq_extnd() or the maximum length of your compilers' array.
See Also	vs_curaddress(), v_rvon(), v_rvoff()

v_curup()

VOID v_curup( handle )

WORD handle;

	v_curup() moves the text cursor up one line.
Opcode	5
Sub-Opcode	4
Availability	Supported by all screen drivers.
Parameters	handle specifies a valid workstation handle.
Binding	contrl[0] = 5; contrl[1] = contrl[3] = 0; contrl[5] = 4; contrl[6] = handle; vdi();
Comments	This call is equivalent to the esc-a VT-52 code.
See Also	v_curdown()

v_dspcur()

VOID v_dspcur( handle, x, y )

WORD handle, x, y;

	v_dspcur() displays the mouse pointer on screen at the specified position.
Opcode	5
Sub-Opcode	18
Availability	Supported by all screen drivers.
Parameters	handle specifies a valid workstation handle. x and y specify the screen coordinates of where to display the mouse pointer.
Binding	contrl[0] = 5; contrl[1] = 1 contrl[3] = 0; contrl[5] = 18; contrl[6] = handle; ptsin[0] = x; ptsin[1] = y; vdi();
Comments	This call will render a mouse cursor on screen regardless of its current 'show' status. Normally a function will use either graf_mouse() if using the AES or v_show_c() if using the VDI.
See Also	v_rmcur(), graf_mouse(), v_show_c()

v_eeol()

VOID v_eeol( handle )

WORD handle;

	v_eeol() erases the text line from the current cursor position rightwards.
Opcode	5
Sub-Opcode	10
Availability	Supported by all screen drivers.
Parameters	handle specifies a valid workstation handle.
Binding	contrl[0] = 5; contrl[1] = contrl[3] = 0; contrl[5] = 10; contrl[6] = handle; vdi();
Comments	This call is equivalent to the esc-k VT-52 code.
See Also	v_eeos()

v_eeos()

WORD v_eeos( handle )

WORD handle;

	v_eeos() erases the current screen of text from the cursor position.
Opcode	5
Sub-Opcode	9
Availability	Supported by all screen drivers.
Parameters	handle specifies a valid workstation handle.
Binding	contrl[0] = 5; contrl[1] = contrl[3] = 0; contrl[5] = 9; contrl[6] = handle; vdi();
Comments	This call is equivalent to the esc-j VT-52 code.
See Also	v_eeol()

v_ellarc()

VOID v_ellarc( handle, x, y, xradius, yradius, startangle, endangle)

WORD handle, x, y, xradius, yradius, startangle, endangle;

	v_ellarc() outputs an elliptical arc segment.
Opcode	11
Sub-Opcode	6
Availability	Supported by all drivers. This function composes one of the 10 VDI GDP's (Generalized Drawing Primitives). Although all current drivers support all GDP's, their availability is not guaranteed and may vary. To check for a particular GDP refer to the table returned by v_opnvwk() or v_opnwk().
Parameters	handle specifies a valid workstation handle. x and y specify the coordinates of the center of an arc with an X radius of xradius and a Y radius of yradius. Only the portion of the arc which falls between the angles specified in startangle and endangle will be drawn. Angles are specified in tenths of degrees as follows:
Binding	contrl[0] = 11; contrl[1] = contrl[3] = 2; contrl[5] = 6; contrl[6] = handle; intin[0] = startangle; intin[1] = endangle; ptsin[0] = x; ptsin[1] = y; ptsin[2] = xradius; ptsin[3] = yradius; vdi();
See Also	v_ellipse(), v_ellpie(), vsl_color(), vsl_type(), vsl_width(), vsl_udsty()

v_ellipse()

VOID v_ellipse( handle, x, y, xradius, yradius)

WORD handle, x, y, xradius, yradius;

	v_ellipse() outputs a filled ellipse.
Opcode	11
Sub-Opcode	5
Availability	Supported by all drivers. This function composes one of the 10 VDI GDP's (Generalized Drawing Primitives). Although all current drivers support all GDP's, their availability is not guaranteed and may vary. To check for a particular GDP refer to the table returned by v_opnvwk() or v_opnwk().
Parameters	handle specifies a valid workstation handle. x and y specify the center point of an arc with an X radius of xradius and a Y radius of yradius.
Binding	contrl[0] = 11; contrl[1] = 2; contrl[3] = 0; contrl[5] = 5; contrl[6] = handle; ptsin[0] = x; ptsin[1] = y; ptsin[2] = xradius; ptsin[3] = yradius; vdi();
See Also	v_ellpie(), v_ellarc(), vsf_color(), vsf_interior(), vsf_style(), vsf_udpat(), vs_perimeter()

v_ellpie()

VOID v_ellpie( handle, x, y, xradius, yradius, startangle, endangle)

WORD handle, x, y, xradius, yradius, startangle, endangle;

	v_ellpie() outputs a filled elliptical pie segment.
Opcode	11
Sub-Opcode	7
Availability	Supported by all drivers. This function composes one of the 10 VDI GDP's (Generalized Drawing Primitives). Although all current drivers support all GDP's, their availability is not guaranteed and may vary. To check for a particular GDP refer to the table returned by v_opnvwk() or v_opnwk().
Parameters	handle specifies a valid workstation handle. x and y specify the center coordinates of an elliptical pie segment to draw with an X radius of xradius and a Y radius of yradius. Only the portion of the arc will be drawn falling between the angles specified in startangle and endangle (as shown below). The ends of this arc is connected to the center point with lines forming the pie segment.
Binding	contrl[0] = 11; contrl[1] = contrl[3] = 2; contrl[5] = 7; contrl[6] = handle; intin[0] = startangle; intin[1] = endangle; ptsin[0] = x; ptsin[1] = y; ptsin[2] = xradius; ptsin[3] = yradius; vdi();
See Also	v_ellarc(), v_ellipse(), vsf_color(), vsf_style(), vsf_interior(), vsf_udpat(), vs_perimeter()

v_enter_cur()

VOID v_enter_cur( handle )

WORD handle;

	v_enter_cur() clears the screen to color 0, removes the mouse cursor and enters text mode.
Opcode	5
Sub-Opcode	3
Availability	Supported by all screen drivers.
Parameters	handle specifies a valid workstation handle.
Binding	contrl[0] = 5; contrl[1] = contrl[3] = 0; contrl[5] = 3; contrl[6] = handle; vdi();
Caveats	You should check that the left mouse button has been released with vq_mouse() prior to calling this function. If the button is depressed when you call this function the VDI will lock waiting for it to be released after v_exit_cur().
Comments	This call is used by a GEM application to prepare for executing a TOS application when not running under MultiTOS.
See Also	v_exit_cur()

v_exit_cur()

VOID v_exit_cur( handle )

WORD handle;

	v_exit_cur() exits text mode and restores the mouse pointer.
Opcode	5
Sub-Opcode	2
Availability	Supported by all screen drivers.
Parameters	handle specifies a valid workstation handle.
Binding	contrl[0] = 5; contrl[1] = contrl[3] = 0; contrl[5] = 2; contrl[6] = handle; vdi();
Caveats	See v_enter_cur().
Comments	To completely restore the screen you should call form_dial(FMD_FINISH, sx, sy, sw, sh) where sx, sy, sw, and sh are the coordinates of the screen.
See Also	v_enter_cur()

v_fillarea()

VOID v_fillarea( handle, count, pxy)

WORD handle, count;

WORD *pxy;

	v_fillarea() outputs a filled polygon.
Opcode	9
Availability	Supported by all drivers.
Parameters	handle specifies a valid workstation handle. count specifies the number of vertices in the polygon to output. pxy should point to an array of coordinate pairs with the first WORD being the first X point, the second WORD being the first Y point and so on.
Binding	WORD i; contrl[0] = 9; contrl[1] = count; contrl[3] = 0; contrl[6] = handle; for(i = 0;i < count*2;i++) ptsin[i] = pxy[i]; vdi();
Comments	This function will automatically connect the first point with the last point.
See Also	v_pline(), v_contourfill()

v_flushcache()

VOID v_flushcache( handle )

WORD handle;

	v_flushcache() flushes the character bitmap portion of the cache.
Opcode	251
Availability	Available only with FSMGDOS and SpeedoGDOS.
Parameters	handle specifies a valid workstation handle.
Binding	contrl[0] = 251; contrl[1] = contrl[3] = 0; contrl[6] = handle; vdi();
See Also	v_loadcache(), v_savecache()

v_fontinit()

VOID v_fontinit( fptr_high, fptr_low )

WORD fptr_high, fptr_low;

	v_fontinit() allows replacement of the built-in system font.
Opcode	5
Sub-Opcode	102
Availability	All TOS versions.
Parameters	fptr_high and fptr_low are the high and low WORDs of a pointer to a Line-A compatible font header structure in Motorola (Big-Endian) format which contains information about the font to be used as a replacement for the system font.
Binding	contrl[0] = 5; contrl[1] = 0; contrl[3] = 2; contrl[5] = 102; contrl[6] = handle; intin[0] = fptr_high; intin[1] = fptr_low; vdi();
Comments	This function has never been officially documented though it exists in all current versions of TOS.

v_form_adv()

VOID v_form_adv( handle )

WORD handle;

	v_form_adv() outputs the current page without clearing the display list.
Opcode	5
Sub-Opcode	20
Availability	Supported by all drivers.
Parameters	handle specifies a valid workstation handle.
Binding	contrl[0] = 5; contrl[1] = contrl[3] = 0; contrl[5] = 20; contrl[6] = handle; vdi();
Comments	This function is useful if you wish to print a new page containing the same objects as on the previous page.
See Also	v_updwk()

v_ftext()

VOID v_ftext( handle, x, y, str)

WORD handle, x, y;

char *str;

	v_ftext() outputs outline text taking spacing remainders into consideration.
Opcode	241
Availability	Available only with FSMGDOS or SpeedoGDOS.
Parameters	handle specifies a valid workstation handle. x and y specify the starting coordinate of the NULL-terminated text string (see vst_alignment() ) pointed to by str to print.
Binding	WORD i = 0; while(intin[i++] = (WORD)*str++); contrl[0] = 241; contrl[1] = 1; contrl[3] = --i; contrl[6] = handle; ptsin[0] = x; ptsin[1] = y; vdi();
Comments	The text contained in str (including its NULL byte) should not exceed the maximum allowable size of the intin array (as indicated in the work_out array) or the size of the intin array allocated by your compiler.To output 16-bit Speedo character indexes, use v_ftext16().This function produces output more properly spaced than with v_gtext() because it takes the remainder amounts from vqt_f_extent() into consideration.
See Also	v_ftext(), v_ftext_offset(), v_ftext_offset16(), v_gtext(), vst_alignment(), vst_color(), vst_effects(), vst_arbpt(), vst_height(), vst_font(), vqt_f_extent(), vst_point()

v_ftext16()

VOID v_ftext16( handle, x, y, wstr, wstrlen)

WORD handle, x, y;

WORD *wstr;

WORD wstrlen;

	v_ftext16() is a variant binding of v_ftext() that outputs 16-bit Speedo character text rather than 8-bit ASCII text.
Opcode	241
Availability	Available only with SpeedoGDOS.
Parameters	handle specifies a valid workstation handle. x and y specify the starting coordinate of the location to output text. wstr points to a NULL-terminated text string composed of WORD-sized Speedo characters. wstrlen specifies the length of the text string.
Binding	WORD i; for( i = 0; i < wstrlen; i++) intin[i] = wstr[i]; contrl[0] = 241; contrl[1] = 1; contrl[3] = wstrlen; contrl[6] = handle; ptsin[0] = x; ptsin[1] = y; vdi();
Comments	This function should only be used when vst_charmap() has been used to indicate that WORD-sized Speedo character indexes should be recognized rather than 8-bit ASCII.The text contained in wstr (including its NULL byte) should not exceed the maximum allowable size of the intin array (as indicated in the work_out array) or the size of the intin array allocated by your compiler.
Caveats	Current versions of SpeedoGDOS become confused when the space character ( index 0) is encountered in the string. It is suggested that one of the three space characters (of varying widths) at indexes 560-562 be used instead.
See Also	v_ftext(), v_ftext_offset(), v_ftext_offset16(), v_gtext(), vst_alignment(), vst_color(), vst_effects(), vst_arbpt(), vst_height(), vst_font(), vqt_f_extent(), vst_point()

v_ftext_offset()

VOID v_ftext_offset( handle, x, y, str, offset )

WORD handle, x, y;

char *str;

WORD *offset;

	v_ftext_offset() is a variant binding of v_ftext() available under SpeedoGDOS which allows an offset vector for each character to be specified.
Opcode	241
Availability	Available only with SpeedoGDOS.
Parameters	handle specifies a valid workstation handle. x and y give the point where the string will be rendered. offset points to an array of WORDs which contains one x and y offset value for each character in str.
Binding	WORD i = 0; while(intin[i++] = (WORD)*str++); --i; ptsin[0] = x; ptsin[1] = y; for(j = 0; j < i * 2;j++) ptsin[j + 2] = offset[j]; contrl[0] = 241; contrl[1] = i + 1; contrl[3] = i; contrl[6] = handle; vdi();
Comments	The text contained in str (including its NULL byte) should not exceed the maximum allowable size of the intin array (as indicated in the work_out array) or the size of the intin array allocated by your compiler.To output 16-bit Speedo character indexes, use v_ftext_offset16().
See Also	v_ftext_offset16(), v_ftext(), v_gtext()

v_ftext_offset16()

VOID v_ftext_offset( handle, x, y, wstr, wstrlen, offset )

WORD handle, x, y;

WORD *wstr;

WORD wstrlen;

WORD *offset;

	v_ftext_offset16() is a variant binding of v_ftext_offset() which allows 16-bit Speedo character strings to be output rather than 8-bit ASCII codes.
Opcode	241
Availability	Available only with SpeedoGDOS.
Parameters	handle specifies a valid workstation handle. x and y give the point where the string will be rendered. offset points to an array of WORDs which contains one x and y offset value for each character in wstr.
Binding	WORD i; for( i = 0;i < wstrlen; i++) intin[i] = wstr[i]; ptsin[0] = x; ptsin[1] = y; for(j = 0; j < i * 2;j++) ptsin[j + 2] = offset[j]; contrl[0] = 241; contrl[1] = wstrlen + 1; contrl[3] = wstrlen; contrl[6] = handle; vdi();
Comments	This function should only be used when vst_charmap() has been used to indicate that WORD sized Speedo character indexes should be recognized rather than 8-bit ASCII.The text contained in wstr (including its NULL byte) should not exceed the maximum allowable size of the intin array (as indicated in the work_out array) or the size of the intin array allocated by your compiler.
Caveats	Current versions of SpeedoGDOS become confused when the space character ( index 0) is encountered in the string. It is suggested that one of the three space characters (of varying widths) at indexes 560-562 be used instead.
See Also	v_ftext16(), v_ftext_offset()

v_getbitmap_info()

VOID v_getbitmap_info( handle, ch, advx, advy, xoff, yoff, width, height, bitmap)

WORD handle, ch;

fix31 *advx, *advy, *xoff, *yoff;

WORD *width, *height;

VOID *bitmap;

	v_getbitmap_info() returns placement information for the bitmap of a character based on the current character font, size, and alignment.
Opcode	239
Availability	Available only with SpeedoGDOS.
Parameters	handle specifies a valid workstation handle. ch is the character to return information about.The fix31 variables pointed to by advx, advy, xoff, and yoff will be filled in with the x and y advance and offset vectors respectively. The WORDs pointed to by width and height will be filled in with the width and height of the bitmap pointed to by the value returned in bitmap.
Binding	contrl[0] = 239; contrl[1] = 0; contrl[3] = 1; contrl[6] = handle; intin[0] = ch; vdi(); *width = intout[0]; *height = intout[1]; *advx = *(fix31 *)&intout[2]; *advy = *(fix31 *)&intout[4]; *xoff = *(fix31 *)&intout[6]; *yoff = *(fix31 *)&intout[8]; *bitmap = *(void *)&intout[10];
Comments	The advance vector represents the amount to add to the current point to properly place the character. The offset vector, when added to the current point, give the location of the upper-left corner of the bitmap.

v_getoutline()

VOID v_getoutline( handle, ch, xyarray, bezarray, maxverts, numverts )

WORD handle, ch;

WORD *xyarray;

char *bezarray;

WORD maxverts;

WORD *numverts;

	v_getoutline() returns information about an SpeedoGDOS character required to generate the character with bezier curves.
Opcode	243
Availability	Available only with SpeedoGDOS.
Parameters	handle specifies a valid workstation handle. ch specifies the character to return information about. The arrays pointed to by xyarray and bezarray are filled in with the bezier information for the character. The definition of xyarray and bezarray is given in the binding for v_bez(). maxverts should indicate the maximum number of vertices the buffer can hold. The WORD pointed to by numverts will be filled in with the actual number of vertices for the character.
Binding	contrl[0] = 243; contrl[1] = 0; contrl[3] = 6; contrl[6] = handle; intin[0] = ch; intin[1] = maxverts; *(WORD *)&intin[2] = xyarray; *(WORD *)&intin[4] = bezarray; vdi(); *numverts = intout[0];

v_get_pixel()

VOID v_get_pixel( handle, x, y, pindex, vindex )

WORD handle, x, y;

WORD *pindex, *vindex;

	v_get_pixel() returns the color value for a specified coordinate on the screen.
Opcode	105
Availability	Supported by all screen drivers.
Parameters	handle specifies a valid workstation handle. x any y specify the coordinate to return color information for.In a palette-based mode the WORD pointed to by pindex will contain the hardware register index of the color and the WORD pointer to by vindex will contain the VDI index of the color.In 16-bit true-color modes, pindex will be 0 and vindex will return the 16-bit RGB pixel value in the format {RRRR RGGG GGGB BBBB}.In 32-bit color modes, the lower byte of vindex will contain the 8 bits of red data, the upper byte of pindex will contain the 8 bits of green data, and the lower byte of pindex will contain the 8 bits of blue data. The upper byte of vindex is reserved for non-color data.
Binding	contrl[0] = 105; contrl[1] = 1; contrl[3] = 0; contrl[6] = handle; ptsin[0] = x; ptsin[1] = y; vdi(); *pindex = intout[0]; *vindex = intout[1];

v_gtext()

VOID v_gtext( handle, x, y, str)

WORD handle, x, y;

char *str;

	v_gtext() outputs graphic text.
Opcode	8
Availability	Supported by all drivers.
Parameters	handle specifies a valid workstation handle. x and y specify the starting coordinates of the text (see vst_alignment() ). str is a pointer to a NULL-terminated character string to print.
Binding	WORD i = 0; while(intin[i++] = (WORD)*str++); contrl[0] = 8; contrl[1] = 1; contrl[3] = --i; contrl[6] = handle; ptsin[0] = x; ptsin[1] = y; vdi();
Comments	The text contained in str (including its NULL byte) should not exceed the maximum allowable size of the intin array (as indicated in the work_out array) or the size of the intin array allocated by your compiler.Using this function to output outline text with FSMGDOS is possible to remain backward-compatible but not recommended as it will introduce small errors as spacing remainders are lost.
See Also	v_ftext(), v_ftext_offset(), vst_color(), vst_effects(), vst_alignment(), vst_height(), vst_point()

v_hardcopy()

VOID v_hardcopy( handle )

WORD handle;

	v_hardcopy() invokes the alt-help screen dump.
Opcode	5
Sub-Opcode	17
Availability	Supported by screen drivers running under ST compatible resolutions.
Parameters	handle specifies a valid workstation handle.
Binding	contrl[0] = 5; contrl[1] = contrl[3] = 0; contrl[5] = 17; contrl[6] = handle; vdi();
Caveats	This function works in only ST compatible screen modes and should thus be avoided.
See Also	Scrdmp()

v_hide_c()

VOID v_hide_c( handle )

WORD handle;

	v_hide_c() hides the mouse cursor.
Opcode	123
Availability	Supported by all screen drivers.
Parameters	handle specifies a valid workstation handle.
Binding	contrl[0] = 123; contrl[1] = contrl[3] = 0; contrl[6] = handle; vdi();
Comments	This call is nested. For each time you call this function you must call v_show_c() an equal number of times to show the mouse.
See Also	v_show_c(), graf_mouse()

v_justified()

VOID v_justified( handle, x, y, str, length, wflag, cflag)

WORD handle, x, y;

char *str;

WORD length, wflag, cflag;

	v_justified() outputs justified graphics text.
Opcode	11
Sub-Opcode	10
Availability	Supported by all drivers. This function composes one of the 10 VDI GDP's (Generalized Drawing Primitives). Although all current drivers support all GDP's, their availability is not guaranteed and may vary. To check for a particular GDP refer to the table returned by v_opnvwk() or v_opnwk().
Parameters	handle specifies a valid workstation handle. x and y specify the starting coordinates at which to draw the NULL-terminated text string (see vst_alignment() ) pointed to by str. length specifies the pixel length of the area to justify on. wflag and cflag specify the type of justification to perform between words and characters respectively. A value of NOJUSTIFY (0) indicates no justification whereas a value of JUSTIFY (1) indicates to perform justification.
Binding	WORD i = 0; while(intin[i++] = (WORD)*str++); contrl[0] = 11; contrl[1] = 2; contrl[3] = --i; contrl[5] = 10; contrl[6] = handle; intin[0] = wflag; intin[1] = cflag; ptsin[0] = x; ptsin[1] = y; ptsin[2] = length; ptsin[3] = 0; vdi();
Comments	This call does not take into account remainder information from outline fonts.
See Also	v_gtext(), v_ftext(), vst_color(), vst_font(), vst_effects(), vst_alignment(), vst_point(), vst_height()

v_killoutline()

VOID v_killoutline( handle, outline)

WORD handle;

FSMOUTLINE outline;

	v_killoutline() releases an outline from memory.
Opcode	242
Availability	Available only with FSMGDOS or SpeedoGDOS.
Comments	Under FSMGDOS this call was required to release memory allocated for an outline returned from v_getoutline(). With SpeedoGDOS, this call is no longer required and is thus not documented further.
See Also	v_getoutline()

v_loadcache()

WORD v_loadcache( handle, fname, mode)

WORD handle;

char *fname;

WORD mode;

	v_loadcache() loads a previously saved cache file from disk.
Opcode	250
Availability	Supported only by FSMGDOS and SpeedoGDOS.
Parameters	handle specifies a valid workstation handle. fname specifies the GEMDOS file specification of the cache file to load. mode specifies whether current data will be flushed first. A value of 0 will append the loaded cache to the current cache whereas a value of 1 will flush the cache prior to loading.
Binding	WORD i = 1; intin[0] = mode; while(intin[i++] = (WORD)*fname++); contrl[0] = 250; contrl[1] = 0; contrl[3] = i; contrl[6] = handle; vdi(); return intout[0];
Return Value	v_loadcache() returns 0 if successful or -1 if an error occurred.
Comments	This command only affects the cache responsible for storing bitmaps created from outline characters.
See Also	v_savecache(), v_flushcache()

v_meta_extents()

VOID v_meta_extents( handle, xmin, ymin, xmax, ymax)

WORD handle, xmin, ymin, xmax, ymax;

	v_meta_extents() embeds placement information for a metafile.
Opcode	5
Sub-Opcode	98
Availability	Supported by all metafile drivers.
Parameters	handle specifies a valid workstation handle. xmin and ymin specify the upper left corner of the bounding box of the metafile. xmax and ymax specify the lower left corner.
Binding	contrl[0] = 5; contrl[1] = 2; contrl[3] = 0; contrl[5] = 98; contrl[6] = handle; ptsin[0] = xmin; ptsin[1] = ymin; ptsin[2] = xmax; ptsin[3] = ymax; vdi();
Comments	Parameters sent to this call should be specified in whatever coordinate system the metafile is currently using.
See Also	vm_pagesize()

v_opnvwk()

VOID v_opnvwk( work_in, handle, work_out )

WORD *work_in, *handle, *work_out;

	v_opnvwk() opens a virtual VDI workstation.
	dev() a pointer to a virtual VDI workstation.
Opcode	100
Availability	Supported by all drivers.
Parameters	work_in is a pointer to an array of 11 WORDs which define the inital defaults for the workstation as follows:
		work_in[ x ]		Meaning
		0		Device identification number. This indicates the physical device ID of the device (the line number of the driver in ASSIGN.SYS when using GDOS). For screen devices you should normally use the value Getrez() + 2, however, a value of 1 is acceptable if not using any loaded fonts.
		1		Default line type (same as vsl_type() ).
		2		Default line color (same as vsl_color() ).
		3		Default marker type (same as vsm_type() ).
		4		Default marker color (same as vsm_color() ).
		5		Default font (same as vst_font() ).
		6		Default text color (same as vst_color() ).
		7		Default fill interior.
		8		Default fill style.
		9		Default fill color.
		10		Coordinate type flag. A value of 0 specifies NDC 'Normalized Device Coordinates' coordinates whereas a value of 2 specifies RC 'Raster Coordinates'. All other values are reserved. NDC coordinates are only available when using external drivers with GDOS.
	handle should be set to the current handle (not the device ID) of the physical workstation for this device. For screen devices this is the value returned by graf_handle(). On exit handle will be filled in the VDI workstation handle allocated, if successful, or 0 if the workstation could not be opened.work_out points to an array of 57 WORDs which on exit will be filled in by the VDI with information regarding the allocated workstation as follows (a structure name is listed beside its array member for those using the 'C' style VDI_Workstation structure instead of the array):
	work_out[x]		VDI Structure Member		Meaning
	0		xres		Width of device in pixels - 1.
	1		yres		Height of device in pixels - 1.
	2		noscale		Device coordinate units flag:0 = Device capable of producing a precisely scaled image (screen, printer, etc...) 1 = Device not capable of producing a precisely scaled image (film recorder, etc...)
	3		wpixel		WIdth of pixel in microns (1/25400 inch).
	4		hpixel		Height of pixel in microns (1/25400 inch).
	5		cheights		Number of character heights (0 = continuous scaling).
	6		linetypes		Number of line types.
	7		linewidths		Number of line widths (0 = continous scaling).
	8		markertypes		Number of marker types.
	9		markersizes		Number of marker sizes (0 = continuous scaling).
	10		faces		Number of faces supported by the device.
	11		patterns		Number of available patterns.
	12		hatches		Number of available hatches.
	13		colors		Number of predefined colors/pens (ST High = 2, ST Medium = 4, TT Low = 256, True Color = 256).
	14		ngdps		Number of supported GDP's
	15-24		cangdps[10]		cangdps[ 0 - (ngdps - 1)] contains a list of the GDP's the device supports as follows:1 = Bar 2 = Arc 3 = Pie Slice 4 = Circle 5 = Ellipse 6 = Elliptical Arc 7 = Elliptical Pie 8 = Rounded Rectangle 9 = Filled Rounded Rectangle 10 = Justified Graphics Text
	25-34		gdpattr[10]		For each GDP as listed above, gdpattr[ 0 - (ngdps - 1)] indicates the attributes which are applied to that GDP as follows:1 = Polyline (vsl_...) 2 = Polymarker (vsm_...) 3 = Text (vst_...) 4 = Fill Area (vsf_...) 5 = None
	35		cancolor		Color capability flag.0 = No 1 = Yes
	36		cantextrot		Text rotation flag.0 = No 1 = Yes
	37		canfillarea		Fill area capability flag.0 = No 1 = Yes
	38		cancellarray		Cell array capability flag.0 = No 1 = Yes
	39		palette		Number of available colors in palette.0 = > 32767 colors 2 = Monochrome >2 = Color
	40		locators		Number of locator devices.1 = Keyboard only. 2 = Keyboard and other.
	41		valuators		Number of valuator devices.1 = Keyboard only. 2 = Keyboard and other.
	42		choicedevs		Number of choice devices.1 = Function keys. 2 = Function keys + keypad.
	43		stringdevs		Number of string devices.1 = Keyboard.
	44		wstype		Workstation type.0 = Output only 1 = Input only 2 = Input/Output 3 = Metafile
	45		minwchar		Minimum character width in pixels.
	46		minhchar		Minimum character height in pixels.
	47		maxwchar		Maximum character width in pixels.
	48		maxhchar		Maximum character height in pixels.
	49		minwline		Minimum line width.
	50		zero5		Reserved (0).
	51		maxwline		Maximum line width.
	52		zero7		Reserved (0).
	53		minwmark		Minimum marker width.
	54		minhmark		Minimum marker height.
	55		maxwmark		Maximum marker width.
	56		maxhmark		Maximum marker height.
Binding	WORD i; contrl[0] = 100; contrl[1] = 0; contrl[3] = 11; contrl[6] = *handle; for(i = 0;i < 11;i++) intin[i] = work_in[i]; vdi(); *handle = contrl[6]; for(i = 0;i < 45;i++) work_out[i] = intout[i]; for(i = 0;i < 13;i++) work_out[45+i] = intout[i];
Caveats	The VDI included with TOS versions less than 2.06 sometimes returned the same handle for consecutive calls using the same physical handle.
Comments	Using multiple virtual workstations provides the benefit of being able to define multiple sets of default line types, text faces, etc... without having to constantly set them.The VDI_Workstation structure method is the recommended method of using this function. See the VDI entry for V_Opnwk() and V_Opnvwk().Desk accessories running under TOS versions below 1.4 should not leave a workstation open across any call which might surrender control to GEM (evnt_button(), evnt_multi(), etc... ). This could give GEM time to change screen resolutions and TOS versions below 1.4 did not release memory allocated by a desk accessory (including workstations) when a resolution change occurred.
See Also	v_opnwk(), vq_extend(), v_clsvwk(), V_Opnvwk()

V_Opnvwk()

WORD V_Opnvwk( dev )

VDI_Workstation dev;

	V_Opnvwk() is not a component of the VDI, rather an interface binding designed to simplify working with virtual screen workstations. It will open a virtual screen workstation with a VDI_Workstation structure as a parameter rather than work_in and work_out arrays.
Opcode	N/A
Availability	User-defined.
Parameters	ws is a pointer to a VDI_Workstation structure defined as follows (for the meaning of each structure member, refer to v_opnvwk() ): typedef struct { WORD handle, dev_id; WORD wchar, hchar, wbox, hbox; WORD xres, yres; WORD noscale; WORD wpixel, hpixel; WORD cheights; WORD linetypes, linewidths; WORD markertypes, markersizes; WORD faces, patterns, hatches, colors; WORD ngdps; WORD cangdps[10]; WORD gdpattr[10]; WORD cancolor, cantextrot; WORD canfillarea, cancellarray; WORD palette; WORD locators, valuators; WORD choicedevs, stringdevs; WORD wstype; WORD minwchar, minhchar; WORD maxwchar, maxwchar; WORD minwline; WORD zero5; WORD maxwline; WORD zero7; WORD minwmark, minhmark; WORD maxwmark, maxhmark; WORD screentype; WORD bgcolors, textfx; WORD canscale; WORD planes, lut; WORD rops; WORD cancontourfill, textrot; WORD writemodes; WORD inputmodes; WORD textalign, inking, rubberbanding; WORD maxvertices, maxintin; WORD mousebuttons; WORD widestyles, widemodes; WORD reserved[38]; } VDI_Workstation;
Binding	WORD V_Opnvwk( dev ) VDI_Workstation dev; { WORD i, in[11]; in[0] = Getrez() + 2; dev->dev_id = in[0]; for(i = 1;i < 10; in[i++] = 1); in[10] = 2; i = graf_handle( &dev->wchar, &dev->hchar, &dev->wbox, &dev->hbox ); v_opnvwk( in, &i, &dev->xres ); dev->handle = i; if(i) vq_extnd( i, 1, &dev->screentype ); return (i); }
Return Value	V_Opnvwk() returns 0 if non-successful or the workstation handle otherwise.
Comments	This function definition is adapted from an article which appeared in the 'Atari .RSC' developers newsletter (Nov '90 - Jan '91).
See Also	v_opnvwk(), V_Opnwk(), vq_extnd()

v_opnwk()

VOID v_opnwk( work_in, handle, work_out )

WORD *work_in, *handle, *work_out;

	v_opnwk() opens a physical workstation.
Opcode	1
Availability	Available only with some form of GDOS.
Parameters	All parmeters for this function are consistent with v_opnvwk() except as follows:On entry, handle does not need to contain any specific value. On return, however, it will contain a workstation handle if successful or 0 if the call failed.
Binding	WORD i; contrl[0] = 1; contrl[1] = 0; contrl[3] = 11; for(i = 0;i < 11;i++) intin[i] = work_in[i]; vdi(); *handle = contrl[6]; for(i = 0;i < 45;i++) work_out[i] = intout[i]; for(i = 0;i < 13;I++) work_out[45+i] = ptsout[i];
Comments	Physical workstations should be opened when needed and closed immediately afterwards. For example, a word processor should not open the printer workstation when the application starts and close it when it ends. If this is done, the user will be unable to change printers with the Printer Setup CPX(s).
See Also	V_Opnwk(), v_opnvwk(), vq_extnd()

V_Opnwk()

WORD V_Opnwk( devno, dev )

WORD devno; dev

VDI_Workstation dev;

	V_Opnwk() is not a component of the VDI, rather an interface binding designed to simplify working with VDI workstations. It will open a physical workstation using a VDI_Workstation structure rather than work_in and work_out.
Opcode	N/A
Availability	User-defined.
Parameters	devno specifies the device ID of the device to open. Valid values for devno follow: 1-10 = Screen (loaded device drivers only) 11-20 = Plotters 21-30 = Printers 31-40 = Metafile Drivers 41-50 = Camera Drivers 51-60 = Tablet Drivers 61-70 = Memory Driversws is a VDI_Workstation structure as defined in V_Opnvwk().
Binding	WORD V_Opnvwk( devno, dev ) WORD devno; VDI_Workstation dev; { WORD i, in[11]; in[0] = dev->dev_id = devno; for(i = 1;i < 10; in[i++] = 1); in[10] = 2; i = devno; v_opnvwk( in, &i, &dev->xres ); dev->handle = i; if(i) vq_extnd( i, 1, &dev->screentype ); return (i); }
Return Value	V_Opnwk() returns a workstation handle if successful or 0 if the call failed.
Comments	This function definition is adapted from an article which appeared in the 'Atari .RSC' developers newsletter (Nov '90 - Jan '91).
See Also	v_opnwk(), vq_extnd(), v_opnvwk(), V_Opnvwk()

v_output_window()

VOID v_output_window( handle, pxy )

WORD handle;

WORD *pxy;

	v_output_window() outputs a specified portion of the current page.
Opcode	5
Sub-Opcode	21
Availability	Supported by all printer and metafile drivers under any type of GDOS.
Parameters	handle specifies a valid workstation handle. pxy is a pointer to an array of four WORDs in VDI rectangle format which specifies the bounding extents of the current page to output.
Binding	contrl[0] = 5; contrl[1] = 2; contrl[3] = 0; contrl[5] = 21; contrl[6] = handle; ptsin[0] = pxy[0]; ptsin[1] = pxy[1]; ptsin[2] = pxy[2]; ptsin[3] = pxy[3]; vdi();
Caveats	Some printer drivers ignore the sides of the bounding box specified and print the entire width of the page.
Comments	This call is similar to v_updwk() except that only a portion of the page is output.
See Also	v_updwk()

v_pgcount()

VOID v_pgcount( handle, numcopies)

WORD handle, numcopies;

	v_pgcount() is used to cause the laser printer to output multiple copies of the current page.
Opcode	5
Sub-Opcode	2000
Availability	Supported only with some laser printer drivers (for instance the Atari laser printer driver) under some form of GDOS.
Parameters	handle specifies a valid workstation handle. numcopies specifies the number of copies to print minus one. A value of 0 means print one copy, a value of 1, two copies, and so on.
Binding	contrl[0] = 5; contrl[1] = 0; contrl[3] = 1; contrl[5] = 2000; contrl[6] = handle; intin[0] = numcopies; vdi();
Comments	This call is preferred over repeatedly calling v_updwk() and v_form_adv() as this method forces the printer data to be resent for each page.

v_pieslice()

VOID v_pieslice( handle, x, y, radius, startangle, endangle )

WORD handle, x, y, radius, startangle, endangle;

	v_pieslice() outputs a filled pie segment.
Opcode	11
Sub-Opcode	3
Availability	Supported by all drivers. This function composes one of the 10 VDI GDP's (Generalized Drawing Primitives). Although all current drivers support all GDP's, their availability is not guaranteed and may vary. To check for a particular GDP refer to the table returned by v_opnvwk() or v_opnwk().
Parameters	handle specifies a valid workstation handle. x and y specify the center of a circlular segment of radius radius which is drawn between the angles of startangle and endangle (specified in tenths of degrees - legal values illustrated below) and connected to the center point.
Binding	contrl[0] = 11; contrl[1] = 4; contrl[3] = 2; contrl[5] = 3; contrl[6] = handle; ptsin[0] = x; ptsin[1] = y; ptsin[2] = ptsin[3] = ptsin[4] = ptsin[5] = 0 ptsin[6] = radius; intin[0] = startangle; intin[1] = endangle; vdi();
See Also	v_ellpie(), vsf_color(), vsf_style(), vsf_interior(), vsf_udpat(), vsf_perimeter()

v_pline()

VOID v_pline( handle, count, pxy )

WORD handle, count;

WORD *pxy;

	v_pline() outputs a polyline (group of one or more lines).
Opcode	6
Availability	Supported by all drivers.
Parameters	handle specifies a valid workstation handle. count specifies the number of vertices in the line path (2 to plot a single line). pxy points to a WORD array with count * 2 elements containing the vertices to plot as in (X1, Y1), (X2, Y2), etc...
Binding	WORD i; contrl[0] = 6; contrl[1] = count; contrl[3] = 0; contrl[6] = handle; for(i = 0;i < (count*2);i++) ptsin[i] = count[i]; vdi();
Comments	To draw a single point with this function, pxy[2] should equal pxy[0], pxy[3] should equal pxy[1], and count should be 2.
See Also	v_fillarea(), vsl_color(), vsl_type(), vsl_udsty(), vsl_ends()

v_pmarker()

VOID v_pmarker( handle, count, pxy )

WORD handle, count;

WORD *pxy;

	v_pmarker() outputs one or several markers.
Opcode	7
Availability	Supported by all drivers.
Parameters	handle specifies a valid workstation. count specifies the number of markers to plot. pxy points to a WORD array with (count * 2) elements containing the vertices of the markers to plot as in ( X1, Y1 ), ( X2, Y2 ), etc...
Binding	WORD i; contrl[0] = 7; contrl[1] = count; contrl[3] = 0; contrl[6] = handle; for(i = 0;i < (count * 2); i++) ptsin[i] = pxy[i]; vdi();
Comments	Single points may be plotted quickly with this function when the proper marker type is selected with vsm_type().
See Also	vsm_type(), vsm_height(), vsm_color()

v_rbox()

VOID v_rbox( handle, pxy )

WORD handle;

WORD *pxy;

	v_rbox() outputs a rounded box (not filled).
Opcode	11
Sub-Opcode	8
Availability	Supported by all drivers. This function composes one of the 10 VDI GDP's (Generalized Drawing Primitives). Although all current drivers support all GDP's, their availability is not guaranteed and may vary. To check for a particular GDP refer to the table returned by v_opnvwk() or v_opnwk().
Parameters	handle specifies a valid workstation handle. pxy points to an array of 4 WORDs containing the VDI format rectangle of the rounded box to output.
Binding	contrl[0] = 11; contrl[1] = 2; contrl[3] = 0; contrl[5] = 8; contrl[6] = handle; ptsin[0] = pxy[0]; ptsin[1] = pxy[1]; ptsin[2] = pxy[2]; ptsin[3] = pxy[3]; vdi();
Caveats	There is no way to define to size of the 'roundness' of the corners.
See Also	v_rfbox(), v_bar(), vsl_type(), vsl_color(), vsl_udsty(), vsl_ends()

v_rfbox()

VOID v_rfbox( handle, pxy )

WORD handle;

WORD *pxy;

	v_rfbox() outputs a filled rounded-rectangle.
Opcode	11
Sub-Opcode	9
Availability	Supported by all drivers. This function composes one of the 10 VDI GDP's (Generalized Drawing Primitives). Although all current drivers support all GDP's, their availability is not guaranteed and may vary. To check for a particular GDP refer to the table returned by v_opnvwk() or v_opnwk().
Parameters	handle specifies a valid workstation handle. pxy points to an array of four WORDs which specify the VDI format rectangle of the rounded-rectangle to output.
Binding	contrl[0] = 11; contrl[1] = 2; contrl[3] = 0; contrl[5] = 9; contrl[6] = handle; ptsin[0] = pxy[0]; ptsin[1] = pxy[1]; ptsin[2] = pxy[2]; ptsin[3] = pxy[3]; vdi();
Caveats	There is no way to specify the 'roundness' of the rectangle.
See Also	v_rbox(), v_bar(), vsf_color(), vsf_style(), vsf_interior(), vsf_udpat()

v_rmcur()

VOID v_rmcur( handle )

WORD handle;

	v_rmcur() removes the last mouse cursor displayed.
Opcode	5
Sub-Opcode	19
Availability	Supported by all screen drivers.
Parameters	handle specifies a valid workstation handle.
Binding	contrl[0] = 5; contrl[1] = contrl[3] = 0; contrl[5] = 19; contrl[6] = handle; vdi();
Comments	v_rmcur() should only be used in conjunction with v_dspcur() when the mouse is moved manually. graf_mouse() or v_hide_c() should be used unless this is your intention.
See Also	v_hide_c(), graf_mouse()

v_rvoff()

VOID v_rvoff( handle )

WORD handle;

	v_rvoff() causes alpha screen text to be displayed in normal video (as opposed to inverse).
Opcode	5
Sub-Opcode	14
Availability	Supported by all screen drivers.
Parameters	handle specifies a valid workstation handle.
Binding	contrl[0] = 5; contrl[1] = contrl[3] = 0; contrl[5] = 14; contrl[6] = handle; vdi();
Comments	This call is equivalent to the esc-q VT-52 code.
See Also	v_rvon(), v_curtext()

v_rvon()

VOID v_rvon( handle )

WORD handle;

	v_rvon() causes alpha screen text to be displayed in inverse mode.
Opcode	5
Sub-Opcode	13
Availability	Supported by all screen devices.
Parameters	handle specifies a valid workstation handle.
Binding	contrl[0] = 5; contrl[1] = contrl[3] = 0; contrl[5] = 13; contrl[6] = handle; vdi();
Comments	This call is equivalent to the esc-p VT-52 code.
See Also	v_rvoff(), v_curtext()

v_savecache()

WORD v_savecache( handle, fname )

WORD handle;

char *fname;

	v_savecache() saves the current outline cache.
Opcode	249
Availability	Available only with FSMGDOS or SpeedoGDOS.
Parameters	handle specifies a valid workstation handle. fname specifies the GEMDOS file specification of the cache file to save.
Binding	WORD i = 0; while(intin[i++] = (WORD)*fname++); contrl[0] = 249; contrl[1] = 0; contrl[3] = --i; contrl[6] = handle; vdi(); return intout[0];
Return Value	v_savecache() returns 0 if successful or -1 if an error occurred.
Comments	This call only saves the portion of the cache responsible for storing bitmaps created from outlines.
See Also	v_loadcache(), v_flushcache()

v_set_app_buff()

VOID v_set_app_buff( but, nparagraphs )

VOID *buf;

WORD nparagraphs;

	v_set_app_buff() designates memory for use by the bezier generation routines.
Opcode	-1
Sub-Opcode	6
Availability	Available only with FONTGDOS, FSMGDOS or SpeedoGDOS.
Parameters	buf specifies the address of a buffer which the bezier generator routines may safely use. nparagraphs specifies the size of the buffer in 'paragraphs' (16 bytes).
Binding	contrl[0] = -1; contrl[1] = 0; contrl[3] = 3; contrl[5] = 6; *(VOID *)&intin[0] = buf; intin[2] = nparagraphs; vdi();
Comments	Before the application exits, it should call v_set_app_buff( NULL, 0 ) to 'unmark' memory. The application is then responsible for deallocating the memory.In the absence of this call the first v_bez() or v_bezfill() call will allocate its own buffer of 8K. Atari documentation recommends a size of about 9K depending on the extents of the bezier you wish to generate.
See Also	v_bez()

v_show_c()

VOID v_show_c( handle, reset )

WORD handle, reset;

	v_show_c() 'unhides' the mouse cursor.
Opcode	122
Availability	Supported by all screen drivers.
Parameters	handle specifies a valid workstation handle. If reset is 0 the mouse will be displayed regardless of the number of times it was 'hidden'. Otherwise, the call will only display the cursor if the function has been called an equal number of times compared to v_hide_c().
Binding	contrl[0] = 122; contrl[1] = 0; contrl[3] = 1; contrl[6] = handle; intin[0] = reset; vdi();
Caveats	While it may be tempting to always use a reset value of 0, it is not recommended. Doing so may confuse the system so that when the critical error handler is called, the mouse is not displayed.
See Also	v_hide_c(), graf_mouse()

v_updwk()

VOID v_updwk( handle )

WORD handle;

	v_updwk() outputs the current page to the specified device.
Opcode	4
Availability	Supported by all printer, metafile, plotter, and camera devices when using any form of GDOS.
Parameters	handle specifies a valid workstation handle.
Binding	contrl[0] = 4; contrl[1] = contrl[3] = 0; contrl[6] = handle; vdi();
Comments	This call does not cause the 'page' to be ejected. You must use either v_clrwk() or v_form_adv() to accomplish that.
See Also	v_clrwk(), v_form_adv()

v_write_meta()

VOID v_write_meta( handle, intin_len, intin, ptsin_len, ptsin )

WORD handle, intin_len;

WORD *intin;

WORD ptsin_len;

WORD *ptsin;

	v_write_meta() writes a customized metafile sub-opcode.
Opcode	5
Sub-Opcode	99
Availability	Supported by all metafile drivers.
Parameters	handle specifies a valid workstation handle. intin points to an array of WORDs with intin_len (0-127) elements. ptsin points to an array of WORDs with ptsin_len (0-127) elements. ptsin is not required to be of any length, however, intin should be at least one word long to specify the sub-opcode in intin[0]. Sub-opcodes 0-100 are reserved for use by Atari. Several pre-defined sub-opcodes in this range already exist as follows:
		Sub-Opcode: intin[0]	Meaning
		10	Start group.
		11	End group.
		49	Set no line style.
		50	Set attribute shadow on.
		51	Set attribute shadow off.
		80	Start draw area type primitive.
		81	End draw area type primitive.
Binding	WORD i; contrl[0] = 5; contrl[1] = ptsin_len; contrl[3] = intin_len; contrl[5] = 99; contrl[6] = handle; for(i = 0;i < intin_len; i++) intin[i] = m_intin[i]; for(i = 0;i < ptsin_len; i++) ptsin[i] = m_ptsin[i]; vdi();
Comments	Metafile readers should ignore and safely skip any opcodes not understood.

vex_butv()

VOID vex_butv( handle, butv, old_butv )

WORD handle;

WORD (*butv)( (WORD) bstate );

WORD (**old_butv)( (WORD) bstate );

	vex_butv() installs a routine which is called by the VDI every time a mouse button is pressed.
Opcode	125
Availability	Supported by all screen drivers.
Parameters	handle specifies a valid physical workstation handle. butv points to a user-defined button-click handler routine. The address pointed to by old_butv will be filled in with the address of the old button-click handler.
Binding	contrl[0] = 125; contrl[1] = contrl[3] = 0; contrl[6] = handle; contrl[7] = (WORD)((LONG)butv >> 16); contrl[8] = (WORD)((LONG)butv); vdi(); *(LONG *)old_butv = (LONG)(((LONG)contrl[9] << 16) | (LONG)contrl[10]);
Comments	Upon entry to butv, the mouse status is contained in 68x00 register D0 (in the same format as the button return value in vq_mouse() ). A 'C' handler should, therefore, be sure to specify register calling parameters for this function. Any registers which will be modifed should be saved and restored upon function exit. The routine may call the BIOS and/or XBIOS sparingly but should not call the AES, VDI, or GEMDOS.
See Also	vex_curv(), vex_motv()

vex_curv()

VOID vex_curv( handle, curv, old_curv )

WORD handle;

WORD (*curv)( (WORD) mx, (WORD) my );

WORD (**old_curv)( (WORD) mx, (WORD) my );

	vex_curv() installs a routine which is called every time the mouse cursor is drawn allowing a customized mouse rendering routine to replace that of the system.
Opcode	127
Availability	Supported by all screen devices.
Parameters	handle specifies a valid physical workstation handle. curv points to a user defined function which will be called every time the mouse is to be refreshed. old_curv is the address of a pointer to the old rendering routine which will be filled in by the function on exit.
Binding	contrl[0] = 127; contrl[1] = contrl[3] = 0; contrl[6] = handle; contrl[7] = (WORD)((LONG)curv >> 16); contrl[8] = (WORD)((LONG)curv); vdi(); *(LONG *)old_curv = (LONG)(((LONG)contrl[9] << 16) | (LONG)contrl[10]);
Comments	Upon entry to curv, the mouse's X and Y location on screen is contained in 68x00 registers D0 and D1 respectively. A 'C' handler should, therefore, be sure to specify register calling parameters for this function. Any registers which will be modifed should be saved and restored upon function exit. The routine may call the BIOS and/or XBIOS sparingly but should not call the AES, VDI, or GEMDOS.
See Also	vex_butv(), vex_motv()

vex_motv()

VOID vex_motv( handle, motv, old_motv )

WORD handle;

WORD (*motv)( (WORD) mx, (WORD) my );

WORD (**old_motv)( (WORD) mx, (WORD) my );

	vex_motv() installs a user routine which is called every time the mouse pointer is moved.
Opcode	126
Availability	Supported by all screen drivers.
Parameters	handle specifies a valid physical workstation handle. motv points to a user-defined routine which is called every time the mouse is moved. old_motv is an address to a pointer which will be filled in containing the address of the old function.
Binding	contrl[0] = 126; contrl[1] = contrl[3] = 0; contrl[6] = handle; contrl[7] = (WORD)((LONG)motv >> 16); contrl[8] = (WORD)((LONG)motv); vdi(); *(LONG *)old_motv = (LONG)(((LONG)contrl[9] << 16) | (LONG)contrl[10]);
Comments	Upon entry to motv, the mouse's new X and Y location is contained in 68x00 registers D0 and D1 respectively. A 'C' handler should, therefore, be sure to specify register calling parameters for this function. Any registers which will be modifed should be saved and restored upon function exit. The routine may call the BIOS and/or XBIOS sparingly but should not call the AES, VDI, or GEMDOS. The routine may modify the contents of D0 and D1 as necessary to affect the movement of the mouse (one way of implementing a mouse accelerator).
See Also	vex_curv(), vex_butv()

vex_timv()

VOID vex_timv( handle, timv, old_timv, mpt )

WORD handle;

VOID (*timv)( VOID );

VOID (**old_timv)( VOID );

WORD *mpt;

	vex_timv() installs a user-defined routine that will be called at each timer tick (currently once every 50 milliseconds).
Opcode	118
Availability	Supported by all screen drivers.
Parameters	handle specifies a valid physical workstation handle. timv should point to a user-defined timer tick routine. old_timv is an address to a pointer which will be filled in with the old timer tick routine. mpt is a pointer to a WORD which will be filled in with the value representing the current number of milliseconds per timer tick.
Binding	contrl[0] = 118; contrl[1] = contrl[3] = 0; contrl[6] = handle; contrl[7] = (WORD)((LONG)timv >> 16); contrl[8] = (WORD)((LONG)timv); vdi(); *mpt = inout[0] *(LONG *)old_timv = (LONG)(((LONG)contrl[9] << 16) | (LONG)contrl[10]);
Comments	Any registers which will be modifed should be saved and restored upon function exit. The routine may call the BIOS and/or XBIOS sparingly but should not call the AES, VDI, or GEMDOS. The routine should fall through to the old routine. As this vector is jumped through quite often, the routine should be very simple to avoid system performance slowdowns.

vm_coords()

VOID vm_coords( handle, xmin, ymin, xmax, ymax )

WORD handle, xmin, ymin, xmax, ymax;

	vm_coords() allows the use of variable coordinate systems with metafiles.
Opcode	5
Sub-Opcodes	99, 1
Availability	Supported by all metafile drivers.
Parameters	handle specifies a valid workstation handle. xmin and ymin specify the coordinate pair which provides an anchor for the upper-left point of the coordinate system. xmax and ymax specify the coordinate pair which provides an anchor for the lower-right point of the coordinate system.
Binding	contrl[0] = 5; contrl[1] = 0; contrl[3] = 5; contrl[5] = 99; contrl[6] = handle; intin[0] = 1; intin[1] = xmin; intin[2] = ymin; intin[3] = xmax; intin[4] = ymax; vdi();
Comments	Use of this function allows the use of practically any coordinate system with a limit of ( -32768, -32768 ), ( 32767, 32767 ).Metafiles default to a coordinate space of ( 0, 32767 ), ( 32767, 0 ).
See Also	vm_pagesize(), v_meta_extents()

vm_filename()

VOID vm_filename( handle, fname )

WORD handle;

char *fname;

	vm_filename() allows specfying a user-defined filename for metafile output.
Opcode	5
Sub-Opcode	100
Availability	Supported by all metafile drivers.
Parameters	handle specifys a valid workstation handle. fname points to a NULL-terminated GEMDOS filename which all metafile output should be redirected to.
Binding	WORD i = 0; while(intin[i++] = (WORD)*fname++); contrl[0] = 5; contrl[1] = 0; contrl[3] = --i; contrl[5] = 100; contrl[6] = handle; vdi();
Caveats	When a metafile is opened, the default file 'GEMFILE.GEM' is created in the current GEMDOS path on the current drive and is not deleted as a result of this call. You will need to manually delete it yourself.
Comments	This call should be made immediately after a v_opnwk() to a metafile handle if you wish to use an alternate filename to prevent data from being lost.

vm_pagesize()

VOID vm_pagesize( handle, pwidth, pheight )

WORD handle, pwidth, pheight;

	vm_pagesize() specifys a metafile's source page size.
Opcode	5
Sub-Opcodes	99, 0
Availability	Supported by all metafile drivers.
Parameters	handle specifies a valid workstation handle. pwidth specifies the width of the page which the metafile was originally placed on in tenths of a millimeter. pheight specifies the height of the page which the metafile was originally placed on in tenths of a millimeter.
Binding	contrl[0] = 5; contrl[1] = 0; contrl[3] = 3; contrl[5] = 99; contrl[6] = handle; intin[0] = 0; intin[1] = pwidth; intin[2] = pheight; vdi();
Comments	A metafile originally designed on an 8.5" x 11" page would have a pwidth value of 2159 and a pheight value of 2794.
See Also	v_meta_extents()

vq_cellarray()

VOID vq_cellarray( handle, pxy, rowlen, num_rows, elements, rows_used, status, colarray )

WORD handle;

WORD *pxy;

WORD rowlen, num_rows;

WORD *elements, *rows_used, *status, *colarray;

	vq_cellarray() returns the cell array definitions of specified pixels.
Opcode	27
Availability	Not supported by any known drivers.
Parameters	handle specifies a valid workstation handle. pxy points to an array of 4 WORDs which specify a VDI format rectangle. row_length specifies the length of each row in the color array. num_rows specifies the number of total rows in the color array.Upon return, the WORD pointed to by elements will indicate the number of array elements used per row. In addition, rows_used will be filled in with actual number of rows used by the color array and the WORD pointed to by status will be filled in with 0 if the operation was successful or 1 if at least one element could not be determined. Finally, the WORD array (with (num_rows * row_length) elements) pointed to by colarray will be filled in with the color index array stored one row at a time. On return colarray will actually contain (elements * rows_used) valid elements.
Binding	WORD i; contrl[0] = 27; contrl[1] = 2; contrl[3] = 0; contrl[6] = handle; contrl[7] = row_length; contrl[8] = num_rows; ptsin[0] = pxy[0]; ptsin[1] = pxy[1]; ptsin[2] = pxy[2]; ptsin[3] = pxy[3]; vdi(); *el_used = contrl[9]; *rows_used = contrl[10]; *status = contrl[11]; for(i = 0;i < contrl[4];i++) colarray[i] = intout[i];
Caveats	No driver types are required to utilize this function. It is therefore recommended that it be avoided unless your application is aware of the capabilities of the driver.
See Also	v_cellarray()

vq_chcells()

VOID vq_chcells( handle, rows, columns )

WORD handle;

WORD *rows, *columns;

	vq_chcells() returns the current number of columns and rows on the alpha text mode of the device.
Opcode	5
Sub-Opcode	1
Availability	Supported by all screen and printer drivers.
Parameters	handle specifies a valid workstation handle. rows and columns each point to a WORD which will be filled in with the current number of rows and columns of the device (in text mode).
Binding	contrl[0] = 5; contrl[1] = contrl[3] = 0; contrl[5] = 1; contrl[6] = handle; vdi(); *rows = intout[0]; *columns = intout[1];
See Also	v_curtext()

vq_color()

WORD vq_color( handle, index, flag, rgb)

WORD handle, index, flag;

WORD *rgb;

	vq_color() returns RGB information for a particular VDI color index.
Opcode	26
Availability	Supported by all drivers.
Parameters	handle specifies a valid workstation handle. index specifies the VDI color index of which you wish to inquire. rgb points to an array of 3 WORDs which will be filled in with the red, green, and blue values (0-1000) of the color index. The values returned in the RGB array are affected by the value of flag as follows:
	Name	flag	Values returned in rgb
	COLOR_REQUESTED	0	Return the values as last requested by the user (ie: not mapped to the actual color value displayed).
	COLOR_ACTUAL	1	Return the values as the actual color being displayed.
Binding	contrl[0] = 26; contrl[1] = 0; contrl[3] = 2; contrl[6] = handle; intin[0] = index; intin[1] = flag; vdi(); rgb[0] = intout[1]; rgb[1] = intout[2]; rgb[2] = intout[3]; return intout[0];
Return Value	vq_color() returns -1 if the specified index is out of range for the device.
Comments	Some drivers for color printers do not allow you to modify the color of each register. A simple test will allow you to determine if the driver will allow you to change index colors as follows: Call vq_color() with a flag value of 0 and save the return. Call vs_color() to modify that color index by a signifigant value. Call vq_color() with a flag value of 0 and compare with what you set. Restore the old value. If equivalent values are returned, you may modify each color index.
See Also	vs_color()

vq_curaddress()

VOID vq_curaddress( handle, row, column )

WORD handle;

WORD *row, *column;

	vq_curaddress() returns the current position of the alpha text cursor.
Opcode	5
Sub-Opcode	15
Availability	Supported by all screen drivers.
Parameters	handle specifies a valid workstation handle. The WORDs pointed to by row and column will be filled in with the current row and column respectively of the text cursor in alpha mode.
Binding	contrl[0] = 5; contrl[1] = contrl[3] = 0; contrl[5] = 15; contrl[6] = handle; vdi(); *row = intout[0]; *column = intout[1];
See Also	v_curtext(), vq_chcells()

vq_extnd()

VOID vq_extnd( handle, mode, work_out )

WORD handle, mode;

WORD *work_out;

	vq_extnd() returns extra information about a particular workstation.
Opcode	102
Availability	Supported by all drivers.
Parameters	handle specifies a valid workstation handle. If mode is set to 0 then this call fills in the array pointed to by work_out with the same 57 WORDs which are returned by either v_opnwk() or v_opnvwk(). If mode is 1 then the 57 WORDs of work_out are filled in with other information as follows:
	work_out[x]	VDI Structure Member	Meaning
	0	screentype	Type of display screen:0 = Not screen.1 = Separate alpha/ graphic controllers and displays. 2 = Separate alpha/ graphic controllers with common screen. 3 = Common alpha/ graphic controllers with separate image memory. 4 = Common alpha/ graphic controllers and image memory.(All known devices either return 0 or 4.)
	1	bgcolors	Number of background colors available.
	2	textfx	Text effects supported. (Same bitmask as with vst_effects() ).
	3	canscale	Scaling of rasters:0 = Can't scale. 1 = Can scale.
	4	planes	Number of planes.
	5	lut	Lookup table supported:0 = Table not supported. 1 = Table supported.(True color modes return a value of 0 for lut and >2 for colors in v_opnvwk()).See the caveat listed below.
	6	rops	Performance factor. Number of 16x16 raster operations per second.
	7	cancontourfill	v_contourfill() availability:0 = Not available. 1 = Available.
	8	textrot	Character rotation capability:0 = None. 1 = 90 degree increments. 2 = Any angle of rotation.
	9	writemodes	Number of writing modes available.
	10	inputmodes	Highest level of input modes available:0 = None. 1 = Request. 2 = Sample.
	11	textalign	Text alignment capability flag:0 = Not available. 1 = Available.
	12	inking	Inking capability flag.0 = Device can't ink. 1 = Device can ink.
	13	rubberbanding	Rubberbanding capability flag:0 = No rubberbanding. 1 = Rubberbanded lines. 2 = Rubberbanded lines and rectangles.
	14	maxvertices	Maximum vertices for polyline, polymarker, or filled area (-1 = no maximum).
	15	maxintin	Maximum length of intin array (1 = no maximum).
	16	mousebuttons	Number of mouse buttons.
	17	widestyles	Styles available for wide lines?0 = No 1 = Yes
	18	widemodes	Writing modes available for wide lines?0 = No 1 = Yes
	19-56	reserved1	Reserved for future use.
Binding	WORD i; contrl[0] = 102; contrl[1] = 0; contrl[3] = 1; contrl[6] = handle; intin[0] = mode; vdi(); for(i = 0;i < 45;i++) work_out[i] = intout[i]; for(i = 0;i < 13;i++) work_out[45+i] = ptsout[i];
Comments	See the entry for V_Opnwk() and V_Opnvwk() to see how the vq_extnd() information and v_opn/v/wk() calls are integrated into a 'C' style structure.
Caveats	The lut member of the VDIWORK structure was originally misdocumented by Atari with the values reversed. The Falcon030 as well as some third-party true-color boards return the correct values. Some older boards may not, however.One alternative method of determining if the current screen is not using a software color lookup table (i.e. true color) is to compare the value for 2 ^ planes with the number of colors in the palette found in colors. If this number is different, the VDI is not using a software color lookup table.
See Also	v_opnwk(), v_opnvwk(), V_Opnwk(), V_Opnvwk()

vq_gdos()

ULONG vq_gdos( VOID )

	vq_gdos() determines the availability and type of GDOS present.
Opcode	N/A
Availability	Supported in ROM by all Atari computers.
Binding	; Correct binding for vq_gdos. Some compilers ; use the name vq_vgdos for the new version ; and vq_gdos for the old version which ; looked like: ; move.w #-2,d0 ; trap #2 ; cmp.w #-2,d0 ; sne d0 ; ext.w d0 _vq_gdos: move.w #-2,d0 trap #2 rts
Return Value	Currently one of the following values are returned:
	Name	Value	GDOS Type
	GDOS_NONE	-2	GDOS not installed.
	-	Any other value.	GDOS 1.0, 1.1, or 1.2 installed.
	GDOS_FNT	0x5F464E54 ('_FNT')	FONTGDOS installed.
	GDOS_FSM	0x5F46534D ('_FSM')	FSMGDOS installed.
Comments	Calling a GDOS function without GDOS loaded is fatal and will cause a system crash.To determine whether FSMGDOS or SpeedoGDOS is loaded look for the 'FSMC' cookie in the cookie jar. The cookie value points to a longword which will contain either '_FSM' or '_SPD'.

vq_key_s()

VOID vq_key_s( handle, status )

WORD handle;

WORD *status;

	vq_key_s() returns the current shift-key status.
Opcode	128
Availability	Supported by all Atari computers.
Parameters	handle specifies a valid workstation handle. status points to a WORD which is filled in on function exit with a bit mask containing the current shift key status as follows:
		Name	Bit	Meaning
		K_RSHIFT	0	Right shift key depressed
		K_LSHIFT	1	Left shift key depressed
		K_CTRL	2	Control key depressed
		K_ALT	3	Alternate key depressed
Binding	contrl[0] = 128; contrl[1] = contrl[3] = 0; contrl[6] = handle; vdi(); *status = intout[0];
See Also	graf_mkstate()

vq_mouse()

VOID vq_mouse( handle, mb, mx, my )

WORD handle;

WORD *mb, *mx, *my;

	vq_mouse() returns information regarding the current state of the mouse.
Opcode	124
Availability	Supported by all screen drivers.
Parameters	handle specifies a valid workstation handle. mb points to a WORD which will be filled in upon function exit with a bit mask indicating the current status of the mouse buttons as follows:
	Name	Mask	Meaning
	LEFT_BUTTON	0x01	Left mouse button
	RIGHT_BUTTON	0x02	Right mouse button
	MIDDLE_BUTTON	0x04	Middle button (this button would be the first button to the left of the rightmost button on the device).
	-	0x08 . .	Other buttons (0x08 is the mask for the button to the immediate left of the middle button. Masks continue leftwards).
	mx and my both point to WORDs which will be filled in upon function exit with the current position of the mouse pointer.
Binding	contrl[0] = 124; contrl[1] = contrl[3] = 0; contrl[6] = handle; vdi(); *mb = intout[0]; *mx = ptsout[0]; *my = ptsout[1];
See Also	graf_mkstate(), v_key_s()

vq_scan()

VOID vq_scan( handle, grh, passes, alh, apage, div )

WORD handle;

WORD *grh, *passes, *alh, *apage, *div;

	vq_scan() returns information regarding printer banding.
Opcode	5
Sub-Opcode	24
Availability	Supported by all printer drivers.
Parameters	handle specifies a valid workstation handle. passes specifies the number of graphic passes per printer page. The value obtained through the formula grh/div specifies the number of graphics scan lines per pass. The value obtained by the formula alh/div specifies the number of graphic scan lines per alpha text line. apage specifies the number of alpha lines per page.
Binding	contrl[0] = 5; contrl[1] = contrl[3] = 0; contrl[5] = 24; contrl[6] = handle; vdi(); *grh = intout[0]; *passes = intout[1]; *alh = intout[2]; *apage = intout[3]; *div = intout[4];
Comments	This call has been previously mis-documented.

vq_tabstatus()

WORD vq_tabstatus( handle )

WORD handle;

	vq_tabstatus() determines the availability of a tablet device.
Opcode	5
Sub-Opcode	16
Availability	Supported by all screen drivers.
Parameters	handle specifies a valid workstation handle.
Binding	contrl[0] = 5; contrl[1] = contrl[3] = 0; contrl[5] = 16; contrl[6] = handle; vdi(); return intout[0];
Return Value	vq_tabstatus() returns 0 if no tablet is available or 1 if a tablet device is present.
See Also	vq_tdimensions(), vt_origin(), vt_axis(), vt_resolution(), vt_alignment()

vq_tdimensions()

VOID vq_tdimensions( handle, xdim, ydim )

WORD handle;

WORD *xdim, *ydim;

	vq_tdimensions() returns the scanning dimensions of the attached graphics tablet.
Opcode	5
Sub-Opcode	84
Availability	Supported by all tablet drivers.
Parameters	handle specifies a valid workstation handle. xdim and ydim point to WORDs which upon function exit will contain the X and Y dimensions of the tablet scanning area specified in tenths of an inch.
Binding	contrl[0] = 5; contrl[1] = contrl[3] = 0; contrl[5] = 84; contrl[6] = handle; vdi(); *xdim = intout[0]; *ydim = intout[1];
See Also	vq_tabstatus()

vqf_attributes()

VOID vqf_attributes( handle, attr )

WORD handle;

WORD *attr;

	vqf_attributes() returns information regarding the current fill attributes.
Opcode	37
Availability	Supported by all devices.
Parameters	handle specifies a valid workstation handle. attr points to an array of five WORDs which upon exit will be filled in as follows:
		attr[x]	Meaning
		0	Current fill area interior type (see vsf_interior() ).
		1	Current fill area color (see vsf_color() ).
		2	Current fill area style (see vsf_style() ).
		3	Current writing mode (see vswr_mode() ).
		4	Current perimeter status (see vsf_perimeter() ).
Binding	contrl[0] = 37; contrl[1] = contrl[3] = 0; contrl[6] = handle; vdi(); attr[0] = intout[0]; attr[1] = intout[1]; attr[2] = intout[2]; attr[3] = intout[3]; attr[4] = intout[4];
See Also	vqt_attributes(), vql_attributes(), vqm_attributes()

vqin_mode()

VOID vqin_mode( handle, dev, mode )

WORD handle, dev;

WORD *mode;

	vqin_mode() returns the input status of the specified VDI device.
Opcode	115
Availability	Supported by all Atari computers.
Parameters	handle specifies a valid workstation handle. mode points to a WORD which upon exit will be filled in with 1 if the specified device is in request mode or 2 if in sample mode. dev specifies the device to inquire as follows:
		Name	dev	Device
		LOCATOR	1	Locator (Mouse, Mouse Buttons, and Keyboard)
		VALUATOR	2	Valuator (not currently defined)
		CHOICE	3	Choice (not currently defined)
		STRING	4	String (Keyboard)
Binding	contrl[0] = 115; contrl[1] = 0 contrl[3] = 1; contrl[6] = handle; intin[0] = dev; vdi(); *mode = intout[0];
See Also	vsin_mode()

vql_attributes()

VOID vql_attributes( handle, attr )

WORD handle;

WORD *attr;

	vql_attributes() returns information regarding current settings which affects line drawing functions.
Opcode	35
Availability	Supported by all drivers.
Parameters	handle specifies a valid workstation handle. attr is an array of 6 WORDs which describe the current parameters for line drawing as follows:
		attr[x]	Meaning
		0	Line type (see vsl_type() ).
		1	Line color (see vsl_color() ).
		2	Writing mode (see vswr_mode() ).
		3	End style for start of lines (see vsl_ends() ).
		4	End style for end of lines (see vsl_ends() ).
		5	Current line width (see vsl_width() ).
Binding	contrl[0] = 35; contrl[1] = contrl[3] = 0; contrl[6] = handle; vdi(); attr[0] = intout[0]; attr[1] = intout[1]; attr[2] = intout[2]; attr[3] = intout[3]; attr[4] = intout[4]; attr[5] = intout[5];
See Also	vqm_attributes(), vqt_attributes(), vqf_attributes()