Class VkCopyDescriptorSet

  • All Implemented Interfaces:
    java.lang.AutoCloseable, NativeResource, Pointer

    public class VkCopyDescriptorSet
    extends Struct
    implements NativeResource
    Structure specifying a copy descriptor set operation.
    Valid Usage
    Valid Usage (Implicit)
    • sType must be STRUCTURE_TYPE_COPY_DESCRIPTOR_SET
    • pNext must be NULL
    • srcSet must be a valid VkDescriptorSet handle
    • dstSet must be a valid VkDescriptorSet handle
    • Both of dstSet, and srcSet must have been created, allocated, or retrieved from the same VkDevice
    See Also

    UpdateDescriptorSets

    Member documentation

    • sType – the type of this structure.
    • pNextNULL or a pointer to an extension-specific structure.
    • srcSetsrcSet, srcBinding, and srcArrayElement are the source set, binding, and array element, respectively. If the descriptor binding identified by srcSet and srcBinding has a descriptor type of DESCRIPTOR_TYPE_INLINE_UNIFORM_BLOCK_EXT then srcArrayElement specifies the starting byte offset within the binding to copy from.
    • srcBinding – see srcSet
    • srcArrayElement – see srcSet
    • dstSetdstSet, dstBinding, and dstArrayElement are the destination set, binding, and array element, respectively. If the descriptor binding identified by dstSet and dstBinding has a descriptor type of DESCRIPTOR_TYPE_INLINE_UNIFORM_BLOCK_EXT then dstArrayElement specifies the starting byte offset within the binding to copy to.
    • dstBinding – see dstSet
    • dstArrayElement – see dstSet
    • descriptorCount – the number of descriptors to copy from the source to destination. If descriptorCount is greater than the number of remaining array elements in the source or destination binding, those affect consecutive bindings in a manner similar to VkWriteDescriptorSet above. If the descriptor binding identified by srcSet and srcBinding has a descriptor type of DESCRIPTOR_TYPE_INLINE_UNIFORM_BLOCK_EXT then descriptorCount specifies the number of bytes to copy and the remaining array elements in the source or destination binding refer to the remaining number of bytes in those.

    Layout

    
     struct VkCopyDescriptorSet {
         VkStructureType sType;
         void const * pNext;
         VkDescriptorSet srcSet;
         uint32_t srcBinding;
         uint32_t srcArrayElement;
         VkDescriptorSet dstSet;
         uint32_t dstBinding;
         uint32_t dstArrayElement;
         uint32_t descriptorCount;
     }
    • Field Detail

      • SIZEOF

        The struct size in bytes.
      • ALIGNOF

        The struct alignment in bytes.
      • STYPE, PNEXT, SRCSET, SRCBINDING, SRCARRAYELEMENT, DSTSET, DSTBINDING, DSTARRAYELEMENT, DESCRIPTORCOUNT

        The struct member offsets.
    • Constructor Detail

      • VkCopyDescriptorSet

        public VkCopyDescriptorSet​(java.nio.ByteBuffer container)
        Creates a VkCopyDescriptorSet 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()
        Description copied from class: Struct
        Returns sizeof(struct).
        Specified by:
        sizeof in class Struct
      • sType

        public int sType()
        Returns the value of the sType field.
      • pNext

        public long pNext()
        Returns the value of the pNext field.
      • srcSet

        public long srcSet()
        Returns the value of the srcSet field.
      • srcBinding

        public int srcBinding()
        Returns the value of the srcBinding field.
      • srcArrayElement

        public int srcArrayElement()
        Returns the value of the srcArrayElement field.
      • dstSet

        public long dstSet()
        Returns the value of the dstSet field.
      • dstBinding

        public int dstBinding()
        Returns the value of the dstBinding field.
      • dstArrayElement

        public int dstArrayElement()
        Returns the value of the dstArrayElement field.
      • descriptorCount

        public int descriptorCount()
        Returns the value of the descriptorCount field.
      • sType

        public VkCopyDescriptorSet sType​(int value)
        Sets the specified value to the sType field.
      • pNext

        public VkCopyDescriptorSet pNext​(long value)
        Sets the specified value to the pNext field.
      • srcSet

        public VkCopyDescriptorSet srcSet​(long value)
        Sets the specified value to the srcSet field.
      • srcBinding

        public VkCopyDescriptorSet srcBinding​(int value)
        Sets the specified value to the srcBinding field.
      • srcArrayElement

        public VkCopyDescriptorSet srcArrayElement​(int value)
        Sets the specified value to the srcArrayElement field.
      • dstSet

        public VkCopyDescriptorSet dstSet​(long value)
        Sets the specified value to the dstSet field.
      • dstBinding

        public VkCopyDescriptorSet dstBinding​(int value)
        Sets the specified value to the dstBinding field.
      • dstArrayElement

        public VkCopyDescriptorSet dstArrayElement​(int value)
        Sets the specified value to the dstArrayElement field.
      • descriptorCount

        public VkCopyDescriptorSet descriptorCount​(int value)
        Sets the specified value to the descriptorCount field.
      • set

        public VkCopyDescriptorSet set​(int sType,
                                       long pNext,
                                       long srcSet,
                                       int srcBinding,
                                       int srcArrayElement,
                                       long dstSet,
                                       int dstBinding,
                                       int dstArrayElement,
                                       int descriptorCount)
        Initializes this struct with the specified values.
      • createSafe

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

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

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

        public static long nsrcSet​(long struct)
        Unsafe version of srcSet().
      • nsrcBinding

        public static int nsrcBinding​(long struct)
        Unsafe version of srcBinding().
      • nsrcArrayElement

        public static int nsrcArrayElement​(long struct)
        Unsafe version of srcArrayElement().
      • ndstSet

        public static long ndstSet​(long struct)
        Unsafe version of dstSet().
      • ndstBinding

        public static int ndstBinding​(long struct)
        Unsafe version of dstBinding().
      • ndstArrayElement

        public static int ndstArrayElement​(long struct)
        Unsafe version of dstArrayElement().
      • ndescriptorCount

        public static int ndescriptorCount​(long struct)
        Unsafe version of descriptorCount().
      • 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.
      • nsrcSet

        public static void nsrcSet​(long struct,
                                   long value)
        Unsafe version of srcSet.
      • nsrcBinding

        public static void nsrcBinding​(long struct,
                                       int value)
        Unsafe version of srcBinding.
      • nsrcArrayElement

        public static void nsrcArrayElement​(long struct,
                                            int value)
        Unsafe version of srcArrayElement.
      • ndstSet

        public static void ndstSet​(long struct,
                                   long value)
        Unsafe version of dstSet.
      • ndstBinding

        public static void ndstBinding​(long struct,
                                       int value)
        Unsafe version of dstBinding.
      • ndstArrayElement

        public static void ndstArrayElement​(long struct,
                                            int value)
        Unsafe version of dstArrayElement.
      • ndescriptorCount

        public static void ndescriptorCount​(long struct,
                                            int value)
        Unsafe version of descriptorCount.