Class NativeLayout

java.lang.Object

club.doki7.ffm.NativeLayout

public final class NativeLayout
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
static final @NotNull ValueLayout	C_LONG	Memory layout of current JVM platform C long type.
static final int	C_LONG_SIZE
static final @NotNull ValueLayout	C_SIZE_T	Memory layout of current JVM platform C size_t type.
static final int	POINTER_SIZE
static final int	UINT32_MAX
static final long	UINT64_MAX
static final int	WCHAR_SIZE
static final @NotNull ValueLayout	WCHAR_T	Memory layout of current JVM platform C wchar_t type.

Method Summary

Modifier and Type	Method	Description
static long	readCLong(@NotNull MemorySegment segment, long offset)
static long	readCSizeT(@NotNull MemorySegment segment, long offset)
static int	readWCharT(@NotNull MemorySegment segment, long offset)
static @NotNull StructLayout	structLayout(@NotNull MemoryLayout... elements)	Unlike MemoryLayout.structLayout, this function will automatically compute and add padding to the layout to ensure that each element is properly aligned.
static @NotNull UnionLayout	unionLayout(@NotNull MemoryLayout... elements)	Currently forwards to MemoryLayout.unionLayout(java.lang.foreign.MemoryLayout...).
static void	writeCLong(@NotNull MemorySegment segment, long offset, long value)
static void	writeCSizeT(@NotNull MemorySegment segment, long offset, long value)
static void	writeWCharT(@NotNull MemorySegment segment, long offset, int value)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

C_SIZE_T

@NotNull
public static final @NotNull ValueLayout C_SIZE_T

Memory layout of current JVM platform C size_t type.

Currently, this field is set to ValueLayout.ADDRESS, whose JavaDoc claims that it has the same size and alignment with a C size_t type.

POINTER_SIZE

public static final int POINTER_SIZE

C_LONG

@NotNull
public static final @NotNull ValueLayout C_LONG

Memory layout of current JVM platform C long type.

Currently, all 32bit platforms will use ValueLayout.JAVA_INT. For 64bit platforms, Windows will use ValueLayout.JAVA_INT, while other platforms will use ValueLayout.JAVA_LONG.

The detection algorithm came from LWJGL3.

See Also:

• lwjgl/core/src/main/java/org/lwgjl/system/Pointer.java

C_LONG_SIZE

public static final int C_LONG_SIZE

WCHAR_T

@NotNull
public static final @NotNull ValueLayout WCHAR_T

Memory layout of current JVM platform C wchar_t type.

Currently, on Windows it is ValueLayout.JAVA_SHORT (2 bytes), while on other platforms it is ValueLayout.JAVA_INT (4 bytes).

WCHAR_SIZE

public static final int WCHAR_SIZE

UINT32_MAX

@Unsigned
public static final int UINT32_MAX

See Also:

• Constant Field Values

UINT64_MAX

@Unsigned
public static final long UINT64_MAX

See Also:

• Constant Field Values

Method Details

readCLong

public static long readCLong(@NotNull
 @NotNull MemorySegment segment,
 long offset)

writeCLong

public static void writeCLong(@NotNull
 @NotNull MemorySegment segment,
 long offset,
 long value)

readCSizeT

@Unsigned
public static long readCSizeT(@NotNull
 @NotNull MemorySegment segment,
 long offset)

writeCSizeT

public static void writeCSizeT(@NotNull
 @NotNull MemorySegment segment,
 long offset,
 @Unsigned
 long value)

readWCharT

@Unsigned
public static int readWCharT(@NotNull
 @NotNull MemorySegment segment,
 long offset)

writeWCharT

public static void writeWCharT(@NotNull
 @NotNull MemorySegment segment,
 long offset,
 int value)

structLayout

@NotNull
public static @NotNull StructLayout structLayout(@NotNull
 @NotNull MemoryLayout... elements)

Unlike MemoryLayout.structLayout, this function will automatically compute and add padding to the layout to ensure that each element is properly aligned. The resulting layout should be the same with a C struct layout.

Parameters:

elements - the elements of the struct

Returns:

the struct layout

unionLayout

@NotNull
public static @NotNull UnionLayout unionLayout(@NotNull
 @NotNull MemoryLayout... elements)

Currently forwards to MemoryLayout.unionLayout(java.lang.foreign.MemoryLayout...).