PTRSHAPE

From EDM2
Jump to: navigation, search

Address in application storage, where the application stores the data necessary for the pointer device driver to return information about the Row-by-Column image for each bit plane for the mode the display is currently running.

Type

USHORT  cb
USHORT  col
USHORT  row
USHORT  colHot
USHORT  rowHot

C Declaration Method

typedef struct

Fields

cb
Length of the pointer buffer.
The length of the pointer buffer available for the pointer device driver to build a row-by-column image for each bit plane for the mode the display is currently running. This value is supplied by the application. If the value is too small, pointer draw places the true length of the image in this field and returns an error.
For all OS/2 system-supported modes, cb is specified in bytes and is equal to:
Mono and Text Modes
For text mode, height and width must be 1, so length is always 4.
cb = (height in chars) * (width in chars) * 2 * 2
   = 1 * 1 * 2 * 2
   = 4
Graphics Mode
Width-in-pels must be a multiple of 8.
cb = (height in pels) * (width in pels) * (bits per pel) * 2 / 8
col
The number of columns in mouse shape.
In graphics modes, this field contains the pel width (columns) of the mouse shape for the session and must be greater than or equal to 1. In text modes, col must equal 1.
row
The number of rows in mouse shape.
In graphics modes, this field contains the pel height (rows) of the mouse shape for the session and must be greater than or equal to 1. In text modes, row must equal 1.
colHot
Pointer image hotspot.
This value is returned by the mouse device driver to indicate the relative column offset within the pointer image. The value defines the center (hotspot) of the pointer image. This value is a signed number that represents either character or pel offset, depending on the display mode.
rowHot
Pointer image hotspot.
The row of the pointer image hotspot. This value is returned by the mouse device driver to indicate the relative row offset within the pointer image. The value defines the center (hotspot) of the pointer image. This value is a signed number that represents either character or pel offset, depending on the display mode.