Record Class VkSparseImageMemoryBind

java.lang.Object

java.lang.Record

club.doki7.vulkan.datatype.VkSparseImageMemoryBind

All Implemented Interfaces:

IPointer, IVkSparseImageMemoryBind

@ValueBasedCandidate
@UnsafeConstructor
public record VkSparseImageMemoryBind(@NotNull MemorySegment segment)
extends Record
implements IVkSparseImageMemoryBind

Represents a pointer to a VkSparseImageMemoryBind structure in native memory.

Structure

typedef struct VkSparseImageMemoryBind {
    VkImageSubresource subresource;
    VkOffset3D offset;
    VkExtent3D extent;
    VkDeviceMemory memory; // optional
    VkDeviceSize memoryOffset;
    VkSparseMemoryBindFlags flags; // optional
} VkSparseImageMemoryBind;

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:

• VkSparseImageMemoryBind

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field	Description
static final long	BYTES
static final StructLayout	LAYOUT
static final StructLayout	LAYOUT$extent
static final ValueLayout.OfInt	LAYOUT$flags
static final AddressLayout	LAYOUT$memory
static final ValueLayout.OfLong	LAYOUT$memoryOffset
static final StructLayout	LAYOUT$offset
static final StructLayout	LAYOUT$subresource
static final long	OFFSET$extent
static final long	OFFSET$flags
static final long	OFFSET$memory
static final long	OFFSET$memoryOffset
static final long	OFFSET$offset
static final long	OFFSET$subresource
static final MemoryLayout.PathElement	PATH$extent
static final MemoryLayout.PathElement	PATH$flags
static final MemoryLayout.PathElement	PATH$memory
static final MemoryLayout.PathElement	PATH$memoryOffset
static final MemoryLayout.PathElement	PATH$offset
static final MemoryLayout.PathElement	PATH$subresource
static final long	SIZE$extent
static final long	SIZE$flags
static final long	SIZE$memory
static final long	SIZE$memoryOffset
static final long	SIZE$offset
static final long	SIZE$subresource

Constructor Summary

Constructors

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

Method Summary

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

public static final MemoryLayout.PathElement PATH$subresource

PATH$offset

public static final MemoryLayout.PathElement PATH$offset

PATH$extent

public static final MemoryLayout.PathElement PATH$extent

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$subresource

public static final StructLayout LAYOUT$subresource

LAYOUT$offset

public static final StructLayout LAYOUT$offset

LAYOUT$extent

public static final StructLayout LAYOUT$extent

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$subresource

public static final long SIZE$subresource

SIZE$offset

public static final long SIZE$offset

SIZE$extent

public static final long SIZE$extent

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$subresource

public static final long OFFSET$subresource

OFFSET$offset

public static final long OFFSET$offset

OFFSET$extent

public static final long OFFSET$extent

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

VkSparseImageMemoryBind

public VkSparseImageMemoryBind(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a VkSparseImageMemoryBind record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static VkSparseImageMemoryBind allocate(Arena arena)

allocate

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

clone

public static VkSparseImageMemoryBind clone(Arena arena,
 VkSparseImageMemoryBind src)

subresource

@NotNull
public @NotNull VkImageSubresource subresource()

subresource

public VkSparseImageMemoryBind subresource(@NotNull
 @NotNull VkImageSubresource value)

subresource

public VkSparseImageMemoryBind subresource(Consumer<@NotNull VkImageSubresource> consumer)

offset

@NotNull
public @NotNull VkOffset3D offset()

offset

public VkSparseImageMemoryBind offset(@NotNull
 @NotNull VkOffset3D value)

offset

public VkSparseImageMemoryBind offset(Consumer<@NotNull VkOffset3D> consumer)

extent

@NotNull
public @NotNull VkExtent3D extent()

extent

public VkSparseImageMemoryBind extent(@NotNull
 @NotNull VkExtent3D value)

extent

public VkSparseImageMemoryBind extent(Consumer<@NotNull VkExtent3D> consumer)

memory

@Nullable
public @Nullable VkDeviceMemory memory()

memory

public VkSparseImageMemoryBind memory(@Nullable
 @Nullable VkDeviceMemory value)

memoryOffset

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

memoryOffset

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

flags

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

flags

public VkSparseImageMemoryBind flags(@EnumType(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