Package org.lwjgl.openxr

Class XrSceneMeshVertexBufferMSFT

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<XrSceneMeshVertexBufferMSFT>

org.lwjgl.openxr.XrSceneMeshVertexBufferMSFT

All Implemented Interfaces:

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

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

Scene mesh vertex buffer.

Valid Usage (Implicit)

• The XR_MSFT_scene_understanding extension must be enabled prior to using XrSceneMeshVertexBufferMSFT
• type must be TYPE_SCENE_MESH_VERTEX_BUFFER_MSFT
• next must be NULL or a valid pointer to the next structure in a structure chain
• If vertexCapacityInput is not 0, vertices must be a pointer to an array of vertexCapacityInput XrVector3f structures

See Also

XrSceneMeshBuffersMSFT, XrVector3f, GetSceneMeshBuffersMSFT

Layout

 struct XrSceneMeshVertexBufferMSFT {
     XrStructureType type();
     void * next();
     uint32_t vertexCapacityInput();
     uint32_t vertexCountOutput();
     XrVector3f * vertices();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	XrSceneMeshVertexBufferMSFT.Buffer	An array of XrSceneMeshVertexBufferMSFT 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	NEXT	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.
static final int	TYPE	The struct member offsets.
static final int	VERTEXCAPACITYINPUT	The struct member offsets.
static final int	VERTEXCOUNTOUTPUT	The struct member offsets.
static final int	VERTICES	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
XrSceneMeshVertexBufferMSFT(ByteBuffer container)	Creates a XrSceneMeshVertexBufferMSFT instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static XrSceneMeshVertexBufferMSFT	calloc()	Returns a new XrSceneMeshVertexBufferMSFT instance allocated with memCalloc.
static XrSceneMeshVertexBufferMSFT.Buffer	calloc(int capacity)	Returns a new XrSceneMeshVertexBufferMSFT.Buffer instance allocated with memCalloc.
static XrSceneMeshVertexBufferMSFT.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrSceneMeshVertexBufferMSFT.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrSceneMeshVertexBufferMSFT	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrSceneMeshVertexBufferMSFT instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrSceneMeshVertexBufferMSFT	create()	Returns a new XrSceneMeshVertexBufferMSFT instance allocated with BufferUtils.
static XrSceneMeshVertexBufferMSFT.Buffer	create(int capacity)	Returns a new XrSceneMeshVertexBufferMSFT.Buffer instance allocated with BufferUtils.
static XrSceneMeshVertexBufferMSFT	create(long address)	Returns a new XrSceneMeshVertexBufferMSFT instance for the specified memory address.
static XrSceneMeshVertexBufferMSFT.Buffer	create(long address, int capacity)	Create a XrSceneMeshVertexBufferMSFT.Buffer instance at the specified memory.
static @Nullable XrSceneMeshVertexBufferMSFT	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable XrSceneMeshVertexBufferMSFT.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
static XrSceneMeshVertexBufferMSFT	malloc()	Returns a new XrSceneMeshVertexBufferMSFT instance allocated with memAlloc.
static XrSceneMeshVertexBufferMSFT.Buffer	malloc(int capacity)	Returns a new XrSceneMeshVertexBufferMSFT.Buffer instance allocated with memAlloc.
static XrSceneMeshVertexBufferMSFT.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrSceneMeshVertexBufferMSFT.Buffer instance allocated on the specified MemoryStack.
static XrSceneMeshVertexBufferMSFT	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrSceneMeshVertexBufferMSFT instance allocated on the specified MemoryStack.
long	next()	NULL or a pointer to the next structure in a structure chain.
XrSceneMeshVertexBufferMSFT	next(long value)	Sets the specified value to the next() field.
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.
static int	nvertexCapacityInput(long struct)	Unsafe version of vertexCapacityInput().
static void	nvertexCapacityInput(long struct, int value)	Sets the specified value to the vertexCapacityInput field of the specified struct.
static int	nvertexCountOutput(long struct)	Unsafe version of vertexCountOutput().
static void	nvertexCountOutput(long struct, int value)	Unsafe version of vertexCountOutput.
static @Nullable XrVector3f.Buffer	nvertices(long struct)	Unsafe version of vertices().
static void	nvertices(long struct, @Nullable XrVector3f.Buffer value)	Unsafe version of vertices.
XrSceneMeshVertexBufferMSFT	set(int type, long next, int vertexCapacityInput, int vertexCountOutput, @Nullable XrVector3f.Buffer vertices)	Initializes this struct with the specified values.
XrSceneMeshVertexBufferMSFT	set(XrSceneMeshVertexBufferMSFT src)	Copies the specified struct data to this struct.
int	sizeof()
int	type()	the XrStructureType of this structure.
XrSceneMeshVertexBufferMSFT	type(int value)	Sets the specified value to the type() field.
XrSceneMeshVertexBufferMSFT	type$Default()	Sets the TYPE_SCENE_MESH_VERTEX_BUFFER_MSFT value to the type() field.
int	vertexCapacityInput()	the capacity of the array, or 0 to indicate a request to retrieve the required capacity.
XrSceneMeshVertexBufferMSFT	vertexCapacityInput(int value)	Sets the specified value to the vertexCapacityInput() field.
int	vertexCountOutput()	the count of vertices, or the required capacity in the case that vertexCapacityInput is insufficient.
XrSceneMeshVertexBufferMSFT	vertexCountOutput(int value)	Sets the specified value to the vertexCountOutput() field.
@Nullable XrVector3f.Buffer	vertices()	an array of XrVector3f filled in by the runtime returns the position of vertices in the mesh component’s space.
XrSceneMeshVertexBufferMSFT	vertices(@Nullable XrVector3f.Buffer value)	Sets the address of the specified XrVector3f.Buffer to the vertices() 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.

VERTEXCAPACITYINPUT

public static final int VERTEXCAPACITYINPUT

The struct member offsets.

VERTEXCOUNTOUTPUT

public static final int VERTEXCOUNTOUTPUT

The struct member offsets.

VERTICES

public static final int VERTICES

The struct member offsets.

Constructor Details

XrSceneMeshVertexBufferMSFT

public XrSceneMeshVertexBufferMSFT(ByteBuffer container)

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

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.

vertexCapacityInput

public int vertexCapacityInput()

the capacity of the array, or 0 to indicate a request to retrieve the required capacity.

vertexCountOutput

public int vertexCountOutput()

the count of vertices, or the required capacity in the case that vertexCapacityInput is insufficient.

vertices

public @Nullable XrVector3f.Buffer vertices()

an array of XrVector3f filled in by the runtime returns the position of vertices in the mesh component’s space.

type

public XrSceneMeshVertexBufferMSFT type(int value)

Sets the specified value to the type() field.

type$Default

public XrSceneMeshVertexBufferMSFT type$Default()

Sets the TYPE_SCENE_MESH_VERTEX_BUFFER_MSFT value to the type() field.

next

public XrSceneMeshVertexBufferMSFT next(long value)

Sets the specified value to the next() field.

vertexCapacityInput

public XrSceneMeshVertexBufferMSFT vertexCapacityInput(int value)

Sets the specified value to the vertexCapacityInput() field.

vertexCountOutput

public XrSceneMeshVertexBufferMSFT vertexCountOutput(int value)

Sets the specified value to the vertexCountOutput() field.

vertices

public XrSceneMeshVertexBufferMSFT vertices(@Nullable XrVector3f.Buffer value)

Sets the address of the specified XrVector3f.Buffer to the vertices() field.

set

public XrSceneMeshVertexBufferMSFT set(int type,
 long next,
 int vertexCapacityInput,
 int vertexCountOutput,
 @Nullable XrVector3f.Buffer vertices)

Initializes this struct with the specified values.

set

public XrSceneMeshVertexBufferMSFT set(XrSceneMeshVertexBufferMSFT src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static XrSceneMeshVertexBufferMSFT malloc()

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

calloc

public static XrSceneMeshVertexBufferMSFT calloc()

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

create

public static XrSceneMeshVertexBufferMSFT create()

Returns a new XrSceneMeshVertexBufferMSFT instance allocated with BufferUtils.

create

public static XrSceneMeshVertexBufferMSFT create(long address)

Returns a new XrSceneMeshVertexBufferMSFT instance for the specified memory address.

createSafe

public static @Nullable XrSceneMeshVertexBufferMSFT createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static XrSceneMeshVertexBufferMSFT.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static XrSceneMeshVertexBufferMSFT.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static XrSceneMeshVertexBufferMSFT.Buffer create(int capacity)

Returns a new XrSceneMeshVertexBufferMSFT.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a XrSceneMeshVertexBufferMSFT.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new XrSceneMeshVertexBufferMSFT instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

Returns a new XrSceneMeshVertexBufferMSFT.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().

nvertexCapacityInput

public static int nvertexCapacityInput(long struct)

Unsafe version of vertexCapacityInput().

nvertexCountOutput

public static int nvertexCountOutput(long struct)

Unsafe version of vertexCountOutput().

nvertices

public static @Nullable XrVector3f.Buffer nvertices(long struct)

Unsafe version of vertices().

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.

nvertexCapacityInput

public static void nvertexCapacityInput(long struct,
 int value)

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

nvertexCountOutput

public static void nvertexCountOutput(long struct,
 int value)

Unsafe version of vertexCountOutput.

nvertices

public static void nvertices(long struct,
 @Nullable XrVector3f.Buffer value)

Unsafe version of vertices.