Top Description Inners Fields Constructors Methods
org.lwjgl.openxr

public Class XrSceneComponentsLocateInfoMSFT

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

Describes the information to locate scene components.
Valid Usage (Implicit)
See Also

XrUuidMSFT, LocateSceneComponentsMSFT

Layout


struct XrSceneComponentsLocateInfoMSFT {
    XrStructureType type;
    void const * next;
    XrSpace baseSpace;
    XrTime time;
    uint32_t componentIdCount;
    XrUuidMSFT const * componentIds;
}

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
BASESPACE

The struct member offsets.

public static final int
COMPONENTIDCOUNT

The struct member offsets.

public static final int
COMPONENTIDS

The struct member offsets.

public static final int
NEXT

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
TIME

The struct member offsets.

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
public
XrSceneComponentsLocateInfoMSFT(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public long
baseSpace()

an XrSpace within which the scene components will be located.

public XrSceneComponentsLocateInfoMSFT
baseSpace(XrSpace value)

Sets the specified value to the baseSpace field.

public static XrSceneComponentsLocateInfoMSFT
calloc()

Returns a new XrSceneComponentsLocateInfoMSFT instance allocated with memCalloc.

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

Returns a new XrSceneComponentsLocateInfoMSFT.Buffer instance allocated with memCalloc.

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

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

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

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

public int
componentIdCount()

a uint32_t describing the count of elements in the componentIds array.

public XrSceneComponentsLocateInfoMSFT
componentIdCount(int value)

Sets the specified value to the componentIdCount field.

public XrUuidMSFT.Buffer
componentIds()

an array of XrUuidMSFT identifiers for the scene components to location.

public XrSceneComponentsLocateInfoMSFT
componentIds(XrUuidMSFT.Buffer value)

Sets the address of the specified XrUuidMSFT.Buffer to the componentIds field.

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

Returns a new XrSceneComponentsLocateInfoMSFT instance allocated with BufferUtils.

public static XrSceneComponentsLocateInfoMSFT
create(long address)

Returns a new XrSceneComponentsLocateInfoMSFT instance for the specified memory address.

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

Returns a new XrSceneComponentsLocateInfoMSFT.Buffer instance allocated with BufferUtils.

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

Create a XrSceneComponentsLocateInfoMSFT.Buffer instance at the specified memory.

public static XrSceneComponentsLocateInfoMSFT
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public static XrSceneComponentsLocateInfoMSFT
malloc()

Returns a new XrSceneComponentsLocateInfoMSFT instance allocated with memAlloc.

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

Returns a new XrSceneComponentsLocateInfoMSFT.Buffer instance allocated with memAlloc.

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

Returns a new XrSceneComponentsLocateInfoMSFT instance allocated on the specified MemoryStack.

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

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

public static long
nbaseSpace(long struct)

Unsafe version of baseSpace.

public static void
nbaseSpace(long struct, XrSpace value)

Unsafe version of baseSpace.

public static int
ncomponentIdCount(long struct)

Unsafe version of componentIdCount.

public static void
ncomponentIdCount(long struct, int value)

Sets the specified value to the componentIdCount field of the specified struct.

public static XrUuidMSFT.Buffer
ncomponentIds(long struct)

Unsafe version of componentIds.

public static void
ncomponentIds(long struct, XrUuidMSFT.Buffer value)

Unsafe version of componentIds.

public long
next()

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

public XrSceneComponentsLocateInfoMSFT
next(long value)

Sets the specified value to the next field.

public static long
nnext(long struct)

Unsafe version of next.

public static void
nnext(long struct, long value)

Unsafe version of next.

public static long
ntime(long struct)

Unsafe version of time.

public static void
ntime(long struct, long value)

Unsafe version of time.

public static int
ntype(long struct)

Unsafe version of type.

public static void
ntype(long struct, int value)

Unsafe version of type.

public XrSceneComponentsLocateInfoMSFT
set(int type, long next, XrSpace baseSpace, long time, int componentIdCount, XrUuidMSFT.Buffer componentIds)

Initializes this struct with the specified values.

public XrSceneComponentsLocateInfoMSFT

Returns:

this struct
set
(XrSceneComponentsLocateInfoMSFT
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 long
time()

an XrTime at which to locate the scene components.

public XrSceneComponentsLocateInfoMSFT
time(long value)

Sets the specified value to the time field.

public int
type()

the XrStructureType of this structure.

public XrSceneComponentsLocateInfoMSFT
type(int value)

Sets the specified value to the type field.

public XrSceneComponentsLocateInfoMSFT
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.

BASESPACEback to summary
public static final int BASESPACE

The struct member offsets.

COMPONENTIDCOUNTback to summary
public static final int COMPONENTIDCOUNT

The struct member offsets.

COMPONENTIDSback to summary
public static final int COMPONENTIDS

The struct member offsets.

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.

TIMEback to summary
public static final int TIME

The struct member offsets.

TYPEback to summary
public static final int TYPE

The struct member offsets.

Constructor Detail

XrSceneComponentsLocateInfoMSFTback to summary
protected XrSceneComponentsLocateInfoMSFT(long address, ByteBuffer container)
XrSceneComponentsLocateInfoMSFTback to summary
public XrSceneComponentsLocateInfoMSFT(ByteBuffer container)

Creates a XrSceneComponentsLocateInfoMSFT 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

baseSpaceback to summary
public long baseSpace()

an XrSpace within which the scene components will be located.

Annotations
@NativeType:XrSpace
baseSpaceback to summary
public XrSceneComponentsLocateInfoMSFT baseSpace(XrSpace value)

Sets the specified value to the baseSpace field.

callocback to summary
public static XrSceneComponentsLocateInfoMSFT calloc()

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static XrSceneComponentsLocateInfoMSFT calloc(MemoryStack stack)

Returns a new XrSceneComponentsLocateInfoMSFT 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 XrSceneComponentsLocateInfoMSFT.Buffer calloc(int capacity, MemoryStack stack)

Returns a new XrSceneComponentsLocateInfoMSFT.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

componentIdCountback to summary
public int componentIdCount()

a uint32_t describing the count of elements in the componentIds array.

Annotations
@NativeType:uint32_t
componentIdCountback to summary
public XrSceneComponentsLocateInfoMSFT componentIdCount(int value)

Sets the specified value to the componentIdCount field.

componentIdsback to summary
public XrUuidMSFT.Buffer componentIds()

an array of XrUuidMSFT identifiers for the scene components to location.

Annotations
@Nullable
@NativeType:XrUuidMSFT const *
componentIdsback to summary
public XrSceneComponentsLocateInfoMSFT componentIds(XrUuidMSFT.Buffer value)

Sets the address of the specified XrUuidMSFT.Buffer to the componentIds field.

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

Returns a new XrSceneComponentsLocateInfoMSFT instance allocated with BufferUtils.

createback to summary
public static XrSceneComponentsLocateInfoMSFT create(long address)

Returns a new XrSceneComponentsLocateInfoMSFT instance for the specified memory address.

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

Returns a new XrSceneComponentsLocateInfoMSFT.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a XrSceneComponentsLocateInfoMSFT.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static XrSceneComponentsLocateInfoMSFT createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

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

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static XrSceneComponentsLocateInfoMSFT malloc(MemoryStack stack)

Returns a new XrSceneComponentsLocateInfoMSFT instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

nbaseSpaceback to summary
public static long nbaseSpace(long struct)

Unsafe version of baseSpace.

nbaseSpaceback to summary
public static void nbaseSpace(long struct, XrSpace value)

Unsafe version of baseSpace.

ncomponentIdCountback to summary
public static int ncomponentIdCount(long struct)

Unsafe version of componentIdCount.

ncomponentIdCountback to summary
public static void ncomponentIdCount(long struct, int value)

Sets the specified value to the componentIdCount field of the specified struct.

ncomponentIdsback to summary
public static XrUuidMSFT.Buffer ncomponentIds(long struct)

Unsafe version of componentIds.

Annotations
@Nullable
ncomponentIdsback to summary
public static void ncomponentIds(long struct, XrUuidMSFT.Buffer value)

Unsafe version of componentIds.

nextback to summary
public long next()

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

Annotations
@NativeType:void const *
nextback to summary
public XrSceneComponentsLocateInfoMSFT next(long value)

Sets the specified value to the next field.

nnextback to summary
public static long nnext(long struct)

Unsafe version of next.

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

Unsafe version of next.

ntimeback to summary
public static long ntime(long struct)

Unsafe version of time.

ntimeback to summary
public static void ntime(long struct, long value)

Unsafe version of time.

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 XrSceneComponentsLocateInfoMSFT set(int type, long next, XrSpace baseSpace, long time, int componentIdCount, XrUuidMSFT.Buffer componentIds)

Initializes this struct with the specified values.

setback to summary
public XrSceneComponentsLocateInfoMSFT set(XrSceneComponentsLocateInfoMSFT src)

Copies the specified struct data to this struct.

Parameters
src:XrSceneComponentsLocateInfoMSFT

the source struct

Returns:XrSceneComponentsLocateInfoMSFT

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
timeback to summary
public long time()

an XrTime at which to locate the scene components.

Annotations
@NativeType:XrTime
timeback to summary
public XrSceneComponentsLocateInfoMSFT time(long value)

Sets the specified value to the time field.

typeback to summary
public int type()

the XrStructureType of this structure.

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

Sets the specified value to the type field.

type$Defaultback to summary
public XrSceneComponentsLocateInfoMSFT type$Default()

Sets the TYPE_SCENE_COMPONENTS_LOCATE_INFO_MSFT 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 XrSceneComponentsLocateInfoMSFT.Buffer

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

An array of XrSceneComponentsLocateInfoMSFT structs.

Field Summary

Modifier and TypeField and Description
private static final XrSceneComponentsLocateInfoMSFT

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new XrSceneComponentsLocateInfoMSFT.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
public long

Returns:

the value of the XrSceneComponentsLocateInfoMSFT#baseSpace field.
baseSpace
()

public XrSceneComponentsLocateInfoMSFT.Buffer
baseSpace(XrSpace value)

Sets the specified value to the XrSceneComponentsLocateInfoMSFT#baseSpace field.

public int
public XrSceneComponentsLocateInfoMSFT.Buffer
componentIdCount(int value)

Sets the specified value to the XrSceneComponentsLocateInfoMSFT#componentIdCount field.

public XrUuidMSFT.Buffer

Returns:

a XrUuidMSFT.Buffer view of the struct array pointed to by the XrSceneComponentsLocateInfoMSFT#componentIds field.
componentIds
()

public XrSceneComponentsLocateInfoMSFT.Buffer
protected XrSceneComponentsLocateInfoMSFT
public long

Returns:

the value of the XrSceneComponentsLocateInfoMSFT#next field.
next
()

public XrSceneComponentsLocateInfoMSFT.Buffer
next(long value)

Sets the specified value to the XrSceneComponentsLocateInfoMSFT#next field.

protected XrSceneComponentsLocateInfoMSFT.Buffer
public long

Returns:

the value of the XrSceneComponentsLocateInfoMSFT#time field.
time
()

public XrSceneComponentsLocateInfoMSFT.Buffer
time(long value)

Sets the specified value to the XrSceneComponentsLocateInfoMSFT#time field.

public int

Returns:

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

public XrSceneComponentsLocateInfoMSFT.Buffer
type(int value)

Sets the specified value to the XrSceneComponentsLocateInfoMSFT#type field.

public XrSceneComponentsLocateInfoMSFT.Buffer
Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final XrSceneComponentsLocateInfoMSFT ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new XrSceneComponentsLocateInfoMSFT.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 XrSceneComponentsLocateInfoMSFT#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

baseSpaceback to summary
public long baseSpace()
Returns:long

the value of the XrSceneComponentsLocateInfoMSFT#baseSpace field.

Annotations
@NativeType:XrSpace
baseSpaceback to summary
public XrSceneComponentsLocateInfoMSFT.Buffer baseSpace(XrSpace value)

Sets the specified value to the XrSceneComponentsLocateInfoMSFT#baseSpace field.

componentIdCountback to summary
public int componentIdCount()
Returns:int

the value of the XrSceneComponentsLocateInfoMSFT#componentIdCount field.

Annotations
@NativeType:uint32_t
componentIdCountback to summary
public XrSceneComponentsLocateInfoMSFT.Buffer componentIdCount(int value)

Sets the specified value to the XrSceneComponentsLocateInfoMSFT#componentIdCount field.

componentIdsback to summary
public XrUuidMSFT.Buffer componentIds()
Returns:XrUuidMSFT.Buffer

a XrUuidMSFT.Buffer view of the struct array pointed to by the XrSceneComponentsLocateInfoMSFT#componentIds field.

Annotations
@Nullable
@NativeType:XrUuidMSFT const *
componentIdsback to summary
public XrSceneComponentsLocateInfoMSFT.Buffer componentIds(XrUuidMSFT.Buffer value)

Sets the address of the specified XrUuidMSFT.Buffer to the XrSceneComponentsLocateInfoMSFT#componentIds field.

getElementFactoryback to summary
protected XrSceneComponentsLocateInfoMSFT getElementFactory()

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

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

the value of the XrSceneComponentsLocateInfoMSFT#next field.

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

Sets the specified value to the XrSceneComponentsLocateInfoMSFT#next field.

selfback to summary
protected XrSceneComponentsLocateInfoMSFT.Buffer self()

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

Annotations
@Override
timeback to summary
public long time()
Returns:long

the value of the XrSceneComponentsLocateInfoMSFT#time field.

Annotations
@NativeType:XrTime
timeback to summary
public XrSceneComponentsLocateInfoMSFT.Buffer time(long value)

Sets the specified value to the XrSceneComponentsLocateInfoMSFT#time field.

typeback to summary
public int type()
Returns:int

the value of the XrSceneComponentsLocateInfoMSFT#type field.

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

Sets the specified value to the XrSceneComponentsLocateInfoMSFT#type field.

type$Defaultback to summary
public XrSceneComponentsLocateInfoMSFT.Buffer type$Default()

Sets the TYPE_SCENE_COMPONENTS_LOCATE_INFO_MSFT value to the XrSceneComponentsLocateInfoMSFT#type field.