Record Class VkSparseImageMemoryBindInfo

java.lang.Object

java.lang.Record

club.doki7.vulkan.datatype.VkSparseImageMemoryBindInfo

All Implemented Interfaces:

IPointer, IVkSparseImageMemoryBindInfo

@ValueBasedCandidate
@UnsafeConstructor
public record VkSparseImageMemoryBindInfo(@NotNull MemorySegment segment)
extends Record
implements IVkSparseImageMemoryBindInfo

Represents a pointer to a VkSparseImageMemoryBindInfo structure in native memory.

Structure

typedef struct VkSparseImageMemoryBindInfo {
    VkImage image;
    uint32_t bindCount;
    VkSparseImageMemoryBind const* pBinds;
} VkSparseImageMemoryBindInfo;

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:

• VkSparseImageMemoryBindInfo

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	VkSparseImageMemoryBindInfo.Ptr	Represents a pointer to / an array of VkSparseImageMemoryBindInfo 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$bindCount
static final AddressLayout	LAYOUT$image
static final AddressLayout	LAYOUT$pBinds
static final long	OFFSET$bindCount
static final long	OFFSET$image
static final long	OFFSET$pBinds
static final MemoryLayout.PathElement	PATH$bindCount
static final MemoryLayout.PathElement	PATH$image
static final MemoryLayout.PathElement	PATH$pBinds
static final long	SIZE$bindCount
static final long	SIZE$image
static final long	SIZE$pBinds

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static VkSparseImageMemoryBindInfo	allocate(Arena arena)
static VkSparseImageMemoryBindInfo.Ptr	allocate(Arena arena, long count)
int	bindCount()
VkSparseImageMemoryBindInfo	bindCount(int value)
static VkSparseImageMemoryBindInfo	clone(Arena arena, VkSparseImageMemoryBindInfo 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.
@Nullable VkImage	image()
VkSparseImageMemoryBindInfo	image(@Nullable VkImage value)
@Nullable VkSparseImageMemoryBind	pBinds()
VkSparseImageMemoryBind.Ptr	pBinds(int assumedCount)
VkSparseImageMemoryBindInfo	pBinds(@Nullable IVkSparseImageMemoryBind value)
@NotNull MemorySegment	pBindsRaw()
void	pBindsRaw(@NotNull MemorySegment value)
@NotNull MemorySegment	segment()	Returns the value of the segment record component.
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$image

public static final MemoryLayout.PathElement PATH$image

PATH$bindCount

public static final MemoryLayout.PathElement PATH$bindCount

PATH$pBinds

public static final MemoryLayout.PathElement PATH$pBinds

LAYOUT$image

public static final AddressLayout LAYOUT$image

LAYOUT$bindCount

public static final ValueLayout.OfInt LAYOUT$bindCount

LAYOUT$pBinds

public static final AddressLayout LAYOUT$pBinds

SIZE$image

public static final long SIZE$image

SIZE$bindCount

public static final long SIZE$bindCount

SIZE$pBinds

public static final long SIZE$pBinds

OFFSET$image

public static final long OFFSET$image

OFFSET$bindCount

public static final long OFFSET$bindCount

OFFSET$pBinds

public static final long OFFSET$pBinds

Constructor Details

VkSparseImageMemoryBindInfo

public VkSparseImageMemoryBindInfo(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a VkSparseImageMemoryBindInfo record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static VkSparseImageMemoryBindInfo allocate(Arena arena)

allocate

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

clone

public static VkSparseImageMemoryBindInfo clone(Arena arena,
 VkSparseImageMemoryBindInfo src)

image

@Nullable
public @Nullable VkImage image()

image

public VkSparseImageMemoryBindInfo image(@Nullable
 @Nullable VkImage value)

bindCount

@Unsigned
public int bindCount()

bindCount

public VkSparseImageMemoryBindInfo bindCount(@Unsigned
 int value)

pBinds

public VkSparseImageMemoryBindInfo pBinds(@Nullable
 @Nullable IVkSparseImageMemoryBind value)

pBinds

@Unsafe
@Nullable
public VkSparseImageMemoryBind.Ptr pBinds(int assumedCount)

pBinds

@Nullable
public @Nullable VkSparseImageMemoryBind pBinds()

pBindsRaw

@Pointer(target=VkSparseImageMemoryBind.class)
@NotNull
public @NotNull MemorySegment pBindsRaw()

pBindsRaw

public void pBindsRaw(@Pointer(target=VkSparseImageMemoryBind.class) @NotNull
 @NotNull MemorySegment 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