Package org.lwjgl.system

Class MemoryStack

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.MemoryStack

All Implemented Interfaces:

AutoCloseable, Pointer

public class MemoryStack
extends Pointer.Default
implements AutoCloseable

An off-heap memory stack.

This class should be used in a thread-local manner for stack allocations.

See Also:

• Configuration.STACK_SIZE
• Configuration.DEBUG_STACK

Nested Class Summary

Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer

Pointer.Default

Field Summary

Fields inherited from interface org.lwjgl.system.Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Method Summary

Modifier and Type	Method	Description
ByteBuffer	ASCII(CharSequence text)	Encodes the specified text on the stack using ASCII encoding and returns a ByteBuffer that points to the encoded text, including a null-terminator.
ByteBuffer	ASCII(CharSequence text, boolean nullTerminated)	Encodes the specified text on the stack using ASCII encoding and returns a ByteBuffer that points to the encoded text.
@Nullable ByteBuffer	ASCIISafe(@Nullable CharSequence text)	Like ASCII, but returns null if text is null.
@Nullable ByteBuffer	ASCIISafe(@Nullable CharSequence text, boolean nullTerminated)	Like ASCII, but returns null if text is null.
ByteBuffer	bytes(byte x)	Single value version of malloc(int, int).
ByteBuffer	bytes(byte... values)	Vararg version of malloc(int, int).
ByteBuffer	bytes(byte x, byte y)	Two value version of malloc(int, int).
ByteBuffer	bytes(byte x, byte y, byte z)	Three value version of malloc(int, int).
ByteBuffer	bytes(byte x, byte y, byte z, byte w)	Four value version of malloc(int, int).
ByteBuffer	calloc(int size)	Calloc version of malloc(int).
ByteBuffer	calloc(int alignment, int size)	Calloc version of malloc(int, int).
CLongBuffer	callocCLong(int size)	CLong version of calloc(int).
DoubleBuffer	callocDouble(int size)	Double version of calloc(int).
FloatBuffer	callocFloat(int size)	Float version of calloc(int).
IntBuffer	callocInt(int size)	Int version of calloc(int).
LongBuffer	callocLong(int size)	Long version of calloc(int).
PointerBuffer	callocPointer(int size)	Pointer version of calloc(int).
ShortBuffer	callocShort(int size)	Short version of calloc(int).
CLongBuffer	clongs(long x)	Single value version of mallocCLong(int).
CLongBuffer	clongs(long... values)	Vararg version of mallocCLong(int).
CLongBuffer	clongs(long x, long y)	Two value version of mallocCLong(int).
CLongBuffer	clongs(long x, long y, long z)	Three value version of mallocCLong(int).
CLongBuffer	clongs(long x, long y, long z, long w)	Four value version of mallocCLong(int).
void	close()	Calls pop() on this MemoryStack.
static MemoryStack	create()	Creates a new MemoryStack with the default size.
static MemoryStack	create(int capacity)	Creates a new MemoryStack with the specified size.
static MemoryStack	create(ByteBuffer buffer)	Creates a new MemoryStack backed by the specified memory buffer.
DoubleBuffer	doubles(double x)	Single value version of mallocDouble(int).
DoubleBuffer	doubles(double... values)	Vararg version of mallocDouble(int).
DoubleBuffer	doubles(double x, double y)	Two value version of mallocDouble(int).
DoubleBuffer	doubles(double x, double y, double z)	Three value version of mallocDouble(int).
DoubleBuffer	doubles(double x, double y, double z, double w)	Four value version of mallocDouble(int).
FloatBuffer	floats(float x)	Single value version of mallocFloat(int).
FloatBuffer	floats(float... values)	Vararg version of mallocFloat(int).
FloatBuffer	floats(float x, float y)	Two value version of mallocFloat(int).
FloatBuffer	floats(float x, float y, float z)	Three value version of mallocFloat(int).
FloatBuffer	floats(float x, float y, float z, float w)	Four value version of mallocFloat(int).
long	getAddress()	Returns the address of the backing off-heap memory.
int	getFrameIndex()	Returns the current frame index.
int	getPointer()	Returns the current stack pointer.
long	getPointerAddress()	Returns the memory address at the current stack pointer.
int	getSize()	Returns the size of the backing off-heap memory.
IntBuffer	ints(int x)	Single value version of mallocInt(int).
IntBuffer	ints(int... values)	Vararg version of mallocInt(int).
IntBuffer	ints(int x, int y)	Two value version of mallocInt(int).
IntBuffer	ints(int x, int y, int z)	Three value version of mallocInt(int).
IntBuffer	ints(int x, int y, int z, int w)	Four value version of mallocInt(int).
LongBuffer	longs(long x)	Single value version of mallocLong(int).
LongBuffer	longs(long... more)	Vararg version of mallocLong(int).
LongBuffer	longs(long x, long y)	Two value version of mallocLong(int).
LongBuffer	longs(long x, long y, long z)	Three value version of mallocLong(int).
LongBuffer	longs(long x, long y, long z, long w)	Four value version of mallocLong(int).
ByteBuffer	malloc(int size)	Allocates a ByteBuffer on the stack with alignment equal to POINTER_SIZE.
ByteBuffer	malloc(int alignment, int size)	Allocates an aligned ByteBuffer on the stack.
CLongBuffer	mallocCLong(int size)	CLong version of malloc(int).
DoubleBuffer	mallocDouble(int size)	Double version of malloc(int).
FloatBuffer	mallocFloat(int size)	Float version of malloc(int).
IntBuffer	mallocInt(int size)	Int version of malloc(int).
LongBuffer	mallocLong(int size)	Long version of malloc(int).
PointerBuffer	mallocPointer(int size)	Pointer version of malloc(int).
ShortBuffer	mallocShort(int size)	Short version of malloc(int).
int	nASCII(CharSequence text, boolean nullTerminated)	Encodes the specified text on the stack using ASCII encoding and returns the encoded text length, in bytes.
int	nASCIISafe(@Nullable CharSequence text, boolean nullTerminated)	Like nASCII, but returns 0 if text is null.
long	nbyte(byte value)	Unsafe version of bytes(byte).
long	ncalloc(int alignment, int num, int size)	Allocates a block of memory on the stack for an array of num elements, each of them size bytes long, and initializes all its bits to zero.
long	nclong(long value)	Unsafe version of clongs(long).
static MemoryStack	ncreate(long address, int size)	Creates a new MemoryStack backed by the specified memory region.
long	ndouble(double value)	Unsafe version of doubles(double).
long	nfloat(float value)	Unsafe version of floats(float).
long	nint(int value)	Unsafe version of ints(int).
long	nlong(long value)	Unsafe version of longs(long).
long	nmalloc(int size)	Calls nmalloc(int, int) with alignment equal to POINTER_SIZE.
long	nmalloc(int alignment, int size)	Allocates a block of size bytes of memory on the stack.
long	npointer(long value)	Unsafe version of pointers(long).
long	npointer(Buffer value)	Unsafe version of pointers(Buffer).
long	npointer(Pointer value)	Unsafe version of pointers(Pointer).
long	nshort(short value)	Unsafe version of shorts(short).
static long	nstackCalloc(int alignment, int num, int size)	Thread-local version of ncalloc(int, int, int).
static long	nstackMalloc(int size)	Thread-local version of nmalloc(int).
static long	nstackMalloc(int alignment, int size)	Thread-local version of nmalloc(int, int).
int	nUTF16(CharSequence text, boolean nullTerminated)	Encodes the specified text on the stack using UTF16 encoding and returns the encoded text length, in bytes.
int	nUTF16Safe(@Nullable CharSequence text, boolean nullTerminated)	Like nUTF16, but returns 0 if text is null.
int	nUTF8(CharSequence text, boolean nullTerminated)	Encodes the specified text on the stack using UTF8 encoding and returns the encoded text length, in bytes.
int	nUTF8Safe(@Nullable CharSequence text, boolean nullTerminated)	Like nUTF8, but returns 0 if text is null.
PointerBuffer	pointers(long x)	Single value version of mallocPointer(int).
PointerBuffer	pointers(long... values)	Vararg version of mallocPointer(int).
PointerBuffer	pointers(long x, long y)	Two value version of mallocPointer(int).
PointerBuffer	pointers(long x, long y, long z)	Three value version of mallocPointer(int).
PointerBuffer	pointers(long x, long y, long z, long w)	Four value version of mallocPointer(int).
PointerBuffer	pointers(Buffer x)	Single value version of mallocPointer(int).
PointerBuffer	pointers(Buffer... values)	Vararg version of mallocPointer(int).
PointerBuffer	pointers(Buffer x, Buffer y)	Two value version of mallocPointer(int).
PointerBuffer	pointers(Buffer x, Buffer y, Buffer z)	Three value version of mallocPointer(int).
PointerBuffer	pointers(Buffer x, Buffer y, Buffer z, Buffer w)	Four value version of mallocPointer(int).
PointerBuffer	pointers(Pointer x)	Single value version of mallocPointer(int).
PointerBuffer	pointers(Pointer... values)	Vararg version of mallocPointer(int).
PointerBuffer	pointers(Pointer x, Pointer y)	Two value version of mallocPointer(int).
PointerBuffer	pointers(Pointer x, Pointer y, Pointer z)	Three value version of mallocPointer(int).
PointerBuffer	pointers(Pointer x, Pointer y, Pointer z, Pointer w)	Four value version of mallocPointer(int).
PointerBuffer	pointersOfElements(CustomBuffer<?> buffer)	Allocates a new PointerBuffer of size buffer.remaining() and fills it with the addresses of the values within the provided CustomBuffer starting at buffer.position().
MemoryStack	pop()	Pops the current stack frame and moves the stack pointer to the end of the previous stack frame.
MemoryStack	push()	Stores the current stack pointer and pushes a new frame to the stack.
void	setPointer(int pointer)	Sets the current stack pointer.
ShortBuffer	shorts(short x)	Single value version of mallocShort(int).
ShortBuffer	shorts(short... values)	Vararg version of mallocShort(int).
ShortBuffer	shorts(short x, short y)	Two value version of mallocShort(int).
ShortBuffer	shorts(short x, short y, short z)	Three value version of mallocShort(int).
ShortBuffer	shorts(short x, short y, short z, short w)	Four value version of mallocShort(int).
static ByteBuffer	stackASCII(CharSequence text)	Thread-local version of ASCII(CharSequence).
static ByteBuffer	stackASCII(CharSequence text, boolean nullTerminated)	Thread-local version of ASCII(CharSequence, boolean).
static @Nullable ByteBuffer	stackASCIISafe(@Nullable CharSequence text)	Thread-local version of ASCII(CharSequence).
static @Nullable ByteBuffer	stackASCIISafe(@Nullable CharSequence text, boolean nullTerminated)	Thread-local version of ASCII(CharSequence, boolean).
static ByteBuffer	stackBytes(byte x)	Thread-local version of bytes(byte).
static ByteBuffer	stackBytes(byte... values)	Thread-local version of bytes(byte...).
static ByteBuffer	stackBytes(byte x, byte y)	Thread-local version of bytes(byte, byte).
static ByteBuffer	stackBytes(byte x, byte y, byte z)	Thread-local version of bytes(byte, byte, byte).
static ByteBuffer	stackBytes(byte x, byte y, byte z, byte w)	Thread-local version of bytes(byte, byte, byte, byte).
static ByteBuffer	stackCalloc(int size)	Thread-local version of calloc.
static CLongBuffer	stackCallocCLong(int size)	Thread-local version of callocCLong(int).
static DoubleBuffer	stackCallocDouble(int size)	Thread-local version of callocDouble(int).
static FloatBuffer	stackCallocFloat(int size)	Thread-local version of callocFloat(int).
static IntBuffer	stackCallocInt(int size)	Thread-local version of callocInt(int).
static LongBuffer	stackCallocLong(int size)	Thread-local version of callocLong(int).
static PointerBuffer	stackCallocPointer(int size)	Thread-local version of callocPointer(int).
static ShortBuffer	stackCallocShort(int size)	Thread-local version of callocShort(int).
static CLongBuffer	stackCLongs(long x)	Thread-local version of longs(long).
static CLongBuffer	stackCLongs(long... values)	Thread-local version of longs(long...).
static CLongBuffer	stackCLongs(long x, long y)	Thread-local version of longs(long, long).
static CLongBuffer	stackCLongs(long x, long y, long z)	Thread-local version of longs(long, long, long).
static CLongBuffer	stackCLongs(long x, long y, long z, long w)	Thread-local version of longs(long, long, long, long).
static DoubleBuffer	stackDoubles(double x)	Thread-local version of doubles(double).
static DoubleBuffer	stackDoubles(double... values)	Thread-local version of doubles(double...).
static DoubleBuffer	stackDoubles(double x, double y)	Thread-local version of doubles(double, double).
static DoubleBuffer	stackDoubles(double x, double y, double z)	Thread-local version of doubles(double, double, double).
static DoubleBuffer	stackDoubles(double x, double y, double z, double w)	Thread-local version of doubles(double, double, double, double).
static FloatBuffer	stackFloats(float x)	Thread-local version of floats(float).
static FloatBuffer	stackFloats(float... values)	Thread-local version of floats(float...).
static FloatBuffer	stackFloats(float x, float y)	Thread-local version of floats(float, float).
static FloatBuffer	stackFloats(float x, float y, float z)	Thread-local version of floats(float, float, float).
static FloatBuffer	stackFloats(float x, float y, float z, float w)	Thread-local version of floats(float, float, float, float).
static MemoryStack	stackGet()	Returns the stack of the current thread.
static IntBuffer	stackInts(int x)	Thread-local version of ints(int).
static IntBuffer	stackInts(int... values)	Thread-local version of ints(int...).
static IntBuffer	stackInts(int x, int y)	Thread-local version of ints(int, int).
static IntBuffer	stackInts(int x, int y, int z)	Thread-local version of ints(int, int, int).
static IntBuffer	stackInts(int x, int y, int z, int w)	Thread-local version of ints(int, int, int, int).
static LongBuffer	stackLongs(long x)	Thread-local version of longs(long).
static LongBuffer	stackLongs(long... values)	Thread-local version of longs(long...).
static LongBuffer	stackLongs(long x, long y)	Thread-local version of longs(long, long).
static LongBuffer	stackLongs(long x, long y, long z)	Thread-local version of longs(long, long, long).
static LongBuffer	stackLongs(long x, long y, long z, long w)	Thread-local version of longs(long, long, long, long).
static ByteBuffer	stackMalloc(int size)	Thread-local version of malloc.
static CLongBuffer	stackMallocCLong(int size)	Thread-local version of mallocCLong(int).
static DoubleBuffer	stackMallocDouble(int size)	Thread-local version of mallocDouble(int).
static FloatBuffer	stackMallocFloat(int size)	Thread-local version of mallocFloat(int).
static IntBuffer	stackMallocInt(int size)	Thread-local version of mallocInt(int).
static LongBuffer	stackMallocLong(int size)	Thread-local version of mallocLong(int).
static PointerBuffer	stackMallocPointer(int size)	Thread-local version of mallocPointer(int).
static ShortBuffer	stackMallocShort(int size)	Thread-local version of mallocShort(int).
static PointerBuffer	stackPointers(long x)	Thread-local version of pointers(long).
static PointerBuffer	stackPointers(long... values)	Thread-local version of pointers(long...).
static PointerBuffer	stackPointers(long x, long y)	Thread-local version of pointers(long, long).
static PointerBuffer	stackPointers(long x, long y, long z)	Thread-local version of pointers(long, long, long).
static PointerBuffer	stackPointers(long x, long y, long z, long w)	Thread-local version of pointers(long, long, long, long).
static PointerBuffer	stackPointers(Pointer x)	Thread-local version of pointers(Pointer).
static PointerBuffer	stackPointers(Pointer... values)	Thread-local version of pointers(Pointer...).
static PointerBuffer	stackPointers(Pointer x, Pointer y)	Thread-local version of pointers(Pointer, Pointer).
static PointerBuffer	stackPointers(Pointer x, Pointer y, Pointer z)	Thread-local version of pointers(Pointer, Pointer, Pointer).
static PointerBuffer	stackPointers(Pointer x, Pointer y, Pointer z, Pointer w)	Thread-local version of pointers(Pointer, Pointer, Pointer, Pointer).
static MemoryStack	stackPop()	Calls pop() on the stack of the current thread.
static MemoryStack	stackPush()	Calls push() on the stack of the current thread.
static ShortBuffer	stackShorts(short x)	Thread-local version of shorts(short).
static ShortBuffer	stackShorts(short... values)	Thread-local version of shorts(short...).
static ShortBuffer	stackShorts(short x, short y)	Thread-local version of shorts(short, short).
static ShortBuffer	stackShorts(short x, short y, short z)	Thread-local version of shorts(short, short, short).
static ShortBuffer	stackShorts(short x, short y, short z, short w)	Thread-local version of shorts(short, short, short, short).
static ByteBuffer	stackUTF16(CharSequence text)	Thread-local version of UTF16(CharSequence).
static ByteBuffer	stackUTF16(CharSequence text, boolean nullTerminated)	Thread-local version of UTF16(CharSequence, boolean).
static @Nullable ByteBuffer	stackUTF16Safe(@Nullable CharSequence text)	Thread-local version of UTF16(CharSequence).
static @Nullable ByteBuffer	stackUTF16Safe(@Nullable CharSequence text, boolean nullTerminated)	Thread-local version of UTF16(CharSequence, boolean).
static ByteBuffer	stackUTF8(CharSequence text)	Thread-local version of UTF8(CharSequence).
static ByteBuffer	stackUTF8(CharSequence text, boolean nullTerminated)	Thread-local version of UTF8(CharSequence, boolean).
static @Nullable ByteBuffer	stackUTF8Safe(@Nullable CharSequence text)	Thread-local version of UTF8(CharSequence).
static @Nullable ByteBuffer	stackUTF8Safe(@Nullable CharSequence text, boolean nullTerminated)	Thread-local version of UTF8(CharSequence, boolean).
ByteBuffer	UTF16(CharSequence text)	Encodes the specified text on the stack using UTF16 encoding and returns a ByteBuffer that points to the encoded text, including a null-terminator.
ByteBuffer	UTF16(CharSequence text, boolean nullTerminated)	Encodes the specified text on the stack using UTF16 encoding and returns a ByteBuffer that points to the encoded text.
@Nullable ByteBuffer	UTF16Safe(@Nullable CharSequence text)	Like UTF16, but returns null if text is null.
@Nullable ByteBuffer	UTF16Safe(@Nullable CharSequence text, boolean nullTerminated)	Like UTF16, but returns null if text is null.
ByteBuffer	UTF8(CharSequence text)	Encodes the specified text on the stack using UTF8 encoding and returns a ByteBuffer that points to the encoded text, including a null-terminator.
ByteBuffer	UTF8(CharSequence text, boolean nullTerminated)	Encodes the specified text on the stack using UTF8 encoding and returns a ByteBuffer that points to the encoded text.
@Nullable ByteBuffer	UTF8Safe(@Nullable CharSequence text)	Like UTF8, but returns null if text is null.
@Nullable ByteBuffer	UTF8Safe(@Nullable CharSequence text, boolean nullTerminated)	Like UTF8, but returns null if text is null.

