Top Description Inners Fields Constructors Methods
org.lwjgl.openxr

public Class XrSemanticLabelsSupportInfoFB

extends Struct<XrSemanticLabelsSupportInfoFB>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*

Specifies additional behaviors of the xrGetSpaceSemanticLabelsFB function.
Description

The XrSemanticLabelsSupportInfoFB structure may be specified in the next chain of XrSemanticLabelsFB to specify additional behaviors of the GetSpaceSemanticLabelsFB function. The runtime must follow the behaviors specified in flags according to the descriptions of XrSemanticLabelsSupportFlagBitsFB. The runtime must return any semantic label that is not included in recognizedLabels as "OTHER" to the application. The runtime must follow this direction only if the runtime reports the extensionVersion as 2 or greater, otherwise the runtime must ignore this as an unknown chained structure.

If the XrSemanticLabelsSupportInfoFB structure is not present in the next chain of XrSemanticLabelsFB, the runtime may return any semantic labels to the application.

Valid Usage (Implicit)

Layout


struct XrSemanticLabelsSupportInfoFB {
    XrStructureType type;
    void const * next;
    XrSemanticLabelsSupportFlagsFB flags;
    char const * recognizedLabels;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
FLAGS

The struct member offsets.

public static final int
NEXT

The struct member offsets.

public static final int
RECOGNIZEDLABELS

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
TYPE

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

AccessConstructor and Description
protected
XrSemanticLabelsSupportInfoFB(long address, ByteBuffer container)

public
XrSemanticLabelsSupportInfoFB(ByteBuffer container)

Creates a XrSemanticLabelsSupportInfoFB instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and TypeMethod and Description
public static XrSemanticLabelsSupportInfoFB
calloc()

Returns a new XrSemanticLabelsSupportInfoFB instance allocated with memCalloc.

public static XrSemanticLabelsSupportInfoFB.Buffer
calloc(int
the buffer capacity
capacity
)

Returns a new XrSemanticLabelsSupportInfoFB.Buffer instance allocated with memCalloc.

public static XrSemanticLabelsSupportInfoFB
calloc(MemoryStack
the stack from which to allocate
stack
)

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

public static XrSemanticLabelsSupportInfoFB.Buffer
calloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

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

protected XrSemanticLabelsSupportInfoFB
create(long
the struct memory address
address
,
ByteBuffer
an optional container buffer, to be referenced strongly by the struct instance.
container
)

Implements abstract org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.
public static XrSemanticLabelsSupportInfoFB
create()

Returns a new XrSemanticLabelsSupportInfoFB instance allocated with BufferUtils.

public static XrSemanticLabelsSupportInfoFB
create(long address)

Returns a new XrSemanticLabelsSupportInfoFB instance for the specified memory address.

public static XrSemanticLabelsSupportInfoFB.Buffer
create(int
the buffer capacity
capacity
)

Returns a new XrSemanticLabelsSupportInfoFB.Buffer instance allocated with BufferUtils.

public static XrSemanticLabelsSupportInfoFB.Buffer
create(long
the memory address
address
,
int
the buffer capacity
capacity
)

Create a XrSemanticLabelsSupportInfoFB.Buffer instance at the specified memory.

public static XrSemanticLabelsSupportInfoFB
createSafe(long address)

Like create, but returns null if address is NULL.

public static XrSemanticLabelsSupportInfoFB.Buffer
createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

public long
flags()

a bitmask of XrSemanticLabelsSupportFlagBitsFB that specifies additional behaviors.

public XrSemanticLabelsSupportInfoFB
flags(long value)

Sets the specified value to the flags field.

public static XrSemanticLabelsSupportInfoFB
malloc()

Returns a new XrSemanticLabelsSupportInfoFB instance allocated with memAlloc.

public static XrSemanticLabelsSupportInfoFB.Buffer
malloc(int
the buffer capacity
capacity
)

Returns a new XrSemanticLabelsSupportInfoFB.Buffer instance allocated with memAlloc.

public static XrSemanticLabelsSupportInfoFB
malloc(MemoryStack
the stack from which to allocate
stack
)

Returns a new XrSemanticLabelsSupportInfoFB instance allocated on the specified MemoryStack.

public static XrSemanticLabelsSupportInfoFB.Buffer
malloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

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

public long
next()

NULL or a pointer to the next structure in a structure chain.

public XrSemanticLabelsSupportInfoFB
next(long value)

Sets the specified value to the next field.

public static long
nflags(long struct)

Unsafe version of flags.

public static void
nflags(long struct, long value)

Unsafe version of flags.

public static long
nnext(long struct)

Unsafe version of next.

public static void
nnext(long struct, long value)

Unsafe version of next.

public static ByteBuffer
nrecognizedLabels(long struct)

Unsafe version of recognizedLabels.

public static void
nrecognizedLabels(long struct, ByteBuffer value)

Unsafe version of recognizedLabels.

public static String
nrecognizedLabelsString(long struct)

Unsafe version of recognizedLabelsString.

public static int
ntype(long struct)

Unsafe version of type.

public static void
ntype(long struct, int value)

Unsafe version of type.

public ByteBuffer
recognizedLabels()

a NULL terminated string that indicates a set of semantic labels recognized by the application.

public XrSemanticLabelsSupportInfoFB
recognizedLabels(ByteBuffer value)

Sets the address of the specified encoded string to the recognizedLabels field.

public String
recognizedLabelsString()

a NULL terminated string that indicates a set of semantic labels recognized by the application.

public XrSemanticLabelsSupportInfoFB
set(int type, long next, long flags, ByteBuffer recognizedLabels)

Initializes this struct with the specified values.

public XrSemanticLabelsSupportInfoFB

Returns:

this struct
set
(XrSemanticLabelsSupportInfoFB
the source struct
src
)

Copies the specified struct data to this struct.

public int
sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).
public int
type()

