Top Description Inners Fields Constructors Methods
org.lwjgl.openxr

public Class XrHolographicWindowAttachmentMSFT

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

The holographic window binding structure which can be passed at session creation.
Description

When creating a holographic window-backed XrSession, the application provides a pointer to an XrHolographicWindowAttachmentMSFT in the next chain of the XrSessionCreateInfo.

The session state of a holographic window-backed XrSession will only reach SESSION_STATE_VISIBLE when the provided CoreWindow is made visible. If the CoreWindow is for a secondary app view, the application must programmatically request to make the CoreWindow visible (e.g. with ApplicationViewSwitcher.TryShowAsStandaloneAsync or ApplicationViewSwitcher.SwitchAsync).

The app must not call CreateSession while the specified CoreWindow thread is blocked, otherwise the call may deadlock.

Valid Usage (Implicit)
See Also

CreateSession

Layout


struct XrHolographicWindowAttachmentMSFT {
    XrStructureType type;
    void const * next;
    IUnknown * holographicSpace;
    IUnknown * coreWindow;
}

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
COREWINDOW

The struct member offsets.

public static final int
HOLOGRAPHICSPACE

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
public
XrHolographicWindowAttachmentMSFT(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static XrHolographicWindowAttachmentMSFT
calloc()

Returns a new XrHolographicWindowAttachmentMSFT instance allocated with memCalloc.

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

Returns a new XrHolographicWindowAttachmentMSFT.Buffer instance allocated with memCalloc.

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

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

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

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

public long
coreWindow()

a pointer to a valid Windows.UI.Core.CoreWindow.

public XrHolographicWindowAttachmentMSFT
coreWindow(long value)

Sets the specified value to the coreWindow field.

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

Returns a new XrHolographicWindowAttachmentMSFT instance allocated with BufferUtils.

public static XrHolographicWindowAttachmentMSFT
create(long address)

Returns a new XrHolographicWindowAttachmentMSFT instance for the specified memory address.

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

Returns a new XrHolographicWindowAttachmentMSFT.Buffer instance allocated with BufferUtils.

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

Create a XrHolographicWindowAttachmentMSFT.Buffer instance at the specified memory.

public static XrHolographicWindowAttachmentMSFT
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public long
holographicSpace()

a pointer to a valid Windows.Graphics.Holographic.HolographicSpace.

public XrHolographicWindowAttachmentMSFT
holographicSpace(long value)

Sets the specified value to the holographicSpace field.

public static XrHolographicWindowAttachmentMSFT
malloc()

Returns a new XrHolographicWindowAttachmentMSFT instance allocated with memAlloc.

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

Returns a new XrHolographicWindowAttachmentMSFT.Buffer instance allocated with memAlloc.

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

Returns a new XrHolographicWindowAttachmentMSFT instance allocated on the specified MemoryStack.

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

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

public static long
ncoreWindow(long struct)

Unsafe version of coreWindow.

public static void
ncoreWindow(long struct, long value)

Unsafe version of coreWindow.

public long
next()

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

public XrHolographicWindowAttachmentMSFT
next(long value)

Sets the specified value to the next field.

public static long
nholographicSpace(long struct)

Unsafe version of holographicSpace.

public static void
nholographicSpace(long struct, long value)

Unsafe version of holographicSpace.

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 XrHolographicWindowAttachmentMSFT
set(int type, long next, long holographicSpace, long coreWindow)

Initializes this struct with the specified values.

public XrHolographicWindowAttachmentMSFT

Returns:

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

Sets the specified value to the type field.

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

COREWINDOWback to summary
public static final int COREWINDOW

The struct member offsets.

HOLOGRAPHICSPACEback to summary
public static final int HOLOGRAPHICSPACE

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

XrHolographicWindowAttachmentMSFTback to summary
protected XrHolographicWindowAttachmentMSFT(long address, ByteBuffer container)
XrHolographicWindowAttachmentMSFTback to summary
public XrHolographicWindowAttachmentMSFT(ByteBuffer container)

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

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static XrHolographicWindowAttachmentMSFT calloc(MemoryStack stack)

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

Returns a new XrHolographicWindowAttachmentMSFT.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

coreWindowback to summary
public long coreWindow()

a pointer to a valid Windows.UI.Core.CoreWindow.

Annotations
@NativeType:IUnknown *
coreWindowback to summary
public XrHolographicWindowAttachmentMSFT coreWindow(long value)

Sets the specified value to the coreWindow field.

createback to summary
protected XrHolographicWindowAttachmentMSFT 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 XrHolographicWindowAttachmentMSFT create()

Returns a new XrHolographicWindowAttachmentMSFT instance allocated with BufferUtils.

createback to summary
public static XrHolographicWindowAttachmentMSFT create(long address)

Returns a new XrHolographicWindowAttachmentMSFT instance for the specified memory address.

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

Returns a new XrHolographicWindowAttachmentMSFT.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a XrHolographicWindowAttachmentMSFT.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static XrHolographicWindowAttachmentMSFT createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
holographicSpaceback to summary
public long holographicSpace()

a pointer to a valid Windows.Graphics.Holographic.HolographicSpace.

Annotations
@NativeType:IUnknown *
holographicSpaceback to summary
public XrHolographicWindowAttachmentMSFT holographicSpace(long value)

Sets the specified value to the holographicSpace field.

mallocback to summary
public static XrHolographicWindowAttachmentMSFT malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static XrHolographicWindowAttachmentMSFT malloc(MemoryStack stack)

Returns a new XrHolographicWindowAttachmentMSFT instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

ncoreWindowback to summary
public static long ncoreWindow(long struct)

Unsafe version of coreWindow.

ncoreWindowback to summary
public static void ncoreWindow(long struct, long value)

Unsafe version of coreWindow.

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 XrHolographicWindowAttachmentMSFT next(long value)

Sets the specified value to the next field.

nholographicSpaceback to summary
public static long nholographicSpace(long struct)

Unsafe version of holographicSpace.

nholographicSpaceback to summary
public static void nholographicSpace(long struct, long value)

Unsafe version of holographicSpace.

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 XrHolographicWindowAttachmentMSFT set(int type, long next, long holographicSpace, long coreWindow)

Initializes this struct with the specified values.

setback to summary
public XrHolographicWindowAttachmentMSFT set(XrHolographicWindowAttachmentMSFT src)

Copies the specified struct data to this struct.

Parameters
src:XrHolographicWindowAttachmentMSFT

the source struct

Returns:XrHolographicWindowAttachmentMSFT

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

Sets the specified value to the type field.

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

Sets the TYPE_HOLOGRAPHIC_WINDOW_ATTACHMENT_MSFT 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 XrHolographicWindowAttachmentMSFT.Buffer

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

An array of XrHolographicWindowAttachmentMSFT structs.

Field Summary

Modifier and TypeField and Description
private static final XrHolographicWindowAttachmentMSFT

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

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

public XrHolographicWindowAttachmentMSFT.Buffer
coreWindow(long value)

Sets the specified value to the XrHolographicWindowAttachmentMSFT#coreWindow field.

protected XrHolographicWindowAttachmentMSFT
public long
public XrHolographicWindowAttachmentMSFT.Buffer
holographicSpace(long value)

Sets the specified value to the XrHolographicWindowAttachmentMSFT#holographicSpace field.

public long

Returns:

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

public XrHolographicWindowAttachmentMSFT.Buffer
next(long value)

Sets the specified value to the XrHolographicWindowAttachmentMSFT#next field.

protected XrHolographicWindowAttachmentMSFT.Buffer
public int

Returns:

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

public XrHolographicWindowAttachmentMSFT.Buffer
type(int value)

Sets the specified value to the XrHolographicWindowAttachmentMSFT#type field.

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

Field Detail

ELEMENT_FACTORYback to summary
private static final XrHolographicWindowAttachmentMSFT ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

coreWindowback to summary
public long coreWindow()
Returns:long

the value of the XrHolographicWindowAttachmentMSFT#coreWindow field.

Annotations
@NativeType:IUnknown *
coreWindowback to summary
public XrHolographicWindowAttachmentMSFT.Buffer coreWindow(long value)

Sets the specified value to the XrHolographicWindowAttachmentMSFT#coreWindow field.

getElementFactoryback to summary
protected XrHolographicWindowAttachmentMSFT getElementFactory()

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

Annotations
@Override
holographicSpaceback to summary
public long holographicSpace()
Returns:long

the value of the XrHolographicWindowAttachmentMSFT#holographicSpace field.

Annotations
@NativeType:IUnknown *
holographicSpaceback to summary
public XrHolographicWindowAttachmentMSFT.Buffer holographicSpace(long value)

Sets the specified value to the XrHolographicWindowAttachmentMSFT#holographicSpace field.

nextback to summary
public long next()
Returns:long

the value of the XrHolographicWindowAttachmentMSFT#next field.

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

Sets the specified value to the XrHolographicWindowAttachmentMSFT#next field.

selfback to summary
protected XrHolographicWindowAttachmentMSFT.Buffer self()

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

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

the value of the XrHolographicWindowAttachmentMSFT#type field.

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

Sets the specified value to the XrHolographicWindowAttachmentMSFT#type field.

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

Sets the TYPE_HOLOGRAPHIC_WINDOW_ATTACHMENT_MSFT value to the XrHolographicWindowAttachmentMSFT#type field.