Record Class VkDeviceGroupBindSparseInfo

java.lang.Object

java.lang.Record

club.doki7.vulkan.datatype.VkDeviceGroupBindSparseInfo

All Implemented Interfaces:

IPointer, IVkDeviceGroupBindSparseInfo

@ValueBasedCandidate
@UnsafeConstructor
public record VkDeviceGroupBindSparseInfo(@NotNull MemorySegment segment)
extends Record
implements IVkDeviceGroupBindSparseInfo

Represents a pointer to a VkDeviceGroupBindSparseInfo structure in native memory.

Structure

typedef struct VkDeviceGroupBindSparseInfo {
    VkStructureType sType;
    void const* pNext; // optional
    uint32_t resourceDeviceIndex;
    uint32_t memoryDeviceIndex;
} VkDeviceGroupBindSparseInfo;

Auto initialization

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

• sType = VK_STRUCTURE_TYPE_DEVICE_GROUP_BIND_SPARSE_INFO

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:

• VkDeviceGroupBindSparseInfo

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	VkDeviceGroupBindSparseInfo.Ptr	Represents a pointer to / an array of VkDeviceGroupBindSparseInfo 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$memoryDeviceIndex
static final AddressLayout	LAYOUT$pNext
static final ValueLayout.OfInt	LAYOUT$resourceDeviceIndex
static final ValueLayout.OfInt	LAYOUT$sType
static final long	OFFSET$memoryDeviceIndex
static final long	OFFSET$pNext
static final long	OFFSET$resourceDeviceIndex
static final long	OFFSET$sType
static final MemoryLayout.PathElement	PATH$memoryDeviceIndex
static final MemoryLayout.PathElement	PATH$pNext
static final MemoryLayout.PathElement	PATH$resourceDeviceIndex
static final MemoryLayout.PathElement	PATH$sType
static final long	SIZE$memoryDeviceIndex
static final long	SIZE$pNext
static final long	SIZE$resourceDeviceIndex
static final long	SIZE$sType

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static VkDeviceGroupBindSparseInfo	allocate(Arena arena)
static VkDeviceGroupBindSparseInfo.Ptr	allocate(Arena arena, long count)
void	autoInit()
static VkDeviceGroupBindSparseInfo	clone(Arena arena, VkDeviceGroupBindSparseInfo src)
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.
int	memoryDeviceIndex()
VkDeviceGroupBindSparseInfo	memoryDeviceIndex(int value)
MemorySegment	pNext()
VkDeviceGroupBindSparseInfo	pNext(@Nullable IPointer pointer)
void	pNext(MemorySegment value)
int	resourceDeviceIndex()
VkDeviceGroupBindSparseInfo	resourceDeviceIndex(int value)
@NotNull MemorySegment	segment()	Returns the value of the segment record component.
int	sType()
VkDeviceGroupBindSparseInfo	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$resourceDeviceIndex

public static final MemoryLayout.PathElement PATH$resourceDeviceIndex

PATH$memoryDeviceIndex

public static final MemoryLayout.PathElement PATH$memoryDeviceIndex

LAYOUT$sType

public static final ValueLayout.OfInt LAYOUT$sType

LAYOUT$pNext

public static final AddressLayout LAYOUT$pNext

LAYOUT$resourceDeviceIndex

public static final ValueLayout.OfInt LAYOUT$resourceDeviceIndex

LAYOUT$memoryDeviceIndex

public static final ValueLayout.OfInt LAYOUT$memoryDeviceIndex

SIZE$sType

public static final long SIZE$sType

SIZE$pNext

public static final long SIZE$pNext

SIZE$resourceDeviceIndex

public static final long SIZE$resourceDeviceIndex

SIZE$memoryDeviceIndex

public static final long SIZE$memoryDeviceIndex

OFFSET$sType

public static final long OFFSET$sType

OFFSET$pNext

public static final long OFFSET$pNext

OFFSET$resourceDeviceIndex

public static final long OFFSET$resourceDeviceIndex

OFFSET$memoryDeviceIndex

public static final long OFFSET$memoryDeviceIndex

Constructor Details

VkDeviceGroupBindSparseInfo

public VkDeviceGroupBindSparseInfo(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a VkDeviceGroupBindSparseInfo record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static VkDeviceGroupBindSparseInfo allocate(Arena arena)

allocate

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

clone

public static VkDeviceGroupBindSparseInfo clone(Arena arena,
 VkDeviceGroupBindSparseInfo src)

autoInit

public void autoInit()

sType

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

sType

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

pNext

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

pNext

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

pNext

public VkDeviceGroupBindSparseInfo pNext(@Nullable
 @Nullable IPointer pointer)

resourceDeviceIndex

@Unsigned
public int resourceDeviceIndex()

resourceDeviceIndex

public VkDeviceGroupBindSparseInfo resourceDeviceIndex(@Unsigned
 int value)

memoryDeviceIndex

@Unsigned
public int memoryDeviceIndex()

memoryDeviceIndex

public VkDeviceGroupBindSparseInfo memoryDeviceIndex(@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