Package org.lwjgl.openxr

Class XrSwapchainImageBaseHeader

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<XrSwapchainImageBaseHeader>

org.lwjgl.openxr.XrSwapchainImageBaseHeader

All Implemented Interfaces:

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

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

Image base header for a swapchain image.

Description

The XrSwapchainImageBaseHeader is a base structure that is extended by graphics API-specific stext:XrSwapchainImage* child structures.

Valid Usage (Implicit)

• type must be one of the following XrStructureType values: TYPE_SWAPCHAIN_IMAGE_OPENGL_KHR, TYPE_SWAPCHAIN_IMAGE_VULKAN_KHR
• next must be NULL or a valid pointer to the next structure in a structure chain

See Also

EnumerateEnvironmentDepthSwapchainImagesMETA, EnumerateSwapchainImages

Layout

 struct XrSwapchainImageBaseHeader {
     XrStructureType type();
     void * next();
 }

Nested Class Summary

Nested Classes

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

Method Summary

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

XrSwapchainImageBaseHeader

public XrSwapchainImageBaseHeader(ByteBuffer container)

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

type

public int type()

the XrStructureType of this structure. This base structure itself has no associated XrStructureType value.

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

Sets the specified value to the type() field.

next

public XrSwapchainImageBaseHeader next(long value)

Sets the specified value to the next() field.

set

public XrSwapchainImageBaseHeader set(int type,
 long next)

Initializes this struct with the specified values.

set

public XrSwapchainImageBaseHeader set(XrSwapchainImageBaseHeader src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static XrSwapchainImageBaseHeader malloc()

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

calloc

public static XrSwapchainImageBaseHeader calloc()

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

create

public static XrSwapchainImageBaseHeader create()

Returns a new XrSwapchainImageBaseHeader instance allocated with BufferUtils.

create

public static XrSwapchainImageBaseHeader create(long address)

Returns a new XrSwapchainImageBaseHeader instance for the specified memory address.

createSafe

public static @Nullable XrSwapchainImageBaseHeader createSafe(long address)

Like create, but returns null if address is NULL.

create

public static XrSwapchainImageBaseHeader create(XrSwapchainImageOpenGLKHR value)

Upcasts the specified XrSwapchainImageOpenGLKHR instance to XrSwapchainImageBaseHeader.

create

public static XrSwapchainImageBaseHeader create(XrSwapchainImageVulkanKHR value)

Upcasts the specified XrSwapchainImageVulkanKHR instance to XrSwapchainImageBaseHeader.

malloc

public static XrSwapchainImageBaseHeader.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static XrSwapchainImageBaseHeader.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static XrSwapchainImageBaseHeader.Buffer create(int capacity)

Returns a new XrSwapchainImageBaseHeader.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a XrSwapchainImageBaseHeader.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

create

public static XrSwapchainImageBaseHeader.Buffer create(XrSwapchainImageOpenGLKHR.Buffer value)

Upcasts the specified XrSwapchainImageOpenGLKHR.Buffer instance to XrSwapchainImageBaseHeader.Buffer.

create

public static XrSwapchainImageBaseHeader.Buffer create(XrSwapchainImageVulkanKHR.Buffer value)

Upcasts the specified XrSwapchainImageVulkanKHR.Buffer instance to XrSwapchainImageBaseHeader.Buffer.

malloc

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

Returns a new XrSwapchainImageBaseHeader instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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