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

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

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

Method Summary

Modifier and Type	Method and Description
public static VkBaseInStructure	calloc() Returns a new `VkBaseInStructure` instance allocated with `memCalloc`.
public static VkBaseInStructure.Buffer	calloc(int the buffer capacity capacity) Returns a new `VkBaseInStructure.Buffer` instance allocated with `memCalloc`.
public static VkBaseInStructure	calloc(MemoryStack the stack from which to allocate stack) Returns a new `VkBaseInStructure` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
public static VkBaseInStructure.Buffer	calloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `VkBaseInStructure.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
public static VkBaseInStructure	callocStack() Deprecated Deprecated for removal in 3.4.0.
public static VkBaseInStructure	callocStack(MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
public static VkBaseInStructure.Buffer	callocStack(int capacity) Deprecated Deprecated for removal in 3.4.0.
public static VkBaseInStructure.Buffer	callocStack(int capacity, MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
protected VkBaseInStructure	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 VkBaseInStructure	create() Returns a new `VkBaseInStructure` instance allocated with `BufferUtils`.
public static VkBaseInStructure	create(long address) Returns a new `VkBaseInStructure` instance for the specified memory address.
public static VkBaseInStructure.Buffer	create(int the buffer capacity capacity) Returns a new `VkBaseInStructure.Buffer` instance allocated with `BufferUtils`.
public static VkBaseInStructure.Buffer	create(long the memory address address, int the buffer capacity capacity) Create a `VkBaseInStructure.Buffer` instance at the specified memory.
public static VkBaseInStructure	createSafe(long address) Like `create`, but returns `null` if `address` is `NULL`.
public static VkBaseInStructure.Buffer	createSafe(long address, int capacity) Like `create`, but returns `null` if `address` is `NULL`.
public static VkBaseInStructure	malloc() Returns a new `VkBaseInStructure` instance allocated with `memAlloc`.
public static VkBaseInStructure.Buffer	malloc(int the buffer capacity capacity) Returns a new `VkBaseInStructure.Buffer` instance allocated with `memAlloc`.
public static VkBaseInStructure	malloc(MemoryStack the stack from which to allocate stack) Returns a new `VkBaseInStructure` instance allocated on the specified `MemoryStack`.
public static VkBaseInStructure.Buffer	malloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `VkBaseInStructure.Buffer` instance allocated on the specified `MemoryStack`.
public static VkBaseInStructure	mallocStack() Deprecated Deprecated for removal in 3.4.0.
public static VkBaseInStructure	mallocStack(MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
public static VkBaseInStructure.Buffer	mallocStack(int capacity) Deprecated Deprecated for removal in 3.4.0.
public static VkBaseInStructure.Buffer	mallocStack(int capacity, MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
public static VkBaseInStructure	npNext(long struct) Unsafe version of `pNext`.
public static void	npNext(long struct, VkBaseInStructure value) Unsafe version of `pNext`.
public static int	nsType(long struct) Unsafe version of `sType`.
public static void	nsType(long struct, int value) Unsafe version of `sType`.
public VkBaseInStructure	pNext() `NULL` or a pointer to the next structure in a structure chain.
public VkBaseInStructure	pNext(VkBaseInStructure value) Sets the address of the specified `VkBaseInStructure` to the `pNext` field.
public VkBaseInStructure	set(int sType, VkBaseInStructure pNext) Initializes this struct with the specified values.
public VkBaseInStructure	Returns: this struct set(VkBaseInStructure 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	sType() the structure type of the structure being iterated through.
public VkBaseInStructure	sType(int value) Sets the specified value to the `sType` field.

Field Detail

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

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

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

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

Constructor Detail

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

VkBaseInStructure back to summary

VkBaseInStructure	back to summary
public VkBaseInStructure(ByteBuffer container) Creates a `VkBaseInStructure` 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 VkBaseInStructure(ByteBuffer container)

Creates a VkBaseInStructure 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 VkBaseInStructure calloc() Returns a new `VkBaseInStructure` instance allocated with `memCalloc`. The instance must be explicitly freed.

calloc back to summary

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

public static VkBaseInStructure.Buffer calloc(int capacity)

Returns a new VkBaseInStructure.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 VkBaseInStructure calloc(MemoryStack stack) Returns a new `VkBaseInStructure` instance allocated on the specified `MemoryStack` and initializes all its bits to zero. Parameters stack:MemoryStack the stack from which to allocate

public static VkBaseInStructure calloc(MemoryStack stack)

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

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

callocStack back to summary

callocStack	back to summary
public static VkBaseInStructure callocStack() Deprecated Deprecated for removal in 3.4.0. Use `calloc(MemoryStack)` instead. Annotations @Deprecated

public static VkBaseInStructure callocStack()

Deprecated

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

Annotations

@Deprecated

callocStack back to summary

callocStack	back to summary
public static VkBaseInStructure callocStack(MemoryStack stack) Deprecated Deprecated for removal in 3.4.0. Use `calloc(MemoryStack)` instead. Annotations @Deprecated

public static VkBaseInStructure callocStack(MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

Annotations

@Deprecated

callocStack back to summary

callocStack	back to summary
public static VkBaseInStructure.Buffer callocStack(int capacity) Deprecated Deprecated for removal in 3.4.0. Use `calloc(int, MemoryStack)` instead. Annotations @Deprecated

public static VkBaseInStructure.Buffer callocStack(int capacity)

Deprecated

Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

Annotations

@Deprecated

callocStack back to summary

callocStack	back to summary
public static VkBaseInStructure.Buffer callocStack(int capacity, MemoryStack stack) Deprecated Deprecated for removal in 3.4.0. Use `calloc(int, MemoryStack)` instead. Annotations @Deprecated

public static VkBaseInStructure.Buffer callocStack(int capacity, MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

Annotations

@Deprecated

create back to summary

create	back to summary
protected VkBaseInStructure 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 VkBaseInStructure 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 VkBaseInStructure create() Returns a new `VkBaseInStructure` instance allocated with `BufferUtils`.

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

create back to summary

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

public static VkBaseInStructure.Buffer create(int capacity)

Returns a new VkBaseInStructure.Buffer instance allocated with BufferUtils.

Parameters

capacity:int: the buffer capacity

create back to summary

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

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

Create a VkBaseInStructure.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 VkBaseInStructure createSafe(long address) Like `create`, but returns `null` if `address` is `NULL`. Annotations @Nullable

public static VkBaseInStructure createSafe(long address)

Like create, but returns null if address is NULL.

Annotations

@Nullable

createSafe back to summary

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

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

Like create, but returns null if address is NULL.

Annotations

@Nullable

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

malloc back to summary

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

public static VkBaseInStructure.Buffer malloc(int capacity)

Returns a new VkBaseInStructure.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 VkBaseInStructure malloc(MemoryStack stack) Returns a new `VkBaseInStructure` instance allocated on the specified `MemoryStack`. Parameters stack:MemoryStack the stack from which to allocate

public static VkBaseInStructure malloc(MemoryStack stack)

Returns a new VkBaseInStructure 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 VkBaseInStructure.Buffer malloc(int capacity, MemoryStack stack) Returns a new `VkBaseInStructure.Buffer` instance allocated on the specified `MemoryStack`. Parameters capacity:int the buffer capacity stack:MemoryStack the stack from which to allocate

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

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

Parameters

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

mallocStack back to summary

mallocStack	back to summary
public static VkBaseInStructure mallocStack() Deprecated Deprecated for removal in 3.4.0. Use `malloc(MemoryStack)` instead. Annotations @Deprecated

public static VkBaseInStructure mallocStack()

Deprecated

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

Annotations

@Deprecated

mallocStack back to summary

mallocStack	back to summary
public static VkBaseInStructure mallocStack(MemoryStack stack) Deprecated Deprecated for removal in 3.4.0. Use `malloc(MemoryStack)` instead. Annotations @Deprecated

public static VkBaseInStructure mallocStack(MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

Annotations

@Deprecated

mallocStack back to summary

mallocStack	back to summary
public static VkBaseInStructure.Buffer mallocStack(int capacity) Deprecated Deprecated for removal in 3.4.0. Use `malloc(int, MemoryStack)` instead. Annotations @Deprecated

public static VkBaseInStructure.Buffer mallocStack(int capacity)

Deprecated

Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

Annotations

@Deprecated

mallocStack back to summary

mallocStack	back to summary
public static VkBaseInStructure.Buffer mallocStack(int capacity, MemoryStack stack) Deprecated Deprecated for removal in 3.4.0. Use `malloc(int, MemoryStack)` instead. Annotations @Deprecated

public static VkBaseInStructure.Buffer mallocStack(int capacity, MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

Annotations

@Deprecated

npNext back to summary

npNext	back to summary
public static VkBaseInStructure npNext(long struct) Unsafe version of `pNext`. Annotations @Nullable

public static VkBaseInStructure npNext(long struct)

Unsafe version of pNext.

Annotations

@Nullable

npNext	back to summary
public static void npNext(long struct, VkBaseInStructure value) Unsafe version of `pNext`.

nsType	back to summary
public static int nsType(long struct) Unsafe version of `sType`.

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

pNext back to summary

pNext	back to summary
public VkBaseInStructure pNext() `NULL` or a pointer to the next structure in a structure chain. Annotations @Nullable @NativeType:VkBaseInStructure const *

public VkBaseInStructure pNext()

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

Annotations

@Nullable
@NativeType:VkBaseInStructure const *

pNext	back to summary
public VkBaseInStructure pNext(VkBaseInStructure value) Sets the address of the specified `VkBaseInStructure` to the `pNext` field.

set	back to summary
public VkBaseInStructure set(int sType, VkBaseInStructure pNext) Initializes this struct with the specified values.

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

set

back to summary

public VkBaseInStructure set(VkBaseInStructure src)

Copies the specified struct data to this struct.

Parameters

src:VkBaseInStructure: the source struct

Returns:VkBaseInStructure

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

sType	back to summary
public int sType() the structure type of the structure being iterated through. Annotations @NativeType:VkStructureType

sType

back to summary

public int sType()

the structure type of the structure being iterated through.

Annotations

@NativeType:VkStructureType

sType	back to summary
public VkBaseInStructure sType(int value) Sets the specified value to the `sType` field.

org.lwjgl.vulkan back to summary

public Class VkBaseInStructure.Buffer

Class Inheritance

extends StructBuffer<VkBaseInStructure, VkBaseInStructure.Buffer>
implements NativeResource

java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.CustomBuffer
org.lwjgl.system.StructBuffer
org.lwjgl.vulkan.VkBaseInStructure.Buffer

All Implemented Interfaces

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

An array of VkBaseInStructure structs.

Field Summary

Modifier and Type	Field and Description
private static final VkBaseInStructure	ELEMENT_FACTORY

Constructor Summary

Access	Constructor and Description
public	Buffer(ByteBuffer container) Creates a new `VkBaseInStructure.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 VkBaseInStructure	getElementFactory() Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.
public VkBaseInStructure	Returns: a `VkBaseInStructure` view of the struct pointed to by the `VkBaseInStructure#pNext` field. pNext()
public VkBaseInStructure.Buffer	pNext(VkBaseInStructure value) Sets the address of the specified `VkBaseInStructure` to the `VkBaseInStructure#pNext` field.
protected VkBaseInStructure.Buffer	self() Implements abstract org.lwjgl.system.CustomBuffer.self.
public int	Returns: the value of the `VkBaseInStructure#sType` field. sType()
public VkBaseInStructure.Buffer	sType(int value) Sets the specified value to the `VkBaseInStructure#sType` 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 VkBaseInStructure ELEMENT_FACTORY

Constructor Detail

Buffer back to summary

Buffer	back to summary
public Buffer(ByteBuffer container) Creates a new `VkBaseInStructure.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 `VkBaseInStructure#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 VkBaseInStructure.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 VkBaseInStructure#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 VkBaseInStructure getElementFactory()

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

Annotations

@Override

pNext	back to summary
public VkBaseInStructure pNext() Returns:VkBaseInStructure a `VkBaseInStructure` view of the struct pointed to by the `VkBaseInStructure#pNext` field. Annotations @Nullable @NativeType:VkBaseInStructure const *

pNext	back to summary
public VkBaseInStructure.Buffer pNext(VkBaseInStructure value) Sets the address of the specified `VkBaseInStructure` to the `VkBaseInStructure#pNext` field.

self

back to summary

protected VkBaseInStructure.Buffer self()

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

Annotations

@Override

sType	back to summary
public int sType() Returns:int the value of the `VkBaseInStructure#sType` field. Annotations @NativeType:VkStructureType

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

public Class VkBaseInStructure

Description

See Also

Layout

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class VkBaseInStructure.Buffer

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail