Record Class VkDescriptorUpdateTemplateEntry

java.lang.Object

java.lang.Record

club.doki7.vulkan.datatype.VkDescriptorUpdateTemplateEntry

All Implemented Interfaces:

IPointer, IVkDescriptorUpdateTemplateEntry

@ValueBasedCandidate
@UnsafeConstructor
public record VkDescriptorUpdateTemplateEntry(@NotNull MemorySegment segment)
extends Record
implements IVkDescriptorUpdateTemplateEntry

Represents a pointer to a VkDescriptorUpdateTemplateEntry structure in native memory.

Structure

typedef struct VkDescriptorUpdateTemplateEntry {
    uint32_t dstBinding;
    uint32_t dstArrayElement;
    uint32_t descriptorCount;
    VkDescriptorType descriptorType;
    size_t offset;
    size_t stride;
} VkDescriptorUpdateTemplateEntry;

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:

• VkDescriptorUpdateTemplateEntry

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	VkDescriptorUpdateTemplateEntry.Ptr	Represents a pointer to / an array of VkDescriptorUpdateTemplateEntry 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$descriptorType
static final ValueLayout.OfInt	LAYOUT$dstArrayElement
static final ValueLayout.OfInt	LAYOUT$dstBinding
static final long	OFFSET$descriptorCount
static final long	OFFSET$descriptorType
static final long	OFFSET$dstArrayElement
static final long	OFFSET$dstBinding
static final long	OFFSET$offset
static final long	OFFSET$stride
static final MemoryLayout.PathElement	PATH$descriptorCount
static final MemoryLayout.PathElement	PATH$descriptorType
static final MemoryLayout.PathElement	PATH$dstArrayElement
static final MemoryLayout.PathElement	PATH$dstBinding
static final MemoryLayout.PathElement	PATH$offset
static final MemoryLayout.PathElement	PATH$stride
static final long	SIZE$descriptorCount
static final long	SIZE$descriptorType
static final long	SIZE$dstArrayElement
static final long	SIZE$dstBinding
static final long	SIZE$offset
static final long	SIZE$stride

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static VkDescriptorUpdateTemplateEntry	allocate(Arena arena)
static VkDescriptorUpdateTemplateEntry.Ptr	allocate(Arena arena, long count)
static VkDescriptorUpdateTemplateEntry	clone(Arena arena, VkDescriptorUpdateTemplateEntry src)
int	descriptorCount()
VkDescriptorUpdateTemplateEntry	descriptorCount(int value)
int	descriptorType()
VkDescriptorUpdateTemplateEntry	descriptorType(int value)
int	dstArrayElement()
VkDescriptorUpdateTemplateEntry	dstArrayElement(int value)
int	dstBinding()
VkDescriptorUpdateTemplateEntry	dstBinding(int 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.
long	offset()
VkDescriptorUpdateTemplateEntry	offset(long value)
@NotNull MemorySegment	segment()	Returns the value of the segment record component.
long	stride()
VkDescriptorUpdateTemplateEntry	stride(long 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$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

PATH$descriptorType

public static final MemoryLayout.PathElement PATH$descriptorType

PATH$offset

public static final MemoryLayout.PathElement PATH$offset

PATH$stride

public static final MemoryLayout.PathElement PATH$stride

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

LAYOUT$descriptorType

public static final ValueLayout.OfInt LAYOUT$descriptorType

SIZE$dstBinding

public static final long SIZE$dstBinding

SIZE$dstArrayElement

public static final long SIZE$dstArrayElement

SIZE$descriptorCount

public static final long SIZE$descriptorCount

SIZE$descriptorType

public static final long SIZE$descriptorType

SIZE$offset

public static final long SIZE$offset

SIZE$stride

public static final long SIZE$stride

OFFSET$dstBinding

public static final long OFFSET$dstBinding

OFFSET$dstArrayElement

public static final long OFFSET$dstArrayElement

OFFSET$descriptorCount

public static final long OFFSET$descriptorCount

OFFSET$descriptorType

public static final long OFFSET$descriptorType

OFFSET$offset

public static final long OFFSET$offset

OFFSET$stride

public static final long OFFSET$stride

Constructor Details

VkDescriptorUpdateTemplateEntry

public VkDescriptorUpdateTemplateEntry(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a VkDescriptorUpdateTemplateEntry record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static VkDescriptorUpdateTemplateEntry allocate(Arena arena)

allocate

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

clone

public static VkDescriptorUpdateTemplateEntry clone(Arena arena,
 VkDescriptorUpdateTemplateEntry src)

dstBinding

@Unsigned
public int dstBinding()

dstBinding

public VkDescriptorUpdateTemplateEntry dstBinding(@Unsigned
 int value)

dstArrayElement

@Unsigned
public int dstArrayElement()

dstArrayElement

public VkDescriptorUpdateTemplateEntry dstArrayElement(@Unsigned
 int value)

descriptorCount

@Unsigned
public int descriptorCount()

descriptorCount

public VkDescriptorUpdateTemplateEntry descriptorCount(@Unsigned
 int value)

descriptorType

@EnumType(VkDescriptorType.class)
public int descriptorType()

descriptorType

public VkDescriptorUpdateTemplateEntry descriptorType(@EnumType(VkDescriptorType.class)
 int value)

offset

@Unsigned
public long offset()

offset

public VkDescriptorUpdateTemplateEntry offset(@Unsigned
 long value)

stride

@Unsigned
public long stride()

stride

public VkDescriptorUpdateTemplateEntry stride(@Unsigned
 long 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