Methods inherited from class org.lwjgl.system.Pointer.Default

address, equals, hashCode, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Details

create

public static MemoryStack create()

Creates a new MemoryStack with the default size.

In the initial state, there is no active stack frame. The push() method must be used before any allocations.

create

public static MemoryStack create(int capacity)

Creates a new MemoryStack with the specified size.

In the initial state, there is no active stack frame. The push() method must be used before any allocations.

Parameters:

capacity - the maximum number of bytes that may be allocated on the stack

create

public static MemoryStack create(ByteBuffer buffer)

Creates a new MemoryStack backed by the specified memory buffer.

In the initial state, there is no active stack frame. The push() method must be used before any allocations.

Parameters:

buffer - the backing memory buffer

ncreate

public static MemoryStack ncreate(long address,
 int size)

Creates a new MemoryStack backed by the specified memory region.

In the initial state, there is no active stack frame. The push() method must be used before any allocations.

Parameters:

address - the backing memory address

size - the backing memory size

push

public MemoryStack push()

Stores the current stack pointer and pushes a new frame to the stack.

This method should be called when entering a method, before doing any stack allocations. When exiting a method, call the pop() method to restore the previous stack frame.

Pairs of push/pop calls may be nested. Care must be taken to:

• match every push with a pop
• not call pop before push has been called at least once
• not nest push calls to more than the maximum supported depth

