Record Class VkPipelineCacheHeaderVersionOne

java.lang.Object

java.lang.Record

club.doki7.vulkan.datatype.VkPipelineCacheHeaderVersionOne

All Implemented Interfaces:

IPointer, IVkPipelineCacheHeaderVersionOne

@ValueBasedCandidate
@UnsafeConstructor
public record VkPipelineCacheHeaderVersionOne(@NotNull MemorySegment segment)
extends Record
implements IVkPipelineCacheHeaderVersionOne

Represents a pointer to a VkPipelineCacheHeaderVersionOne structure in native memory.

Structure

typedef struct VkPipelineCacheHeaderVersionOne {
    uint32_t headerSize;
    VkPipelineCacheHeaderVersion headerVersion;
    uint32_t vendorID;
    uint32_t deviceID;
    uint8_t[VK_UUID_SIZE] pipelineCacheUUID;
} VkPipelineCacheHeaderVersionOne;

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:

• VkPipelineCacheHeaderVersionOne

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	VkPipelineCacheHeaderVersionOne.Ptr	Represents a pointer to / an array of VkPipelineCacheHeaderVersionOne 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$deviceID
static final ValueLayout.OfInt	LAYOUT$headerSize
static final ValueLayout.OfInt	LAYOUT$headerVersion
static final SequenceLayout	LAYOUT$pipelineCacheUUID
static final ValueLayout.OfInt	LAYOUT$vendorID
static final long	OFFSET$deviceID
static final long	OFFSET$headerSize
static final long	OFFSET$headerVersion
static final long	OFFSET$pipelineCacheUUID
static final long	OFFSET$vendorID
static final MemoryLayout.PathElement	PATH$deviceID
static final MemoryLayout.PathElement	PATH$headerSize
static final MemoryLayout.PathElement	PATH$headerVersion
static final MemoryLayout.PathElement	PATH$pipelineCacheUUID
static final MemoryLayout.PathElement	PATH$vendorID
static final long	SIZE$deviceID
static final long	SIZE$headerSize
static final long	SIZE$headerVersion
static final long	SIZE$pipelineCacheUUID
static final long	SIZE$vendorID

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static VkPipelineCacheHeaderVersionOne	allocate(Arena arena)
static VkPipelineCacheHeaderVersionOne.Ptr	allocate(Arena arena, long count)
static VkPipelineCacheHeaderVersionOne	clone(Arena arena, VkPipelineCacheHeaderVersionOne src)
int	deviceID()
VkPipelineCacheHeaderVersionOne	deviceID(int value)
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.
int	headerSize()
VkPipelineCacheHeaderVersionOne	headerSize(int value)
int	headerVersion()
VkPipelineCacheHeaderVersionOne	headerVersion(int value)
BytePtr	pipelineCacheUUID()
VkPipelineCacheHeaderVersionOne	pipelineCacheUUID(BytePtr value)
MemorySegment	pipelineCacheUUIDRaw()
@NotNull MemorySegment	segment()	Returns the value of the segment record component.
final String	toString()	Returns a string representation of this record class.
int	vendorID()
VkPipelineCacheHeaderVersionOne	vendorID(int value)

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

public static final MemoryLayout.PathElement PATH$headerSize

PATH$headerVersion

public static final MemoryLayout.PathElement PATH$headerVersion

PATH$vendorID

public static final MemoryLayout.PathElement PATH$vendorID

PATH$deviceID

public static final MemoryLayout.PathElement PATH$deviceID

PATH$pipelineCacheUUID

public static final MemoryLayout.PathElement PATH$pipelineCacheUUID

LAYOUT$headerSize

public static final ValueLayout.OfInt LAYOUT$headerSize

LAYOUT$headerVersion

public static final ValueLayout.OfInt LAYOUT$headerVersion

LAYOUT$vendorID

public static final ValueLayout.OfInt LAYOUT$vendorID

LAYOUT$deviceID

public static final ValueLayout.OfInt LAYOUT$deviceID

LAYOUT$pipelineCacheUUID

public static final SequenceLayout LAYOUT$pipelineCacheUUID

SIZE$headerSize

public static final long SIZE$headerSize

SIZE$headerVersion

public static final long SIZE$headerVersion

SIZE$vendorID

public static final long SIZE$vendorID

SIZE$deviceID

public static final long SIZE$deviceID

SIZE$pipelineCacheUUID

public static final long SIZE$pipelineCacheUUID

OFFSET$headerSize

public static final long OFFSET$headerSize

OFFSET$headerVersion

public static final long OFFSET$headerVersion

OFFSET$vendorID

public static final long OFFSET$vendorID

OFFSET$deviceID

public static final long OFFSET$deviceID

OFFSET$pipelineCacheUUID

public static final long OFFSET$pipelineCacheUUID

Constructor Details

VkPipelineCacheHeaderVersionOne

public VkPipelineCacheHeaderVersionOne(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a VkPipelineCacheHeaderVersionOne record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static VkPipelineCacheHeaderVersionOne allocate(Arena arena)

allocate

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

clone

public static VkPipelineCacheHeaderVersionOne clone(Arena arena,
 VkPipelineCacheHeaderVersionOne src)

headerSize

@Unsigned
public int headerSize()

headerSize

public VkPipelineCacheHeaderVersionOne headerSize(@Unsigned
 int value)

headerVersion

@EnumType(VkPipelineCacheHeaderVersion.class)
public int headerVersion()

headerVersion

public VkPipelineCacheHeaderVersionOne headerVersion(@EnumType(VkPipelineCacheHeaderVersion.class)
 int value)

vendorID

@Unsigned
public int vendorID()

vendorID

public VkPipelineCacheHeaderVersionOne vendorID(@Unsigned
 int value)

deviceID

@Unsigned
public int deviceID()

deviceID

public VkPipelineCacheHeaderVersionOne deviceID(@Unsigned
 int value)

pipelineCacheUUID

@Unsigned
public BytePtr pipelineCacheUUID()

pipelineCacheUUID

public VkPipelineCacheHeaderVersionOne pipelineCacheUUID(@Unsigned
 BytePtr value)

pipelineCacheUUIDRaw

public MemorySegment pipelineCacheUUIDRaw()

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