Package org.lwjgl.openxr

Class XrPlaneDetectorLocationsEXT

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<XrPlaneDetectorLocationsEXT>

org.lwjgl.openxr.XrPlaneDetectorLocationsEXT

All Implemented Interfaces:

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

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

Contains the plane information.

Valid Usage (Implicit)

• The XR_EXT_plane_detection extension must be enabled prior to using XrPlaneDetectorLocationsEXT
• type must be TYPE_PLANE_DETECTOR_LOCATIONS_EXT
• next must be NULL or a valid pointer to the next structure in a structure chain
• If planeLocationCapacityInput is not 0, planeLocations must be a pointer to an array of planeLocationCapacityInput XrPlaneDetectorLocationEXT structures

See Also

XrPlaneDetectorLocationEXT, GetPlaneDetectionsEXT

Layout

 struct XrPlaneDetectorLocationsEXT {
     XrStructureType type();
     void * next();
     uint32_t planeLocationCapacityInput();
     uint32_t planeLocationCountOutput();
     XrPlaneDetectorLocationEXT * planeLocations();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	XrPlaneDetectorLocationsEXT.Buffer	An array of XrPlaneDetectorLocationsEXT 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	PLANELOCATIONCAPACITYINPUT	The struct member offsets.
static final int	PLANELOCATIONCOUNTOUTPUT	The struct member offsets.
static final int	PLANELOCATIONS	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
XrPlaneDetectorLocationsEXT(ByteBuffer container)	Creates a XrPlaneDetectorLocationsEXT instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static XrPlaneDetectorLocationsEXT	calloc()	Returns a new XrPlaneDetectorLocationsEXT instance allocated with memCalloc.
static XrPlaneDetectorLocationsEXT.Buffer	calloc(int capacity)	Returns a new XrPlaneDetectorLocationsEXT.Buffer instance allocated with memCalloc.
static XrPlaneDetectorLocationsEXT.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrPlaneDetectorLocationsEXT.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrPlaneDetectorLocationsEXT	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrPlaneDetectorLocationsEXT instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrPlaneDetectorLocationsEXT	create()	Returns a new XrPlaneDetectorLocationsEXT instance allocated with BufferUtils.
static XrPlaneDetectorLocationsEXT.Buffer	create(int capacity)	Returns a new XrPlaneDetectorLocationsEXT.Buffer instance allocated with BufferUtils.
static XrPlaneDetectorLocationsEXT	create(long address)	Returns a new XrPlaneDetectorLocationsEXT instance for the specified memory address.
static XrPlaneDetectorLocationsEXT.Buffer	create(long address, int capacity)	Create a XrPlaneDetectorLocationsEXT.Buffer instance at the specified memory.
static @Nullable XrPlaneDetectorLocationsEXT	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable XrPlaneDetectorLocationsEXT.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
static XrPlaneDetectorLocationsEXT	malloc()	Returns a new XrPlaneDetectorLocationsEXT instance allocated with memAlloc.
static XrPlaneDetectorLocationsEXT.Buffer	malloc(int capacity)	Returns a new XrPlaneDetectorLocationsEXT.Buffer instance allocated with memAlloc.
static XrPlaneDetectorLocationsEXT.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrPlaneDetectorLocationsEXT.Buffer instance allocated on the specified MemoryStack.
static XrPlaneDetectorLocationsEXT	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrPlaneDetectorLocationsEXT instance allocated on the specified MemoryStack.
long	next()	NULL or a pointer to the next structure in a structure chain.
XrPlaneDetectorLocationsEXT	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	nplaneLocationCapacityInput(long struct)	Unsafe version of planeLocationCapacityInput().
static void	nplaneLocationCapacityInput(long struct, int value)	Sets the specified value to the planeLocationCapacityInput field of the specified struct.
static int	nplaneLocationCountOutput(long struct)	Unsafe version of planeLocationCountOutput().
static void	nplaneLocationCountOutput(long struct, int value)	Unsafe version of planeLocationCountOutput.
static @Nullable XrPlaneDetectorLocationEXT.Buffer	nplaneLocations(long struct)	Unsafe version of planeLocations().
static void	nplaneLocations(long struct, @Nullable XrPlaneDetectorLocationEXT.Buffer value)	Unsafe version of planeLocations.
static int	ntype(long struct)	Unsafe version of type().
static void	ntype(long struct, int value)	Unsafe version of type.
int	planeLocationCapacityInput()	the capacity of the array, or 0 to indicate a request to retrieve the required capacity.
XrPlaneDetectorLocationsEXT	planeLocationCapacityInput(int value)	Sets the specified value to the planeLocationCapacityInput() field.
int	planeLocationCountOutput()	the number of planes, or the required capacity in the case that planeLocationCapacityInput is insufficient.
XrPlaneDetectorLocationsEXT	planeLocationCountOutput(int value)	Sets the specified value to the planeLocationCountOutput() field.
@Nullable XrPlaneDetectorLocationEXT.Buffer	planeLocations()	an array of XrPlaneDetectorLocationEXT.
XrPlaneDetectorLocationsEXT	planeLocations(@Nullable XrPlaneDetectorLocationEXT.Buffer value)	Sets the address of the specified XrPlaneDetectorLocationEXT.Buffer to the planeLocations() field.
XrPlaneDetectorLocationsEXT	set(int type, long next, int planeLocationCapacityInput, int planeLocationCountOutput, @Nullable XrPlaneDetectorLocationEXT.Buffer planeLocations)	Initializes this struct with the specified values.
XrPlaneDetectorLocationsEXT	set(XrPlaneDetectorLocationsEXT src)	Copies the specified struct data to this struct.
int	sizeof()
int	type()	the XrStructureType of this structure.
XrPlaneDetectorLocationsEXT	type(int value)	Sets the specified value to the type() field.
XrPlaneDetectorLocationsEXT	type$Default()	Sets the TYPE_PLANE_DETECTOR_LOCATIONS_EXT 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.

PLANELOCATIONCAPACITYINPUT

public static final int PLANELOCATIONCAPACITYINPUT

The struct member offsets.

PLANELOCATIONCOUNTOUTPUT

public static final int PLANELOCATIONCOUNTOUTPUT

The struct member offsets.

PLANELOCATIONS

public static final int PLANELOCATIONS

The struct member offsets.

Constructor Details

XrPlaneDetectorLocationsEXT

public XrPlaneDetectorLocationsEXT(ByteBuffer container)

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

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.

planeLocationCapacityInput

public int planeLocationCapacityInput()

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

planeLocationCountOutput

public int planeLocationCountOutput()

the number of planes, or the required capacity in the case that planeLocationCapacityInput is insufficient.

planeLocations

public @Nullable XrPlaneDetectorLocationEXT.Buffer planeLocations()

an array of XrPlaneDetectorLocationEXT. It can be NULL if planeLocationCapacityInput is 0.

type

public XrPlaneDetectorLocationsEXT type(int value)

Sets the specified value to the type() field.

type$Default

public XrPlaneDetectorLocationsEXT type$Default()

Sets the TYPE_PLANE_DETECTOR_LOCATIONS_EXT value to the type() field.

next

public XrPlaneDetectorLocationsEXT next(long value)

Sets the specified value to the next() field.

planeLocationCapacityInput

public XrPlaneDetectorLocationsEXT planeLocationCapacityInput(int value)

Sets the specified value to the planeLocationCapacityInput() field.

planeLocationCountOutput

public XrPlaneDetectorLocationsEXT planeLocationCountOutput(int value)

Sets the specified value to the planeLocationCountOutput() field.

planeLocations

public XrPlaneDetectorLocationsEXT planeLocations(@Nullable XrPlaneDetectorLocationEXT.Buffer value)

Sets the address of the specified XrPlaneDetectorLocationEXT.Buffer to the planeLocations() field.

set

public XrPlaneDetectorLocationsEXT set(int type,
 long next,
 int planeLocationCapacityInput,
 int planeLocationCountOutput,
 @Nullable XrPlaneDetectorLocationEXT.Buffer planeLocations)

Initializes this struct with the specified values.

set

public XrPlaneDetectorLocationsEXT set(XrPlaneDetectorLocationsEXT src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static XrPlaneDetectorLocationsEXT malloc()

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

calloc

public static XrPlaneDetectorLocationsEXT calloc()

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

create

public static XrPlaneDetectorLocationsEXT create()

Returns a new XrPlaneDetectorLocationsEXT instance allocated with BufferUtils.

create

public static XrPlaneDetectorLocationsEXT create(long address)

Returns a new XrPlaneDetectorLocationsEXT instance for the specified memory address.

createSafe

public static @Nullable XrPlaneDetectorLocationsEXT createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static XrPlaneDetectorLocationsEXT.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static XrPlaneDetectorLocationsEXT.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static XrPlaneDetectorLocationsEXT.Buffer create(int capacity)

Returns a new XrPlaneDetectorLocationsEXT.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a XrPlaneDetectorLocationsEXT.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new XrPlaneDetectorLocationsEXT instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nplaneLocationCapacityInput

public static int nplaneLocationCapacityInput(long struct)

Unsafe version of planeLocationCapacityInput().

nplaneLocationCountOutput

public static int nplaneLocationCountOutput(long struct)

Unsafe version of planeLocationCountOutput().

nplaneLocations

public static @Nullable XrPlaneDetectorLocationEXT.Buffer nplaneLocations(long struct)

Unsafe version of planeLocations().

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.

nplaneLocationCapacityInput

public static void nplaneLocationCapacityInput(long struct,
 int value)

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

nplaneLocationCountOutput

public static void nplaneLocationCountOutput(long struct,
 int value)

Unsafe version of planeLocationCountOutput.

nplaneLocations

public static void nplaneLocations(long struct,
 @Nullable XrPlaneDetectorLocationEXT.Buffer value)

Unsafe version of planeLocations.