Modifier and Type	Class and Description
protected static class	Struct.Layout
protected static class	Struct.Member
public static interface	Struct.StructValidation A functional interface that enables lambda expressions to be passed to the `validate` method.

Modifier and Type	Field and Description
protected ByteBuffer	container
protected static final int	DEFAULT_ALIGN_AS
protected static final int	DEFAULT_PACK_ALIGNMENT

Access	Constructor and Description
protected	Struct(long the struct memory address address, ByteBuffer an optional container buffer, to be referenced strongly by the struct instance. container) Creates a struct instance at the specified address.

Method Summary

Modifier and Type	Method and Description
protected static Struct.Member	__array(int size, int length)
protected static Struct.Member	__array(int size, int alignment, int length)
protected static Struct.Member	__array(int size, int alignment, boolean forceAlignment, int length)
protected static ByteBuffer	__checkContainer(ByteBuffer container, int sizeof)
protected static long	__checkMalloc(int elements, int elementSize)
protected static ByteBuffer	__create(int elements, int elementSize)
protected static <T extends Struct<T>> ByteBuffer	__getContainer(T struct)
protected static ByteBuffer	__getContainer(StructBuffer<?, ?> struct)
protected static Struct.Member	__member(int size)
protected static Struct.Member	__member(int size, int alignment)
protected static Struct.Member	__member(int size, int alignment, boolean forceAlignment)
protected static Struct.Member	__padding(int num, boolean condition)
protected static Struct.Member	__padding(int num, int size, boolean condition)
protected static Struct.Layout	__struct(Struct.Member... members)
protected static Struct.Layout	__struct(int packAlignment, int alignas, Struct.Member... members)
protected static Struct.Layout	__union(Struct.Member... members)
protected static Struct.Layout	__union(int packAlignment, int alignas, Struct.Member... members)
private static void	addNestedMembers(Struct.Member nested, List<Struct.Member> members, int offset)
private static int	align(int offset, int alignment)
private void	checkMemberOffset(int memberOffset)
public void	clear() Zeroes-out the struct data.
protected abstract SELF	create(long the struct memory address address, ByteBuffer an optional container buffer, to be referenced strongly by the struct instance. container) Similar to `the constructor`, but returns the exact type of the `Struct` subclass.
public void	free() Frees the struct allocation.
private static long	getBytes(int elements, int elementSize)
public boolean	Returns: true if the member is `NULL` isNull(int the byte offset of the member to query memberOffset) Returns true if the pointer member that corresponds to the specified `memberOffset` is `NULL`.
public abstract int	sizeof() Returns `sizeof(struct)`.
public static void	validate(long the struct array to validate array, int the number of structs in `array` count, int the size of each struct, in bytes SIZEOF, Struct.StructValidation validation) Validates each struct contained in the specified struct array.

Inherited from org.lwjgl.system.Pointer.Default:: address equals hashCode toString

Field Detail

container	back to summary
protected ByteBuffer container Annotations @SuppressWarnings:unused, FieldCanBeLocal @Nullable

container

back to summary

protected ByteBuffer container

Annotations

@SuppressWarnings:unused, FieldCanBeLocal
@Nullable

DEFAULT_ALIGN_AS	back to summary
protected static final int DEFAULT_ALIGN_AS

DEFAULT_PACK_ALIGNMENT	back to summary
protected static final int DEFAULT_PACK_ALIGNMENT

Constructor Detail

Struct	back to summary
protected Struct(long address, ByteBuffer container) Creates a struct instance at the specified address. Parameters address:long the struct memory address container:ByteBuffer an optional container buffer, to be referenced strongly by the struct instance.

Struct

back to summary

protected Struct(long address, ByteBuffer container)

Creates a struct instance at the specified address.

Parameters

address:long: the struct memory address
container:ByteBuffer: an optional container buffer, to be referenced strongly by the struct instance.

Method Detail

__array	back to summary
protected static Struct.Member __array(int size, int length)

__array	back to summary
protected static Struct.Member __array(int size, int alignment, int length)

__array	back to summary
protected static Struct.Member __array(int size, int alignment, boolean forceAlignment, int length)

__checkContainer	back to summary
protected static ByteBuffer __checkContainer(ByteBuffer container, int sizeof)

__checkMalloc	back to summary
protected static long __checkMalloc(int elements, int elementSize)

__create	back to summary
protected static ByteBuffer __create(int elements, int elementSize)

__getContainer	back to summary
protected static <T extends Struct<T>> ByteBuffer __getContainer(T struct) Annotations @Nullable

__getContainer	back to summary
protected static ByteBuffer __getContainer(StructBuffer<?, ?> struct) Annotations @Nullable

__member	back to summary
protected static Struct.Member __member(int size)

__member	back to summary
protected static Struct.Member __member(int size, int alignment)

__member	back to summary
protected static Struct.Member __member(int size, int alignment, boolean forceAlignment)

__padding	back to summary
protected static Struct.Member __padding(int num, boolean condition)

__padding	back to summary
protected static Struct.Member __padding(int num, int size, boolean condition)

__struct	back to summary
protected static Struct.Layout __struct(Struct.Member... members)

__struct	back to summary
protected static Struct.Layout __struct(int packAlignment, int alignas, Struct.Member... members)

__union	back to summary
protected static Struct.Layout __union(Struct.Member... members)

