Top Description Inners Fields Constructors Methods
org.lwjgl.util.remotery

public Class RMTProperty

extends Struct<RMTProperty>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Annotations
@NativeType:struct rmtProperty
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*
Definition of a property that should be stored globally.

Note

Use the callback api and the rmt_PropertyGetxxx accessors to traverse this structure.

Layout


struct rmtProperty {
    rmtBool initialised;
    rmtPropertyType type;
    rmtPropertyFlags flags;
    rmtPropertyValue value;
    rmtPropertyValue lastFrameValue;
    rmtPropertyValue prevValue;
    rmtU32 prevValueFrame;
    char const * name;
    char const * description;
    rmtPropertyValue defaultValue;
    rmtProperty * parent;
    rmtProperty * firstChild;
    rmtProperty * lastChild;
    rmtProperty * nextSibling;
    rmtU32 nameHash;
    rmtU32 uniqueID;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
RMTProperty.Buffer

An array of RMTProperty structs.

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
DEFAULTVALUE

The struct member offsets.

public static final int
DESCRIPTION

The struct member offsets.

public static final int
FIRSTCHILD

The struct member offsets.

public static final int
FLAGS

The struct member offsets.

public static final int
INITIALISED

The struct member offsets.

public static final int
LASTCHILD

The struct member offsets.

public static final int
LASTFRAMEVALUE

The struct member offsets.

public static final int
NAME

The struct member offsets.

public static final int
NAMEHASH

The struct member offsets.

public static final int
NEXTSIBLING

The struct member offsets.

public static final int
PARENT

The struct member offsets.

public static final int
PREVVALUE

The struct member offsets.

public static final int
PREVVALUEFRAME

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
TYPE

The struct member offsets.

public static final int
UNIQUEID

The struct member offsets.

public static final int
VALUE

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

AccessConstructor and Description
protected
RMTProperty(long address, ByteBuffer container)

public
RMTProperty(ByteBuffer container)

Creates a RMTProperty instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and TypeMethod and Description
public static RMTProperty
calloc()

Returns a new RMTProperty instance allocated with memCalloc.

public static RMTProperty.Buffer
calloc(int
the buffer capacity
capacity)

Returns a new RMTProperty.Buffer instance allocated with memCalloc.

public static RMTProperty
calloc(MemoryStack
the stack from which to allocate
stack)

Returns a new RMTProperty instance allocated on the specified MemoryStack and initializes all its bits to zero.

public static RMTProperty.Buffer
calloc(int
the buffer capacity
capacity, MemoryStack
the stack from which to allocate
stack)

Returns a new RMTProperty.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.

protected RMTProperty
create(long
the struct memory address
address, ByteBuffer
an optional container buffer, to be referenced strongly by the struct instance.
container)

Implements abstract org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.
public static RMTProperty
create()

Returns a new RMTProperty instance allocated with BufferUtils.

public static RMTProperty
create(long address)

Returns a new RMTProperty instance for the specified memory address.

public static RMTProperty.Buffer
create(int
the buffer capacity
capacity)

Returns a new RMTProperty.Buffer instance allocated with BufferUtils.

public static RMTProperty.Buffer
create(long
the memory address
address, int
the buffer capacity
capacity)

Create a RMTProperty.Buffer instance at the specified memory.

public static RMTProperty
createSafe(long address)

Like create, but returns null if address is NULL.

public static RMTProperty.Buffer
createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

public RMTPropertyValue
defaultValue()

default value for Reset calls

public RMTProperty
defaultValue(RMTPropertyValue value)

Copies the specified RMTPropertyValue to the defaultValue field.

public RMTProperty
defaultValue(Consumer<RMTPropertyValue> consumer)

Passes the defaultValue field to the specified Consumer.

public ByteBuffer

Returns:

a ByteBuffer view of the null-terminated string pointed to by the description field.
description()

public RMTProperty
description(ByteBuffer value)

Sets the address of the specified encoded string to the description field.

public String

Returns:

the null-terminated string pointed to by the description field.
descriptionString()

public RMTProperty
firstChild()

links within the property tree

public RMTProperty
firstChild(RMTProperty value)

Sets the address of the specified RMTProperty to the firstChild field.

public int

Returns:

the value of the flags field.
flags()

public RMTProperty
flags(int value)

Sets the specified value to the flags field.

public boolean
initialised()

gets set to TRUE after a property has been modified, when it gets initialised for the first time

public RMTProperty
initialised(boolean value)

Sets the specified value to the initialised field.

public RMTProperty
lastChild()

links within the property tree

public RMTProperty
lastChild(RMTProperty value)

Sets the address of the specified RMTProperty to the lastChild field.

public RMTPropertyValue
lastFrameValue()

last frame value to see if previous value needs to be updated

public RMTProperty
lastFrameValue(RMTPropertyValue value)

Copies the specified RMTPropertyValue to the lastFrameValue field.

public RMTProperty
lastFrameValue(Consumer<RMTPropertyValue> consumer)

Passes the lastFrameValue field to the specified Consumer.

public static RMTProperty
malloc()

Returns a new RMTProperty instance allocated with memAlloc.

public static RMTProperty.Buffer
malloc(int
the buffer capacity
capacity)

Returns a new RMTProperty.Buffer instance allocated with memAlloc.

public static RMTProperty
malloc(MemoryStack
the stack from which to allocate
stack)

Returns a new RMTProperty instance allocated on the specified MemoryStack.

public static RMTProperty.Buffer
malloc(int
the buffer capacity
capacity, MemoryStack
the stack from which to allocate
stack)

Returns a new RMTProperty.Buffer instance allocated on the specified MemoryStack.

public ByteBuffer
name()

text description

public RMTProperty
name(ByteBuffer value)

Sets the address of the specified encoded string to the name field.

public int
nameHash()

hash for efficient sending of properties to the viewer

public RMTProperty
nameHash(int value)

Sets the specified value to the nameHash field.

public String
nameString()

text description

public static RMTPropertyValue
ndefaultValue(long struct)

Unsafe version of defaultValue.

public static void
ndefaultValue(long struct, RMTPropertyValue value)

Unsafe version of defaultValue.

public static ByteBuffer
ndescription(long struct)

Unsafe version of description.

public static void
ndescription(long struct, ByteBuffer value)

Unsafe version of description.

public static String
ndescriptionString(long struct)

Unsafe version of descriptionString.

public RMTProperty
nextSibling()

links within the property tree

public RMTProperty
nextSibling(RMTProperty value)

Sets the address of the specified RMTProperty to the nextSibling field.

public static RMTProperty
nfirstChild(long struct)

Unsafe version of firstChild.

public static void
nfirstChild(long struct, RMTProperty value)

Unsafe version of firstChild.

public static int
nflags(long struct)

Unsafe version of flags.

public static void
nflags(long struct, int value)

Unsafe version of flags.

public static int
ninitialised(long struct)

Unsafe version of initialised.

public static void
ninitialised(long struct, int value)

Unsafe version of initialised.

public static RMTProperty
nlastChild(long struct)

Unsafe version of lastChild.

public static void
nlastChild(long struct, RMTProperty value)

Unsafe version of lastChild.

public static RMTPropertyValue
nlastFrameValue(long struct)

Unsafe version of lastFrameValue.

public static void
nlastFrameValue(long struct, RMTPropertyValue value)

Unsafe version of lastFrameValue.

public static ByteBuffer
nname(long struct)

Unsafe version of name.

public static void
nname(long struct, ByteBuffer value)

Unsafe version of name.

public static int
nnameHash(long struct)

Unsafe version of nameHash.

public static void
nnameHash(long struct, int value)

Unsafe version of nameHash.

public static String
nnameString(long struct)

Unsafe version of nameString.

public static RMTProperty
nnextSibling(long struct)

Unsafe version of nextSibling.

public static void
nnextSibling(long struct, RMTProperty value)

Unsafe version of nextSibling.

public static RMTProperty
nparent(long struct)

Unsafe version of parent.

public static void
nparent(long struct, RMTProperty value)

Unsafe version of parent.

public static RMTPropertyValue
nprevValue(long struct)

Unsafe version of prevValue.

public static void
nprevValue(long struct, RMTPropertyValue value)

Unsafe version of prevValue.

public static int
nprevValueFrame(long struct)

Unsafe version of prevValueFrame.

public static void
nprevValueFrame(long struct, int value)

Unsafe version of prevValueFrame.

public static int
ntype(long struct)

Unsafe version of type.

public static void
ntype(long struct, int value)

Unsafe version of type.

public static int
nuniqueID(long struct)

Unsafe version of uniqueID.

public static void
nuniqueID(long struct, int value)

Unsafe version of uniqueID.

public static RMTPropertyValue
nvalue(long struct)

Unsafe version of value.

public static void
nvalue(long struct, RMTPropertyValue value)

Unsafe version of value.

public RMTProperty
parent()

parent link specifically placed after default value so that variadic macro can initialise it

public RMTProperty
parent(RMTProperty value)

Sets the address of the specified RMTProperty to the parent field.

public RMTPropertyValue
prevValue()

previous value only if it's different from the current value, and when it changed

public RMTProperty
prevValue(RMTPropertyValue value)

Copies the specified RMTPropertyValue to the prevValue field.

public RMTProperty
prevValue(Consumer<RMTPropertyValue> consumer)

Passes the prevValue field to the specified Consumer.

public int

Returns:

the value of the prevValueFrame field.
prevValueFrame()

public RMTProperty
prevValueFrame(int value)

Sets the specified value to the prevValueFrame field.

public RMTProperty
set(boolean initialised, int type, int flags, RMTPropertyValue value, RMTPropertyValue lastFrameValue, RMTPropertyValue prevValue, int prevValueFrame, ByteBuffer name, ByteBuffer description, RMTPropertyValue defaultValue, RMTProperty parent, RMTProperty firstChild, RMTProperty lastChild, RMTProperty nextSibling, int nameHash, int uniqueID)

Initializes this struct with the specified values.

public RMTProperty

Returns:

this struct
set(RMTProperty
the source struct
src)

Copies the specified struct data to this struct.

public int
sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).
public int
type()

runtime description

public RMTProperty
type(int value)

Sets the specified value to the type field.

public int
uniqueID()

unique, persistent ID among all properties

public RMTProperty
uniqueID(int value)

Sets the specified value to the uniqueID field.

public static void
validate(long
the struct to validate
struct)

Validates pointer members that should not be NULL.

public RMTPropertyValue
value()

current value

public RMTProperty
value(RMTPropertyValue value)

Copies the specified RMTPropertyValue to the value field.

public RMTProperty
value(Consumer<RMTPropertyValue> consumer)

Passes the value field to the specified Consumer.

Inherited from org.lwjgl.system.Struct:
__array__array__array__checkContainer__checkMalloc__create__getContainer__getContainer__member__member__member__padding__padding__struct__struct__union__unionclearfreeisNullvalidate