public enum PlatformEventKindWhat a PlatformEvent is, and therefore which of its payloads is real.
No guide page documents this yet — the page shows what the code says about itself.
Fields and properties (37)
NoneThe default value, which is never enqueued. A PlatformEvent that reads as this one was not initialised.
WindowShownThe window became visible.
WindowHiddenThe window stopped being visible.
WindowMovedThe window moved. Position is its new top-left in desktop coordinates.
WindowResizedThe window's client area changed size. Size is the new size in logical points; PixelSize is the new framebuffer size.
WindowFocusGainedThe window gained keyboard focus.
WindowFocusLostThe window lost keyboard focus.
WindowMinimisedThe window was minimised. Rendering to it is wasted work until it is restored.
WindowMaximisedThe window was maximised.
WindowRestoredThe window returned to its normal state from minimised or maximised.
WindowCloseRequestedSomebody asked for the window to close — the title-bar button, Alt+F4, the dock.
WindowDpiChangedThe window's scale factor changed — it was dragged to a display with a different DPI, or the display's scale was changed under it.
WindowMouseEnteredThe pointer entered the window's client area.
WindowMouseLeftThe pointer left the window's client area.
KeyDownA key went down. IsRepeat distinguishes auto-repeat.
KeyUpA key came up.
TextInputCommitted text. Text is what the user actually typed, after the layout, dead keys and any IME have had their say.
TextEditingIn-progress IME composition. Text is the pre-edit string, SelectionStart and SelectionLength the composition cursor within it.
MouseMovedThe pointer moved. Position is window-relative; Delta is the movement since the last event.
MouseButtonDownA mouse button went down. ClickCount is 2 for the second click of a double-click, as the OS defines one.
MouseButtonUpA mouse button came up.
MouseWheelThe wheel turned, or a trackpad scrolled. Delta is in wheel notches, positive up and right.
TouchDownA finger touched down. DeviceId identifies the finger for as long as it stays down.
TouchMovedA finger moved.
TouchUpA finger lifted.
GamepadConnectedA gamepad was plugged in. DeviceId is its id.
GamepadDisconnectedA gamepad was unplugged. Its id is not reused for a different device.
GamepadButtonDownA gamepad button went down.
GamepadButtonUpA gamepad button came up.
GamepadAxisMovedA gamepad axis moved. Value is the new position.
DisplaysChangedA display was added, removed, or had its mode or scale changed. Anything cached from IDisplayInfo is stale.
SuspendingThe process is about to be suspended. Save now; there may be no later.
ResumedThe process resumed. On Android the graphics surface has been destroyed and recreated, so the swapchain is invalid whatever it claims.
LowMemoryThe OS is under memory pressure and would like some back.
QuitThe application was asked to quit — the last window closed, a signal arrived, the dock's quit item was used.
DropFileA file was dropped on a window. Text is its native path, not a virtual one — it comes from outside anything the engine has mounted.
DropTextText was dropped on a window.
Used by (28)
- PbrShowcaseGamePbrShowcase
- TriangleGameHelloTriangle
- UiHostHelloUi
- VideoGameVideoPlayback
- VirtualGeometryGameVirtualGeometry
- DesktopLifecycleVixen.Platform.Desktop
- DesktopPlatformVixen.Platform.Desktop
- DesktopPlatformTestsVixen.Platform.Desktop.Tests
- HeadlessLifecycleVixen.Platform.Headless
- HeadlessLifecycleTestsVixen.Platform.Headless.Tests
- HeadlessPlatformVixen.Platform.Headless
- HeadlessPlatformTestsVixen.Platform.Headless.Tests
- HeadlessWindowVixen.Platform.Headless
- MobileLifecycleVixen.Platform
- MobileLifecycleTestsVixen.Platform.Tests
- PlatformEventVixen.Platform
- PlatformEventBufferTestsVixen.Platform.Tests
- PlatformEventTestsVixen.Platform.Tests
- PlatformInputVixen.App.Hosting
- PlatformInputVixen.Platform.Ui
- PlatformWindowHostVixen.Platform.Ui
- PlatformWindowHostTestsVixen.Platform.Ui.Tests
- VixenApplicationVixen.App.Hosting
- EditorHostVixen.Editor.Host
- InterceptingGameVixen.App.Tests
- PlatformInputTestsVixen.App.Tests
- PostingGameVixen.App.Tests
- VixenApplicationTestsVixen.App.Tests