GINO Graphics Suite - GINO v9.0  

gEnqHLS

Syntax

[C/C++:]
void gEnqHLS(int col, GHLSSTY *hls);
[F90:]
subroutine gEnqHLS(col, hls)

integer, intent(in) :: col
type (GHLSSTY), intent(out) :: hls

Arguments

col
Colour index

< 0, Dummy definition
= GBACKGROUND, Background colour
> 0, Index up to device capability

hls
Hue, lightness and saturation values

Description

The routine gEnqHLS() returns the hue, lightness and saturation values identified by col. The colour may have been defined by a routine other than gDefineHLS(), in which case the colour coordinates are converted to HLS. If col is less than zero, the colour values returned are those last specified by any of the colour definition routines.

The default values are returned by gEnqHLS() until the colour identified by col is redefined by any call to the colour definition routines.

The default values correspond to as many of the standard GINO colours as the device can implement. For plotters and other devices that do not cater for variable colours or if col is out of range for the device, gEnqHLS() returns hls.hue, hls.light and hls.sat set to zero.

See Also

gEnqHLS Usage
gDefineHLS
gDefineHSV
gDefineRGB