the XrStructureType of this structure.

public XrSemanticLabelsSupportInfoFB
type(int value)

Sets the specified value to the type field.

public XrSemanticLabelsSupportInfoFB
public static void
validate(long
the struct to validate
struct
)

Validates pointer members that should not be NULL.

Inherited from org.lwjgl.system.Struct:
__array__array__array__checkContainer__checkMalloc__create__getContainer__getContainer__member__member__member__padding__padding__struct__struct__union__unionclearfreeisNullvalidate

Field Detail

ALIGNOFback to summary
public static final int ALIGNOF

The struct alignment in bytes.

FLAGSback to summary
public static final int FLAGS

The struct member offsets.

NEXTback to summary
public static final int NEXT

The struct member offsets.

RECOGNIZEDLABELSback to summary
public static final int RECOGNIZEDLABELS

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

TYPEback to summary
public static final int TYPE

The struct member offsets.

Constructor Detail

XrSemanticLabelsSupportInfoFBback to summary
protected XrSemanticLabelsSupportInfoFB(long address, ByteBuffer container)
XrSemanticLabelsSupportInfoFBback to summary
public XrSemanticLabelsSupportInfoFB(ByteBuffer container)

Creates a XrSemanticLabelsSupportInfoFB 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 Detail

callocback to summary
public static XrSemanticLabelsSupportInfoFB calloc()

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

callocback to summary
public static XrSemanticLabelsSupportInfoFB.Buffer calloc(int capacity)

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static XrSemanticLabelsSupportInfoFB calloc(MemoryStack stack)

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

Parameters
stack:MemoryStack

the stack from which to allocate

callocback to summary
public static XrSemanticLabelsSupportInfoFB.Buffer calloc(int capacity, MemoryStack stack)

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

createback to summary
protected XrSemanticLabelsSupportInfoFB create(long address, ByteBuffer container)

Implements abstract org.lwjgl.system.Struct.create.

Doc from org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.

Effectively, every Struct instance is a factory for more instances of the same type. This is used by StructBuffer.

Parameters
address:long

the struct memory address

container:ByteBuffer

an optional container buffer, to be referenced strongly by the struct instance.

Annotations
@Override
createback to summary
public static XrSemanticLabelsSupportInfoFB create()

Returns a new XrSemanticLabelsSupportInfoFB instance allocated with BufferUtils.

createback to summary
public static XrSemanticLabelsSupportInfoFB create(long address)

Returns a new XrSemanticLabelsSupportInfoFB instance for the specified memory address.

createback to summary
public static XrSemanticLabelsSupportInfoFB.Buffer create(int capacity)

Returns a new XrSemanticLabelsSupportInfoFB.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

createback to summary
public static XrSemanticLabelsSupportInfoFB.Buffer create(long address, int capacity)

Create a XrSemanticLabelsSupportInfoFB.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static XrSemanticLabelsSupportInfoFB createSafe(long address)

Like create, but returns null if address is NULL.

Annotations
@Nullable
createSafeback to summary
public static XrSemanticLabelsSupportInfoFB.Buffer createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

Annotations
@Nullable
flagsback to summary
public long flags()

a bitmask of XrSemanticLabelsSupportFlagBitsFB that specifies additional behaviors.

Annotations
@NativeType:XrSemanticLabelsSupportFlagsFB
flagsback to summary
public XrSemanticLabelsSupportInfoFB flags(long value)

Sets the specified value to the flags field.

mallocback to summary
public static XrSemanticLabelsSupportInfoFB malloc()

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

mallocback to summary
public static XrSemanticLabelsSupportInfoFB.Buffer malloc(int capacity)

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static XrSemanticLabelsSupportInfoFB malloc(MemoryStack stack)

Returns a new XrSemanticLabelsSupportInfoFB instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

mallocback to summary
public static XrSemanticLabelsSupportInfoFB.Buffer malloc(int capacity, MemoryStack stack)

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

nextback to summary
public long next()

NULL or a pointer to the next structure in a structure chain. No such structures are defined in core OpenXR or this extension.

Annotations
@NativeType:void const *
nextback to summary
public XrSemanticLabelsSupportInfoFB next(long value)

Sets the specified value to the next field.

nflagsback to summary
public static long nflags(long struct)

Unsafe version of flags.

nflagsback to summary
public static void nflags(long struct, long value)

Unsafe version of flags.

nnextback to summary
public static long nnext(long struct)

Unsafe version of next.

nnextback to summary
public static void nnext(long struct, long value)

Unsafe version of next.

nrecognizedLabelsback to summary
public static ByteBuffer nrecognizedLabels(long struct)

Unsafe version of recognizedLabels.

nrecognizedLabelsback to summary
public static void nrecognizedLabels(long struct, ByteBuffer value)

Unsafe version of recognizedLabels.

nrecognizedLabelsStringback to summary
public static String nrecognizedLabelsString(long struct)

Unsafe version of recognizedLabelsString.

ntypeback to summary
public static int ntype(long struct)

Unsafe version of type.

ntypeback to summary
public static void ntype(long struct, int value)

Unsafe version of type.

recognizedLabelsback to summary
public ByteBuffer recognizedLabels()

a NULL terminated string that indicates a set of semantic labels recognized by the application. Each semantic label must be represented as a string and be separated by a comma without spaces. This field must include at least "OTHER" and must not be NULL.

Annotations
@NativeType:char const *
recognizedLabelsback to summary
public XrSemanticLabelsSupportInfoFB recognizedLabels(ByteBuffer value)

Sets the address of the specified encoded string to the recognizedLabels field.

recognizedLabelsStringback to summary
public String recognizedLabelsString()

a NULL terminated string that indicates a set of semantic labels recognized by the application. Each semantic label must be represented as a string and be separated by a comma without spaces. This field must include at least "OTHER" and must not be NULL.

Annotations
@NativeType:char const *
setback to summary
public XrSemanticLabelsSupportInfoFB set(int type, long next, long flags, ByteBuffer recognizedLabels)

Initializes this struct with the specified values.

setback to summary
public XrSemanticLabelsSupportInfoFB set(XrSemanticLabelsSupportInfoFB src)

Copies the specified struct data to this struct.

Parameters
src:XrSemanticLabelsSupportInfoFB

the source struct

Returns:XrSemanticLabelsSupportInfoFB

this struct

sizeofback to summary
public int sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Doc from org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).

Annotations
@Override
typeback to summary
public int type()

the XrStructureType of this structure.

Annotations
@NativeType:XrStructureType
typeback to summary
public XrSemanticLabelsSupportInfoFB type(int value)

Sets the specified value to the type field.

type$Defaultback to summary
public XrSemanticLabelsSupportInfoFB type$Default()

Sets the TYPE_SEMANTIC_LABELS_SUPPORT_INFO_FB value to the type field.

validateback to summary
public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters
struct:long

the struct to validate

org.lwjgl.openxr back to summary

public Class XrSemanticLabelsSupportInfoFB.Buffer

extends StructBuffer<XrSemanticLabelsSupportInfoFB, XrSemanticLabelsSupportInfoFB.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable

An array of XrSemanticLabelsSupportInfoFB structs.

Field Summary

Modifier and TypeField and Description
private static final XrSemanticLabelsSupportInfoFB

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new XrSemanticLabelsSupportInfoFB.Buffer instance backed by the specified container.

public
Buffer(long address, int cap)

pack-priv
Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Summary

Modifier and TypeMethod and Description
public long

Returns:

the value of the XrSemanticLabelsSupportInfoFB#flags field.
flags
()

public XrSemanticLabelsSupportInfoFB.Buffer
flags(long value)

Sets the specified value to the XrSemanticLabelsSupportInfoFB#flags field.

protected XrSemanticLabelsSupportInfoFB
public long

Returns:

the value of the XrSemanticLabelsSupportInfoFB#next field.
next
()

public XrSemanticLabelsSupportInfoFB.Buffer
next(long value)

Sets the specified value to the XrSemanticLabelsSupportInfoFB#next field.

public ByteBuffer

Returns:

a ByteBuffer view of the null-terminated string pointed to by the XrSemanticLabelsSupportInfoFB#recognizedLabels field.
recognizedLabels
()

public XrSemanticLabelsSupportInfoFB.Buffer
recognizedLabels(ByteBuffer value)

Sets the address of the specified encoded string to the XrSemanticLabelsSupportInfoFB#recognizedLabels field.

public String

Returns:

the null-terminated string pointed to by the XrSemanticLabelsSupportInfoFB#recognizedLabels field.
recognizedLabelsString
()

protected XrSemanticLabelsSupportInfoFB.Buffer
public int

Returns:

the value of the XrSemanticLabelsSupportInfoFB#type field.
type
()

public XrSemanticLabelsSupportInfoFB.Buffer
type(int value)

Sets the specified value to the XrSemanticLabelsSupportInfoFB#type field.

public XrSemanticLabelsSupportInfoFB.Buffer
Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final XrSemanticLabelsSupportInfoFB ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new XrSemanticLabelsSupportInfoFB.Buffer instance backed by the specified container.

Changes to the container's content will be visible to the struct buffer instance and vice versa. The two buffers' position, limit, and mark values will be independent. The new buffer's position will be zero, its capacity and its limit will be the number of bytes remaining in this buffer divided by XrSemanticLabelsSupportInfoFB#SIZEOF, and its mark will be undefined.

The created buffer instance holds a strong reference to the container object.

Bufferback to summary
public Buffer(long address, int cap)
Bufferback to summary
pack-priv Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Detail

flagsback to summary
public long flags()
Returns:long

the value of the XrSemanticLabelsSupportInfoFB#flags field.

Annotations
@NativeType:XrSemanticLabelsSupportFlagsFB
flagsback to summary
public XrSemanticLabelsSupportInfoFB.Buffer flags(long value)

Sets the specified value to the XrSemanticLabelsSupportInfoFB#flags field.

getElementFactoryback to summary
protected XrSemanticLabelsSupportInfoFB getElementFactory()

Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.

Annotations
@Override
nextback to summary
public long next()
Returns:long

the value of the XrSemanticLabelsSupportInfoFB#next field.

Annotations
@NativeType:void const *
nextback to summary
public XrSemanticLabelsSupportInfoFB.Buffer next(long value)

Sets the specified value to the XrSemanticLabelsSupportInfoFB#next field.

recognizedLabelsback to summary
public ByteBuffer recognizedLabels()
Returns:ByteBuffer

a ByteBuffer view of the null-terminated string pointed to by the XrSemanticLabelsSupportInfoFB#recognizedLabels field.

Annotations
@NativeType:char const *
recognizedLabelsback to summary
public XrSemanticLabelsSupportInfoFB.Buffer recognizedLabels(ByteBuffer value)

Sets the address of the specified encoded string to the XrSemanticLabelsSupportInfoFB#recognizedLabels field.

recognizedLabelsStringback to summary
public String recognizedLabelsString()
Returns:String

the null-terminated string pointed to by the XrSemanticLabelsSupportInfoFB#recognizedLabels field.

Annotations
@NativeType:char const *
selfback to summary
protected XrSemanticLabelsSupportInfoFB.Buffer self()

Implements abstract org.lwjgl.system.CustomBuffer.self.

Annotations
@Override
typeback to summary
public int type()
Returns:int

the value of the XrSemanticLabelsSupportInfoFB#type field.

Annotations
@NativeType:XrStructureType
typeback to summary
public XrSemanticLabelsSupportInfoFB.Buffer type(int value)

Sets the specified value to the XrSemanticLabelsSupportInfoFB#type field.

type$Defaultback to summary
public XrSemanticLabelsSupportInfoFB.Buffer type$Default()

Sets the TYPE_SEMANTIC_LABELS_SUPPORT_INFO_FB value to the XrSemanticLabelsSupportInfoFB#type field.