Top Description Inners Fields Constructors Methods
org.lwjgl.openxr

public Class XrSessionCreateInfoOverlayEXTX

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

Session creation extension struct providing overlay session parameters.
Valid Usage (Implicit)

Layout


struct XrSessionCreateInfoOverlayEXTX {
    XrStructureType type;
    void const * next;
    XrOverlaySessionCreateFlagsEXTX createFlags;
    uint32_t sessionLayersPlacement;
}

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
CREATEFLAGS

The struct member offsets.

public static final int
NEXT

The struct member offsets.

public static final int
SESSIONLAYERSPLACEMENT

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

public
XrSessionCreateInfoOverlayEXTX(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static XrSessionCreateInfoOverlayEXTX
calloc()

Returns a new XrSessionCreateInfoOverlayEXTX instance allocated with memCalloc.

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

Returns a new XrSessionCreateInfoOverlayEXTX.Buffer instance allocated with memCalloc.

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

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

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

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

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

Returns a new XrSessionCreateInfoOverlayEXTX instance allocated with BufferUtils.

public static XrSessionCreateInfoOverlayEXTX
create(long address)

Returns a new XrSessionCreateInfoOverlayEXTX instance for the specified memory address.

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

Returns a new XrSessionCreateInfoOverlayEXTX.Buffer instance allocated with BufferUtils.

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

Create a XrSessionCreateInfoOverlayEXTX.Buffer instance at the specified memory.

public long
createFlags()

0 or one or more XrOverlaySessionCreateFlagBitsEXTX which indicate various characteristics desired for the overlay session.

public XrSessionCreateInfoOverlayEXTX
createFlags(long value)

Sets the specified value to the createFlags field.

public static XrSessionCreateInfoOverlayEXTX
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public static XrSessionCreateInfoOverlayEXTX
malloc()

Returns a new XrSessionCreateInfoOverlayEXTX instance allocated with memAlloc.

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

Returns a new XrSessionCreateInfoOverlayEXTX.Buffer instance allocated with memAlloc.

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

Returns a new XrSessionCreateInfoOverlayEXTX instance allocated on the specified MemoryStack.

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

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

public static long
ncreateFlags(long struct)

Unsafe version of createFlags.

public static void
ncreateFlags(long struct, long value)

Unsafe version of createFlags.

public long
next()

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

public XrSessionCreateInfoOverlayEXTX
next(long value)

Sets the specified value to the next field.

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
nsessionLayersPlacement(long struct)

Unsafe version of sessionLayersPlacement.

public static void
nsessionLayersPlacement(long struct, int value)

Unsafe version of sessionLayersPlacement.

public static int
ntype(long struct)

Unsafe version of type.

public static void
ntype(long struct, int value)

Unsafe version of type.

public int
sessionLayersPlacement()

a value indicating the desired placement of the session’s composition layers in terms of other sessions.

public XrSessionCreateInfoOverlayEXTX
sessionLayersPlacement(int value)

Sets the specified value to the sessionLayersPlacement field.

public XrSessionCreateInfoOverlayEXTX
set(int type, long next, long createFlags, int sessionLayersPlacement)

Initializes this struct with the specified values.

public XrSessionCreateInfoOverlayEXTX

Returns:

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

Sets the specified value to the type field.

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

CREATEFLAGSback to summary
public static final int CREATEFLAGS

The struct member offsets.

NEXTback to summary
public static final int NEXT

The struct member offsets.

SESSIONLAYERSPLACEMENTback to summary
public static final int SESSIONLAYERSPLACEMENT

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

XrSessionCreateInfoOverlayEXTXback to summary
protected XrSessionCreateInfoOverlayEXTX(long address, ByteBuffer container)
XrSessionCreateInfoOverlayEXTXback to summary
public XrSessionCreateInfoOverlayEXTX(ByteBuffer container)

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

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static XrSessionCreateInfoOverlayEXTX calloc(MemoryStack stack)

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

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

Returns a new XrSessionCreateInfoOverlayEXTX instance allocated with BufferUtils.

createback to summary
public static XrSessionCreateInfoOverlayEXTX create(long address)

Returns a new XrSessionCreateInfoOverlayEXTX instance for the specified memory address.

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

Returns a new XrSessionCreateInfoOverlayEXTX.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a XrSessionCreateInfoOverlayEXTX.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createFlagsback to summary
public long createFlags()

0 or one or more XrOverlaySessionCreateFlagBitsEXTX which indicate various characteristics desired for the overlay session.

Annotations
@NativeType:XrOverlaySessionCreateFlagsEXTX
createFlagsback to summary
public XrSessionCreateInfoOverlayEXTX createFlags(long value)

Sets the specified value to the createFlags field.

createSafeback to summary
public static XrSessionCreateInfoOverlayEXTX createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
mallocback to summary
public static XrSessionCreateInfoOverlayEXTX malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static XrSessionCreateInfoOverlayEXTX malloc(MemoryStack stack)

Returns a new XrSessionCreateInfoOverlayEXTX instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

ncreateFlagsback to summary
public static long ncreateFlags(long struct)

Unsafe version of createFlags.

ncreateFlagsback to summary
public static void ncreateFlags(long struct, long value)

Unsafe version of createFlags.

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

Sets the specified value to the next field.

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.

nsessionLayersPlacementback to summary
public static int nsessionLayersPlacement(long struct)

Unsafe version of sessionLayersPlacement.

nsessionLayersPlacementback to summary
public static void nsessionLayersPlacement(long struct, int value)

Unsafe version of sessionLayersPlacement.

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.

sessionLayersPlacementback to summary
public int sessionLayersPlacement()

a value indicating the desired placement of the session’s composition layers in terms of other sessions.

Annotations
@NativeType:uint32_t
sessionLayersPlacementback to summary
public XrSessionCreateInfoOverlayEXTX sessionLayersPlacement(int value)

Sets the specified value to the sessionLayersPlacement field.

setback to summary
public XrSessionCreateInfoOverlayEXTX set(int type, long next, long createFlags, int sessionLayersPlacement)

Initializes this struct with the specified values.

setback to summary
public XrSessionCreateInfoOverlayEXTX set(XrSessionCreateInfoOverlayEXTX src)

Copies the specified struct data to this struct.

Parameters
src:XrSessionCreateInfoOverlayEXTX

the source struct

Returns:XrSessionCreateInfoOverlayEXTX

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

Sets the specified value to the type field.

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

Sets the TYPE_SESSION_CREATE_INFO_OVERLAY_EXTX value to the type field.

org.lwjgl.openxr back to summary

public Class XrSessionCreateInfoOverlayEXTX.Buffer

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

An array of XrSessionCreateInfoOverlayEXTX structs.

Field Summary

Modifier and TypeField and Description
private static final XrSessionCreateInfoOverlayEXTX

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

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

public XrSessionCreateInfoOverlayEXTX.Buffer
createFlags(long value)

Sets the specified value to the XrSessionCreateInfoOverlayEXTX#createFlags field.

protected XrSessionCreateInfoOverlayEXTX
public long

Returns:

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

public XrSessionCreateInfoOverlayEXTX.Buffer
next(long value)

Sets the specified value to the XrSessionCreateInfoOverlayEXTX#next field.

protected XrSessionCreateInfoOverlayEXTX.Buffer
public int
public XrSessionCreateInfoOverlayEXTX.Buffer
sessionLayersPlacement(int value)

Sets the specified value to the XrSessionCreateInfoOverlayEXTX#sessionLayersPlacement field.

public int

Returns:

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

public XrSessionCreateInfoOverlayEXTX.Buffer
type(int value)

Sets the specified value to the XrSessionCreateInfoOverlayEXTX#type field.

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

Field Detail

ELEMENT_FACTORYback to summary
private static final XrSessionCreateInfoOverlayEXTX ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

createFlagsback to summary
public long createFlags()
Returns:long

the value of the XrSessionCreateInfoOverlayEXTX#createFlags field.

Annotations
@NativeType:XrOverlaySessionCreateFlagsEXTX
createFlagsback to summary
public XrSessionCreateInfoOverlayEXTX.Buffer createFlags(long value)

Sets the specified value to the XrSessionCreateInfoOverlayEXTX#createFlags field.

getElementFactoryback to summary
protected XrSessionCreateInfoOverlayEXTX getElementFactory()

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

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

the value of the XrSessionCreateInfoOverlayEXTX#next field.

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

Sets the specified value to the XrSessionCreateInfoOverlayEXTX#next field.

selfback to summary
protected XrSessionCreateInfoOverlayEXTX.Buffer self()

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

Annotations
@Override
sessionLayersPlacementback to summary
public int sessionLayersPlacement()
Returns:int

the value of the XrSessionCreateInfoOverlayEXTX#sessionLayersPlacement field.

Annotations
@NativeType:uint32_t
sessionLayersPlacementback to summary
public XrSessionCreateInfoOverlayEXTX.Buffer sessionLayersPlacement(int value)

Sets the specified value to the XrSessionCreateInfoOverlayEXTX#sessionLayersPlacement field.

typeback to summary
public int type()
Returns:int

the value of the XrSessionCreateInfoOverlayEXTX#type field.

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

Sets the specified value to the XrSessionCreateInfoOverlayEXTX#type field.

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

Sets the TYPE_SESSION_CREATE_INFO_OVERLAY_EXTX value to the XrSessionCreateInfoOverlayEXTX#type field.