Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Documentation spelling fixes and unknown param #8201

Merged
merged 2 commits into from
Feb 25, 2024
Merged

Documentation spelling fixes and unknown param #8201

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5a921fa
Fix several documentation typos related to Input
Feb 25, 2024
f8e44de
Remove param documentation from GameWindow.OnTextInput for a param th…
Feb 25, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
1 change: 0 additions & 1 deletion MonoGame.Framework/GameWindow.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -234,7 +234,6 @@ protected void OnScreenDeviceNameChanged ()
/// <summary>
/// Called when the window receives text input. Raises the <see cref="TextInput"/> event.
/// </summary>
/// <param name="sender">The game window.</param>
/// <param name="e">Parameters to the <see cref="TextInput"/> event.</param>
internal void OnTextInput(TextInputEventArgs e)
{
Expand Down
6 changes: 3 additions & 3 deletions MonoGame.Framework/Input/Touch/GestureType.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
namespace Microsoft.Xna.Framework.Input.Touch
{
/// <summary>
/// Enumuration of values that represent different gestures that can be processed by <see cref="TouchPanel.ReadGesture"/>.
/// Enumeration of values that represent different gestures that can be processed by <see cref="TouchPanel.ReadGesture"/>.
/// </summary>
[Flags]
public enum GestureType
Expand Down Expand Up @@ -37,7 +37,7 @@ public enum GestureType
/// <summary>
/// The user touched a single point for approximately one second.
/// </summary>
/// <remarks>As this is a single event, it will not be contionusly fired while the user is holding the touch-point.</remarks>
/// <remarks>As this is a single event, it will not be continuously fired while the user is holding the touch-point.</remarks>
Hold = 16,
/// <summary>
/// The user touched the screen and performed either left to right or right to left drag gesture.
Expand All @@ -56,7 +56,7 @@ public enum GestureType
/// <summary>
/// The user tapped the device twice which is always preceded by a Tap gesture.
/// </summary>
/// <remarks>If the time between two touchs are long enough, insted two seperate single Tap gestures will be generated.</remarks>
/// <remarks>If the time between two touches are long enough, instead two separate single Tap gestures will be generated.</remarks>
DoubleTap = 256,
/// <summary>
/// The user touched the screen and performed either top to bottom or bottom to top drag gesture.
Expand Down
4 changes: 2 additions & 2 deletions MonoGame.Framework/Platform/WindowsUniversal/InputEvents.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ public InputEvents(CoreWindow window, UIElement inputElement, TouchQueue touchQu

if (inputElement is SwapChainPanel || inputElement is SwapChainBackgroundPanel)
{
// Create a thread to precess input events.
// Create a thread to process input events.
var workItemHandler = new WorkItemHandler((action) =>
{
var inputDevices = CoreInputDeviceTypes.Mouse | CoreInputDeviceTypes.Pen | CoreInputDeviceTypes.Touch;
Expand Down Expand Up @@ -281,7 +281,7 @@ internal static Keys KeyTranslate(Windows.System.VirtualKey inkey, CorePhysicalK
// we can detect right shift by checking the scancode value.
// left shift is 0x2A, right shift is 0x36. IsExtendedKey is always false.
return (keyStatus.ScanCode == 0x36) ? Keys.RightShift : Keys.LeftShift;
// Note that the Alt key is now refered to as Menu.
// Note that the Alt key is now referred to as Menu.
// ALT key doesn't get fired by KeyUp/KeyDown events.
// One solution could be to check CoreWindow.GetKeyState(...) on every tick.
case Windows.System.VirtualKey.Menu:
Expand Down