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

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

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

Method Summary

Modifier and Type	Method and Description
public static VkBufferCopy	calloc() Returns a new `VkBufferCopy` instance allocated with `memCalloc`.
public static VkBufferCopy.Buffer	calloc(int the buffer capacity capacity) Returns a new `VkBufferCopy.Buffer` instance allocated with `memCalloc`.
public static VkBufferCopy	calloc(MemoryStack the stack from which to allocate stack) Returns a new `VkBufferCopy` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
public static VkBufferCopy.Buffer	calloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `VkBufferCopy.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
public static VkBufferCopy	callocStack() Deprecated Deprecated for removal in 3.4.0.
public static VkBufferCopy	callocStack(MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
public static VkBufferCopy.Buffer	callocStack(int capacity) Deprecated Deprecated for removal in 3.4.0.
public static VkBufferCopy.Buffer	callocStack(int capacity, MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
protected VkBufferCopy	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 VkBufferCopy	create() Returns a new `VkBufferCopy` instance allocated with `BufferUtils`.
public static VkBufferCopy	create(long address) Returns a new `VkBufferCopy` instance for the specified memory address.
public static VkBufferCopy.Buffer	create(int the buffer capacity capacity) Returns a new `VkBufferCopy.Buffer` instance allocated with `BufferUtils`.
public static VkBufferCopy.Buffer	create(long the memory address address, int the buffer capacity capacity) Create a `VkBufferCopy.Buffer` instance at the specified memory.
public static VkBufferCopy	createSafe(long address) Like `create`, but returns `null` if `address` is `NULL`.
public static VkBufferCopy.Buffer	createSafe(long address, int capacity) Like `create`, but returns `null` if `address` is `NULL`.
public long	dstOffset() the starting offset in bytes from the start of `dstBuffer`.
public VkBufferCopy	dstOffset(long value) Sets the specified value to the `dstOffset` field.
public static VkBufferCopy	malloc() Returns a new `VkBufferCopy` instance allocated with `memAlloc`.
public static VkBufferCopy.Buffer	malloc(int the buffer capacity capacity) Returns a new `VkBufferCopy.Buffer` instance allocated with `memAlloc`.
public static VkBufferCopy	malloc(MemoryStack the stack from which to allocate stack) Returns a new `VkBufferCopy` instance allocated on the specified `MemoryStack`.
public static VkBufferCopy.Buffer	malloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `VkBufferCopy.Buffer` instance allocated on the specified `MemoryStack`.
public static VkBufferCopy	mallocStack() Deprecated Deprecated for removal in 3.4.0.
public static VkBufferCopy	mallocStack(MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
public static VkBufferCopy.Buffer	mallocStack(int capacity) Deprecated Deprecated for removal in 3.4.0.
public static VkBufferCopy.Buffer	mallocStack(int capacity, MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
public static long	ndstOffset(long struct) Unsafe version of `dstOffset`.
public static void	ndstOffset(long struct, long value) Unsafe version of `dstOffset`.
public static long	nsize(long struct) Unsafe version of `size`.
public static void	nsize(long struct, long value) Unsafe version of `size`.
public static long	nsrcOffset(long struct) Unsafe version of `srcOffset`.
public static void	nsrcOffset(long struct, long value) Unsafe version of `srcOffset`.
public VkBufferCopy	set(long srcOffset, long dstOffset, long size) Initializes this struct with the specified values.
public VkBufferCopy	Returns: this struct set(VkBufferCopy the source struct src) Copies the specified struct data to this struct.
public long	size() the number of bytes to copy.
public VkBufferCopy	size(long value) Sets the specified value to the `size` field.
public int	sizeof() Implements abstract org.lwjgl.system.Struct.sizeof. Returns `sizeof(struct)`.
public long	srcOffset() the starting offset in bytes from the start of `srcBuffer`.
public VkBufferCopy	srcOffset(long value) Sets the specified value to the `srcOffset` field.

Field Detail

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

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

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

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

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

Constructor Detail

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

VkBufferCopy back to summary

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

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

calloc back to summary

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

public static VkBufferCopy.Buffer calloc(int capacity)

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

public static VkBufferCopy calloc(MemoryStack stack)

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

Returns a new VkBufferCopy.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 VkBufferCopy callocStack() Deprecated Deprecated for removal in 3.4.0. Use `calloc(MemoryStack)` instead. Annotations @Deprecated

public static VkBufferCopy 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 VkBufferCopy callocStack(MemoryStack stack) Deprecated Deprecated for removal in 3.4.0. Use `calloc(MemoryStack)` instead. Annotations @Deprecated

public static VkBufferCopy 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 VkBufferCopy.Buffer callocStack(int capacity) Deprecated Deprecated for removal in 3.4.0. Use `calloc(int, MemoryStack)` instead. Annotations @Deprecated

public static VkBufferCopy.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 VkBufferCopy.Buffer callocStack(int capacity, MemoryStack stack) Deprecated Deprecated for removal in 3.4.0. Use `calloc(int, MemoryStack)` instead. Annotations @Deprecated

public static VkBufferCopy.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 VkBufferCopy 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 VkBufferCopy 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 VkBufferCopy create() Returns a new `VkBufferCopy` instance allocated with `BufferUtils`.

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

create back to summary

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

public static VkBufferCopy.Buffer create(int capacity)

Returns a new VkBufferCopy.Buffer instance allocated with BufferUtils.

Parameters

capacity:int: the buffer capacity

create back to summary

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

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

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

public static VkBufferCopy createSafe(long address)

Like create, but returns null if address is NULL.

Annotations

@Nullable

createSafe back to summary

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

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

Like create, but returns null if address is NULL.

Annotations

@Nullable

dstOffset back to summary

dstOffset	back to summary
public long dstOffset() the starting offset in bytes from the start of `dstBuffer`. Annotations @NativeType:VkDeviceSize

public long dstOffset()

the starting offset in bytes from the start of dstBuffer.

Annotations

@NativeType:VkDeviceSize

dstOffset	back to summary
public VkBufferCopy dstOffset(long value) Sets the specified value to the `dstOffset` field.

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

malloc back to summary

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

public static VkBufferCopy.Buffer malloc(int capacity)

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

public static VkBufferCopy malloc(MemoryStack stack)

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

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

Returns a new VkBufferCopy.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 VkBufferCopy mallocStack() Deprecated Deprecated for removal in 3.4.0. Use `malloc(MemoryStack)` instead. Annotations @Deprecated

public static VkBufferCopy 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 VkBufferCopy mallocStack(MemoryStack stack) Deprecated Deprecated for removal in 3.4.0. Use `malloc(MemoryStack)` instead. Annotations @Deprecated

public static VkBufferCopy 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 VkBufferCopy.Buffer mallocStack(int capacity) Deprecated Deprecated for removal in 3.4.0. Use `malloc(int, MemoryStack)` instead. Annotations @Deprecated

public static VkBufferCopy.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 VkBufferCopy.Buffer mallocStack(int capacity, MemoryStack stack) Deprecated Deprecated for removal in 3.4.0. Use `malloc(int, MemoryStack)` instead. Annotations @Deprecated

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

Deprecated

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

Annotations

@Deprecated

ndstOffset	back to summary
public static long ndstOffset(long struct) Unsafe version of `dstOffset`.

ndstOffset	back to summary
public static void ndstOffset(long struct, long value) Unsafe version of `dstOffset`.

nsize	back to summary
public static long nsize(long struct) Unsafe version of `size`.

nsize	back to summary
public static void nsize(long struct, long value) Unsafe version of `size`.

nsrcOffset	back to summary
public static long nsrcOffset(long struct) Unsafe version of `srcOffset`.

nsrcOffset	back to summary
public static void nsrcOffset(long struct, long value) Unsafe version of `srcOffset`.

set	back to summary
public VkBufferCopy set(long srcOffset, long dstOffset, long size) Initializes this struct with the specified values.

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

set

back to summary

public VkBufferCopy set(VkBufferCopy src)

Copies the specified struct data to this struct.

Parameters

src:VkBufferCopy: the source struct

Returns:VkBufferCopy

this struct

size	back to summary
public long size() the number of bytes to copy. Annotations @NativeType:VkDeviceSize

size

back to summary

public long size()

the number of bytes to copy.

Annotations

@NativeType:VkDeviceSize

size	back to summary
public VkBufferCopy size(long value) Sets the specified value to the `size` field.

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

srcOffset back to summary

srcOffset	back to summary
public long srcOffset() the starting offset in bytes from the start of `srcBuffer`. Annotations @NativeType:VkDeviceSize

public long srcOffset()

the starting offset in bytes from the start of srcBuffer.

Annotations

@NativeType:VkDeviceSize

srcOffset	back to summary
public VkBufferCopy srcOffset(long value) Sets the specified value to the `srcOffset` field.

org.lwjgl.vulkan back to summary

public Class VkBufferCopy.Buffer

Class Inheritance

extends StructBuffer<VkBufferCopy, VkBufferCopy.Buffer>
implements NativeResource

All Implemented Interfaces

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

An array of VkBufferCopy structs.

Field Summary

Modifier and Type	Field and Description
private static final VkBufferCopy	ELEMENT_FACTORY

Constructor Summary

Access	Constructor and Description
public	Buffer(ByteBuffer container) Creates a new `VkBufferCopy.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
public long	Returns: the value of the `VkBufferCopy#dstOffset` field. dstOffset()
public VkBufferCopy.Buffer	dstOffset(long value) Sets the specified value to the `VkBufferCopy#dstOffset` field.
protected VkBufferCopy	getElementFactory() Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.
protected VkBufferCopy.Buffer	self() Implements abstract org.lwjgl.system.CustomBuffer.self.
public long	Returns: the value of the `VkBufferCopy#size` field. size()
public VkBufferCopy.Buffer	size(long value) Sets the specified value to the `VkBufferCopy#size` field.
public long	Returns: the value of the `VkBufferCopy#srcOffset` field. srcOffset()
public VkBufferCopy.Buffer	srcOffset(long value) Sets the specified value to the `VkBufferCopy#srcOffset` 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 VkBufferCopy ELEMENT_FACTORY

Constructor Detail

Buffer back to summary

public Buffer(ByteBuffer container)

Creates a new VkBufferCopy.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 VkBufferCopy#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

dstOffset	back to summary
public long dstOffset() Returns:long the value of the `VkBufferCopy#dstOffset` field. Annotations @NativeType:VkDeviceSize

dstOffset	back to summary
public VkBufferCopy.Buffer dstOffset(long value) Sets the specified value to the `VkBufferCopy#dstOffset` field.

getElementFactory

back to summary

protected VkBufferCopy getElementFactory()

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

Annotations

@Override

self

back to summary

protected VkBufferCopy.Buffer self()

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

Annotations

@Override

size	back to summary
public long size() Returns:long the value of the `VkBufferCopy#size` field. Annotations @NativeType:VkDeviceSize

size	back to summary
public VkBufferCopy.Buffer size(long value) Sets the specified value to the `VkBufferCopy#size` field.

srcOffset	back to summary
public long srcOffset() Returns:long the value of the `VkBufferCopy#srcOffset` field. Annotations @NativeType:VkDeviceSize

srcOffset	back to summary
public VkBufferCopy.Buffer srcOffset(long value) Sets the specified value to the `VkBufferCopy#srcOffset` field.

public Class VkBufferCopy

Valid Usage

See Also

Layout

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class VkBufferCopy.Buffer

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail