.\" @(#)PEXRotate.3 1.5 95/03/24 SMI;
.so man3/pex.macs
.TH PEXRotate 3 "May 1995" "Solaris PEXlib Reference Manual" ""
.SH NAME
PEXRotate - utility function
.SH SYNTAX
.HP
int PEXRotate\^(\^int \fIaxis\fP, double \fIangle\fP, PEXMatrix \fImatrix_return\fP\^)
.SH PARAMETERS
.IP \fIaxis\fP 1i
One of
.B PEXXAxis,
.B PEXYAxis,
.B PEXZAxis.
.IP \fIangle\fP 1i
Angle of the rotation in radians.
.IP \fImatrix_return\fP 1i
Matrix into which rotation matrix is stored.
.SH RETURNS
.LP
Zero if successful; otherwise, one of the following:
.TP
.B PEXBadAxis
Invalid axis value specified.
.SH DESCRIPTION
.\" indexing
.IX PEXRotate
.IX "Utility Functions" PEXRotate
.LP
This function creates a rotation matrix about the specified
.I axis.
.LP
The resulting matrix rotates by the
.I angle
specified in radians about the origin.
.LP
The function returns unsuccessfully if
.I axis
is not one of the defined values.
.SH ERRORS
None
.SH SEE ALSO
.LP
.nf
.BR PEXRotate2D (3)
.BR PEXRotateGeneral (3)
.fi