Record Class VkSemaphoreSubmitInfo

java.lang.Object

java.lang.Record

club.doki7.vulkan.datatype.VkSemaphoreSubmitInfo

All Implemented Interfaces:

IPointer, IVkSemaphoreSubmitInfo

@ValueBasedCandidate
@UnsafeConstructor
public record VkSemaphoreSubmitInfo(@NotNull MemorySegment segment)
extends Record
implements IVkSemaphoreSubmitInfo

Represents a pointer to a VkSemaphoreSubmitInfo structure in native memory.

Structure

typedef struct VkSemaphoreSubmitInfo {
    VkStructureType sType;
    void const* pNext; // optional
    VkSemaphore semaphore;
    uint64_t value;
    VkPipelineStageFlags2 stageMask; // optional
    uint32_t deviceIndex;
} VkSemaphoreSubmitInfo;

Auto initialization

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

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

• VkSemaphoreSubmitInfo

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

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

Method Summary

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

PATH$stageMask

public static final MemoryLayout.PathElement PATH$stageMask

PATH$deviceIndex

public static final MemoryLayout.PathElement PATH$deviceIndex

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

LAYOUT$stageMask

public static final ValueLayout.OfLong LAYOUT$stageMask

LAYOUT$deviceIndex

public static final ValueLayout.OfInt LAYOUT$deviceIndex

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

SIZE$stageMask

public static final long SIZE$stageMask

SIZE$deviceIndex

public static final long SIZE$deviceIndex

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

OFFSET$stageMask

public static final long OFFSET$stageMask

OFFSET$deviceIndex

public static final long OFFSET$deviceIndex

Constructor Details

VkSemaphoreSubmitInfo

public VkSemaphoreSubmitInfo(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a VkSemaphoreSubmitInfo record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static VkSemaphoreSubmitInfo allocate(Arena arena)

allocate

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

clone

public static VkSemaphoreSubmitInfo clone(Arena arena,
 VkSemaphoreSubmitInfo src)

autoInit

public void autoInit()

sType

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

sType

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

pNext

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

pNext

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

pNext

public VkSemaphoreSubmitInfo pNext(@Nullable
 @Nullable IPointer pointer)

semaphore

@Nullable
public @Nullable VkSemaphore semaphore()

semaphore

public VkSemaphoreSubmitInfo semaphore(@Nullable
 @Nullable VkSemaphore value)

value

@Unsigned
public long value()

value

public VkSemaphoreSubmitInfo value(@Unsigned
 long value)

stageMask

@Bitmask(VkPipelineStageFlags2.class)
public long stageMask()

stageMask

public VkSemaphoreSubmitInfo stageMask(@Bitmask(VkPipelineStageFlags2.class)
 long value)

deviceIndex

@Unsigned
public int deviceIndex()

deviceIndex

public VkSemaphoreSubmitInfo deviceIndex(@Unsigned
 int 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