Module overrungl.core

Package overrungl

Class Struct

java.lang.Object

overrungl.Pointer

overrungl.Struct

All Implemented Interfaces:

Addressable

Direct Known Subclasses:

DrawArraysIndirectCommand, DrawElementsIndirectCommand, GLFWGamepadState, GLFWGammaRamp, GLFWImage, GLFWVidMode, NFDEnumerator, NFDNFilterItem, NFDU8FilterItem, STBIIoCallbacks

public class Struct
extends Pointer

Struct relies on preview features of the Java platform:

• Struct refers to one or more preview APIs: MemoryLayout, MemorySegment, SegmentAllocator.

Programs can only use Struct when preview features are enabled.

Preview features may be removed in a future release, or upgraded to permanent features of the Java platform.

The C struct wrapper.

Since:

0.1.0

Author:

squid233

Field Summary

Fields

Modifier and Type	Field	Description
protected MemoryLayoutPREVIEW	layout	The memory layout of this struct.

Fields inherited from class overrungl.Pointer

address, allocator, managedSegment

Constructor Summary

Constructors

Constructor	Description
Struct(MemorySegmentPREVIEW address, SegmentAllocatorPREVIEW allocator)	Creates a struct instance.
Struct(MemorySegmentPREVIEW address, SegmentAllocatorPREVIEW allocator, MemoryLayoutPREVIEW layout)	Creates a struct instance with the given memory layout.

Method Summary

Modifier and Type	Method	Description
MemoryLayoutPREVIEW	layout()	Returns the layout of this struct.
MemorySegmentPREVIEW	segment()	Gets as a native segment.
long	sizeof()	Returns the elements size of this struct in bytes.

Methods inherited from class overrungl.Pointer

address, allocator, segment, segment

Methods inherited from class java.lang.Object

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

Field Details

layout

protected MemoryLayoutPREVIEW layout

The memory layout of this struct.

The memory layout can be modified in subclasses to load lazily.

Constructor Details

Struct

public Struct(MemorySegmentPREVIEW address,
 SegmentAllocatorPREVIEW allocator,
 MemoryLayoutPREVIEW layout)

Creates a struct instance with the given memory layout.

Parameters:

address - the address.

allocator - the allocator of this address.

layout - the memory layout of this struct.

Struct

public Struct(MemorySegmentPREVIEW address,
 SegmentAllocatorPREVIEW allocator)

Creates a struct instance.

Parameters:

address - the address.

allocator - the allocator of this address.

Method Details

segment

public MemorySegmentPREVIEW segment()

Gets as a native segment.

Returns:

the memory segment.

See Also:

• Pointer.segment(long)^PREVIEW

layout

public MemoryLayoutPREVIEW layout()

Returns the layout of this struct.

Returns:

the layout of this struct

sizeof

public long sizeof()

Returns the elements size of this struct in bytes.

Returns:

the elements size of this struct in bytes