.\"##
.\" $XConsortium: p297,v 5.2 94/04/17 20:57:53 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.
.ds f \s-2SET COLOUR MAPPING INDEX\s+2
.TH "SET COLOUR MAPPING INDEX" 3P+ "29 February 1991"
.SH NAME
SET COLOUR MAPPING INDEX \- create a structure element to set the colour
mapping index
.IX "Special Attributes" "SET COLOUR MAPPING INDEX"
.IX "Attributes, Special Attributes" "SET COLOUR MAPPING INDEX"
.IX "Colour Mapping" "SET COLOUR MAPPING INDEX"
.IX "PHIGS Extension Functions" "SET COLOUR MAPPING INDEX"
.SH SYNOPSIS
.SS C Syntax
.ft B
.ta 1.25i 3i
.nf
void
pset_colr_map_ind ( index )
Pint	index;	\fIcolour mapping index\fP
.fi
.ft R
.SS Required PHIGS Operating States
(PHOP, *, STOP, *)
.SH DESCRIPTION
.SS Purpose
\s-2SET COLOUR MAPPING INDEX\s+2
creates an element in the currently open structure containing a
colour mapping index. The index number corresponds to an entry
in the table of defined colour mapping representations in the
workstation state list.
.SS C Input Parameter
.IP \fIindex\fR
This is an index to the workstation colour mapping bundle table.
.SS Execution
Depending on the edit mode, a \s-2SET COLOUR MAPPING INDEX\s+2
element with a value colour mapping index is inserted into the open
structure after the element pointer or replaces the element pointed
to by the element pointer. The element pointer is then updated to point
to this \s-2SET COLOUR MAPPING INDEX\s+2 element.
.LP
When a \s-2SET COLOUR MAPPING INDEX\s+2 structure element is traversed, 
the current colour mapping index value 
in the \s-2PHIGS\s0 Extension traversal state list is set to 
index. This value indexes a colour mapping representation in the 
table of defined colour mapping operations stored in the workstation state list.
If the entry corresponding to the specified index
is not defined, then an entry of zero is substituted in the index.
.LP
The current colour mapping index determines the colour mapping operation that
will be applied to all primitives subsequently displayed.
.sp .2
.SH ERRORS
.IP 005
Ignoring function, function requires state (\s-2PHOP,*,STOP,*\s+2)
.IP 121
Ignoring function, the colour mapping index is less than 0.
.SH SEE ALSO
.nf
.IP
.ta 0.5i
.SM "SET COLOUR MAPPING REPRESENTATION (3P+)"
.SM "INQUIRE LIST OF COLOUR MAPPING INDICES (3P+)"
.fi
