INQUIRE LIST OF DEPTH CUE INDICES(3P+) — Kubota Pacfic Computer Inc. (29 February 1991)

NAME

INQUIRE LIST OF DEPTH CUE INDICES − inquire the list of depth cue indices defined on a workstation

SYNOPSIS

C Syntax

void
pinq_list_dcue_inds ( ws, length, start, error_ind, indices, total_length )
Pintws;workstation identifier
Pintlength;length of application list
Pintstart;starting position
Pint∗error_ind;OUT error indicator
Pint_list∗indices;OUT list of polyline indices
Pint∗total_length;OUT length of list in PHIGS

Required PHIGS Operating States

(PHOP, WSOP, ∗, ∗)

DESCRIPTION

Purpose

INQUIRE LIST OF DEPTH CUE INDICES obtains a list of the currently defined workstation depth cue indices. Objects are depth cued toward a specified depth cue colour. Depth cueing applies to all primitives.

C Input Parameters

wsThe workstation identifier.

lengthThe number of ints in the indices output parameter for which the application has allocated memory. length is the number of list elements that the system can return in indices→ints. If a value of 0 is used here, no data will be returned in the indices→ints list, but the total number of elements will be returned in total_length.

startStarting position of inquiry. The elements in the list, beginning with the item number specified by start, are copied sequentially into indices→ints until indices→ints is full or all the elements have been copied.

C Output Parameters

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

indicesA pointer to a Pint_list data structure containing the list of depth cue indices. A Pint_list structure is defined as:

typedef struct {
Pintnum_ints;/∗ number of Pints in list ∗/
Pint∗ints;/∗ list of integers ∗/
} Pint_list;

The num_ints component specifies the number of elements in the list. The ints component is a pointer to a list num_ints long.

The application must allocate memory for length elements in the list of ints.

total_length
A pointer to an integer in which the system returns the total number of elements in the list. This is the value required for length if all elements in the list are to be returned.

Execution

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

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

003Ignoring function, function requires state (PHOP,WSOP,∗,∗)

054Ignoring function, the specified workstation is not open

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

Museum