.\"
.\" $XConsortium: p046,v 5.3 94/04/17 20:54:46 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.
.\" "@(#)escape_-3.3 1.15 90/02/24 Copyr 1988 Sun Micro"
.ds f \s-2ESCAPE -3\s+2
.ds e \s-2ESCAPE\s+2
.ds s Sun\s-2PHIGS\s+2
.TH "ESCAPE -3" 3P "29 February 1991"
.SH NAME
ESCAPE -3 \- disable or enable \s-2PHIGS\s+2 \s-2DC\s+2 bounds checking
.SH SYNOPSIS
.SS C Syntax
.ft B
.ta 1.25i 3i
.nf
void
pescape ( func_id, in, store, out )
Pint	func_id;	\fIescape function identifier\fP
Pescape_in_data	*in;	\fIinput data for the function\fP
Pstore	store;	\fInot used\fP
Pescape_out_data	**out;	\fIOUT not used\fP
.fi
.ft R
.SS Required PHIGS Operating States
(PHOP, *, *, *)
.SH DESCRIPTION
.SS Purpose
\*f
disables or enables Device Coordinate \s-2(DC)\s+2 bounds checking by
\s-2PHIGS\s+2 functions with \s-2DC\s+2 input parameters (such as
\s-2SET WORKSTATION VIEWPORT\s+2 and the input device initialization
functions).
.SS C Input Parameters
.IP \fIfunc_id\fP
The function identifier for this escape is \s-2PUESC_IGNORE_DC_ERRORS\s+2,
which is defined in phigs.h to be -3.
.IP \fIin\fP
A pointer to a Pescape_in_data union, which contains the escape_in_u3 member
used by this escape function.
This member is defined in phigs.h as:
.nf
.ta .5i +.5i +1.25i
.sp .4
struct {
.sp .2
	Pint	ignore_DC_errors;	/* ignore errors if non-zero */
.sp .2
} escape_in_u3;
.fi
.IP
\fIignore_DC_errors\fP
indicates if \s-2DC\s+2 bounds checking is enabled (0, the default) or
disabled (non-zero).
.IP \fIstore\fP
Not used.
.SS C Output Parameters
.IP \fIout\fP
There is no output data record for this escape.
.SS Execution
This escape disables or enables bounds checking of \s-2DC\s+2
parameters specifed to \s-2PHIGS\s+2 functions.
A number of \s-2PHIGS\s+2 workstation functions have \s-2DC\s+2 values as
parameters.
Normally these values are checked against the current \s-2DC\s+2 size of the
workstation when the function is called, and an error is reported if any
of the values lie outside the current limits.
The function then returns without performing the desired operation.
This escape is used to override that behavior by indicating that \s-2DC\s+2 values
outside the current workstation limits should be accepted.
This allows such \s-2DC\s+2 values to be entered into the workstation state list
and used in subsequent \s-2PHIGS\s+2 operations.
The use of these values in not defined by the \s-2PHIGS\s+2 standard, but
\s-2PHIGS\s+2 will use them as it would values that are within range.
This may produce results that do not conform to the \s-2PHIGS\s+2 standard.
It is the application's responsibility to ensure that the results of
\s-2PHIGS'\s+2 use of these out-of-range values is meaningful.
.SH ERRORS
.IP 003
Ignoring function, function requires state (PHOP, WSOP, *, *)
.SH SEE ALSO
.nf
.IP
.ta 0.5i
.SM "ESCAPE (3P)"
.fi