Returns:

this stack

pop

public MemoryStack pop()

Pops the current stack frame and moves the stack pointer to the end of the previous stack frame.

Returns:

this stack

close

public void close()

Calls pop() on this MemoryStack.

This method should not be used directly. It is called automatically when the MemoryStack is used as a resource in a try-with-resources statement.

Specified by:

close in interface AutoCloseable

getAddress

public long getAddress()

Returns the address of the backing off-heap memory.

The stack grows "downwards", so the bottom of the stack is at address + size, while the top is at address.

getSize

public int getSize()

Returns the size of the backing off-heap memory.

This is the maximum number of bytes that may be allocated on the stack.

getFrameIndex

public int getFrameIndex()

Returns the current frame index.

This is the current number of nested push() calls.

getPointerAddress

public long getPointerAddress()

Returns the memory address at the current stack pointer.

getPointer

public int getPointer()

Returns the current stack pointer.

The stack grows "downwards", so when the stack is empty pointer is equal to size. On every allocation pointer is reduced by the allocated size (after alignment) and address + pointer points to the first byte of the last allocation.

Effectively, this methods returns how many more bytes may be allocated on the stack.

setPointer

public void setPointer(int pointer)

Sets the current stack pointer.

This method directly manipulates the stack pointer. Using it irresponsibly may break the internal state of the stack. It should only be used in rare cases or in auto-generated code.

