Package org.lwjgl.openxr

Class XrSwapchainSubImage

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<XrSwapchainSubImage>

org.lwjgl.openxr.XrSwapchainSubImage

All Implemented Interfaces:

AutoCloseable, NativeResource, Pointer

public class XrSwapchainSubImage
extends Struct<XrSwapchainSubImage>
implements NativeResource

 struct XrSwapchainSubImage {
     XrSwapchain swapchain;
     {@link XrRect2Di XrRect2Di} imageRect;
     uint32_t imageArrayIndex;
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	XrSwapchainSubImage.Buffer	An array of XrSwapchainSubImage structs.

Nested classes/interfaces inherited from class org.lwjgl.system.Struct

Struct.StructValidation

Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer

Pointer.Default

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ALIGNOF	The struct alignment in bytes.
static final int	IMAGEARRAYINDEX	The struct member offsets.
static final int	IMAGERECT	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.
static final int	SWAPCHAIN	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
XrSwapchainSubImage(ByteBuffer container)	Creates a XrSwapchainSubImage instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static XrSwapchainSubImage	calloc()	Returns a new XrSwapchainSubImage instance allocated with memCalloc.
static XrSwapchainSubImage.Buffer	calloc(int capacity)	Returns a new XrSwapchainSubImage.Buffer instance allocated with memCalloc.
static XrSwapchainSubImage.Buffer	calloc(int capacity, MemoryStack stack)	Returns a new XrSwapchainSubImage.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrSwapchainSubImage	calloc(MemoryStack stack)	Returns a new XrSwapchainSubImage instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrSwapchainSubImage	create()	Returns a new XrSwapchainSubImage instance allocated with BufferUtils.
static XrSwapchainSubImage.Buffer	create(int capacity)	Returns a new XrSwapchainSubImage.Buffer instance allocated with BufferUtils.
static XrSwapchainSubImage	create(long address)	Returns a new XrSwapchainSubImage instance for the specified memory address.
static XrSwapchainSubImage.Buffer	create(long address, int capacity)	Create a XrSwapchainSubImage.Buffer instance at the specified memory.
static @Nullable XrSwapchainSubImage	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable XrSwapchainSubImage.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
int	imageArrayIndex()
XrSwapchainSubImage	imageArrayIndex(int value)	Sets the specified value to the imageArrayIndex field.
XrRect2Di	imageRect()
XrSwapchainSubImage	imageRect(Consumer<XrRect2Di> consumer)	Passes the imageRect field to the specified Consumer.
XrSwapchainSubImage	imageRect(XrRect2Di value)	Copies the specified XrRect2Di to the imageRect field.
static XrSwapchainSubImage	malloc()	Returns a new XrSwapchainSubImage instance allocated with memAlloc.
static XrSwapchainSubImage.Buffer	malloc(int capacity)	Returns a new XrSwapchainSubImage.Buffer instance allocated with memAlloc.
static XrSwapchainSubImage.Buffer	malloc(int capacity, MemoryStack stack)	Returns a new XrSwapchainSubImage.Buffer instance allocated on the specified MemoryStack.
static XrSwapchainSubImage	malloc(MemoryStack stack)	Returns a new XrSwapchainSubImage instance allocated on the specified MemoryStack.
static int	nimageArrayIndex(long struct)	Unsafe version of imageArrayIndex().
static void	nimageArrayIndex(long struct, int value)	Unsafe version of imageArrayIndex.
static XrRect2Di	nimageRect(long struct)	Unsafe version of imageRect().
static void	nimageRect(long struct, XrRect2Di value)	Unsafe version of imageRect.
static long	nswapchain(long struct)	Unsafe version of swapchain().
static void	nswapchain(long struct, XrSwapchain value)	Unsafe version of swapchain.
XrSwapchainSubImage	set(XrSwapchain swapchain, XrRect2Di imageRect, int imageArrayIndex)	Initializes this struct with the specified values.
XrSwapchainSubImage	set(XrSwapchainSubImage src)	Copies the specified struct data to this struct.
int	sizeof()	Returns sizeof(struct).
long	swapchain()
XrSwapchainSubImage	swapchain(XrSwapchain value)	Sets the specified value to the swapchain 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.

SWAPCHAIN

public static final int SWAPCHAIN

The struct member offsets.

IMAGERECT

public static final int IMAGERECT

The struct member offsets.

IMAGEARRAYINDEX

public static final int IMAGEARRAYINDEX

The struct member offsets.

Constructor Details

XrSwapchainSubImage

public XrSwapchainSubImage(ByteBuffer container)

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

Description copied from class: Struct

Returns sizeof(struct).

Specified by:

sizeof in class Struct<XrSwapchainSubImage>

swapchain

public long swapchain()

Returns:

the value of the swapchain field.

imageRect

public XrRect2Di imageRect()

Returns:

a XrRect2Di view of the imageRect field.

imageArrayIndex

public int imageArrayIndex()

Returns:

the value of the imageArrayIndex field.

swapchain

public XrSwapchainSubImage swapchain(XrSwapchain value)

Sets the specified value to the swapchain field.

imageRect

public XrSwapchainSubImage imageRect(XrRect2Di value)

Copies the specified XrRect2Di to the imageRect field.

imageRect

public XrSwapchainSubImage imageRect(Consumer<XrRect2Di> consumer)

Passes the imageRect field to the specified Consumer.

imageArrayIndex

public XrSwapchainSubImage imageArrayIndex(int value)

Sets the specified value to the imageArrayIndex field.

set

public XrSwapchainSubImage set(XrSwapchain swapchain,
 XrRect2Di imageRect,
 int imageArrayIndex)

Initializes this struct with the specified values.

set

public XrSwapchainSubImage set(XrSwapchainSubImage src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static XrSwapchainSubImage malloc()

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

calloc

public static XrSwapchainSubImage calloc()

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

create

public static XrSwapchainSubImage create()

Returns a new XrSwapchainSubImage instance allocated with BufferUtils.

create

public static XrSwapchainSubImage create(long address)

Returns a new XrSwapchainSubImage instance for the specified memory address.

createSafe

public static @Nullable XrSwapchainSubImage createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static XrSwapchainSubImage.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static XrSwapchainSubImage.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static XrSwapchainSubImage.Buffer create(int capacity)

Returns a new XrSwapchainSubImage.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a XrSwapchainSubImage.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

public static XrSwapchainSubImage malloc(MemoryStack stack)

Returns a new XrSwapchainSubImage instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static XrSwapchainSubImage calloc(MemoryStack stack)

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

Parameters:

stack - the stack from which to allocate

malloc

public static XrSwapchainSubImage.Buffer malloc(int capacity,
 MemoryStack stack)

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

public static XrSwapchainSubImage.Buffer calloc(int capacity,
 MemoryStack stack)

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

nswapchain

public static long nswapchain(long struct)

Unsafe version of swapchain().

nimageRect

public static XrRect2Di nimageRect(long struct)

Unsafe version of imageRect().

nimageArrayIndex

public static int nimageArrayIndex(long struct)

Unsafe version of imageArrayIndex().

nswapchain

public static void nswapchain(long struct,
 XrSwapchain value)

Unsafe version of swapchain.

nimageRect

public static void nimageRect(long struct,
 XrRect2Di value)

Unsafe version of imageRect.

nimageArrayIndex

public static void nimageArrayIndex(long struct,
 int value)

Unsafe version of imageArrayIndex.

validate

public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters:

struct - the struct to validate