vitasdk
Documentation of the vitasdk

Exports for User. More...

Data Structures

struct  SceTouchPanelInfo
 
struct  SceTouchReport
 
struct  SceTouchData
 

Macros

#define SCE_TOUCH_MAX_REPORT   8
 FIXME 6 on front | 4 on back.
 

Enumerations

enum  SceTouchErrorCode { SCE_TOUCH_ERROR_INVALID_ARG = 0x80350001 , SCE_TOUCH_ERROR_PRIV_REQUIRED = 0x80350002 , SCE_TOUCH_ERROR_FATAL = 0x803500FF }
 Touch error codes. More...
 
enum  SceTouchPortType { SCE_TOUCH_PORT_FRONT = 0 , SCE_TOUCH_PORT_BACK = 1 , SCE_TOUCH_PORT_MAX_NUM = 2 }
 Port numbers of touch panels. More...
 
enum  SceTouchSamplingState { SCE_TOUCH_SAMPLING_STATE_STOP = 0 , SCE_TOUCH_SAMPLING_STATE_START = 1 }
 Sampling port setting of the touch panel. More...
 
enum  SceTouchReportInfo { SCE_TOUCH_REPORT_INFO_HIDE_UPPER_LAYER = 0x0001 }
 Info field of SceTouchReport structure. More...
 

Functions

 VITASDK_BUILD_ASSERT_EQ (0x30, SceTouchPanelInfo)
 
 VITASDK_BUILD_ASSERT_EQ (0x10, SceTouchReport)
 
 VITASDK_BUILD_ASSERT_EQ (0x90, SceTouchData)
 
int sceTouchGetPanelInfo (SceUInt32 port, SceTouchPanelInfo *pPanelInfo)
 Get Touch Panel information.
 
int sceTouchRead (SceUInt32 port, SceTouchData *pData, SceUInt32 nBufs)
 Get touch data (Blocking)
 
int sceTouchPeek (SceUInt32 port, SceTouchData *pData, SceUInt32 nBufs)
 Get touch data (Polling)
 
int sceTouchSetSamplingState (SceUInt32 port, SceTouchSamplingState state)
 Set sampling state of touch panel.
 
int sceTouchGetSamplingState (SceUInt32 port, SceTouchSamplingState *pState)
 Get sampling state of touch panel.
 
int sceTouchEnableTouchForce (SceUInt32 port)
 Enable touch force output.
 
int sceTouchDisableTouchForce (SceUInt32 port)
 Disable touch force output.
 
int sceTouchGetDeviceInfo (SceUInt32 port_type, SceTouchDeviceInfo *info)
 Get touch-panel device information.
 

Variables

SceInt16 SceTouchPanelInfo::minAaX
 Min active area X position.
 
SceInt16 SceTouchPanelInfo::minAaY
 Min active area Y position.
 
SceInt16 SceTouchPanelInfo::maxAaX
 Max active area X position.
 
SceInt16 SceTouchPanelInfo::maxAaY
 Max active area Y position.
 
SceInt16 SceTouchPanelInfo::minDispX
 Min display X origin (top left)
 
SceInt16 SceTouchPanelInfo::minDispY
 Min display Y origin (top left)
 
SceInt16 SceTouchPanelInfo::maxDispX
 Max display X origin (bottom right)
 
SceInt16 SceTouchPanelInfo::maxDispY
 Max display Y origin (bottom right)
 
SceUInt8 SceTouchPanelInfo::minForce
 Min touch force value.
 
SceUInt8 SceTouchPanelInfo::maxForce
 Max touch force value.
 
SceUInt8 SceTouchPanelInfo::reserved [30]
 Reserved.
 
SceUInt8 SceTouchReport::id
 Touch ID.
 
SceUInt8 SceTouchReport::force
 Touch force.
 
SceInt16 SceTouchReport::x
 X position.
 
SceInt16 SceTouchReport::y
 Y position.
 
SceUInt8 SceTouchReport::reserved [8]
 Reserved.
 
SceUInt16 SceTouchReport::info
 Information of this touch.
 
