Record Class VkTilePropertiesQCOM

java.lang.Object

java.lang.Record

club.doki7.vulkan.datatype.VkTilePropertiesQCOM

All Implemented Interfaces:

IPointer, IVkTilePropertiesQCOM

@ValueBasedCandidate
@UnsafeConstructor
public record VkTilePropertiesQCOM(@NotNull MemorySegment segment)
extends Record
implements IVkTilePropertiesQCOM

Represents a pointer to a VkTilePropertiesQCOM structure in native memory.

Structure

typedef struct VkTilePropertiesQCOM {
    VkStructureType sType;
    void* pNext; // optional
    VkExtent3D tileSize;
    VkExtent2D apronSize;
    VkOffset2D origin;
} VkTilePropertiesQCOM;

Auto initialization

This structure has the following members that can be automatically initialized:

• sType = VK_STRUCTURE_TYPE_TILE_PROPERTIES_QCOM

The allocate (allocate(Arena), allocate(Arena, long)) functions will automatically initialize these fields. Also, you may call autoInit() to initialize these fields manually for non-allocated instances.

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:

• VkTilePropertiesQCOM

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	VkTilePropertiesQCOM.Ptr	Represents a pointer to / an array of VkTilePropertiesQCOM 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$apronSize
static final StructLayout	LAYOUT$origin
static final AddressLayout	LAYOUT$pNext
static final ValueLayout.OfInt	LAYOUT$sType
static final StructLayout	LAYOUT$tileSize
static final long	OFFSET$apronSize
static final long	OFFSET$origin
static final long	OFFSET$pNext
static final long	OFFSET$sType
static final long	OFFSET$tileSize
static final MemoryLayout.PathElement	PATH$apronSize
static final MemoryLayout.PathElement	PATH$origin
static final MemoryLayout.PathElement	PATH$pNext
static final MemoryLayout.PathElement	PATH$sType
static final MemoryLayout.PathElement	PATH$tileSize
static final long	SIZE$apronSize
static final long	SIZE$origin
static final long	SIZE$pNext
static final long	SIZE$sType
static final long	SIZE$tileSize

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static VkTilePropertiesQCOM	allocate(Arena arena)
static VkTilePropertiesQCOM.Ptr	allocate(Arena arena, long count)
@NotNull VkExtent2D	apronSize()
VkTilePropertiesQCOM	apronSize(@NotNull VkExtent2D value)
VkTilePropertiesQCOM	apronSize(Consumer<@NotNull VkExtent2D> consumer)
void	autoInit()
static VkTilePropertiesQCOM	clone(Arena arena, VkTilePropertiesQCOM 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.
@NotNull VkOffset2D	origin()
VkTilePropertiesQCOM	origin(@NotNull VkOffset2D value)
VkTilePropertiesQCOM	origin(Consumer<@NotNull VkOffset2D> consumer)
@NotNull MemorySegment	pNext()
VkTilePropertiesQCOM	pNext(@Nullable IPointer pointer)
VkTilePropertiesQCOM	pNext(@NotNull MemorySegment value)
@NotNull MemorySegment	segment()	Returns the value of the segment record component.
int	sType()
VkTilePropertiesQCOM	sType(int value)
@NotNull VkExtent3D	tileSize()
VkTilePropertiesQCOM	tileSize(@NotNull VkExtent3D value)
VkTilePropertiesQCOM	tileSize(Consumer<@NotNull VkExtent3D> 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$sType

public static final MemoryLayout.PathElement PATH$sType

PATH$pNext

public static final MemoryLayout.PathElement PATH$pNext

PATH$tileSize

public static final MemoryLayout.PathElement PATH$tileSize

PATH$apronSize

public static final MemoryLayout.PathElement PATH$apronSize

PATH$origin

public static final MemoryLayout.PathElement PATH$origin

LAYOUT$sType

public static final ValueLayout.OfInt LAYOUT$sType

LAYOUT$pNext

public static final AddressLayout LAYOUT$pNext

LAYOUT$tileSize

public static final StructLayout LAYOUT$tileSize

LAYOUT$apronSize

public static final StructLayout LAYOUT$apronSize

LAYOUT$origin

public static final StructLayout LAYOUT$origin

SIZE$sType

public static final long SIZE$sType

SIZE$pNext

public static final long SIZE$pNext

SIZE$tileSize

public static final long SIZE$tileSize

SIZE$apronSize

public static final long SIZE$apronSize

SIZE$origin

public static final long SIZE$origin

OFFSET$sType

public static final long OFFSET$sType

OFFSET$pNext

public static final long OFFSET$pNext

OFFSET$tileSize

public static final long OFFSET$tileSize

OFFSET$apronSize

public static final long OFFSET$apronSize

OFFSET$origin

public static final long OFFSET$origin

Constructor Details

VkTilePropertiesQCOM

public VkTilePropertiesQCOM(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a VkTilePropertiesQCOM record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static VkTilePropertiesQCOM allocate(Arena arena)

allocate

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

clone

public static VkTilePropertiesQCOM clone(Arena arena,
 VkTilePropertiesQCOM src)

autoInit

public void autoInit()

sType

@EnumType(VkStructureType.class)
public int sType()

sType

public VkTilePropertiesQCOM sType(@EnumType(VkStructureType.class)
 int value)

pNext

@Pointer(comment="void*")
@NotNull
public @NotNull MemorySegment pNext()

pNext

public VkTilePropertiesQCOM pNext(@Pointer(comment="void*") @NotNull
 @NotNull MemorySegment value)

pNext

public VkTilePropertiesQCOM pNext(@Nullable
 @Nullable IPointer pointer)

tileSize

@NotNull
public @NotNull VkExtent3D tileSize()

tileSize

public VkTilePropertiesQCOM tileSize(@NotNull
 @NotNull VkExtent3D value)

tileSize

public VkTilePropertiesQCOM tileSize(Consumer<@NotNull VkExtent3D> consumer)

apronSize

@NotNull
public @NotNull VkExtent2D apronSize()

apronSize

public VkTilePropertiesQCOM apronSize(@NotNull
 @NotNull VkExtent2D value)

apronSize

public VkTilePropertiesQCOM apronSize(Consumer<@NotNull VkExtent2D> consumer)

origin

@NotNull
public @NotNull VkOffset2D origin()

origin

public VkTilePropertiesQCOM origin(@NotNull
 @NotNull VkOffset2D value)

origin

public VkTilePropertiesQCOM origin(Consumer<@NotNull VkOffset2D> consumer)

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