inquire_text_extent(3G)

NAME

inquire_text_extent, intinquire_text_extent2d − return text-extent rectangle coordinates

SYNOPSIS

C Syntax:

void inquire_text_extent ( fildes, string, xform, extent )
int fildes, xform;
char *string;
float extent[12];

void intinquire_text_extent2d ( fildes, string, xform, extent )
int fildes, xform, extent[8];
char *string;

FORTRAN77 Syntax:

subroutine inquire_text_extent ( fildes, string, xform, extent )
integer*4 fildes, xform
character*(*) string
real extent (12)

subroutine intinquire_text_extent2d ( fildes, string, xform,
extent )
integer*4 fildes, xform, extent (8)
character*(*) string

Pascal Syntax:

typestring255=string[255];
text_extent_array=array[1..12] of real;
inttext2d_extent_array=array[1..8] of integer;

procedure inquire_text_extent ( fildes:integer; str:string255;
xform:integer; var extent:text_extent_array );

procedure intinquire_text_extent2d ( fildes:integer; str:string255;
xform:integer; var extent:inttext2d_extent_array );

DESCRIPTION

Input Parameters

fildes Integer file descriptor returned by gopen when an I/O path to a graphics device is opened.

string String of ASCII characters.

xform Enumerated value specifying the type of transformation to perform on the font coordinates:

VDC_TEXT = VDC
WORLD_COORDINATE_TEXT = world coordinate
TOS_TEXT = top of matrix stack

OUTPUT PARAMETER

extent Return array for the coordinates of the concatenation point and the text extent rectangle.

Discussion

The inquire_text_extent and intinquire_text_extent2d procedures execute the string and return the extent values. Inquire_text_extent returns:

extent [0]: Concatenation point: x coordinate

extent [1]: Concatenation point: y coordinate

extent [2]: Concatenation point: z coordinate

extent [3]: Lower-left corner: x coordinate

extent [4]: Lower-left corner: y coordinate

extent [5]: Lower-left corner: z coordinate

extent [6]: Upper-left corner: x coordinate

extent [7]: Upper-left corner: y coordinate

extent [8]: Upper-left corner: z coordinate

extent [9]: Upper-right corner: x coordinate

extent [10]: Upper-right corner: y coordinate

extent [11]: Upper-right corner: z coordinate

Intinquire_text_extent2d returns the following values:

extent [0]: Concatenation point: x coordinate

extent [1]: Concatenation point: y coordinate

extent [2]: Lower-left corner: x coordinate

extent [3]: Lower-left corner: y coordinate

extent [4]: Upper-left corner: x coordinate

extent [5]: Upper-left corner: y coordinate

extent [6]: Upper-right corner: x coordinate

extent [7]: Upper-right corner: y coordinate

For VDC_TEXT the returned coordinates are in virtual device coordinate values.

For WORLD_COORDINATE_TEXT the returned values are in world coordinate values.

For TOS_TEXT the returned values are defined by the top of the matrix stack.

Integer operations are only available when using the INT_XFORM gopen mode. When in INT_XFORM mode, floating point operations are not available for that fildes. Floating point operations are the default, or can be specified with FLOAT_XFORM mode. For a list of integer operations, floating point operations and common operations see the starbase(3G) manual page.

Museum

Related Articles