Package org.lwjgl.openxr

Class XrMarkerDetectorCustomProfileInfoML

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<XrMarkerDetectorCustomProfileInfoML>

org.lwjgl.openxr.XrMarkerDetectorCustomProfileInfoML

All Implemented Interfaces:

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

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

A custom marker tracking profile.

Description

All marker detectors share some underlying hardware and resources, and thus not all combinations of profiles between multiple detectors are possible. If a profile (preset or custom) specified during marker detector creation is different from those used by existing marker detectors the runtime will attempt to honor the highest frame rate and fps requested.

CPU load due to marker tracking is a function of the chosen XrMarkerTypeML, XrMarkerDetectorFpsML, and XrMarkerDetectorResolutionML.

Valid Usage (Implicit)

• The XR_ML_marker_understanding extension must be enabled prior to using XrMarkerDetectorCustomProfileInfoML
• type must be TYPE_MARKER_DETECTOR_CUSTOM_PROFILE_INFO_ML
• next must be NULL or a valid pointer to the next structure in a structure chain
• fpsHint must be a valid XrMarkerDetectorFpsML value
• resolutionHint must be a valid XrMarkerDetectorResolutionML value
• cameraHint must be a valid XrMarkerDetectorCameraML value
• cornerRefineMethod must be a valid XrMarkerDetectorCornerRefineMethodML value
• fullAnalysisIntervalHint must be a valid XrMarkerDetectorFullAnalysisIntervalML value

Layout

 struct XrMarkerDetectorCustomProfileInfoML {
     XrStructureType type();
     void const * next();
     XrMarkerDetectorFpsML fpsHint();
     XrMarkerDetectorResolutionML resolutionHint();
     XrMarkerDetectorCameraML cameraHint();
     XrMarkerDetectorCornerRefineMethodML cornerRefineMethod();
     XrBool32 useEdgeRefinement();
     XrMarkerDetectorFullAnalysisIntervalML fullAnalysisIntervalHint();
 }

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static XrMarkerDetectorCustomProfileInfoML	calloc()	Returns a new XrMarkerDetectorCustomProfileInfoML instance allocated with memCalloc.
static XrMarkerDetectorCustomProfileInfoML.Buffer	calloc(int capacity)	Returns a new XrMarkerDetectorCustomProfileInfoML.Buffer instance allocated with memCalloc.
static XrMarkerDetectorCustomProfileInfoML.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrMarkerDetectorCustomProfileInfoML.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrMarkerDetectorCustomProfileInfoML	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrMarkerDetectorCustomProfileInfoML instance allocated on the specified MemoryStack and initializes all its bits to zero.
int	cameraHint()	a suggestion of the camera set for the detector to use
XrMarkerDetectorCustomProfileInfoML	cameraHint(int value)	Sets the specified value to the cameraHint() field.
int	cornerRefineMethod()	selects a method for corner refinement for ArUco/AprilTag detectors.
XrMarkerDetectorCustomProfileInfoML	cornerRefineMethod(int value)	Sets the specified value to the cornerRefineMethod() field.
static XrMarkerDetectorCustomProfileInfoML	create()	Returns a new XrMarkerDetectorCustomProfileInfoML instance allocated with BufferUtils.
static XrMarkerDetectorCustomProfileInfoML.Buffer	create(int capacity)	Returns a new XrMarkerDetectorCustomProfileInfoML.Buffer instance allocated with BufferUtils.
static XrMarkerDetectorCustomProfileInfoML	create(long address)	Returns a new XrMarkerDetectorCustomProfileInfoML instance for the specified memory address.
static XrMarkerDetectorCustomProfileInfoML.Buffer	create(long address, int capacity)	Create a XrMarkerDetectorCustomProfileInfoML.Buffer instance at the specified memory.
static @Nullable XrMarkerDetectorCustomProfileInfoML	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable XrMarkerDetectorCustomProfileInfoML.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
int	fpsHint()	a suggestion of the category of frame rate for the detector to use.
XrMarkerDetectorCustomProfileInfoML	fpsHint(int value)	Sets the specified value to the fpsHint() field.
int	fullAnalysisIntervalHint()	the suggested interval between fully analyzed frames that introduce new detected markers, in addition to updating the state of already detected markers.
XrMarkerDetectorCustomProfileInfoML	fullAnalysisIntervalHint(int value)	Sets the specified value to the fullAnalysisIntervalHint() field.
static XrMarkerDetectorCustomProfileInfoML	malloc()	Returns a new XrMarkerDetectorCustomProfileInfoML instance allocated with memAlloc.
static XrMarkerDetectorCustomProfileInfoML.Buffer	malloc(int capacity)	Returns a new XrMarkerDetectorCustomProfileInfoML.Buffer instance allocated with memAlloc.
static XrMarkerDetectorCustomProfileInfoML.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrMarkerDetectorCustomProfileInfoML.Buffer instance allocated on the specified MemoryStack.
static XrMarkerDetectorCustomProfileInfoML	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrMarkerDetectorCustomProfileInfoML instance allocated on the specified MemoryStack.
static int	ncameraHint(long struct)	Unsafe version of cameraHint().
static void	ncameraHint(long struct, int value)	Unsafe version of cameraHint.
static int	ncornerRefineMethod(long struct)	Unsafe version of cornerRefineMethod().
static void	ncornerRefineMethod(long struct, int value)	Unsafe version of cornerRefineMethod.
long	next()	NULL or a pointer to the next structure in a structure chain.
XrMarkerDetectorCustomProfileInfoML	next(long value)	Sets the specified value to the next() field.
static int	nfpsHint(long struct)	Unsafe version of fpsHint().
static void	nfpsHint(long struct, int value)	Unsafe version of fpsHint.
static int	nfullAnalysisIntervalHint(long struct)	Unsafe version of fullAnalysisIntervalHint().
static void	nfullAnalysisIntervalHint(long struct, int value)	Unsafe version of fullAnalysisIntervalHint.
static long	nnext(long struct)	Unsafe version of next().
static void	nnext(long struct, long value)	Unsafe version of next.
static int	nresolutionHint(long struct)	Unsafe version of resolutionHint().
static void	nresolutionHint(long struct, int value)	Unsafe version of resolutionHint.
static int	ntype(long struct)	Unsafe version of type().
static void	ntype(long struct, int value)	Unsafe version of type.
static int	nuseEdgeRefinement(long struct)	Unsafe version of useEdgeRefinement().
static void	nuseEdgeRefinement(long struct, int value)	Unsafe version of useEdgeRefinement.
int	resolutionHint()	a suggestion of the category of camera resolution for the detector to use.
XrMarkerDetectorCustomProfileInfoML	resolutionHint(int value)	Sets the specified value to the resolutionHint() field.
XrMarkerDetectorCustomProfileInfoML	set(int type, long next, int fpsHint, int resolutionHint, int cameraHint, int cornerRefineMethod, boolean useEdgeRefinement, int fullAnalysisIntervalHint)	Initializes this struct with the specified values.
XrMarkerDetectorCustomProfileInfoML	set(XrMarkerDetectorCustomProfileInfoML src)	Copies the specified struct data to this struct.
int	sizeof()
int	type()	the XrStructureType of this structure.
XrMarkerDetectorCustomProfileInfoML	type(int value)	Sets the specified value to the type() field.
XrMarkerDetectorCustomProfileInfoML	type$Default()	Sets the TYPE_MARKER_DETECTOR_CUSTOM_PROFILE_INFO_ML value to the type() field.
boolean	useEdgeRefinement()	specifies whether to run a refinement step that uses marker edges to generate even more accurate corners, but slow down tracking rate overall by consuming more compute.
XrMarkerDetectorCustomProfileInfoML	useEdgeRefinement(boolean value)	Sets the specified value to the useEdgeRefinement() 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.

FPSHINT

public static final int FPSHINT

The struct member offsets.

RESOLUTIONHINT

public static final int RESOLUTIONHINT

The struct member offsets.

CAMERAHINT

public static final int CAMERAHINT

The struct member offsets.

CORNERREFINEMETHOD

public static final int CORNERREFINEMETHOD

The struct member offsets.

USEEDGEREFINEMENT

public static final int USEEDGEREFINEMENT

The struct member offsets.

FULLANALYSISINTERVALHINT

public static final int FULLANALYSISINTERVALHINT

The struct member offsets.

Constructor Details

XrMarkerDetectorCustomProfileInfoML

public XrMarkerDetectorCustomProfileInfoML(ByteBuffer container)

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

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.

fpsHint

public int fpsHint()

a suggestion of the category of frame rate for the detector to use.

resolutionHint

public int resolutionHint()

a suggestion of the category of camera resolution for the detector to use.

cameraHint

public int cameraHint()

a suggestion of the camera set for the detector to use

cornerRefineMethod

public int cornerRefineMethod()

selects a method for corner refinement for ArUco/AprilTag detectors. This member is ignored for detectors of other marker types.

useEdgeRefinement

public boolean useEdgeRefinement()

specifies whether to run a refinement step that uses marker edges to generate even more accurate corners, but slow down tracking rate overall by consuming more compute. It affects ArUco/AprilTag markers only: this member is ignored for detectors of other marker types.

fullAnalysisIntervalHint

public int fullAnalysisIntervalHint()

the suggested interval between fully analyzed frames that introduce new detected markers, in addition to updating the state of already detected markers.

type

public XrMarkerDetectorCustomProfileInfoML type(int value)

Sets the specified value to the type() field.

type$Default

public XrMarkerDetectorCustomProfileInfoML type$Default()

Sets the TYPE_MARKER_DETECTOR_CUSTOM_PROFILE_INFO_ML value to the type() field.

next

public XrMarkerDetectorCustomProfileInfoML next(long value)

Sets the specified value to the next() field.

fpsHint

public XrMarkerDetectorCustomProfileInfoML fpsHint(int value)

Sets the specified value to the fpsHint() field.

resolutionHint

public XrMarkerDetectorCustomProfileInfoML resolutionHint(int value)

Sets the specified value to the resolutionHint() field.

cameraHint

public XrMarkerDetectorCustomProfileInfoML cameraHint(int value)

Sets the specified value to the cameraHint() field.

cornerRefineMethod

public XrMarkerDetectorCustomProfileInfoML cornerRefineMethod(int value)

Sets the specified value to the cornerRefineMethod() field.

useEdgeRefinement

public XrMarkerDetectorCustomProfileInfoML useEdgeRefinement(boolean value)

Sets the specified value to the useEdgeRefinement() field.

fullAnalysisIntervalHint

public XrMarkerDetectorCustomProfileInfoML fullAnalysisIntervalHint(int value)

Sets the specified value to the fullAnalysisIntervalHint() field.

set

public XrMarkerDetectorCustomProfileInfoML set(int type,
 long next,
 int fpsHint,
 int resolutionHint,
 int cameraHint,
 int cornerRefineMethod,
 boolean useEdgeRefinement,
 int fullAnalysisIntervalHint)

Initializes this struct with the specified values.

set

public XrMarkerDetectorCustomProfileInfoML set(XrMarkerDetectorCustomProfileInfoML src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static XrMarkerDetectorCustomProfileInfoML malloc()

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

calloc

public static XrMarkerDetectorCustomProfileInfoML calloc()

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

create

public static XrMarkerDetectorCustomProfileInfoML create()

Returns a new XrMarkerDetectorCustomProfileInfoML instance allocated with BufferUtils.

create

public static XrMarkerDetectorCustomProfileInfoML create(long address)

Returns a new XrMarkerDetectorCustomProfileInfoML instance for the specified memory address.

createSafe

public static @Nullable XrMarkerDetectorCustomProfileInfoML createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static XrMarkerDetectorCustomProfileInfoML.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static XrMarkerDetectorCustomProfileInfoML.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static XrMarkerDetectorCustomProfileInfoML.Buffer create(int capacity)

Returns a new XrMarkerDetectorCustomProfileInfoML.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a XrMarkerDetectorCustomProfileInfoML.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new XrMarkerDetectorCustomProfileInfoML instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nfpsHint

public static int nfpsHint(long struct)

Unsafe version of fpsHint().

nresolutionHint

public static int nresolutionHint(long struct)

Unsafe version of resolutionHint().

ncameraHint

public static int ncameraHint(long struct)

Unsafe version of cameraHint().

ncornerRefineMethod

public static int ncornerRefineMethod(long struct)

Unsafe version of cornerRefineMethod().

nuseEdgeRefinement

public static int nuseEdgeRefinement(long struct)

Unsafe version of useEdgeRefinement().

nfullAnalysisIntervalHint

public static int nfullAnalysisIntervalHint(long struct)

Unsafe version of fullAnalysisIntervalHint().

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.

nfpsHint

public static void nfpsHint(long struct,
 int value)

Unsafe version of fpsHint.

nresolutionHint

public static void nresolutionHint(long struct,
 int value)

Unsafe version of resolutionHint.

ncameraHint

public static void ncameraHint(long struct,
 int value)

Unsafe version of cameraHint.

ncornerRefineMethod

public static void ncornerRefineMethod(long struct,
 int value)

Unsafe version of cornerRefineMethod.

nuseEdgeRefinement

public static void nuseEdgeRefinement(long struct,
 int value)

Unsafe version of useEdgeRefinement.

nfullAnalysisIntervalHint

public static void nfullAnalysisIntervalHint(long struct,
 int value)

Unsafe version of fullAnalysisIntervalHint.