Record Class VkSpecializationInfo

java.lang.Object

java.lang.Record

club.doki7.vulkan.datatype.VkSpecializationInfo

All Implemented Interfaces:

IPointer, IVkSpecializationInfo

@ValueBasedCandidate
@UnsafeConstructor
public record VkSpecializationInfo(@NotNull MemorySegment segment)
extends Record
implements IVkSpecializationInfo

Represents a pointer to a VkSpecializationInfo structure in native memory.

Structure

typedef struct VkSpecializationInfo {
    uint32_t mapEntryCount; // optional
    VkSpecializationMapEntry const* pMapEntries; // optional
    size_t dataSize; // optional
    void const* pData; // optional
} VkSpecializationInfo;

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:

• VkSpecializationInfo

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	VkSpecializationInfo.Ptr	Represents a pointer to / an array of VkSpecializationInfo 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$mapEntryCount
static final AddressLayout	LAYOUT$pData
static final AddressLayout	LAYOUT$pMapEntries
static final long	OFFSET$dataSize
static final long	OFFSET$mapEntryCount
static final long	OFFSET$pData
static final long	OFFSET$pMapEntries
static final MemoryLayout.PathElement	PATH$dataSize
static final MemoryLayout.PathElement	PATH$mapEntryCount
static final MemoryLayout.PathElement	PATH$pData
static final MemoryLayout.PathElement	PATH$pMapEntries
static final long	SIZE$dataSize
static final long	SIZE$mapEntryCount
static final long	SIZE$pData
static final long	SIZE$pMapEntries

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static VkSpecializationInfo	allocate(Arena arena)
static VkSpecializationInfo.Ptr	allocate(Arena arena, long count)
static VkSpecializationInfo	clone(Arena arena, VkSpecializationInfo src)
long	dataSize()
VkSpecializationInfo	dataSize(long 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	mapEntryCount()
VkSpecializationInfo	mapEntryCount(int value)
@NotNull MemorySegment	pData()
VkSpecializationInfo	pData(@Nullable IPointer pointer)
VkSpecializationInfo	pData(@NotNull MemorySegment value)
@Nullable VkSpecializationMapEntry	pMapEntries()
VkSpecializationMapEntry.Ptr	pMapEntries(int assumedCount)
VkSpecializationInfo	pMapEntries(@Nullable IVkSpecializationMapEntry value)
@NotNull MemorySegment	pMapEntriesRaw()
void	pMapEntriesRaw(@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$mapEntryCount

public static final MemoryLayout.PathElement PATH$mapEntryCount

PATH$pMapEntries

public static final MemoryLayout.PathElement PATH$pMapEntries

PATH$dataSize

public static final MemoryLayout.PathElement PATH$dataSize

PATH$pData

public static final MemoryLayout.PathElement PATH$pData

LAYOUT$mapEntryCount

public static final ValueLayout.OfInt LAYOUT$mapEntryCount

LAYOUT$pMapEntries

public static final AddressLayout LAYOUT$pMapEntries

LAYOUT$pData

public static final AddressLayout LAYOUT$pData

SIZE$mapEntryCount

public static final long SIZE$mapEntryCount

SIZE$pMapEntries

public static final long SIZE$pMapEntries

SIZE$dataSize

public static final long SIZE$dataSize

SIZE$pData

public static final long SIZE$pData

OFFSET$mapEntryCount

public static final long OFFSET$mapEntryCount

OFFSET$pMapEntries

public static final long OFFSET$pMapEntries

OFFSET$dataSize

public static final long OFFSET$dataSize

OFFSET$pData

public static final long OFFSET$pData

Constructor Details

VkSpecializationInfo

public VkSpecializationInfo(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a VkSpecializationInfo record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static VkSpecializationInfo allocate(Arena arena)

allocate

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

clone

public static VkSpecializationInfo clone(Arena arena,
 VkSpecializationInfo src)

mapEntryCount

@Unsigned
public int mapEntryCount()

mapEntryCount

public VkSpecializationInfo mapEntryCount(@Unsigned
 int value)

pMapEntries

public VkSpecializationInfo pMapEntries(@Nullable
 @Nullable IVkSpecializationMapEntry value)

pMapEntries

@Unsafe
@Nullable
public VkSpecializationMapEntry.Ptr pMapEntries(int assumedCount)

pMapEntries

@Nullable
public @Nullable VkSpecializationMapEntry pMapEntries()

pMapEntriesRaw

@Pointer(target=VkSpecializationMapEntry.class)
@NotNull
public @NotNull MemorySegment pMapEntriesRaw()

pMapEntriesRaw

public void pMapEntriesRaw(@Pointer(target=VkSpecializationMapEntry.class) @NotNull
 @NotNull MemorySegment value)

dataSize

@Unsigned
public long dataSize()

dataSize

public VkSpecializationInfo dataSize(@Unsigned
 long value)

pData

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

pData

public VkSpecializationInfo pData(@Pointer(comment="void*") @NotNull
 @NotNull MemorySegment value)

pData

public VkSpecializationInfo pData(@Nullable
 @Nullable IPointer pointer)

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