.\"##
.\" $XConsortium: p156,v 5.2 94/04/17 20:56:16 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.
.ds f \s-2INQUIRE LIST OF DEPTH CUE INDICES\s+2
.TH "INQUIRE LIST OF DEPTH CUE INDICES" 3P+ "29 February 1991"
.SH NAME
INQUIRE LIST OF DEPTH CUE INDICES \- inquire the list of depth cue indices defined
on a workstation
.IX "Depth Cueing" "INQUIRE LIST OF DEPTH CUE INDICES"
.IX "Inquiry functions" "INQUIRE LIST OF DEPTH CUE INDICES"
.IX "PHIGS Extension Functions" "INQUIRE LIST OF DEPTH CUE INDICES"
.SH SYNOPSIS
.SS C Syntax
.ft B
.ta 1.25i 3i
.nf
void 
pinq_list_dcue_inds ( ws, length, start, error_ind, indices, total_length )
Pint	ws;	\fIworkstation identifier\fP
Pint	length;	\fIlength of application list\fP
Pint	start;	\fIstarting position\fP
Pint	*error_ind;	\fIOUT error indicator\fP
Pint_list	*indices;	\fIOUT list of polyline indices\fP
Pint	*total_length;	\fIOUT length of list in PHIGS\fP
.fi
.ft R
.SS Required PHIGS Operating States
(PHOP, WSOP, *, *)
.SH DESCRIPTION
.SS Purpose
.LP
\s-2INQUIRE LIST OF DEPTH CUE INDICES\s+2
obtains a list of the currently defined workstation depth cue indices.
Objects are depth cued toward a specified depth cue colour. Depth cueing
applies to all primitives. 
.SS C Input Parameters
.IP \fIws\fP
The workstation identifier.
.IP \fIlength\fP
The number of \fIints\fR in the \fIindices\fR output parameter for which the 
application has allocated memory. \fIlength\fR is the number of list elements
that the system can return in \fIindices\(->ints\fR.
If a value of 0 is used here, no data will be returned in the \fIindices\(->ints\fR
list, but the total number of elements will be returned in \fItotal_length\fR.
.IP \fIstart\fP
Starting position of inquiry.  The elements in the list, beginning
with the item number specified by \fIstart\fR, are copied sequentially into 
\fIindices\(->ints\fR until \fIindices\(->ints\fR is full
or all the elements have been copied.
.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 \fIindices\fP
A pointer to a Pint_list data structure containing the list of
depth cue indices.
A Pint_list structure is defined as:
.nf
.ta .5i +\w'Pint     'u +\w'num_ints;     'u
.sp .4
typedef struct {
.sp .2
	Pint	num_ints;	/* number of Pints in list */
	Pint	*ints;	/* list of integers */
.sp .2
} Pint_list;
.fi
.IP
The \fInum_ints\fR component specifies the number of elements in the list.
The \fIints\fR component is a pointer to a list \fInum_ints\fR long.
.IP
The application must allocate memory for \fIlength\fR elements in the
list of \fIints\fR.
.IP \fItotal_length\fP
A pointer to an integer in which the system returns the total number of elements
in the list.  This is the value required for \fIlength\fR if all elements in the
list are to be returned.
.SS Execution
If the inquired information is available, the error indicator is returned
as zero and values are returned in the output parameters.
.LP
If the inquired information is not available, the values returned in the
output parameters are undefined and the error indicator
is set to one of the following error numbers to indicate the reason
for nonavailability.
.LP
Since this is an inquiry function, \s-2ERROR HANDLING\s+2 is not 
invoked when an error is detected by this function.
.RE
.SH ERRORS
.IP 003
Ignoring function, function requires state (\s-2PHOP,WSOP,*,*\s+2)
.IP 054
Ignoring function, the specified workstation is not open
.IP 059
Ignoring function, the specified workstation does not have output
capability (that is, the workstation category is neither \s-2OUTPUT\s+2,
\s-2OUTIN\s+2, nor \s-2MO\s+2)
.SH SEE ALSO
.nf
.IP
.ta 0.5i
.SM "SET DEPTH CUE REPRESENTATION (3P+)"
.SM "SET DEPTH CUE INDEX (3P+)"
.SM "INQUIRE DEPTH CUE REPRESENTATION (3P+)"
.fi
