ryujinx-backup/Opentk
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Merge pull request #581 from Nihlus/correct-xml-comment

Browse source 
Corrected XML comments to reflect now removed JoystickAxis enumeration.
This commit is contained in:
Jarl Gullberg 2017-07-20 13:41:53 +02:00 committed by GitHub
commit ef96e7ab15
1 changed files with 3 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
src/OpenTK/Input/JoystickState.cs
View file

@ -52,14 +52,14 @@ namespace OpenTK.Input
private JoystickHatState hat3;
/// <summary>
/// Gets a value between -1.0 and 1.0 representing the current offset of the specified <see cref="JoystickAxis"/>.
/// Gets a value between -1.0 and 1.0 representing the current offset of the specified axis.
/// </summary>
/// <returns>
/// A value between -1.0 and 1.0 representing offset of the specified <see cref="JoystickAxis"/>.
/// A value between -1.0 and 1.0 representing offset of the specified axis.
/// If the specified axis does not exist, then the return value is 0.0. Use <see cref="Joystick.GetCapabilities"/>
/// to query the number of available axes.
/// </returns>
/// <param name="axis">The <see cref="JoystickAxis"/> to query.</param>
/// <param name="axis">The axis to query.</param>
public float GetAxis(int axis)
{
return GetAxisRaw(axis) * ConversionFactor;