Scene objects.

Description

The runtime must only set XrSceneObjectMSFT::objectType to any of the following XrSceneObjectTypeMSFT values:

Valid Usage (Implicit)

The XR_MSFT_scene_understanding extension must be enabled prior to using XrSceneObjectsMSFT
type must be TYPE_SCENE_OBJECTS_MSFT
next must be NULL or a valid pointer to the next structure in a structure chain
If sceneObjectCount is not 0, sceneObjects must be a pointer to an array of sceneObjectCount XrSceneObjectMSFT structures

Layout


struct XrSceneObjectsMSFT {
    XrStructureType type;
    void * next;
    uint32_t sceneObjectCount;
    XrSceneObjectMSFT * sceneObjects;
}

Nested and Inner Type Summary

Modifier and Type	Class and Description
public static class	XrSceneObjectsMSFT.Buffer An array of `XrSceneObjectsMSFT` structs.

Field Summary

Modifier and Type	Field 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	SCENEOBJECTCOUNT The struct member offsets.
public static final int	SCENEOBJECTS 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:: container DEFAULT_ALIGN_AS DEFAULT_PACK_ALIGNMENT

Constructor Summary

Access	Constructor and Description
protected	XrSceneObjectsMSFT(long address, ByteBuffer container)
public	XrSceneObjectsMSFT(ByteBuffer container) Creates a `XrSceneObjectsMSFT` instance at the current position of the specified `ByteBuffer` container.

Method Summary

Modifier and Type	Method and Description
public static XrSceneObjectsMSFT	calloc() Returns a new `XrSceneObjectsMSFT` instance allocated with `memCalloc`.
public static XrSceneObjectsMSFT.Buffer	calloc(int the buffer capacity capacity) Returns a new `XrSceneObjectsMSFT.Buffer` instance allocated with `memCalloc`.
public static XrSceneObjectsMSFT	calloc(MemoryStack the stack from which to allocate stack) Returns a new `XrSceneObjectsMSFT` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
public static XrSceneObjectsMSFT.Buffer	calloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `XrSceneObjectsMSFT.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
protected XrSceneObjectsMSFT	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 XrSceneObjectsMSFT	create() Returns a new `XrSceneObjectsMSFT` instance allocated with `BufferUtils`.
public static XrSceneObjectsMSFT	create(long address) Returns a new `XrSceneObjectsMSFT` instance for the specified memory address.
public static XrSceneObjectsMSFT.Buffer	create(int the buffer capacity capacity) Returns a new `XrSceneObjectsMSFT.Buffer` instance allocated with `BufferUtils`.
public static XrSceneObjectsMSFT.Buffer	create(long the memory address address, int the buffer capacity capacity) Create a `XrSceneObjectsMSFT.Buffer` instance at the specified memory.
public static XrSceneObjectsMSFT	createSafe(long address) Like `create`, but returns `null` if `address` is `NULL`.
public static XrSceneObjectsMSFT.Buffer	createSafe(long address, int capacity) Like `create`, but returns `null` if `address` is `NULL`.
public static XrSceneObjectsMSFT	malloc() Returns a new `XrSceneObjectsMSFT` instance allocated with `memAlloc`.
public static XrSceneObjectsMSFT.Buffer	malloc(int the buffer capacity capacity) Returns a new `XrSceneObjectsMSFT.Buffer` instance allocated with `memAlloc`.
public static XrSceneObjectsMSFT	malloc(MemoryStack the stack from which to allocate stack) Returns a new `XrSceneObjectsMSFT` instance allocated on the specified `MemoryStack`.
public static XrSceneObjectsMSFT.Buffer	malloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `XrSceneObjectsMSFT.Buffer` instance allocated on the specified `MemoryStack`.
public long	next() `NULL` or a pointer to the next structure in a structure chain.
public XrSceneObjectsMSFT	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 int	nsceneObjectCount(long struct) Unsafe version of `sceneObjectCount`.
public static void	nsceneObjectCount(long struct, int value) Sets the specified value to the `sceneObjectCount` field of the specified `struct`.
public static XrSceneObjectMSFT.Buffer	nsceneObjects(long struct) Unsafe version of `sceneObjects`.
public static void	nsceneObjects(long struct, XrSceneObjectMSFT.Buffer value) Unsafe version of `sceneObjects`.
public static int	ntype(long struct) Unsafe version of `type`.
public static void	ntype(long struct, int value) Unsafe version of `type`.
public int	sceneObjectCount() a `uint32_t` describing the count of elements in the `sceneObjects` array.
public XrSceneObjectsMSFT	sceneObjectCount(int value) Sets the specified value to the `sceneObjectCount` field.
public XrSceneObjectMSFT.Buffer	sceneObjects() an array of `XrSceneObjectMSFT`.
public XrSceneObjectsMSFT	sceneObjects(XrSceneObjectMSFT.Buffer value) Sets the address of the specified `XrSceneObjectMSFT.Buffer` to the `sceneObjects` field.
public XrSceneObjectsMSFT	set(int type, long next, int sceneObjectCount, XrSceneObjectMSFT.Buffer sceneObjects) Initializes this struct with the specified values.
public XrSceneObjectsMSFT	Returns: this struct set(XrSceneObjectsMSFT 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 XrSceneObjectsMSFT	type(int value) Sets the specified value to the `type` field.
public XrSceneObjectsMSFT	type$Default() Sets the `TYPE_SCENE_OBJECTS_MSFT` value to the `type` field.

Field Detail

ALIGNOF	back to summary
public static final int ALIGNOF The struct alignment in bytes.

NEXT	back to summary
public static final int NEXT The struct member offsets.

SCENEOBJECTCOUNT	back to summary
public static final int SCENEOBJECTCOUNT The struct member offsets.

SCENEOBJECTS	back to summary
public static final int SCENEOBJECTS The struct member offsets.

SIZEOF	back to summary
public static final int SIZEOF The struct size in bytes.

TYPE	back to summary
public static final int TYPE The struct member offsets.

Constructor Detail

XrSceneObjectsMSFT	back to summary
protected XrSceneObjectsMSFT(long address, ByteBuffer container)

XrSceneObjectsMSFT back to summary

XrSceneObjectsMSFT	back to summary
public XrSceneObjectsMSFT(ByteBuffer container) Creates a `XrSceneObjectsMSFT` 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.

public XrSceneObjectsMSFT(ByteBuffer container)

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

calloc	back to summary
public static XrSceneObjectsMSFT calloc() Returns a new `XrSceneObjectsMSFT` instance allocated with `memCalloc`. The instance must be explicitly freed.

calloc back to summary

calloc	back to summary
public static XrSceneObjectsMSFT.Buffer calloc(int capacity) Returns a new `XrSceneObjectsMSFT.Buffer` instance allocated with `memCalloc`. The instance must be explicitly freed. Parameters capacity:int the buffer capacity

public static XrSceneObjectsMSFT.Buffer calloc(int capacity)

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

Parameters

capacity:int: the buffer capacity

calloc back to summary

calloc	back to summary
public static XrSceneObjectsMSFT calloc(MemoryStack stack) Returns a new `XrSceneObjectsMSFT` instance allocated on the specified `MemoryStack` and initializes all its bits to zero. Parameters stack:MemoryStack the stack from which to allocate

public static XrSceneObjectsMSFT calloc(MemoryStack stack)

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

Parameters

stack:MemoryStack: the stack from which to allocate

calloc back to summary

calloc	back to summary
public static XrSceneObjectsMSFT.Buffer calloc(int capacity, MemoryStack stack) Returns a new `XrSceneObjectsMSFT.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

public static XrSceneObjectsMSFT.Buffer calloc(int capacity, MemoryStack stack)

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

create back to summary

create	back to summary
protected XrSceneObjectsMSFT 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

protected XrSceneObjectsMSFT 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

create	back to summary
public static XrSceneObjectsMSFT create() Returns a new `XrSceneObjectsMSFT` instance allocated with `BufferUtils`.

create	back to summary
public static XrSceneObjectsMSFT create(long address) Returns a new `XrSceneObjectsMSFT` instance for the specified memory address.

create back to summary

create	back to summary
public static XrSceneObjectsMSFT.Buffer create(int capacity) Returns a new `XrSceneObjectsMSFT.Buffer` instance allocated with `BufferUtils`. Parameters capacity:int the buffer capacity

public static XrSceneObjectsMSFT.Buffer create(int capacity)

Returns a new XrSceneObjectsMSFT.Buffer instance allocated with BufferUtils.

Parameters

capacity:int: the buffer capacity

create back to summary

create	back to summary
public static XrSceneObjectsMSFT.Buffer create(long address, int capacity) Create a `XrSceneObjectsMSFT.Buffer` instance at the specified memory. Parameters address:long the memory address capacity:int the buffer capacity

public static XrSceneObjectsMSFT.Buffer create(long address, int capacity)

Create a XrSceneObjectsMSFT.Buffer instance at the specified memory.

Parameters

address:long: the memory address
capacity:int: the buffer capacity

createSafe back to summary

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

public static XrSceneObjectsMSFT createSafe(long address)

Like create, but returns null if address is NULL.

Annotations

@Nullable

createSafe back to summary

createSafe	back to summary
public static XrSceneObjectsMSFT.Buffer createSafe(long address, int capacity) Like `create`, but returns `null` if `address` is `NULL`. Annotations @Nullable

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

Like create, but returns null if address is NULL.

Annotations

@Nullable

malloc	back to summary
public static XrSceneObjectsMSFT malloc() Returns a new `XrSceneObjectsMSFT` instance allocated with `memAlloc`. The instance must be explicitly freed.

malloc back to summary

malloc	back to summary
public static XrSceneObjectsMSFT.Buffer malloc(int capacity) Returns a new `XrSceneObjectsMSFT.Buffer` instance allocated with `memAlloc`. The instance must be explicitly freed. Parameters capacity:int the buffer capacity

public static XrSceneObjectsMSFT.Buffer malloc(int capacity)

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

Parameters

capacity:int: the buffer capacity

malloc back to summary

malloc	back to summary
public static XrSceneObjectsMSFT malloc(MemoryStack stack) Returns a new `XrSceneObjectsMSFT` instance allocated on the specified `MemoryStack`. Parameters stack:MemoryStack the stack from which to allocate

public static XrSceneObjectsMSFT malloc(MemoryStack stack)

Returns a new XrSceneObjectsMSFT instance allocated on the specified MemoryStack.

Parameters

stack:MemoryStack: the stack from which to allocate

malloc back to summary

malloc	back to summary
public static XrSceneObjectsMSFT.Buffer malloc(int capacity, MemoryStack stack) Returns a new `XrSceneObjectsMSFT.Buffer` instance allocated on the specified `MemoryStack`. Parameters capacity:int the buffer capacity stack:MemoryStack the stack from which to allocate

public static XrSceneObjectsMSFT.Buffer malloc(int capacity, MemoryStack stack)

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

Parameters

capacity:int: the buffer capacity
stack:MemoryStack: the stack from which to allocate

next back to summary

next	back to summary
public long next() `NULL` or a pointer to the next structure in a structure chain. Annotations @NativeType:void *

public long next()

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

Annotations

@NativeType:void *

next	back to summary
public XrSceneObjectsMSFT next(long value) Sets the specified value to the `next` field.

nnext	back to summary
public static long nnext(long struct) Unsafe version of `next`.

nnext	back to summary
public static void nnext(long struct, long value) Unsafe version of `next`.

nsceneObjectCount	back to summary
public static int nsceneObjectCount(long struct) Unsafe version of `sceneObjectCount`.

nsceneObjectCount	back to summary
public static void nsceneObjectCount(long struct, int value) Sets the specified value to the `sceneObjectCount` field of the specified `struct`.

nsceneObjects back to summary

nsceneObjects	back to summary
public static XrSceneObjectMSFT.Buffer nsceneObjects(long struct) Unsafe version of `sceneObjects`. Annotations @Nullable

public static XrSceneObjectMSFT.Buffer nsceneObjects(long struct)

Unsafe version of sceneObjects.

Annotations

@Nullable

nsceneObjects	back to summary
public static void nsceneObjects(long struct, XrSceneObjectMSFT.Buffer value) Unsafe version of `sceneObjects`.

ntype	back to summary
public static int ntype(long struct) Unsafe version of `type`.

ntype	back to summary
public static void ntype(long struct, int value) Unsafe version of `type`.

sceneObjectCount back to summary

sceneObjectCount	back to summary
public int sceneObjectCount() a `uint32_t` describing the count of elements in the `sceneObjects` array. Annotations @NativeType:uint32_t

public int sceneObjectCount()

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

Annotations

@NativeType:uint32_t

sceneObjectCount	back to summary
public XrSceneObjectsMSFT sceneObjectCount(int value) Sets the specified value to the `sceneObjectCount` field.

sceneObjects back to summary

sceneObjects	back to summary
public XrSceneObjectMSFT.Buffer sceneObjects() an array of `XrSceneObjectMSFT`. Annotations @Nullable @NativeType:XrSceneObjectMSFT *

public XrSceneObjectMSFT.Buffer sceneObjects()

an array of XrSceneObjectMSFT.

Annotations

@Nullable
@NativeType:XrSceneObjectMSFT *

sceneObjects	back to summary
public XrSceneObjectsMSFT sceneObjects(XrSceneObjectMSFT.Buffer value) Sets the address of the specified `XrSceneObjectMSFT.Buffer` to the `sceneObjects` field.

set	back to summary
public XrSceneObjectsMSFT set(int type, long next, int sceneObjectCount, XrSceneObjectMSFT.Buffer sceneObjects) Initializes this struct with the specified values.

set	back to summary
public XrSceneObjectsMSFT set(XrSceneObjectsMSFT src) Copies the specified struct data to this struct. Parameters src:XrSceneObjectsMSFT the source struct Returns:XrSceneObjectsMSFT this struct

set

back to summary

public XrSceneObjectsMSFT set(XrSceneObjectsMSFT src)

Copies the specified struct data to this struct.

Parameters

src:XrSceneObjectsMSFT: the source struct

Returns:XrSceneObjectsMSFT

this struct

sizeof back to summary

sizeof	back to summary
public int sizeof() Implements abstract org.lwjgl.system.Struct.sizeof. Doc from org.lwjgl.system.Struct.sizeof. Returns `sizeof(struct)`. Annotations @Override

public int sizeof()

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

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

Returns sizeof(struct).

Annotations

@Override

type back to summary

type	back to summary
public int type() the `XrStructureType` of this structure. Annotations @NativeType:XrStructureType

public int type()

the XrStructureType of this structure.

Annotations

@NativeType:XrStructureType

type	back to summary
public XrSceneObjectsMSFT type(int value) Sets the specified value to the `type` field.

type$Default	back to summary
public XrSceneObjectsMSFT type$Default() Sets the `TYPE_SCENE_OBJECTS_MSFT` value to the `type` field.

org.lwjgl.openxr back to summary

public Class XrSceneObjectsMSFT.Buffer

Class Inheritance

extends StructBuffer<XrSceneObjectsMSFT, XrSceneObjectsMSFT.Buffer>
implements NativeResource

java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.CustomBuffer
org.lwjgl.system.StructBuffer
org.lwjgl.openxr.XrSceneObjectsMSFT.Buffer

All Implemented Interfaces

org.lwjgl.system.NativeResource, java.lang.AutoCloseable

An array of XrSceneObjectsMSFT structs.

Field Summary

Modifier and Type	Field and Description
private static final XrSceneObjectsMSFT	ELEMENT_FACTORY

Constructor Summary

