Record Class VkTimelineSemaphoreSubmitInfo

java.lang.Object

java.lang.Record

club.doki7.vulkan.datatype.VkTimelineSemaphoreSubmitInfo

All Implemented Interfaces:

IPointer, IVkTimelineSemaphoreSubmitInfo

@ValueBasedCandidate
@UnsafeConstructor
public record VkTimelineSemaphoreSubmitInfo(@NotNull MemorySegment segment)
extends Record
implements IVkTimelineSemaphoreSubmitInfo

Represents a pointer to a VkTimelineSemaphoreSubmitInfo structure in native memory.

Structure

typedef struct VkTimelineSemaphoreSubmitInfo {
    VkStructureType sType;
    void const* pNext; // optional
    uint32_t waitSemaphoreValueCount; // optional
    uint64_t const* pWaitSemaphoreValues; // optional
    uint32_t signalSemaphoreValueCount; // optional
    uint64_t const* pSignalSemaphoreValues; // optional
} VkTimelineSemaphoreSubmitInfo;

Auto initialization

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

• sType = VK_STRUCTURE_TYPE_TIMELINE_SEMAPHORE_SUBMIT_INFO

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:

• VkTimelineSemaphoreSubmitInfo

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	VkTimelineSemaphoreSubmitInfo.Ptr	Represents a pointer to / an array of VkTimelineSemaphoreSubmitInfo structure(s) in native memory.

Field Summary

Fields