SceUInt64 SceTouchData::timeStamp
 Data timestamp.
 
SceUInt32 SceTouchData::status
 Unused.
 
SceUInt32 SceTouchData::reportNum
 Number of touch reports.
 
SceTouchReport SceTouchData::report [SCE_TOUCH_MAX_REPORT]
 Touch reports.
 

Detailed Description

Exports for User.


Using this library in your project

Include the header file in your project:

#include <psp2/touch.h>


Link the library to the executable:

SceTouch_stub




Data Structure Documentation

◆ SceTouchPanelInfo

struct SceTouchPanelInfo
Data Fields
SceInt16 minAaX Min active area X position.
SceInt16 minAaY Min active area Y position.
SceInt16 maxAaX Max active area X position.
SceInt16 maxAaY Max active area Y position.
SceInt16 minDispX Min display X origin (top left)
SceInt16 minDispY Min display Y origin (top left)
SceInt16 maxDispX Max display X origin (bottom right)
SceInt16 maxDispY Max display Y origin (bottom right)
SceUInt8 minForce Min touch force value.
SceUInt8 maxForce Max touch force value.
SceUInt8 reserved[30] Reserved.

◆ SceTouchReport

struct SceTouchReport
Data Fields
SceUInt8 id Touch ID.
SceUInt8 force Touch force.
SceInt16 x X position.
SceInt16 y Y position.
SceUInt8 reserved[8] Reserved.
SceUInt16 info Information of this touch.

◆ SceTouchData

struct SceTouchData
Data Fields
SceUInt64 timeStamp Data timestamp.
SceUInt32 status Unused.
SceUInt32 reportNum Number of touch reports.
SceTouchReport report[SCE_TOUCH_MAX_REPORT] Touch reports.

Macro Definition Documentation

◆ SCE_TOUCH_MAX_REPORT

#define SCE_TOUCH_MAX_REPORT   8

FIXME 6 on front | 4 on back.

Enumeration Type Documentation

◆ SceTouchErrorCode

Touch error codes.

Enumerator
SCE_TOUCH_ERROR_INVALID_ARG 
SCE_TOUCH_ERROR_PRIV_REQUIRED 
SCE_TOUCH_ERROR_FATAL 

◆ SceTouchPortType

Port numbers of touch panels.

See also
sceTouchRead
sceTouchPeek
Enumerator
SCE_TOUCH_PORT_FRONT 

Front touch panel id.

SCE_TOUCH_PORT_BACK 

Back touch panel id.

SCE_TOUCH_PORT_MAX_NUM 

Number of touch panels.

◆ SceTouchSamplingState

Sampling port setting of the touch panel.

See also
sceTouchSetSamplingState
Enumerator
SCE_TOUCH_SAMPLING_STATE_STOP 
SCE_TOUCH_SAMPLING_STATE_START 

◆ SceTouchReportInfo

Info field of SceTouchReport structure.

See also
SceTouchReport
Enumerator
SCE_TOUCH_REPORT_INFO_HIDE_UPPER_LAYER 

Function Documentation

◆ VITASDK_BUILD_ASSERT_EQ() [1/3]

VITASDK_BUILD_ASSERT_EQ ( 0x30  ,
SceTouchPanelInfo   
)

◆ VITASDK_BUILD_ASSERT_EQ() [2/3]

VITASDK_BUILD_ASSERT_EQ ( 0x10  ,
SceTouchReport   
)

◆ VITASDK_BUILD_ASSERT_EQ() [3/3]

VITASDK_BUILD_ASSERT_EQ ( 0x90  ,
SceTouchData   
)

◆ sceTouchGetPanelInfo()

int sceTouchGetPanelInfo ( SceUInt32  port,
SceTouchPanelInfo *  pPanelInfo 
)

Get Touch Panel information.

Parameters
[in]portPort number.
[out]pPanelInfoThe buffer to get the Touch Panel information.

◆ sceTouchRead()

int sceTouchRead ( SceUInt32  port,
SceTouchData *  pData,
SceUInt32  nBufs 
)

Get touch data (Blocking)

