.\" @(#)PEXEncodedText2D.3 1.5 95/03/24 SMI;
.so man3/pex.macs
.TH PEXEncodedText2D 3 "May 1995" "Solaris PEXlib Reference Manual" ""
.SH NAME
PEXEncodedText2D \- Encoded 2D Text Primitive
.SH SYNTAX
.HP
void PEXEncodedText2D\^(\^Display *\fIdisplay\fP\^, XID \fIresource_id\fP\^, PEXOCRequestType \fIreq_type\fP\^, PEXCoord2D *\fIorigin\fP\^, unsigned int \fIcount\fP\^, PEXEncodedTextData *\fIencoded_text\fP\^)
.SH PARAMETERS
.IP \fIdisplay\fP 1i
A pointer to a display structure returned by a successful
.B XOpenDisplay
call.
.IP \fIresource_id\fP 1i
The resource identifier of the renderer or structure.
.IP \fIreq_type\fP 1i
The request type for the output command (
.B PEXOCRender,
.B PEXOCStore,
.B PEXOCRenderSingle
or
.B PEXOCStoreSingle
).
.IP \fIorigin\fP 1i
The origin of the text string.
.IP \fIcount\fP 1i
The number of encoded text strings.
.IP \fIencoded_text\fP 1i
An array of encoded text strings.
.SH RETURNS
None
.SH DESCRIPTION
.\" indexing
.IX PEXEncodedText2D
.IX "Text Primitive" PEXEncodedText2D
.LP
This function creates a 2D text output primitive.
.LP
This function is similar to
.BR PEXText2D (3) ,
except
that multiple encoded text strings are specified.  Each text
string in encoded text array has a character set, a character
set width, an encoding state, and a list of characters.
.LP
The character
set is an index into the current font group.  Font groups contain
individual fonts which are numbered starting at one; a value of
three selects the third font in the font group currently being
used.  If a character set is not available in the current font
group then the entire string will be rendered using the default
font group.  If a character set value is not available in the
default font group then that portion of the string will be rendered
in an implementation-dependent manner.  The character set width indicates
the width or size of characters in the strings.
Valid values for character set width are
.B PEXCSByte,
.B PEXCSShort
and
.B PEXCSLong.
The encoding state is provided for use by the application and is not
interpreted by the \s-1PEX\s0 server.
.LP
All other aspects of this primitive are the same as
.BR PEXText2D (3) .
.SH DATA STRUCTURES
.LP
.nf
typedef struct {
	unsigned short		character_set;
	unsigned char		character_set_width;	/* PEXCSByte, PEXCSShort,
							   PEXCSLong */
	unsigned char		encoding_state;
	unsigned short		reserved;
	unsigned short		length;
	char			*ch;
.br
} PEXEncodedTextData;
.fi
.sp .5
See also
.B PEXlib.h.
.SH ERRORS
.TP
.SB BadPEXRenderer
The specified renderer resource identifier is invalid.
.TP
.SB BadPEXStructure
The specified structure resource identifier is invalid.
.SH SEE ALSO
.LP
.nf
.BR PEXSetTextFontIndex (3)
.BR PEXSetTextPrecision (3)
.BR PEXSetCharExpansion (3)
.BR PEXSetCharSpacing (3)
.BR PEXSetTextColorIndex (3)
.BR PEXSetTextColor (3)
.BR PEXSetCharHeight (3)
.BR PEXSetCharUpVector (3)
.BR PEXSetTextPath (3)
.BR PEXSetTextAlignment (3)
.BR PEXSetTextBundleIndex (3)
.fi