summaryrefslogtreecommitdiff
path: root/xc/unsupported/doc/PHIGS/man3/p021
blob: e5983dc82950cca144eca6c23e67586a65756661 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
.\"##
.\" $XConsortium: p021,v 5.2 94/04/17 20:54:25 rws Exp $
.\"##
.\"## 
$XMCOPY
.\"## Copyright (c) 1990, 1991 by Sun Microsystems, Inc. 
.\"## 
.\"##                         All Rights Reserved
.\"## 
.\"## Permission to use, copy, modify, and distribute this software and its 
.\"## documentation for any purpose and without fee is hereby granted, 
.\"## provided that the above copyright notice appear in all copies and that
.\"## both that copyright notice and this permission notice appear in 
.\"## supporting documentation, and that the name of Sun Microsystems,
.\"## not be used in advertising or publicity 
.\"## pertaining to distribution of the software without specific, written 
.\"## prior permission.  
.\"## 
.\"## SUN MICROSYSTEMS DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, 
.\"## INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
.\"## EVENT SHALL SUN MICROSYSTEMS BE LIABLE FOR ANY SPECIAL, INDIRECT OR
.\"## CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF
.\"## USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
.\"## OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
.\"## PERFORMANCE OF THIS SOFTWARE.
.TH "COMPOSE MATRIX" 3P "29 February 1991"
.SH NAME
COMPOSE MATRIX  \- generate the composition of two homogeneous
\s-2\&2D\s+2 matrices
.SH SYNOPSIS
.SS C Syntax
.ft B
.ta 1.25i 3i
.nf
void
pcompose_matrix ( a, b, error_ind, m )
Pmatrix	a;	\fImatrix a\fP
Pmatrix	b;	\fImatrix b\fP
Pint	*error_ind;	\fI\s-2OUT\s+2 error indicator\fP
Pmatrix	m;	\fI\s-2OUT\s+2 result matrix\fP
.fi
.ft R
.SS Required PHIGS Operating States
(PHOP, *, *, *)
.SH DESCRIPTION
.SS Purpose
Use \s-2COMPOSE MATRIX\s+2 to produce a \s-2\&2D\s+2 (3\ \(mu\ 3) homogeneous matrix
that is the composition (matrix multiplication product) of two specified
3\ \(mu\ 3 matrices.
.LP
The returned matrix may be passed to the \s-2SET LOCAL TRANSFORMATION\s+2
and \s-2SET GLOBAL TRANSFORMATION\s+2 functions, or to any \s-2PHIGS\s+2 function
accepting a parameter of type Pmatrix.
.SS C Input Parameters
.IP "\fIa\fP, \fIb\fP"
The \s-2\&2D\s+2 (3\ \(mu\ 3) matrices used to calculate the composition matrix.
Matrices are specified as a Pmatrix array defined in phigs.h as follows:
.IP
typedef  Pfloat  Pmatrix[3][3];
.LP
.SS C Output Parameters
.IP \fIerror_ind\fP
A pointer to the location to store the error number of any error detected
by this function.
.IP \fIm\fP
The resulting composition matrix.
.SS Execution
\s-2COMPOSE MATRIX\s+2 returns a 3\ \(mu\ 3 matrix that is the result of
multiplying the two specified matrices \fIa\fP and \fIb\fP:
.IP
\fIresult\fP = \fIa\fP \s-2x\s+2 \fIb\fP
.SH ERRORS
.IP 002
Ignoring function, function requires state (\s-2PHOP, *, *, *\s+2)
.SH SEE ALSO
.nf
.IP
.ta 0.5i
.SM "COMPOSE MATRIX 3 (3P)"
.SM "COMPOSE TRANSFORMATION MATRIX (3P)"
.SM "BUILD TRANSFORMATION MATRIX (3P)"
.SM "SET LOCAL TRANSFORMATION (3P)"
.SM "SET GLOBAL TRANSFORMATION (3P)"
.fi