P/Invoke wrappers for Wintab functions. More...

Public Member Functions
static UInt32	WTInfoA (UInt32 wCategory_I, UInt32 nIndex_I, IntPtr lpOutput_O)
	This function returns global information about the interface in an application-supplied buffer. More...

static P_HCTX	WTOpenA (P_HWND hWnd_I, ref WintabLogContext logContext_I, bool enable_I)
	This function establishes an active context on the tablet. More...

static bool	WTClose (P_HCTX hctx_I)
	This function closes and destroys the tablet context object. More...

static bool	WTEnable (P_HCTX hctx_I, bool enable_I)
	This function enables or disables a tablet context, temporarily turning on or off the processing of packets. More...

static bool	WTOverlap (P_HCTX hctx_I, bool toTop_I)
	This function sends a tablet context to the top or bottom of the order of overlapping tablet contexts. More...

static UInt32	WTQueueSizeGet (P_HCTX hctx_I)
	This function returns the number of packets the context's queue can hold. More...

static bool	WTQueueSizeSet (P_HCTX hctx_I, UInt32 nPkts_I)
	This function attempts to change the context's queue size to the value specified in nPkts_I. More...

static bool	WTPacket (P_HCTX hctx_I, UInt32 pktSerialNum_I, IntPtr pktBuf_O)
	This function fills in the passed pktBuf_O buffer with the context event packet having the specified serial number. More...

static UInt32	WTPacketsGet (P_HCTX hctx_I, UInt32 maxPkts_I, IntPtr pktBuf_O)
	This function copies the next maxPkts_I events from the packet queue of context hCtx to the passed pktBuf_O buffer and removes them from the queue More...

static UInt32	WTDataGet (P_HCTX hctx_I, UInt32 pktIDStart_I, UInt32 pktIDEnd_I, UInt32 maxPkts_I, IntPtr pktBuf_O, ref UInt32 numPkts_O)
	A This function copies all packets with Identifiers between pktIDStart_I and pktIDEnd_I inclusive from the context's queue to the passed buffer and removes them from the queue. More...

static UInt32	WTDataPeek (P_HCTX hctx_I, UInt32 pktIDStart_I, UInt32 pktIDEnd_I, UInt32 maxPkts_I, IntPtr pktBuf_O, ref UInt32 numPkts_O)
	This function copies all packets with serial numbers between pktIDStart_I and pktIDEnd_I inclusive, from the context's queue to the passed buffer without removing them from the queue. More...

static bool	WTQueuePacketsEx (P_HCTX hctx_I, ref UInt32 pktIDOldest_O, ref UInt32 pktIDNewest_O)
	This function returns the identifiers of the oldest and newest packets currently in the queue. More...

static bool	WTExtGet (P_HCTX hctx_I, UInt32 extTag_I, IntPtr extData_O)
	This function retrieves any context-specific data for an extension. More...

static bool	WTExtSet (P_HCTX hctx_I, UInt32 extTag_I, IntPtr extData_I)
	This function sets any context-specific data for an extension. More...

Detailed Description

P/Invoke wrappers for Wintab functions.

See Wintab_v140.doc (Wintab 1.4 spec) and related Wintab documentation for details.

Member Function Documentation

static bool wHiteRabbiT.Common.Wacom.CWintabFuncs.WTClose ( P_HCTX hctx_I )

This function closes and destroys the tablet context object.

Parameters

hctx_I Identifies the context to be closed.

Returns: The function returns a non-zero value if the context was valid and was destroyed. Otherwise, it returns zero.

static UInt32 wHiteRabbiT.Common.Wacom.CWintabFuncs.WTDataGet	(	P_HCTX	hctx_I,
		UInt32	pktIDStart_I,
		UInt32	pktIDEnd_I,
		UInt32	maxPkts_I,
		IntPtr	pktBuf_O,
		ref UInt32	numPkts_O
	)

A This function copies all packets with Identifiers between pktIDStart_I and pktIDEnd_I inclusive from the context's queue to the passed buffer and removes them from the queue.

Parameters

hctx_I	Identifies the context whose packets are being returned.
pktIDStart_I	Identifier of the oldest tablet event to return.
pktIDEnd_I	Identifier of the newest tablet event to return.
maxPkts_I	Specifies the maximum number of packets to return.
pktBuf_O	Buffer to receive the event packets.
numPkts_O	Number of packets actually copied.

Returns: The return value is the total number of packets found in the queue between pktIDStart_I and pktIDEnd_I.

static UInt32 wHiteRabbiT.Common.Wacom.CWintabFuncs.WTDataPeek	(	P_HCTX	hctx_I,
		UInt32	pktIDStart_I,
		UInt32	pktIDEnd_I,
		UInt32	maxPkts_I,
		IntPtr	pktBuf_O,
		ref UInt32	numPkts_O
	)

This function copies all packets with serial numbers between pktIDStart_I and pktIDEnd_I inclusive, from the context's queue to the passed buffer without removing them from the queue.

Parameters

hctx_I	Identifies the context whose packets are being read.
pktIDStart_I	Identifier of the oldest tablet event to return.
pktIDEnd_I	Identifier of the newest tablet event to return.
maxPkts_I	Specifies the maximum number of packets to return.
pktBuf_O	Buffer to receive the event packets.
numPkts_O	Number of packets actually copied.

Returns: The return value is the total number of packets found in the queue between pktIDStart_I and pktIDEnd_I.

static bool wHiteRabbiT.Common.Wacom.CWintabFuncs.WTEnable	(	P_HCTX	hctx_I,
		bool	enable_I
	)

This function enables or disables a tablet context, temporarily turning on or off the processing of packets.

Parameters

hctx_I	Identifies the context to be enabled or disabled.
enable_I	Specifies enabling if non-zero, disabling if zero.

Returns: The function returns true if the enable or disable request was satisfied.

static bool wHiteRabbiT.Common.Wacom.CWintabFuncs.WTExtGet	(	P_HCTX	hctx_I,
		UInt32	extTag_I,
		IntPtr	extData_O
	)

This function retrieves any context-specific data for an extension.

Parameters

hctx_I	Identifies the context whose extension attributes are being retrieved.
extTag_I	Identifies the extension tag for which context-specific data is being retrieved.
extData_O	Points to a buffer to hold retrieved data (WTExtensionProperty).

Returns

static bool wHiteRabbiT.Common.Wacom.CWintabFuncs.WTExtSet	(	P_HCTX	hctx_I,
		UInt32	extTag_I,
		IntPtr	extData_I
	)

This function sets any context-specific data for an extension.

Parameters

hctx_I	Identifies the context whose extension attributes are being modified.
extTag_I	Identifies the extension tag for which context-specific data is being modified.
extData_I	Points to the new data (WTExtensionProperty).

Returns

static UInt32 wHiteRabbiT.Common.Wacom.CWintabFuncs.WTInfoA	(	UInt32	wCategory_I,
		UInt32	nIndex_I,
		IntPtr	lpOutput_O
	)

This function returns global information about the interface in an application-supplied buffer.

Different types of information are specified by different index arguments. Applications use this function to receive information about tablet coordinates, physical dimensions, capabilities, and cursor types.

Parameters

wCategory_I	Identifies the category from which information is being requested.
nIndex_I	Identifies which information is being requested from within the category.
lpOutput_O	Points to a buffer to hold the requested information.

Returns: The return value specifies the size of the returned information in bytes. If the information is not supported, the function returns zero. If a tablet is not physically present, this function always returns zero.

static P_HCTX wHiteRabbiT.Common.Wacom.CWintabFuncs.WTOpenA	(	P_HWND	hWnd_I,
		ref WintabLogContext	logContext_I,
		bool	enable_I
	)

This function establishes an active context on the tablet.

On successful completion of this function, the application may begin receiving tablet events via messages (if they were requested), and may use the handle returned to poll the context, or to perform other context-related functions.

Parameters

hWnd_I	Identifies the window that owns the tablet context, and receives messages from the context.
logContext_I	Points to an application-provided WintabLogContext data structure describing the context to be opened.
enable_I	Specifies whether the new context will immediately begin processing input data.

Returns: The return value identifies the new context. It is NULL if the context is not opened.

static bool wHiteRabbiT.Common.Wacom.CWintabFuncs.WTOverlap	(	P_HCTX	hctx_I,
		bool	toTop_I
	)

This function sends a tablet context to the top or bottom of the order of overlapping tablet contexts.

Parameters

hctx_I	Identifies the context to move within the overlap order.
toTop_I	Specifies sending the context to the top of the overlap order true, or to the bottom if false.

Returns: The function returns true if successful.

static bool wHiteRabbiT.Common.Wacom.CWintabFuncs.WTPacket	(	P_HCTX	hctx_I,
		UInt32	pktSerialNum_I,
		IntPtr	pktBuf_O
	)

This function fills in the passed pktBuf_O buffer with the context event packet having the specified serial number.

The returned packet and any older packets are removed from the context's internal queue.

Parameters

hctx_I	Identifies the context whose packets are being returned.
pktSerialNum_I	Serial number of the tablet event to return.
pktBuf_O	Buffer to receive the event packet.

Returns: The return value is true if the specified packet was found and returned. It is false if the specified packet was not found in the queue.

static UInt32 wHiteRabbiT.Common.Wacom.CWintabFuncs.WTPacketsGet	(	P_HCTX	hctx_I,
		UInt32	maxPkts_I,
		IntPtr	pktBuf_O
	)

This function copies the next maxPkts_I events from the packet queue of context hCtx to the passed pktBuf_O buffer and removes them from the queue

Parameters

hctx_I	Identifies the context whose packets are being returned.
maxPkts_I	Specifies the maximum number of packets to return
pktBuf_O	Buffer to receive the event packets.

Returns: The return value is the number of packets copied in the buffer.

static bool wHiteRabbiT.Common.Wacom.CWintabFuncs.WTQueuePacketsEx	(	P_HCTX	hctx_I,
		ref UInt32	pktIDOldest_O,
		ref UInt32	pktIDNewest_O
	)

This function returns the identifiers of the oldest and newest packets currently in the queue.

Parameters

hctx_I	Identifies the context whose queue is being queried.
pktIDOldest_O	Identifier of the oldest packet in the queue.
pktIDNewest_O	Identifier of the newest packet in the queue.

Returns: This function returns bool if successful.

static UInt32 wHiteRabbiT.Common.Wacom.CWintabFuncs.WTQueueSizeGet ( P_HCTX hctx_I )

This function returns the number of packets the context's queue can hold.

Parameters

hctx_I Identifies the context whose queue size is being returned.

Returns: The number of packets the queue can hold.

static bool wHiteRabbiT.Common.Wacom.CWintabFuncs.WTQueueSizeSet	(	P_HCTX	hctx_I,
		UInt32	nPkts_I
	)

This function attempts to change the context's queue size to the value specified in nPkts_I.

Parameters

hctx_I	Identifies the context whose queue size is being set.
nPkts_I	Specifies the requested queue size.

Returns: The return value is true if the queue size was successfully changed.

The documentation for this class was generated from the following file:

D:/wHiteRabbiT/wHiteRabbiT-sTudio/trunk/Unity_4_5/Assets/WR_wHiteRabbiT-sTudio/WRFramework/Common/Wacom/CWintabFuncs.cs

Public Member Functions

Detailed Description

Member Function Documentation