[ Previous | Next | Contents | Glossary | Home | Search ]
The graPHIGS Programming Interface : Subroutine Reference

GPCUR - Set Cursor Representation

GPCUR (wsid, index, format, shape)

Purpose

Use GPCUR to set the cursor shape into the specified cursor shape table entry of the specified workstation.

Parameters

wsid -- specified by user, fullword integer

Workstation identifier.

index -- specified by user, fullword integer

Cursor shape table index (>=1)

format -- specified by user, fullword integer

Format of the cursor definition in shape

Valid formats are:

 1 -

Fixed Size Raster, 1 bit per pixel.

>=2 -

Reserved.

shape -- specified by user, variable data

Cursor definition data. This parameter contains the information required to define a cursor shape. The content of this parameter is interpreted according to the format parameter.

Type 1 cursor format requires a rectangular array of pixels, each 1 bit deep. A value of one in a pixel location indicates that the cursor color should be displayed for the screen pixel which is overlayed by the cursor pixel. A value of zero indicates that the underlying screen pixel should not be modified or overlayed. The following syntax is required for this format:

Field Offset (bytes) Length (bytes) Type/Interpretation
ncol 0 4 fullword integer. x size of pixel array (number of columns)
nrow 4 4 fullword integer. y size of pixel array (number of rows)
pixels 8 (ncol+31)/32*nrow*4 Array of bits, 1/pixel. Each row starts on a word (32 bit) boundary.
For this format, the x size and y size of the specified pixel array must match the maximum pixel array size as returned by the Inquire Cursor Facilities (GPQCUF) subroutine.

Error Codes

25
SPECIFIED WORKSTATION DOES NOT EXIST
37
WORKSTATION IS NOT OF CATEGORY OUTIN
181
CURSOR PIXEL ARRAY SIZE IS INVALID
182
CURSOR SHAPE TABLE INDEX NOT WITHIN WORKSTATION TABLE RANGE
183
SPECIFIED CURSOR FORMAT IS NOT SUPPORTED

Related Subroutines

GPCUS
Set Cursor Shape
GPQCUF
Inquire Cursor Facilities

RCP code

201344772 (X'0C004704')


[ Previous | Next | Contents | Glossary | Home | Search ]