Top Description Inners Fields Constructors Methods
org.lwjgl.openxr

public Class XrSwapchainImageWaitInfo

extends Struct<XrSwapchainImageWaitInfo>
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 a swapchain image wait operation.
Valid Usage (Implicit)
See Also

WaitSwapchainImage

Layout


struct XrSwapchainImageWaitInfo {
    XrStructureType type;
    void const * next;
    XrDuration timeout;
}

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
NEXT

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
TIMEOUT

The struct member offsets.

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

public
XrSwapchainImageWaitInfo(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static XrSwapchainImageWaitInfo
calloc()

Returns a new XrSwapchainImageWaitInfo instance allocated with memCalloc.

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

Returns a new XrSwapchainImageWaitInfo.Buffer instance allocated with memCalloc.

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

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

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

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

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

Returns a new XrSwapchainImageWaitInfo instance allocated with BufferUtils.

public static XrSwapchainImageWaitInfo
create(long address)

Returns a new XrSwapchainImageWaitInfo instance for the specified memory address.

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

Returns a new XrSwapchainImageWaitInfo.Buffer instance allocated with BufferUtils.

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

Create a XrSwapchainImageWaitInfo.Buffer instance at the specified memory.

public static XrSwapchainImageWaitInfo
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public static XrSwapchainImageWaitInfo
malloc()

Returns a new XrSwapchainImageWaitInfo instance allocated with memAlloc.

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

Returns a new XrSwapchainImageWaitInfo.Buffer instance allocated with memAlloc.

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

Returns a new XrSwapchainImageWaitInfo instance allocated on the specified MemoryStack.

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

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

public long
next()

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

public XrSwapchainImageWaitInfo
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 long
ntimeout(long struct)

Unsafe version of timeout.

public static void
ntimeout(long struct, long value)

Unsafe version of timeout.

public static int
ntype(long struct)

Unsafe version of type.

public static void
ntype(long struct, int value)

Unsafe version of type.

public XrSwapchainImageWaitInfo
set(int type, long next, long timeout)

Initializes this struct with the specified values.

public XrSwapchainImageWaitInfo

Returns:

this struct
set
(XrSwapchainImageWaitInfo
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 long
timeout()

indicates how many nanoseconds the call should block waiting for the image to become available for writing.

public XrSwapchainImageWaitInfo
timeout(long value)

Sets the specified value to the timeout field.

public int
type()

the XrStructureType of this structure.

public XrSwapchainImageWaitInfo
type(int value)

Sets the specified value to the type field.

public XrSwapchainImageWaitInfo
type$Default()

Sets the TYPE_SWAPCHAIN_IMAGE_WAIT_INFO value to the type field.

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.

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.

TIMEOUTback to summary
public static final int TIMEOUT

The struct member offsets.

TYPEback to summary
public static final int TYPE

The struct member offsets.

Constructor Detail

XrSwapchainImageWaitInfoback to summary
protected XrSwapchainImageWaitInfo(long address, ByteBuffer container)
XrSwapchainImageWaitInfoback to summary
public XrSwapchainImageWaitInfo(ByteBuffer container)

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

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static XrSwapchainImageWaitInfo calloc(MemoryStack stack)

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

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

Returns a new XrSwapchainImageWaitInfo instance allocated with BufferUtils.

createback to summary
public static XrSwapchainImageWaitInfo create(long address)

Returns a new XrSwapchainImageWaitInfo instance for the specified memory address.

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

Returns a new XrSwapchainImageWaitInfo.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a XrSwapchainImageWaitInfo.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static XrSwapchainImageWaitInfo createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

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

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static XrSwapchainImageWaitInfo malloc(MemoryStack stack)

Returns a new XrSwapchainImageWaitInfo instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Annotations
@NativeType:void const *
nextback to summary
public XrSwapchainImageWaitInfo 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.

ntimeoutback to summary
public static long ntimeout(long struct)

Unsafe version of timeout.

ntimeoutback to summary
public static void ntimeout(long struct, long value)

Unsafe version of timeout.

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 XrSwapchainImageWaitInfo set(int type, long next, long timeout)

Initializes this struct with the specified values.

setback to summary
public XrSwapchainImageWaitInfo set(XrSwapchainImageWaitInfo src)

Copies the specified struct data to this struct.

Parameters
src:XrSwapchainImageWaitInfo

the source struct

Returns:XrSwapchainImageWaitInfo

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
timeoutback to summary
public long timeout()

indicates how many nanoseconds the call should block waiting for the image to become available for writing.

Annotations
@NativeType:XrDuration
timeoutback to summary
public XrSwapchainImageWaitInfo timeout(long value)

Sets the specified value to the timeout field.

typeback to summary
public int type()

the XrStructureType of this structure.

Annotations
@NativeType:XrStructureType
typeback to summary
public XrSwapchainImageWaitInfo type(int value)

Sets the specified value to the type field.

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

Sets the TYPE_SWAPCHAIN_IMAGE_WAIT_INFO value to the type field.

org.lwjgl.openxr back to summary

public Class XrSwapchainImageWaitInfo.Buffer

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

An array of XrSwapchainImageWaitInfo structs.

Field Summary

Modifier and TypeField and Description
private static final XrSwapchainImageWaitInfo

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new XrSwapchainImageWaitInfo.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 XrSwapchainImageWaitInfo
public long

Returns:

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

public XrSwapchainImageWaitInfo.Buffer
next(long value)

Sets the specified value to the XrSwapchainImageWaitInfo#next field.

protected XrSwapchainImageWaitInfo.Buffer
public long

Returns:

the value of the XrSwapchainImageWaitInfo#timeout field.
timeout
()

public XrSwapchainImageWaitInfo.Buffer
timeout(long value)

Sets the specified value to the XrSwapchainImageWaitInfo#timeout field.

public int

Returns:

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

public XrSwapchainImageWaitInfo.Buffer
type(int value)

Sets the specified value to the XrSwapchainImageWaitInfo#type field.

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

Field Detail

ELEMENT_FACTORYback to summary
private static final XrSwapchainImageWaitInfo ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new XrSwapchainImageWaitInfo.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 XrSwapchainImageWaitInfo#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 XrSwapchainImageWaitInfo getElementFactory()

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

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

the value of the XrSwapchainImageWaitInfo#next field.

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

Sets the specified value to the XrSwapchainImageWaitInfo#next field.

selfback to summary
protected XrSwapchainImageWaitInfo.Buffer self()

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

Annotations
@Override
timeoutback to summary
public long timeout()
Returns:long

the value of the XrSwapchainImageWaitInfo#timeout field.

Annotations
@NativeType:XrDuration
timeoutback to summary
public XrSwapchainImageWaitInfo.Buffer timeout(long value)

Sets the specified value to the XrSwapchainImageWaitInfo#timeout field.

typeback to summary
public int type()
Returns:int

the value of the XrSwapchainImageWaitInfo#type field.

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

Sets the specified value to the XrSwapchainImageWaitInfo#type field.

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

Sets the TYPE_SWAPCHAIN_IMAGE_WAIT_INFO value to the XrSwapchainImageWaitInfo#type field.