Class SDL_TextEditingCandidatesEvent

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<SDL_TextEditingCandidatesEvent>

org.lwjgl.sdl.SDL_TextEditingCandidatesEvent

All Implemented Interfaces:

AutoCloseable, NativeResource, Pointer

public class SDL_TextEditingCandidatesEvent
extends Struct<SDL_TextEditingCandidatesEvent>
implements NativeResource

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;
}

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SDL_TextEditingCandidatesEvent.Buffer	An array of SDL_TextEditingCandidatesEvent structs.

Nested classes/interfaces inherited from class Struct

Struct.StructValidation

Nested classes/interfaces inherited from interface Pointer

Pointer.Default

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ALIGNOF	The struct alignment in bytes.
static final int	CANDIDATES	The struct member offsets.
static final int	HORIZONTAL	The struct member offsets.
static final int	NUM_CANDIDATES	The struct member offsets.
static final int	PADDING1	The struct member offsets.
static final int	PADDING2	The struct member offsets.
static final int	PADDING3	The struct member offsets.
static final int	RESERVED	The struct member offsets.
static final int	SELECTED_CANDIDATE	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.
static final int	TIMESTAMP	The struct member offsets.
static final int	TYPE	The struct member offsets.
static final int	WINDOWID	The struct member offsets.

Fields inherited from interface Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

Constructor	Description
SDL_TextEditingCandidatesEvent(ByteBuffer container)	Creates a SDL_TextEditingCandidatesEvent instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static SDL_TextEditingCandidatesEvent	calloc()	Returns a new SDL_TextEditingCandidatesEvent instance allocated with memCalloc.
static SDL_TextEditingCandidatesEvent.Buffer	calloc(int capacity)	Returns a new SDL_TextEditingCandidatesEvent.Buffer instance allocated with memCalloc.
static SDL_TextEditingCandidatesEvent.Buffer	calloc(int capacity, MemoryStack stack)	Returns a new SDL_TextEditingCandidatesEvent.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static SDL_TextEditingCandidatesEvent	calloc(MemoryStack stack)	Returns a new SDL_TextEditingCandidatesEvent instance allocated on the specified MemoryStack and initializes all its bits to zero.
@Nullable PointerBuffer	candidates()
SDL_TextEditingCandidatesEvent	candidates(@Nullable PointerBuffer value)	Sets the address of the specified PointerBuffer to the candidates field.
static SDL_TextEditingCandidatesEvent	create()	Returns a new SDL_TextEditingCandidatesEvent instance allocated with BufferUtils.
static SDL_TextEditingCandidatesEvent.Buffer	create(int capacity)	Returns a new SDL_TextEditingCandidatesEvent.Buffer instance allocated with BufferUtils.
static SDL_TextEditingCandidatesEvent	create(long address)	Returns a new SDL_TextEditingCandidatesEvent instance for the specified memory address.
static SDL_TextEditingCandidatesEvent.Buffer	create(long address, int capacity)	Create a SDL_TextEditingCandidatesEvent.Buffer instance at the specified memory.
static @Nullable SDL_TextEditingCandidatesEvent	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable SDL_TextEditingCandidatesEvent.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
boolean	horizontal()
SDL_TextEditingCandidatesEvent	horizontal(boolean value)	Sets the specified value to the horizontal field.
static SDL_TextEditingCandidatesEvent	malloc()	Returns a new SDL_TextEditingCandidatesEvent instance allocated with memAlloc.
static SDL_TextEditingCandidatesEvent.Buffer	malloc(int capacity)	Returns a new SDL_TextEditingCandidatesEvent.Buffer instance allocated with memAlloc.
static SDL_TextEditingCandidatesEvent.Buffer	malloc(int capacity, MemoryStack stack)	Returns a new SDL_TextEditingCandidatesEvent.Buffer instance allocated on the specified MemoryStack.
static SDL_TextEditingCandidatesEvent	malloc(MemoryStack stack)	Returns a new SDL_TextEditingCandidatesEvent instance allocated on the specified MemoryStack.
static @Nullable PointerBuffer	ncandidates(long struct)	Unsafe version of candidates.
static void	ncandidates(long struct, @Nullable PointerBuffer value)	Unsafe version of candidates.
static boolean	nhorizontal(long struct)	Unsafe version of horizontal().
static void	nhorizontal(long struct, boolean value)	Unsafe version of horizontal.
static int	nnum_candidates(long struct)	Unsafe version of num_candidates().
static void	nnum_candidates(long struct, int value)	Sets the specified value to the num_candidates field of the specified struct.
static byte	npadding1(long struct)
static void	npadding1(long struct, byte value)
static byte	npadding2(long struct)
static void	npadding2(long struct, byte value)
static byte	npadding3(long struct)
static void	npadding3(long struct, byte value)
static int	nreserved(long struct)
static void	nreserved(long struct, int value)
static int	nselected_candidate(long struct)	Unsafe version of selected_candidate().
static void	nselected_candidate(long struct, int value)	Unsafe version of selected_candidate.
static long	ntimestamp(long struct)	Unsafe version of timestamp().
static void	ntimestamp(long struct, long value)	Unsafe version of timestamp.
static int	ntype(long struct)	Unsafe version of type().
static void	ntype(long struct, int value)	Unsafe version of type.
int	num_candidates()
SDL_TextEditingCandidatesEvent	num_candidates(int value)	Sets the specified value to the num_candidates field.
static int	nwindowID(long struct)	Unsafe version of windowID().
static void	nwindowID(long struct, int value)	Unsafe version of windowID.
int	selected_candidate()
SDL_TextEditingCandidatesEvent	selected_candidate(int value)	Sets the specified value to the selected_candidate field.
SDL_TextEditingCandidatesEvent	set(int type, long timestamp, int windowID, @Nullable PointerBuffer candidates, int num_candidates, int selected_candidate, boolean horizontal)	Initializes this struct with the specified values.
SDL_TextEditingCandidatesEvent	set(SDL_TextEditingCandidatesEvent src)	Copies the specified struct data to this struct.
int	sizeof()	Returns sizeof(struct).
long	timestamp()
SDL_TextEditingCandidatesEvent	timestamp(long value)	Sets the specified value to the timestamp field.
int	type()
SDL_TextEditingCandidatesEvent	type(int value)	Sets the specified value to the type field.
int	windowID()
SDL_TextEditingCandidatesEvent	windowID(int value)	Sets the specified value to the windowID field.

