.\"##
.\" $XConsortium: p093,v 5.2 94/04/17 20:55:24 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 COLOUR FACILITIES" 3P "29 February 1991"
.SH NAME
INQUIRE COLOUR FACILITIES \- inquire a workstation type's colour facilities
.IX "Colour" "INQUIRE COLOUR FACILITIES"
.SH SYNOPSIS
.SS C Syntax
.ft B
.ta 1.25i 3i
.nf
void
pinq_colr_facs ( type, error_ind, facilities )
Pint	type;	\fIworkstation type\fP
Pint	*error_ind;	\fI\s-2OUT\s+2 error indicator\fP
Pcolr_facs	*facilities;	\fI\s-2OUT\s+2 colour facilities\fP
.fi
.ft R
.SS Required PHIGS Operating States
(PHOP, *, *, *)
.SH DESCRIPTION
.SS Purpose
Use \s-2INQUIRE COLOUR FACILITIES\s+2 to obtain a description of
colour facilities for the specified type of workstation.
.SS C Input Parameter
.IP \fItype\fP
Get the colour facilities for this workstation type.
.LP
.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 \fIfacilities\fP
A pointer to the structure in which to store the information,
defined as:
.ta .5i +1i +1i
.nf
.sp .2
typedef struct {
.sp .2
	Pint	num_colrs;	/* number of colours */
	Pcolr_avail	colr_avail;	/* colour availability */
	Pint	num_pred_inds;	/* number of predefined bundles */
	Pcieluv	prim_colrs;	/* primary colours */
.sp .2
} Pcolr_facs;
.sp .2
.fi
.IP
\fIcolr_avail\fP returns the colour availability, one of the 
following enumeration values:
.sp
.ta .5i +\w'PAVAIL_MONOCHR     'u
.nf
	PAVAIL_COLR	\fIColour\fP
	PAVAIL_MONOCHR	\fIMonochrome\fP
.sp
.fi
.IP
\fInum_pred_inds\fP returns the number of predefined colour bundle indices.
.IP
\fIprim_colrs\fP returns the three primary colours
\s-2CIE\s+2 (\fICommission Internationale de l'Eclairage\fR's
universal colour definition system) chromaticity coefficients, defined as:
.ta .5i +1i +1i
.nf
.sp .2
typedef struct {
.sp .2
	Pfloat	cieluv_x;	/* x coefficient */
	Pfloat	cieluv_y;	/* y coefficient */
	Pfloat	cieluv_y_lum;	/* y luminance */
.sp .2
} Pcieluv;
.fi
.IP
The \fIz\fP primary chromaticity coefficients may be calculated by
1.0 \(mi \fIx\fP \(mi \fIy\fP.
.IP
\fBNote:\fR \s-2PEX-SI\s0 does not support the CIE colour model,
so 0.0 is returned for all the chromaticity coefficients.
.SH ERRORS
.IP 002
Ignoring function, function requires state (\s-2PHOP, *, *, *\s+2)
.IP 052
Ignoring function, workstation type not recognized by the implementation
.IP 051
Ignoring function, this information is not yet available
for this workstation type; open a workstation of this type
and use the specific workstation type
.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)
.IP 062
Ignoring function, this information is not available for this
\s-2MO\s+2 workstation type
.SH SEE ALSO
.nf
.IP
.ta 0.5i
.SM "INQUIRE WORKSTATION CONNECTION AND TYPE (3P)"
.SM "WORKSTATION TYPE SET (3P)"
.SM "INQUIRE PREDEFINED COLOUR REPRESENTATION (3P)"
.SM "PHIGS WORKSTATION DESCRIPTION TABLE (7P)"
.fi