Record Class VkSparseImageMemoryRequirements

java.lang.Object

java.lang.Record

club.doki7.vulkan.datatype.VkSparseImageMemoryRequirements

All Implemented Interfaces:

IPointer, IVkSparseImageMemoryRequirements

@ValueBasedCandidate
@UnsafeConstructor
public record VkSparseImageMemoryRequirements(@NotNull MemorySegment segment)
extends Record
implements IVkSparseImageMemoryRequirements

Represents a pointer to a VkSparseImageMemoryRequirements structure in native memory.

Structure

typedef struct VkSparseImageMemoryRequirements {
    VkSparseImageFormatProperties formatProperties;
    uint32_t imageMipTailFirstLod;
    VkDeviceSize imageMipTailSize;
    VkDeviceSize imageMipTailOffset;
    VkDeviceSize imageMipTailStride;
} VkSparseImageMemoryRequirements;

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:

• VkSparseImageMemoryRequirements

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	VkSparseImageMemoryRequirements.Ptr	Represents a pointer to / an array of VkSparseImageMemoryRequirements 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$formatProperties
static final ValueLayout.OfInt	LAYOUT$imageMipTailFirstLod
static final ValueLayout.OfLong	LAYOUT$imageMipTailOffset
static final ValueLayout.OfLong	LAYOUT$imageMipTailSize
static final ValueLayout.OfLong	LAYOUT$imageMipTailStride
static final long	OFFSET$formatProperties
static final long	OFFSET$imageMipTailFirstLod
static final long	OFFSET$imageMipTailOffset
static final long	OFFSET$imageMipTailSize
static final long	OFFSET$imageMipTailStride
static final MemoryLayout.PathElement	PATH$formatProperties
static final MemoryLayout.PathElement	PATH$imageMipTailFirstLod
static final MemoryLayout.PathElement	PATH$imageMipTailOffset
static final MemoryLayout.PathElement	PATH$imageMipTailSize
static final MemoryLayout.PathElement	PATH$imageMipTailStride
static final long	SIZE$formatProperties
static final long	SIZE$imageMipTailFirstLod
static final long	SIZE$imageMipTailOffset
static final long	SIZE$imageMipTailSize
static final long	SIZE$imageMipTailStride

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static VkSparseImageMemoryRequirements	allocate(Arena arena)
static VkSparseImageMemoryRequirements.Ptr	allocate(Arena arena, long count)
static VkSparseImageMemoryRequirements	clone(Arena arena, VkSparseImageMemoryRequirements src)
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
@NotNull VkSparseImageFormatProperties	formatProperties()
VkSparseImageMemoryRequirements	formatProperties(@NotNull VkSparseImageFormatProperties value)
VkSparseImageMemoryRequirements	formatProperties(Consumer<@NotNull VkSparseImageFormatProperties> consumer)
final int	hashCode()	Returns a hash code value for this object.
int	imageMipTailFirstLod()
VkSparseImageMemoryRequirements	imageMipTailFirstLod(int value)
long	imageMipTailOffset()
VkSparseImageMemoryRequirements	imageMipTailOffset(long value)
long	imageMipTailSize()
VkSparseImageMemoryRequirements	imageMipTailSize(long value)
long	imageMipTailStride()
VkSparseImageMemoryRequirements	imageMipTailStride(long 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$formatProperties

public static final MemoryLayout.PathElement PATH$formatProperties

PATH$imageMipTailFirstLod

public static final MemoryLayout.PathElement PATH$imageMipTailFirstLod

PATH$imageMipTailSize

public static final MemoryLayout.PathElement PATH$imageMipTailSize

PATH$imageMipTailOffset

public static final MemoryLayout.PathElement PATH$imageMipTailOffset

PATH$imageMipTailStride

public static final MemoryLayout.PathElement PATH$imageMipTailStride

LAYOUT$formatProperties

public static final StructLayout LAYOUT$formatProperties

LAYOUT$imageMipTailFirstLod

public static final ValueLayout.OfInt LAYOUT$imageMipTailFirstLod

LAYOUT$imageMipTailSize

public static final ValueLayout.OfLong LAYOUT$imageMipTailSize

LAYOUT$imageMipTailOffset

public static final ValueLayout.OfLong LAYOUT$imageMipTailOffset

LAYOUT$imageMipTailStride

public static final ValueLayout.OfLong LAYOUT$imageMipTailStride

SIZE$formatProperties

public static final long SIZE$formatProperties

SIZE$imageMipTailFirstLod

public static final long SIZE$imageMipTailFirstLod

SIZE$imageMipTailSize

public static final long SIZE$imageMipTailSize

SIZE$imageMipTailOffset

public static final long SIZE$imageMipTailOffset

SIZE$imageMipTailStride

public static final long SIZE$imageMipTailStride

OFFSET$formatProperties

public static final long OFFSET$formatProperties

OFFSET$imageMipTailFirstLod

public static final long OFFSET$imageMipTailFirstLod

OFFSET$imageMipTailSize

public static final long OFFSET$imageMipTailSize

OFFSET$imageMipTailOffset

public static final long OFFSET$imageMipTailOffset

OFFSET$imageMipTailStride

public static final long OFFSET$imageMipTailStride

Constructor Details

VkSparseImageMemoryRequirements

public VkSparseImageMemoryRequirements(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a VkSparseImageMemoryRequirements record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static VkSparseImageMemoryRequirements allocate(Arena arena)

allocate

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

clone

public static VkSparseImageMemoryRequirements clone(Arena arena,
 VkSparseImageMemoryRequirements src)

formatProperties

@NotNull
public @NotNull VkSparseImageFormatProperties formatProperties()

formatProperties

public VkSparseImageMemoryRequirements formatProperties(@NotNull
 @NotNull VkSparseImageFormatProperties value)

formatProperties

public VkSparseImageMemoryRequirements formatProperties(Consumer<@NotNull VkSparseImageFormatProperties> consumer)

imageMipTailFirstLod

@Unsigned
public int imageMipTailFirstLod()

imageMipTailFirstLod

public VkSparseImageMemoryRequirements imageMipTailFirstLod(@Unsigned
 int value)

imageMipTailSize

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

imageMipTailSize

public VkSparseImageMemoryRequirements imageMipTailSize(@NativeType("VkDeviceSize") @Unsigned
 long value)

imageMipTailOffset

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

imageMipTailOffset

public VkSparseImageMemoryRequirements imageMipTailOffset(@NativeType("VkDeviceSize") @Unsigned
 long value)

imageMipTailStride

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

imageMipTailStride

public VkSparseImageMemoryRequirements imageMipTailStride(@NativeType("VkDeviceSize") @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