Methods inherited from class Struct

clear, free, isNull, validate, validate

Methods inherited from class Pointer.Default

address, equals, hashCode, toString

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface NativeResource

close, free

Field Details

SIZEOF

public static final int SIZEOF

The struct size in bytes.

ALIGNOF

public static final int ALIGNOF

The struct alignment in bytes.

TYPE

public static final int TYPE

The struct member offsets.

RESERVED

public static final int RESERVED

The struct member offsets.

TIMESTAMP

public static final int TIMESTAMP

The struct member offsets.

WINDOWID

public static final int WINDOWID

The struct member offsets.

CANDIDATES

public static final int CANDIDATES

The struct member offsets.

NUM_CANDIDATES

public static final int NUM_CANDIDATES

The struct member offsets.

SELECTED_CANDIDATE

public static final int SELECTED_CANDIDATE

The struct member offsets.

HORIZONTAL

public static final int HORIZONTAL

The struct member offsets.

PADDING1

public static final int PADDING1

The struct member offsets.

PADDING2

public static final int PADDING2

The struct member offsets.

PADDING3

public static final int PADDING3

The struct member offsets.

Constructor Details

SDL_TextEditingCandidatesEvent

public SDL_TextEditingCandidatesEvent(ByteBuffer container)

Creates a SDL_TextEditingCandidatesEvent instance at the current position of the specified ByteBuffer container. Changes to the buffer's content will be visible to the struct instance and vice versa.

The created instance holds a strong reference to the container object.

Method Details

sizeof

public int sizeof()

Description copied from class: Struct

Returns sizeof(struct).

Specified by:

sizeof in class Struct<SDL_TextEditingCandidatesEvent>

type

@NativeType("SDL_EventType")
public int type()

Returns:

the value of the type field.

timestamp

@NativeType("Uint64")
public long timestamp()

Returns:

the value of the timestamp field.

windowID

@NativeType("SDL_WindowID")
public int windowID()

Returns:

the value of the windowID field.

candidates

@NativeType("char const * const *")
public @Nullable PointerBuffer candidates()

Returns:

a PointerBuffer view of the data pointed to by the candidates field.

num_candidates

@NativeType("Sint32")
public int num_candidates()

Returns:

the value of the num_candidates field.

selected_candidate

@NativeType("Sint32")
public int selected_candidate()

Returns:

the value of the selected_candidate field.

horizontal

@NativeType("bool")
public boolean horizontal()

Returns:

the value of the horizontal field.

type

public SDL_TextEditingCandidatesEvent type(@NativeType("SDL_EventType")
 int value)

Sets the specified value to the type field.

timestamp

public SDL_TextEditingCandidatesEvent timestamp(@NativeType("Uint64")
 long value)

Sets the specified value to the timestamp field.

windowID

public SDL_TextEditingCandidatesEvent windowID(@NativeType("SDL_WindowID")
 int value)

Sets the specified value to the windowID field.

candidates

public SDL_TextEditingCandidatesEvent candidates(@NativeType("char const * const *")
 @Nullable PointerBuffer value)

Sets the address of the specified PointerBuffer to the candidates field.

num_candidates

public SDL_TextEditingCandidatesEvent num_candidates(@NativeType("Sint32")
 int value)

Sets the specified value to the num_candidates field.

selected_candidate

