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
sType
must beSTRUCTURE_TYPE_COPY_DESCRIPTOR_SET
pNext
must beNULL
srcSet
must be a validVkDescriptorSet
handledstSet
must be a validVkDescriptorSet
handle- Each of
srcSet
anddstSet
must have been created, allocated or retrieved from the sameVkDevice
srcBinding
must be a valid binding withinsrcSet
- The sum of
srcArrayElement
anddescriptorCount
must be less than or equal to the number of array elements in the descriptor set binding specified bysrcBinding
, and all applicable consecutive bindings dstBinding
must be a valid binding withindstSet
- The sum of
dstArrayElement
anddescriptorCount
must be less than or equal to the number of array elements in the descriptor set binding specified bydstBinding
, and all applicable consecutive bindings - If
srcSet
is 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_SET
pNext
– 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. IfdescriptorCount
is 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 class
VkCopyDescriptorSet.Buffer
An array ofVkCopyDescriptorSet
structs.-
Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer
Pointer.Default
-
-
Field Summary
Fields Modifier and Type Field and Description static int
SIZEOF
The 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 aVkCopyDescriptorSet
instance at the current position of the specifiedByteBuffer
container.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method and Description static VkCopyDescriptorSet
calloc()
Returns a newVkCopyDescriptorSet
instance allocated withmemCalloc
.static VkCopyDescriptorSet.Buffer
calloc(int capacity)
Returns a newVkCopyDescriptorSet.Buffer
instance allocated withmemCalloc
.static VkCopyDescriptorSet
callocStack()
Returns a newVkCopyDescriptorSet
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkCopyDescriptorSet.Buffer
callocStack(int capacity)
Returns a newVkCopyDescriptorSet.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkCopyDescriptorSet.Buffer
callocStack(int capacity, MemoryStack stack)
Returns a newVkCopyDescriptorSet.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkCopyDescriptorSet
callocStack(MemoryStack stack)
Returns a newVkCopyDescriptorSet
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkCopyDescriptorSet
create()
Returns a newVkCopyDescriptorSet
instance allocated withBufferUtils
.static VkCopyDescriptorSet.Buffer
create(int capacity)
Returns a newVkCopyDescriptorSet.Buffer
instance allocated withBufferUtils
.static VkCopyDescriptorSet
create(long address)
Returns a newVkCopyDescriptorSet
instance for the specified memory address ornull
if the address isNULL
.static VkCopyDescriptorSet.Buffer
create(long address, int capacity)
Create aVkCopyDescriptorSet.Buffer
instance at the specified memory.int
descriptorCount()
Returns the value of thedescriptorCount
field.VkCopyDescriptorSet
descriptorCount(int value)
Sets the specified value to thedescriptorCount
field.int
dstArrayElement()
Returns the value of thedstArrayElement
field.VkCopyDescriptorSet
dstArrayElement(int value)
Sets the specified value to thedstArrayElement
field.int
dstBinding()
Returns the value of thedstBinding
field.VkCopyDescriptorSet
dstBinding(int value)
Sets the specified value to thedstBinding
field.long
dstSet()
Returns the value of thedstSet
field.VkCopyDescriptorSet
dstSet(long value)
Sets the specified value to thedstSet
field.static VkCopyDescriptorSet
malloc()
Returns a newVkCopyDescriptorSet
instance allocated withmemAlloc
.static VkCopyDescriptorSet.Buffer
malloc(int capacity)
Returns a newVkCopyDescriptorSet.Buffer
instance allocated withmemAlloc
.static VkCopyDescriptorSet
mallocStack()
Returns a newVkCopyDescriptorSet
instance allocated on the thread-localMemoryStack
.static VkCopyDescriptorSet.Buffer
mallocStack(int capacity)
Returns a newVkCopyDescriptorSet.Buffer
instance allocated on the thread-localMemoryStack
.static VkCopyDescriptorSet.Buffer
mallocStack(int capacity, MemoryStack stack)
Returns a newVkCopyDescriptorSet.Buffer
instance allocated on the specifiedMemoryStack
.static VkCopyDescriptorSet
mallocStack(MemoryStack stack)
Returns a newVkCopyDescriptorSet
instance allocated on the specifiedMemoryStack
.VkCopyDescriptorSet
nset(long struct)
Unsafe version ofset
.long
pNext()
Returns the value of thepNext
field.VkCopyDescriptorSet
pNext(long value)
Sets the specified value to thepNext
field.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.VkCopyDescriptorSet
set(VkCopyDescriptorSet src)
Copies the specified struct data to this struct.int
sizeof()
Returns thesizeof(struct)
.int
srcArrayElement()
Returns the value of thesrcArrayElement
field.VkCopyDescriptorSet
srcArrayElement(int value)
Sets the specified value to thesrcArrayElement
field.int
srcBinding()
Returns the value of thesrcBinding
field.VkCopyDescriptorSet
srcBinding(int value)
Sets the specified value to thesrcBinding
field.long
srcSet()
Returns the value of thesrcSet
field.VkCopyDescriptorSet
srcSet(long value)
Sets the specified value to thesrcSet
field.int
sType()
Returns the value of thesType
field.VkCopyDescriptorSet
sType(int value)
Sets the specified value to thesType
field.-
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 aVkCopyDescriptorSet
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()
Description copied from class:Struct
Returns thesizeof(struct)
.
-
sType
public int sType()
Returns the value of thesType
field.
-
pNext
public long pNext()
Returns the value of thepNext
field.
-
srcSet
public long srcSet()
Returns the value of thesrcSet
field.
-
srcBinding
public int srcBinding()
Returns the value of thesrcBinding
field.
-
srcArrayElement
public int srcArrayElement()
Returns the value of thesrcArrayElement
field.
-
dstSet
public long dstSet()
Returns the value of thedstSet
field.
-
dstBinding
public int dstBinding()
Returns the value of thedstBinding
field.
-
dstArrayElement
public int dstArrayElement()
Returns the value of thedstArrayElement
field.
-
descriptorCount
public int descriptorCount()
Returns the value of thedescriptorCount
field.
-
sType
public VkCopyDescriptorSet sType(int value)
Sets the specified value to thesType
field.
-
pNext
public VkCopyDescriptorSet pNext(long value)
Sets the specified value to thepNext
field.
-
srcSet
public VkCopyDescriptorSet srcSet(long value)
Sets the specified value to thesrcSet
field.
-
srcBinding
public VkCopyDescriptorSet srcBinding(int value)
Sets the specified value to thesrcBinding
field.
-
srcArrayElement
public VkCopyDescriptorSet srcArrayElement(int value)
Sets the specified value to thesrcArrayElement
field.
-
dstSet
public VkCopyDescriptorSet dstSet(long value)
Sets the specified value to thedstSet
field.
-
dstBinding
public VkCopyDescriptorSet dstBinding(int value)
Sets the specified value to thedstBinding
field.
-
dstArrayElement
public VkCopyDescriptorSet dstArrayElement(int value)
Sets the specified value to thedstArrayElement
field.
-
descriptorCount
public VkCopyDescriptorSet descriptorCount(int value)
Sets the specified value to thedescriptorCount
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.
-
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 newVkCopyDescriptorSet
instance allocated withmemAlloc
. The instance must be explicitly freed.
-
calloc
public static VkCopyDescriptorSet calloc()
Returns a newVkCopyDescriptorSet
instance allocated withmemCalloc
. The instance must be explicitly freed.
-
create
public static VkCopyDescriptorSet create()
Returns a newVkCopyDescriptorSet
instance allocated withBufferUtils
.
-
create
public static VkCopyDescriptorSet create(long address)
Returns a newVkCopyDescriptorSet
instance for the specified memory address ornull
if the address isNULL
.
-
malloc
public static VkCopyDescriptorSet.Buffer malloc(int capacity)
Returns a newVkCopyDescriptorSet.Buffer
instance allocated withmemAlloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
calloc
public static VkCopyDescriptorSet.Buffer calloc(int capacity)
Returns a newVkCopyDescriptorSet.Buffer
instance allocated withmemCalloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
create
public static VkCopyDescriptorSet.Buffer create(int capacity)
Returns a newVkCopyDescriptorSet.Buffer
instance allocated withBufferUtils
.- Parameters:
capacity
- the buffer capacity
-
create
public static VkCopyDescriptorSet.Buffer create(long address, int capacity)
Create aVkCopyDescriptorSet.Buffer
instance at the specified memory.- Parameters:
address
- the memory addresscapacity
- the buffer capacity
-
mallocStack
public static VkCopyDescriptorSet mallocStack()
Returns a newVkCopyDescriptorSet
instance allocated on the thread-localMemoryStack
.
-
callocStack
public static VkCopyDescriptorSet callocStack()
Returns a newVkCopyDescriptorSet
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.
-
mallocStack
public static VkCopyDescriptorSet mallocStack(MemoryStack stack)
Returns a newVkCopyDescriptorSet
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocate
-
callocStack
public static VkCopyDescriptorSet callocStack(MemoryStack stack)
Returns a newVkCopyDescriptorSet
instance allocated on the specifiedMemoryStack
and 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.Buffer
instance allocated on the thread-localMemoryStack
.- Parameters:
capacity
- the buffer capacity
-
callocStack
public static VkCopyDescriptorSet.Buffer callocStack(int capacity)
Returns a newVkCopyDescriptorSet.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.- Parameters:
capacity
- the buffer capacity
-
mallocStack
public static VkCopyDescriptorSet.Buffer mallocStack(int capacity, MemoryStack stack)
Returns a newVkCopyDescriptorSet.Buffer
instance 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.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocatecapacity
- the buffer capacity
-
-