Top Description Inners Fields Constructors Methods
org.lwjgl.openxr

public Class XrSceneComponentLocationsMSFT

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

Returns the scene component locations.
Valid Usage (Implicit)
See Also

XrSceneComponentLocationMSFT, LocateSceneComponentsMSFT

Layout


struct XrSceneComponentLocationsMSFT {
    XrStructureType type;
    void * next;
    uint32_t locationCount;
    XrSceneComponentLocationMSFT * locations;
}

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
LOCATIONCOUNT

The struct member offsets.

public static final int
LOCATIONS

The struct member offsets.

public static final int
NEXT

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
XrSceneComponentLocationsMSFT(long address, ByteBuffer container)

public
XrSceneComponentLocationsMSFT(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static XrSceneComponentLocationsMSFT
calloc()

Returns a new XrSceneComponentLocationsMSFT instance allocated with memCalloc.

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

Returns a new XrSceneComponentLocationsMSFT.Buffer instance allocated with memCalloc.

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

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

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

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

protected XrSceneComponentLocationsMSFT
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 XrSceneComponentLocationsMSFT
create()

Returns a new XrSceneComponentLocationsMSFT instance allocated with BufferUtils.

public static XrSceneComponentLocationsMSFT
create(long address)

Returns a new XrSceneComponentLocationsMSFT instance for the specified memory address.

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

Returns a new XrSceneComponentLocationsMSFT.Buffer instance allocated with BufferUtils.

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

Create a XrSceneComponentLocationsMSFT.Buffer instance at the specified memory.

public static XrSceneComponentLocationsMSFT
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public int
locationCount()

a uint32_t describing the count of elements in the locations array.

public XrSceneComponentLocationsMSFT
locationCount(int value)

Sets the specified value to the locationCount field.

public XrSceneComponentLocationMSFT.Buffer
locations()

an array of XrSceneComponentLocationMSFT scene component locations.

public XrSceneComponentLocationsMSFT
locations(XrSceneComponentLocationMSFT.Buffer value)

Sets the address of the specified XrSceneComponentLocationMSFT.Buffer to the locations field.

public static XrSceneComponentLocationsMSFT
malloc()

Returns a new XrSceneComponentLocationsMSFT instance allocated with memAlloc.

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

Returns a new XrSceneComponentLocationsMSFT.Buffer instance allocated with memAlloc.

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

Returns a new XrSceneComponentLocationsMSFT instance allocated on the specified MemoryStack.

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

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

public long
next()

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

public XrSceneComponentLocationsMSFT
next(long value)

Sets the specified value to the next field.

public static int
nlocationCount(long struct)

Unsafe version of locationCount.

public static void
nlocationCount(long struct, int value)

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

public static XrSceneComponentLocationMSFT.Buffer
nlocations(long struct)

Unsafe version of locations.

public static void
nlocations(long struct, XrSceneComponentLocationMSFT.Buffer value)

Unsafe version of locations.

public static long
nnext(long struct)

Unsafe version of next.

public static void
nnext(long struct, long value)

Unsafe version of next.

public static int
ntype(long struct)

Unsafe version of type.

public static void
ntype(long struct, int value)

Unsafe version of type.

public XrSceneComponentLocationsMSFT
set(int type, long next, int locationCount, XrSceneComponentLocationMSFT.Buffer locations)

Initializes this struct with the specified values.

public XrSceneComponentLocationsMSFT

Returns:

this struct
set
(XrSceneComponentLocationsMSFT
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 XrSceneComponentLocationsMSFT
type(int value)

Sets the specified value to the type field.

public XrSceneComponentLocationsMSFT
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.

LOCATIONCOUNTback to summary
public static final int LOCATIONCOUNT

The struct member offsets.

LOCATIONSback to summary
public static final int LOCATIONS

The struct member offsets.

NEXTback to summary
public static final int NEXT

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

XrSceneComponentLocationsMSFTback to summary
protected XrSceneComponentLocationsMSFT(long address, ByteBuffer container)
XrSceneComponentLocationsMSFTback to summary
public XrSceneComponentLocationsMSFT(ByteBuffer container)

Creates a XrSceneComponentLocationsMSFT 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 XrSceneComponentLocationsMSFT calloc()

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static XrSceneComponentLocationsMSFT calloc(MemoryStack stack)

Returns a new XrSceneComponentLocationsMSFT 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 XrSceneComponentLocationsMSFT.Buffer calloc(int capacity, MemoryStack stack)

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

Returns a new XrSceneComponentLocationsMSFT instance allocated with BufferUtils.

createback to summary
public static XrSceneComponentLocationsMSFT create(long address)

Returns a new XrSceneComponentLocationsMSFT instance for the specified memory address.

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

Returns a new XrSceneComponentLocationsMSFT.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a XrSceneComponentLocationsMSFT.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static XrSceneComponentLocationsMSFT createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
locationCountback to summary
public int locationCount()

a uint32_t describing the count of elements in the locations array.

Annotations
@NativeType:uint32_t
locationCountback to summary
public XrSceneComponentLocationsMSFT locationCount(int value)

Sets the specified value to the locationCount field.

locationsback to summary
public XrSceneComponentLocationMSFT.Buffer locations()

an array of XrSceneComponentLocationMSFT scene component locations.

Annotations
@Nullable
@NativeType:XrSceneComponentLocationMSFT *
locationsback to summary
public XrSceneComponentLocationsMSFT locations(XrSceneComponentLocationMSFT.Buffer value)

Sets the address of the specified XrSceneComponentLocationMSFT.Buffer to the locations field.

mallocback to summary
public static XrSceneComponentLocationsMSFT malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static XrSceneComponentLocationsMSFT malloc(MemoryStack stack)

Returns a new XrSceneComponentLocationsMSFT instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

Returns a new XrSceneComponentLocationsMSFT.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 *
nextback to summary
public XrSceneComponentLocationsMSFT next(long value)

Sets the specified value to the next field.

nlocationCountback to summary
public static int nlocationCount(long struct)

Unsafe version of locationCount.

nlocationCountback to summary
public static void nlocationCount(long struct, int value)

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

nlocationsback to summary
public static XrSceneComponentLocationMSFT.Buffer nlocations(long struct)

Unsafe version of locations.

Annotations
@Nullable
nlocationsback to summary
public static void nlocations(long struct, XrSceneComponentLocationMSFT.Buffer value)

Unsafe version of locations.

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.

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.

setback to summary
public XrSceneComponentLocationsMSFT set(int type, long next, int locationCount, XrSceneComponentLocationMSFT.Buffer locations)

Initializes this struct with the specified values.

setback to summary
public XrSceneComponentLocationsMSFT set(XrSceneComponentLocationsMSFT src)

Copies the specified struct data to this struct.

Parameters
src:XrSceneComponentLocationsMSFT

the source struct

Returns:XrSceneComponentLocationsMSFT

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 XrSceneComponentLocationsMSFT type(int value)

Sets the specified value to the type field.

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

Sets the TYPE_SCENE_COMPONENT_LOCATIONS_MSFT value to the type field.

org.lwjgl.openxr back to summary

public Class XrSceneComponentLocationsMSFT.Buffer

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

An array of XrSceneComponentLocationsMSFT structs.

Field Summary

Modifier and TypeField and Description
private static final XrSceneComponentLocationsMSFT

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new XrSceneComponentLocationsMSFT.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
protected XrSceneComponentLocationsMSFT
public int
public XrSceneComponentLocationsMSFT.Buffer
locationCount(int value)

Sets the specified value to the XrSceneComponentLocationsMSFT#locationCount field.

public XrSceneComponentLocationMSFT.Buffer

Returns:

a XrSceneComponentLocationMSFT.Buffer view of the struct array pointed to by the XrSceneComponentLocationsMSFT#locations field.
locations
()

public XrSceneComponentLocationsMSFT.Buffer
public long

Returns:

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

public XrSceneComponentLocationsMSFT.Buffer
next(long value)

Sets the specified value to the XrSceneComponentLocationsMSFT#next field.

protected XrSceneComponentLocationsMSFT.Buffer
public int

Returns:

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

public XrSceneComponentLocationsMSFT.Buffer
type(int value)

Sets the specified value to the XrSceneComponentLocationsMSFT#type field.

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

Field Detail

ELEMENT_FACTORYback to summary
private static final XrSceneComponentLocationsMSFT ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new XrSceneComponentLocationsMSFT.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 XrSceneComponentLocationsMSFT#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

getElementFactoryback to summary
protected XrSceneComponentLocationsMSFT getElementFactory()

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

Annotations
@Override
locationCountback to summary
public int locationCount()
Returns:int

the value of the XrSceneComponentLocationsMSFT#locationCount field.

Annotations
@NativeType:uint32_t
locationCountback to summary
public XrSceneComponentLocationsMSFT.Buffer locationCount(int value)

Sets the specified value to the XrSceneComponentLocationsMSFT#locationCount field.

locationsback to summary
public XrSceneComponentLocationMSFT.Buffer locations()
Returns:XrSceneComponentLocationMSFT.Buffer

a XrSceneComponentLocationMSFT.Buffer view of the struct array pointed to by the XrSceneComponentLocationsMSFT#locations field.

Annotations
@Nullable
@NativeType:XrSceneComponentLocationMSFT *
locationsback to summary
public XrSceneComponentLocationsMSFT.Buffer locations(XrSceneComponentLocationMSFT.Buffer value)

Sets the address of the specified XrSceneComponentLocationMSFT.Buffer to the XrSceneComponentLocationsMSFT#locations field.

nextback to summary
public long next()
Returns:long

the value of the XrSceneComponentLocationsMSFT#next field.

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

Sets the specified value to the XrSceneComponentLocationsMSFT#next field.

selfback to summary
protected XrSceneComponentLocationsMSFT.Buffer self()

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

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

the value of the XrSceneComponentLocationsMSFT#type field.

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

Sets the specified value to the XrSceneComponentLocationsMSFT#type field.

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

Sets the TYPE_SCENE_COMPONENT_LOCATIONS_MSFT value to the XrSceneComponentLocationsMSFT#type field.