View source for Unit Mouse

Return to [[Unit_Reference|Unit Reference]]


=== Description ===
----

'''Ultibo Mouse Interface unit'''

'''Mouse Devices'''

This unit provides the Mouse device interface and mouse API to be used by both drivers and applications.
 
The API includes functions to create, register, locate, read, write, control and configure each connected mouse device.

The API supports a global mouse buffer so multiple devices can feed data into a common buffer as well as a buffer per device to allow each device to be used for a specific purpose. For example an application with two separate displays may choose to have a mouse or pointing device to control each one individually.

=== Constants ===
----


<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 20px; padding-bottom: 15px;">
<div style="font-size: 14px; padding-left: 12px;">'''Mouse specific constants''' <code> MOUSE_* </code></div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
| <code>MOUSE_NAME_PREFIX = 'Mouse';</code>
| Name prefix for Mouse Devices
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 20px; padding-bottom: 15px;">
<div style="font-size: 14px; padding-left: 12px;">'''Mouse device type''' <code> MOUSE_TYPE_* </code></div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
| <code>MOUSE_TYPE_NONE = 0;</code>
| style="width: 50%;"|&nbsp;
|-
| <code>MOUSE_TYPE_USB = 1;</code>
| &nbsp;
|-
| <code>MOUSE_TYPE_PS2 = 2;</code>
| &nbsp;
|-
| <code>MOUSE_TYPE_SERIAL = 3;</code>
| &nbsp;
|-
|colspan="2"|&nbsp;
|-
| <code>MOUSE_TYPE_MAX = 3;</code>
| &nbsp;
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 20px; padding-bottom: 15px;">
<div style="font-size: 14px; padding-left: 12px;">'''Mouse device state''' <code> MOUSE_STATE_* </code></div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
| <code>MOUSE_STATE_DETACHED = 0;</code>
| style="width: 50%;"|&nbsp;
|-
| <code>MOUSE_STATE_DETACHING = 1;</code>
| &nbsp;
|-
| <code>MOUSE_STATE_ATTACHING = 2;</code>
| &nbsp;
|-
| <code>MOUSE_STATE_ATTACHED = 3;</code>
| &nbsp;
|-
|colspan="2"|&nbsp;
|-
| <code>MOUSE_STATE_MAX = 3;</code>
| &nbsp;
|-
|}
</div></div>
<br /> 
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 20px; padding-bottom: 15px;">
<div style="font-size: 14px; padding-left: 12px;">'''Mouse device flag''' <code> MOUSE_FLAG_* </code></div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
| <code>MOUSE_FLAG_NONE = $00000000;</code>
| &nbsp;
|-
| <code>MOUSE_FLAG_NON_BLOCK = $00000001;</code>
| If set device reads are non blocking (Also supported in Flags parameter of MouseReadEx)
|-
| <code>MOUSE_FLAG_DIRECT_READ = $00000002;</code>
| If set device writes mouse data to its local buffer which must be read using MouseDeviceRead
|-
| <code>MOUSE_FLAG_SWAP_BUTTONS = $00000004;</code>
| If set left and right mouse buttons will be swapped in mouse data
|-
| <code>MOUSE_FLAG_PEEK_BUFFER = $00000008;</code>
| Peek at the buffer to see if any data is available, don't remove it. (Used only in Flags parameter of MouseReadEx)
|-
| <code>MOUSE_FLAG_SWAP_XY = $00000010;</code>
| If set swap the X and Y coordinates
|-
| <code>MOUSE_FLAG_INVERT_X = $00000020;</code>
| If set invert the X coordinate
|-
| <code>MOUSE_FLAG_INVERT_Y = $00000040;</code>
| If set invert the Y coordinate
|-
| <code>MOUSE_FLAG_SWAP_MAX_XY = $00000080;</code>
| If set swap the maximum X and Y values
|-
|colspan="2"|&nbsp;
|-
|colspan="2"|''Flags supported by MOUSE_CONTROL_GET/SET/CLEAR_FLAG''
|-
|colspan="2"|<code>MOUSE_FLAG_MASK = MOUSE_FLAG_NON_BLOCK or MOUSE_FLAG_DIRECT_READ or MOUSE_FLAG_SWAP_BUTTONS or MOUSE_FLAG_SWAP_XY or MOUSE_FLAG_INVERT_X or MOUSE_FLAG_INVERT_Y or MOUSE_FLAG_SWAP_MAX_XY;</code>
|-
|}
</div></div>
<br /> 
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 20px; padding-bottom: 15px;">
<div style="font-size: 14px; padding-left: 12px;">'''Mouse device control code''' <code> MOUSE_CONTROL_* </code></div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
| <code>MOUSE_CONTROL_GET_FLAG = 1;</code>
| Get Flag
|-
| <code>MOUSE_CONTROL_SET_FLAG = 2;</code>
| Set Flag
|-
| <code>MOUSE_CONTROL_CLEAR_FLAG = 3;</code>
| Clear Flag
|-
| <code>MOUSE_CONTROL_FLUSH_BUFFER = 4;</code>
| Flush Buffer
|-
| <code>MOUSE_CONTROL_GET_SAMPLE_RATE = 5;</code>
| Get Sample Rate
|-
| <code>MOUSE_CONTROL_SET_SAMPLE_RATE = 6;</code>
| Set Sample Rate
|-
| <code>MOUSE_CONTROL_GET_MAX_X = 7;</code>
| Get Maximum X value (Only applies to Absolute X values)
|-
| <code>MOUSE_CONTROL_GET_MAX_Y = 8;</code>
| Get Maximum Y value (Only applies to Absolute Y values)
|-
| <code>MOUSE_CONTROL_GET_MAX_WHEEL = 9;</code>
| Get Maximum Wheel value (Only applies to Absolute Wheel values)
|-
| <code>MOUSE_CONTROL_GET_MAX_BUTTONS = 10;</code>
| Get Maximum Buttons mask (eg MOUSE_LEFT_BUTTON or MOUSE_RIGHT_BUTTON etc)
|-
| <code>MOUSE_CONTROL_GET_ROTATION = 11;</code>
| Get Rotation value (0, 90, 180, 270) (Only where supported by the driver)
|-
| <code>MOUSE_CONTROL_SET_ROTATION = 12;</code>
| Set Rotation value (0, 90, 180, 270) (Only where supported by the driver)
|-
|}
</div></div>
<br /> 
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 20px; padding-bottom: 15px;">
<div style="font-size: 14px; padding-left: 12px;">'''Mouse buffer size''' <code> MOUSE_BUFFER_* </code></div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
| <code>MOUSE_BUFFER_SIZE = 512;</code>
| style="width: 50%;"|&nbsp;
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 20px; padding-bottom: 15px;">
<div style="font-size: 14px; padding-left: 12px;">'''Mouse sampling rate''' <code> MOUSE_SAMPLE_* </code></div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
| <code>MOUSE_SAMPLE_RATE = 100;</code>
| 100 samples/sec
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 20px; padding-bottom: 15px;">
<div style="font-size: 14px; padding-left: 12px;">'''Mouse data definition''' <code> MOUSE_LEFT_*, MOUSE_RIGHT_* </code></div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
|colspan="2"|Values for TMouseData.Buttons
|-
|colspan="2"|&nbsp;
|-
| <code>MOUSE_LEFT_BUTTON = $0001;</code>
| The Left mouse button is pressed
|-
| <code>MOUSE_RIGHT_BUTTON = $0002;</code>
| The Right mouse button is pressed
|-
| <code>MOUSE_MIDDLE_BUTTON = $0004;</code>
| The Middle mouse button is pressed
|-
| <code>MOUSE_SIDE_BUTTON = $0008;</code>
| The Side mouse button is pressed
|-
| <code>MOUSE_EXTRA_BUTTON = $0010;</code>
| The Extra mouse button is pressed
|-
| <code>MOUSE_TOUCH_BUTTON = $0020;</code>
| The Touch screen is being touched
|-
| <code>MOUSE_ABSOLUTE_X = $0040;</code>
| The OffsetX value is absolute not relative
|-
| <code>MOUSE_ABSOLUTE_Y = $0080;</code>
| The OffsetY value is absolute not relative
|-
| <code>MOUSE_ABSOLUTE_WHEEL = $0100;</code>
| The OffsetWheel value is absolute not relative
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 20px; padding-bottom: 15px;">
<div style="font-size: 14px; padding-left: 12px;">'''Mouse rotation''' <code> MOUSE_ROTATION_* </code></div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
| <code>MOUSE_ROTATION_0 = FRAMEBUFFER_ROTATION_0;</code>
| No rotation
|-
| <code>MOUSE_ROTATION_90  = FRAMEBUFFER_ROTATION_90;</code>
| 90 degree rotation
|-
| <code>MOUSE_ROTATION_180 = FRAMEBUFFER_ROTATION_180;</code>
| 180 degree rotation
|-
| <code>MOUSE_ROTATION_270 = FRAMEBUFFER_ROTATION_270;</code>
| 270 degree rotation
|-
|}
</div></div>
<br /> 
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 20px; padding-bottom: 15px;">
<div style="font-size: 14px; padding-left: 12px;">'''Mouse logging''' <code> MOUSE_LOG_* </code></div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
| <code>MOUSE_LOG_LEVEL_DEBUG = LOG_LEVEL_DEBUG;</code>
| Mouse debugging messages
|-
| <code>MOUSE_LOG_LEVEL_INFO = LOG_LEVEL_INFO;</code>
| Mouse informational messages, such as a device being attached or detached
|-
| <code>MOUSE_LOG_LEVEL_WARN = LOG_LEVEL_WARN;</code>
| Mouse warning messages
|-
| <code>MOUSE_LOG_LEVEL_ERROR = LOG_LEVEL_ERROR;</code>
| Mouse error messages
|-
| <code>MOUSE_LOG_LEVEL_NONE = LOG_LEVEL_NONE;</code>
| No Mouse messages
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 20px; padding-bottom: 15px;">
<div style="font-size: 14px; padding-left: 12px;">'''USB mouse specific constants''' <code> USBMOUSE_* </code></div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
|colspan="2"|Note: The following constants are duplicated with the USBMouse unit for backwards compatibility
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 20px; padding-bottom: 15px;">
<div style="font-size: 14px; padding-left: 12px;">'''USB HID types''' <code> USB_HID_* </code></div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
|colspan="2"|''HID Interface Subclass types (See USB HID v1.11 specification)''
|-
| <code>USB_HID_SUBCLASS_NONE = 0;</code>
| Section 4.2
|-
| <code>USB_HID_SUBCLASS_BOOT = 1;</code>
| Section 4.2
|-
|colspan="2"|&nbsp;
|-
|colspan="2"|''HID Interface Protocol types (See USB HID v1.11 specification)''
|-
| <code>USB_HID_BOOT_PROTOCOL_NONE = 0;</code>
| Section 4.3
|-
| <code>USB_HID_BOOT_PROTOCOL_KEYBOARD = 1;</code>
| Section 4.3
|-
| <code>USB_HID_BOOT_PROTOCOL_MOUSE = 2;</code>
| Section 4.3
|-
|colspan="2"|&nbsp;
|-
|colspan="2"|''HID Class Descriptor Types (See USB HID v1.11 specification)''
|-
| <code>USB_HID_DESCRIPTOR_TYPE_HID = $21;</code>
| Section 7.1
|-
| <code>USB_HID_DESCRIPTOR_TYPE_REPORT = $22;</code>
| Section 7.1
|-
| <code>USB_HID_DESCRIPTOR_TYPE_PHYSICAL_DESCRIPTOR = $23;</code>
| Section 7.1
|-
|colspan="2"|&nbsp;
|-
|colspan="2"|''HID Request types''
|-
| <code>USB_HID_REQUEST_GET_REPORT = $01;</code>
| &nbsp;
|-
| <code>USB_HID_REQUEST_GET_IDLE = $02;</code>
| &nbsp;
|-
| <code>USB_HID_REQUEST_GET_PROTOCOL = $03;</code>
| Section 7.2
|-
| <code>USB_HID_REQUEST_SET_REPORT = $09;</code>
| &nbsp;
|-
| <code>USB_HID_REQUEST_SET_IDLE = $0A;</code>
| &nbsp;
|-
| <code>USB_HID_REQUEST_SET_PROTOCOL = $0B;</code>
| Section 7.2
|-
|colspan="2"|&nbsp;
|-
|colspan="2"|''HID Protocol types''
|-
| <code>USB_HID_PROTOCOL_BOOT = 0;</code>
| Section 7.2.5
|-
| <code>USB_HID_PROTOCOL_REPORT = 1;</code>
| Section 7.2.5
|-
|colspan="2"|&nbsp;
|-
|colspan="2"|''HID Report types''
|-
| <code>USB_HID_REPORT_INPUT = 1;</code>
| Section 7.2.1
|-
| <code>USB_HID_REPORT_OUTPUT = 2;</code>
| Section 7.2.1
|-
| <code>USB_HID_REPORT_FEATURE = 3;</code>
| Section 7.2.1
|-
|colspan="2"|&nbsp;
|-
|colspan="2"|''HID Report IDs''
|-
| <code>USB_HID_REPORTID_NONE = 0;</code>
| Section 7.2.1
|-
|colspan="2"|&nbsp;
|-
|colspan="2"|''HID Boot Protocol Button bits''
|-
| <code>USB_HID_BOOT_LEFT_BUTTON = (1 shl 0);</code>
| &nbsp;
|-
| <code>USB_HID_BOOT_RIGHT_BUTTON = (1 shl 1);</code>
| &nbsp;
|-
| <code>USB_HID_BOOT_MIDDLE_BUTTON = (1 shl 2);</code>
| &nbsp;
|-
| <code>USB_HID_BOOT_SIDE_BUTTON = (1 shl 3);</code>
| &nbsp;
|-
| <code>USB_HID_BOOT_EXTRA_BUTTON = (1 shl 4);</code>
| &nbsp;
|-
|colspan="2"|&nbsp;
|-
|colspan="2"|''HID Boot Protocol Report data''
|-
| <code>USB_HID_BOOT_REPORT_SIZE = 3;</code>
| Appendix B of HID Device Class Definition 1.11
|-
| <code>USB_HID_BOOT_DATA_SIZE = 8;</code>
| Allocate more than the minimum to allow for extra data
|-
|}
</div></div>
<br /> 