nmalloc

public long nmalloc(int size)

Calls nmalloc(int, int) with alignment equal to POINTER_SIZE.

Parameters:

size - the allocation size

Returns:

the memory address on the stack for the requested allocation

nmalloc

public long nmalloc(int alignment,
 int size)

Allocates a block of size bytes of memory on the stack. The content of the newly allocated block of memory is not initialized, remaining with indeterminate values.

Parameters:

alignment - the required alignment

size - the allocation size

Returns:

the memory address on the stack for the requested allocation

ncalloc

public long ncalloc(int alignment,
 int num,
 int size)

Allocates a block of memory on the stack for an array of num elements, each of them size bytes long, and initializes all its bits to zero.

Parameters:

alignment - the required element alignment

num - num the number of elements to allocate

size - the size of each element

Returns:

the memory address on the stack for the requested allocation

malloc

public ByteBuffer malloc(int alignment,
 int size)

Allocates an aligned ByteBuffer on the stack.

Parameters:

alignment - the required buffer alignment

size - the number of elements in the buffer

Returns:

the allocated buffer

calloc

public ByteBuffer calloc(int alignment,
 int size)

Calloc version of malloc(int, int).

malloc

public ByteBuffer malloc(int size)

Allocates a ByteBuffer on the stack with alignment equal to POINTER_SIZE.

Parameters:

size - the number of elements in the buffer

Returns:

the allocated buffer

calloc

public ByteBuffer calloc(int size)

Calloc version of malloc(int).

nbyte

public long nbyte(byte value)

Unsafe version of bytes(byte).

bytes

public ByteBuffer bytes(byte x)

Single value version of malloc(int, int).

bytes

public ByteBuffer bytes(byte x,
 byte y)

Two value version of malloc(int, int).

bytes

public ByteBuffer bytes(byte x,
 byte y,
 byte z)

Three value version of malloc(int, int).

bytes

public ByteBuffer bytes(byte x,
 byte y,
 byte z,
 byte w)

Four value version of malloc(int, int).

bytes

public ByteBuffer bytes(byte... values)

Vararg version of malloc(int, int).

mallocShort

public ShortBuffer mallocShort(int size)

Short version of malloc(int).

callocShort

public ShortBuffer callocShort(int size)

Short version of calloc(int).

nshort

public long nshort(short value)

Unsafe version of shorts(short).

shorts

public ShortBuffer shorts(short x)

Single value version of mallocShort(int).

shorts

public ShortBuffer shorts(short x,
 short y)

Two value version of mallocShort(int).

shorts

public ShortBuffer shorts(short x,
 short y,
 short z)

Three value version of mallocShort(int).

shorts

public ShortBuffer shorts(short x,
 short y,
 short z,
 short w)

Four value version of mallocShort(int).

shorts

public ShortBuffer shorts(short... values)

Vararg version of mallocShort(int).

mallocInt

public IntBuffer mallocInt(int size)

Int version of malloc(int).

callocInt

public IntBuffer callocInt(int size)

Int version of calloc(int).

nint

public long nint(int value)

Unsafe version of ints(int).

ints

public IntBuffer ints(int x)

Single value version of mallocInt(int).

ints

public IntBuffer ints(int x,
 int y)

Two value version of mallocInt(int).

ints

public IntBuffer ints(int x,
 int y,
 int z)

Three value version of mallocInt(int).

ints

public IntBuffer ints(int x,
 int y,
 int z,
 int w)

Four value version of mallocInt(int).

ints

public IntBuffer ints(int... values)

Vararg version of mallocInt(int).

mallocLong

public LongBuffer mallocLong(int size)

Long version of malloc(int).

callocLong

public LongBuffer callocLong(int size)

Long version of calloc(int).

nlong

public long nlong(long value)

Unsafe version of longs(long).

longs

public LongBuffer longs(long x)

Single value version of mallocLong(int).

longs

public LongBuffer longs(long x,
 long y)

Two value version of mallocLong(int).

longs

public LongBuffer longs(long x,
 long y,
 long z)

Three value version of mallocLong(int).

longs

public LongBuffer longs(long x,
 long y,
 long z,
 long w)

Four value version of mallocLong(int).

longs

public LongBuffer longs(long... more)

Vararg version of mallocLong(int).

mallocCLong

public CLongBuffer mallocCLong(int size)

CLong version of malloc(int).

callocCLong

public CLongBuffer callocCLong(int size)

CLong version of calloc(int).

nclong

public long nclong(long value)

Unsafe version of clongs(long).

clongs

public CLongBuffer clongs(long x)

Single value version of mallocCLong(int).

clongs

public CLongBuffer clongs(long x,
 long y)

Two value version of mallocCLong(int).

clongs

public CLongBuffer clongs(long x,
 long y,
 long z)

Three value version of mallocCLong(int).

clongs

public CLongBuffer clongs(long x,
 long y,
 long z,
 long w)

Four value version of mallocCLong(int).

clongs

public CLongBuffer clongs(long... values)

Vararg version of mallocCLong(int).

mallocFloat

public FloatBuffer mallocFloat(int size)

Float version of malloc(int).

callocFloat

public FloatBuffer callocFloat(int size)

Float version of calloc(int).

nfloat

public long nfloat(float value)

Unsafe version of floats(float).

floats

public FloatBuffer floats(float x)

Single value version of mallocFloat(int).

floats

public FloatBuffer floats(float x,
 float y)

Two value version of mallocFloat(int).

floats

public FloatBuffer floats(float x,
 float y,
 float z)

Three value version of mallocFloat(int).

floats

public FloatBuffer floats(float x,
 float y,
 float z,
 float w)

Four value version of mallocFloat(int).

floats

public FloatBuffer floats(float... values)

Vararg version of mallocFloat(int).

mallocDouble

public DoubleBuffer mallocDouble(int size)

Double version of malloc(int).

callocDouble

public DoubleBuffer callocDouble(int size)

Double version of calloc(int).

ndouble

public long ndouble(double value)

Unsafe version of doubles(double).

doubles

public DoubleBuffer doubles(double x)

Single value version of mallocDouble(int).

doubles

public DoubleBuffer doubles(double x,
 double y)

Two value version of mallocDouble(int).

doubles

public DoubleBuffer doubles(double x,
 double y,
 double z)

Three value version of mallocDouble(int).

doubles

public DoubleBuffer doubles(double x,
 double y,
 double z,
 double w)

Four value version of mallocDouble(int).

doubles

public DoubleBuffer doubles(double... values)

Vararg version of mallocDouble(int).

mallocPointer

public PointerBuffer mallocPointer(int size)

Pointer version of malloc(int).

callocPointer

public PointerBuffer callocPointer(int size)

Pointer version of calloc(int).

npointer

public long npointer(long value)

Unsafe version of pointers(long).

pointers

public PointerBuffer pointers(long x)

Single value version of mallocPointer(int).

pointers

public PointerBuffer pointers(long x,
 long y)

Two value version of mallocPointer(int).

pointers

public PointerBuffer pointers(long x,
 long y,
 long z)

Three value version of mallocPointer(int).

pointers

public PointerBuffer pointers(long x,
 long y,
 long z,
 long w)

Four value version of mallocPointer(int).

pointers

public PointerBuffer pointers(long... values)

Vararg version of mallocPointer(int).

npointer

public long npointer(Pointer value)

Unsafe version of pointers(Pointer).

pointers

public PointerBuffer pointers(Pointer x)

Single value version of mallocPointer(int).

pointers

public PointerBuffer pointers(Pointer x,
 Pointer y)

Two value version of mallocPointer(int).

pointers

public PointerBuffer pointers(Pointer x,
 Pointer y,
 Pointer z)

Three value version of mallocPointer(int).

pointers

public PointerBuffer pointers(Pointer x,
 Pointer y,
 Pointer z,
 Pointer w)

Four value version of mallocPointer(int).

pointers

public PointerBuffer pointers(Pointer... values)

Vararg version of mallocPointer(int).

npointer

public long npointer(Buffer value)

Unsafe version of pointers(Buffer).

pointers

public PointerBuffer pointers(Buffer x)

Single value version of mallocPointer(int).

pointers

public PointerBuffer pointers(Buffer x,
 Buffer y)

Two value version of mallocPointer(int).

pointers

public PointerBuffer pointers(Buffer x,
 Buffer y,
 Buffer z)

Three value version of mallocPointer(int).

pointers

public PointerBuffer pointers(Buffer x,
 Buffer y,
 Buffer z,
 Buffer w)

Four value version of mallocPointer(int).

pointers

public PointerBuffer pointers(Buffer... values)

Vararg version of mallocPointer(int).

pointersOfElements

public PointerBuffer pointersOfElements(CustomBuffer<?> buffer)

Allocates a new PointerBuffer of size buffer.remaining() and fills it with the addresses of the values within the provided CustomBuffer starting at buffer.position().

Parameters:

buffer - the CustomBuffer to obtain its element addresses of

Returns:

a PointerBuffer containing the buffer's element addresses

ASCII

public ByteBuffer ASCII(CharSequence text)

Encodes the specified text on the stack using ASCII encoding and returns a ByteBuffer that points to the encoded text, including a null-terminator.

The buffer will have alignment equal to POINTER_SIZE.

Parameters:

text - the text to encode

ASCII

public ByteBuffer ASCII(CharSequence text,
 boolean nullTerminated)

Encodes the specified text on the stack using ASCII encoding and returns a ByteBuffer that points to the encoded text.

The buffer will have alignment equal to POINTER_SIZE.

Parameters:

text - the text to encode

nullTerminated - if true, a null-terminator is included at the end of the encoded text

nASCII

public int nASCII(CharSequence text,
 boolean nullTerminated)

Encodes the specified text on the stack using ASCII encoding and returns the encoded text length, in bytes.

Use getPointerAddress() immediately after this method to get the encoded text address, which will have alignment equal to POINTER_SIZE.

Parameters:

text - the text to encode

nullTerminated - if true, a null-terminator is included at the end of the encoded text

ASCIISafe

public @Nullable ByteBuffer ASCIISafe(@Nullable CharSequence text)

Like ASCII, but returns null if text is null.

ASCIISafe

public @Nullable ByteBuffer ASCIISafe(@Nullable CharSequence text,
 boolean nullTerminated)

Like ASCII, but returns null if text is null.

nASCIISafe

public int nASCIISafe(@Nullable CharSequence text,
 boolean nullTerminated)

Like nASCII, but returns 0 if text is null.

UTF8

public ByteBuffer UTF8(CharSequence text)

Encodes the specified text on the stack using UTF8 encoding and returns a ByteBuffer that points to the encoded text, including a null-terminator.

The buffer will have alignment equal to POINTER_SIZE.

Parameters:

text - the text to encode

UTF8

public ByteBuffer UTF8(CharSequence text,
 boolean nullTerminated)

Encodes the specified text on the stack using UTF8 encoding and returns a ByteBuffer that points to the encoded text.

The buffer will have alignment equal to POINTER_SIZE.

Parameters:

text - the text to encode

nullTerminated - if true, a null-terminator is included at the end of the encoded text

nUTF8

public int nUTF8(CharSequence text,
 boolean nullTerminated)

Encodes the specified text on the stack using UTF8 encoding and returns the encoded text length, in bytes.

Use getPointerAddress() immediately after this method to get the encoded text address, which will have alignment equal to POINTER_SIZE.

Parameters:

text - the text to encode

nullTerminated - if true, a null-terminator is included at the end of the encoded text

UTF8Safe

public @Nullable ByteBuffer UTF8Safe(@Nullable CharSequence text)

Like UTF8, but returns null if text is null.

UTF8Safe

public @Nullable ByteBuffer UTF8Safe(@Nullable CharSequence text,
 boolean nullTerminated)

Like UTF8, but returns null if text is null.

nUTF8Safe

public int nUTF8Safe(@Nullable CharSequence text,
 boolean nullTerminated)

Like nUTF8, but returns 0 if text is null.

UTF16

