Difference between revisions of "Unit Touch"

From Ultibo.org
Jump to: navigation, search
Line 253: Line 253:
 
|-
 
|-
 
| <code>Info:LongWord;</code>
 
| <code>Info:LongWord;</code>
| style="width: 50%;"|&nbsp;
+
| Bitmap of touch info values (eg TOUCH_FINGER)
 
|-
 
|-
 
| <code>PointID:Word;</code>
 
| <code>PointID:Word;</code>
| &nbsp;
+
| The touch point ID value for this touch (First ID is 1)
 
|-
 
|-
 
| <code>PositionX:SmallInt;</code>
 
| <code>PositionX:SmallInt;</code>
| &nbsp;
+
| The X position of this touch point
 
|-
 
|-
 
| <code>PositionY:SmallInt;</code>
 
| <code>PositionY:SmallInt;</code>
| &nbsp;
+
| The Y position of this touch point
 
|-
 
|-
| <code>PositionZ:SmallInt;</code>
+
| <code>The Z position of this touch point (If applicable)</code>
 
| &nbsp;
 
| &nbsp;
 +
|-
 +
| <code>TouchWidth:Word;</code>
 +
| The Width of this touch point (If applicable)
 +
|-
 +
| <code>TouchHeight:Word;</code>
 +
| The Height of this touch point (If applicable)
 +
|-
 +
| <code>Parameter:Pointer;</code>
 +
| The parameter for the event callback (If applicable)
 
|-
 
|-
 
|}
 
|}
Line 316: Line 325:
 
|-
 
|-
 
| <code>MaxX:LongWord;</code>
 
| <code>MaxX:LongWord;</code>
| Maximum (absolute) X value for the touch device
+
| Maximum (absolute) X position for the touch device
 
|-
 
|-
 
| <code>MaxY:LongWord;</code>
 
| <code>MaxY:LongWord;</code>
| Maximum (absolute) Y value for the touch device
+
| Maximum (absolute) Y position for the touch device
 
|-
 
|-
 
| <code>MaxZ:LongWord;</code>
 
| <code>MaxZ:LongWord;</code>
| Maximum (absolute) Z value for the touch device
+
| Maximum (absolute) Z position for the touch device (If applicable)
 +
|-
 +
| <code>MaxWidth:LongWord;</code>
 +
| Maximum touch width value for the touch device (If applicable)
 +
|-
 +
| <code>MaxHeight:LongWord;</code>
 +
| Maximum touch height value for the touch device (If applicable)
 
|-
 
|-
 
| <code>MaxPoints:LongWord;</code>
 
| <code>MaxPoints:LongWord;</code>
Line 329: Line 344:
 
|}
 
|}
 
</div></div>  
 
</div></div>  
 +
 +
'''Touch event callback'''
 +
 +
{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
 +
|-
 +
| <code>TTouchEvent = function(Touch:PTouchDevice; Data:PTouchData):LongWord;</code>
 +
| style="width: 40%;"|
 +
|-
 +
|} 
  
 
'''Touch enumeration callback'''
 
'''Touch enumeration callback'''
Line 415: Line 439:
 
{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
 
{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
 
|-
 
|-
| <code>TTouchDeviceControl = function(Touch:PTouchDevice; Request:Integer; Argument1:LongWord; var Argument2:LongWord):LongWord;</code>
+
| <code>TTouchDeviceControl = function(Touch:PTouchDevice; Request:Integer; Argument1:PtrUInt; var Argument2:PtrUInt):LongWord;</code>
 
| style="width: 40%;"|
 
| style="width: 40%;"|
 
|-
 
|-
Line 482: Line 506:
 
| <code>Lock:TMutexHandle;</code>
 
| <code>Lock:TMutexHandle;</code>
 
| Device lock
 
| Device lock
 +
|-
 +
| <code>Event:TTouchEvent;</code>
 +
| Event callback function (If assigned)
 +
|-
 +
| <code>Parameter:Pointer;</code>
 +
| Parameter for the event callback (or nil)
 
|-
 
|-
 
| <code>Buffer:TTouchBuffer;</code>
 
| <code>Buffer:TTouchBuffer;</code>

Revision as of 06:12, 16 November 2022

Return to Unit Reference


Description


Ultibo Touch Interface unit

Constants



[Expand]
Touch specific constants TOUCH_*


[Expand]
Touch device type TOUCH_TYPE_*


[Expand]
Touch device state TOUCH_STATE_*


[Expand]
Touch device flag TOUCH_FLAG_*


[Expand]
Touch device control code TOUCH_CONTROL_*


[Expand]
Touch buffer size TOUCH_BUFFER_*


[Expand]
Touch data definitions TOUCH_FINGER*, TOUCH_ID_*


[Expand]
Touch rotation TOUCH_ROTATION_*


[Expand]
Touch logging TOUCH_LOG_*


Type definitions



Touch data

[Expand]

PTouchData = ^TTouchData;

TTouchData = record

Touch buffer

[Expand]

PTouchBuffer = ^TTouchBuffer;

TTouchBuffer = record

Touch properties

[Expand]

PTouchProperties = ^TTouchProperties;

TTouchProperties = record

Touch event callback

TTouchEvent = function(Touch:PTouchDevice; Data:PTouchData):LongWord;

Touch enumeration callback

TTouchEnumerate = function(Touch:PTouchDevice; Data:Pointer):LongWord;

Touch notification callback

TTouchNotification = function(Device:PDevice; Data:Pointer; Notification:LongWord):LongWord;

Touch device start

TTouchDeviceStart = function(Touch:PTouchDevice):LongWord;

Touch device stop

TTouchDeviceStop = function(Touch:PTouchDevice):LongWord;

Touch device peek

TTouchDevicePeek = function(Touch:PTouchDevice):LongWord;

Touch device read

TTouchDeviceRead = function(Touch:PTouchDevice; Buffer:Pointer; Size,Flags:LongWord; var Count:LongWord):LongWord;

Touch device write

TTouchDeviceWrite = function(Touch:PTouchDevice; Buffer:Pointer; Size,Count:LongWord):LongWord;

Touch device flush

TTouchDeviceFlush = function(Touch:PTouchDevice):LongWord;

Touch device update

TTouchDeviceUpdate = function(Touch:PTouchDevice):LongWord;

Touch device control

TTouchDeviceControl = function(Touch:PTouchDevice; Request:Integer; Argument1:PtrUInt; var Argument2:PtrUInt):LongWord;

Touch device get properties

TTouchDeviceGetProperties = function(Touch:PTouchDevice; Properties:PTouchProperties):LongWord;

Touch device

[Expand]

PTouchDevice = ^TTouchDevice;

TTouchDevice = record


Public variables



Touch logging

TOUCH_DEFAULT_LOG_LEVEL:LongWord = TOUCH_LOG_LEVEL_DEBUG; Minimum level for Touch messages. Only messages with level greater than or equal to this will be printed.
TOUCH_LOG_ENABLED:Boolean;


Function declarations



Initialization functions

[Expand]
procedure TouchInit;
Description: Initialize the Touch unit and Touch device table


Touch functions

[Expand]
function TouchDeviceStart(Touch:PTouchDevice):LongWord;
Description: Start the specified Touch device ready for receiving events


[Expand]
function TouchDeviceStop(Touch:PTouchDevice):LongWord;
Description: Stop the specified Touch device and terminate receiving events


[Expand]
function TouchDevicePeek(Touch:PTouchDevice):LongWord;
Description: Peek at the buffer of the specified touch device to see if any data packets are ready


[Expand]
function TouchDeviceRead(Touch:PTouchDevice; Buffer:Pointer; Size,Flags:LongWord; var Count:LongWord):LongWord;
Description: Read touch data packets from the buffer of the specified touch device


[Expand]
function TouchDeviceWrite(Touch:PTouchDevice; Buffer:Pointer; Size,Count:LongWord):LongWord;
Description: Write touch data packets to the buffer of the specified touch device


[Expand]
function TouchDeviceFlush(Touch:PTouchDevice):LongWord;
Description: Flush the contents of the buffer of the specified touch device


[Expand]
function TouchDeviceUpdate(Touch:PTouchDevice):LongWord;
Description: Request the specified touch device to update the current configuration


[Expand]
function TouchDeviceControl(Touch:PTouchDevice; Request:Integer; Argument1:PtrUInt; var Argument2:PtrUInt):LongWord;
Description: Perform a control request on the specified touch device


[Expand]
function TouchDeviceProperties(Touch:PTouchDevice; Properties:PTouchProperties):LongWord; inline;
Description: Get the properties for the specified Touch device


[Expand]
function TouchDeviceGetProperties(Touch:PTouchDevice;Properties:PTouchProperties):LongWord;
Description: Get the properties for the specified Touch device


[Expand]
function TouchDeviceCreate:PTouchDevice;
Description: Create a new Touch device entry


[Expand]
function TouchDeviceCreateEx(Size:LongWord):PTouchDevice;
Description: Create a new Touch device entry


[Expand]
function TouchDeviceDestroy(Touch:PTouchDevice):LongWord;
Description: Destroy an existing Touch device entry


[Expand]
function TouchDeviceRegister(Touch:PTouchDevice):LongWord;
Description: Register a new Touch device in the Touch device table


[Expand]
function TouchDeviceDeregister(Touch:PTouchDevice):LongWord;
Description: Deregister an Touch device from the Touch device table


[Expand]
function TouchDeviceFind(TouchId:LongWord):PTouchDevice;
Description: Find a Touch device by ID in the Touch device table


[Expand]
function TouchDeviceFindByName(const Name:String):PTouchDevice; inline;
Description: Find a Touch device by name in the device table


[Expand]
function TouchDeviceFindByDescription(const Description:String):PTouchDevice; inline;
Description: Find a Touch device by description in the device table


[Expand]
function TouchDeviceEnumerate(Callback:TTouchEnumerate; Data:Pointer):LongWord;
Description: Enumerate all Touch devices in the Touch device table


[Expand]
function TouchDeviceNotification(Touch:PTouchDevice; Callback:TTouchNotification; Data:Pointer; Notification,Flags:LongWord):LongWord;
Description: Register a notification for Touch device changes


Touch helper functions

[Expand]
function TouchGetCount:LongWord; inline;
Description: Get the current Touch device count


[Expand]
function TouchDeviceGetDefault:PTouchDevice; inline;
Description: Get the current default Touch device


[Expand]
function TouchDeviceSetDefault(Touch:PTouchDevice):LongWord;
Description: Set the current default Touch device


[Expand]
function TouchDeviceCheck(Touch:PTouchDevice):PTouchDevice;
Description: Check if the supplied Touch device is in the Touch device table


[Expand]
function TouchDeviceTypeToString(TouchType:LongWord):String;
Description: Return a string describing the Touch device type (eg TOUCH_TYPE_CAPACITIVE)


[Expand]
function TouchDeviceStateToString(TouchState:LongWord):String;
Description: Return a string describing the Touch device state (eg TOUCH_STATE_ENABLED)


[Expand]
function TouchDeviceRotationToString(Rotation:LongWord):String;
Description: Return a string describing the supplied touch rotation value


[Expand]
function TouchDeviceResolveRotation(ARotation:LongWord):LongWord;
Description: Resolve a value of 0, 90, 180 or 270 to a touch rotation constant (eg TOUCH_ROTATION_180)


[Expand]
function TouchDeviceSetCallback(Touch:PTouchDevice; Event:TTouchEvent; Parameter:Pointer):LongWord;
Description: Set the event callback function for the specified touch device


[Expand]
function TouchInsertData(Touch:PTouchDevice; Data:PTouchData; Signal:Boolean):LongWord;
Description: Insert a TTouchData entry into the touch device buffer


[Expand]
procedure TouchLog(Level:LongWord; Touch:PTouchDevice; const AText:String);
Description: To be documented


[Expand]
procedure TouchLogInfo(Touch:PTouchDevice; const AText:String); inline;
Description: To be documented


[Expand]
procedure TouchLogWarn(Touch:PTouchDevice; const AText:String); inline;
Description: To be documented


[Expand]
procedure TouchLogError(Touch:PTouchDevice; const AText:String); inline;
Description: To be documented


[Expand]
procedure TouchLogDebug(Touch:PTouchDevice; const AText:String); inline;
Description: To be documented


Return to Unit Reference