Scene component.

Description

The runtime must set parentId to either zero or a valid XrUuidMSFT that corresponds to a scene component of type SCENE_COMPONENT_TYPE_OBJECT_MSFT that exists in the XrSceneMSFT.

Note

The parent scene object is intended to allow scene components to be grouped. For example, the scene object for a wall might have multiple scene component children like SCENE_COMPONENT_TYPE_PLANE_MSFT, SCENE_COMPONENT_TYPE_VISUAL_MESH_MSFT, and SCENE_COMPONENT_TYPE_COLLIDER_MESH_MSFT. Those child scene components would be alternative representations of the same wall.

Valid Usage (Implicit)

The XR_MSFT_scene_understanding extension must be enabled prior to using XrSceneComponentMSFT
componentType must be a valid XrSceneComponentTypeMSFT value

Layout


struct XrSceneComponentMSFT {
    XrSceneComponentTypeMSFT componentType;
    XrUuidMSFT id;
    XrUuidMSFT parentId;
    XrTime updateTime;
}

Nested and Inner Type Summary

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

Field Summary

Modifier and Type	Field and Description
public static final int	ALIGNOF The struct alignment in bytes.
public static final int	COMPONENTTYPE The struct member offsets.
public static final int	ID The struct member offsets.
public static final int	PARENTID The struct member offsets.
public static final int	SIZEOF The struct size in bytes.
public static final int	UPDATETIME The struct member offsets.

Inherited from org.lwjgl.system.Struct:: container DEFAULT_ALIGN_AS DEFAULT_PACK_ALIGNMENT

Constructor Summary

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

Method Summary