Access	Constructor and Description
public	Buffer(ByteBuffer container) Creates a new `XrSceneObjectsMSFT.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 Type	Method and Description
protected XrSceneObjectsMSFT	getElementFactory() Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.
public long	Returns: the value of the `XrSceneObjectsMSFT#next` field. next()
public XrSceneObjectsMSFT.Buffer	next(long value) Sets the specified value to the `XrSceneObjectsMSFT#next` field.
public int	Returns: the value of the `XrSceneObjectsMSFT#sceneObjectCount` field. sceneObjectCount()
public XrSceneObjectsMSFT.Buffer	sceneObjectCount(int value) Sets the specified value to the `XrSceneObjectsMSFT#sceneObjectCount` field.
public XrSceneObjectMSFT.Buffer	Returns: a `XrSceneObjectMSFT.Buffer` view of the struct array pointed to by the `XrSceneObjectsMSFT#sceneObjects` field. sceneObjects()
public XrSceneObjectsMSFT.Buffer	sceneObjects(XrSceneObjectMSFT.Buffer value) Sets the address of the specified `XrSceneObjectMSFT.Buffer` to the `XrSceneObjectsMSFT#sceneObjects` field.
protected XrSceneObjectsMSFT.Buffer	self() Implements abstract org.lwjgl.system.CustomBuffer.self.
public int	Returns: the value of the `XrSceneObjectsMSFT#type` field. type()
public XrSceneObjectsMSFT.Buffer	type(int value) Sets the specified value to the `XrSceneObjectsMSFT#type` field.
public XrSceneObjectsMSFT.Buffer	type$Default() Sets the `TYPE_SCENE_OBJECTS_MSFT` value to the `XrSceneObjectsMSFT#type` field.

Inherited from org.lwjgl.system.StructBuffer:: apply apply forEach get get get get iterator parallelStream put put sizeof spliterator stream

Field Detail

ELEMENT_FACTORY	back to summary
private static final XrSceneObjectsMSFT ELEMENT_FACTORY

Constructor Detail

Buffer back to summary

public Buffer(ByteBuffer container)

Creates a new XrSceneObjectsMSFT.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 XrSceneObjectsMSFT#SIZEOF, and its mark will be undefined.

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

Buffer	back to summary
public Buffer(long address, int cap)

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

Method Detail

getElementFactory

back to summary

protected XrSceneObjectsMSFT getElementFactory()

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

Annotations

@Override

next	back to summary
public long next() Returns:long the value of the `XrSceneObjectsMSFT#next` field. Annotations @NativeType:void *

next	back to summary
public XrSceneObjectsMSFT.Buffer next(long value) Sets the specified value to the `XrSceneObjectsMSFT#next` field.

sceneObjectCount	back to summary
public int sceneObjectCount() Returns:int the value of the `XrSceneObjectsMSFT#sceneObjectCount` field. Annotations @NativeType:uint32_t

sceneObjectCount	back to summary
public XrSceneObjectsMSFT.Buffer sceneObjectCount(int value) Sets the specified value to the `XrSceneObjectsMSFT#sceneObjectCount` field.

sceneObjects	back to summary
public XrSceneObjectMSFT.Buffer sceneObjects() Returns:XrSceneObjectMSFT.Buffer a `XrSceneObjectMSFT.Buffer` view of the struct array pointed to by the `XrSceneObjectsMSFT#sceneObjects` field. Annotations @Nullable @NativeType:XrSceneObjectMSFT *

sceneObjects	back to summary
public XrSceneObjectsMSFT.Buffer sceneObjects(XrSceneObjectMSFT.Buffer value) Sets the address of the specified `XrSceneObjectMSFT.Buffer` to the `XrSceneObjectsMSFT#sceneObjects` field.

self

back to summary

protected XrSceneObjectsMSFT.Buffer self()

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

Annotations

@Override

type	back to summary
public int type() Returns:int the value of the `XrSceneObjectsMSFT#type` field. Annotations @NativeType:XrStructureType

type	back to summary
public XrSceneObjectsMSFT.Buffer type(int value) Sets the specified value to the `XrSceneObjectsMSFT#type` field.

type$Default	back to summary
public XrSceneObjectsMSFT.Buffer type$Default() Sets the `TYPE_SCENE_OBJECTS_MSFT` value to the `XrSceneObjectsMSFT#type` field.

public Class XrSceneObjectsMSFT

Description

Valid Usage (Implicit)

See Also

Layout

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class XrSceneObjectsMSFT.Buffer

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail