Package org.lwjgl.openxr

Class XrHolographicWindowAttachmentMSFT

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<XrHolographicWindowAttachmentMSFT>

org.lwjgl.openxr.XrHolographicWindowAttachmentMSFT

All Implemented Interfaces:

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

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

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)

• The XR_MSFT_holographic_window_attachment extension must be enabled prior to using XrHolographicWindowAttachmentMSFT
• type must be TYPE_HOLOGRAPHIC_WINDOW_ATTACHMENT_MSFT
• next must be NULL or a valid pointer to the next structure in a structure chain
• holographicSpace must be a pointer to an IUnknown value
• coreWindow must be a pointer to an IUnknown value

See Also

CreateSession

Layout

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static XrHolographicWindowAttachmentMSFT	calloc()	Returns a new XrHolographicWindowAttachmentMSFT instance allocated with memCalloc.
static XrHolographicWindowAttachmentMSFT.Buffer	calloc(int capacity)	Returns a new XrHolographicWindowAttachmentMSFT.Buffer instance allocated with memCalloc.
static XrHolographicWindowAttachmentMSFT.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrHolographicWindowAttachmentMSFT.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrHolographicWindowAttachmentMSFT	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrHolographicWindowAttachmentMSFT instance allocated on the specified MemoryStack and initializes all its bits to zero.
long	coreWindow()	a pointer to a valid Windows.UI.Core.CoreWindow.
XrHolographicWindowAttachmentMSFT	coreWindow(long value)	Sets the specified value to the coreWindow() field.
static XrHolographicWindowAttachmentMSFT	create()	Returns a new XrHolographicWindowAttachmentMSFT instance allocated with BufferUtils.
static XrHolographicWindowAttachmentMSFT.Buffer	create(int capacity)	Returns a new XrHolographicWindowAttachmentMSFT.Buffer instance allocated with BufferUtils.
static XrHolographicWindowAttachmentMSFT	create(long address)	Returns a new XrHolographicWindowAttachmentMSFT instance for the specified memory address.
static XrHolographicWindowAttachmentMSFT.Buffer	create(long address, int capacity)	Create a XrHolographicWindowAttachmentMSFT.Buffer instance at the specified memory.
static @Nullable XrHolographicWindowAttachmentMSFT	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable XrHolographicWindowAttachmentMSFT.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
long	holographicSpace()	a pointer to a valid Windows.Graphics.Holographic.HolographicSpace.
XrHolographicWindowAttachmentMSFT	holographicSpace(long value)	Sets the specified value to the holographicSpace() field.
static XrHolographicWindowAttachmentMSFT	malloc()	Returns a new XrHolographicWindowAttachmentMSFT instance allocated with memAlloc.
static XrHolographicWindowAttachmentMSFT.Buffer	malloc(int capacity)	Returns a new XrHolographicWindowAttachmentMSFT.Buffer instance allocated with memAlloc.
static XrHolographicWindowAttachmentMSFT.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrHolographicWindowAttachmentMSFT.Buffer instance allocated on the specified MemoryStack.
static XrHolographicWindowAttachmentMSFT	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrHolographicWindowAttachmentMSFT instance allocated on the specified MemoryStack.
static long	ncoreWindow(long struct)	Unsafe version of coreWindow().
static void	ncoreWindow(long struct, long value)	Unsafe version of coreWindow.
long	next()	NULL or a pointer to the next structure in a structure chain.
XrHolographicWindowAttachmentMSFT	next(long value)	Sets the specified value to the next() field.
static long	nholographicSpace(long struct)	Unsafe version of holographicSpace().
static void	nholographicSpace(long struct, long value)	Unsafe version of holographicSpace.
static long	nnext(long struct)	Unsafe version of next().
static void	nnext(long struct, long value)	Unsafe version of next.
static int	ntype(long struct)	Unsafe version of type().
static void	ntype(long struct, int value)	Unsafe version of type.
XrHolographicWindowAttachmentMSFT	set(int type, long next, long holographicSpace, long coreWindow)	Initializes this struct with the specified values.
XrHolographicWindowAttachmentMSFT	set(XrHolographicWindowAttachmentMSFT src)	Copies the specified struct data to this struct.
int	sizeof()
int	type()	the XrStructureType of this structure.
XrHolographicWindowAttachmentMSFT	type(int value)	Sets the specified value to the type() field.
XrHolographicWindowAttachmentMSFT	type$Default()	Sets the TYPE_HOLOGRAPHIC_WINDOW_ATTACHMENT_MSFT value to the type() field.
static void	validate(long struct)	Validates pointer members that should not be NULL.

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.

HOLOGRAPHICSPACE

public static final int HOLOGRAPHICSPACE

The struct member offsets.

COREWINDOW

public static final int COREWINDOW

The struct member offsets.

Constructor Details

XrHolographicWindowAttachmentMSFT

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 Details

sizeof

public int sizeof()

Specified by:

sizeof in class org.lwjgl.system.Struct<XrHolographicWindowAttachmentMSFT>

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. No such structures are defined in core OpenXR or this extension.

holographicSpace

public long holographicSpace()

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

coreWindow

public long coreWindow()

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

type

public XrHolographicWindowAttachmentMSFT type(int value)

Sets the specified value to the type() field.

type$Default

public XrHolographicWindowAttachmentMSFT type$Default()

Sets the TYPE_HOLOGRAPHIC_WINDOW_ATTACHMENT_MSFT value to the type() field.

next

public XrHolographicWindowAttachmentMSFT next(long value)

Sets the specified value to the next() field.

holographicSpace

public XrHolographicWindowAttachmentMSFT holographicSpace(long value)

Sets the specified value to the holographicSpace() field.

coreWindow

public XrHolographicWindowAttachmentMSFT coreWindow(long value)

Sets the specified value to the coreWindow() field.

set

public XrHolographicWindowAttachmentMSFT set(int type,
 long next,
 long holographicSpace,
 long coreWindow)

Initializes this struct with the specified values.

set

public XrHolographicWindowAttachmentMSFT set(XrHolographicWindowAttachmentMSFT src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static XrHolographicWindowAttachmentMSFT malloc()

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

calloc

public static XrHolographicWindowAttachmentMSFT calloc()

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

create

public static XrHolographicWindowAttachmentMSFT create()

Returns a new XrHolographicWindowAttachmentMSFT instance allocated with BufferUtils.

create

public static XrHolographicWindowAttachmentMSFT create(long address)

Returns a new XrHolographicWindowAttachmentMSFT instance for the specified memory address.

createSafe

public static @Nullable XrHolographicWindowAttachmentMSFT createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static XrHolographicWindowAttachmentMSFT.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static XrHolographicWindowAttachmentMSFT.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static XrHolographicWindowAttachmentMSFT.Buffer create(int capacity)

Returns a new XrHolographicWindowAttachmentMSFT.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a XrHolographicWindowAttachmentMSFT.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new XrHolographicWindowAttachmentMSFT instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nholographicSpace

public static long nholographicSpace(long struct)

Unsafe version of holographicSpace().

ncoreWindow

public static long ncoreWindow(long struct)

Unsafe version of coreWindow().

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.

nholographicSpace

public static void nholographicSpace(long struct,
 long value)

Unsafe version of holographicSpace.

ncoreWindow

public static void ncoreWindow(long struct,
 long value)

Unsafe version of coreWindow.

validate

public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters:

struct - the struct to validate