=== Type definitions ===
----


'''Mouse data'''
 
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
<code>PMouseData = ^TMouseData;</code>

<code>TMouseData = record</code>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
| <code>Buttons:Word;</code>
| The bitmap of current button values (eg MOUSE_LEFT_BUTTON or MOUSE_RIGHT_BUTTON)
|-
| <code>OffsetX:SmallInt;</code>
| The X offset of the mouse pointer (May be negative, read as absolute if Buttons includes MOUSE_ABSOLUTE_X)
|-
| <code>OffsetY:SmallInt;</code>
| The Y offset of the mouse pointer (May be negative, read as absolute if Buttons includes MOUSE_ABSOLUTE_Y)
|-
| <code>OffsetWheel:SmallInt;</code>
| The X offset of the mouse pointer (May be negative, read as absolute if Buttons includes MOUSE_ABSOLUTE_WHEEL)
|-
| <code>MaximumX:Word;</code>
| The maximum X value of the mouse (Only applicable if Buttons includes MOUSE_ABSOLUTE_X, otherwise must be 0)
|-
| <code>MaximumY:Word;</code>
| The maximum Y value of the mouse (Only applicable if Buttons includes MOUSE_ABSOLUTE_Y, otherwise must be 0)
|-
| <code>MaximumWheel:Word;</code>
| The maximum Wheel value of the mouse (Only applicable if Buttons includes MOUSE_ABSOLUTE_WHEEL, otherwise must be 0)
|-
| <code>Reserved:Word;</code>
| Reserved field (Round structure to 16 bytes)
|-
|}
</div></div> 
 
