External/pspsdk
1
0
Fork 0
mirror of https://github.com/pspdev/pspsdk.git synced 2025-10-04 17:09:09 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #55 from Felix-Dev/patch-1

Browse Source 
pspctrl.h: Fix PspCtrlButtons link and newline attempt for Doxygen output
This commit is contained in:
Paul Sajna
2021-04-05 13:57:37 -07:00
committed by GitHub
parent 939ffe27f4 312cd74a50
commit 1d32cbfe04
1 changed files with 6 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
src/ctrl/pspctrl.h
View File

@@ -109,22 +109,22 @@ typedef struct SceCtrlData {
* states for each button: * states for each button:
* *
* • [make]: The button has just been pressed with its prior state being the released state. Transition from * • [make]: The button has just been pressed with its prior state being the released state. Transition from
* 'released' state to 'pressed' state. * 'released' state to 'pressed' state.\n
* • [press]: The button is currently in the 'pressed' state. * • [press]: The button is currently in the 'pressed' state.\n
* • [break]: The button has just been released with its prior state being the 'pressed' state. Transition from * • [break]: The button has just been released with its prior state being the 'pressed' state. Transition from
* 'pressed' state to 'release' state. * 'pressed' state to 'release' state.\n
* • [release]: The button is currently in the 'released' state. * • [release]: The button is currently in the 'released' state.
* *
* It is possible for a button to (briefly) be in two states at the same time. Valid combinations are as follows: * It is possible for a button to (briefly) be in two states at the same time. Valid combinations are as follows:
* *
* • [make] & [press] * • [make] & [press]\n
* • [break] & [release] * • [break] & [release]
* *
* In other words, if a button is in the [make] state, then it is also in the [press] state. However, this is not the case * In other words, if a button is in the [make] state, then it is also in the [press] state. However, this is not the case
* for the inverse. A button in the [press] state does not need to be in the [make] state. * for the inverse. A button in the [press] state does not need to be in the [make] state.
* *
* These comparison results are stored internally as latch data and can be retrieved using the APIs ::sceCtrlPeekLatch() and * These comparison results are stored internally as latch data and can be retrieved using the APIs ::sceCtrlPeekLatch() and
* ::sceCtrlReadLatch(). ::SceCtrlPadButtons can be used to find out the state of each button. * ::sceCtrlReadLatch(). ::PspCtrlButtons can be used to find out the state of each button.
* *
* @remark The same can be accomplished by using the different sceCtrl[Read/Peek]Buffer[Positive/Negative]() APIs * @remark The same can be accomplished by using the different sceCtrl[Read/Peek]Buffer[Positive/Negative]() APIs
* and comparing the currently collected button sampling data with the previously collected one. * and comparing the currently collected button sampling data with the previously collected one.