en:docs:fapi:mougetptrshape

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
Last revisionBoth sides next revision
en:docs:fapi:mougetptrshape [2021/10/15 01:56] – prokusheven:docs:fapi:mougetptrshape [2021/10/15 02:26] – prokushev
Line 15: Line 15:
   * PtrDefRec (PPTRSHAPE) - input/output: Address of a structure in application storage where the application stores the data necessary for the pointer device driver to return information about the Row by Col image for each bit plane for the mode the display is currently running. See MouSetPtrShape for a further description of the contents of this structure.   * PtrDefRec (PPTRSHAPE) - input/output: Address of a structure in application storage where the application stores the data necessary for the pointer device driver to return information about the Row by Col image for each bit plane for the mode the display is currently running. See MouSetPtrShape for a further description of the contents of this structure.
     * TotLength (USHORT) :  Length of the pointer buffer available for the pointer device driver to build a Row by Col 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.     * TotLength (USHORT) :  Length of the pointer buffer available for the pointer device driver to build a Row by Col 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.
 +    * col (USHORT)
 +Number of columns in the 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 (USHORT)
 +Number of rows in the 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.
 +    * coloffset (USHORT)
 +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. 
 +
 +    * rowoffset (USHORT)
 +
 +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.
 +
 +  * DeviceHandle (HMOU) - input:Handle of the mouse device from a previous MouOpen.
  
 For all OS/2 system-supported modes, TotLength is specified in bytes and is equal to: For all OS/2 system-supported modes, TotLength is specified in bytes and is equal to:
  
   *Mono & Text Modes   *Mono & Text Modes
-  **For text mode height and width must be 1, so length is always 4.+    *For text mode height and width must be 1, so length is always 4. 
     TotLength = (height in chars) * (width in chars) * 2 * 2     TotLength = (height in chars) * (width in chars) * 2 * 2
               = 1 * 1 * 2 * 2               = 1 * 1 * 2 * 2
               = 4               = 4
 +
   *Graphics Mode   *Graphics Mode
-  **Width-in-pels must be a multiple of 8. +    * Width-in-pels must be a multiple of 8. 
-  **TotLength = (height in pels)*(width in pels)*(bits per pel)*2/8+    * TotLength = (height in pels)*(width in pels)*(bits per pel)*2/8
   *Modes 4 and 5 (320 X 200)   *Modes 4 and 5 (320 X 200)
-  **TotLength = (height) * (width) * 2 * 2 / 8+    *TotLength = (height) * (width) * 2 * 2 / 8
   *Mode 6 (640 X 200)   *Mode 6 (640 X 200)
-  **TotLength = (height) * (width) * 1 * 2 / 8 +   *TotLength = (height) * (width) * 1 * 2 / 8 
-:Length calculations produce byte boundary buffer sizes. + 
-        +Length calculations produce byte boundary buffer sizes.
-:col (USHORT) +
-::Number of columns in the 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 (USHORT) +
-::Number of rows in the 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. +
-:coloffset (USHORT) +
-::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.  +
-:rowoffset (USHORT) +
-::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. +
-;DeviceHandle (HMOU) - input:Handle of the mouse device from a previous MouOpen.+
  
 ===== Return Code ===== ===== Return Code =====