Record Class VkPipelineBinaryKeysAndDataKHR

java.lang.Object

java.lang.Record

club.doki7.vulkan.datatype.VkPipelineBinaryKeysAndDataKHR

All Implemented Interfaces:

IPointer, IVkPipelineBinaryKeysAndDataKHR

@ValueBasedCandidate
@UnsafeConstructor
public record VkPipelineBinaryKeysAndDataKHR(@NotNull MemorySegment segment)
extends Record
implements IVkPipelineBinaryKeysAndDataKHR

Represents a pointer to a VkPipelineBinaryKeysAndDataKHR structure in native memory.

Structure

typedef struct VkPipelineBinaryKeysAndDataKHR {
    uint32_t binaryCount;
    VkPipelineBinaryKeyKHR const* pPipelineBinaryKeys;
    VkPipelineBinaryDataKHR const* pPipelineBinaryData;
} VkPipelineBinaryKeysAndDataKHR;

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:

• VkPipelineBinaryKeysAndDataKHR

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	VkPipelineBinaryKeysAndDataKHR.Ptr	Represents a pointer to / an array of VkPipelineBinaryKeysAndDataKHR 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$binaryCount
static final AddressLayout	LAYOUT$pPipelineBinaryData
static final AddressLayout	LAYOUT$pPipelineBinaryKeys
static final long	OFFSET$binaryCount
static final long	OFFSET$pPipelineBinaryData
static final long	OFFSET$pPipelineBinaryKeys
static final MemoryLayout.PathElement	PATH$binaryCount
static final MemoryLayout.PathElement	PATH$pPipelineBinaryData
static final MemoryLayout.PathElement	PATH$pPipelineBinaryKeys
static final long	SIZE$binaryCount
static final long	SIZE$pPipelineBinaryData
static final long	SIZE$pPipelineBinaryKeys

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static VkPipelineBinaryKeysAndDataKHR	allocate(Arena arena)
static VkPipelineBinaryKeysAndDataKHR.Ptr	allocate(Arena arena, long count)
int	binaryCount()
VkPipelineBinaryKeysAndDataKHR	binaryCount(int value)
static VkPipelineBinaryKeysAndDataKHR	clone(Arena arena, VkPipelineBinaryKeysAndDataKHR 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.
@Nullable VkPipelineBinaryDataKHR	pPipelineBinaryData()
VkPipelineBinaryDataKHR.Ptr	pPipelineBinaryData(int assumedCount)
VkPipelineBinaryKeysAndDataKHR	pPipelineBinaryData(@Nullable IVkPipelineBinaryDataKHR value)
@NotNull MemorySegment	pPipelineBinaryDataRaw()
void	pPipelineBinaryDataRaw(@NotNull MemorySegment value)
@Nullable VkPipelineBinaryKeyKHR	pPipelineBinaryKeys()
VkPipelineBinaryKeyKHR.Ptr	pPipelineBinaryKeys(int assumedCount)
VkPipelineBinaryKeysAndDataKHR	pPipelineBinaryKeys(@Nullable IVkPipelineBinaryKeyKHR value)
@NotNull MemorySegment	pPipelineBinaryKeysRaw()
void	pPipelineBinaryKeysRaw(@NotNull MemorySegment 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$binaryCount

public static final MemoryLayout.PathElement PATH$binaryCount

PATH$pPipelineBinaryKeys

public static final MemoryLayout.PathElement PATH$pPipelineBinaryKeys

PATH$pPipelineBinaryData

public static final MemoryLayout.PathElement PATH$pPipelineBinaryData

LAYOUT$binaryCount

public static final ValueLayout.OfInt LAYOUT$binaryCount

LAYOUT$pPipelineBinaryKeys

public static final AddressLayout LAYOUT$pPipelineBinaryKeys

LAYOUT$pPipelineBinaryData

public static final AddressLayout LAYOUT$pPipelineBinaryData

SIZE$binaryCount

public static final long SIZE$binaryCount

SIZE$pPipelineBinaryKeys

public static final long SIZE$pPipelineBinaryKeys

SIZE$pPipelineBinaryData

public static final long SIZE$pPipelineBinaryData

OFFSET$binaryCount

public static final long OFFSET$binaryCount

OFFSET$pPipelineBinaryKeys

public static final long OFFSET$pPipelineBinaryKeys

OFFSET$pPipelineBinaryData

public static final long OFFSET$pPipelineBinaryData

Constructor Details

VkPipelineBinaryKeysAndDataKHR

public VkPipelineBinaryKeysAndDataKHR(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a VkPipelineBinaryKeysAndDataKHR record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static VkPipelineBinaryKeysAndDataKHR allocate(Arena arena)

allocate

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

clone

public static VkPipelineBinaryKeysAndDataKHR clone(Arena arena,
 VkPipelineBinaryKeysAndDataKHR src)

binaryCount

@Unsigned
public int binaryCount()

binaryCount

public VkPipelineBinaryKeysAndDataKHR binaryCount(@Unsigned
 int value)

pPipelineBinaryKeys

public VkPipelineBinaryKeysAndDataKHR pPipelineBinaryKeys(@Nullable
 @Nullable IVkPipelineBinaryKeyKHR value)

pPipelineBinaryKeys

@Unsafe
@Nullable
public VkPipelineBinaryKeyKHR.Ptr pPipelineBinaryKeys(int assumedCount)

pPipelineBinaryKeys

@Nullable
public @Nullable VkPipelineBinaryKeyKHR pPipelineBinaryKeys()

pPipelineBinaryKeysRaw

@Pointer(target=VkPipelineBinaryKeyKHR.class)
@NotNull
public @NotNull MemorySegment pPipelineBinaryKeysRaw()

pPipelineBinaryKeysRaw

public void pPipelineBinaryKeysRaw(@Pointer(target=VkPipelineBinaryKeyKHR.class) @NotNull
 @NotNull MemorySegment value)

pPipelineBinaryData

public VkPipelineBinaryKeysAndDataKHR pPipelineBinaryData(@Nullable
 @Nullable IVkPipelineBinaryDataKHR value)

pPipelineBinaryData

@Unsafe
@Nullable
public VkPipelineBinaryDataKHR.Ptr pPipelineBinaryData(int assumedCount)

pPipelineBinaryData

@Nullable
public @Nullable VkPipelineBinaryDataKHR pPipelineBinaryData()

pPipelineBinaryDataRaw

@Pointer(target=VkPipelineBinaryDataKHR.class)
@NotNull
public @NotNull MemorySegment pPipelineBinaryDataRaw()

pPipelineBinaryDataRaw

public void pPipelineBinaryDataRaw(@Pointer(target=VkPipelineBinaryDataKHR.class) @NotNull
 @NotNull MemorySegment 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