Top Description Inners Fields Constructors Methods
org.lwjgl.openxr

public Class XrVulkanSwapchainFormatListCreateInfoKHR

extends Struct<XrVulkanSwapchainFormatListCreateInfoKHR>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*, org.lwjgl.vulkan.*

A list of Vulkan view formats.
Valid Usage (Implicit)
See Also

CreateSwapchain

Layout


struct XrVulkanSwapchainFormatListCreateInfoKHR {
    XrStructureType type;
    void const * next;
    uint32_t viewFormatCount;
    VkFormat const * viewFormats;
}

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
TYPE

The struct member offsets.

public static final int
VIEWFORMATCOUNT

The struct member offsets.

public static final int
VIEWFORMATS

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

AccessConstructor and Description
protected
public
XrVulkanSwapchainFormatListCreateInfoKHR(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static XrVulkanSwapchainFormatListCreateInfoKHR
calloc()

Returns a new XrVulkanSwapchainFormatListCreateInfoKHR instance allocated with memCalloc.

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

Returns a new XrVulkanSwapchainFormatListCreateInfoKHR.Buffer instance allocated with memCalloc.

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

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

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

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

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

Returns a new XrVulkanSwapchainFormatListCreateInfoKHR instance allocated with BufferUtils.

public static XrVulkanSwapchainFormatListCreateInfoKHR
create(long address)

Returns a new XrVulkanSwapchainFormatListCreateInfoKHR instance for the specified memory address.

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

Returns a new XrVulkanSwapchainFormatListCreateInfoKHR.Buffer instance allocated with BufferUtils.

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

Create a XrVulkanSwapchainFormatListCreateInfoKHR.Buffer instance at the specified memory.

public static XrVulkanSwapchainFormatListCreateInfoKHR
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public static XrVulkanSwapchainFormatListCreateInfoKHR
malloc()

Returns a new XrVulkanSwapchainFormatListCreateInfoKHR instance allocated with memAlloc.

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

Returns a new XrVulkanSwapchainFormatListCreateInfoKHR.Buffer instance allocated with memAlloc.

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

Returns a new XrVulkanSwapchainFormatListCreateInfoKHR instance allocated on the specified MemoryStack.

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

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

public long
next()

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

public XrVulkanSwapchainFormatListCreateInfoKHR
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 int
ntype(long struct)

Unsafe version of type.

public static void
ntype(long struct, int value)

Unsafe version of type.

public static int
nviewFormatCount(long struct)

Unsafe version of viewFormatCount.

public static void
nviewFormatCount(long struct, int value)

Sets the specified value to the viewFormatCount field of the specified struct.

public static IntBuffer
nviewFormats(long struct)

Unsafe version of viewFormats.

public static void
nviewFormats(long struct, IntBuffer value)

Unsafe version of viewFormats.

public XrVulkanSwapchainFormatListCreateInfoKHR
set(int type, long next, IntBuffer viewFormats)

Initializes this struct with the specified values.

public XrVulkanSwapchainFormatListCreateInfoKHR

Returns:

this struct
set
(XrVulkanSwapchainFormatListCreateInfoKHR
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 int
type()

the XrStructureType of this structure.

public XrVulkanSwapchainFormatListCreateInfoKHR
type(int value)

Sets the specified value to the type field.

public XrVulkanSwapchainFormatListCreateInfoKHR
public static void
validate(long
the struct to validate
struct
)

Validates pointer members that should not be NULL.

public int
viewFormatCount()

the number of view formats passed in viewFormats.

public IntBuffer
viewFormats()

an array of VkFormat.

public XrVulkanSwapchainFormatListCreateInfoKHR
viewFormats(IntBuffer value)

Sets the address of the specified IntBuffer to the viewFormats 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.

TYPEback to summary
public static final int TYPE

The struct member offsets.

VIEWFORMATCOUNTback to summary
public static final int VIEWFORMATCOUNT

The struct member offsets.

VIEWFORMATSback to summary
public static final int VIEWFORMATS

The struct member offsets.

Constructor Detail

XrVulkanSwapchainFormatListCreateInfoKHRback to summary
protected XrVulkanSwapchainFormatListCreateInfoKHR(long address, ByteBuffer container)
XrVulkanSwapchainFormatListCreateInfoKHRback to summary
public XrVulkanSwapchainFormatListCreateInfoKHR(ByteBuffer container)

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

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static XrVulkanSwapchainFormatListCreateInfoKHR calloc(MemoryStack stack)

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

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

Returns a new XrVulkanSwapchainFormatListCreateInfoKHR instance allocated with BufferUtils.

createback to summary
public static XrVulkanSwapchainFormatListCreateInfoKHR create(long address)

Returns a new XrVulkanSwapchainFormatListCreateInfoKHR instance for the specified memory address.

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

Returns a new XrVulkanSwapchainFormatListCreateInfoKHR.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a XrVulkanSwapchainFormatListCreateInfoKHR.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static XrVulkanSwapchainFormatListCreateInfoKHR createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

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

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static XrVulkanSwapchainFormatListCreateInfoKHR malloc(MemoryStack stack)

Returns a new XrVulkanSwapchainFormatListCreateInfoKHR instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

Returns a new XrVulkanSwapchainFormatListCreateInfoKHR.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 or this extension.

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

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.

nviewFormatCountback to summary
public static int nviewFormatCount(long struct)

Unsafe version of viewFormatCount.

nviewFormatCountback to summary
public static void nviewFormatCount(long struct, int value)

Sets the specified value to the viewFormatCount field of the specified struct.

nviewFormatsback to summary
public static IntBuffer nviewFormats(long struct)

Unsafe version of viewFormats.

Annotations
@Nullable
nviewFormatsback to summary
public static void nviewFormats(long struct, IntBuffer value)

Unsafe version of viewFormats.

setback to summary
public XrVulkanSwapchainFormatListCreateInfoKHR set(int type, long next, IntBuffer viewFormats)

Initializes this struct with the specified values.

setback to summary
public XrVulkanSwapchainFormatListCreateInfoKHR set(XrVulkanSwapchainFormatListCreateInfoKHR src)

Copies the specified struct data to this struct.

Parameters
src:XrVulkanSwapchainFormatListCreateInfoKHR

the source struct

Returns:XrVulkanSwapchainFormatListCreateInfoKHR

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
typeback to summary
public int type()

the XrStructureType of this structure.

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

Sets the specified value to the type field.

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

Sets the TYPE_VULKAN_SWAPCHAIN_FORMAT_LIST_CREATE_INFO_KHR value to the type field.

validateback to summary
public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters
struct:long

the struct to validate

viewFormatCountback to summary
public int viewFormatCount()

the number of view formats passed in viewFormats.

Annotations
@NativeType:uint32_t
viewFormatsback to summary
public IntBuffer viewFormats()

an array of VkFormat.

Annotations
@Nullable
@NativeType:VkFormat const *
viewFormatsback to summary
public XrVulkanSwapchainFormatListCreateInfoKHR viewFormats(IntBuffer value)

Sets the address of the specified IntBuffer to the viewFormats field.

org.lwjgl.openxr back to summary

public Class XrVulkanSwapchainFormatListCreateInfoKHR.Buffer

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

An array of XrVulkanSwapchainFormatListCreateInfoKHR structs.

Field Summary

Modifier and TypeField and Description
private static final XrVulkanSwapchainFormatListCreateInfoKHR

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

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

Returns:

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

public XrVulkanSwapchainFormatListCreateInfoKHR.Buffer
next(long value)

Sets the specified value to the XrVulkanSwapchainFormatListCreateInfoKHR#next field.

protected XrVulkanSwapchainFormatListCreateInfoKHR.Buffer
public int

Returns:

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

public XrVulkanSwapchainFormatListCreateInfoKHR.Buffer
type(int value)

Sets the specified value to the XrVulkanSwapchainFormatListCreateInfoKHR#type field.

public XrVulkanSwapchainFormatListCreateInfoKHR.Buffer
public int
public IntBuffer

Returns:

a IntBuffer view of the data pointed to by the XrVulkanSwapchainFormatListCreateInfoKHR#viewFormats field.
viewFormats
()

public XrVulkanSwapchainFormatListCreateInfoKHR.Buffer
viewFormats(IntBuffer value)

Sets the address of the specified IntBuffer to the XrVulkanSwapchainFormatListCreateInfoKHR#viewFormats field.

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final XrVulkanSwapchainFormatListCreateInfoKHR ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

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

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

the value of the XrVulkanSwapchainFormatListCreateInfoKHR#next field.

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

Sets the specified value to the XrVulkanSwapchainFormatListCreateInfoKHR#next field.

selfback to summary
protected XrVulkanSwapchainFormatListCreateInfoKHR.Buffer self()

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

Annotations
@Override
typeback to summary
public int type()
Returns:int

the value of the XrVulkanSwapchainFormatListCreateInfoKHR#type field.

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

Sets the specified value to the XrVulkanSwapchainFormatListCreateInfoKHR#type field.

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

Sets the TYPE_VULKAN_SWAPCHAIN_FORMAT_LIST_CREATE_INFO_KHR value to the XrVulkanSwapchainFormatListCreateInfoKHR#type field.

viewFormatCountback to summary
public int viewFormatCount()
Returns:int

the value of the XrVulkanSwapchainFormatListCreateInfoKHR#viewFormatCount field.

Annotations
@NativeType:uint32_t
viewFormatsback to summary
public IntBuffer viewFormats()
Returns:IntBuffer

a IntBuffer view of the data pointed to by the XrVulkanSwapchainFormatListCreateInfoKHR#viewFormats field.

Annotations
@Nullable
@NativeType:VkFormat const *
viewFormatsback to summary
public XrVulkanSwapchainFormatListCreateInfoKHR.Buffer viewFormats(IntBuffer value)

Sets the address of the specified IntBuffer to the XrVulkanSwapchainFormatListCreateInfoKHR#viewFormats field.