public ByteBuffer UTF16(CharSequence text)

Encodes the specified text on the stack using UTF16 encoding and returns a ByteBuffer that points to the encoded text, including a null-terminator.

The buffer will have alignment equal to POINTER_SIZE.

Parameters:

text - the text to encode

UTF16

public ByteBuffer UTF16(CharSequence text,
 boolean nullTerminated)

Encodes the specified text on the stack using UTF16 encoding and returns a ByteBuffer that points to the encoded text.

The buffer will have alignment equal to POINTER_SIZE.

Parameters:

text - the text to encode

nullTerminated - if true, a null-terminator is included at the end of the encoded text

nUTF16

public int nUTF16(CharSequence text,
 boolean nullTerminated)

Encodes the specified text on the stack using UTF16 encoding and returns the encoded text length, in bytes.

Use getPointerAddress() immediately after this method to get the encoded text address, which will have alignment equal to POINTER_SIZE.

Parameters:

text - the text to encode

nullTerminated - if true, a null-terminator is included at the end of the encoded text

UTF16Safe

public @Nullable ByteBuffer UTF16Safe(@Nullable CharSequence text)

Like UTF16, but returns null if text is null.

UTF16Safe

public @Nullable ByteBuffer UTF16Safe(@Nullable CharSequence text,
 boolean nullTerminated)

Like UTF16, but returns null if text is null.

nUTF16Safe

public int nUTF16Safe(@Nullable CharSequence text,
 boolean nullTerminated)

Like nUTF16, but returns 0 if text is null.

stackGet

public static MemoryStack stackGet()

Returns the stack of the current thread.

stackPush

public static MemoryStack stackPush()

Calls push() on the stack of the current thread.

Returns:

the stack of the current thread.

stackPop

public static MemoryStack stackPop()

Calls pop() on the stack of the current thread.

Returns:

the stack of the current thread.

nstackMalloc

public static long nstackMalloc(int size)

Thread-local version of nmalloc(int).

nstackMalloc

public static long nstackMalloc(int alignment,
 int size)

Thread-local version of nmalloc(int, int).

nstackCalloc

public static long nstackCalloc(int alignment,
 int num,
 int size)

Thread-local version of ncalloc(int, int, int).

stackMalloc

public static ByteBuffer stackMalloc(int size)

Thread-local version of malloc.

stackCalloc

public static ByteBuffer stackCalloc(int size)

Thread-local version of calloc.

stackBytes

public static ByteBuffer stackBytes(byte x)

Thread-local version of bytes(byte).

stackBytes

public static ByteBuffer stackBytes(byte x,
 byte y)

Thread-local version of bytes(byte, byte).

stackBytes

public static ByteBuffer stackBytes(byte x,
 byte y,
 byte z)

Thread-local version of bytes(byte, byte, byte).

stackBytes

public static ByteBuffer stackBytes(byte x,
 byte y,
 byte z,
 byte w)

Thread-local version of bytes(byte, byte, byte, byte).

stackBytes

public static ByteBuffer stackBytes(byte... values)

Thread-local version of bytes(byte...).

stackMallocShort

public static ShortBuffer stackMallocShort(int size)

Thread-local version of mallocShort(int).

stackCallocShort

public static ShortBuffer stackCallocShort(int size)

Thread-local version of callocShort(int).

stackShorts

public static ShortBuffer stackShorts(short x)

Thread-local version of shorts(short).

stackShorts

public static ShortBuffer stackShorts(short x,
 short y)

Thread-local version of shorts(short, short).

stackShorts

public static ShortBuffer stackShorts(short x,
 short y,
 short z)

Thread-local version of shorts(short, short, short).

stackShorts

public static ShortBuffer stackShorts(short x,
 short y,
 short z,
 short w)

Thread-local version of shorts(short, short, short, short).

stackShorts

public static ShortBuffer stackShorts(short... values)

Thread-local version of shorts(short...).

stackMallocInt

public static IntBuffer stackMallocInt(int size)

Thread-local version of mallocInt(int).

stackCallocInt

public static IntBuffer stackCallocInt(int size)

Thread-local version of callocInt(int).

stackInts

public static IntBuffer stackInts(int x)

Thread-local version of ints(int).

stackInts

public static IntBuffer stackInts(int x,
 int y)

Thread-local version of ints(int, int).

stackInts

public static IntBuffer stackInts(int x,
 int y,
 int z)

Thread-local version of ints(int, int, int).

stackInts

public static IntBuffer stackInts(int x,
 int y,
 int z,
 int w)

Thread-local version of ints(int, int, int, int).

stackInts

public static IntBuffer stackInts(int... values)

Thread-local version of ints(int...).

stackMallocLong

public static LongBuffer stackMallocLong(int size)

Thread-local version of mallocLong(int).

stackCallocLong

public static LongBuffer stackCallocLong(int size)

Thread-local version of callocLong(int).

stackLongs

public static LongBuffer stackLongs(long x)

Thread-local version of longs(long).

stackLongs

public static LongBuffer stackLongs(long x,
 long y)

Thread-local version of longs(long, long).

stackLongs

public static LongBuffer stackLongs(long x,
 long y,
 long z)

Thread-local version of longs(long, long, long).

stackLongs

public static LongBuffer stackLongs(long x,
 long y,
 long z,
 long w)

Thread-local version of longs(long, long, long, long).

stackLongs

public static LongBuffer stackLongs(long... values)

Thread-local version of longs(long...).

stackMallocCLong

public static CLongBuffer stackMallocCLong(int size)

Thread-local version of mallocCLong(int).

stackCallocCLong

public static CLongBuffer stackCallocCLong(int size)

Thread-local version of callocCLong(int).

stackCLongs

public static CLongBuffer stackCLongs(long x)

Thread-local version of longs(long).

stackCLongs

