Class VkBufferCopy2

  • All Implemented Interfaces:
    java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
    Direct Known Subclasses:
    VkBufferCopy2KHR

    public class VkBufferCopy2
    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
    Valid Usage (Implicit)
    See Also

    VkCopyBufferInfo2

    Layout

    
     struct VkBufferCopy2 {
         VkStructureType sType();
         void const * pNext();
         VkDeviceSize srcOffset();
         VkDeviceSize dstOffset();
         VkDeviceSize size();
     }
    • Field Detail

      • SIZEOF

        The struct size in bytes.
      • ALIGNOF

        The struct alignment in bytes.
      • STYPE, PNEXT, SRCOFFSET, DSTOFFSET, SIZE

        The struct member offsets.
    • Constructor Detail

      • VkBufferCopy2

        public VkBufferCopy2​(java.nio.ByteBuffer container)
        Creates a VkBufferCopy2 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

      • sizeof

        public int sizeof()
        Specified by:
        sizeof in class org.lwjgl.system.Struct
      • sType

        public int sType()
        the type of this structure.
      • pNext

        public long pNext()
        NULL or a pointer to a structure extending this structure.
      • srcOffset

        public long srcOffset()
        the starting offset in bytes from the start of srcBuffer.
      • dstOffset

        public long dstOffset()
        the starting offset in bytes from the start of dstBuffer.
      • size

        public long size()
        the number of bytes to copy.
      • size

        public VkBufferCopy2 size​(long value)
        Sets the specified value to the size() field.
      • set

        public VkBufferCopy2 set​(int sType,
                                 long pNext,
                                 long srcOffset,
                                 long dstOffset,
                                 long size)
        Initializes this struct with the specified values.
      • set

        public VkBufferCopy2 set​(VkBufferCopy2 src)
        Copies the specified struct data to this struct.
        Parameters:
        src - the source struct
        Returns:
        this struct
      • malloc

        public static VkBufferCopy2 malloc()
        Returns a new VkBufferCopy2 instance allocated with memAlloc. The instance must be explicitly freed.
      • calloc

        public static VkBufferCopy2 calloc()
        Returns a new VkBufferCopy2 instance allocated with memCalloc. The instance must be explicitly freed.
      • create

        public static VkBufferCopy2 create()
        Returns a new VkBufferCopy2 instance allocated with BufferUtils.
      • create

        public static VkBufferCopy2 create​(long address)
        Returns a new VkBufferCopy2 instance for the specified memory address.
      • createSafe

        @Nullable
        public static VkBufferCopy2 createSafe​(long address)
        Like create, but returns null if address is NULL.
      • malloc

        public static VkBufferCopy2.Buffer malloc​(int capacity)
        Returns a new VkBufferCopy2.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
        Parameters:
        capacity - the buffer capacity
      • calloc

        public static VkBufferCopy2.Buffer calloc​(int capacity)
        Returns a new VkBufferCopy2.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
        Parameters:
        capacity - the buffer capacity
      • create

        public static VkBufferCopy2.Buffer create​(long address,
                                                  int capacity)
        Create a VkBufferCopy2.Buffer instance at the specified memory.
        Parameters:
        address - the memory address
        capacity - the buffer capacity
      • createSafe

        @Nullable
        public static VkBufferCopy2.Buffer createSafe​(long address,
                                                      int capacity)
        Like create, but returns null if address is NULL.
      • malloc

        public static VkBufferCopy2 malloc​(org.lwjgl.system.MemoryStack stack)
        Returns a new VkBufferCopy2 instance allocated on the specified MemoryStack.
        Parameters:
        stack - the stack from which to allocate
      • calloc

        public static VkBufferCopy2 calloc​(org.lwjgl.system.MemoryStack stack)
        Returns a new VkBufferCopy2 instance allocated on the specified MemoryStack and initializes all its bits to zero.
        Parameters:
        stack - the stack from which to allocate
      • malloc

        public static VkBufferCopy2.Buffer malloc​(int capacity,
                                                  org.lwjgl.system.MemoryStack stack)
        Returns a new VkBufferCopy2.Buffer instance allocated on the specified MemoryStack.
        Parameters:
        stack - the stack from which to allocate
        capacity - the buffer capacity
      • calloc

        public static VkBufferCopy2.Buffer calloc​(int capacity,
                                                  org.lwjgl.system.MemoryStack stack)
        Returns a new VkBufferCopy2.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
        Parameters:
        stack - the stack from which to allocate
        capacity - the buffer capacity
      • nsType

        public static int nsType​(long struct)
        Unsafe version of sType().
      • npNext

        public static long npNext​(long struct)
        Unsafe version of pNext().
      • nsrcOffset

        public static long nsrcOffset​(long struct)
        Unsafe version of srcOffset().
      • ndstOffset

        public static long ndstOffset​(long struct)
        Unsafe version of dstOffset().
      • nsize

        public static long nsize​(long struct)
        Unsafe version of size().
      • nsType

        public static void nsType​(long struct,
                                  int value)
        Unsafe version of sType.
      • npNext

        public static void npNext​(long struct,
                                  long value)
        Unsafe version of pNext.
      • nsrcOffset

        public static void nsrcOffset​(long struct,
                                      long value)
        Unsafe version of srcOffset.
      • ndstOffset

        public static void ndstOffset​(long struct,
                                      long value)
        Unsafe version of dstOffset.
      • nsize

        public static void nsize​(long struct,
                                 long value)
        Unsafe version of size.