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

public Class RMTSampleIterator

extends Struct<RMTSampleIterator>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Annotations
@NativeType:struct rmtSampleIterator
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*

Struct to hold iterator info.

Layout


struct rmtSampleIterator {
    rmtSample * sample;
    rmtSample * initial;
}

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
INITIAL

The struct member offsets.

public static final int
SAMPLE

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

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

public
RMTSampleIterator(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static RMTSampleIterator
calloc()

Returns a new RMTSampleIterator instance allocated with memCalloc.

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

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

protected RMTSampleIterator
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 RMTSampleIterator
create()

Returns a new RMTSampleIterator instance allocated with BufferUtils.

public static RMTSampleIterator
create(long address)

Returns a new RMTSampleIterator instance for the specified memory address.

public static RMTSampleIterator
createSafe(long address)

Like create, but returns null if address is NULL.

public static RMTSampleIterator
malloc()

Returns a new RMTSampleIterator instance allocated with memAlloc.

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

Returns a new RMTSampleIterator instance allocated on the specified MemoryStack.

public static long
ninitial(long struct)

public static long
nsample(long struct)

Unsafe version of sample.

public long

Returns:

the value of the sample field.
sample
()

public int
sizeof()

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

Returns sizeof(struct).
Inherited from org.lwjgl.system.Struct:
__array__array__array__checkContainer__checkMalloc__create__getContainer__getContainer__member__member__member__padding__padding__struct__struct__union__unionclearfreeisNullvalidate

Field Detail

ALIGNOFback to summary
public static final int ALIGNOF

The struct alignment in bytes.

INITIALback to summary
public static final int INITIAL

The struct member offsets.

SAMPLEback to summary
public static final int SAMPLE

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

Constructor Detail

RMTSampleIteratorback to summary
protected RMTSampleIterator(long address, ByteBuffer container)
RMTSampleIteratorback to summary
public RMTSampleIterator(ByteBuffer container)

Creates a RMTSampleIterator instance at the current position of the specified ByteBuffer container. Changes to the buffer's content will be visible to the struct instance and vice versa.

The created instance holds a strong reference to the container object.

Method Detail

callocback to summary
public static RMTSampleIterator calloc()

Returns a new RMTSampleIterator instance allocated with memCalloc. The instance must be explicitly freed.

callocback to summary
public static RMTSampleIterator calloc(MemoryStack stack)

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

Parameters
stack:MemoryStack

the stack from which to allocate

createback to summary
protected RMTSampleIterator create(long address, ByteBuffer container)

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

Doc from org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.

Effectively, every Struct instance is a factory for more instances of the same type. This is used by StructBuffer.

Parameters
address:long

the struct memory address

container:ByteBuffer

an optional container buffer, to be referenced strongly by the struct instance.

Annotations
@Override
createback to summary
public static RMTSampleIterator create()

Returns a new RMTSampleIterator instance allocated with BufferUtils.

createback to summary
public static RMTSampleIterator create(long address)

Returns a new RMTSampleIterator instance for the specified memory address.

createSafeback to summary
public static RMTSampleIterator createSafe(long address)

Like create, but returns null if address is NULL.

Annotations
@Nullable
mallocback to summary
public static RMTSampleIterator malloc()

Returns a new RMTSampleIterator instance allocated with memAlloc. The instance must be explicitly freed.

mallocback to summary
public static RMTSampleIterator malloc(MemoryStack stack)

Returns a new RMTSampleIterator instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

ninitialback to summary
public static long ninitial(long struct)
nsampleback to summary
public static long nsample(long struct)

Unsafe version of sample.

sampleback to summary
public long sample()
Returns:long

the value of the sample field.

Annotations
@NativeType:rmtSample *
sizeofback to summary
public int sizeof()

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

Doc from org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).

Annotations
@Override