.\"##
.\" $XConsortium: p124,v 5.2 94/04/17 20:55:51 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 DISPLAY UPDATE STATE" 3P "29 February 1991"
.SH NAME
INQUIRE DISPLAY UPDATE STATE \- inquire the current display update state
.IX "Simulations" "INQUIRE DISPLAY UPDATE STATE"
.IX "Quick Update Methods" "INQUIRE DISPLAY UPDATE STATE"
.SH SYNOPSIS
.SS C Syntax
.ft B
.ta 1.25i 3i
.nf
void
pinq_disp_upd_st ( ws, error_ind, def_mode, mod_mode, display_empty, state )
Pint	ws;	\fIworkstation identifier\fP
Pint	*error_ind;	\fI\s-2OUT\s+2 error indicator\fP
Pdefer_mode	*def_mode;	\fI\s-2OUT\s+2 deferral mode\fP
Pmod_mode	*mod_mode;	\fI\s-2OUT\s+2 modification mode\fP
Pdisp_surf_empty	*disp_empty;	\fI\s-2OUT\s+2 display surface empty\fP
Pvisual_st	*state;	\fI\s-2OUT\s+2 state of visual representation\fP
.fi
.ft R
.SS Required PHIGS Operating States
(PHOP, WSOP, *, *)
.SH DESCRIPTION
.SS Purpose
.LP
Use
.SM INQUIRE DISPLAY UPDATE STATE
to determine the current
display update state
from a specified workstation's state list.
.LP
The deferral mode and modification mode were set by the application.
The display surface empty and state of visual representation state list values
are maintained by
.SM PHIGS.
.SS C Input Parameters
.IP \fIws\fP
The \fIworkstation identifier\fP of the workstation whose state list is queried.
.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 \fIdef_mode\fP
A pointer to a location in which the system returns the current deferral mode.
Possible values for Pdefer_mode are defined in phigs.h as follows:
.sp .3
.ta \w'PDEFER_ASAP     'u
PDEFER_ASAP		Make the display visually correct
\(em \fIAs Soon As Possible\fP
.sp .1
PDEFER_BNIG		Make the display visually correct
\(em \fIBefore the Next Interaction Globally\fP
.sp .1
PDEFER_BNIL		Make the display visually correct
\(em \fIBefore the Next Interaction Locally\fP
.sp .1
PDEFER_ASTI		Make the display visually correct
\(em \fIAt Some Time\fP
.sp .1
PDEFER_WAIT		Make the display visually correct
\(em \fIWhen the Application Requests It\fP
.IP \fImod_mode\fP
A pointer to a location in which the system returns the current modification mode.
Possible values for Pmod_mode are defined in phigs.h as follows:
.sp .3
.ta \w'PMODE_UQUM     'u
PMODE_NIVE		\fINo Immediate Visual Effects\fP
.sp .1
PMODE_UWOR	\fIUpdate Without Regeneration\fP
.sp .1
PMODE_UQUM	\fIUse Quick Update Methods\fP
.IP \fIdisplay_empty\fP
A pointer to a location in which the system returns the current
display surface empty status.  Possible values for
Pdisp_surf_empty are:
.nf
.ta \w'PSURF_NOT_EMPTY      'u
PSURF_EMPTY	\fIEmpty\fP
PSURF_NOT_EMPTY	\fINot Empty\fP
.fi
.IP \fIstate\fP
A pointer to a location in which the system returns the current
state of visual representation.  Possible values for Pvisual_st are:
.nf
.ta \w'PVISUAL_ST_SIMULATED    'u
PVISUAL_ST_CORRECT	\fICorrect\fP
PVISUAL_ST_DEFER	\fIDeferred\fP
PVISUAL_ST_SIMULATED	\fISimulated\fP
.fi
.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 DISPLAY UPDATE STATE (3P)"
.SM "INQUIRE DEFAULT DISPLAY UPDATE STATE (3P)"
.fi