Modifier and Type	Field	Description
static final long	BYTES
static final StructLayout	LAYOUT
static final AddressLayout	LAYOUT$pNext
static final AddressLayout	LAYOUT$pSignalSemaphoreValues
static final AddressLayout	LAYOUT$pWaitSemaphoreValues
static final ValueLayout.OfInt	LAYOUT$signalSemaphoreValueCount
static final ValueLayout.OfInt	LAYOUT$sType
static final ValueLayout.OfInt	LAYOUT$waitSemaphoreValueCount
static final long	OFFSET$pNext
static final long	OFFSET$pSignalSemaphoreValues
static final long	OFFSET$pWaitSemaphoreValues
static final long	OFFSET$signalSemaphoreValueCount
static final long	OFFSET$sType
static final long	OFFSET$waitSemaphoreValueCount
static final MemoryLayout.PathElement	PATH$pNext
static final MemoryLayout.PathElement	PATH$pSignalSemaphoreValues
static final MemoryLayout.PathElement	PATH$pWaitSemaphoreValues
static final MemoryLayout.PathElement	PATH$signalSemaphoreValueCount
static final MemoryLayout.PathElement	PATH$sType
static final MemoryLayout.PathElement	PATH$waitSemaphoreValueCount
static final long	SIZE$pNext
static final long	SIZE$pSignalSemaphoreValues
static final long	SIZE$pWaitSemaphoreValues
static final long	SIZE$signalSemaphoreValueCount
static final long	SIZE$sType
static final long	SIZE$waitSemaphoreValueCount

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static VkTimelineSemaphoreSubmitInfo	allocate(Arena arena)
static VkTimelineSemaphoreSubmitInfo.Ptr	allocate(Arena arena, long count)
void	autoInit()
static VkTimelineSemaphoreSubmitInfo	clone(Arena arena, VkTimelineSemaphoreSubmitInfo 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 MemorySegment	pNext()
VkTimelineSemaphoreSubmitInfo	pNext(@Nullable IPointer pointer)
VkTimelineSemaphoreSubmitInfo	pNext(@NotNull MemorySegment value)
@Nullable LongPtr	pSignalSemaphoreValues()	Note: the returned LongPtr does not have correct LongPtr.size() property.
VkTimelineSemaphoreSubmitInfo	pSignalSemaphoreValues(@Nullable LongPtr value)
@NotNull MemorySegment	pSignalSemaphoreValuesRaw()
void	pSignalSemaphoreValuesRaw(@NotNull MemorySegment value)
@Nullable LongPtr	pWaitSemaphoreValues()	Note: the returned LongPtr does not have correct LongPtr.size() property.
VkTimelineSemaphoreSubmitInfo	pWaitSemaphoreValues(@Nullable LongPtr value)
@NotNull MemorySegment	pWaitSemaphoreValuesRaw()
void	pWaitSemaphoreValuesRaw(@NotNull MemorySegment value)
@NotNull MemorySegment	segment()	Returns the value of the segment record component.
int	signalSemaphoreValueCount()
VkTimelineSemaphoreSubmitInfo	signalSemaphoreValueCount(int value)
int	sType()
VkTimelineSemaphoreSubmitInfo	sType(int value)
final String	toString()	Returns a string representation of this record class.
int	waitSemaphoreValueCount()
VkTimelineSemaphoreSubmitInfo	waitSemaphoreValueCount(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$sType

public static final MemoryLayout.PathElement PATH$sType

PATH$pNext

public static final MemoryLayout.PathElement PATH$pNext

PATH$waitSemaphoreValueCount

public static final MemoryLayout.PathElement PATH$waitSemaphoreValueCount

PATH$pWaitSemaphoreValues

public static final MemoryLayout.PathElement PATH$pWaitSemaphoreValues

PATH$signalSemaphoreValueCount

public static final MemoryLayout.PathElement PATH$signalSemaphoreValueCount

PATH$pSignalSemaphoreValues

public static final MemoryLayout.PathElement PATH$pSignalSemaphoreValues

LAYOUT$sType

public static final ValueLayout.OfInt LAYOUT$sType

LAYOUT$pNext

public static final AddressLayout LAYOUT$pNext

LAYOUT$waitSemaphoreValueCount

public static final ValueLayout.OfInt LAYOUT$waitSemaphoreValueCount

LAYOUT$pWaitSemaphoreValues

public static final AddressLayout LAYOUT$pWaitSemaphoreValues

LAYOUT$signalSemaphoreValueCount

public static final ValueLayout.OfInt LAYOUT$signalSemaphoreValueCount

LAYOUT$pSignalSemaphoreValues

public static final AddressLayout LAYOUT$pSignalSemaphoreValues

SIZE$sType

public static final long SIZE$sType

SIZE$pNext

public static final long SIZE$pNext

SIZE$waitSemaphoreValueCount

public static final long SIZE$waitSemaphoreValueCount

SIZE$pWaitSemaphoreValues

public static final long SIZE$pWaitSemaphoreValues

SIZE$signalSemaphoreValueCount

public static final long SIZE$signalSemaphoreValueCount

SIZE$pSignalSemaphoreValues

public static final long SIZE$pSignalSemaphoreValues

OFFSET$sType

public static final long OFFSET$sType

OFFSET$pNext

public static final long OFFSET$pNext

OFFSET$waitSemaphoreValueCount

public static final long OFFSET$waitSemaphoreValueCount

OFFSET$pWaitSemaphoreValues

public static final long OFFSET$pWaitSemaphoreValues

OFFSET$signalSemaphoreValueCount

public static final long OFFSET$signalSemaphoreValueCount

OFFSET$pSignalSemaphoreValues

public static final long OFFSET$pSignalSemaphoreValues

Constructor Details

VkTimelineSemaphoreSubmitInfo

public VkTimelineSemaphoreSubmitInfo(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a VkTimelineSemaphoreSubmitInfo record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static VkTimelineSemaphoreSubmitInfo allocate(Arena arena)

allocate

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

clone

public static VkTimelineSemaphoreSubmitInfo clone(Arena arena,
 VkTimelineSemaphoreSubmitInfo src)

autoInit

public void autoInit()

sType

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

sType

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

pNext

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

pNext

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

pNext

public VkTimelineSemaphoreSubmitInfo pNext(@Nullable
 @Nullable IPointer pointer)

waitSemaphoreValueCount

@Unsigned
public int waitSemaphoreValueCount()

waitSemaphoreValueCount

public VkTimelineSemaphoreSubmitInfo waitSemaphoreValueCount(@Unsigned
 int value)

pWaitSemaphoreValues

@Nullable
@Unsigned
public @Nullable LongPtr pWaitSemaphoreValues()

Note: the returned LongPtr does not have correct LongPtr.size() property. It's up to user to track the size of the buffer, and use LongPtr.reinterpret(long) to set the size before actually reading from or writing to the buffer.

pWaitSemaphoreValues

public VkTimelineSemaphoreSubmitInfo pWaitSemaphoreValues(@Nullable @Unsigned
 @Nullable LongPtr value)

pWaitSemaphoreValuesRaw

@Pointer(comment="uint64_t*")
@NotNull
public @NotNull MemorySegment pWaitSemaphoreValuesRaw()

pWaitSemaphoreValuesRaw

public void pWaitSemaphoreValuesRaw(@Pointer(comment="uint64_t*") @NotNull
 @NotNull MemorySegment value)

signalSemaphoreValueCount

@Unsigned
public int signalSemaphoreValueCount()

signalSemaphoreValueCount

public VkTimelineSemaphoreSubmitInfo signalSemaphoreValueCount(@Unsigned
 int value)

pSignalSemaphoreValues

@Nullable
@Unsigned
public @Nullable LongPtr pSignalSemaphoreValues()

Note: the returned LongPtr does not have correct LongPtr.size() property. It's up to user to track the size of the buffer, and use LongPtr.reinterpret(long) to set the size before actually reading from or writing to the buffer.

pSignalSemaphoreValues

public VkTimelineSemaphoreSubmitInfo pSignalSemaphoreValues(@Nullable @Unsigned
 @Nullable LongPtr value)

pSignalSemaphoreValuesRaw

@Pointer(comment="uint64_t*")
@NotNull
public @NotNull MemorySegment pSignalSemaphoreValuesRaw()

pSignalSemaphoreValuesRaw

public void pSignalSemaphoreValuesRaw(@Pointer(comment="uint64_t*") @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