Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkCopyDescriptorSet

extends Struct<VkCopyDescriptorSet>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*

Structure specifying a copy descriptor set operation.
Description

If the VkDescriptorSetLayoutBinding for dstBinding is DESCRIPTOR_TYPE_MUTABLE_EXT and srcBinding is not DESCRIPTOR_TYPE_MUTABLE_EXT, the new active descriptor type becomes the descriptor type of srcBinding. If both VkDescriptorSetLayoutBinding for srcBinding and dstBinding are DESCRIPTOR_TYPE_MUTABLE_EXT, the active descriptor type in each source descriptor is copied into the corresponding destination descriptor. The active descriptor type can be different for each source descriptor.

Note

The intention is that copies to and from mutable descriptors is a simple memcpy. Copies between non-mutable and mutable descriptors are expected to require one memcpy per descriptor to handle the difference in size, but this use case with more than one descriptorCount is considered rare.

Valid Usage
Valid Usage (Implicit)
See Also

UpdateDescriptorSets

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;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
DESCRIPTORCOUNT

The struct member offsets.

public static final int
DSTARRAYELEMENT

The struct member offsets.

public static final int
DSTBINDING

The struct member offsets.

public static final int
DSTSET

The struct member offsets.

public static final int
PNEXT

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
SRCARRAYELEMENT

The struct member offsets.

public static final int
SRCBINDING

The struct member offsets.

public static final int
SRCSET

The struct member offsets.

public static final int
STYPE

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

AccessConstructor and Description
protected
VkCopyDescriptorSet(long address, ByteBuffer container)

public
VkCopyDescriptorSet(ByteBuffer container)

Creates a VkCopyDescriptorSet instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and TypeMethod and Description
public static VkCopyDescriptorSet
calloc()

Returns a new VkCopyDescriptorSet instance allocated with memCalloc.

public static VkCopyDescriptorSet.Buffer
calloc(int
the buffer capacity
capacity
)

Returns a new VkCopyDescriptorSet.Buffer instance allocated with memCalloc.

public static VkCopyDescriptorSet
calloc(MemoryStack
the stack from which to allocate
stack
)

Returns a new VkCopyDescriptorSet instance allocated on the specified MemoryStack and initializes all its bits to zero.

public static VkCopyDescriptorSet.Buffer
calloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

Returns a new VkCopyDescriptorSet.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.

public static VkCopyDescriptorSet
callocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static VkCopyDescriptorSet
callocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static VkCopyDescriptorSet.Buffer
callocStack(int capacity)

