.\"##
.\" $XConsortium: p167,v 5.2 94/04/17 20:56:22 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 "INQUIRE MODELLING CLIPPING FACILITIES" 3P "29 February 1991"
.SH NAME
INQUIRE MODELLING CLIPPING FACILITIES \- inquire number of modelling clipping planes and operators available
.IX "Modelling Clipping" "INQUIRE MODELLING CLIPPING FACILITIES"
.SH SYNOPSIS
.SS C Syntax
.ft B
.ta 1.25i 3i
.nf
void
pinq_model_clip_facs ( length, start, error_ind, num, ops, total_length )
Pint	length;	\fIlength of application list\fP
Pint	start;	\fIstarting position\fP
Pint	*error_ind;	\fIOUT error indicator\fP
Pint	*num;	\fIOUT number of distinct planes in modelling clipping volume\fP
Pint_list	*ops;	\fIOUT list of operators\fP
Pint	*total_length;	\fIOUT length of list in PHIGS\fP
.fi
.ft R
.SS Required PHIGS Operating States
(PHOP, *, *, *)
.SH DESCRIPTION
.SS Purpose
\s-2INQUIRE MODELLING CLIPPING FACILITIES\s+2 obtains the number
of planes and available operators
that may be used to determine the modelling clipping volume in the
\s-2PHIGS\s+2
implementation.
.SS C Input Parameters
.IP \fIlength\fP
Number of items for which the application has allocated memory
in the output parameter \fIops\fP.
0 can be specified, in order to get the \fItotal length\fP of the list
of operators.
.IP \fIstart\fP
Starting position in the list of operators at which to begin the inquiry.
.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 \fInum\fP
A pointer to a location in which the system return the number of distinct
planes (half-spaces) that can be used
to determine the modelling clipping volume.
.IP \fIops\fP
A pointer to a \fIPint_list\fP
in which the system returns the portion of the
list of supported modelling clipping operators,
starting at the entry specified with \fIstart\fP.
.IP
Pint_list is defined in phigs.h as follows:
.nf
.ta .5i +\w'Pint   'u +\w'num_ints;    'u
.sp .3
typedef struct {
.sp .2
	Pint   num_ints;		/* number of Pints in list */
	Pint   *ints;		/* list of integers */
.fi
.sp .2
} Pint_list;
.sp .5
The pointer \fIops\fR\(->\fIints\fR must be initialized to an array of
\fIlength\fP \fIPint\fP elements.
.IP \fItotal_length\fP
A pointer to an integer in which to return the \fItotal length\fP of
the list of supported operators.
This is the value required for \fIlength\fP if all the items in the
list are to be returned.
.SH ERRORS
.IP 002
Ignoring function, function requires state 
(\s-2PHOP\s+2, \s-2*\s+2, \s-2*\s+2, \s-2*\s+2)
.SH SEE ALSO
.nf
.IP
.ta 0.5i
.SM "PHIGS DESCRIPTION TABLE (7P)"
.SM "SET MODELLING CLIPPING INDICATOR (3P)"
.SM "SET MODELLING CLIPPING VOLUME (3P)"