__union	back to summary
protected static Struct.Layout __union(int packAlignment, int alignas, Struct.Member... members)

addNestedMembers	back to summary
private static void addNestedMembers(Struct.Member nested, List<Struct.Member> members, int offset)

align	back to summary
private static int align(int offset, int alignment)

checkMemberOffset	back to summary
private void checkMemberOffset(int memberOffset)

clear	back to summary
public void clear() Zeroes-out the struct data.

create back to summary

create	back to summary
protected abstract SELF create(long address, ByteBuffer container) Similar to `the constructor`, but returns the exact type of the `Struct` subclass. Effectively, every `Struct` instance is a factory for more instances of the same type. This is used by `StructBuffer`. Parameters address:long the struct memory address container:ByteBuffer an optional container buffer, to be referenced strongly by the struct instance.

protected abstract SELF create(long address, ByteBuffer container)

Similar to the constructor, but returns the exact type of the Struct subclass.

Effectively, every Struct instance is a factory for more instances of the same type. This is used by StructBuffer.

Parameters

address:long: the struct memory address
container:ByteBuffer: an optional container buffer, to be referenced strongly by the struct instance.

free	back to summary
public void free() Frees the struct allocation. This method should not be used if the memory backing this struct is not owned by the struct.

free

back to summary

public void free()

Frees the struct allocation.

This method should not be used if the memory backing this struct is not owned by the struct.

getBytes	back to summary
private static long getBytes(int elements, int elementSize)

isNull back to summary

isNull	back to summary
public boolean isNull(int memberOffset) Returns true if the pointer member that corresponds to the specified `memberOffset` is `NULL`. This is useful to verify that not nullable members of an untrusted struct instance are indeed not `NULL`. Parameters memberOffset:int the byte offset of the member to query Returns:boolean true if the member is `NULL`

public boolean isNull(int memberOffset)

Returns true if the pointer member that corresponds to the specified memberOffset is NULL.

This is useful to verify that not nullable members of an untrusted struct instance are indeed not NULL.

Parameters

memberOffset:int: the byte offset of the member to query

Returns:boolean

true if the member is NULL

sizeof	back to summary
public abstract int sizeof() Returns `sizeof(struct)`.

validate back to summary

validate	back to summary
public static void validate(long array, int count, int SIZEOF, Struct.StructValidation validation) Validates each struct contained in the specified struct array. [INTERNAL USE ONLY] Parameters array:long the struct array to validate count:int the number of structs in `array` SIZEOF:int the size of each struct, in bytes

public static void validate(long array, int count, int SIZEOF, Struct.StructValidation validation)

Validates each struct contained in the specified struct array. [INTERNAL USE ONLY]

Parameters

array:long: the struct array to validate
count:int: the number of structs in array
SIZEOF:int: the size of each struct, in bytes

org.lwjgl.system back to summary

protected Class Struct.Layout

Class Inheritance

extends Member

java.lang.Object
org.lwjgl.system.Struct.Member
org.lwjgl.system.Struct.Layout

Field Summary

Modifier and Type	Field and Description
pack-priv final Struct.Member[]	members

Inherited from org.lwjgl.system.Struct.Member:: alignment forcedAlignment offset size

Constructor Summary

Access	Constructor and Description
pack-priv	Layout(int size, int alignment, boolean forceAlignment, Struct.Member[] members)

Method Summary

Modifier and Type	Method and Description
public int	offsetof(int member)

Inherited from org.lwjgl.system.Struct.Member:: getAlignment getAlignment getSize

Field Detail

members	back to summary
pack-priv final Struct.Member[] members

members

back to summary

pack-priv final Struct.Member[] members

Constructor Detail

Layout	back to summary
pack-priv Layout(int size, int alignment, boolean forceAlignment, Struct.Member[] members)

Layout

back to summary

pack-priv Layout(int size, int alignment, boolean forceAlignment, Struct.Member[] members)

Method Detail

offsetof	back to summary
public int offsetof(int member)

offsetof

back to summary

public int offsetof(int member)

org.lwjgl.system back to summary

protected Class Struct.Member

Class Inheritance

extends Object

java.lang.Object
org.lwjgl.system.Struct.Member

Known Direct Subclasses

org.lwjgl.system.Struct.Layout

Field Summary

Modifier and Type	Field and Description
pack-priv final int	alignment
pack-priv final boolean	forcedAlignment
pack-priv int	offset
pack-priv final int	size

Constructor Summary

Access	Constructor and Description
pack-priv	Member(int size, int alignment, boolean forcedAlignment)

Method Summary

Modifier and Type	Method and Description
public int	getAlignment()
public int	getAlignment(int packAlignment)
public int	getSize()

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

alignment	back to summary
pack-priv final int alignment

forcedAlignment	back to summary
pack-priv final boolean forcedAlignment

offset	back to summary
pack-priv int offset

size	back to summary
pack-priv final int size

Constructor Detail

Member	back to summary
pack-priv Member(int size, int alignment, boolean forcedAlignment)

Method Detail

getAlignment	back to summary
public int getAlignment()

getAlignment	back to summary
public int getAlignment(int packAlignment)

getSize	back to summary
public int getSize()

public abstract Class Struct<SELF extends Struct<SELF>>

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

protected Class Struct.Layout

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

protected Class Struct.Member

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Interface Struct.StructValidation

Method Summary

Method Detail