Deprecated
Deprecated for removal in 3.4.0.
public static VkCopyDescriptorSet.Buffer
callocStack(int capacity, MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
protected VkCopyDescriptorSet
create(long
the struct memory address
address
,
ByteBuffer
an optional container buffer, to be referenced strongly by the struct instance.
container
)

Implements abstract org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.
public static VkCopyDescriptorSet
create()

Returns a new VkCopyDescriptorSet instance allocated with BufferUtils.

public static VkCopyDescriptorSet
create(long address)

Returns a new VkCopyDescriptorSet instance for the specified memory address.

public static VkCopyDescriptorSet.Buffer
create(int
the buffer capacity
capacity
)

Returns a new VkCopyDescriptorSet.Buffer instance allocated with BufferUtils.

public static VkCopyDescriptorSet.Buffer
create(long
the memory address
address
,
int
the buffer capacity
capacity
)

Create a VkCopyDescriptorSet.Buffer instance at the specified memory.

public static VkCopyDescriptorSet
createSafe(long address)

Like create, but returns null if address is NULL.

public static VkCopyDescriptorSet.Buffer
createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

public int
descriptorCount()

the number of descriptors to copy from the source to destination.

public VkCopyDescriptorSet
descriptorCount(int value)

Sets the specified value to the descriptorCount field.

public int
dstArrayElement()

see dstSet

public VkCopyDescriptorSet
dstArrayElement(int value)

Sets the specified value to the dstArrayElement field.

public int
dstBinding()

see dstSet

public VkCopyDescriptorSet
dstBinding(int value)

Sets the specified value to the dstBinding field.

public long
dstSet()

dstSet, dstBinding, and dstArrayElement are the destination set, binding, and array element, respectively.

public VkCopyDescriptorSet
dstSet(long value)

Sets the specified value to the dstSet field.

public static VkCopyDescriptorSet
malloc()

Returns a new VkCopyDescriptorSet instance allocated with memAlloc.

public static VkCopyDescriptorSet.Buffer
malloc(int
the buffer capacity
capacity
)

Returns a new VkCopyDescriptorSet.Buffer instance allocated with memAlloc.

public static VkCopyDescriptorSet
malloc(MemoryStack
the stack from which to allocate
stack
)

Returns a new VkCopyDescriptorSet instance allocated on the specified MemoryStack.

public static VkCopyDescriptorSet.Buffer
malloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

Returns a new VkCopyDescriptorSet.Buffer instance allocated on the specified MemoryStack.

public static VkCopyDescriptorSet
mallocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static VkCopyDescriptorSet
mallocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static VkCopyDescriptorSet.Buffer
mallocStack(int capacity)

Deprecated
Deprecated for removal in 3.4.0.
public static VkCopyDescriptorSet.Buffer
mallocStack(int capacity, MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static int
ndescriptorCount(long struct)

Unsafe version of descriptorCount.

public static void
ndescriptorCount(long struct, int value)

Unsafe version of descriptorCount.

public static int
ndstArrayElement(long struct)

Unsafe version of dstArrayElement.

public static void
ndstArrayElement(long struct, int value)

Unsafe version of dstArrayElement.

public static int
ndstBinding(long struct)

Unsafe version of dstBinding.

public static void
ndstBinding(long struct, int value)

Unsafe version of dstBinding.

public static long
ndstSet(long struct)

Unsafe version of dstSet.

public static void
ndstSet(long struct, long value)

Unsafe version of dstSet.

public static long
npNext(long struct)

Unsafe version of pNext.

public static void
npNext(long struct, long value)

Unsafe version of pNext.

public static int
nsrcArrayElement(long struct)

Unsafe version of srcArrayElement.

public static void
nsrcArrayElement(long struct, int value)

Unsafe version of srcArrayElement.

public static int
nsrcBinding(long struct)

Unsafe version of srcBinding.

public static void
nsrcBinding(long struct, int value)

Unsafe version of srcBinding.

public static long
nsrcSet(long struct)

Unsafe version of srcSet.

public static void
nsrcSet(long struct, long value)

Unsafe version of srcSet.

public static int
nsType(long struct)

Unsafe version of sType.

public static void
nsType(long struct, int value)

Unsafe version of sType.

public long
pNext()

NULL or a pointer to a structure extending this structure.

public VkCopyDescriptorSet
pNext(long value)

Sets the specified value to the pNext field.

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.

public VkCopyDescriptorSet

Returns:

this struct
set
(VkCopyDescriptorSet
the source struct
src
)

Copies the specified struct data to this struct.

public int
sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).
public int
srcArrayElement()

see srcSet

public VkCopyDescriptorSet
srcArrayElement(int value)

Sets the specified value to the srcArrayElement field.

public int
srcBinding()

see srcSet

public VkCopyDescriptorSet
srcBinding(int value)

Sets the specified value to the srcBinding field.

public long
srcSet()

srcSet, srcBinding, and srcArrayElement are the source set, binding, and array element, respectively.

public VkCopyDescriptorSet
srcSet(long value)

Sets the specified value to the srcSet field.

public int
sType()

a VkStructureType value identifying this structure.

public VkCopyDescriptorSet
sType(int value)

Sets the specified value to the sType field.

public VkCopyDescriptorSet
Inherited from org.lwjgl.system.Struct:
__array__array__array__checkContainer__checkMalloc__create__getContainer__getContainer__member__member__member__padding__padding__struct__struct__union__unionclearfreeisNullvalidate