Package org.lwjgl.vulkan
Class VkBufferCopy
- java.lang.Object
-
- org.lwjgl.system.Pointer.Default
-
- org.lwjgl.system.Struct
-
- org.lwjgl.vulkan.VkBufferCopy
-
- All Implemented Interfaces:
java.lang.AutoCloseable
,org.lwjgl.system.NativeResource
,org.lwjgl.system.Pointer
public class VkBufferCopy extends org.lwjgl.system.Struct implements org.lwjgl.system.NativeResource
Structure specifying a buffer copy operation.Valid Usage
- The
size
must be greater than 0
See Also
Member documentation
srcOffset
– the starting offset in bytes from the start ofsrcBuffer
.dstOffset
– the starting offset in bytes from the start ofdstBuffer
.size
– the number of bytes to copy.
Layout
struct VkBufferCopy { VkDeviceSize srcOffset; VkDeviceSize dstOffset; VkDeviceSize size; }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
VkBufferCopy.Buffer
An array ofVkBufferCopy
structs.
-
Constructor Summary
Constructors Constructor Description VkBufferCopy(java.nio.ByteBuffer container)
Creates aVkBufferCopy
instance at the current position of the specifiedByteBuffer
container.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static VkBufferCopy
calloc()
Returns a newVkBufferCopy
instance allocated withmemCalloc
.static VkBufferCopy.Buffer
calloc(int capacity)
Returns a newVkBufferCopy.Buffer
instance allocated withmemCalloc
.static VkBufferCopy
callocStack()
Returns a newVkBufferCopy
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkBufferCopy.Buffer
callocStack(int capacity)
Returns a newVkBufferCopy.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkBufferCopy.Buffer
callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkBufferCopy.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkBufferCopy
callocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkBufferCopy
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.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
dstOffset()
Returns the value of thedstOffset
field.VkBufferCopy
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
mallocStack()
Returns a newVkBufferCopy
instance allocated on the thread-localMemoryStack
.static VkBufferCopy.Buffer
mallocStack(int capacity)
Returns a newVkBufferCopy.Buffer
instance allocated on the thread-localMemoryStack
.static VkBufferCopy.Buffer
mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkBufferCopy.Buffer
instance allocated on the specifiedMemoryStack
.static VkBufferCopy
mallocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkBufferCopy
instance allocated on the specifiedMemoryStack
.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
.VkBufferCopy
set(long srcOffset, long dstOffset, long size)
Initializes this struct with the specified values.VkBufferCopy
set(VkBufferCopy src)
Copies the specified struct data to this struct.long
size()
Returns the value of thesize
field.VkBufferCopy
size(long value)
Sets the specified value to thesize
field.int
sizeof()
long
srcOffset()
Returns the value of thesrcOffset
field.VkBufferCopy
srcOffset(long value)
Sets the specified value to thesrcOffset
field.
-
-
-
Constructor Detail
-
VkBufferCopy
public VkBufferCopy(java.nio.ByteBuffer container)
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 Detail
-
sizeof
public int sizeof()
- Specified by:
sizeof
in classorg.lwjgl.system.Struct
-
srcOffset
public long srcOffset()
Returns the value of thesrcOffset
field.
-
dstOffset
public long dstOffset()
Returns the value of thedstOffset
field.
-
size
public long size()
Returns the value of thesize
field.
-
srcOffset
public VkBufferCopy srcOffset(long value)
Sets the specified value to thesrcOffset
field.
-
dstOffset
public VkBufferCopy dstOffset(long value)
Sets the specified value to thedstOffset
field.
-
size
public VkBufferCopy size(long value)
Sets the specified value to thesize
field.
-
set
public VkBufferCopy set(long srcOffset, long dstOffset, long size)
Initializes this struct with the specified values.
-
set
public VkBufferCopy set(VkBufferCopy src)
Copies the specified struct data to this struct.- Parameters:
src
- the source struct- Returns:
- this struct
-
malloc
public static VkBufferCopy malloc()
Returns a newVkBufferCopy
instance allocated withmemAlloc
. The instance must be explicitly freed.
-
calloc
public static VkBufferCopy calloc()
Returns a newVkBufferCopy
instance allocated withmemCalloc
. The instance must be explicitly freed.
-
create
public static VkBufferCopy create()
Returns a newVkBufferCopy
instance allocated withBufferUtils
.
-
create
public static VkBufferCopy create(long address)
Returns a newVkBufferCopy
instance for the specified memory address.
-
createSafe
@Nullable public static VkBufferCopy createSafe(long address)
-
malloc
public static VkBufferCopy.Buffer malloc(int capacity)
Returns a newVkBufferCopy.Buffer
instance allocated withmemAlloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
calloc
public static VkBufferCopy.Buffer calloc(int capacity)
Returns a newVkBufferCopy.Buffer
instance allocated withmemCalloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
create
public static VkBufferCopy.Buffer create(int capacity)
Returns a newVkBufferCopy.Buffer
instance allocated withBufferUtils
.- Parameters:
capacity
- the buffer capacity
-
create
public static VkBufferCopy.Buffer create(long address, int capacity)
Create aVkBufferCopy.Buffer
instance at the specified memory.- Parameters:
address
- the memory addresscapacity
- the buffer capacity
-
createSafe
@Nullable public static VkBufferCopy.Buffer createSafe(long address, int capacity)
-
mallocStack
public static VkBufferCopy mallocStack()
Returns a newVkBufferCopy
instance allocated on the thread-localMemoryStack
.
-
callocStack
public static VkBufferCopy callocStack()
Returns a newVkBufferCopy
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.
-
mallocStack
public static VkBufferCopy mallocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkBufferCopy
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocate
-
callocStack
public static VkBufferCopy callocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkBufferCopy
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocate
-
mallocStack
public static VkBufferCopy.Buffer mallocStack(int capacity)
Returns a newVkBufferCopy.Buffer
instance allocated on the thread-localMemoryStack
.- Parameters:
capacity
- the buffer capacity
-
callocStack
public static VkBufferCopy.Buffer callocStack(int capacity)
Returns a newVkBufferCopy.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.- Parameters:
capacity
- the buffer capacity
-
mallocStack
public static VkBufferCopy.Buffer mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkBufferCopy.Buffer
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocatecapacity
- the buffer capacity
-
callocStack
public static VkBufferCopy.Buffer callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkBufferCopy.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocatecapacity
- the buffer capacity
-
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
.
-
-