Parameters
[in]portPort Number.
[out]pDataBuffer to receive touch data.
[in]nBufsNumber of buffers to receive touch data.
Returns
Buffers count, between 1 and 'nBufs'. <0 on error.

◆ sceTouchPeek()

int sceTouchPeek ( SceUInt32  port,
SceTouchData *  pData,
SceUInt32  nBufs 
)

Get touch data (Polling)

Parameters
[in]portport number.
[out]pDataBuffer to receive touch data.
[in]nBufsNumber of buffers to receive touch data.
Returns
Buffers count, between 1 and 'nBufs'. <0 on error.

◆ sceTouchSetSamplingState()

int sceTouchSetSamplingState ( SceUInt32  port,
SceTouchSamplingState  state 
)

Set sampling state of touch panel.

Parameters
[in]portPort number.
[in]stateSampling state.

◆ sceTouchGetSamplingState()

int sceTouchGetSamplingState ( SceUInt32  port,
SceTouchSamplingState *  pState 
)

Get sampling state of touch panel.

Parameters
[in]portPort number.
[out]pStateThe buffer to receive sampling state.

◆ sceTouchEnableTouchForce()

int sceTouchEnableTouchForce ( SceUInt32  port)

Enable touch force output.

Parameters
[in]portPort number.

◆ sceTouchDisableTouchForce()

int sceTouchDisableTouchForce ( SceUInt32  port)

Disable touch force output.

Parameters
[in]portPort number.

◆ sceTouchGetDeviceInfo()

int sceTouchGetDeviceInfo ( SceUInt32  port_type,
SceTouchDeviceInfo *  info 
)

Get touch-panel device information.

Only system programs can call this function. It retrieves the cached front or back panel identity record. The output is copied only after the kernel getter succeeds.

Parameters
[in]port_type- One of SceTouchPortType.
[out]info- Receives the complete 0xC-byte device-information record.
Returns
0 on success, SCE_TOUCH_ERROR_INVALID_ARG for an invalid port_type, SCE_TOUCH_ERROR_PRIV_REQUIRED when the caller is not a system program, or a kernel user-memory-copy error for an invalid info.

Variable Documentation

◆ minAaX

SceInt16 SceTouchPanelInfo::minAaX

Min active area X position.

◆ minAaY

SceInt16 SceTouchPanelInfo::minAaY

Min active area Y position.

◆ maxAaX

SceInt16 SceTouchPanelInfo::maxAaX

Max active area X position.

◆ maxAaY

SceInt16 SceTouchPanelInfo::maxAaY

Max active area Y position.

◆ minDispX

SceInt16 SceTouchPanelInfo::minDispX

Min display X origin (top left)

◆ minDispY

SceInt16 SceTouchPanelInfo::minDispY

Min display Y origin (top left)

◆ maxDispX

SceInt16 SceTouchPanelInfo::maxDispX

Max display X origin (bottom right)

◆ maxDispY

SceInt16 SceTouchPanelInfo::maxDispY

Max display Y origin (bottom right)

◆ minForce

SceUInt8 SceTouchPanelInfo::minForce

Min touch force value.

◆ maxForce

SceUInt8 SceTouchPanelInfo::maxForce

Max touch force value.

◆ reserved [1/2]

SceUInt8 SceTouchPanelInfo::reserved[30]

Reserved.

◆ id

SceUInt8 SceTouchReport::id

Touch ID.

◆ force

SceUInt8 SceTouchReport::force

Touch force.

◆ x

SceInt16 SceTouchReport::x

X position.

◆ y

SceInt16 SceTouchReport::y

Y position.

◆ reserved [2/2]

SceUInt8 SceTouchReport::reserved[8]

Reserved.

◆ info

SceUInt16 SceTouchReport::info

Information of this touch.

◆ timeStamp

SceUInt64 SceTouchData::timeStamp

Data timestamp.

◆ status

SceUInt32 SceTouchData::status

Unused.

◆ reportNum

SceUInt32 SceTouchData::reportNum

Number of touch reports.

◆ report

SceTouchReport SceTouchData::report[SCE_TOUCH_MAX_REPORT]

Touch reports.