INQUIRE PREDEFINED LIGHT SOURCE REPRESENTATION(3P+) — Kubota Pacfic Computer Inc. (29 February 1991)

NAME

INQUIRE PREDEFINED LIGHT SOURCE REPRESENTATION − inquire a predefined light source representation

SYNOPSIS

C Syntax

void
pinq_pred_light_src_rep ( type, index, error_ind, bundle )
Pinttype;workstation type
Pintindex;predefined index
Pint∗error_ind;OUT error indicator
Plight_src_bundle∗bundle; OUT predefined light source rep

Required PHIGS Operating States

(PHOP, ∗, ∗, ∗)

DESCRIPTION

Purpose

INQUIRE PREDEFINED LIGHT SOURCE REPRESENTATION returns the attribute values of a specified predefined entry in the light source bundle table of a workstation type’s workstation description table. See SET LIGHT SOURCE REPRESENTATION for a full description of the contents of the bundle table entry and a description of the extended light source bundle table.

C Input Parameters

typeThe workstation type.

indexIndex of the predefined entry to be returned.

C Output Parameters

error_ind
A pointer to the location to store the error number of any error detected by this function.

bundleA pointer to the location in which to return the light source representation. The Plight_src_bundle data structure contains values needed to define the specified type of light source representation. Plight_src_bundle is defined as:

typedef struct {
Pinttype;/∗ light source type ∗/
Plight_src_recrec;/∗ light source data record ∗/
} Plight_src_bundle;

Plight_src_rec is defined as:

typedef union {
Pamb_light_src_recambient;
Pdir_light_src_recdirectional;
Ppos_light_src_recpositional;
Pspot_light_src_recspot;
} Plight_src_rec;

Pamb_light_src_rec is defined as:

typedef struct {
Pgcolrcolr;/∗ light source colour ∗/
} Pamb_light_src_rec;

Pdir_light_src_rec is defined as:

typedef struct {
Pgcolrcolr;/∗ light source colour ∗/
Pvec3dir;/∗ light source direction ∗/
} Pdir_light_src_rec;

Ppos_light_src_rec is defined as:

typedef struct {
Pgcolrcolr;/∗ light source colour ∗/
Ppoint3pos;/∗ light source position ∗/
Pfloatcoef[2];/∗ attenuation coefficients ∗/
} Ppos_light_src_rec;

Pspot_light_src_rec is defined as:

typedef struct {
Pgcolrcolr;/∗ light source colour ∗/
Ppoint3pos;/∗ light source position ∗/
Pvec3dir;/∗ light source direction ∗/
Pfloatexp;/∗ concentration exponent ∗/
Pfloatcoef[2];/∗ attenuation coefficients ∗/
Pfloatangle;/∗ spread angle ∗/
} Pspot_light_src_rec;

Pgcolr is defined as:

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

Pvec3 is defined as:

typedef struct {
Pfloatdelta_x;/∗ x magnitude ∗/
Pfloatdelta_y;/∗ y magnitude ∗/
Pfloatdelta_z;/∗ z magnitude ∗/
} Pvec3;

Ppoint3 is defined as:

typedef struct {
Pfloatx;/∗ x coordinate ∗/
Pfloaty;/∗ y coordinate ∗/
Pfloatz;/∗ z coordinate ∗/
} Ppoint3;

Execution

If the inquired information is available, the error indicator is returned as zero and values are returned in the output parameters.

See SET LIGHT SOURCE REPRESENTATION for the defined data record formats that may be returned in the data record parameter.

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.

Since this is an inquiry function, ERROR HANDLING is not invoked when an error is detected by this function.

ERRORS

002Ignoring function, function requires state (PHOP,∗,∗,∗)

051Ignoring function, this information unavailable for this workstation type

052Ignoring function, workstation type not recognized by the implementation

059Ignoring function, the specified workstation does not have output capability (i.e., the workstation category is neither OUTPUT, OUTIN, nor MO)

062Ignoring function, this information is not available for this MO workstation type

102Ignoring function, specified representation has not been predefined on this workstation

614Ignoring function, the general interior index is less than one

Museum