Unit Touch

Return to Unit Reference

Description

---

Ultibo Touch interface unit

To be documented

Constants

---

[Expand]

Touch specific constants TOUCH_*

TOUCH_NAME_PREFIX = 'Touch';

Name prefix for Touch Devices

[Expand]

Touch device type constants TOUCH_TYPE_*

TOUCH_TYPE_NONE = 0;
TOUCH_TYPE_RESISTIVE = 1;
TOUCH_TYPE_CAPACITIVE = 2;

[Expand]

Touch device state constants TOUCH_STATE_*

TOUCH_STATE_DISABLED = 0;
TOUCH_STATE_ENABLED = 1;

[Expand]

Touch device flag constants TOUCH_FLAG_*

TOUCH_FLAG_NONE = $00000000;
TOUCH_FLAG_NON_BLOCK = $00000001;	If set device reads are non blocking (Also supported in Flags parameter of TouchDeviceRead)
TOUCH_FLAG_PEEK_BUFFER = $00000002;	Peek at the buffer to see if any data is available, don't remove it (Used only in Flags parameter of TouchDeviceRead)
TOUCH_FLAG_MOUSE_DATA = $00000004;	If set the device will write a mouse data event for each touch event
TOUCH_FLAG_MULTI_POINT = $00000008;	If set the device supports multi point touch
TOUCH_FLAG_PRESSURE = $00000010;	If set the device supports pressure value on touch points
Flags supported by TOUCH_CONTROL_GET/SET/CLEAR_FLAG
TOUCH_FLAG_MASK = TOUCH_FLAG_NON_BLOCK or TOUCH_FLAG_MOUSE_DATA or TOUCH_FLAG_MULTI_POINT or TOUCH_FLAG_PRESSURE;

[Expand]

Touch device control code constants TOUCH_CONTROL_*

TOUCH_CONTROL_GET_FLAG = 1;	Get Flag
TOUCH_CONTROL_SET_FLAG = 2;	Set Flag
TOUCH_CONTROL_CLEAR_FLAG = 3;	Clear Flag
TOUCH_CONTROL_FLUSH_BUFFER = 4;	Flush Buffer

[Expand]

Touch buffer size constants TOUCH_BUFFER_*

TOUCH_BUFFER_SIZE = 1024;

[Expand]

Touch data definitions constants TOUCH_FINGER*, TOUCH_ID_*

Values for TTouchData.Info
TOUCH_FINGER = $00000001;	A finger is pressed at this touch point
Values for TTouchData.PointID
TOUCH_ID_UNKNOWN = Word(-1);
Values for TTouchData.PositionX
TOUCH_X_UNKNOWN = -1;
Values for TTouchData.PositionY
TOUCH_Y_UNKNOWN = -1;
Values for TTouchData.PositionZ
TOUCH_Z_UNKNOWN = -1;

[Expand]

Touch rotation constants TOUCH_ROTATION_*

TOUCH_ROTATION_0 = FRAMEBUFFER_ROTATION_0;	No rotation
TOUCH_ROTATION_90 = FRAMEBUFFER_ROTATION_90;	90 degree rotation
TOUCH_ROTATION_180 = FRAMEBUFFER_ROTATION_180;	180 degree rotation
TOUCH_ROTATION_270 = FRAMEBUFFER_ROTATION_270;	270 degree rotation

[Expand]

Touch logging constants TOUCH_LOG_*

TOUCH_LOG_LEVEL_DEBUG = LOG_LEVEL_DEBUG;	Touch debugging messages
TOUCH_LOG_LEVEL_INFO = LOG_LEVEL_INFO;	Touch informational messages, such as a device being attached or detached
TOUCH_LOG_LEVEL_ERROR = LOG_LEVEL_ERROR;	Touch error messages
TOUCH_LOG_LEVEL_NONE = LOG_LEVEL_NONE;	No Touch messages

Type definitions

---

To be documented

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

Note	Called only during system startup

Touch functions

[Expand]

function TouchDeviceStart(Touch:PTouchDevice):LongWord;

Description: Start the specified Touch device ready for receiving events

Touch	The Touch device to start
Return	ERROR_SUCCESS if completed or another error code on failure

[Expand]

function TouchDeviceStop(Touch:PTouchDevice):LongWord;

Description: Stop the specified Touch device and terminate receiving events

Touch	The Touch device to stop
Return	ERROR_SUCCESS if completed or another error code on failure

[Expand]

function TouchDevicePeek(Touch:PTouchDevice):LongWord;

Description: Peek at the buffer of the specified touch device to see if any data packets are ready

Touch	The Touch device to peek at
Return	ERROR_SUCCESS if packets are ready, ERROR_NO_MORE_ITEMS if not or another error code on failure

[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

Touch	The Touch device to read from
Buffer	Pointer to a buffer to copy the touch data packets to
Size	The size of the buffer in bytes (Must be at least TTouchData or greater)
Flags	The flags for the behaviour of the read (eg TOUCH_FLAG_NON_BLOCK)
Count	The number of touch data packets copied to the buffer
Return	ERROR_SUCCESS if completed or another error code on failure

[Expand]

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

Description: Write touch data packets to the buffer of the specified touch device

Touch	The Touch device to write to
Buffer	Pointer to a buffer to copy the touch data packets from
Size	The size of the buffer in bytes (Must be at least TTouchData or greater)
Count	The number of touch data packets to copy from the buffer
Return	ERROR_SUCCESS if completed or another error code on failure

[Expand]

function TouchDeviceFlush(Touch:PTouchDevice):LongWord;

Description: Flush the contents of the buffer of the specified touch device

Touch	The Touch device to flush
Return	ERROR_SUCCESS if completed or another error code on failure

[Expand]

function TouchDeviceControl(Touch:PTouchDevice; Request:Integer; Argument1:LongWord; var Argument2:LongWord):LongWord;

Description: Perform a control request on the specified touch device

Touch	The Touch device to control
Request	The request code for the operation (eg TOUCH_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

[Expand]

function TouchDeviceProperties(Touch:PTouchDevice; Properties:PTouchProperties):LongWord;

Description: Get the properties for the specified Touch device

Touch	The Touch device to get properties from
Properties	Pointer to a TTouchProperties structure to fill in
Return	ERROR_SUCCESS if completed or another error code on failure

[Expand]

function TouchDeviceCreate:PTouchDevice;

Description: Create a new Touch device entry

Return	Pointer to new Touch device entry or nil if Touch device could not be created

[Expand]

function TouchDeviceCreateEx(Size:LongWord):PTouchDevice;

Description: Create a new Touch device entry

Size	Size in bytes to allocate for new Touch device (Including the Touch device entry)
Return	Pointer to new Touch device entry or nil if Touch device could not be created

[Expand]

function TouchDeviceDestroy(Touch:PTouchDevice):LongWord;

Description: Destroy an existing Touch device entry

Note	None documented

[Expand]

function TouchDeviceRegister(Touch:PTouchDevice):LongWord;

Description: Register a new Touch device in the Touch device table

Note	None documented

[Expand]

function TouchDeviceDeregister(Touch:PTouchDevice):LongWord;

Description: Deregister an Touch device from the Touch device table

Note	None documented

[Expand]

function TouchDeviceFind(TouchId:LongWord):PTouchDevice;

Description: To be documented

Note	None documented

[Expand]

function TouchDeviceFindByName(const Name:String):PTouchDevice; inline;

Description: To be documented

Note	None documented

[Expand]

function TouchDeviceFindByDescription(const Description:String):PTouchDevice; inline;

Description: To be documented

Note	None documented

[Expand]

function TouchDeviceEnumerate(Callback:TTouchEnumerate; Data:Pointer):LongWord;

Description: To be documented

Note	None documented

[Expand]

function TouchDeviceNotification(Touch:PTouchDevice; Callback:TTouchNotification; Data:Pointer; Notification,Flags:LongWord):LongWord;

Description: To be documented

Note	None documented

Touch helper functions

[Expand]

function TouchGetCount:LongWord; inline;

Description: Get the current Touch device count

Note	None documented

[Expand]

function TouchDeviceGetDefault:PTouchDevice; inline;

Description: Get the current default Touch device

Note	None documented

[Expand]

function TouchDeviceSetDefault(Touch:PTouchDevice):LongWord;

Description: Set the current default Touch device

Note	None documented

[Expand]

function TouchDeviceCheck(Touch:PTouchDevice):PTouchDevice;

Description: Check if the supplied Touch device is in the Touch device table

Note	None documented

[Expand]

procedure TouchLog(Level:LongWord; Touch:PTouchDevice; const AText:String);

Description: To be documented

Note	None documented

[Expand]

procedure TouchLogInfo(Touch:PTouchDevice; const AText:String); inline;

Description: To be documented

Note	None documented

[Expand]

procedure TouchLogError(Touch:PTouchDevice; const AText:String); inline;

Description: To be documented

Note	None documented

[Expand]

procedure TouchLogDebug(Touch:PTouchDevice; const AText:String); inline;

Description: To be documented

Note	None documented

Return to Unit Reference