Package org.lwjgl.openxr

Class XrSceneMarkerQRCodesMSFT

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<XrSceneMarkerQRCodesMSFT>

org.lwjgl.openxr.XrSceneMarkerQRCodesMSFT

All Implemented Interfaces:

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

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

Properties for QRCode marker.

Description

An XrSceneMarkerQRCodesMSFT structure can be chained to the next pointer of XrSceneComponentsMSFT when calling GetSceneComponentsMSFT function to retrieve the QR Code specific properties through an array of XrSceneMarkerQRCodeMSFT structures.

GetSceneComponentsMSFT follows the two-call idiom for filling the XrSceneComponentsMSFT structure to which an XrSceneMarkerQRCodesMSFT structure can be chained.

The qrCodeCapacityInput must be equal to or greater than the corresponding XrSceneComponentsMSFT::componentCapacityInput, otherwise the runtime must return the success code ERROR_SIZE_INSUFFICIENT from GetSceneComponentsMSFT.

The actual count of elements returned in the array qrCodes is consistent to the extended XrSceneComponentsMSFT structure and returned in XrSceneComponentsMSFT::componentCountOutput.

Valid Usage (Implicit)

• The XR_MSFT_scene_marker extension must be enabled prior to using XrSceneMarkerQRCodesMSFT
• type must be TYPE_SCENE_MARKER_QR_CODES_MSFT
• next must be NULL or a valid pointer to the next structure in a structure chain
• If qrCodeCapacityInput is not 0, qrCodes must be a pointer to an array of qrCodeCapacityInput XrSceneMarkerQRCodeMSFT structures

See Also

XrSceneMarkerQRCodeMSFT, GetSceneComponentsMSFT

Layout

 struct XrSceneMarkerQRCodesMSFT {
     XrStructureType type();
     void const * next();
     uint32_t qrCodeCapacityInput();
     XrSceneMarkerQRCodeMSFT * qrCodes();
 }

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static XrSceneMarkerQRCodesMSFT	calloc()	Returns a new XrSceneMarkerQRCodesMSFT instance allocated with memCalloc.
static XrSceneMarkerQRCodesMSFT.Buffer	calloc(int capacity)	Returns a new XrSceneMarkerQRCodesMSFT.Buffer instance allocated with memCalloc.
static XrSceneMarkerQRCodesMSFT.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrSceneMarkerQRCodesMSFT.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrSceneMarkerQRCodesMSFT	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrSceneMarkerQRCodesMSFT instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrSceneMarkerQRCodesMSFT	create()	Returns a new XrSceneMarkerQRCodesMSFT instance allocated with BufferUtils.
static XrSceneMarkerQRCodesMSFT.Buffer	create(int capacity)	Returns a new XrSceneMarkerQRCodesMSFT.Buffer instance allocated with BufferUtils.
static XrSceneMarkerQRCodesMSFT	create(long address)	Returns a new XrSceneMarkerQRCodesMSFT instance for the specified memory address.
static XrSceneMarkerQRCodesMSFT.Buffer	create(long address, int capacity)	Create a XrSceneMarkerQRCodesMSFT.Buffer instance at the specified memory.
static @Nullable XrSceneMarkerQRCodesMSFT	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable XrSceneMarkerQRCodesMSFT.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
static XrSceneMarkerQRCodesMSFT	malloc()	Returns a new XrSceneMarkerQRCodesMSFT instance allocated with memAlloc.
static XrSceneMarkerQRCodesMSFT.Buffer	malloc(int capacity)	Returns a new XrSceneMarkerQRCodesMSFT.Buffer instance allocated with memAlloc.
static XrSceneMarkerQRCodesMSFT.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrSceneMarkerQRCodesMSFT.Buffer instance allocated on the specified MemoryStack.
static XrSceneMarkerQRCodesMSFT	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrSceneMarkerQRCodesMSFT instance allocated on the specified MemoryStack.
long	next()	NULL or a pointer to the next structure in a structure chain.
XrSceneMarkerQRCodesMSFT	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	nqrCodeCapacityInput(long struct)	Unsafe version of qrCodeCapacityInput().
static void	nqrCodeCapacityInput(long struct, int value)	Sets the specified value to the qrCodeCapacityInput field of the specified struct.
static @Nullable XrSceneMarkerQRCodeMSFT.Buffer	nqrCodes(long struct)	Unsafe version of qrCodes().
static void	nqrCodes(long struct, @Nullable XrSceneMarkerQRCodeMSFT.Buffer value)	Unsafe version of qrCodes.
static int	ntype(long struct)	Unsafe version of type().
static void	ntype(long struct, int value)	Unsafe version of type.
int	qrCodeCapacityInput()	a uint32_t indicating the count of elements in the qrCodes array.
XrSceneMarkerQRCodesMSFT	qrCodeCapacityInput(int value)	Sets the specified value to the qrCodeCapacityInput() field.
@Nullable XrSceneMarkerQRCodeMSFT.Buffer	qrCodes()	an array of XrSceneMarkerQRCodeMSFT for the runtime to fill with the properties of the QR Codes.
XrSceneMarkerQRCodesMSFT	qrCodes(@Nullable XrSceneMarkerQRCodeMSFT.Buffer value)	Sets the address of the specified XrSceneMarkerQRCodeMSFT.Buffer to the qrCodes() field.
XrSceneMarkerQRCodesMSFT	set(int type, long next, int qrCodeCapacityInput, @Nullable XrSceneMarkerQRCodeMSFT.Buffer qrCodes)	Initializes this struct with the specified values.
XrSceneMarkerQRCodesMSFT	set(XrSceneMarkerQRCodesMSFT src)	Copies the specified struct data to this struct.
int	sizeof()
int	type()	the XrStructureType of this structure.
XrSceneMarkerQRCodesMSFT	type(int value)	Sets the specified value to the type() field.
XrSceneMarkerQRCodesMSFT	type$Default()	Sets the TYPE_SCENE_MARKER_QR_CODES_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.

QRCODECAPACITYINPUT

public static final int QRCODECAPACITYINPUT

The struct member offsets.

QRCODES

public static final int QRCODES

The struct member offsets.

Constructor Details

XrSceneMarkerQRCodesMSFT

public XrSceneMarkerQRCodesMSFT(ByteBuffer container)

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

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. See also: XrSceneComponentsMSFT, XrSceneMarkersMSFT

qrCodeCapacityInput

public int qrCodeCapacityInput()

a uint32_t indicating the count of elements in the qrCodes array.

qrCodes

public @Nullable XrSceneMarkerQRCodeMSFT.Buffer qrCodes()

an array of XrSceneMarkerQRCodeMSFT for the runtime to fill with the properties of the QR Codes.

type

public XrSceneMarkerQRCodesMSFT type(int value)

Sets the specified value to the type() field.

type$Default

public XrSceneMarkerQRCodesMSFT type$Default()

Sets the TYPE_SCENE_MARKER_QR_CODES_MSFT value to the type() field.

next

public XrSceneMarkerQRCodesMSFT next(long value)

Sets the specified value to the next() field.

qrCodeCapacityInput

public XrSceneMarkerQRCodesMSFT qrCodeCapacityInput(int value)

Sets the specified value to the qrCodeCapacityInput() field.

qrCodes

public XrSceneMarkerQRCodesMSFT qrCodes(@Nullable XrSceneMarkerQRCodeMSFT.Buffer value)

Sets the address of the specified XrSceneMarkerQRCodeMSFT.Buffer to the qrCodes() field.

set

public XrSceneMarkerQRCodesMSFT set(int type,
 long next,
 int qrCodeCapacityInput,
 @Nullable XrSceneMarkerQRCodeMSFT.Buffer qrCodes)

Initializes this struct with the specified values.

set

public XrSceneMarkerQRCodesMSFT set(XrSceneMarkerQRCodesMSFT src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static XrSceneMarkerQRCodesMSFT malloc()

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

calloc

public static XrSceneMarkerQRCodesMSFT calloc()

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

create

public static XrSceneMarkerQRCodesMSFT create()

Returns a new XrSceneMarkerQRCodesMSFT instance allocated with BufferUtils.

create

public static XrSceneMarkerQRCodesMSFT create(long address)

Returns a new XrSceneMarkerQRCodesMSFT instance for the specified memory address.

createSafe

public static @Nullable XrSceneMarkerQRCodesMSFT createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static XrSceneMarkerQRCodesMSFT.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static XrSceneMarkerQRCodesMSFT.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static XrSceneMarkerQRCodesMSFT.Buffer create(int capacity)

Returns a new XrSceneMarkerQRCodesMSFT.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a XrSceneMarkerQRCodesMSFT.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new XrSceneMarkerQRCodesMSFT instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nqrCodeCapacityInput

public static int nqrCodeCapacityInput(long struct)

Unsafe version of qrCodeCapacityInput().

nqrCodes

public static @Nullable XrSceneMarkerQRCodeMSFT.Buffer nqrCodes(long struct)

Unsafe version of qrCodes().

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.

nqrCodeCapacityInput

public static void nqrCodeCapacityInput(long struct,
 int value)

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

nqrCodes

public static void nqrCodes(long struct,
 @Nullable XrSceneMarkerQRCodeMSFT.Buffer value)

Unsafe version of qrCodes.