Top Description Inners Fields Constructors Methods
org.lwjgl.openxr

public Class XrSceneComponentLocationMSFT

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

Describes the location of a scene component.
Valid Usage (Implicit)
See Also

XrPosef, XrSceneComponentLocationsMSFT

Layout


struct XrSceneComponentLocationMSFT {
    XrSpaceLocationFlags flags;
    XrPosef pose;
}

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
POSE

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

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

public
XrSceneComponentLocationMSFT(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static XrSceneComponentLocationMSFT
calloc()

Returns a new XrSceneComponentLocationMSFT instance allocated with memCalloc.

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

Returns a new XrSceneComponentLocationMSFT.Buffer instance allocated with memCalloc.

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

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

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

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

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

Returns a new XrSceneComponentLocationMSFT instance allocated with BufferUtils.

public static XrSceneComponentLocationMSFT
create(long address)

Returns a new XrSceneComponentLocationMSFT instance for the specified memory address.

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

Returns a new XrSceneComponentLocationMSFT.Buffer instance allocated with BufferUtils.

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

Create a XrSceneComponentLocationMSFT.Buffer instance at the specified memory.

public static XrSceneComponentLocationMSFT
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public long
flags()

a bitfield, with bit masks defined in XrSpaceLocationFlagBits, to indicate which members contain valid data.

public XrSceneComponentLocationMSFT
flags(long value)

Sets the specified value to the flags field.

public static XrSceneComponentLocationMSFT
malloc()

Returns a new XrSceneComponentLocationMSFT instance allocated with memAlloc.

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

Returns a new XrSceneComponentLocationMSFT.Buffer instance allocated with memAlloc.

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

Returns a new XrSceneComponentLocationMSFT instance allocated on the specified MemoryStack.

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

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

public static long
nflags(long struct)

Unsafe version of flags.

public static void
nflags(long struct, long value)

Unsafe version of flags.

public static XrPosef
npose(long struct)

Unsafe version of pose.

public static void
npose(long struct, XrPosef value)

Unsafe version of pose.

public XrPosef
pose()

an XrPosef defining the position and orientation of the scene component within the reference frame of the corresponding XrSceneComponentsLocateInfoMSFT::baseSpace.

public XrSceneComponentLocationMSFT
pose(XrPosef value)

Copies the specified XrPosef to the pose field.

public XrSceneComponentLocationMSFT
pose(Consumer<XrPosef> consumer)

Passes the pose field to the specified Consumer.

public XrSceneComponentLocationMSFT
set(long flags, XrPosef pose)

Initializes this struct with the specified values.

public XrSceneComponentLocationMSFT

Returns:

this struct
set
(XrSceneComponentLocationMSFT
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).
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.

POSEback to summary
public static final int POSE

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

Constructor Detail

XrSceneComponentLocationMSFTback to summary
protected XrSceneComponentLocationMSFT(long address, ByteBuffer container)
XrSceneComponentLocationMSFTback to summary
public XrSceneComponentLocationMSFT(ByteBuffer container)

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

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static XrSceneComponentLocationMSFT calloc(MemoryStack stack)

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

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

Returns a new XrSceneComponentLocationMSFT instance allocated with BufferUtils.

createback to summary
public static XrSceneComponentLocationMSFT create(long address)

Returns a new XrSceneComponentLocationMSFT instance for the specified memory address.

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

Returns a new XrSceneComponentLocationMSFT.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a XrSceneComponentLocationMSFT.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static XrSceneComponentLocationMSFT createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
flagsback to summary
public long flags()

a bitfield, with bit masks defined in XrSpaceLocationFlagBits, to indicate which members contain valid data.

Annotations
@NativeType:XrSpaceLocationFlags
flagsback to summary
public XrSceneComponentLocationMSFT flags(long value)

Sets the specified value to the flags field.

mallocback to summary
public static XrSceneComponentLocationMSFT malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static XrSceneComponentLocationMSFT malloc(MemoryStack stack)

Returns a new XrSceneComponentLocationMSFT instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

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.

nposeback to summary
public static XrPosef npose(long struct)

Unsafe version of pose.

nposeback to summary
public static void npose(long struct, XrPosef value)

Unsafe version of pose.

poseback to summary
public XrPosef pose()

an XrPosef defining the position and orientation of the scene component within the reference frame of the corresponding XrSceneComponentsLocateInfoMSFT::baseSpace.

poseback to summary
public XrSceneComponentLocationMSFT pose(XrPosef value)

Copies the specified XrPosef to the pose field.

poseback to summary
public XrSceneComponentLocationMSFT pose(Consumer<XrPosef> consumer)

Passes the pose field to the specified Consumer.

setback to summary
public XrSceneComponentLocationMSFT set(long flags, XrPosef pose)

Initializes this struct with the specified values.

setback to summary
public XrSceneComponentLocationMSFT set(XrSceneComponentLocationMSFT src)

Copies the specified struct data to this struct.

Parameters
src:XrSceneComponentLocationMSFT

the source struct

Returns:XrSceneComponentLocationMSFT

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
org.lwjgl.openxr back to summary

public Class XrSceneComponentLocationMSFT.Buffer

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

An array of XrSceneComponentLocationMSFT structs.

Field Summary

Modifier and TypeField and Description
private static final XrSceneComponentLocationMSFT

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new XrSceneComponentLocationMSFT.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 XrSceneComponentLocationMSFT#flags field.
flags
()

public XrSceneComponentLocationMSFT.Buffer
flags(long value)

Sets the specified value to the XrSceneComponentLocationMSFT#flags field.

protected XrSceneComponentLocationMSFT
public XrPosef

Returns:

a XrPosef view of the XrSceneComponentLocationMSFT#pose field.
pose
()

public XrSceneComponentLocationMSFT.Buffer
pose(XrPosef value)

Copies the specified XrPosef to the XrSceneComponentLocationMSFT#pose field.

public XrSceneComponentLocationMSFT.Buffer
pose(Consumer<XrPosef> consumer)

Passes the XrSceneComponentLocationMSFT#pose field to the specified Consumer.

protected XrSceneComponentLocationMSFT.Buffer
Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final XrSceneComponentLocationMSFT ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new XrSceneComponentLocationMSFT.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 XrSceneComponentLocationMSFT#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 XrSceneComponentLocationMSFT#flags field.

Annotations
@NativeType:XrSpaceLocationFlags
flagsback to summary
public XrSceneComponentLocationMSFT.Buffer flags(long value)

Sets the specified value to the XrSceneComponentLocationMSFT#flags field.

getElementFactoryback to summary
protected XrSceneComponentLocationMSFT getElementFactory()

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

Annotations
@Override
poseback to summary
public XrPosef pose()
Returns:XrPosef

a XrPosef view of the XrSceneComponentLocationMSFT#pose field.

poseback to summary
public XrSceneComponentLocationMSFT.Buffer pose(XrPosef value)

Copies the specified XrPosef to the XrSceneComponentLocationMSFT#pose field.

poseback to summary
public XrSceneComponentLocationMSFT.Buffer pose(Consumer<XrPosef> consumer)

Passes the XrSceneComponentLocationMSFT#pose field to the specified Consumer.

selfback to summary
protected XrSceneComponentLocationMSFT.Buffer self()

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

Annotations
@Override