Top Description Inners Constructors Methods

org.lwjgl.system.rpmalloc

public abstract Class RPMemoryMapCallback

Class Inheritance

extends Callback
implements RPMemoryMapCallbackI

java.lang.Object
org.lwjgl.system.Callback
org.lwjgl.system.rpmalloc.RPMemoryMapCallback

All Implemented Interfaces

org.lwjgl.system.rpmalloc.RPMemoryMapCallbackI, org.lwjgl.system.CallbackI, org.lwjgl.system.Pointer

Known Direct Subclasses

org.lwjgl.system.rpmalloc.RPMemoryMapCallback.Container

Imports

javax.annotation.*, org.lwjgl.system.*

Instances of this class may be set to the RPMallocConfig struct.

Type


void * (*invoke) (
    size_t size,
    size_t *offset
)

Nested and Inner Type Summary

Modifier and Type	Class and Description
private static class	RPMemoryMapCallback.Container

Constructor Summary

Access	Constructor and Description
protected	RPMemoryMapCallback()
pack-priv	RPMemoryMapCallback(long functionPointer)

Method Summary

Modifier and Type	Method and Description
public static RPMemoryMapCallback	Returns: the new `RPMemoryMapCallback` create(long functionPointer) Creates a `RPMemoryMapCallback` instance from the specified function pointer.
public static RPMemoryMapCallback	create(RPMemoryMapCallbackI instance) Creates a `RPMemoryMapCallback` instance that delegates to the specified `RPMemoryMapCallbackI` instance.
public static RPMemoryMapCallback	createSafe(long functionPointer) Like `create`, but returns `null` if `functionPointer` is `NULL`.

Inherited from org.lwjgl.system.Callback:: address equals free free get getSafe hashCode toString

Constructor Detail

RPMemoryMapCallback	back to summary
protected RPMemoryMapCallback()

RPMemoryMapCallback	back to summary
pack-priv RPMemoryMapCallback(long functionPointer)

Method Detail

create back to summary

create	back to summary
public static RPMemoryMapCallback create(long functionPointer) Creates a `RPMemoryMapCallback` instance from the specified function pointer. Returns:RPMemoryMapCallback the new `RPMemoryMapCallback`

public static RPMemoryMapCallback create(long functionPointer)

Creates a RPMemoryMapCallback instance from the specified function pointer.

Returns:RPMemoryMapCallback: the new RPMemoryMapCallback

create	back to summary
public static RPMemoryMapCallback create(RPMemoryMapCallbackI instance) Creates a `RPMemoryMapCallback` instance that delegates to the specified `RPMemoryMapCallbackI` instance.

createSafe back to summary

createSafe	back to summary
public static RPMemoryMapCallback createSafe(long functionPointer) Like `create`, but returns `null` if `functionPointer` is `NULL`. Annotations @Nullable

public static RPMemoryMapCallback createSafe(long functionPointer)

Like create, but returns null if functionPointer is NULL.

Annotations

@Nullable

org.lwjgl.system.rpmalloc back to summary

private final Class RPMemoryMapCallback.Container

Class Inheritance

extends RPMemoryMapCallback

java.lang.Object
org.lwjgl.system.Callback
org.lwjgl.system.rpmalloc.RPMemoryMapCallback
org.lwjgl.system.rpmalloc.RPMemoryMapCallback.Container

Field Summary

Modifier and Type	Field and Description
private final RPMemoryMapCallbackI	delegate

Constructor Summary

Access	Constructor and Description
pack-priv	Container(long functionPointer, RPMemoryMapCallbackI delegate)

Method Summary

Modifier and Type	Method and Description
public long	invoke(long the number of bytes to map size, long the alignment offset offset) Implements org.lwjgl.system.rpmalloc.RPMemoryMapCallbackI.invoke. Map memory pages for the given number of bytes.

Inherited from org.lwjgl.system.rpmalloc.RPMemoryMapCallback:: create create createSafe

Field Detail

delegate	back to summary
private final RPMemoryMapCallbackI delegate

delegate

back to summary

private final RPMemoryMapCallbackI delegate

Constructor Detail

Container	back to summary
pack-priv Container(long functionPointer, RPMemoryMapCallbackI delegate)

Container

back to summary

pack-priv Container(long functionPointer, RPMemoryMapCallbackI delegate)

Method Detail

invoke back to summary

invoke	back to summary
public long invoke(long size, long offset) Implements org.lwjgl.system.rpmalloc.RPMemoryMapCallbackI.invoke. Doc from org.lwjgl.system.rpmalloc.RPMemoryMapCallbackI.invoke. Map memory pages for the given number of bytes. The returned address MUST be aligned to the rpmalloc span size, which will always be a power of two. Optionally the function can store an alignment offset in the offset variable in case it performs alignment and the returned pointer is offset from the actual start of the memory region due to this alignment. The alignment offset will be passed to the memory unmap function. The alignment offset MUST NOT be larger than 65535 (storable in an `uint16_t`), if it is you must use natural alignment to shift it into 16 bits. If you set a `memory_map` function, you must also set a `memory_unmap` function or else the default implementation will be used for both. Parameters size:long the number of bytes to map offset:long the alignment offset Annotations @Override

public long invoke(long size, long offset)

Implements org.lwjgl.system.rpmalloc.RPMemoryMapCallbackI.invoke.

Doc from org.lwjgl.system.rpmalloc.RPMemoryMapCallbackI.invoke.

Map memory pages for the given number of bytes.

The returned address MUST be aligned to the rpmalloc span size, which will always be a power of two. Optionally the function can store an alignment offset in the offset variable in case it performs alignment and the returned pointer is offset from the actual start of the memory region due to this alignment. The alignment offset will be passed to the memory unmap function. The alignment offset MUST NOT be larger than 65535 (storable in an uint16_t), if it is you must use natural alignment to shift it into 16 bits.

If you set a memory_map function, you must also set a memory_unmap function or else the default implementation will be used for both.

Parameters

size:long: the number of bytes to map
offset:long: the alignment offset

Annotations

@Override