'''Mouse buffer'''

<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
<code>PMouseBuffer = ^TMouseBuffer;</code>

<code>TMouseBuffer = record</code>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
| <code>Wait:TSemaphoreHandle;</code>
| Buffer ready semaphore
|-
| <code>Start:LongWord;</code>
| Index of first buffer ready
|-
| <code>Count:LongWord;</code>
| Number of entries ready in buffer
|-
| <code>Buffer:array[0..(MOUSE_BUFFER_SIZE - 1)] of TMouseData; </code>
| &nbsp;
|-
|}
</div></div>

'''Mouse properties'''

<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
<code>PMouseProperties = ^TMouseProperties;</code>

<code>TMouseProperties = record</code>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
| <code>Flags:LongWord;</code>
| Device flags (eg MOUSE_FLAG_SWAP_BUTTONS)
|-
| <code>Rotation:LongWord;</code>
| Screen Rotation (eg MOUSE_ROTATION_180)
|-
| <code>MaxX:LongWord;</code>
| Maximum (absolute) X value for the mouse device
|-
| <code>MaxY:LongWord;</code>
| Maximum (absolute) Y value for the mouse device
|-
| <code>MaxWheel:LongWord;</code>
| Maximum (absolute) wheel value for the mouse device
|-
| <code>MaxButtons:LongWord;</code>
| Maximum buttons mask (eg MOUSE_LEFT_BUTTON or MOUSE_RIGHT_BUTTON etc)
|-
|}
</div></div> 

'''Mouse enumeration callback'''

{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
|-
| <code>TMouseEnumerate = function(Mouse:PMouseDevice; Data:Pointer):LongWord;</code>
| style="width: 40%;"|
|-
|}

'''Mouse notification callback'''

{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
|-
| <code>TMouseNotification = function(Device:PDevice; Data:Pointer; Notification:LongWord):LongWord;</code>
| style="width: 40%;"|
|-
|}
 
'''Mouse device read'''

{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
|-
| <code>TMouseDeviceRead = function(Mouse:PMouseDevice; Buffer:Pointer; Size:LongWord; var Count:LongWord):LongWord;</code>
| style="width: 40%;"|
|-
|}

'''Mouse device update'''

{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
|-
| <code>TMouseDeviceUpdate = function(Mouse:PMouseDevice):LongWord; stdcall;</code>
| style="width: 40%;"|
|-
|}

'''Mouse device control'''

{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
|-
| <code>TMouseDeviceControl = function(Mouse:PMouseDevice; Request:Integer; Argument1:PtrUInt; var Argument2:PtrUInt):LongWord;</code>
| style="width: 40%;"|
|-
|}

'''Mouse device get properties'''

{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
|-
| <code>TMouseDeviceGetProperties = function(Mouse:PMouseDevice; Properties:PMouseProperties):LongWord; stdcall;</code>
| style="width: 40%;"|
|-
|} 

'''Mouse device types'''
 
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
<code>PMouseDevice = ^TMouseDevice;</code>

<code>TMouseDevice = record</code>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
|colspan="2"|''Device Properties''
|-
| <code>Device:TDevice;</code>
| The Device entry for this Mouse
|-
|colspan="2"|''Mouse Properties''
|-
| <code>MouseId:LongWord;</code>
| Unique Id of this Mouse in the Mouse table
|-
| <code>MouseState:LongWord;</code>
| Mouse state (eg MOUSE_STATE_ATTACHED)
|-
| <code>MouseRate:LongWord;</code>
| Mouse sample rate (Samples per second)
|-
| <code>DeviceRead:TMouseDeviceRead;</code>
| A Device specific DeviceRead method implementing a standard Mouse device interface (Or nil if the default method is suitable)
|-
| <code>DeviceUpdate:TMouseDeviceUpdate;</code>
| A Device specific DeviceUpdate method implementing a standard Mouse device interface (Or nil if the default method is suitable)
|-
| <code>DeviceControl:TMouseDeviceControl;</code>
| A Device specific DeviceControl method implementing a standard Mouse device interface (Or nil if the default method is suitable)
|-
| <code>DeviceGetProperties:TMouseDeviceGetProperties;</code>
| A Device specific DeviceGetProperties method implementing a standard Mouse device interface (Or nil if the default method is suitable)
|-
|colspan="2"|''Driver Properties''
|-
| <code>Lock:TMutexHandle;</code>
| Mouse lock
|-
| <code>Buffer:TMouseBuffer;</code>
| Mouse input buffer
|-
| <code>Properties:TMouseProperties;</code>
| Device properties
|-
|colspan="2"|''Statistics Properties''
|-
| <code>ReceiveCount:LongWord;</code>
| &nbsp;
|-
| <code>ReceiveErrors:LongWord;</code>
| &nbsp;
|-
| <code>BufferOverruns:LongWord;</code>
| &nbsp;
|-
|colspan="2"|''Internal Properties''
|-
| <code>Prev:PMouseDevice;</code>
| Previous entry in Mouse table
|-
| <code>Next:PMouseDevice;</code>
| Next entry in Mouse table
|-
|}
</div></div> 

'''USB HID descriptor''' 

<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
<code>PUSBHIDDescriptor = ^TUSBHIDDescriptor;</code>

<code>TUSBHIDDescriptor = packed record</code>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
| <code>bLength:Byte;</code>
| style="width: 50%;"|&nbsp;
|-
| <code>bDescriptorType:Byte;</code>
| &nbsp;
|-
| <code>bcdHID:Word;</code>
| &nbsp;
|-
| <code>bCountryCode:Byte;</code>
| &nbsp;
|-
| <code>bNumDescriptors:Byte;</code>
| &nbsp;
|-
| <code>bHIDDescriptorType:Byte;</code>
| &nbsp;
|-
| <code>wHIDDescriptorLength:Word;</code>
| &nbsp;
|-
|colspan="2"|''Note: Up to two optional bHIDDescriptorType/wHIDDescriptorLength pairs after the Report descriptor details''
|-
|}
</div></div> 
<br />

=== Public variables ===
----


'''Mouse logging'''

{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
|-
| <code>MOUSE_DEFAULT_LOG_LEVEL:LongWord = MOUSE_LOG_LEVEL_DEBUG;</code>
| style="width: 40%;"|Minimum level for Mouse messages. Only messages with level greater than or equal to this will be printed.
|-
|}
{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
|-
| <code>MOUSE_LOG_ENABLED:Boolean;</code>
| style="width: 40%;"|
|-
|}
<br />

=== Function declarations ===
----


'''Initialization functions'''

<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">procedure MouseInit;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Initialize the mouse unit and device table</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| Called only during system startup
|-
|}
</div></div>
<br />

'''Mouse functions'''

<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function MousePeek:LongWord;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Peek at the global mouse buffer to see if any data packets are ready</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Return
| ERROR_SUCCESS if packets are ready, ERROR_NO_MORE_ITEMS if not or another error code on failure
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function MouseRead(Buffer:Pointer; Size:LongWord; var Count:LongWord):LongWord; inline;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Read mouse data packets from the global mouse buffer</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Buffer
| Pointer to a buffer to copy the mouse data packets to
|-
! Size
| The size of the buffer in bytes (Must be at least TMouseData or greater)
|-
! Count
| The number of mouse data packets copied to the bufferm
|-
! Return
| ERROR_SUCCESS if completed or another error code on failure
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function MouseReadEx(Buffer:Pointer; Size,Flags:LongWord; var Count:LongWord):LongWord;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Read mouse data packets from the global mouse buffer</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Buffer
| Pointer to a buffer to copy the mouse data packets to
|-
! Size
| The size of the buffer in bytes (Must be at least TMouseData or greater)
|-
! Flags
| The flags for the behaviour of the read (eg MOUSE_FLAG_NON_BLOCK)
|-
! Count
| The number of mouse data packets copied to the buffer
|-
! Return
| ERROR_SUCCESS if completed or another error code on failure
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function MouseWrite(Buffer:Pointer; Size,Count:LongWord):LongWord;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Write mouse data packets to the global mouse buffer</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Buffer
| Pointer to a buffer to copy the mouse data packets from
|-
! Size
| The size of the buffer in bytes (Must be at least TMouseData or greater)
|-
! Count
| The number of mouse data packets to copy from the buffer
|-
! Return
| ERROR_SUCCESS if completed or another error code on failure
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function MouseFlush:LongWord;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Flush the contents of the global mouse buffer</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Return
| ERROR_SUCCESS if completed or another error code on failure
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function MouseDeviceRead(Mouse:PMouseDevice; Buffer:Pointer; Size:LongWord; var Count:LongWord):LongWord;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Read mouse data packets from the buffer of the specified mouse</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Mouse
| The mouse device to read from
|-
! Buffer
| Pointer to a buffer to copy the mouse data packets to
|-
! Size
| The size of the buffer in bytes (Must be at least TMouseData or greater)
|-
! Count
| The number of mouse data packets copied to the buffer
|-
! Return
| ERROR_SUCCESS if completed or another error code on failure
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function MouseDeviceUpdate(Mouse:PMouseDevice):LongWord;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Request the specified mouse device to update the current configuration</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Mouse
| The mouse device to update
|-
! Return
| ERROR_SUCCESS if completed or another error code on failure
|-
! Note
| Items updated can include rotation, maximum X, Y and wheel and flags (If supported)
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function MouseDeviceControl(Mouse:PMouseDevice; Request:Integer; Argument1:PtrUInt; var Argument2:PtrUInt):LongWord;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Perform a control request on the specified mouse device</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Mouse
| The mouse device to control
|-
! Request
| The request code for the operation (eg MOUSE_CONTROL_GET_FLAG)
|-
! Argument1
| The first argument for the operation (Dependent on request code)
|-
! Argument2
| The second argument for the operation (Dependent on request code)
|-
! Return
| ERROR_SUCCESS if completed or another error code on failure
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function MouseDeviceGetProperties(Mouse:PMouseDevice; Properties:PMouseProperties):LongWord;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Get the properties for the specified mouse device</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Mouse
| The mouse device to get properties from
|-
! Properties
| Pointer to a TMouseProperties structure to fill in
|-
! Return
| ERROR_SUCCESS if completed or another error code on failure
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function MouseDeviceSetState(Mouse:PMouseDevice; State:LongWord):LongWord;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Set the state of the specified mouse and send a notification</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Mouse
| The mouse to set the state for
|-
! State
| The new state to set and notify
|-
! Return
| ERROR_SUCCESS if completed or another error code on failure
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function MouseDeviceCreate:PMouseDevice;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Create a new Mouse device entry</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Return
| Pointer to new Mouse device entry or nil if mouse could not be created
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function MouseDeviceCreateEx(Size:LongWord):PMouseDevice;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Create a new Mouse device entry</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Size
| Size in bytes to allocate for new mouse (Including the mouse device entry)
|-
! Return
| Pointer to new Mouse device entry or nil if mouse could not be created
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function MouseDeviceDestroy(Mouse:PMouseDevice):LongWord;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Destroy an existing Mouse device entry</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Mouse
| The mouse device to destroy
|-
! Return
| ERROR_SUCCESS if completed or another error code on failure
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function MouseDeviceRegister(Mouse:PMouseDevice):LongWord;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Register a new Mouse device in the Mouse table</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Mouse
| The mouse device to register
|-
! Return
| ERROR_SUCCESS if completed or another error code on failure
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function MouseDeviceDeregister(Mouse:PMouseDevice):LongWord;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Deregister a Mouse device from the Mouse table</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Mouse
| The mouse device to deregister
|-
! Return
| ERROR_SUCCESS if completed or another error code on failure
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function MouseDeviceFind(MouseId:LongWord):PMouseDevice;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Find a mouse device by ID in the mouse table</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! MouseId
| The ID number of the mouse to find
|-
! Return
| Pointer to mouse device entry or nil if not found
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function MouseDeviceFindByName(const Name:String):PMouseDevice; inline;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Find a mouse device by name in the mouse table</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Name
| The name of the mouse to find (eg Mouse0)
|-
! Return
| Pointer to mouse device entry or nil if not found
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function MouseDeviceFindByDescription(const Description:String):PMouseDevice; inline;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Find a mouse device by description in the mouse table</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Description
| The description of the mouse to find (eg USB HID Mouse)
|-
! Return
| Pointer to mouse device entry or nil if not found
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function MouseDeviceEnumerate(Callback:TMouseEnumerate; Data:Pointer):LongWord;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Enumerate all mouse devices in the mouse table</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Callback
| The callback function to call for each mouse in the table
|-
! Data
| A private data pointer to pass to callback for each mouse in the table
|-
! Return
| ERROR_SUCCESS if completed or another error code on failure
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function MouseDeviceNotification(Mouse:PMouseDevice; Callback:TMouseNotification; Data:Pointer; Notification,Flags:LongWord):LongWord;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Register a notification for mouse device changes</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Mouse
| The mouse device to notify changes for (Optional, pass nil for all mice)
|-
! Callback
| The function to call when a notification event occurs
|-
! Data
| A private data pointer to pass to callback when a notification event occurs
|-
! Notification
| The events to register for notification of (eg DEVICE_NOTIFICATION_REGISTER)
|-
! Flags
| The flags to control the notification (eg NOTIFIER_FLAG_WORKER)
|-
|}
</div></div>
<br />

