Update POV documentation with examples of POV angles

Change-Id: If0f5b75366785b94a97b02694667fc00f8bfe196
This commit is contained in:
Joe Ross
2016-03-19 13:51:42 -07:00
parent 16343bbe71
commit 1e14403b3b
2 changed files with 8 additions and 2 deletions

View File

@@ -206,7 +206,10 @@ bool Joystick::GetRawButton(uint32_t button) const {
}
/**
* Get the state of a POV on the joystick.
* Get the angle in degrees of a POV on the joystick.
*
* The POV angles start at 0 in the up direction, and increase
* clockwise (eg right is 90, upper-left is 315).
*
* @param pov The index of the POV to read (starting at 0)
* @return the angle of the POV in degrees, or -1 if the POV is not pressed.