summaryrefslogtreecommitdiff
path: root/xc/unsupported/doc/PHIGS/man3/p104
blob: 75b827eee16d8e14954f0b7587b068e83f6b8f4c (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
.\"
.\" $XConsortium: p104,v 5.3 94/04/17 20:55:33 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 "INQUIRE CURRENT ELEMENT TYPE AND SIZE" 3P "29 February 1991"
.SH NAME
INQUIRE CURRENT ELEMENT TYPE AND SIZE \- inquire the type and size of the current element
.SH SYNOPSIS
.SS C Syntax
.ft B
.ta 1.25i 2.75i
.nf
void
pinq_cur_elem_type_size ( error_ind, type, size )
Pint	*error_ind;	\fI\s-2OUT\s+2 error indicator\fP
Pelem_type	*type;	\fI\s-2OUT\s+2 element type\fP
size_t	*size;	\fI\s-2OUT\s+2 element size\fP
.fi
.ft R
.SS Required PHIGS Operating States
(PHOP, *, STOP, *)
.SH DESCRIPTION
.SS Purpose
\s-2INQUIRE CURRENT ELEMENT TYPE AND SIZE\s+2
returns the type and size of the current element.
.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 \fItype\fP
Returns the type of the current element.
For example, a polyline primitive element would be returned as 
\s-2PELEM_POLYLINE\s+2, a character height attribute as 
\s-2PEL_CHARACTER_HEIGHT\s+2,
a modelling transformation as \s-2PEL_LOCAL_MODELLING_TRANSFORMATION3\s+2, 
and so forth.
The Pelem_type enumerated type is defined in phigs.h as follows:
.nf
.ta .5i
.sp .4
typedef enum {
.sp .2
	PELEM_ALL,
	PELEM_NIL,
	PELEM_POLYLINE3,
	PELEM_POLYLINE,
	PELEM_POLYMARKER3,
	PELEM_POLYMARKER,
	PELEM_TEXT3,
	PELEM_TEXT,
	PELEM_ANNO_TEXT_REL3,
	PELEM_ANNO_TEXT_REL,
	PELEM_FILL_AREA3,
	PELEM_FILL_AREA,
	PELEM_FILL_AREA_SET3,
	PELEM_FILL_AREA_SET,
	PELEM_CELL_ARRAY3,
	PELEM_CELL_ARRAY,
	PELEM_GDP3,
	PELEM_GDP,
	PELEM_LINE_IND,
	PELEM_MARKER_IND,
	PELEM_TEXT_IND,
	PELEM_INT_IND,
	PELEM_EDGE_IND,
	PELEM_LINETYPE,
	PELEM_LINEWIDTH,
	PELEM_LINE_COLR_IND,
	PELEM_MARKER_TYPE,
	PELEM_MARKER_SIZE,
	PELEM_MARKER_COLR_IND,
	PELEM_TEXT_FONT,
	PELEM_TEXT_PREC,
	PELEM_CHAR_EXPAN,
	PELEM_CHAR_SPACE,
	PELEM_TEXT_COLR_IND,
	PELEM_CHAR_HT,
	PELEM_CHAR_UP_VEC,
	PELEM_TEXT_PATH,
	PELEM_TEXT_ALIGN,
	PELEM_ANNO_CHAR_HT,
	PELEM_ANNO_CHAR_UP_VEC,
	PELEM_ANNO_PATH,
	PELEM_ANNO_ALIGN,
	PELEM_ANNO_STYLE,
	PELEM_INT_STYLE,
	PELEM_INT_STYLE_IND,
	PELEM_INT_COLR_IND,
	PELEM_EDGE_FLAG,
	PELEM_EDGETYPE,
	PELEM_EDGEWIDTH,
	PELEM_EDGE_COLR_IND,
	PELEM_PAT_SIZE,
	PELEM_PAT_REF_POINT_VECS,
	PELEM_PAT_REF_POINT,
	PELEM_ADD_NAMES_SET,
	PELEM_REMOVE_NAMES_SET,
	PELEM_INDIV_ASF,
	PELEM_HLHSR_ID,
	PELEM_LOCAL_MODEL_TRAN3,
	PELEM_LOCAL_MODEL_TRAN,
	PELEM_GLOBAL_MODEL_TRAN3,
	PELEM_GLOBAL_MODEL_TRAN,
	PELEM_MODEL_CLIP_VOL3,
	PELEM_MODEL_CLIP_VOL,
	PELEM_MODEL_CLIP_IND,
	PELEM_RESTORE_MODEL_CLIP_VOL,
	PELEM_VIEW_IND,
	PELEM_EXEC_STRUCT,
	PELEM_LABEL,
	PELEM_APPL_DATA,
	PELEM_GSE,
	PELEM_PICK_ID,
	PELEM_POLYLINE_SET3_DATA,
	PELEM_FILL_AREA_SET3_DATA,
	PELEM_TRI_STRIP3_DATA,
	PELEM_QUAD_MESH3_DATA,
	PELEM_SET_OF_FILL_AREA_SET3_DATA,
	PELEM_NUNI_BSP_CURVE,
	PELEM_NUNI_BSP_SURF,
	PELEM_CELL_ARRAY3_PLUS,
	PELEM_TEXT_COLR,
	PELEM_MARKER_COLR,
	PELEM_EDGE_COLR,
	PELEM_LINE_COLR,
	PELEM_CURVE_APPROX_CRIT,
	PELEM_LINE_SHAD_METH,
	PELEM_INT_COLR,
	PELEM_BACK_INT_COLR,
	PELEM_BACK_INT_STYLE,
	PELEM_BACK_INT_STYLE_IND,
	PELEM_REFL_PROPS,
	PELEM_BACK_REFL_PROPS,
	PELEM_INT_SHAD_METH,
	PELEM_BACK_INT_SHAD_METH,
	PELEM_INT_REFL_EQN,
	PELEM_BACK_INT_REFL_EQN,
	PELEM_SURF_APPROX_CRIT,
	PELEM_PARA_SURF_CHARACS,
	PELEM_FACE_DISTING_MODE,
	PELEM_FACE_CULL_MODE,
	PELEM_LIGHT_SRC_STATE,
	PELEM_DCUE_IND,
	PELEM_COLR_MAP_IND,
	PELEM_RENDERING_COLR_MODEL,
	PELEM_NUM_EL_TYPES
.sp .2
} Pelem_type;
.fi
.IP \fIsize\fP
Returns the size, in bytes, that the application will have to allocate
in order to call \s-2INQUIRE CURRENT ELEMENT CONTENT\s+2
to retrieve the contents of the current element.
If the current element type is such that it is not necessary to allocate any
dynamic memory to retrieve its contents, a value of zero is returned.
.SH ERRORS
.IP 005
Ignoring function, function requires state (\s-2PHOP, *, STOP, *\s+2)
.SH SEE ALSO
.nf
.IP
.ta 0.5i
.SM "INQUIRE CURRENT ELEMENT CONTENT (3P)"
.SM "INQUIRE ELEMENT POINTER (3P)"
.SM "ELEMENT SEARCH (3P)"
.SM "INQUIRE ELEMENT TYPE AND SIZE (3P)"
.fi