summaryrefslogtreecommitdiff
path: root/xc/unsupported/doc/PHIGS/man3/p013
blob: 9b062f19fee8a2e4e54162709711c598b8e80121 (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
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
.\"
.\" $XConsortium: p013,v 5.2 91/08/16 14:31:05 hersh Exp $
.\"
.\" 
$XMCOPY
.\" Copyright (c) 1990, 1991 by Sun Microsystems, Inc. and the X Consortium.
.\" 
.\"                         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 names of Sun Microsystems,
.\" and the X Consortium 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 "CELL ARRAY 3 PLUS" 3P "29 February 1991"
.SH NAME
CELL ARRAY 3 PLUS \-
create a \s-23D\s+2 extended cell array element
.IX "CELL ARRAY 3 PLUS"
.SH SYNOPSIS
.SS C Syntax
.ft B
.ta 1.4i 3i
.nf
void
pcell_array3_plus ( paral, dim, colour_model, colrs )
Pparal	*paral;	\fIcell parallelogram: [0]=P; [1]=Q; [2]=R\fP
Pint_size	*dim;	\fIdimension of cell: DX and DY\fP
Pint	colour_model;	\fIcolour model\fP
Pcoval	*colrs;	\fIcolour array\fP
.fi
.SS Required PHIGS Operating States
(PHOP, *, *, *)
.SH DESCRIPTION
.SS Purpose
\s-2CELL ARRAY 3 PLUS\s+2 creates a \s-23D\s+2 cell array made of cells
filled with general colour in each cell. Its area is defined by three
points P, Q, and R in Modelling Coordinates giving the corners of a 
parallelogram as P, Q, R and (Q+R-P).
.\" .LP
.\" This is a \s-2PHIGS\s0 Extension function based on
.\" \s-2PHIGS PLUS\s+2 and is not part of the
.\" \s-2PHIGS\s+2 standard.
.SS C Input Parameters
.IP \fIparal\fP
A pointer to an array of three Ppoint3 structures giving three corners of the 
parallelogram that defines the area of the \s-2CELL ARRAY 3 PLUS\s+2
element.  Pparal is defined in phigs.h as follows:
.sp .2
.nf
.ta .5i +1i +1i
.sp .2
typedef struct {
.sp .2
	Ppoint3	p;	/* point p */
	Ppoint3	q;	/* point q */
	Ppoint3	r;	/* point r */
.sp .2
} Pparal;
.IP
.fi
.IP \fIcolour_model\fP
The colour model for specified cell colours.
.sp
.nf
.ta .5i +\w'PMODEL_CIELUV     'u 
0       PINDIRECT	\fIColour Index Specified\fP
1       PMODEL_RGB	\fIRed, Green, Blue Colour Model\fP
2       PMODEL_CIELUV	\fICommission Internationale de l'Eclairage Colour Model\fP
3       PMODEL_HSV	\fIHue, Saturation, Value Colour Model\fP
4       PMODEL_HLS	\fIHue, Lightness, Saturation Colour Model\fP
.sp
.fi
.IP
.SS C Output Parameters
.IP \fIdim\fP
A pointer to a Pdim structure specifying the dimensions of the colour
cells array.
Pint_size is defined in phigs.h as follows:
.sp .4
.ta .5i +1i +1i
.nf
typedef struct {
.sp .2
	Pint	size_x;	/* dimension (number of divisions) along X */
	Pint	size_y;	/* dimension (number of divisions) along Y */
.sp .2
} Pint_size;
.fi
.IP \fIcolrs\fP
A pointer to an array of Pcoval of dimension defined by \fIdim\fP,
containing the colour values specifying cell colours. 
Pcoval is defined in phigs.h as follows:
.bp
.ta .5i +1.5i +1i   
.nf
typedef union {
.sp .2
	Pint	index;	/* index in workstation colour bundle table */
	Pcolr_rep	direct;	/* direct colour components */
.sp .2
} Pcoval;
.fi
.sp
Pcolr_rep is defined as:
.sp .4
.ta .5i +1i +1i
.nf
.sp .2
typedef union {
.sp .2
	Prgb	rgb;	/* Red Green Blue colour specification */
	Pcieluv	cieluv;	/* CIE L*U*V* colour specification */
	Phls	hls;	/* Hue Lightness Saturation colour specification */
	Phsv	hsv;	/* Hue Saturation Value colour specification */
	Pdata	unsupp;	/* Colour in unsupported colour model */
.sp .2
} Pcolr_rep
.fi
.IP
Prgb is defined in phigs.h as follows:
.nf
.ta .5i +1i +1i
.sp .2
typedef struct {
.sp .2
	Pfloat	red;	/* red, hue, etc */
	Pfloat	green;	/* green, saturation, lightness, etc */
	Pfloat	blue;	/* blue, value, saturation, etc */
.sp .2
} Prgb;
.fi
.IP
Pcieluv is defined in phigs.h as follows:
.nf
.ta .5i +1i +1i
.sp .2
typedef struct {
.sp .2
	Pfloat	cieluv_x;	/* x coefficient */
	Pfloat	cieluv_y;	/* y coefficient */
	Pfloat	cieluv_y_lum;	/* y luminance */
.sp .2
} Pcieluv;
.fi
.IP
Phsv is defined in phigs.h as follows:
.nf
.ta .5i +1i +1i
.sp .2
typedef struct {
.sp .2
	Pfloat	hue;	/* hue */
	Pfloat	satur;	/* saturation */
	Pfloat	value;	/* value */
.sp .2
} Phsv;
.fi
.IP
Phls is defined in phigs.h as follows:
.nf
.ta .5i +1i +1i
.sp .2
typedef struct {
.yp .2
	Pfloat	hue;	/* hue */
	Pfloat	lightness;	/* lightness */
	Pfloat	satur;	/* saturation */
.sp .2
} Phls;
.fi
.IP
Pdata is defined in phigs.h as follows:
.nf
.ta .5i +1i +1i
.sp .2
typedef struct {
.sp .2
	size_t	size;	/* size of data */
	char	*data	/* pointer to data */
.sp .2
} Pdata;
.fi
.IP
.SS Execution
When the structure is traversed, the \s-2CELL ARRAY 3 PLUS\s+2 element
draws the transformed boundaries of the cell parallelogram, using the
polyline attributes currently in effect. This is the minimal simulation
for \s-2CELL ARRAY 3 PLUS\s+2.
.SS Attributes Applied
The attributes listed below are used to display the
\s-2CELL ARRAY 3 PLUS\s+2 primitive when the structure is traversed. 
The Aspect Source Flags (\s-2ASF\s+2s) tell where to access the 
output display attributes.
These attributes can come directly from the traversal state list,
or they can be accessed indirectly, using the appropriate index
in the traversal state list and the corresponding bundled
representation in the workstation state list.
.RS
.nf
.ta .5i +\w'back interior reflectance equation   'u
.sp
polyline colour			polyline colour index \s-2ASF\s+2
linewidth scale factor		linewidth scale factor \s-2ASF\s+2
linetype 			linetype \s-2ASF\s+2
polyline shading method		polyline shading method \s-2ASF\s+2
polyline index
depth cue index
name set
.fi
.RE
.IP
.sp .2
.SH ERRORS
.IP 005
Ignoring function, function requires state
(\s-2PHOP\s+2, \s-2*\s+2, \s-2STOP\s+2, \s-2*\s+2)
.IP 117
Iqnoring function, one of the dimensions of the colour index array
is less than zero
.IP
.SH SEE ALSO
.nf
.IP
.ta 0.5i
.SM "CELL ARRAY 3 (3P)"
.fi