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

Modifier and Type	Field and Description
public static final int	ALIGNOF The struct alignment in bytes.
public static final int	IMAGEARRAYINDEX The struct member offsets.
public static final int	IMAGERECT The struct member offsets.
public static final int	SIZEOF The struct size in bytes.
public static final int	SWAPCHAIN The struct member offsets.

Access	Constructor and Description
protected	XrSwapchainSubImage(long address, ByteBuffer container)
public	XrSwapchainSubImage(ByteBuffer container) Creates a `XrSwapchainSubImage` instance at the current position of the specified `ByteBuffer` container.

Method Summary

Modifier and Type	Method and Description
public static XrSwapchainSubImage	calloc() Returns a new `XrSwapchainSubImage` instance allocated with `memCalloc`.
public static XrSwapchainSubImage.Buffer	calloc(int the buffer capacity capacity) Returns a new `XrSwapchainSubImage.Buffer` instance allocated with `memCalloc`.
public static XrSwapchainSubImage	calloc(MemoryStack the stack from which to allocate stack) Returns a new `XrSwapchainSubImage` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
public static XrSwapchainSubImage.Buffer	calloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `XrSwapchainSubImage.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
protected XrSwapchainSubImage	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 XrSwapchainSubImage	create() Returns a new `XrSwapchainSubImage` instance allocated with `BufferUtils`.
public static XrSwapchainSubImage	create(long address) Returns a new `XrSwapchainSubImage` instance for the specified memory address.
public static XrSwapchainSubImage.Buffer	create(int the buffer capacity capacity) Returns a new `XrSwapchainSubImage.Buffer` instance allocated with `BufferUtils`.
public static XrSwapchainSubImage.Buffer	create(long the memory address address, int the buffer capacity capacity) Create a `XrSwapchainSubImage.Buffer` instance at the specified memory.
public static XrSwapchainSubImage	createSafe(long address) Like `create`, but returns `null` if `address` is `NULL`.
public static XrSwapchainSubImage.Buffer	createSafe(long address, int capacity) Like `create`, but returns `null` if `address` is `NULL`.
public int	imageArrayIndex() the image array index, with 0 meaning the first or only array element.
public XrSwapchainSubImage	imageArrayIndex(int value) Sets the specified value to the `imageArrayIndex` field.
public XrRect2Di	imageRect() an `XrRect2Di` representing the valid portion of the image to use, in pixels.
public XrSwapchainSubImage	imageRect(XrRect2Di value) Copies the specified `XrRect2Di` to the `imageRect` field.
public XrSwapchainSubImage	imageRect(Consumer<XrRect2Di> consumer) Passes the `imageRect` field to the specified `Consumer`.
public static XrSwapchainSubImage	malloc() Returns a new `XrSwapchainSubImage` instance allocated with `memAlloc`.
public static XrSwapchainSubImage.Buffer	malloc(int the buffer capacity capacity) Returns a new `XrSwapchainSubImage.Buffer` instance allocated with `memAlloc`.
public static XrSwapchainSubImage	malloc(MemoryStack the stack from which to allocate stack) Returns a new `XrSwapchainSubImage` instance allocated on the specified `MemoryStack`.
public static XrSwapchainSubImage.Buffer	malloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `XrSwapchainSubImage.Buffer` instance allocated on the specified `MemoryStack`.
public static int	nimageArrayIndex(long struct) Unsafe version of `imageArrayIndex`.
public static void	nimageArrayIndex(long struct, int value) Unsafe version of `imageArrayIndex`.
public static XrRect2Di	nimageRect(long struct) Unsafe version of `imageRect`.
public static void	nimageRect(long struct, XrRect2Di value) Unsafe version of `imageRect`.
public static long	nswapchain(long struct) Unsafe version of `swapchain`.
public static void	nswapchain(long struct, XrSwapchain value) Unsafe version of `swapchain`.
public XrSwapchainSubImage	set(XrSwapchain swapchain, XrRect2Di imageRect, int imageArrayIndex) Initializes this struct with the specified values.
public XrSwapchainSubImage	Returns: this struct set(XrSwapchainSubImage 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	swapchain() the `XrSwapchain` to be displayed.
public XrSwapchainSubImage	swapchain(XrSwapchain value) Sets the specified value to the `swapchain` field.
public static void	validate(long the struct to validate struct) Validates pointer members that should not be `NULL`.

Field Detail

ALIGNOF	back to summary
public static final int ALIGNOF The struct alignment in bytes.

IMAGEARRAYINDEX	back to summary
public static final int IMAGEARRAYINDEX The struct member offsets.

IMAGERECT	back to summary
public static final int IMAGERECT The struct member offsets.

SIZEOF	back to summary
public static final int SIZEOF The struct size in bytes.

SWAPCHAIN	back to summary
public static final int SWAPCHAIN The struct member offsets.

Constructor Detail

XrSwapchainSubImage	back to summary
protected XrSwapchainSubImage(long address, ByteBuffer container)

XrSwapchainSubImage back to summary

XrSwapchainSubImage	back to summary
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.

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 Detail

calloc	back to summary
public static XrSwapchainSubImage calloc() Returns a new `XrSwapchainSubImage` instance allocated with `memCalloc`. The instance must be explicitly freed.

calloc back to summary

calloc	back to summary
public static XrSwapchainSubImage.Buffer calloc(int capacity) Returns a new `XrSwapchainSubImage.Buffer` instance allocated with `memCalloc`. The instance must be explicitly freed. Parameters capacity:int the buffer capacity

public static XrSwapchainSubImage.Buffer calloc(int capacity)

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

Parameters

capacity:int: the buffer capacity

calloc back to summary

calloc	back to summary
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:MemoryStack the stack from which to allocate

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:MemoryStack: the stack from which to allocate

calloc back to summary

calloc	back to summary
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:int the buffer capacity stack:MemoryStack the stack from which to allocate

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:int: the buffer capacity
stack:MemoryStack: the stack from which to allocate

create back to summary

create	back to summary
protected XrSwapchainSubImage 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

protected XrSwapchainSubImage 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

create	back to summary
public static XrSwapchainSubImage create() Returns a new `XrSwapchainSubImage` instance allocated with `BufferUtils`.

create	back to summary
public static XrSwapchainSubImage create(long address) Returns a new `XrSwapchainSubImage` instance for the specified memory address.

create back to summary

create	back to summary
public static XrSwapchainSubImage.Buffer create(int capacity) Returns a new `XrSwapchainSubImage.Buffer` instance allocated with `BufferUtils`. Parameters capacity:int the buffer capacity

public static XrSwapchainSubImage.Buffer create(int capacity)

Returns a new XrSwapchainSubImage.Buffer instance allocated with BufferUtils.

Parameters

capacity:int: the buffer capacity

create back to summary

create	back to summary
public static XrSwapchainSubImage.Buffer create(long address, int capacity) Create a `XrSwapchainSubImage.Buffer` instance at the specified memory. Parameters address:long the memory address capacity:int the buffer capacity

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

Create a XrSwapchainSubImage.Buffer instance at the specified memory.

Parameters

address:long: the memory address
capacity:int: the buffer capacity

createSafe back to summary

createSafe	back to summary
public static XrSwapchainSubImage createSafe(long address) Like `create`, but returns `null` if `address` is `NULL`. Annotations @Nullable

public static XrSwapchainSubImage createSafe(long address)

Like create, but returns null if address is NULL.

Annotations

@Nullable

createSafe back to summary

createSafe	back to summary
public static XrSwapchainSubImage.Buffer createSafe(long address, int capacity) Like `create`, but returns `null` if `address` is `NULL`. Annotations @Nullable

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

Like create, but returns null if address is NULL.

Annotations

@Nullable

imageArrayIndex	back to summary
public int imageArrayIndex() the image array index, with 0 meaning the first or only array element. Annotations @NativeType:uint32_t

imageArrayIndex

back to summary

public int imageArrayIndex()

the image array index, with 0 meaning the first or only array element.

Annotations

@NativeType:uint32_t

imageArrayIndex	back to summary
public XrSwapchainSubImage imageArrayIndex(int value) Sets the specified value to the `imageArrayIndex` field.

imageRect back to summary

imageRect	back to summary
public XrRect2Di imageRect() an `XrRect2Di` representing the valid portion of the image to use, in pixels. It also implicitly defines the transform from normalized image coordinates into pixel coordinates. The coordinate origin depends on which graphics API is being used. See the graphics API extension details for more information on the coordinate origin definition. Note that the compositor may bleed in pixels from outside the bounds in some cases, for instance due to mipmapping.

public XrRect2Di imageRect()

an XrRect2Di representing the valid portion of the image to use, in pixels. It also implicitly defines the transform from normalized image coordinates into pixel coordinates. The coordinate origin depends on which graphics API is being used. See the graphics API extension details for more information on the coordinate origin definition. Note that the compositor may bleed in pixels from outside the bounds in some cases, for instance due to mipmapping.

imageRect	back to summary
public XrSwapchainSubImage imageRect(XrRect2Di value) Copies the specified `XrRect2Di` to the `imageRect` field.

imageRect	back to summary
public XrSwapchainSubImage imageRect(Consumer<XrRect2Di> consumer) Passes the `imageRect` field to the specified `Consumer`.

malloc	back to summary
public static XrSwapchainSubImage malloc() Returns a new `XrSwapchainSubImage` instance allocated with `memAlloc`. The instance must be explicitly freed.

malloc back to summary

malloc	back to summary
public static XrSwapchainSubImage.Buffer malloc(int capacity) Returns a new `XrSwapchainSubImage.Buffer` instance allocated with `memAlloc`. The instance must be explicitly freed. Parameters capacity:int the buffer capacity

public static XrSwapchainSubImage.Buffer malloc(int capacity)

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

Parameters

capacity:int: the buffer capacity

malloc back to summary

malloc	back to summary
public static XrSwapchainSubImage malloc(MemoryStack stack) Returns a new `XrSwapchainSubImage` instance allocated on the specified `MemoryStack`. Parameters stack:MemoryStack the stack from which to allocate

public static XrSwapchainSubImage malloc(MemoryStack stack)

Returns a new XrSwapchainSubImage instance allocated on the specified MemoryStack.

Parameters

stack:MemoryStack: the stack from which to allocate

malloc back to summary

malloc	back to summary
public static XrSwapchainSubImage.Buffer malloc(int capacity, MemoryStack stack) Returns a new `XrSwapchainSubImage.Buffer` instance allocated on the specified `MemoryStack`. Parameters capacity:int the buffer capacity stack:MemoryStack the stack from which to allocate

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

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

Parameters

capacity:int: the buffer capacity
stack:MemoryStack: the stack from which to allocate

nimageArrayIndex	back to summary
public static int nimageArrayIndex(long struct) Unsafe version of `imageArrayIndex`.

nimageArrayIndex	back to summary
public static void nimageArrayIndex(long struct, int value) Unsafe version of `imageArrayIndex`.

nimageRect	back to summary
public static XrRect2Di nimageRect(long struct) Unsafe version of `imageRect`.

nimageRect	back to summary
public static void nimageRect(long struct, XrRect2Di value) Unsafe version of `imageRect`.

nswapchain	back to summary
public static long nswapchain(long struct) Unsafe version of `swapchain`.

nswapchain	back to summary
public static void nswapchain(long struct, XrSwapchain value) Unsafe version of `swapchain`.

set	back to summary
public XrSwapchainSubImage set(XrSwapchain swapchain, XrRect2Di imageRect, int imageArrayIndex) Initializes this struct with the specified values.

set	back to summary
public XrSwapchainSubImage set(XrSwapchainSubImage src) Copies the specified struct data to this struct. Parameters src:XrSwapchainSubImage the source struct Returns:XrSwapchainSubImage this struct

set

back to summary

public XrSwapchainSubImage set(XrSwapchainSubImage src)

Copies the specified struct data to this struct.

Parameters

src:XrSwapchainSubImage: the source struct

Returns:XrSwapchainSubImage

this struct

sizeof back to summary

sizeof	back to summary
public int sizeof() Implements abstract org.lwjgl.system.Struct.sizeof. Doc from org.lwjgl.system.Struct.sizeof. Returns `sizeof(struct)`. Annotations @Override

public int sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Doc from org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).

Annotations

@Override

swapchain back to summary

swapchain	back to summary
public long swapchain() the `XrSwapchain` to be displayed. Annotations @NativeType:XrSwapchain

public long swapchain()

the XrSwapchain to be displayed.

Annotations

@NativeType:XrSwapchain

swapchain	back to summary
public XrSwapchainSubImage swapchain(XrSwapchain value) Sets the specified value to the `swapchain` field.

validate back to summary

validate	back to summary
public static void validate(long struct) Validates pointer members that should not be `NULL`. Parameters struct:long the struct to validate

public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters

struct:long: the struct to validate

org.lwjgl.openxr back to summary

public Class XrSwapchainSubImage.Buffer

Class Inheritance

extends StructBuffer<XrSwapchainSubImage, XrSwapchainSubImage.Buffer>
implements NativeResource

java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.CustomBuffer
org.lwjgl.system.StructBuffer
org.lwjgl.openxr.XrSwapchainSubImage.Buffer

All Implemented Interfaces

org.lwjgl.system.NativeResource, java.lang.AutoCloseable

An array of XrSwapchainSubImage structs.

Field Summary

Modifier and Type	Field and Description
private static final XrSwapchainSubImage	ELEMENT_FACTORY

Constructor Summary

Access	Constructor and Description
public	Buffer(ByteBuffer container) Creates a new `XrSwapchainSubImage.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 Type	Method and Description
protected XrSwapchainSubImage	getElementFactory() Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.
public int	Returns: the value of the `XrSwapchainSubImage#imageArrayIndex` field. imageArrayIndex()
public XrSwapchainSubImage.Buffer	imageArrayIndex(int value) Sets the specified value to the `XrSwapchainSubImage#imageArrayIndex` field.
public XrRect2Di	Returns: a `XrRect2Di` view of the `XrSwapchainSubImage#imageRect` field. imageRect()
public XrSwapchainSubImage.Buffer	imageRect(XrRect2Di value) Copies the specified `XrRect2Di` to the `XrSwapchainSubImage#imageRect` field.
public XrSwapchainSubImage.Buffer	imageRect(Consumer<XrRect2Di> consumer) Passes the `XrSwapchainSubImage#imageRect` field to the specified `Consumer`.
protected XrSwapchainSubImage.Buffer	self() Implements abstract org.lwjgl.system.CustomBuffer.self.
public long	Returns: the value of the `XrSwapchainSubImage#swapchain` field. swapchain()
public XrSwapchainSubImage.Buffer	swapchain(XrSwapchain value) Sets the specified value to the `XrSwapchainSubImage#swapchain` field.

Inherited from org.lwjgl.system.StructBuffer:: apply apply forEach get get get get iterator parallelStream put put sizeof spliterator stream

Field Detail

ELEMENT_FACTORY	back to summary
private static final XrSwapchainSubImage ELEMENT_FACTORY

Constructor Detail

Buffer back to summary

Buffer	back to summary
public Buffer(ByteBuffer container) Creates a new `XrSwapchainSubImage.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 `XrSwapchainSubImage#SIZEOF`, and its mark will be undefined. The created buffer instance holds a strong reference to the container object.

public Buffer(ByteBuffer container)

Creates a new XrSwapchainSubImage.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 XrSwapchainSubImage#SIZEOF, and its mark will be undefined.

The created buffer instance holds a strong reference to the container object.

Buffer	back to summary
public Buffer(long address, int cap)

Buffer	back to summary
pack-priv Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Detail

getElementFactory

back to summary

protected XrSwapchainSubImage getElementFactory()

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

Annotations

@Override

imageArrayIndex	back to summary
public int imageArrayIndex() Returns:int the value of the `XrSwapchainSubImage#imageArrayIndex` field. Annotations @NativeType:uint32_t

imageArrayIndex	back to summary
public XrSwapchainSubImage.Buffer imageArrayIndex(int value) Sets the specified value to the `XrSwapchainSubImage#imageArrayIndex` field.

imageRect	back to summary
public XrRect2Di imageRect() Returns:XrRect2Di a `XrRect2Di` view of the `XrSwapchainSubImage#imageRect` field.

imageRect	back to summary
public XrSwapchainSubImage.Buffer imageRect(XrRect2Di value) Copies the specified `XrRect2Di` to the `XrSwapchainSubImage#imageRect` field.

imageRect	back to summary
public XrSwapchainSubImage.Buffer imageRect(Consumer<XrRect2Di> consumer) Passes the `XrSwapchainSubImage#imageRect` field to the specified `Consumer`.

self

back to summary

protected XrSwapchainSubImage.Buffer self()

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

Annotations

@Override

swapchain	back to summary
public long swapchain() Returns:long the value of the `XrSwapchainSubImage#swapchain` field. Annotations @NativeType:XrSwapchain

swapchain	back to summary
public XrSwapchainSubImage.Buffer swapchain(XrSwapchain value) Sets the specified value to the `XrSwapchainSubImage#swapchain` field.

public Class XrSwapchainSubImage

Valid Usage (Implicit)

See Also

Layout

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class XrSwapchainSubImage.Buffer

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail