SET TEXT COLOUR(3P+) — MISC. REFERENCE MANUAL PAGES

NAME

SET TEXT COLOUR − create a structure element to set the text colour attribute

SYNOPSIS

C Syntax

void
psettextcolour ( colour )
Pgcolr∗colour;text colour

FORTRAN Syntax

SUBROUTINE pstxco ( COLMOD, ICOLR, COLR )
INTEGERCOLMODcolour model
INTEGERICOLRcolour table index
REALCOLR(3)colour triple

Required PHIGS Operating States

(PHOP, ∗, STOP, ∗)

DESCRIPTION

Purpose

SET TEXT COLOUR creates a structure element to set the text colour attribute.

When the current interior shading method Aspect Source Flag ASF is set to INDIVIDUAL, the current value of this attribute applies to the following output primitives:

• TEXT

• TEXT 3

• ANNOTATION TEXT RELATIVE

• ANNOTATION TEXT RELATIVE 3

This is a SunPHIGS Extension function based on PHIGS+ and is not part of the PHIGS standard.

C Input Parameters

All of the following data types are predefined in phigs.h.

colourText colour. Pgcolr is defined as:

typedef struct {
Pint type;/∗ indirect, RGB, CIE, HSV, HLS ∗/
union {
   Pintindex;/∗ colour table index ∗/
   struct {
Pfloatx;/∗ red, hue, etc. ∗/
Pfloaty;/∗ green, saturation, lightness, etc. ∗/
Pfloatz;/∗ blue, value, saturation, etc. ∗/
   } general;
} val;
} Pgcolr;

FORTRAN Input Parameters

All of the following data types are predefined in phigs77.h.

COLMOD
The colour model. The predefined values are:

0PINDIRColour Index Specified
1PRGBRed, Green, and Blue
2PCIECIE Colour Model
3PHSVHue, Saturation, and Value
4PHLSHue, Lightness, and Saturation

ICOLR
An integer index into the workstation colour table for determining the text colour. This value is only used if COLMOD is equal to PINDIR.

COLR(3)
An array of reals containing the text colour. This array is unused if COLMOD is equal to PINDIR.

COLR(1) = Red, Hue, etc.
COLR(2) = Green, Saturation, Lightness, etc.
COLR(3) = Blue, Value, Saturation, etc.

Execution

Depending on the edit mode, a SET TEXT COLOUR element with the value text colour in the specified colour model is inserted into the open structure after the element pointer or replaces the element pointed at by the element pointer. The element pointer is then updated to point to this SET TEXT COLOUR element.

When the current text colour ASF is set to INDIVIDUAL, text output primitives which follow in the structure network are drawn using the current text colour.

When the current text colour ASF is set to BUNDLED, the text colour is taken from the workstation extended representation indicated by the current text index. In this case, the text colour set with SET TEXT COLOUR has no effect.

The standard PHIGS function SET TEXT COLOUR INDEX is equivalent to calling to SET TEXT COLOUR with type INDIRECT.

ERRORS

005Ignoring function, function requires state (PHOP, ∗, STOP, ∗)

Museum