public static CLongBuffer stackCLongs(long x,
 long y)

Thread-local version of longs(long, long).

stackCLongs

public static CLongBuffer stackCLongs(long x,
 long y,
 long z)

Thread-local version of longs(long, long, long).

stackCLongs

public static CLongBuffer stackCLongs(long x,
 long y,
 long z,
 long w)

Thread-local version of longs(long, long, long, long).

stackCLongs

public static CLongBuffer stackCLongs(long... values)

Thread-local version of longs(long...).

stackMallocFloat

public static FloatBuffer stackMallocFloat(int size)

Thread-local version of mallocFloat(int).

stackCallocFloat

public static FloatBuffer stackCallocFloat(int size)

Thread-local version of callocFloat(int).

stackFloats

public static FloatBuffer stackFloats(float x)

Thread-local version of floats(float).

stackFloats

public static FloatBuffer stackFloats(float x,
 float y)

Thread-local version of floats(float, float).

stackFloats

public static FloatBuffer stackFloats(float x,
 float y,
 float z)

Thread-local version of floats(float, float, float).

stackFloats

public static FloatBuffer stackFloats(float x,
 float y,
 float z,
 float w)

Thread-local version of floats(float, float, float, float).

stackFloats

public static FloatBuffer stackFloats(float... values)

Thread-local version of floats(float...).

stackMallocDouble

public static DoubleBuffer stackMallocDouble(int size)

Thread-local version of mallocDouble(int).

stackCallocDouble

public static DoubleBuffer stackCallocDouble(int size)

Thread-local version of callocDouble(int).

stackDoubles

public static DoubleBuffer stackDoubles(double x)

Thread-local version of doubles(double).

stackDoubles

public static DoubleBuffer stackDoubles(double x,
 double y)

Thread-local version of doubles(double, double).

stackDoubles

public static DoubleBuffer stackDoubles(double x,
 double y,
 double z)

Thread-local version of doubles(double, double, double).

stackDoubles

public static DoubleBuffer stackDoubles(double x,
 double y,
 double z,
 double w)

Thread-local version of doubles(double, double, double, double).

stackDoubles

public static DoubleBuffer stackDoubles(double... values)

Thread-local version of doubles(double...).

stackMallocPointer

public static PointerBuffer stackMallocPointer(int size)

Thread-local version of mallocPointer(int).

stackCallocPointer

public static PointerBuffer stackCallocPointer(int size)

Thread-local version of callocPointer(int).

stackPointers

public static PointerBuffer stackPointers(long x)

Thread-local version of pointers(long).

stackPointers

public static PointerBuffer stackPointers(long x,
 long y)

Thread-local version of pointers(long, long).

stackPointers

public static PointerBuffer stackPointers(long x,
 long y,
 long z)

Thread-local version of pointers(long, long, long).

stackPointers

public static PointerBuffer stackPointers(long x,
 long y,
 long z,
 long w)

Thread-local version of pointers(long, long, long, long).

stackPointers

public static PointerBuffer stackPointers(long... values)

Thread-local version of pointers(long...).

stackPointers

public static PointerBuffer stackPointers(Pointer x)

Thread-local version of pointers(Pointer).

stackPointers

public static PointerBuffer stackPointers(Pointer x,
 Pointer y)

Thread-local version of pointers(Pointer, Pointer).

stackPointers

public static PointerBuffer stackPointers(Pointer x,
 Pointer y,
 Pointer z)

Thread-local version of pointers(Pointer, Pointer, Pointer).

stackPointers

public static PointerBuffer stackPointers(Pointer x,
 Pointer y,
 Pointer z,
 Pointer w)

Thread-local version of pointers(Pointer, Pointer, Pointer, Pointer).

stackPointers

public static PointerBuffer stackPointers(Pointer... values)

Thread-local version of pointers(Pointer...).

stackASCII

public static ByteBuffer stackASCII(CharSequence text)

Thread-local version of ASCII(CharSequence).

stackASCII

public static ByteBuffer stackASCII(CharSequence text,
 boolean nullTerminated)

Thread-local version of ASCII(CharSequence, boolean).

stackUTF8

public static ByteBuffer stackUTF8(CharSequence text)

Thread-local version of UTF8(CharSequence).

stackUTF8

public static ByteBuffer stackUTF8(CharSequence text,
 boolean nullTerminated)

Thread-local version of UTF8(CharSequence, boolean).

stackUTF16

public static ByteBuffer stackUTF16(CharSequence text)

Thread-local version of UTF16(CharSequence).

stackUTF16

public static ByteBuffer stackUTF16(CharSequence text,
 boolean nullTerminated)

Thread-local version of UTF16(CharSequence, boolean).

stackASCIISafe

public static @Nullable ByteBuffer stackASCIISafe(@Nullable CharSequence text)

Thread-local version of ASCII(CharSequence).

stackASCIISafe

public static @Nullable ByteBuffer stackASCIISafe(@Nullable CharSequence text,
 boolean nullTerminated)

Thread-local version of ASCII(CharSequence, boolean).

stackUTF8Safe

public static @Nullable ByteBuffer stackUTF8Safe(@Nullable CharSequence text)

Thread-local version of UTF8(CharSequence).

stackUTF8Safe

public static @Nullable ByteBuffer stackUTF8Safe(@Nullable CharSequence text,
 boolean nullTerminated)

Thread-local version of UTF8(CharSequence, boolean).

stackUTF16Safe

public static @Nullable ByteBuffer stackUTF16Safe(@Nullable CharSequence text)

Thread-local version of UTF16(CharSequence).

stackUTF16Safe

public static @Nullable ByteBuffer stackUTF16Safe(@Nullable CharSequence text,
 boolean nullTerminated)

Thread-local version of UTF16(CharSequence, boolean).