Lighweight Java Game Library 2.9.3 · org.lwjgl.util.mapped.MappedObject

Modifier and Type	Field and Description
public long	baseAddress The mapped object base memory address, in bytes.
pack-priv static final boolean	CHECKS
pack-priv ByteBuffer	preventGC The mapped buffer.
public static int	SIZEOF Holds the value of sizeof of the sub-type of this MappedObject The behavior of this (transformed) method does not follow the normal Java behavior.
public int	view The mapped object view offset, in elements.
public long	viewAddress The mapped object view memory address, in bytes.

Access	Constructor and Description
protected	MappedObject()

Method Summary

Modifier and Type	Method and Description
public final <T extends MappedObject> T[]	asArray()
public final ByteBuffer	Returns: the backing buffer backingByteBuffer() Returns the `java.nio.ByteBuffer` that backs this mapped object.
public final int	Returns: the mapped object capacity capacity() Returns the number of mapped objects that fit in the mapped buffer.
pack-priv final void	checkAddress(final long address)
pack-priv final void	checkRange(final int bytes)
public final <T extends MappedObject> void	copyRange(T target, int instances) Copies and amount of `SIZEOF * instances` bytes, from the current mapped object, to the specified mapped object.
public final <T extends MappedObject> void	copyTo(T target) Copies and amount of `SIZEOF - padding` bytes, from the current mapped object, to the specified mapped object.
public final <T extends MappedObject> T	dup() Creates an identical new MappedObject instance, comparable to the contract of `java.nio.ByteBuffer#duplicate`.
public static <T extends MappedObject> Iterable<T>	foreach(T mapped) Creates an `Iterable` <mappedobject> that will step through `capacity()` views, leaving the `view` at the last valid value.
public static <T extends MappedObject> Iterable<T>	foreach(T mapped, int elementCount) Creates an `Iterable` <mappedobject> that will step through `elementCount` views, leaving the `view` at the last valid value.
public final int	Returns: the memory alignment getAlign() Returns the mapped object memory alignment, in bytes.
public final int	Returns: the sizeof value getSizeof() Returns the mapped object memory sizeof, in bytes.
protected final long	getViewAddress(final int view)
public static <T extends MappedObject> T	malloc(int elementCount) Creates a MappedObject instance, mapping the memory region of an allocated direct ByteBuffer with a capacity of `elementCount*SIZEOF` The behavior of this (transformed) method does not follow the normal Java behavior.
public static <T extends MappedObject> T	map(ByteBuffer bb) Creates a MappedObject instance, mapping the memory region of the specified direct ByteBuffer.
public static <T extends MappedObject> T	map(long address, int capacity) Creates a MappedObject instance, mapping the memory region specified.
public final void	next() Moves the current view to the next element.
public final void	runViewConstructor() Any code in the default constructor will not run automatically.
public final void	setViewAddress(final long address)
public final <T extends MappedObject> T	slice() Creates a new MappedObject instance, with a base offset equal to the offset of the current view, comparable to the contract of `java.nio.ByteBuffer#slice`.

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

Field Detail

baseAddress	back to summary
public long baseAddress The mapped object base memory address, in bytes. Read-only.

CHECKS	back to summary
pack-priv static final boolean CHECKS

preventGC	back to summary
pack-priv ByteBuffer preventGC The mapped buffer.

SIZEOF back to summary

SIZEOF	back to summary
public static int SIZEOF Holds the value of sizeof of the sub-type of this MappedObject The behavior of this (transformed) method does not follow the normal Java behavior. `Vec2.SIZEOF` will yield 8 (2 floats) `Vec3.SIZEOF` will yield 12 (3 floats) This (required) notation might cause compiler warnings, which can be suppressed with @SuppressWarnings("static-access"). Using Java 5.0's static-import on this method will break functionality.

public static int SIZEOF

Holds the value of sizeof of the sub-type of this MappedObject

The behavior of this (transformed) method does not follow the normal Java behavior.
Vec2.SIZEOF will yield 8 (2 floats)
Vec3.SIZEOF will yield 12 (3 floats)
This (required) notation might cause compiler warnings, which can be suppressed with @SuppressWarnings("static-access").
Using Java 5.0's static-import on this method will break functionality.

view back to summary

view	back to summary
public int view The mapped object view offset, in elements. Read/write. This is a virtual field, used as a convenient getter/setter for `viewAddress`. See Also `viewAddress`

public int view

The mapped object view offset, in elements. Read/write. This is a virtual field, used as a convenient getter/setter for viewAddress.

See Also: viewAddress

viewAddress	back to summary
public long viewAddress The mapped object view memory address, in bytes. Read-only.

Constructor Detail

MappedObject	back to summary
protected MappedObject()

Method Detail

asArray	back to summary
public final <T extends MappedObject> T[] asArray() Annotations @SuppressWarnings:unused

backingByteBuffer back to summary

backingByteBuffer	back to summary
public final ByteBuffer backingByteBuffer() Returns the `java.nio.ByteBuffer` that backs this mapped object. Returns:ByteBuffer the backing buffer

public final ByteBuffer backingByteBuffer()

Returns the java.nio.ByteBuffer that backs this mapped object.

Returns:ByteBuffer: the backing buffer

capacity	back to summary
public final int capacity() Returns the number of mapped objects that fit in the mapped buffer. Returns:int the mapped object capacity

capacity

back to summary

public final int capacity()

Returns the number of mapped objects that fit in the mapped buffer.

Returns:int: the mapped object capacity

checkAddress	back to summary
pack-priv final void checkAddress(final long address)

checkRange	back to summary
pack-priv final void checkRange(final int bytes)

copyRange back to summary

copyRange	back to summary
public final <T extends MappedObject> void copyRange(T target, int instances) Copies and amount of `SIZEOF * instances` bytes, from the current mapped object, to the specified mapped object. Note that this includes any padding bytes that are part of SIZEOF. Annotations @SuppressWarnings:unused

public final <T extends MappedObject> void copyRange(T target, int instances)

Copies and amount of SIZEOF * instances bytes, from the current mapped object, to the specified mapped object. Note that this includes any padding bytes that are part of SIZEOF.

Annotations

@SuppressWarnings:unused

copyTo back to summary

copyTo	back to summary
public final <T extends MappedObject> void copyTo(T target) Copies and amount of `SIZEOF - padding` bytes, from the current mapped object, to the specified mapped object. Annotations @SuppressWarnings:unused

public final <T extends MappedObject> void copyTo(T target)

Copies and amount of SIZEOF - padding bytes, from the current mapped object, to the specified mapped object.

Annotations

@SuppressWarnings:unused

dup	back to summary
public final <T extends MappedObject> T dup() Creates an identical new MappedObject instance, comparable to the contract of `java.nio.ByteBuffer#duplicate`. This is useful when more than one views of the mapped object are required at the same time, e.g. in multithreaded access.

foreach back to summary

foreach	back to summary
public static <T extends MappedObject> Iterable<T> foreach(T mapped) Creates an `Iterable` that will step through `capacity()` views, leaving the `view` at the last valid value. For convenience you are encouraged to static-import this specific method: `import static org.lwjgl.util.mapped.MappedObject.foreach;`

public static <T extends MappedObject> Iterable<T> foreach(T mapped)

Creates an Iterable that will step through capacity() views, leaving the view at the last valid value.

For convenience you are encouraged to static-import this specific method: import static org.lwjgl.util.mapped.MappedObject.foreach;

foreach back to summary

foreach	back to summary
public static <T extends MappedObject> Iterable<T> foreach(T mapped, int elementCount) Creates an `Iterable` that will step through `elementCount` views, leaving the `view` at the last valid value. For convenience you are encouraged to static-import this specific method: `import static org.lwjgl.util.mapped.MappedObject.foreach;`

public static <T extends MappedObject> Iterable<T> foreach(T mapped, int elementCount)

Creates an Iterable that will step through elementCount views, leaving the view at the last valid value.

For convenience you are encouraged to static-import this specific method: import static org.lwjgl.util.mapped.MappedObject.foreach;

getAlign	back to summary
public final int getAlign() Returns the mapped object memory alignment, in bytes. Returns:int the memory alignment

getAlign

back to summary

public final int getAlign()

Returns the mapped object memory alignment, in bytes.

Returns:int: the memory alignment

getSizeof	back to summary
public final int getSizeof() Returns the mapped object memory sizeof, in bytes. Returns:int the sizeof value

getSizeof

back to summary

public final int getSizeof()

Returns the mapped object memory sizeof, in bytes.

Returns:int: the sizeof value

getViewAddress	back to summary
protected final long getViewAddress(final int view)

malloc back to summary

malloc	back to summary
public static <T extends MappedObject> T malloc(int elementCount) Creates a MappedObject instance, mapping the memory region of an allocated direct ByteBuffer with a capacity of `elementCount*SIZEOF` The behavior of this (transformed) method does not follow the normal Java behavior. `Vec2.malloc(int)` will return a mapped Vec2 instance. `Vec3.malloc(int)` will return a mapped Vec3 instance. This (required) notation might cause compiler warnings, which can be suppressed with @SuppressWarnings("static-access"). Using Java 5.0's static-import on this method will break functionality. Annotations @SuppressWarnings:unused

public static <T extends MappedObject> T malloc(int elementCount)

Creates a MappedObject instance, mapping the memory region of an allocated direct ByteBuffer with a capacity of elementCount*SIZEOF

The behavior of this (transformed) method does not follow the normal Java behavior.
Vec2.malloc(int) will return a mapped Vec2 instance.
Vec3.malloc(int) will return a mapped Vec3 instance.
This (required) notation might cause compiler warnings, which can be suppressed with @SuppressWarnings("static-access").
Using Java 5.0's static-import on this method will break functionality.

Annotations

@SuppressWarnings:unused

map back to summary

map	back to summary
public static <T extends MappedObject> T map(ByteBuffer bb) Creates a MappedObject instance, mapping the memory region of the specified direct ByteBuffer. The behavior of this (transformed) method does not follow the normal Java behavior. `Vec2.map(buffer)` will return a mapped Vec2 instance. `Vec3.map(buffer)` will return a mapped Vec3 instance. This (required) notation might cause compiler warnings, which can be suppressed with @SuppressWarnings("static-access"). Using Java 5.0's static-import on this method will break functionality. Annotations @SuppressWarnings:unused

public static <T extends MappedObject> T map(ByteBuffer bb)

Creates a MappedObject instance, mapping the memory region of the specified direct ByteBuffer.

The behavior of this (transformed) method does not follow the normal Java behavior.
Vec2.map(buffer) will return a mapped Vec2 instance.
Vec3.map(buffer) will return a mapped Vec3 instance.
This (required) notation might cause compiler warnings, which can be suppressed with @SuppressWarnings("static-access").
Using Java 5.0's static-import on this method will break functionality.

Annotations

@SuppressWarnings:unused

map back to summary

map	back to summary
public static <T extends MappedObject> T map(long address, int capacity) Creates a MappedObject instance, mapping the memory region specified. This is useful for mapping arbitrary regions in memory, e.g. OpenCL CLMem objects, without creating a ByteBuffer first. The behavior of this (transformed) method does not follow the normal Java behavior. `Vec2.map(buffer)` will return a mapped Vec2 instance. `Vec3.map(buffer)` will return a mapped Vec3 instance. This (required) notation might cause compiler warnings, which can be suppressed with @SuppressWarnings("static-access"). Using Java 5.0's static-import on this method will break functionality. Annotations @SuppressWarnings:unused

public static <T extends MappedObject> T map(long address, int capacity)

Creates a MappedObject instance, mapping the memory region specified. This is useful for mapping arbitrary regions in memory, e.g. OpenCL CLMem objects, without creating a ByteBuffer first.

Annotations

@SuppressWarnings:unused

next	back to summary
public final void next() Moves the current view to the next element.

runViewConstructor	back to summary
public final void runViewConstructor() Any code in the default constructor will not run automatically. This method can be used to execute that code on the current view.

setViewAddress	back to summary
public final void setViewAddress(final long address)

slice	back to summary
public final <T extends MappedObject> T slice() Creates a new MappedObject instance, with a base offset equal to the offset of the current view, comparable to the contract of `java.nio.ByteBuffer#slice`.

public abstract Class MappedObject

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail