Package org.lwjgl.openxr

Class XrPlaneDetectorPolygonBufferEXT

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<XrPlaneDetectorPolygonBufferEXT>

org.lwjgl.openxr.XrPlaneDetectorPolygonBufferEXT

All Implemented Interfaces:

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

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

Plane polygon vertex buffer.

Valid Usage (Implicit)

• The XR_EXT_plane_detection extension must be enabled prior to using XrPlaneDetectorPolygonBufferEXT
• type must be TYPE_PLANE_DETECTOR_POLYGON_BUFFER_EXT
• 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 XrVector2f structures

See Also

XrVector2f, GetPlanePolygonBufferEXT

Layout

 struct XrPlaneDetectorPolygonBufferEXT {
     XrStructureType type();
     void * next();
     uint32_t vertexCapacityInput();
     uint32_t vertexCountOutput();
     XrVector2f * vertices();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	XrPlaneDetectorPolygonBufferEXT.Buffer	An array of XrPlaneDetectorPolygonBufferEXT 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
XrPlaneDetectorPolygonBufferEXT(ByteBuffer container)	Creates a XrPlaneDetectorPolygonBufferEXT instance at the current position of the specified ByteBuffer container.

Method Summary

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

XrPlaneDetectorPolygonBufferEXT

public XrPlaneDetectorPolygonBufferEXT(ByteBuffer container)

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

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 written, or the required capacity in the case that vertexCapacityInput is insufficient.

vertices

public @Nullable XrVector2f.Buffer vertices()

an array of XrVector2f that must be filled by the runtime with the positions of the polygon vertices relative to the plane’s pose.

type

public XrPlaneDetectorPolygonBufferEXT type(int value)

Sets the specified value to the type() field.

type$Default

public XrPlaneDetectorPolygonBufferEXT type$Default()

Sets the TYPE_PLANE_DETECTOR_POLYGON_BUFFER_EXT value to the type() field.

next

public XrPlaneDetectorPolygonBufferEXT next(long value)

Sets the specified value to the next() field.

vertexCapacityInput

public XrPlaneDetectorPolygonBufferEXT vertexCapacityInput(int value)

Sets the specified value to the vertexCapacityInput() field.

vertexCountOutput

public XrPlaneDetectorPolygonBufferEXT vertexCountOutput(int value)

Sets the specified value to the vertexCountOutput() field.

vertices

public XrPlaneDetectorPolygonBufferEXT vertices(@Nullable XrVector2f.Buffer value)

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

set

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

Initializes this struct with the specified values.

set

public XrPlaneDetectorPolygonBufferEXT set(XrPlaneDetectorPolygonBufferEXT src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static XrPlaneDetectorPolygonBufferEXT malloc()

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

calloc

public static XrPlaneDetectorPolygonBufferEXT calloc()

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

create

public static XrPlaneDetectorPolygonBufferEXT create()

Returns a new XrPlaneDetectorPolygonBufferEXT instance allocated with BufferUtils.

create

public static XrPlaneDetectorPolygonBufferEXT create(long address)

Returns a new XrPlaneDetectorPolygonBufferEXT instance for the specified memory address.

createSafe

public static @Nullable XrPlaneDetectorPolygonBufferEXT createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static XrPlaneDetectorPolygonBufferEXT.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static XrPlaneDetectorPolygonBufferEXT.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static XrPlaneDetectorPolygonBufferEXT.Buffer create(int capacity)

Returns a new XrPlaneDetectorPolygonBufferEXT.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a XrPlaneDetectorPolygonBufferEXT.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new XrPlaneDetectorPolygonBufferEXT instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

Returns a new XrPlaneDetectorPolygonBufferEXT.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 XrVector2f.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 XrVector2f.Buffer value)

Unsafe version of vertices.