Package org.lwjgl.openxr

Class XrSceneDeserializeInfoMSFT

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<XrSceneDeserializeInfoMSFT>

org.lwjgl.openxr.XrSceneDeserializeInfoMSFT

All Implemented Interfaces:

AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer

public class XrSceneDeserializeInfoMSFT
extends org.lwjgl.system.Struct<XrSceneDeserializeInfoMSFT>
implements org.lwjgl.system.NativeResource

The information to deserialize a binary scene.

Description

If the scene fragments are not in the same order as returned by GetSceneComponentsMSFT or the runtime failed to deserialized the binary data then GetSceneComputeStateMSFT must return SCENE_COMPUTE_STATE_COMPLETED_WITH_ERROR_MSFT.

Valid Usage (Implicit)

• The XR_MSFT_scene_understanding_serialization extension must be enabled prior to using XrSceneDeserializeInfoMSFT
• type must be TYPE_SCENE_DESERIALIZE_INFO_MSFT
• next must be NULL or a valid pointer to the next structure in a structure chain
• If fragmentCount is not 0, fragments must be a pointer to an array of fragmentCount valid XrDeserializeSceneFragmentMSFT structures

See Also

XrDeserializeSceneFragmentMSFT, DeserializeSceneMSFT

Layout

 struct XrSceneDeserializeInfoMSFT {
     XrStructureType type();
     void const * next();
     uint32_t fragmentCount();
     XrDeserializeSceneFragmentMSFT const * fragments();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	XrSceneDeserializeInfoMSFT.Buffer	An array of XrSceneDeserializeInfoMSFT structs.

Nested classes/interfaces inherited from class org.lwjgl.system.Struct

org.lwjgl.system.Struct.StructValidation

Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer

org.lwjgl.system.Pointer.Default

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ALIGNOF	The struct alignment in bytes.
static final int	FRAGMENTCOUNT	The struct member offsets.
static final int	FRAGMENTS	The struct member offsets.
static final int	NEXT	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.
static final int	TYPE	The struct member offsets.

Fields inherited from interface org.lwjgl.system.Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

Constructor	Description
XrSceneDeserializeInfoMSFT(ByteBuffer container)	Creates a XrSceneDeserializeInfoMSFT instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static XrSceneDeserializeInfoMSFT	calloc()	Returns a new XrSceneDeserializeInfoMSFT instance allocated with memCalloc.
static XrSceneDeserializeInfoMSFT.Buffer	calloc(int capacity)	Returns a new XrSceneDeserializeInfoMSFT.Buffer instance allocated with memCalloc.
static XrSceneDeserializeInfoMSFT.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrSceneDeserializeInfoMSFT.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrSceneDeserializeInfoMSFT	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrSceneDeserializeInfoMSFT instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrSceneDeserializeInfoMSFT	create()	Returns a new XrSceneDeserializeInfoMSFT instance allocated with BufferUtils.
static XrSceneDeserializeInfoMSFT.Buffer	create(int capacity)	Returns a new XrSceneDeserializeInfoMSFT.Buffer instance allocated with BufferUtils.
static XrSceneDeserializeInfoMSFT	create(long address)	Returns a new XrSceneDeserializeInfoMSFT instance for the specified memory address.
static XrSceneDeserializeInfoMSFT.Buffer	create(long address, int capacity)	Create a XrSceneDeserializeInfoMSFT.Buffer instance at the specified memory.
static @Nullable XrSceneDeserializeInfoMSFT	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable XrSceneDeserializeInfoMSFT.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
int	fragmentCount()	the count of XrDeserializeSceneFragmentMSFT structures in the fragments array.
XrSceneDeserializeInfoMSFT	fragmentCount(int value)	Sets the specified value to the fragmentCount() field.
@Nullable XrDeserializeSceneFragmentMSFT.Buffer	fragments()	an array of XrDeserializeSceneFragmentMSFT.
XrSceneDeserializeInfoMSFT	fragments(@Nullable XrDeserializeSceneFragmentMSFT.Buffer value)	Sets the address of the specified XrDeserializeSceneFragmentMSFT.Buffer to the fragments() field.
static XrSceneDeserializeInfoMSFT	malloc()	Returns a new XrSceneDeserializeInfoMSFT instance allocated with memAlloc.
static XrSceneDeserializeInfoMSFT.Buffer	malloc(int capacity)	Returns a new XrSceneDeserializeInfoMSFT.Buffer instance allocated with memAlloc.
static XrSceneDeserializeInfoMSFT.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrSceneDeserializeInfoMSFT.Buffer instance allocated on the specified MemoryStack.
static XrSceneDeserializeInfoMSFT	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrSceneDeserializeInfoMSFT instance allocated on the specified MemoryStack.
long	next()	NULL or a pointer to the next structure in a structure chain.
XrSceneDeserializeInfoMSFT	next(long value)	Sets the specified value to the next() field.
static int	nfragmentCount(long struct)	Unsafe version of fragmentCount().
static void	nfragmentCount(long struct, int value)	Sets the specified value to the fragmentCount field of the specified struct.
static @Nullable XrDeserializeSceneFragmentMSFT.Buffer	nfragments(long struct)	Unsafe version of fragments().
static void	nfragments(long struct, @Nullable XrDeserializeSceneFragmentMSFT.Buffer value)	Unsafe version of fragments.
static long	nnext(long struct)	Unsafe version of next().
static void	nnext(long struct, long value)	Unsafe version of next.
static int	ntype(long struct)	Unsafe version of type().
static void	ntype(long struct, int value)	Unsafe version of type.
XrSceneDeserializeInfoMSFT	set(int type, long next, int fragmentCount, @Nullable XrDeserializeSceneFragmentMSFT.Buffer fragments)	Initializes this struct with the specified values.
XrSceneDeserializeInfoMSFT	set(XrSceneDeserializeInfoMSFT src)	Copies the specified struct data to this struct.
int	sizeof()
int	type()	the XrStructureType of this structure.
XrSceneDeserializeInfoMSFT	type(int value)	Sets the specified value to the type() field.
XrSceneDeserializeInfoMSFT	type$Default()	Sets the TYPE_SCENE_DESERIALIZE_INFO_MSFT value to the type() field.

Methods inherited from class org.lwjgl.system.Struct

clear, free, isNull, validate, validate

Methods inherited from class org.lwjgl.system.Pointer.Default

address, equals, hashCode, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.lwjgl.system.NativeResource

close, free

Field Details

SIZEOF

public static final int SIZEOF

The struct size in bytes.

ALIGNOF

public static final int ALIGNOF

The struct alignment in bytes.

TYPE

public static final int TYPE

The struct member offsets.

NEXT

public static final int NEXT

The struct member offsets.

FRAGMENTCOUNT

public static final int FRAGMENTCOUNT

The struct member offsets.

FRAGMENTS

public static final int FRAGMENTS

The struct member offsets.

Constructor Details

XrSceneDeserializeInfoMSFT

public XrSceneDeserializeInfoMSFT(ByteBuffer container)

Creates a XrSceneDeserializeInfoMSFT 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 Details

sizeof

public int sizeof()

Specified by:

sizeof in class org.lwjgl.system.Struct<XrSceneDeserializeInfoMSFT>

type

public int type()

the XrStructureType of this structure.

next

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.

fragmentCount

public int fragmentCount()

the count of XrDeserializeSceneFragmentMSFT structures in the fragments array.

fragments

public @Nullable XrDeserializeSceneFragmentMSFT.Buffer fragments()

an array of XrDeserializeSceneFragmentMSFT.

type

public XrSceneDeserializeInfoMSFT type(int value)

Sets the specified value to the type() field.

type$Default

public XrSceneDeserializeInfoMSFT type$Default()

Sets the TYPE_SCENE_DESERIALIZE_INFO_MSFT value to the type() field.

next

public XrSceneDeserializeInfoMSFT next(long value)

Sets the specified value to the next() field.

fragmentCount

public XrSceneDeserializeInfoMSFT fragmentCount(int value)

Sets the specified value to the fragmentCount() field.

fragments

public XrSceneDeserializeInfoMSFT fragments(@Nullable XrDeserializeSceneFragmentMSFT.Buffer value)

Sets the address of the specified XrDeserializeSceneFragmentMSFT.Buffer to the fragments() field.

set

public XrSceneDeserializeInfoMSFT set(int type,
 long next,
 int fragmentCount,
 @Nullable XrDeserializeSceneFragmentMSFT.Buffer fragments)

Initializes this struct with the specified values.

set

public XrSceneDeserializeInfoMSFT set(XrSceneDeserializeInfoMSFT src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static XrSceneDeserializeInfoMSFT malloc()

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

calloc

public static XrSceneDeserializeInfoMSFT calloc()

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

create

public static XrSceneDeserializeInfoMSFT create()

Returns a new XrSceneDeserializeInfoMSFT instance allocated with BufferUtils.

create

public static XrSceneDeserializeInfoMSFT create(long address)

Returns a new XrSceneDeserializeInfoMSFT instance for the specified memory address.

createSafe

public static @Nullable XrSceneDeserializeInfoMSFT createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static XrSceneDeserializeInfoMSFT.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static XrSceneDeserializeInfoMSFT.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static XrSceneDeserializeInfoMSFT.Buffer create(int capacity)

Returns a new XrSceneDeserializeInfoMSFT.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a XrSceneDeserializeInfoMSFT.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

public static @Nullable XrSceneDeserializeInfoMSFT.Buffer createSafe(long address,
 int capacity)

Like create, but returns null if address is NULL.

malloc

public static XrSceneDeserializeInfoMSFT malloc(org.lwjgl.system.MemoryStack stack)

Returns a new XrSceneDeserializeInfoMSFT instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static XrSceneDeserializeInfoMSFT calloc(org.lwjgl.system.MemoryStack stack)

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

Parameters:

stack - the stack from which to allocate

malloc

public static XrSceneDeserializeInfoMSFT.Buffer malloc(int capacity,
 org.lwjgl.system.MemoryStack stack)

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

public static XrSceneDeserializeInfoMSFT.Buffer calloc(int capacity,
 org.lwjgl.system.MemoryStack stack)

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

ntype

public static int ntype(long struct)

Unsafe version of type().

nnext

public static long nnext(long struct)

Unsafe version of next().

nfragmentCount

public static int nfragmentCount(long struct)

Unsafe version of fragmentCount().

nfragments

public static @Nullable XrDeserializeSceneFragmentMSFT.Buffer nfragments(long struct)

Unsafe version of fragments().

ntype

public static void ntype(long struct,
 int value)

Unsafe version of type.

nnext

public static void nnext(long struct,
 long value)

Unsafe version of next.

nfragmentCount

public static void nfragmentCount(long struct,
 int value)

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

nfragments

public static void nfragments(long struct,
 @Nullable XrDeserializeSceneFragmentMSFT.Buffer value)

Unsafe version of fragments.