Record Class SDL_TextEditingCandidatesEvent

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

Keyboard IME candidates event structure (event.edit_candidates.*)

Since: This struct is available since SDL 3.2.0.

Structure

typedef struct SDL_TextEditingCandidatesEvent {
    SDL_EventType type;
    Uint32 reserved;
    Uint64 timestamp;
    SDL_WindowID windowID;
    char const* const* candidates;
    Sint32 num_candidates;
    Sint32 selected_candidate;
    bool horizontal;
    Uint8 padding1;
    Uint8 padding2;
    Uint8 padding3;
} SDL_TextEditingCandidatesEvent;

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.