Modifier and Type	Method and Description
public static XrSceneComponentMSFT	calloc() Returns a new `XrSceneComponentMSFT` instance allocated with `memCalloc`.
public static XrSceneComponentMSFT.Buffer	calloc(int the buffer capacity capacity) Returns a new `XrSceneComponentMSFT.Buffer` instance allocated with `memCalloc`.
public static XrSceneComponentMSFT	calloc(MemoryStack the stack from which to allocate stack) Returns a new `XrSceneComponentMSFT` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
public static XrSceneComponentMSFT.Buffer	calloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `XrSceneComponentMSFT.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
public int	componentType() the `XrSceneComponentTypeMSFT` of the scene component.
public XrSceneComponentMSFT	componentType(int value) Sets the specified value to the `componentType` field.
protected XrSceneComponentMSFT	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 XrSceneComponentMSFT	create() Returns a new `XrSceneComponentMSFT` instance allocated with `BufferUtils`.
public static XrSceneComponentMSFT	create(long address) Returns a new `XrSceneComponentMSFT` instance for the specified memory address.
public static XrSceneComponentMSFT.Buffer	create(int the buffer capacity capacity) Returns a new `XrSceneComponentMSFT.Buffer` instance allocated with `BufferUtils`.
public static XrSceneComponentMSFT.Buffer	create(long the memory address address, int the buffer capacity capacity) Create a `XrSceneComponentMSFT.Buffer` instance at the specified memory.
public static XrSceneComponentMSFT	createSafe(long address) Like `create`, but returns `null` if `address` is `NULL`.
public static XrSceneComponentMSFT.Buffer	createSafe(long address, int capacity) Like `create`, but returns `null` if `address` is `NULL`.
public XrUuidMSFT	id() the `XrUuidMSFT` of the scene component.
public XrSceneComponentMSFT	id(XrUuidMSFT value) Copies the specified `XrUuidMSFT` to the `id` field.
public XrSceneComponentMSFT	id(Consumer<XrUuidMSFT> consumer) Passes the `id` field to the specified `Consumer`.
public static XrSceneComponentMSFT	malloc() Returns a new `XrSceneComponentMSFT` instance allocated with `memAlloc`.
public static XrSceneComponentMSFT.Buffer	malloc(int the buffer capacity capacity) Returns a new `XrSceneComponentMSFT.Buffer` instance allocated with `memAlloc`.
public static XrSceneComponentMSFT	malloc(MemoryStack the stack from which to allocate stack) Returns a new `XrSceneComponentMSFT` instance allocated on the specified `MemoryStack`.
public static XrSceneComponentMSFT.Buffer	malloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `XrSceneComponentMSFT.Buffer` instance allocated on the specified `MemoryStack`.
public static int	ncomponentType(long struct) Unsafe version of `componentType`.
public static void	ncomponentType(long struct, int value) Unsafe version of `componentType`.
public static XrUuidMSFT	nid(long struct) Unsafe version of `id`.
public static void	nid(long struct, XrUuidMSFT value) Unsafe version of `id`.
public static XrUuidMSFT	nparentId(long struct) Unsafe version of `parentId`.
public static void	nparentId(long struct, XrUuidMSFT value) Unsafe version of `parentId`.
public static long	nupdateTime(long struct) Unsafe version of `updateTime`.
public static void	nupdateTime(long struct, long value) Unsafe version of `updateTime`.
public XrUuidMSFT	parentId() the `XrUuidMSFT` of the parent scene object.
public XrSceneComponentMSFT	parentId(XrUuidMSFT value) Copies the specified `XrUuidMSFT` to the `parentId` field.
public XrSceneComponentMSFT	parentId(Consumer<XrUuidMSFT> consumer) Passes the `parentId` field to the specified `Consumer`.
public XrSceneComponentMSFT	set(int componentType, XrUuidMSFT id, XrUuidMSFT parentId, long updateTime) Initializes this struct with the specified values.
public XrSceneComponentMSFT	Returns: this struct set(XrSceneComponentMSFT 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	updateTime() the `XrTime` that this scene component was last updated.
public XrSceneComponentMSFT	updateTime(long value) Sets the specified value to the `updateTime` field.

Field Detail

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

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

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

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

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

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

Constructor Detail

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

XrSceneComponentMSFT back to summary

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

Creates a XrSceneComponentMSFT 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 XrSceneComponentMSFT calloc() Returns a new `XrSceneComponentMSFT` instance allocated with `memCalloc`. The instance must be explicitly freed.

calloc back to summary

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

public static XrSceneComponentMSFT.Buffer calloc(int capacity)

Returns a new XrSceneComponentMSFT.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 XrSceneComponentMSFT calloc(MemoryStack stack) Returns a new `XrSceneComponentMSFT` instance allocated on the specified `MemoryStack` and initializes all its bits to zero. Parameters stack:MemoryStack the stack from which to allocate

public static XrSceneComponentMSFT calloc(MemoryStack stack)

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

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

componentType back to summary

componentType	back to summary
public int componentType() the `XrSceneComponentTypeMSFT` of the scene component. Annotations @NativeType:XrSceneComponentTypeMSFT

public int componentType()

the XrSceneComponentTypeMSFT of the scene component.

Annotations

@NativeType:XrSceneComponentTypeMSFT

componentType	back to summary
public XrSceneComponentMSFT componentType(int value) Sets the specified value to the `componentType` field.

create back to summary

create	back to summary
protected XrSceneComponentMSFT 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 XrSceneComponentMSFT 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 XrSceneComponentMSFT create() Returns a new `XrSceneComponentMSFT` instance allocated with `BufferUtils`.

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

create back to summary

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

public static XrSceneComponentMSFT.Buffer create(int capacity)

Returns a new XrSceneComponentMSFT.Buffer instance allocated with BufferUtils.

Parameters

capacity:int: the buffer capacity

create back to summary

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

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

Create a XrSceneComponentMSFT.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 XrSceneComponentMSFT createSafe(long address) Like `create`, but returns `null` if `address` is `NULL`. Annotations @Nullable

public static XrSceneComponentMSFT createSafe(long address)

Like create, but returns null if address is NULL.

Annotations

@Nullable

createSafe back to summary

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

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

Like create, but returns null if address is NULL.

Annotations

@Nullable

id	back to summary
public XrUuidMSFT id() the `XrUuidMSFT` of the scene component.

id	back to summary
public XrSceneComponentMSFT id(XrUuidMSFT value) Copies the specified `XrUuidMSFT` to the `id` field.

id	back to summary
public XrSceneComponentMSFT id(Consumer<XrUuidMSFT> consumer) Passes the `id` field to the specified `Consumer`.

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

malloc back to summary

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

public static XrSceneComponentMSFT.Buffer malloc(int capacity)

Returns a new XrSceneComponentMSFT.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 XrSceneComponentMSFT malloc(MemoryStack stack) Returns a new `XrSceneComponentMSFT` instance allocated on the specified `MemoryStack`. Parameters stack:MemoryStack the stack from which to allocate

public static XrSceneComponentMSFT malloc(MemoryStack stack)

Returns a new XrSceneComponentMSFT 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 XrSceneComponentMSFT.Buffer malloc(int capacity, MemoryStack stack) Returns a new `XrSceneComponentMSFT.Buffer` instance allocated on the specified `MemoryStack`. Parameters capacity:int the buffer capacity stack:MemoryStack the stack from which to allocate

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

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

Parameters

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

ncomponentType	back to summary
public static int ncomponentType(long struct) Unsafe version of `componentType`.

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

nid	back to summary
public static XrUuidMSFT nid(long struct) Unsafe version of `id`.

nid	back to summary
public static void nid(long struct, XrUuidMSFT value) Unsafe version of `id`.

nparentId	back to summary
public static XrUuidMSFT nparentId(long struct) Unsafe version of `parentId`.

nparentId	back to summary
public static void nparentId(long struct, XrUuidMSFT value) Unsafe version of `parentId`.

nupdateTime	back to summary
public static long nupdateTime(long struct) Unsafe version of `updateTime`.

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

parentId	back to summary
public XrUuidMSFT parentId() the `XrUuidMSFT` of the parent scene object. If the scene component does not have a parent, then `parentId` will be equal to zero.

parentId	back to summary
public XrSceneComponentMSFT parentId(XrUuidMSFT value) Copies the specified `XrUuidMSFT` to the `parentId` field.

parentId	back to summary
public XrSceneComponentMSFT parentId(Consumer<XrUuidMSFT> consumer) Passes the `parentId` field to the specified `Consumer`.

set	back to summary
public XrSceneComponentMSFT set(int componentType, XrUuidMSFT id, XrUuidMSFT parentId, long updateTime) Initializes this struct with the specified values.

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

set

back to summary

public XrSceneComponentMSFT set(XrSceneComponentMSFT src)

Copies the specified struct data to this struct.

Parameters

src:XrSceneComponentMSFT: the source struct

Returns:XrSceneComponentMSFT

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

updateTime back to summary

updateTime	back to summary
public long updateTime() the `XrTime` that this scene component was last updated. Annotations @NativeType:XrTime

public long updateTime()

the XrTime that this scene component was last updated.

Annotations

@NativeType:XrTime

updateTime	back to summary
public XrSceneComponentMSFT updateTime(long value) Sets the specified value to the `updateTime` field.

org.lwjgl.openxr back to summary

public Class XrSceneComponentMSFT.Buffer

Class Inheritance

extends StructBuffer<XrSceneComponentMSFT, XrSceneComponentMSFT.Buffer>
implements NativeResource

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

All Implemented Interfaces

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

An array of XrSceneComponentMSFT structs.

Field Summary

Modifier and Type	Field and Description
private static final XrSceneComponentMSFT	ELEMENT_FACTORY

Constructor Summary

Access	Constructor and Description
public	Buffer(ByteBuffer container) Creates a new `XrSceneComponentMSFT.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
public int	Returns: the value of the `XrSceneComponentMSFT#componentType` field. componentType()
public XrSceneComponentMSFT.Buffer	componentType(int value) Sets the specified value to the `XrSceneComponentMSFT#componentType` field.
protected XrSceneComponentMSFT	getElementFactory() Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.
public XrUuidMSFT	Returns: a `XrUuidMSFT` view of the `XrSceneComponentMSFT#id` field. id()
public XrSceneComponentMSFT.Buffer	id(XrUuidMSFT value) Copies the specified `XrUuidMSFT` to the `XrSceneComponentMSFT#id` field.
public XrSceneComponentMSFT.Buffer	id(Consumer<XrUuidMSFT> consumer) Passes the `XrSceneComponentMSFT#id` field to the specified `Consumer`.
public XrUuidMSFT	Returns: a `XrUuidMSFT` view of the `XrSceneComponentMSFT#parentId` field. parentId()
public XrSceneComponentMSFT.Buffer	parentId(XrUuidMSFT value) Copies the specified `XrUuidMSFT` to the `XrSceneComponentMSFT#parentId` field.
public XrSceneComponentMSFT.Buffer	parentId(Consumer<XrUuidMSFT> consumer) Passes the `XrSceneComponentMSFT#parentId` field to the specified `Consumer`.
protected XrSceneComponentMSFT.Buffer	self() Implements abstract org.lwjgl.system.CustomBuffer.self.
public long	Returns: the value of the `XrSceneComponentMSFT#updateTime` field. updateTime()
public XrSceneComponentMSFT.Buffer	updateTime(long value) Sets the specified value to the `XrSceneComponentMSFT#updateTime` 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 XrSceneComponentMSFT ELEMENT_FACTORY

Constructor Detail

Buffer back to summary

public Buffer(ByteBuffer container)

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

componentType	back to summary
public int componentType() Returns:int the value of the `XrSceneComponentMSFT#componentType` field. Annotations @NativeType:XrSceneComponentTypeMSFT

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

getElementFactory

back to summary

protected XrSceneComponentMSFT getElementFactory()

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

Annotations

@Override

id	back to summary
public XrUuidMSFT id() Returns:XrUuidMSFT a `XrUuidMSFT` view of the `XrSceneComponentMSFT#id` field.

id	back to summary
public XrSceneComponentMSFT.Buffer id(XrUuidMSFT value) Copies the specified `XrUuidMSFT` to the `XrSceneComponentMSFT#id` field.

id	back to summary
public XrSceneComponentMSFT.Buffer id(Consumer<XrUuidMSFT> consumer) Passes the `XrSceneComponentMSFT#id` field to the specified `Consumer`.

parentId	back to summary
public XrUuidMSFT parentId() Returns:XrUuidMSFT a `XrUuidMSFT` view of the `XrSceneComponentMSFT#parentId` field.

parentId	back to summary
public XrSceneComponentMSFT.Buffer parentId(XrUuidMSFT value) Copies the specified `XrUuidMSFT` to the `XrSceneComponentMSFT#parentId` field.

parentId	back to summary
public XrSceneComponentMSFT.Buffer parentId(Consumer<XrUuidMSFT> consumer) Passes the `XrSceneComponentMSFT#parentId` field to the specified `Consumer`.

self

back to summary

protected XrSceneComponentMSFT.Buffer self()

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

Annotations

@Override

updateTime	back to summary
public long updateTime() Returns:long the value of the `XrSceneComponentMSFT#updateTime` field. Annotations @NativeType:XrTime

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

public Class XrSceneComponentMSFT

Description

Note

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 XrSceneComponentMSFT.Buffer

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail