Platforms to show: All Mac Windows Linux Cross-Platform
Back to WinPointerInfoMBS class.
WinPointerInfoMBS.ButtonChangeType as Integer
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Windows | MBS Win Plugin | 16.2 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop, Console & Web |
See kPointerChange* constants.
(Read only property)
WinPointerInfoMBS.frameId as Integer
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Windows | MBS Win Plugin | 16.2 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop, Console & Web |
For example, a parallel-mode multi-touch digitizer may report the positions of multiple touch contacts in a single update to the system.
Note that frame identifier is assigned as input is reported to the system for all pointers across all devices. Therefore, this field may not contain strictly sequential values in a single series of messages that a window receives. However, this field will contain the same numerical value for all input updates that were reported in the same input frame by a single device.
(Read only property)
WinPointerInfoMBS.HimetricLocationRawX as Integer
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Windows | MBS Win Plugin | 16.2 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop, Console & Web |
For adjusted screen coordinates, see HimetricLocation.
(Read only property)
WinPointerInfoMBS.HimetricLocationRawY as Integer
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Windows | MBS Win Plugin | 16.2 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop, Console & Web |
For adjusted screen coordinates, see HimetricLocation.
(Read only property)
WinPointerInfoMBS.HimetricLocationX as Integer
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Windows | MBS Win Plugin | 16.2 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop, Console & Web |
The predicted value is based on the pointer position reported by the digitizer and the motion of the pointer. This correction can compensate for visual lag due to inherent delays in sensing and processing the pointer location on the digitizer. This is applicable to pointers of type touch. For other pointer types, the predicted value will be the same as the non-predicted value (see ptHimetricLocationRaw).
(Read only property)
WinPointerInfoMBS.HimetricLocationY as Integer
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Windows | MBS Win Plugin | 16.2 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop, Console & Web |
The predicted value is based on the pointer position reported by the digitizer and the motion of the pointer. This correction can compensate for visual lag due to inherent delays in sensing and processing the pointer location on the digitizer. This is applicable to pointers of type touch. For other pointer types, the predicted value will be the same as the non-predicted value (see ptHimetricLocationRaw).
(Read only property)
WinPointerInfoMBS.historyCount as Integer
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Windows | MBS Win Plugin | 16.2 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop, Console & Web |
This count matches the total count of entries that can be returned by a call to GetPointerInfoHistory. If no coalescing occurred, this count is 1 for the single input represented by the message.
(Read only property)
WinPointerInfoMBS.hwndTarget as Integer
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Windows | MBS Win Plugin | 16.2 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop, Console & Web |
If the pointer is captured, either implicitly by virtue of having made contact over this window or explicitly using the pointer capture API, this is the capture window. If the pointer is uncaptured, this is the window over which the pointer was when this message was generated.
(Read only property)
WinPointerInfoMBS.InputData as Integer
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Windows | MBS Win Plugin | 16.2 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop, Console & Web |
When flags indicate kFlagWheel, this value indicates the distance the wheel is rotated, expressed in multiples or factors of WHEEL_DELTA. A positive value indicates that the wheel was rotated forward and a negative value indicates that the wheel was rotated backward.
When flags indicate kFlagWheel, this value indicates the distance the wheel is rotated, expressed in multiples or factors of WHEEL_DELTA. A positive value indicates that the wheel was rotated to the right and a negative value indicates that the wheel was rotated to the left.
(Read only property)
WinPointerInfoMBS.KeyStates as Integer
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Windows | MBS Win Plugin | 16.2 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop, Console & Web |
May be zero or a combination of the following values:
8 | A SHIFT key was pressed. |
4 | A CTRL key was pressed. |
WinPointerInfoMBS.PerformanceCount as Int64
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Windows | MBS Win Plugin | 16.2 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop, Console & Web |
The value can be calibrated when the touch digitizer hardware supports the scan timestamp information in its input report.
(Read only property)
WinPointerInfoMBS.PixelLocationRawX as Integer
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Windows | MBS Win Plugin | 16.2 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop, Console & Web |
For adjusted screen coordinates, see PixelLocation.
(Read only property)
WinPointerInfoMBS.PixelLocationRawY as Integer
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Windows | MBS Win Plugin | 16.2 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop, Console & Web |
For adjusted screen coordinates, see PixelLocation.
(Read only property)
WinPointerInfoMBS.PixelLocationX as Integer
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Windows | MBS Win Plugin | 16.2 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop, Console & Web |
The predicted value is based on the pointer position reported by the digitizer and the motion of the pointer. This correction can compensate for visual lag due to inherent delays in sensing and processing the pointer location on the digitizer. This is applicable to pointers of type touch. For other pointer types, the predicted value will be the same as the non-predicted value (see ptPixelLocationRaw).
(Read only property)
WinPointerInfoMBS.PixelLocationY as Integer
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Windows | MBS Win Plugin | 16.2 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop, Console & Web |
The predicted value is based on the pointer position reported by the digitizer and the motion of the pointer. This correction can compensate for visual lag due to inherent delays in sensing and processing the pointer location on the digitizer. This is applicable to pointers of type touch. For other pointer types, the predicted value will be the same as the non-predicted value (see ptPixelLocationRaw).
(Read only property)
WinPointerInfoMBS.pointerFlags as Integer
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Windows | MBS Win Plugin | 16.2 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop, Console & Web |
See kFlag* constants.
(Read only property)
WinPointerInfoMBS.pointerId as Integer
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Windows | MBS Win Plugin | 16.2 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop, Console & Web |
A pointer comes into existence when it is first detected and ends its existence when it goes out of detection range. Note that if a physical entity (finger or pen) goes out of detection range and then returns to be detected again, it is treated as a new pointer and may be assigned a new pointer identifier.
(Read only property)
WinPointerInfoMBS.pointerType as Integer
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Windows | MBS Win Plugin | 16.2 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop, Console & Web |
See kType* constants.
(Read only property)
WinPointerInfoMBS.sourceDevice as Integer
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Windows | MBS Win Plugin | 16.2 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop, Console & Web |
(Read only property)
WinPointerInfoMBS.Time as Integer
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Windows | MBS Win Plugin | 16.2 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop, Console & Web |
Value is 0 or the time stamp of the message, based on the system tick count when the message was received.
The application can specify the input time stamp in either Time or PerformanceCount. The value cannot be more recent than the current tick count or QueryPerformanceCount (QPC) value of the injection thread. Once a frame is injected with a time stamp, all subsequent frames must include a timestamp until all contacts in the frame go to an UP state. The custom timestamp value must also be provided for the first element in the contacts array. The time stamp values after the first element are ignored. The custom timestamp value must increment in every injection frame.
When PerformanceCount is specified, the time stamp will be converted to the current time in .1 millisecond resolution upon actual injection. If a custom PerformanceCount resulted in the same .1 millisecond window from the previous injection, ERROR_NOT_READY is returned and injection will not occur. While injection will not be invalidated immediately by the error, the next successful injection must have a PerformanceCount value that is at least 0.1 millisecond from the previously successful injection. This is also true if Time is used.
If both Time and PerformanceCount are specified in InjectTouchInput, ERROR_INVALID_PARAMETER is returned.
InjectTouchInput cannot switch between Time and PerformanceCount once injection has started.
If neither Time and PerformanceCount are specified, InjectTouchInput allocates the timestamp based on the timing of the call. If InjectTouchInput calls are repeatedly less than 0.1 millisecond apart, ERROR_NOT_READY might be returned. The error will not invalidate the input immediately, but the injection application needs to retry the same frame again for injection to succeed.
(Read only property)
The items on this page are in the following plugins: MBS Win Plugin.