Vixen
02b45cc4
csharp
public enum PlatformEventKind

What 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)

  • None

    The default value, which is never enqueued. A PlatformEvent that reads as this one was not initialised.

  • WindowShown

    The window became visible.

  • WindowHidden

    The window stopped being visible.

  • WindowMoved

    The window moved. Position is its new top-left in desktop coordinates.

  • WindowResized

    The window's client area changed size. Size is the new size in logical points; PixelSize is the new framebuffer size.

  • WindowFocusGained

    The window gained keyboard focus.

  • WindowFocusLost

    The window lost keyboard focus.

  • WindowMinimised

    The window was minimised. Rendering to it is wasted work until it is restored.

  • WindowMaximised

    The window was maximised.

  • WindowRestored

    The window returned to its normal state from minimised or maximised.

  • WindowCloseRequested

    Somebody asked for the window to close — the title-bar button, Alt+F4, the dock.

  • WindowDpiChanged

    The window's scale factor changed — it was dragged to a display with a different DPI, or the display's scale was changed under it.

  • WindowMouseEntered

    The pointer entered the window's client area.

  • WindowMouseLeft

    The pointer left the window's client area.

  • KeyDown

    A key went down. IsRepeat distinguishes auto-repeat.

  • KeyUp

    A key came up.

  • TextInput

    Committed text. Text is what the user actually typed, after the layout, dead keys and any IME have had their say.

  • TextEditing

    In-progress IME composition. Text is the pre-edit string, SelectionStart and SelectionLength the composition cursor within it.

  • MouseMoved

    The pointer moved. Position is window-relative; Delta is the movement since the last event.

  • MouseButtonDown

    A mouse button went down. ClickCount is 2 for the second click of a double-click, as the OS defines one.

  • MouseButtonUp

    A mouse button came up.

  • MouseWheel

    The wheel turned, or a trackpad scrolled. Delta is in wheel notches, positive up and right.

  • TouchDown

    A finger touched down. DeviceId identifies the finger for as long as it stays down.

  • TouchMoved

    A finger moved.

  • TouchUp

    A finger lifted.

  • GamepadConnected

    A gamepad was plugged in. DeviceId is its id.

  • GamepadDisconnected

    A gamepad was unplugged. Its id is not reused for a different device.

  • GamepadButtonDown

    A gamepad button went down.

  • GamepadButtonUp

    A gamepad button came up.

  • GamepadAxisMoved

    A gamepad axis moved. Value is the new position.

  • DisplaysChanged

    A display was added, removed, or had its mode or scale changed. Anything cached from IDisplayInfo is stale.

  • Suspending

    The process is about to be suspended. Save now; there may be no later.

  • Resumed

    The process resumed. On Android the graphics surface has been destroyed and recreated, so the swapchain is invalid whatever it claims.

  • LowMemory

    The OS is under memory pressure and would like some back.

  • Quit

    The application was asked to quit — the last window closed, a signal arrived, the dock's quit item was used.

  • DropFile

    A file was dropped on a window. Text is its native path, not a virtual one — it comes from outside anything the engine has mounted.

  • DropText

    Text 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