Package org.lwjgl.openxr

Class XrSwapchainImageAcquireInfo

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<XrSwapchainImageAcquireInfo>

org.lwjgl.openxr.XrSwapchainImageAcquireInfo

All Implemented Interfaces:

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

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

Describes a swapchain image acquisition.

Description

Because this structure only exists to support extension-specific structures, AcquireSwapchainImage will accept a NULL argument for AcquireSwapchainImage::acquireInfo for applications that are not using any relevant extensions.

Valid Usage (Implicit)

• type must be TYPE_SWAPCHAIN_IMAGE_ACQUIRE_INFO
• next must be NULL or a valid pointer to the next structure in a structure chain

See Also

AcquireSwapchainImage

Layout

 struct XrSwapchainImageAcquireInfo {
     XrStructureType type();
     void const * next();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	XrSwapchainImageAcquireInfo.Buffer	An array of XrSwapchainImageAcquireInfo 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	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
XrSwapchainImageAcquireInfo(ByteBuffer container)	Creates a XrSwapchainImageAcquireInfo instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static XrSwapchainImageAcquireInfo	calloc()	Returns a new XrSwapchainImageAcquireInfo instance allocated with memCalloc.
static XrSwapchainImageAcquireInfo.Buffer	calloc(int capacity)	Returns a new XrSwapchainImageAcquireInfo.Buffer instance allocated with memCalloc.
static XrSwapchainImageAcquireInfo.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrSwapchainImageAcquireInfo.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrSwapchainImageAcquireInfo	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrSwapchainImageAcquireInfo instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrSwapchainImageAcquireInfo	create()	Returns a new XrSwapchainImageAcquireInfo instance allocated with BufferUtils.
static XrSwapchainImageAcquireInfo.Buffer	create(int capacity)	Returns a new XrSwapchainImageAcquireInfo.Buffer instance allocated with BufferUtils.
static XrSwapchainImageAcquireInfo	create(long address)	Returns a new XrSwapchainImageAcquireInfo instance for the specified memory address.
static XrSwapchainImageAcquireInfo.Buffer	create(long address, int capacity)	Create a XrSwapchainImageAcquireInfo.Buffer instance at the specified memory.
static @Nullable XrSwapchainImageAcquireInfo	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable XrSwapchainImageAcquireInfo.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
static XrSwapchainImageAcquireInfo	malloc()	Returns a new XrSwapchainImageAcquireInfo instance allocated with memAlloc.
static XrSwapchainImageAcquireInfo.Buffer	malloc(int capacity)	Returns a new XrSwapchainImageAcquireInfo.Buffer instance allocated with memAlloc.
static XrSwapchainImageAcquireInfo.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrSwapchainImageAcquireInfo.Buffer instance allocated on the specified MemoryStack.
static XrSwapchainImageAcquireInfo	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrSwapchainImageAcquireInfo instance allocated on the specified MemoryStack.
long	next()	NULL or a pointer to the next structure in a structure chain.
XrSwapchainImageAcquireInfo	next(long value)	Sets the specified value to the next() field.
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.
XrSwapchainImageAcquireInfo	set(int type, long next)	Initializes this struct with the specified values.
XrSwapchainImageAcquireInfo	set(XrSwapchainImageAcquireInfo src)	Copies the specified struct data to this struct.
int	sizeof()
int	type()	the XrStructureType of this structure.
XrSwapchainImageAcquireInfo	type(int value)	Sets the specified value to the type() field.
XrSwapchainImageAcquireInfo	type$Default()	Sets the TYPE_SWAPCHAIN_IMAGE_ACQUIRE_INFO value to the type() field.

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.

Constructor Details

XrSwapchainImageAcquireInfo

public XrSwapchainImageAcquireInfo(ByteBuffer container)

Creates a XrSwapchainImageAcquireInfo 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<XrSwapchainImageAcquireInfo>

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.

type

public XrSwapchainImageAcquireInfo type(int value)

Sets the specified value to the type() field.

type$Default

public XrSwapchainImageAcquireInfo type$Default()

Sets the TYPE_SWAPCHAIN_IMAGE_ACQUIRE_INFO value to the type() field.

next

public XrSwapchainImageAcquireInfo next(long value)

Sets the specified value to the next() field.

set

public XrSwapchainImageAcquireInfo set(int type,
 long next)

Initializes this struct with the specified values.

set

public XrSwapchainImageAcquireInfo set(XrSwapchainImageAcquireInfo src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static XrSwapchainImageAcquireInfo malloc()

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

calloc

public static XrSwapchainImageAcquireInfo calloc()

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

create

public static XrSwapchainImageAcquireInfo create()

Returns a new XrSwapchainImageAcquireInfo instance allocated with BufferUtils.

create

public static XrSwapchainImageAcquireInfo create(long address)

Returns a new XrSwapchainImageAcquireInfo instance for the specified memory address.

createSafe

public static @Nullable XrSwapchainImageAcquireInfo createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static XrSwapchainImageAcquireInfo.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static XrSwapchainImageAcquireInfo.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static XrSwapchainImageAcquireInfo.Buffer create(int capacity)

Returns a new XrSwapchainImageAcquireInfo.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a XrSwapchainImageAcquireInfo.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new XrSwapchainImageAcquireInfo instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

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.