Package org.lwjgl.vulkan
Class VkBufferCopy
- All Implemented Interfaces:
AutoCloseable
,NativeResource
,Pointer
Structure specifying a buffer copy operation.
Valid Usage
- The
size
must be greater than 0
See Also
Layout
struct VkBufferCopy {
VkDeviceSize srcOffset()
;
VkDeviceSize dstOffset()
;
VkDeviceSize size()
;
}
-
Nested Class Summary
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
Modifier and TypeFieldDescriptionstatic final int
The struct alignment in bytes.static final int
The struct member offsets.static final int
The struct member offsets.static final int
The struct size in bytes.static final int
The struct member offsets.Fields inherited from interface org.lwjgl.system.Pointer
BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE
-
Constructor Summary
ConstructorDescriptionVkBufferCopy
(ByteBuffer container) Creates aVkBufferCopy
instance at the current position of the specifiedByteBuffer
container. -
Method Summary
Modifier and TypeMethodDescriptionstatic VkBufferCopy
calloc()
Returns a newVkBufferCopy
instance allocated withmemCalloc
.static VkBufferCopy.Buffer
calloc
(int capacity) Returns a newVkBufferCopy.Buffer
instance allocated withmemCalloc
.static VkBufferCopy.Buffer
calloc
(int capacity, MemoryStack stack) Returns a newVkBufferCopy.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkBufferCopy
calloc
(MemoryStack stack) Returns a newVkBufferCopy
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkBufferCopy
Deprecated.static VkBufferCopy.Buffer
callocStack
(int capacity) Deprecated.static VkBufferCopy.Buffer
callocStack
(int capacity, MemoryStack stack) Deprecated.static VkBufferCopy
callocStack
(MemoryStack stack) Deprecated.static VkBufferCopy
create()
Returns a newVkBufferCopy
instance allocated withBufferUtils
.static VkBufferCopy.Buffer
create
(int capacity) Returns a newVkBufferCopy.Buffer
instance allocated withBufferUtils
.static VkBufferCopy
create
(long address) Returns a newVkBufferCopy
instance for the specified memory address.static VkBufferCopy.Buffer
create
(long address, int capacity) Create aVkBufferCopy.Buffer
instance at the specified memory.static VkBufferCopy
createSafe
(long address) static VkBufferCopy.Buffer
createSafe
(long address, int capacity) long
the starting offset in bytes from the start ofdstBuffer
.dstOffset
(long value) Sets the specified value to thedstOffset()
field.static VkBufferCopy
malloc()
Returns a newVkBufferCopy
instance allocated withmemAlloc
.static VkBufferCopy.Buffer
malloc
(int capacity) Returns a newVkBufferCopy.Buffer
instance allocated withmemAlloc
.static VkBufferCopy.Buffer
malloc
(int capacity, MemoryStack stack) Returns a newVkBufferCopy.Buffer
instance allocated on the specifiedMemoryStack
.static VkBufferCopy
malloc
(MemoryStack stack) Returns a newVkBufferCopy
instance allocated on the specifiedMemoryStack
.static VkBufferCopy
Deprecated.static VkBufferCopy.Buffer
mallocStack
(int capacity) Deprecated.static VkBufferCopy.Buffer
mallocStack
(int capacity, MemoryStack stack) Deprecated.static VkBufferCopy
mallocStack
(MemoryStack stack) Deprecated.static long
ndstOffset
(long struct) Unsafe version ofdstOffset()
.static void
ndstOffset
(long struct, long value) Unsafe version ofdstOffset
.static long
nsize
(long struct) Unsafe version ofsize()
.static void
nsize
(long struct, long value) Unsafe version ofsize
.static long
nsrcOffset
(long struct) Unsafe version ofsrcOffset()
.static void
nsrcOffset
(long struct, long value) Unsafe version ofsrcOffset
.set
(long srcOffset, long dstOffset, long size) Initializes this struct with the specified values.set
(VkBufferCopy src) Copies the specified struct data to this struct.long
size()
the number of bytes to copy.size
(long value) Sets the specified value to thesize()
field.int
sizeof()
Returnssizeof(struct)
.long
the starting offset in bytes from the start ofsrcBuffer
.srcOffset
(long value) Sets the specified value to thesrcOffset()
field.Methods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toString
Methods inherited from interface org.lwjgl.system.NativeResource
close, free
-
Field Details
-
SIZEOF
public static final int SIZEOFThe struct size in bytes. -
ALIGNOF
public static final int ALIGNOFThe struct alignment in bytes. -
SRCOFFSET
public static final int SRCOFFSETThe struct member offsets. -
DSTOFFSET
public static final int DSTOFFSETThe struct member offsets. -
SIZE
public static final int SIZEThe struct member offsets.
-
-
Constructor Details
-
VkBufferCopy
Creates aVkBufferCopy
instance at the current position of the specifiedByteBuffer
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
Returnssizeof(struct)
.- Specified by:
sizeof
in classStruct<VkBufferCopy>
-
srcOffset
public long srcOffset()the starting offset in bytes from the start ofsrcBuffer
. -
dstOffset
public long dstOffset()the starting offset in bytes from the start ofdstBuffer
. -
size
public long size()the number of bytes to copy. -
srcOffset
Sets the specified value to thesrcOffset()
field. -
dstOffset
Sets the specified value to thedstOffset()
field. -
size
Sets the specified value to thesize()
field. -
set
Initializes this struct with the specified values. -
set
Copies the specified struct data to this struct.- Parameters:
src
- the source struct- Returns:
- this struct
-
malloc
Returns a newVkBufferCopy
instance allocated withmemAlloc
. The instance must be explicitly freed. -
calloc
Returns a newVkBufferCopy
instance allocated withmemCalloc
. The instance must be explicitly freed. -
create
Returns a newVkBufferCopy
instance allocated withBufferUtils
. -
create
Returns a newVkBufferCopy
instance for the specified memory address. -
createSafe
-
malloc
Returns a newVkBufferCopy.Buffer
instance allocated withmemAlloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
calloc
Returns a newVkBufferCopy.Buffer
instance allocated withmemCalloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
create
Returns a newVkBufferCopy.Buffer
instance allocated withBufferUtils
.- Parameters:
capacity
- the buffer capacity
-
create
Create aVkBufferCopy.Buffer
instance at the specified memory.- Parameters:
address
- the memory addresscapacity
- the buffer capacity
-
createSafe
-
mallocStack
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(MemoryStack)
instead. -
callocStack
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(MemoryStack)
instead. -
mallocStack
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(MemoryStack)
instead. -
callocStack
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(MemoryStack)
instead. -
mallocStack
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(int, MemoryStack)
instead. -
callocStack
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(int, MemoryStack)
instead. -
mallocStack
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(int, MemoryStack)
instead. -
callocStack
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(int, MemoryStack)
instead. -
malloc
Returns a newVkBufferCopy
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocate
-
calloc
Returns a newVkBufferCopy
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocate
-
malloc
Returns a newVkBufferCopy.Buffer
instance allocated on the specifiedMemoryStack
.- Parameters:
capacity
- the buffer capacitystack
- the stack from which to allocate
-
calloc
Returns a newVkBufferCopy.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
capacity
- the buffer capacitystack
- the stack from which to allocate
-
nsrcOffset
public static long nsrcOffset(long struct) Unsafe version ofsrcOffset()
. -
ndstOffset
public static long ndstOffset(long struct) Unsafe version ofdstOffset()
. -
nsize
public static long nsize(long struct) Unsafe version ofsize()
. -
nsrcOffset
public static void nsrcOffset(long struct, long value) Unsafe version ofsrcOffset
. -
ndstOffset
public static void ndstOffset(long struct, long value) Unsafe version ofdstOffset
. -
nsize
public static void nsize(long struct, long value) Unsafe version ofsize
.
-