'''RTL console functions'''

<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function SysConsoleHideMouse(AUserData:Pointer):Boolean;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Handler for Platform ConsoleHideMouse function</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| None documented
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function SysConsoleShowMouse(X,Y:LongWord; AUserData:Pointer):Boolean;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Handler for Platform ConsoleShowMouse function</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| None documented
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function SysConsoleReadMouse(var X,Y,Buttons:LongWord; AUserData:Pointer):Boolean;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Handler for Platform ConsoleReadMouse function</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| None documented
|-
|}
</div></div>
<br />

'''Mouse helper functions'''

<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function MouseGetCount:LongWord;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Get the current mouse count</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| None documented
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function MouseDeviceCheck(Mouse:PMouseDevice):PMouseDevice;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Check if the supplied Mouse is in the mouse table</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| None documented
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function MouseDeviceTypeToString(MouseType:LongWord):String;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' To be documented</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| None documented
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function MouseDeviceStateToString(MouseState:LongWord):String;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' To be documented</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| None documented
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function MouseDeviceRotationToString(Rotation:LongWord):String;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Return a string describing the supplied mouse rotation value</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| None documented
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function MouseDeviceStateToNotification(State:LongWord):LongWord;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Convert a Mouse state value into the notification code for device notifications</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| None documented
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function MouseDeviceResolveRotation(ARotation:LongWord):LongWord;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Resolve a value of 0, 90, 180 or 270 to a mouse rotation constant (eg MOUSE_ROTATION_180)</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| Also accepts passing the mouse rotation constant values directly
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function MouseInsertData(Mouse:PMouseDevice; Data:PMouseData; Signal:Boolean):LongWord;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Insert a TMouseData entry into the mouse buffer (Direct or Global)</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Mouse
| The mouse device to insert data for
|-
! Data
| The TMouseData entry to insert
|-
! Signal
| If True then signal that new data is available in the buffer
|-
! Return
| ERROR_SUCCESS if completed or another error code on failure
|-
! Note
| Caller must hold the mouse lock
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">procedure MouseLog(Level:LongWord; Mouse:PMouseDevice; const AText:String);</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' To be documented</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| None documented
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">procedure MouseLogInfo(Mouse:PMouseDevice; const AText:String); inline;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' To be documented</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| None documented
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">procedure MouseLogWarn(Mouse:PMouseDevice; const AText:String); inline;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' To be documented</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| None documented
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">procedure MouseLogError(Mouse:PMouseDevice; const AText:String); inline;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' To be documented</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| None documented
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">procedure MouseLogDebug(Mouse:PMouseDevice;const AText:String); inline;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' To be documented</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| None documented
|-
|}
</div></div>
<br />

Return to [[Unit_Reference|Unit Reference]]