Record Class VkCopyDescriptorSet

java.lang.Object

java.lang.Record

club.doki7.vulkan.datatype.VkCopyDescriptorSet

All Implemented Interfaces:

IPointer, IVkCopyDescriptorSet

@ValueBasedCandidate
@UnsafeConstructor
public record VkCopyDescriptorSet(@NotNull MemorySegment segment)
extends Record
implements IVkCopyDescriptorSet

Represents a pointer to a VkCopyDescriptorSet structure in native memory.

Structure

typedef struct VkCopyDescriptorSet {
    VkStructureType sType;
    void const* pNext; // optional
    VkDescriptorSet srcSet;
    uint32_t srcBinding;
    uint32_t srcArrayElement;
    VkDescriptorSet dstSet;
    uint32_t dstBinding;
    uint32_t dstArrayElement;
    uint32_t descriptorCount;
} VkCopyDescriptorSet;

Auto initialization

This structure has the following members that can be automatically initialized:

• sType = VK_STRUCTURE_TYPE_COPY_DESCRIPTOR_SET

The allocate (allocate(Arena), allocate(Arena, long)) functions will automatically initialize these fields. Also, you may call autoInit() to initialize these fields manually for non-allocated instances.

Contracts

The property segment() should always be not-null (segment != NULL && !segment.equals(MemorySegment.NULL)), and properly aligned to LAYOUT.byteAlignment() bytes. To represent null pointer, you may use a Java null instead. See the documentation of IPointer.segment() for more details.

The constructor of this class is marked as UnsafeConstructor, because it does not perform any runtime check. The constructor can be useful for automatic code generators.

See Also:

• VkCopyDescriptorSet

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	VkCopyDescriptorSet.Ptr	Represents a pointer to / an array of VkCopyDescriptorSet structure(s) in native memory.

Field Summary

Fields

Modifier and Type	Field	Description
static final long	BYTES
static final StructLayout	LAYOUT
static final ValueLayout.OfInt	LAYOUT$descriptorCount
static final ValueLayout.OfInt	LAYOUT$dstArrayElement
static final ValueLayout.OfInt	LAYOUT$dstBinding
static final AddressLayout	LAYOUT$dstSet
static final AddressLayout	LAYOUT$pNext
static final ValueLayout.OfInt	LAYOUT$srcArrayElement
static final ValueLayout.OfInt	LAYOUT$srcBinding
static final AddressLayout	LAYOUT$srcSet
static final ValueLayout.OfInt	LAYOUT$sType
static final long	OFFSET$descriptorCount
static final long	OFFSET$dstArrayElement
static final long	OFFSET$dstBinding
static final long	OFFSET$dstSet
static final long	OFFSET$pNext
static final long	OFFSET$srcArrayElement
static final long	OFFSET$srcBinding
static final long	OFFSET$srcSet
static final long	OFFSET$sType
static final MemoryLayout.PathElement	PATH$descriptorCount
static final MemoryLayout.PathElement	PATH$dstArrayElement
static final MemoryLayout.PathElement	PATH$dstBinding
static final MemoryLayout.PathElement	PATH$dstSet
static final MemoryLayout.PathElement	PATH$pNext
static final MemoryLayout.PathElement	PATH$srcArrayElement
static final MemoryLayout.PathElement	PATH$srcBinding
static final MemoryLayout.PathElement	PATH$srcSet
static final MemoryLayout.PathElement	PATH$sType
static final long	SIZE$descriptorCount
static final long	SIZE$dstArrayElement
static final long	SIZE$dstBinding
static final long	SIZE$dstSet
static final long	SIZE$pNext
static final long	SIZE$srcArrayElement
static final long	SIZE$srcBinding
static final long	SIZE$srcSet
static final long	SIZE$sType

Constructor Summary

Constructors

Constructor	Description
VkCopyDescriptorSet(@NotNull MemorySegment segment)	Creates an instance of a VkCopyDescriptorSet record class.

Method Summary

Modifier and Type	Method	Description
static VkCopyDescriptorSet	allocate(Arena arena)
static VkCopyDescriptorSet.Ptr	allocate(Arena arena, long count)
void	autoInit()
static VkCopyDescriptorSet	clone(Arena arena, VkCopyDescriptorSet src)
int	descriptorCount()
VkCopyDescriptorSet	descriptorCount(int value)
int	dstArrayElement()
VkCopyDescriptorSet	dstArrayElement(int value)
int	dstBinding()
VkCopyDescriptorSet	dstBinding(int value)
@Nullable VkDescriptorSet	dstSet()
VkCopyDescriptorSet	dstSet(@Nullable VkDescriptorSet value)
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
MemorySegment	pNext()
VkCopyDescriptorSet	pNext(@Nullable IPointer pointer)
void	pNext(MemorySegment value)
@NotNull MemorySegment	segment()	Returns the value of the segment record component.
int	srcArrayElement()
VkCopyDescriptorSet	srcArrayElement(int value)
int	srcBinding()
VkCopyDescriptorSet	srcBinding(int value)
@Nullable VkDescriptorSet	srcSet()
VkCopyDescriptorSet	srcSet(@Nullable VkDescriptorSet value)
int	sType()
VkCopyDescriptorSet	sType(int value)
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

