Package org.lwjgl.vulkan
Class VkCopyDescriptorSet
- java.lang.Object
-
- org.lwjgl.system.Pointer.Default
-
- org.lwjgl.system.Struct
-
- org.lwjgl.vulkan.VkCopyDescriptorSet
-
- All Implemented Interfaces:
- java.lang.AutoCloseable, NativeResource, Pointer
public class VkCopyDescriptorSet extends Struct
Khronos Reference Page
Vulkan SpecificationDescribes descriptor sets to copy between.
Valid Usage
sTypemust beSTRUCTURE_TYPE_COPY_DESCRIPTOR_SETpNextmust beNULLsrcSetmust be a validVkDescriptorSethandledstSetmust be a validVkDescriptorSethandle- Each of
srcSetanddstSetmust have been created, allocated or retrieved from the sameVkDevice srcBindingmust be a valid binding withinsrcSet- The sum of
srcArrayElementanddescriptorCountmust be less than or equal to the number of array elements in the descriptor set binding specified bysrcBinding, and all applicable consecutive bindings dstBindingmust be a valid binding withindstSet- The sum of
dstArrayElementanddescriptorCountmust be less than or equal to the number of array elements in the descriptor set binding specified bydstBinding, and all applicable consecutive bindings - If
srcSetis equal todstSet, then the source and destination ranges of descriptors must not overlap, where the ranges may include array elements from consecutive bindings
Member documentation
sType– the type of this structure. Must be:STRUCTURE_TYPE_COPY_DESCRIPTOR_SETpNext– reserved for use by extensionssrcSet– the source setsrcBinding– the source bindingsrcArrayElement– the source array elementdstSet– the destination setdstBinding– the destination bindingdstArrayElement– the destination array elementdescriptorCount– the number of descriptors to copy from the source to destination. IfdescriptorCountis greater than the number of remaining array elements in the source or destination binding, those affect consecutive bindings in a manner similar toVkWriteDescriptorSet.
Layout
struct VkCopyDescriptorSet { VkStructureType sType; const void * pNext; VkDescriptorSet srcSet; uint32_t srcBinding; uint32_t srcArrayElement; VkDescriptorSet dstSet; uint32_t dstBinding; uint32_t dstArrayElement; uint32_t descriptorCount; }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class and Description static classVkCopyDescriptorSet.BufferAn array ofVkCopyDescriptorSetstructs.-
Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer
Pointer.Default
-
-
Field Summary
Fields Modifier and Type Field and Description static intSIZEOFThe struct size in bytes.-
Fields inherited from interface org.lwjgl.system.Pointer
POINTER_SHIFT, POINTER_SIZE
-
-
Constructor Summary
Constructors Constructor and Description VkCopyDescriptorSet(java.nio.ByteBuffer container)Creates aVkCopyDescriptorSetinstance at the current position of the specifiedByteBuffercontainer.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method and Description static VkCopyDescriptorSetcalloc()Returns a newVkCopyDescriptorSetinstance allocated withmemCalloc.static VkCopyDescriptorSet.Buffercalloc(int capacity)Returns a newVkCopyDescriptorSet.Bufferinstance allocated withmemCalloc.static VkCopyDescriptorSetcallocStack()Returns a newVkCopyDescriptorSetinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.static VkCopyDescriptorSet.BuffercallocStack(int capacity)Returns a newVkCopyDescriptorSet.Bufferinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.static VkCopyDescriptorSet.BuffercallocStack(int capacity, MemoryStack stack)Returns a newVkCopyDescriptorSet.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkCopyDescriptorSetcallocStack(MemoryStack stack)Returns a newVkCopyDescriptorSetinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkCopyDescriptorSetcreate()Returns a newVkCopyDescriptorSetinstance allocated withBufferUtils.static VkCopyDescriptorSet.Buffercreate(int capacity)Returns a newVkCopyDescriptorSet.Bufferinstance allocated withBufferUtils.static VkCopyDescriptorSetcreate(long address)Returns a newVkCopyDescriptorSetinstance for the specified memory address ornullif the address isNULL.static VkCopyDescriptorSet.Buffercreate(long address, int capacity)Create aVkCopyDescriptorSet.Bufferinstance at the specified memory.intdescriptorCount()Returns the value of thedescriptorCountfield.VkCopyDescriptorSetdescriptorCount(int value)Sets the specified value to thedescriptorCountfield.intdstArrayElement()Returns the value of thedstArrayElementfield.VkCopyDescriptorSetdstArrayElement(int value)Sets the specified value to thedstArrayElementfield.intdstBinding()Returns the value of thedstBindingfield.VkCopyDescriptorSetdstBinding(int value)Sets the specified value to thedstBindingfield.longdstSet()Returns the value of thedstSetfield.VkCopyDescriptorSetdstSet(long value)Sets the specified value to thedstSetfield.static VkCopyDescriptorSetmalloc()Returns a newVkCopyDescriptorSetinstance allocated withmemAlloc.static VkCopyDescriptorSet.Buffermalloc(int capacity)Returns a newVkCopyDescriptorSet.Bufferinstance allocated withmemAlloc.static VkCopyDescriptorSetmallocStack()Returns a newVkCopyDescriptorSetinstance allocated on the thread-localMemoryStack.static VkCopyDescriptorSet.BuffermallocStack(int capacity)Returns a newVkCopyDescriptorSet.Bufferinstance allocated on the thread-localMemoryStack.static VkCopyDescriptorSet.BuffermallocStack(int capacity, MemoryStack stack)Returns a newVkCopyDescriptorSet.Bufferinstance allocated on the specifiedMemoryStack.static VkCopyDescriptorSetmallocStack(MemoryStack stack)Returns a newVkCopyDescriptorSetinstance allocated on the specifiedMemoryStack.VkCopyDescriptorSetnset(long struct)Unsafe version ofset.longpNext()Returns the value of thepNextfield.VkCopyDescriptorSetpNext(long value)Sets the specified value to thepNextfield.VkCopyDescriptorSetset(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.VkCopyDescriptorSetset(VkCopyDescriptorSet src)Copies the specified struct data to this struct.intsizeof()Returns thesizeof(struct).intsrcArrayElement()Returns the value of thesrcArrayElementfield.VkCopyDescriptorSetsrcArrayElement(int value)Sets the specified value to thesrcArrayElementfield.intsrcBinding()Returns the value of thesrcBindingfield.VkCopyDescriptorSetsrcBinding(int value)Sets the specified value to thesrcBindingfield.longsrcSet()Returns the value of thesrcSetfield.VkCopyDescriptorSetsrcSet(long value)Sets the specified value to thesrcSetfield.intsType()Returns the value of thesTypefield.VkCopyDescriptorSetsType(int value)Sets the specified value to thesTypefield.-
Methods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toString
-
Methods inherited from interface org.lwjgl.system.NativeResource
close
-
-
-
-
Constructor Detail
-
VkCopyDescriptorSet
public VkCopyDescriptorSet(java.nio.ByteBuffer container)
Creates aVkCopyDescriptorSetinstance at the current position of the specifiedByteBuffercontainer. 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:StructReturns thesizeof(struct).
-
sType
public int sType()
Returns the value of thesTypefield.
-
pNext
public long pNext()
Returns the value of thepNextfield.
-
srcSet
public long srcSet()
Returns the value of thesrcSetfield.
-
srcBinding
public int srcBinding()
Returns the value of thesrcBindingfield.
-
srcArrayElement
public int srcArrayElement()
Returns the value of thesrcArrayElementfield.
-
dstSet
public long dstSet()
Returns the value of thedstSetfield.
-
dstBinding
public int dstBinding()
Returns the value of thedstBindingfield.
-
dstArrayElement
public int dstArrayElement()
Returns the value of thedstArrayElementfield.
-
descriptorCount
public int descriptorCount()
Returns the value of thedescriptorCountfield.
-
sType
public VkCopyDescriptorSet sType(int value)
Sets the specified value to thesTypefield.
-
pNext
public VkCopyDescriptorSet pNext(long value)
Sets the specified value to thepNextfield.
-
srcSet
public VkCopyDescriptorSet srcSet(long value)
Sets the specified value to thesrcSetfield.
-
srcBinding
public VkCopyDescriptorSet srcBinding(int value)
Sets the specified value to thesrcBindingfield.
-
srcArrayElement
public VkCopyDescriptorSet srcArrayElement(int value)
Sets the specified value to thesrcArrayElementfield.
-
dstSet
public VkCopyDescriptorSet dstSet(long value)
Sets the specified value to thedstSetfield.
-
dstBinding
public VkCopyDescriptorSet dstBinding(int value)
Sets the specified value to thedstBindingfield.
-
dstArrayElement
public VkCopyDescriptorSet dstArrayElement(int value)
Sets the specified value to thedstArrayElementfield.
-
descriptorCount
public VkCopyDescriptorSet descriptorCount(int value)
Sets the specified value to thedescriptorCountfield.
-
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.
-
nset
public VkCopyDescriptorSet nset(long struct)
Unsafe version ofset.
-
set
public VkCopyDescriptorSet set(VkCopyDescriptorSet src)
Copies the specified struct data to this struct.- Parameters:
src- the source struct- Returns:
- this struct
-
malloc
public static VkCopyDescriptorSet malloc()
Returns a newVkCopyDescriptorSetinstance allocated withmemAlloc. The instance must be explicitly freed.
-
calloc
public static VkCopyDescriptorSet calloc()
Returns a newVkCopyDescriptorSetinstance allocated withmemCalloc. The instance must be explicitly freed.
-
create
public static VkCopyDescriptorSet create()
Returns a newVkCopyDescriptorSetinstance allocated withBufferUtils.
-
create
public static VkCopyDescriptorSet create(long address)
Returns a newVkCopyDescriptorSetinstance for the specified memory address ornullif the address isNULL.
-
malloc
public static VkCopyDescriptorSet.Buffer malloc(int capacity)
Returns a newVkCopyDescriptorSet.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
public static VkCopyDescriptorSet.Buffer calloc(int capacity)
Returns a newVkCopyDescriptorSet.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
public static VkCopyDescriptorSet.Buffer create(int capacity)
Returns a newVkCopyDescriptorSet.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
public static VkCopyDescriptorSet.Buffer create(long address, int capacity)
Create aVkCopyDescriptorSet.Bufferinstance at the specified memory.- Parameters:
address- the memory addresscapacity- the buffer capacity
-
mallocStack
public static VkCopyDescriptorSet mallocStack()
Returns a newVkCopyDescriptorSetinstance allocated on the thread-localMemoryStack.
-
callocStack
public static VkCopyDescriptorSet callocStack()
Returns a newVkCopyDescriptorSetinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.
-
mallocStack
public static VkCopyDescriptorSet mallocStack(MemoryStack stack)
Returns a newVkCopyDescriptorSetinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
callocStack
public static VkCopyDescriptorSet callocStack(MemoryStack stack)
Returns a newVkCopyDescriptorSetinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocate
-
mallocStack
public static VkCopyDescriptorSet.Buffer mallocStack(int capacity)
Returns a newVkCopyDescriptorSet.Bufferinstance allocated on the thread-localMemoryStack.- Parameters:
capacity- the buffer capacity
-
callocStack
public static VkCopyDescriptorSet.Buffer callocStack(int capacity)
Returns a newVkCopyDescriptorSet.Bufferinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.- Parameters:
capacity- the buffer capacity
-
mallocStack
public static VkCopyDescriptorSet.Buffer mallocStack(int capacity, MemoryStack stack)
Returns a newVkCopyDescriptorSet.Bufferinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocatecapacity- the buffer capacity
-
callocStack
public static VkCopyDescriptorSet.Buffer callocStack(int capacity, MemoryStack stack)
Returns a newVkCopyDescriptorSet.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocatecapacity- the buffer capacity
-
-