Top Description Inners Fields Constructors Methods
org.lwjgl.openxr

public Class XrBaseInStructure

extends Struct<XrBaseInStructure>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*

Convenience type for iterating (read only).
Description

XrBaseInStructure can be used to facilitate iterating through a read-only structure pointer chain.

See Also

XrBaseInStructure, XrBaseOutStructure

Layout


struct XrBaseInStructure {
    XrStructureType type;
    XrBaseInStructure const * next;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
NEXT

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
TYPE

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

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

public
XrBaseInStructure(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static XrBaseInStructure
calloc()

Returns a new XrBaseInStructure instance allocated with memCalloc.

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

Returns a new XrBaseInStructure.Buffer instance allocated with memCalloc.

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

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

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

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

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

Returns a new XrBaseInStructure instance allocated with BufferUtils.

public static XrBaseInStructure
create(long address)

Returns a new XrBaseInStructure instance for the specified memory address.

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

Returns a new XrBaseInStructure.Buffer instance allocated with BufferUtils.

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

Create a XrBaseInStructure.Buffer instance at the specified memory.

public static XrBaseInStructure
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public static XrBaseInStructure
malloc()

Returns a new XrBaseInStructure instance allocated with memAlloc.

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

Returns a new XrBaseInStructure.Buffer instance allocated with memAlloc.

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

Returns a new XrBaseInStructure instance allocated on the specified MemoryStack.

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

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

public XrBaseInStructure
next()

NULL or a pointer to the next structure in a structure chain.

public XrBaseInStructure
next(XrBaseInStructure value)

Sets the address of the specified XrBaseInStructure to the next field.

public static XrBaseInStructure
nnext(long struct)

Unsafe version of next.

public static void
nnext(long struct, XrBaseInStructure value)

Unsafe version of next.

public static int
ntype(long struct)

Unsafe version of type.

public static void
ntype(long struct, int value)

Unsafe version of type.

public XrBaseInStructure
set(int type, XrBaseInStructure next)

Initializes this struct with the specified values.

public XrBaseInStructure

Returns:

this struct
set
(XrBaseInStructure
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()

the XrStructureType of this structure.

public XrBaseInStructure
type(int value)

Sets the specified value to the type field.

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

Validates pointer members that should not be NULL.

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.

NEXTback to summary
public static final int NEXT

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

TYPEback to summary
public static final int TYPE

The struct member offsets.

Constructor Detail

XrBaseInStructureback to summary
protected XrBaseInStructure(long address, ByteBuffer container)
XrBaseInStructureback to summary
public XrBaseInStructure(ByteBuffer container)

Creates a XrBaseInStructure 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 XrBaseInStructure calloc()

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

callocback to summary
public static XrBaseInStructure.Buffer calloc(int capacity)

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static XrBaseInStructure calloc(MemoryStack stack)

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

Parameters
stack:MemoryStack

the stack from which to allocate

callocback to summary
public static XrBaseInStructure.Buffer calloc(int capacity, MemoryStack stack)

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

createback to summary
protected XrBaseInStructure 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 XrBaseInStructure create()

Returns a new XrBaseInStructure instance allocated with BufferUtils.

createback to summary
public static XrBaseInStructure create(long address)

Returns a new XrBaseInStructure instance for the specified memory address.

createback to summary
public static XrBaseInStructure.Buffer create(int capacity)

Returns a new XrBaseInStructure.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

createback to summary
public static XrBaseInStructure.Buffer create(long address, int capacity)

Create a XrBaseInStructure.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static XrBaseInStructure createSafe(long address)

Like create, but returns null if address is NULL.

Annotations
@Nullable
createSafeback to summary
public static XrBaseInStructure.Buffer createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

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

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

mallocback to summary
public static XrBaseInStructure.Buffer malloc(int capacity)

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static XrBaseInStructure malloc(MemoryStack stack)

Returns a new XrBaseInStructure instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

mallocback to summary
public static XrBaseInStructure.Buffer malloc(int capacity, MemoryStack stack)

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

nextback to summary
public XrBaseInStructure next()

NULL or a pointer to the next structure in a structure chain. No such structures are defined in core OpenXR.

Annotations
@NativeType:XrBaseInStructure const *
nextback to summary
public XrBaseInStructure next(XrBaseInStructure value)

Sets the address of the specified XrBaseInStructure to the next field.

nnextback to summary
public static XrBaseInStructure nnext(long struct)

Unsafe version of next.

nnextback to summary
public static void nnext(long struct, XrBaseInStructure value)

Unsafe version of next.

ntypeback to summary
public static int ntype(long struct)

Unsafe version of type.

ntypeback to summary
public static void ntype(long struct, int value)

Unsafe version of type.

setback to summary
public XrBaseInStructure set(int type, XrBaseInStructure next)

Initializes this struct with the specified values.

setback to summary
public XrBaseInStructure set(XrBaseInStructure src)

Copies the specified struct data to this struct.

Parameters
src:XrBaseInStructure

the source struct

Returns:XrBaseInStructure

this struct

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
typeback to summary
public int type()

the XrStructureType of this structure. This base structure itself has no associated XrStructureType value.

Annotations
@NativeType:XrStructureType
typeback to summary
public XrBaseInStructure type(int value)

Sets the specified value to the type field.

validateback to summary
public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters
struct:long

the struct to validate

org.lwjgl.openxr back to summary

public Class XrBaseInStructure.Buffer

extends StructBuffer<XrBaseInStructure, XrBaseInStructure.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable

An array of XrBaseInStructure structs.

Field Summary

Modifier and TypeField and Description
private static final XrBaseInStructure

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new XrBaseInStructure.Buffer instance backed by the specified container.

public
Buffer(long address, int cap)

pack-priv
Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Summary

Modifier and TypeMethod and Description
protected XrBaseInStructure
public XrBaseInStructure

Returns:

a XrBaseInStructure view of the struct pointed to by the XrBaseInStructure#next field.
next
()

public XrBaseInStructure.Buffer
next(XrBaseInStructure value)

Sets the address of the specified XrBaseInStructure to the XrBaseInStructure#next field.

protected XrBaseInStructure.Buffer
public int

Returns:

the value of the XrBaseInStructure#type field.
type
()

public XrBaseInStructure.Buffer
type(int value)

Sets the specified value to the XrBaseInStructure#type field.

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final XrBaseInStructure ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new XrBaseInStructure.Buffer instance backed by the specified container.

Changes to the container's content will be visible to the struct buffer instance and vice versa. The two buffers' position, limit, and mark values will be independent. The new buffer's position will be zero, its capacity and its limit will be the number of bytes remaining in this buffer divided by XrBaseInStructure#SIZEOF, and its mark will be undefined.

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

Bufferback to summary
public Buffer(long address, int cap)
Bufferback to summary
pack-priv Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Detail

getElementFactoryback to summary
protected XrBaseInStructure getElementFactory()

Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.

Annotations
@Override
nextback to summary
public XrBaseInStructure next()
Returns:XrBaseInStructure

a XrBaseInStructure view of the struct pointed to by the XrBaseInStructure#next field.

Annotations
@NativeType:XrBaseInStructure const *
nextback to summary
public XrBaseInStructure.Buffer next(XrBaseInStructure value)

Sets the address of the specified XrBaseInStructure to the XrBaseInStructure#next field.

selfback to summary
protected XrBaseInStructure.Buffer self()

Implements abstract org.lwjgl.system.CustomBuffer.self.

Annotations
@Override
typeback to summary
public int type()
Returns:int

the value of the XrBaseInStructure#type field.

Annotations
@NativeType:XrStructureType
typeback to summary
public XrBaseInStructure.Buffer type(int value)

Sets the specified value to the XrBaseInStructure#type field.