LAYOUT

public static final StructLayout LAYOUT

BYTES

public static final long BYTES

PATH$sType

public static final MemoryLayout.PathElement PATH$sType

PATH$pNext

public static final MemoryLayout.PathElement PATH$pNext

PATH$srcSet

public static final MemoryLayout.PathElement PATH$srcSet

PATH$srcBinding

public static final MemoryLayout.PathElement PATH$srcBinding

PATH$srcArrayElement

public static final MemoryLayout.PathElement PATH$srcArrayElement

PATH$dstSet

public static final MemoryLayout.PathElement PATH$dstSet

PATH$dstBinding

public static final MemoryLayout.PathElement PATH$dstBinding

PATH$dstArrayElement

public static final MemoryLayout.PathElement PATH$dstArrayElement

PATH$descriptorCount

public static final MemoryLayout.PathElement PATH$descriptorCount

LAYOUT$sType

public static final ValueLayout.OfInt LAYOUT$sType

LAYOUT$pNext

public static final AddressLayout LAYOUT$pNext

LAYOUT$srcSet

public static final AddressLayout LAYOUT$srcSet

LAYOUT$srcBinding

public static final ValueLayout.OfInt LAYOUT$srcBinding

LAYOUT$srcArrayElement

public static final ValueLayout.OfInt LAYOUT$srcArrayElement

LAYOUT$dstSet

public static final AddressLayout LAYOUT$dstSet

LAYOUT$dstBinding

public static final ValueLayout.OfInt LAYOUT$dstBinding

LAYOUT$dstArrayElement

public static final ValueLayout.OfInt LAYOUT$dstArrayElement

LAYOUT$descriptorCount

public static final ValueLayout.OfInt LAYOUT$descriptorCount

SIZE$sType

public static final long SIZE$sType

SIZE$pNext

public static final long SIZE$pNext

SIZE$srcSet

public static final long SIZE$srcSet

SIZE$srcBinding

public static final long SIZE$srcBinding

SIZE$srcArrayElement

public static final long SIZE$srcArrayElement

SIZE$dstSet

public static final long SIZE$dstSet

SIZE$dstBinding

public static final long SIZE$dstBinding

SIZE$dstArrayElement

public static final long SIZE$dstArrayElement

SIZE$descriptorCount

public static final long SIZE$descriptorCount

OFFSET$sType

public static final long OFFSET$sType

OFFSET$pNext

public static final long OFFSET$pNext

OFFSET$srcSet

public static final long OFFSET$srcSet

OFFSET$srcBinding

public static final long OFFSET$srcBinding

OFFSET$srcArrayElement

public static final long OFFSET$srcArrayElement

OFFSET$dstSet

public static final long OFFSET$dstSet

OFFSET$dstBinding

public static final long OFFSET$dstBinding

OFFSET$dstArrayElement

public static final long OFFSET$dstArrayElement

OFFSET$descriptorCount

public static final long OFFSET$descriptorCount

Constructor Details

VkCopyDescriptorSet

public VkCopyDescriptorSet(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a VkCopyDescriptorSet record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static VkCopyDescriptorSet allocate(Arena arena)

allocate

public static VkCopyDescriptorSet.Ptr allocate(Arena arena,
 long count)

clone

public static VkCopyDescriptorSet clone(Arena arena,
 VkCopyDescriptorSet src)

autoInit

public void autoInit()

sType

@EnumType(VkStructureType.class)
public int sType()

sType

public VkCopyDescriptorSet sType(@EnumType(VkStructureType.class)
 int value)

pNext

@Pointer(comment="void*")
public MemorySegment pNext()

pNext

public void pNext(@Pointer(comment="void*")
 MemorySegment value)

pNext

public VkCopyDescriptorSet pNext(@Nullable
 @Nullable IPointer pointer)

srcSet

@Nullable
public @Nullable VkDescriptorSet srcSet()

srcSet

public VkCopyDescriptorSet srcSet(@Nullable
 @Nullable VkDescriptorSet value)

srcBinding

@Unsigned
public int srcBinding()

srcBinding

public VkCopyDescriptorSet srcBinding(@Unsigned
 int value)

srcArrayElement

@Unsigned
public int srcArrayElement()

srcArrayElement

public VkCopyDescriptorSet srcArrayElement(@Unsigned
 int value)

dstSet

@Nullable
public @Nullable VkDescriptorSet dstSet()

dstSet

public VkCopyDescriptorSet dstSet(@Nullable
 @Nullable VkDescriptorSet value)

dstBinding

@Unsigned
public int dstBinding()

dstBinding

public VkCopyDescriptorSet dstBinding(@Unsigned
 int value)

dstArrayElement

@Unsigned
public int dstArrayElement()

dstArrayElement

public VkCopyDescriptorSet dstArrayElement(@Unsigned
 int value)

descriptorCount

@Unsigned
public int descriptorCount()

descriptorCount

public VkCopyDescriptorSet descriptorCount(@Unsigned
 int value)

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

segment

@NotNull
public @NotNull MemorySegment segment()

Returns the value of the segment record component.

Specified by:

segment in interface IPointer

Returns:

the value of the segment record component