Record Class VkSparseImageFormatProperties

java.lang.Object

java.lang.Record

club.doki7.vulkan.datatype.VkSparseImageFormatProperties

All Implemented Interfaces:

IPointer, IVkSparseImageFormatProperties

@ValueBasedCandidate
@UnsafeConstructor
public record VkSparseImageFormatProperties(@NotNull MemorySegment segment)
extends Record
implements IVkSparseImageFormatProperties

Represents a pointer to a VkSparseImageFormatProperties structure in native memory.

Structure

typedef struct VkSparseImageFormatProperties {
    VkImageAspectFlags aspectMask; // optional
    VkExtent3D imageGranularity;
    VkSparseImageFormatFlags flags; // optional
} VkSparseImageFormatProperties;

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:

• VkSparseImageFormatProperties

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	VkSparseImageFormatProperties.Ptr	Represents a pointer to / an array of VkSparseImageFormatProperties 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$aspectMask
static final ValueLayout.OfInt	LAYOUT$flags
static final StructLayout	LAYOUT$imageGranularity
static final long	OFFSET$aspectMask
static final long	OFFSET$flags
static final long	OFFSET$imageGranularity
static final MemoryLayout.PathElement	PATH$aspectMask
static final MemoryLayout.PathElement	PATH$flags
static final MemoryLayout.PathElement	PATH$imageGranularity
static final long	SIZE$aspectMask
static final long	SIZE$flags
static final long	SIZE$imageGranularity

Constructor Summary

Constructors

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

Method Summary

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

public static final MemoryLayout.PathElement PATH$aspectMask

PATH$imageGranularity

public static final MemoryLayout.PathElement PATH$imageGranularity

PATH$flags

public static final MemoryLayout.PathElement PATH$flags

LAYOUT$aspectMask

public static final ValueLayout.OfInt LAYOUT$aspectMask

LAYOUT$imageGranularity

public static final StructLayout LAYOUT$imageGranularity

LAYOUT$flags

public static final ValueLayout.OfInt LAYOUT$flags

SIZE$aspectMask

public static final long SIZE$aspectMask

SIZE$imageGranularity

public static final long SIZE$imageGranularity

SIZE$flags

public static final long SIZE$flags

OFFSET$aspectMask

public static final long OFFSET$aspectMask

OFFSET$imageGranularity

public static final long OFFSET$imageGranularity

OFFSET$flags

public static final long OFFSET$flags

Constructor Details

VkSparseImageFormatProperties

public VkSparseImageFormatProperties(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a VkSparseImageFormatProperties record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static VkSparseImageFormatProperties allocate(Arena arena)

allocate

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

clone

public static VkSparseImageFormatProperties clone(Arena arena,
 VkSparseImageFormatProperties src)

aspectMask

@Bitmask(VkImageAspectFlags.class)
public int aspectMask()

aspectMask

public VkSparseImageFormatProperties aspectMask(@Bitmask(VkImageAspectFlags.class)
 int value)

imageGranularity

@NotNull
public @NotNull VkExtent3D imageGranularity()

imageGranularity

public VkSparseImageFormatProperties imageGranularity(@NotNull
 @NotNull VkExtent3D value)

imageGranularity

public VkSparseImageFormatProperties imageGranularity(Consumer<@NotNull VkExtent3D> consumer)

flags

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

flags

public VkSparseImageFormatProperties flags(@Bitmask(VkSparseImageFormatFlags.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