Record Class SDL_KeyboardEvent

java.lang.Object
java.lang.Record
club.doki7.sdl3.datatype.SDL_KeyboardEvent
All Implemented Interfaces:
IPointer, ISDL_KeyboardEvent
@ValueBasedCandidate @UnsafeConstructor public record SDL_KeyboardEvent(@NotNull MemorySegment segment) extends Record implements ISDL_KeyboardEvent

Keyboard button event structure (event.key.*)

The key is the base SDL_Keycode generated by pressing the scancode using the current keyboard layout, applying any options specified in SDL_HINT_KEYCODE_OPTIONS. You can get the SDL_Keycode corresponding to the event scancode and modifiers directly from the keyboard layout, bypassing SDL_HINT_KEYCODE_OPTIONS, by calling SDL_GetKeyFromScancode().

Since: This struct is available since SDL 3.2.0.

See also:

  • SDL_GetKeyFromScancode
  • SDL_HINT_KEYCODE_OPTIONS

Structure

typedef struct SDL_KeyboardEvent {
    SDL_EventType type;
    Uint32 reserved;
    Uint64 timestamp;
    SDL_WindowID windowID;
    SDL_KeyboardID which;
    SDL_Scancode scancode;
    SDL_Keycode key;
    SDL_Keymod mod;
    Uint16 raw;
    bool down;
    bool repeat;
} SDL_KeyboardEvent;

Contracts

The property segment() should always be not-null (segment != NULL && !segment.equals(MemorySegment.NULL)), and properly aligned to LAYOUT.byteAlignment() bytes. To represent null pointer, you may use a Java null instead. See the documentation of IPointer.segment() for more details.

The constructor of this class is marked as UnsafeConstructor, because it does not perform any runtime check. The constructor can be useful for automatic code generators.