.\"##
.\" $XConsortium: p376,v 5.2 94/04/17 20:58:49 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.
.\" 1. Substitute PHIGS Extension function name (in CAPS) for "PNAME" in line be.\"low:
.ds pN SET TEXT COLOUR
.TH "\*(pN" 3P+ "29 February 1991"
.SH NAME
\*(pN \-
create a structure element to set the text 
colour attribute
.IX "Colour" "SET TEXT COLOUR"
.IX "Text Attributes" "SET TEXT COLOUR"
.IX "Attributes, Text Attributes" "SET TEXT COLOUR"
.IX "PHIGS Extension Functions" "\*(pN"
.SH SYNOPSIS
.SS C Syntax
.ft B
.ta 1.25i 3i
.nf
.\" 6. Insert C syntax below
void
pset_text_colr ( colour )
Pgcolr	*colour;	\fItext colour\fP
.fi
.ft R
.SS Required PHIGS Operating States
(PHOP, *, STOP, *)
.SH DESCRIPTION
.SS Purpose
\s-2SET TEXT COLOUR\s+2 creates a structure element to set the text 
colour attribute.
.LP
When the current interior shading
method Aspect Source Flag 
(\s-2ASF\s+2) is set to \s-2INDIVIDUAL\s+2, the current value of
this attribute applies to the following output primitives:
.RS
.ta 0.2i +0.2i +0.2i +0.2i +0.2i +0.2i +0.2i +0.2i
.LP
\(bu
.SM "TEXT"
.LP
\(bu
.SM "TEXT 3"
.LP
\(bu
.SM "ANNOTATION TEXT RELATIVE"
.LP
\(bu
.SM "ANNOTATION TEXT RELATIVE 3"
.ta
.RE
.SS C Input Parameters
.IP \fIcolour\fP
Text colour. Pgcolr is defined as:
.ta .5i +\w'union  'u +\w'struct  'u +\w'Pfloat      'u +\w'index;    'u +w\'x;      'u
.nf
.sp .4
typedef struct {
.sp .2
	Pint		 type;		/* indirect, RGB, CIE, HSV, HLS */
	union {
	   Pint		ind;		/* colour table index */
	   struct {
		Pfloat		x;		/* red, hue, etc. */
		Pfloat		y;		/* green, saturation, lightness, etc. */
		Pfloat		z;		/* blue, value, saturation, etc. */
	   } general;
	} val;
} Pgcolr;
.fi
.SS Execution
Depending on the edit mode, a \s-2SET TEXT COLOUR\s+2 element with
the value text colour in the specified colour model is 
inserted into the open structure after the element pointer, or it replaces
the element pointed at by the element pointer. The element pointer
is then updated to point to this \s-2SET TEXT COLOUR\s+2 element.
.LP
When the current text colour \s-2ASF\s+2 is set to
\s-2INDIVIDUAL\s+2, text output primitives
that follow in
the structure network are drawn using the current
text colour.
.LP
When the current text colour \s-2ASF\s+2 is set to \s-2BUNDLED\s+2,
the text colour is taken from the
workstation extended representation indicated by the current text index.
In this case, the text colour
set with \s-2SET TEXT COLOUR\s+2 has no effect.
.LP
The standard \s-2PHIGS\s+2 function \s-2SET TEXT COLOUR INDEX\s+2
is equivalent to calling to \s-2SET TEXT COLOUR\s+2 with type
\s-2INDIRECT\s+2.
.sp .2
.SH ERRORS
.IP 005
Ignoring function, function requires state (\s-2PHOP, *, STOP, *\s+2)
.SH SEE ALSO
.nf
.IP
.ta 0.5i
.SM "COLOUR (7P)"
.SM "SET INDIVIDUAL ASF (3P)"
.SM "SET TEXT REPRESENTATION PLUS (3P+)"
.SM "SET TEXT COLOUR INDEX (3P)"
.fi
