summaryrefslogtreecommitdiff
path: root/xc/unsupported/doc/PHIGS/man3/p231
blob: 9af17e86e5a978e0218f21c37ccf3169bae80f85 (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
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
.\"##
.\" $XConsortium: p231,v 5.2 91/08/16 15:03:41 hersh 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 "INQUIRE WORKSTATION TRANSFORMATION 3" 3P "29 February 1991"
.SH NAME
INQUIRE WORKSTATION TRANSFORMATION 3 \- inquire a 3D workstation transformation
.IX "Workstation Transformation" "INQUIRE WORKSTATION TRANSFORMATION 3"
.SH SYNOPSIS
.SS C Syntax
.ft B
.ta 1.25i 3i
.nf
void
pinq_ws_tran3 ( ws, error_ind, upd_st, req_win_lim, cur_win_lim, req_vp_lim,
cur_vp_lim)
Pint	ws;	\fIworkstation identifier\fP
Pint	*error_ind;	\fIOUT error indicator\fP
Pupd_st	*upd_st;	\fIOUT update state\fP
Plimit3	*req_win_lim;	\fIOUT requested workstation window\fP
Plimit3	*cur_win_lim;	\fIOUT current workstation window\fP
Plimit3	*req_vp_lim;	\fIOUT requested workstation viewport\fP
Plimit3	*cur_vp_lim;	\fIOUT current workstation viewport\fP
.fi
.ft R
.SS Required PHIGS Operating States
(PHOP, WSOP, *, *)
.SH DESCRIPTION
.SS Purpose
Use \s-2INQUIRE WORKSTATION TRANSFORMATION 3\s+2 to determine the current
and requested \s-2\&3D\s+2 transformation
from a specified workstation's state list.
.SS C Input Parameter
.IP \fIws\fP
The \fIworkstation identifier\fP of the workstation whose state list is queried.
.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 \fIupd_st\fP
The current update state.  Pupd_st is defined in phigs.h as follows:
.sp .4
.nf
typedef enum {
.sp .2
.ta .5i
	PUPD_NOT_PEND
	PUPD_PEND
.sp .2
} Pupd_st;
.fi
.IP \fIreq_win_lim\fP
The requested workstation window.  Plimit3 is defined in phigs.h as follows:
.sp .4
.nf
.ta .5i +\w'Pfloat      'u +\w'x_min;     'u
typedef struct {
.sp .2
	Pfloat	x_min;	
	Pfloat	x_max;	
	Pfloat	y_min;
	Pfloat	y_max;  
	Pfloat 	z_min;
	Pfloat	z_max; 
.sp .2
} Plimit3;
.fi
.IP \fIcur_win_lim\fP
The current workstation window.  Plimit3 is defined above.
.IP \fIreq_vp_lim\fP
The requested workstation viewport. Plimit3 is defined above. 
.IP \fIcur_vp_lim\fP
The current workstation viewport.  Plimit3 is defined above.
.SS Execution
The requested and current entries may differ if a workstation transformation
change has been requested, but has not yet been provided.  The update
state will be \fIPending\fP in this case, and \fINot Pending\fP otherwise.
.SH ERRORS
.IP 003
Ignoring function, function requires state 
(\s-2PHOP\s+2, \s-2WSOP\s+2, \s-2*\s+2, \s-2*\s+2)
.IP 054
Ignoring function, the specified workstation is not open
.IP 057
Ignoring function, specified workstation is of category \s-2MI\s+2
.SH SEE ALSO
.nf
.IP
.ta 0.5i
.SM "SET WORKSTATION VIEWPORT 3 (3P)"
.SM "SET WORKSTATION WINDOW 3 (3P)"
.SM "INQUIRE WORKSTATION TRANSFORMATION (3P)"
.fi