Record Class VkSparseMemoryBind

java.lang.Object

java.lang.Record

club.doki7.vulkan.datatype.VkSparseMemoryBind

All Implemented Interfaces:

IPointer, IVkSparseMemoryBind

@ValueBasedCandidate
@UnsafeConstructor
public record VkSparseMemoryBind(@NotNull MemorySegment segment)
extends Record
implements IVkSparseMemoryBind

Represents a pointer to a VkSparseMemoryBind structure in native memory.

Structure

typedef struct VkSparseMemoryBind {
    VkDeviceSize resourceOffset;
    VkDeviceSize size;
    VkDeviceMemory memory; // optional
    VkDeviceSize memoryOffset;
    VkSparseMemoryBindFlags flags; // optional
} VkSparseMemoryBind;

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:

• VkSparseMemoryBind

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	VkSparseMemoryBind.Ptr	Represents a pointer to / an array of VkSparseMemoryBind 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$flags
static final AddressLayout	LAYOUT$memory
static final ValueLayout.OfLong	LAYOUT$memoryOffset
static final ValueLayout.OfLong	LAYOUT$resourceOffset
static final ValueLayout.OfLong	LAYOUT$size
static final long	OFFSET$flags
static final long	OFFSET$memory
static final long	OFFSET$memoryOffset
static final long	OFFSET$resourceOffset
static final long	OFFSET$size
static final MemoryLayout.PathElement	PATH$flags
static final MemoryLayout.PathElement	PATH$memory
static final MemoryLayout.PathElement	PATH$memoryOffset
static final MemoryLayout.PathElement	PATH$resourceOffset
static final MemoryLayout.PathElement	PATH$size
static final long	SIZE$flags
static final long	SIZE$memory
static final long	SIZE$memoryOffset
static final long	SIZE$resourceOffset
static final long	SIZE$size

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static VkSparseMemoryBind	allocate(Arena arena)
static VkSparseMemoryBind.Ptr	allocate(Arena arena, long count)
static VkSparseMemoryBind	clone(Arena arena, VkSparseMemoryBind src)
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
int	flags()
VkSparseMemoryBind	flags(int value)
final int	hashCode()	Returns a hash code value for this object.
@Nullable VkDeviceMemory	memory()
VkSparseMemoryBind	memory(@Nullable VkDeviceMemory value)
long	memoryOffset()
VkSparseMemoryBind	memoryOffset(long value)
long	resourceOffset()
VkSparseMemoryBind	resourceOffset(long value)
@NotNull MemorySegment	segment()	Returns the value of the segment record component.
long	size()
VkSparseMemoryBind	size(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$resourceOffset

public static final MemoryLayout.PathElement PATH$resourceOffset

PATH$size

public static final MemoryLayout.PathElement PATH$size

PATH$memory

public static final MemoryLayout.PathElement PATH$memory

PATH$memoryOffset

public static final MemoryLayout.PathElement PATH$memoryOffset

PATH$flags

public static final MemoryLayout.PathElement PATH$flags

LAYOUT$resourceOffset

public static final ValueLayout.OfLong LAYOUT$resourceOffset

LAYOUT$size

public static final ValueLayout.OfLong LAYOUT$size

LAYOUT$memory

public static final AddressLayout LAYOUT$memory

LAYOUT$memoryOffset

public static final ValueLayout.OfLong LAYOUT$memoryOffset

LAYOUT$flags

public static final ValueLayout.OfInt LAYOUT$flags

SIZE$resourceOffset

public static final long SIZE$resourceOffset

SIZE$size

public static final long SIZE$size

SIZE$memory

public static final long SIZE$memory

SIZE$memoryOffset

public static final long SIZE$memoryOffset

SIZE$flags

public static final long SIZE$flags

OFFSET$resourceOffset

public static final long OFFSET$resourceOffset

OFFSET$size

public static final long OFFSET$size

OFFSET$memory

public static final long OFFSET$memory

OFFSET$memoryOffset

public static final long OFFSET$memoryOffset

OFFSET$flags

public static final long OFFSET$flags

Constructor Details

VkSparseMemoryBind

public VkSparseMemoryBind(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a VkSparseMemoryBind record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static VkSparseMemoryBind allocate(Arena arena)

allocate

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

clone

public static VkSparseMemoryBind clone(Arena arena,
 VkSparseMemoryBind src)

resourceOffset

@NativeType("VkDeviceSize")
@Unsigned
public long resourceOffset()

resourceOffset

public VkSparseMemoryBind resourceOffset(@NativeType("VkDeviceSize") @Unsigned
 long value)

size

@NativeType("VkDeviceSize")
@Unsigned
public long size()

size

public VkSparseMemoryBind size(@NativeType("VkDeviceSize") @Unsigned
 long value)

memory

@Nullable
public @Nullable VkDeviceMemory memory()

memory

public VkSparseMemoryBind memory(@Nullable
 @Nullable VkDeviceMemory value)

memoryOffset

@NativeType("VkDeviceSize")
@Unsigned
public long memoryOffset()

memoryOffset

public VkSparseMemoryBind memoryOffset(@NativeType("VkDeviceSize") @Unsigned
 long value)

flags

@Bitmask(VkSparseMemoryBindFlags.class)
public int flags()

flags

public VkSparseMemoryBind flags(@Bitmask(VkSparseMemoryBindFlags.class)
 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