.\"
.\" $XConsortium: p141,v 5.3 94/04/17 20:56:04 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 HLHSR MODE" 3P "29 February 1991"
.SH NAME
INQUIRE HLHSR MODE \- inquire a workstation's hidden line/hidden surface removal mode
.IX "HLHSR" "INQUIRE HLHSR MODE"
.IX "Z-buffering" "INQUIRE HLHSR MODE"
.IX "Hidden Line/Hidden Surface Removal" "INQUIRE HLHSR MODE"
.SH SYNOPSIS
.SS C Syntax
.ft B
.ta 1.25i 3i
.nf
void
pinq_hlhsr_mode ( ws, error_ind, state, cur_mode, req_mode )
Pint	ws;	\fIworkstation identifier\fP
Pint	*error_ind;	\fI\s-2OUT\s+2 error indicator\fP
Pupd_st	*state;	\fI\s-2OUT HLHSR\s+2 update state\fP
Pint	*cur_mode;	\fI\s-2OUT\s+2 current \s-2HLHSR\s+2 mode\fP
Pint	*req_mode;	\fI\s-2OUT\s+2 requested \s-2HLHSR\s+2 mode\fP
.fi
.ft R
.SS Required PHIGS Operating States
(PHOP, WSOP, *, *)
.SH DESCRIPTION
.SS Purpose
Use \s-2INQUIRE HLHSR MODE\s+2 to determine the current
\s-2HLHSR\s+2 (hidden line and hidden surface removal) mode
from a specified PHIGS workstation state list.
.LP
.SS C Input Parameters
.IP \fIws\fP
The \fIworkstation identifier\fP of the workstation whose workstation state list
is queried.
.SS C Output Parameters
.IP \fIerr_ind\fP
A pointer to the location to store the error number of any error
detected by this function.
.IP \fIstate\fP
A pointer to a location in which the system returns the
\fI\s-2HLHSR\s+2 update state\fP.  Pupd_st is one of the values
\s-2PUPD_NOT_PEND\s+2 (\fINot Pending\fP) or \s-2PUPD_PEND\s+2 (\fIPending\fP).
.IP \fIcur_mode\fP
A pointer to a location in which the system returns the current
\fI\s-2HLHSR\s+2 mode\fP.
.IP \fIreq_mode\fP
A pointer to a location in which the system returns the \fIrequested
\s-2HLHSR\s+2 mode\fP. The requested mode can differ from the current mode
if the update state is
.SM PENDING.
.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 057
Ignoring function, specified workstation is of category \s-2MI\s+2
.SH SEE ALSO
.nf
.IP
.ta 0.5i
.SM "SET HLHSR MODE (3P)"
.SM "SET HLHSR IDENTIFIER (3P)"
.SM "INQUIRE HLHSR FACILITIES (3P)"
.fi
