Unit Touch

Return to Unit Reference

Description

---

To be documented

Constants

---

To be documented

Type definitions

---

To be documented

Public variables

---

To be documented

Function declarations

---

Initialization functions

procedure TouchInit;

Description: Initialize the Touch unit and Touch device table

Note	Called only during system startup

Touch functions

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

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

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

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

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

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

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 (Dependant on request code)
Argument2	The second argument for the operation (Dependant on request code)
Return	ERROR_SUCCESS if completed or another error code on failure

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

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

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

function TouchDeviceDestroy(Touch:PTouchDevice):LongWord;

Description: Destroy an existing Touch device entry

Note	None documented

function TouchDeviceRegister(Touch:PTouchDevice):LongWord;

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

Note	None documented

function TouchDeviceDeregister(Touch:PTouchDevice):LongWord;

Description: Deregister an Touch device from the Touch device table

Note	None documented

function TouchDeviceFind(TouchId:LongWord):PTouchDevice;

Description: To be documented

Note	None documented

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

Description: To be documented

Note	None documented

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

Description: To be documented

Note	None documented

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

Description: To be documented

Note	None documented

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

Description: To be documented

Note	None documented

Touch helper functions

function TouchGetCount:LongWord; inline;

Description: Get the current Touch device count

Note	None documented

function TouchDeviceGetDefault:PTouchDevice; inline;

Description: Get the current default Touch device

Note	None documented

function TouchDeviceSetDefault(Touch:PTouchDevice):LongWord;

Description: Set the current default Touch device

Note	None documented

function TouchDeviceCheck(Touch:PTouchDevice):PTouchDevice;

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

Note	None documented

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

Description: To be documented

Note	None documented

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

Description: To be documented

Note	None documented

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

Description: To be documented

Note	None documented

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

Description: To be documented

Note	None documented

Return to Unit Reference