Record Class VkSemaphoreSignalInfo

java.lang.Object

java.lang.Record

club.doki7.vulkan.datatype.VkSemaphoreSignalInfo

All Implemented Interfaces:

IPointer, IVkSemaphoreSignalInfo

@ValueBasedCandidate
@UnsafeConstructor
public record VkSemaphoreSignalInfo(@NotNull MemorySegment segment)
extends Record
implements IVkSemaphoreSignalInfo

Represents a pointer to a VkSemaphoreSignalInfo structure in native memory.

Structure

typedef struct VkSemaphoreSignalInfo {
    VkStructureType sType;
    void const* pNext; // optional
    VkSemaphore semaphore;
    uint64_t value;
} VkSemaphoreSignalInfo;

Auto initialization

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

• sType = VK_STRUCTURE_TYPE_SEMAPHORE_SIGNAL_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:

• VkSemaphoreSignalInfo

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	VkSemaphoreSignalInfo.Ptr	Represents a pointer to / an array of VkSemaphoreSignalInfo 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$semaphore
static final ValueLayout.OfInt	LAYOUT$sType
static final ValueLayout.OfLong	LAYOUT$value
static final long	OFFSET$pNext
static final long	OFFSET$semaphore
static final long	OFFSET$sType
static final long	OFFSET$value
static final MemoryLayout.PathElement	PATH$pNext
static final MemoryLayout.PathElement	PATH$semaphore
static final MemoryLayout.PathElement	PATH$sType
static final MemoryLayout.PathElement	PATH$value
static final long	SIZE$pNext
static final long	SIZE$semaphore
static final long	SIZE$sType
static final long	SIZE$value

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static VkSemaphoreSignalInfo	allocate(Arena arena)
static VkSemaphoreSignalInfo.Ptr	allocate(Arena arena, long count)
void	autoInit()
static VkSemaphoreSignalInfo	clone(Arena arena, VkSemaphoreSignalInfo 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.
MemorySegment	pNext()
VkSemaphoreSignalInfo	pNext(@Nullable IPointer pointer)
void	pNext(MemorySegment value)
@NotNull MemorySegment	segment()	Returns the value of the segment record component.
@Nullable VkSemaphore	semaphore()
VkSemaphoreSignalInfo	semaphore(@Nullable VkSemaphore value)
int	sType()
VkSemaphoreSignalInfo	sType(int value)
final String	toString()	Returns a string representation of this record class.
long	value()
VkSemaphoreSignalInfo	value(long 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$semaphore

public static final MemoryLayout.PathElement PATH$semaphore

PATH$value

public static final MemoryLayout.PathElement PATH$value

LAYOUT$sType

public static final ValueLayout.OfInt LAYOUT$sType

LAYOUT$pNext

public static final AddressLayout LAYOUT$pNext

LAYOUT$semaphore

public static final AddressLayout LAYOUT$semaphore

LAYOUT$value

public static final ValueLayout.OfLong LAYOUT$value

SIZE$sType

public static final long SIZE$sType

SIZE$pNext

public static final long SIZE$pNext

SIZE$semaphore

public static final long SIZE$semaphore

SIZE$value

public static final long SIZE$value

OFFSET$sType

public static final long OFFSET$sType

OFFSET$pNext

public static final long OFFSET$pNext

OFFSET$semaphore

public static final long OFFSET$semaphore

OFFSET$value

public static final long OFFSET$value

Constructor Details

VkSemaphoreSignalInfo

public VkSemaphoreSignalInfo(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a VkSemaphoreSignalInfo record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static VkSemaphoreSignalInfo allocate(Arena arena)

allocate

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

clone

public static VkSemaphoreSignalInfo clone(Arena arena,
 VkSemaphoreSignalInfo src)

autoInit

public void autoInit()

sType

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

sType

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

pNext

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

pNext

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

pNext

public VkSemaphoreSignalInfo pNext(@Nullable
 @Nullable IPointer pointer)

semaphore

@Nullable
public @Nullable VkSemaphore semaphore()

semaphore

public VkSemaphoreSignalInfo semaphore(@Nullable
 @Nullable VkSemaphore value)

value

@Unsigned
public long value()

value

public VkSemaphoreSignalInfo value(@Unsigned
 long 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