public SDL_TextEditingCandidatesEvent selected_candidate(@NativeType("Sint32")
 int value)

Sets the specified value to the selected_candidate field.

horizontal

public SDL_TextEditingCandidatesEvent horizontal(@NativeType("bool")
 boolean value)

Sets the specified value to the horizontal field.

set

public SDL_TextEditingCandidatesEvent set(int type,
 long timestamp,
 int windowID,
 @Nullable PointerBuffer candidates,
 int num_candidates,
 int selected_candidate,
 boolean horizontal)

Initializes this struct with the specified values.

set

public SDL_TextEditingCandidatesEvent set(SDL_TextEditingCandidatesEvent src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static SDL_TextEditingCandidatesEvent malloc()

Returns a new SDL_TextEditingCandidatesEvent instance allocated with memAlloc. The instance must be explicitly freed.

calloc

public static SDL_TextEditingCandidatesEvent calloc()

Returns a new SDL_TextEditingCandidatesEvent instance allocated with memCalloc. The instance must be explicitly freed.

create

public static SDL_TextEditingCandidatesEvent create()

Returns a new SDL_TextEditingCandidatesEvent instance allocated with BufferUtils.

create

public static SDL_TextEditingCandidatesEvent create(long address)

Returns a new SDL_TextEditingCandidatesEvent instance for the specified memory address.

createSafe

public static @Nullable SDL_TextEditingCandidatesEvent createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static SDL_TextEditingCandidatesEvent.Buffer malloc(int capacity)

Returns a new SDL_TextEditingCandidatesEvent.Buffer instance allocated with memAlloc. The instance must be explicitly freed.

Parameters:

capacity - the buffer capacity

calloc

public static SDL_TextEditingCandidatesEvent.Buffer calloc(int capacity)

Returns a new SDL_TextEditingCandidatesEvent.Buffer instance allocated with memCalloc. The instance must be explicitly freed.

Parameters:

capacity - the buffer capacity

create

public static SDL_TextEditingCandidatesEvent.Buffer create(int capacity)

Returns a new SDL_TextEditingCandidatesEvent.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

public static SDL_TextEditingCandidatesEvent.Buffer create(long address,
 int capacity)

Create a SDL_TextEditingCandidatesEvent.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

public static @Nullable SDL_TextEditingCandidatesEvent.Buffer createSafe(long address,
 int capacity)

Like create, but returns null if address is NULL.

malloc

public static SDL_TextEditingCandidatesEvent malloc(MemoryStack stack)

Returns a new SDL_TextEditingCandidatesEvent instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static SDL_TextEditingCandidatesEvent calloc(MemoryStack stack)

Returns a new SDL_TextEditingCandidatesEvent instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters:

stack - the stack from which to allocate

malloc

public static SDL_TextEditingCandidatesEvent.Buffer malloc(int capacity,
 MemoryStack stack)

Returns a new SDL_TextEditingCandidatesEvent.Buffer instance allocated on the specified MemoryStack.

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

public static SDL_TextEditingCandidatesEvent.Buffer calloc(int capacity,
 MemoryStack stack)

Returns a new SDL_TextEditingCandidatesEvent.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

ntype

public static int ntype(long struct)

Unsafe version of type().

nreserved

public static int nreserved(long struct)

ntimestamp

public static long ntimestamp(long struct)

Unsafe version of timestamp().

nwindowID

public static int nwindowID(long struct)

Unsafe version of windowID().

ncandidates

public static @Nullable PointerBuffer ncandidates(long struct)

Unsafe version of candidates.

nnum_candidates

public static int nnum_candidates(long struct)

Unsafe version of num_candidates().

nselected_candidate

public static int nselected_candidate(long struct)

Unsafe version of selected_candidate().

nhorizontal

public static boolean nhorizontal(long struct)

Unsafe version of horizontal().

npadding1

public static byte npadding1(long struct)

npadding2

public static byte npadding2(long struct)

npadding3

public static byte npadding3(long struct)

ntype

public static void ntype(long struct,
 int value)

Unsafe version of type.

nreserved

public static void nreserved(long struct,
 int value)

ntimestamp

public static void ntimestamp(long struct,
 long value)

Unsafe version of timestamp.

nwindowID

public static void nwindowID(long struct,
 int value)

Unsafe version of windowID.

ncandidates

public static void ncandidates(long struct,
 @Nullable PointerBuffer value)

Unsafe version of candidates.

nnum_candidates

public static void nnum_candidates(long struct,
 int value)

Sets the specified value to the num_candidates field of the specified struct.

nselected_candidate

public static void nselected_candidate(long struct,
 int value)

Unsafe version of selected_candidate.

nhorizontal

public static void nhorizontal(long struct,
 boolean value)

Unsafe version of horizontal.

npadding1

public static void npadding1(long struct,
 byte value)

npadding2

public static void npadding2(long struct,
 byte value)

npadding3

public static void npadding3(long struct,
 byte value)