NAME

INQUIRE LIST OF DEPTH CUE INDICES - inquire for 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 )

Pint       ws;              workstation identifier
Pint       length;          length of application list
Pint       start;           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

FORTRAN Syntax

SUBROUTINE pqdci ( WKID, N, ERRIND, NDCI, DCI )

INTEGER      WKID        workstation identifier
INTEGER      N           list element requested
INTEGER      ERRIND      OUT error indicator
INTEGER      NDCI        OUT number of depth cue indices
INTEGER      DCI         OUT Nth depth cue index

Required PHIGS Operating States

(PHOP, WSOP, * ,* )

DESCRIPTION

Purpose

INQUIRE LIST OF DEPTH CUE INDICES inquire for 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.

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

C Input Parameters

ws

The workstation identifier.

length

The 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, then no data is returned in the indices.ints list, but the total number of elements is returned in total_length.

start

Starting 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 in which to store the error number of any error that this function detects.

indices A pointer to a Pint_list data structure containing the list of depth cue indices. A

Pint_list structure is defined as:

typedef struct {

Pint  num_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.

FORTRAN Input Parameters

WKID

The identifier of the workstation for which the list of depth cue indices is desired.

N

The requested element from the list of depth cue indices.

FORTRAN Output Parameters

ERRIND

A pointer to the location in which to store the error number of any error that this function detects.

NDCI

The number of depth cue indices in the list.

DCI

The Nth element of the list of depth cue indices.

Execution

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

If the inquired information is not available, then 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

003

Ignoring function, function requires state (PHOP, WSOP, * ,* )

054

Ignoring function, the specified workstation is not open

059

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

SEE ALSO

SET DEPTH CUE REPRESENTATION (3PP)

SET DEPTH CUE INDEX (3PP)

INQUIRE DEPTH CUE REPRESENTATION (3PP)