.\"##
.\" $XConsortium: p095,v 5.2 94/04/17 20:55:26 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 MAPPING METHOD FACILITIES" 3P+ "29 February 1991"
.SH NAME
INQUIRE COLOUR MAPPING METHOD FACILITIES \- inquire the available colour
mapping facilities specific to a colour mapping method.
.IX "Colour" "INQUIRE COLOUR MAPPING METHOD FACILITIES"
.SH SYNOPSIS
.SS C Syntax
.ft B
.ta 1.25i 3i
.nf
void
pinq_colr_map_method_facs ( type, map_method, error_ind, map_st )
Pwstype	type;	\fIworkstation type\fP
Pint	map_method;	\fI mapping method \fP
Pint	*error_ind;	\fI\s-2OUT\s+2 error indicator\fP
Pcolr_map_st	*map_st;	\fIOUT method-specific facilities\fP
.fi
.ft R
.SS Required PHIGS Operating States
(PHOP, *, *, *)
.SH DESCRIPTION
.SS Purpose
Use \s-2INQUIRE COLOUR MAPPING METHOD FACILITIES\s+2 to obtain the
available colour mapping facilities specific to a specified colour mapping
method.
.SS C Input Parameters
.IP \fItype\fP
The workstation type for which to get the colour mapping method facilities.
.IP \fImap_method\fR
The colour mapping method of interest.
The colour mapping methods defined in phigs.h are as follows:
.nf
.ta .5i +.5i
	1	PCOLR_MAP_TRUE
	2	PCOLR_MAP_PSUEDO
	3	PCOLR_MAP_PSEUDO_N
.fi
.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 \fImap_st\fP
A pointer to a Pcolr_map_st structure
in which to store the information.
Pcolr_map_st is defined in phigs.h as:
.ta .5i +1i +1i
.nf
.sp .2
typedef union {
.sp .2
	Pint	int_data;	\fIfor map_method 1 and 2\fR
.sp .2
} Pcolr_map_st;
.sp .2
.fi
.IP
For colour mapping method \s-2PCOLR_MAP_TRUE\s+2, \fIint_data\fP will contain the
number of available true colours.
For colour mapping method \s-2PCOLR_MAP_PSEUDO\s+2, \fIint_data\fP will contain the
maximum number of available pseudo colour entries.
There is no information returned for colour mapping method \s-2PCOLR_MAP_PSEUDO_N\s+2.
.SS Execution
If the inquired information is available, the error indicator is
returned as zero and the requested information is returned.
.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.
.SH ERRORS
.IP 002
Ignoring function, function requires state (\s-2PHOP, *, *, *\s+2)
.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 052
Ignoring function, workstation type not recognized by the implementation
.IP 059
Ignoring function, the specified workstation does not have
output capability (that is, the workstation category is neither 
\s-2OUTPUT\s+2 nor \s-2OUTIN\s+2)
.IP 062
Ignoring function, this information is not available for this
\s-2MO\s+2 workstation type
.IP 126
Ignoring function, the specified colour mapping method is not
available on the specified workstation.
.SH SEE ALSO
.nf
.IP
.ta 0.5i
.SM "INQUIRE COLOUR MAPPING FACILITIES (3P+)"
.SM "PHIGS WORKSTATION DESCRIPTION TABLE (7P)"
.fi
