INQUIRE LIST OF DEPTH CUE INDICES(3P+) — MISC. REFERENCE MANUAL PAGES

NAME

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

SYNOPSIS

C Syntax

void
pinqdcueind ( wsid, length, start, error_ind, indices, total_length )
Pintwsid;workstation identifier
Pintlength;number of indices requested
Pintstart;starting position
Pint∗error_ind;OUT error indicator
Pintlst∗indices;OUT depth cue indices
Pint∗total_length;OUT length of list in PHIGS

FORTRAN Syntax

SUBROUTINE pqdci ( WKID, N, ERRIND, NDCI, DCI )
INTEGERWKIDworkstation identifier
INTEGERNlist element requested
INTEGERERRINDOUT error indicator
INTEGERNDCIOUT number of depth cue indices
INTEGERDCIOUT Nth depth cue index

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.

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.

wsidThe workstation identifier.

lengthThe number of indices requested.

startThe first index 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.

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

typedef struct {
Pintnumber;/∗ number of Pints in list ∗/
Pint∗integers;/∗ list of integers ∗/
} Pintlst;

total_length
A pointer to an integer which returns the total length of the list of depth cue indices.

FORTRAN Input Parameters

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

NThe requested element from the list of depth cue indices.

FORTRAN Ouput Parameters

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

NDCIThe number of depth cue indicies in the list.

DCIThe Nth element of the list of depth cue indices.

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 (i.e., the workstation category is neither OUTPUT, OUTIN, nor MO)

Museum