Record Class VkSubmitInfo2

java.lang.Object

java.lang.Record

club.doki7.vulkan.datatype.VkSubmitInfo2

All Implemented Interfaces:

IPointer, IVkSubmitInfo2

@ValueBasedCandidate
@UnsafeConstructor
public record VkSubmitInfo2(@NotNull MemorySegment segment)
extends Record
implements IVkSubmitInfo2

Represents a pointer to a VkSubmitInfo2 structure in native memory.

Structure

typedef struct VkSubmitInfo2 {
    VkStructureType sType;
    void const* pNext; // optional
    VkSubmitFlags flags; // optional
    uint32_t waitSemaphoreInfoCount; // optional
    VkSemaphoreSubmitInfo const* pWaitSemaphoreInfos; // optional
    uint32_t commandBufferInfoCount; // optional
    VkCommandBufferSubmitInfo const* pCommandBufferInfos; // optional
    uint32_t signalSemaphoreInfoCount; // optional
    VkSemaphoreSubmitInfo const* pSignalSemaphoreInfos; // optional
} VkSubmitInfo2;

Auto initialization

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

• sType = VK_STRUCTURE_TYPE_SUBMIT_INFO_2

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:

• VkSubmitInfo2

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	VkSubmitInfo2.Ptr	Represents a pointer to / an array of VkSubmitInfo2 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$commandBufferInfoCount
static final ValueLayout.OfInt	LAYOUT$flags
static final AddressLayout	LAYOUT$pCommandBufferInfos
static final AddressLayout	LAYOUT$pNext
static final AddressLayout	LAYOUT$pSignalSemaphoreInfos
static final AddressLayout	LAYOUT$pWaitSemaphoreInfos
static final ValueLayout.OfInt	LAYOUT$signalSemaphoreInfoCount
static final ValueLayout.OfInt	LAYOUT$sType
static final ValueLayout.OfInt	LAYOUT$waitSemaphoreInfoCount
static final long	OFFSET$commandBufferInfoCount
static final long	OFFSET$flags
static final long	OFFSET$pCommandBufferInfos
static final long	OFFSET$pNext
static final long	OFFSET$pSignalSemaphoreInfos
static final long	OFFSET$pWaitSemaphoreInfos
static final long	OFFSET$signalSemaphoreInfoCount
static final long	OFFSET$sType
static final long	OFFSET$waitSemaphoreInfoCount
static final MemoryLayout.PathElement	PATH$commandBufferInfoCount
static final MemoryLayout.PathElement	PATH$flags
static final MemoryLayout.PathElement	PATH$pCommandBufferInfos
static final MemoryLayout.PathElement	PATH$pNext
static final MemoryLayout.PathElement	PATH$pSignalSemaphoreInfos
static final MemoryLayout.PathElement	PATH$pWaitSemaphoreInfos
static final MemoryLayout.PathElement	PATH$signalSemaphoreInfoCount
static final MemoryLayout.PathElement	PATH$sType
static final MemoryLayout.PathElement	PATH$waitSemaphoreInfoCount
static final long	SIZE$commandBufferInfoCount
static final long	SIZE$flags
static final long	SIZE$pCommandBufferInfos
static final long	SIZE$pNext
static final long	SIZE$pSignalSemaphoreInfos
static final long	SIZE$pWaitSemaphoreInfos
static final long	SIZE$signalSemaphoreInfoCount
static final long	SIZE$sType
static final long	SIZE$waitSemaphoreInfoCount

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static VkSubmitInfo2	allocate(Arena arena)
static VkSubmitInfo2.Ptr	allocate(Arena arena, long count)
void	autoInit()
static VkSubmitInfo2	clone(Arena arena, VkSubmitInfo2 src)
int	commandBufferInfoCount()
VkSubmitInfo2	commandBufferInfoCount(int value)
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
int	flags()
VkSubmitInfo2	flags(int value)
final int	hashCode()	Returns a hash code value for this object.
@Nullable VkCommandBufferSubmitInfo	pCommandBufferInfos()
VkCommandBufferSubmitInfo.Ptr	pCommandBufferInfos(int assumedCount)
VkSubmitInfo2	pCommandBufferInfos(@Nullable IVkCommandBufferSubmitInfo value)
@NotNull MemorySegment	pCommandBufferInfosRaw()
void	pCommandBufferInfosRaw(@NotNull MemorySegment value)
@NotNull MemorySegment	pNext()
VkSubmitInfo2	pNext(@Nullable IPointer pointer)
VkSubmitInfo2	pNext(@NotNull MemorySegment value)
@Nullable VkSemaphoreSubmitInfo	pSignalSemaphoreInfos()
VkSemaphoreSubmitInfo.Ptr	pSignalSemaphoreInfos(int assumedCount)
VkSubmitInfo2	pSignalSemaphoreInfos(@Nullable IVkSemaphoreSubmitInfo value)
@NotNull MemorySegment	pSignalSemaphoreInfosRaw()
void	pSignalSemaphoreInfosRaw(@NotNull MemorySegment value)
@Nullable VkSemaphoreSubmitInfo	pWaitSemaphoreInfos()
VkSemaphoreSubmitInfo.Ptr	pWaitSemaphoreInfos(int assumedCount)
VkSubmitInfo2	pWaitSemaphoreInfos(@Nullable IVkSemaphoreSubmitInfo value)
@NotNull MemorySegment	pWaitSemaphoreInfosRaw()
void	pWaitSemaphoreInfosRaw(@NotNull MemorySegment value)
@NotNull MemorySegment	segment()	Returns the value of the segment record component.
int	signalSemaphoreInfoCount()
VkSubmitInfo2	signalSemaphoreInfoCount(int value)
int	sType()
VkSubmitInfo2	sType(int value)
final String	toString()	Returns a string representation of this record class.
int	waitSemaphoreInfoCount()
VkSubmitInfo2	waitSemaphoreInfoCount(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$flags

public static final MemoryLayout.PathElement PATH$flags

PATH$waitSemaphoreInfoCount

public static final MemoryLayout.PathElement PATH$waitSemaphoreInfoCount

PATH$pWaitSemaphoreInfos

public static final MemoryLayout.PathElement PATH$pWaitSemaphoreInfos

PATH$commandBufferInfoCount

public static final MemoryLayout.PathElement PATH$commandBufferInfoCount

PATH$pCommandBufferInfos

public static final MemoryLayout.PathElement PATH$pCommandBufferInfos

PATH$signalSemaphoreInfoCount

public static final MemoryLayout.PathElement PATH$signalSemaphoreInfoCount

PATH$pSignalSemaphoreInfos

public static final MemoryLayout.PathElement PATH$pSignalSemaphoreInfos

LAYOUT$sType

public static final ValueLayout.OfInt LAYOUT$sType

LAYOUT$pNext

public static final AddressLayout LAYOUT$pNext

LAYOUT$flags

public static final ValueLayout.OfInt LAYOUT$flags

LAYOUT$waitSemaphoreInfoCount

public static final ValueLayout.OfInt LAYOUT$waitSemaphoreInfoCount

LAYOUT$pWaitSemaphoreInfos

public static final AddressLayout LAYOUT$pWaitSemaphoreInfos

LAYOUT$commandBufferInfoCount

public static final ValueLayout.OfInt LAYOUT$commandBufferInfoCount

LAYOUT$pCommandBufferInfos

public static final AddressLayout LAYOUT$pCommandBufferInfos

LAYOUT$signalSemaphoreInfoCount

public static final ValueLayout.OfInt LAYOUT$signalSemaphoreInfoCount

LAYOUT$pSignalSemaphoreInfos

public static final AddressLayout LAYOUT$pSignalSemaphoreInfos

SIZE$sType

public static final long SIZE$sType

SIZE$pNext

public static final long SIZE$pNext

SIZE$flags

public static final long SIZE$flags

SIZE$waitSemaphoreInfoCount

public static final long SIZE$waitSemaphoreInfoCount

SIZE$pWaitSemaphoreInfos

public static final long SIZE$pWaitSemaphoreInfos

SIZE$commandBufferInfoCount

public static final long SIZE$commandBufferInfoCount

SIZE$pCommandBufferInfos

public static final long SIZE$pCommandBufferInfos

SIZE$signalSemaphoreInfoCount

public static final long SIZE$signalSemaphoreInfoCount

SIZE$pSignalSemaphoreInfos

public static final long SIZE$pSignalSemaphoreInfos

OFFSET$sType

public static final long OFFSET$sType

OFFSET$pNext

public static final long OFFSET$pNext

OFFSET$flags

public static final long OFFSET$flags

OFFSET$waitSemaphoreInfoCount

public static final long OFFSET$waitSemaphoreInfoCount

OFFSET$pWaitSemaphoreInfos

public static final long OFFSET$pWaitSemaphoreInfos

OFFSET$commandBufferInfoCount

public static final long OFFSET$commandBufferInfoCount

OFFSET$pCommandBufferInfos

public static final long OFFSET$pCommandBufferInfos

OFFSET$signalSemaphoreInfoCount

public static final long OFFSET$signalSemaphoreInfoCount

OFFSET$pSignalSemaphoreInfos

public static final long OFFSET$pSignalSemaphoreInfos

Constructor Details

VkSubmitInfo2

public VkSubmitInfo2(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a VkSubmitInfo2 record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static VkSubmitInfo2 allocate(Arena arena)

allocate

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

clone

public static VkSubmitInfo2 clone(Arena arena,
 VkSubmitInfo2 src)

autoInit

public void autoInit()

sType

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

sType

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

pNext

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

pNext

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

pNext

public VkSubmitInfo2 pNext(@Nullable
 @Nullable IPointer pointer)

flags

@Bitmask(VkSubmitFlags.class)
public int flags()

flags

public VkSubmitInfo2 flags(@Bitmask(VkSubmitFlags.class)
 int value)

waitSemaphoreInfoCount

@Unsigned
public int waitSemaphoreInfoCount()

waitSemaphoreInfoCount

public VkSubmitInfo2 waitSemaphoreInfoCount(@Unsigned
 int value)

pWaitSemaphoreInfos

public VkSubmitInfo2 pWaitSemaphoreInfos(@Nullable
 @Nullable IVkSemaphoreSubmitInfo value)

pWaitSemaphoreInfos

@Unsafe
@Nullable
public VkSemaphoreSubmitInfo.Ptr pWaitSemaphoreInfos(int assumedCount)

pWaitSemaphoreInfos

@Nullable
public @Nullable VkSemaphoreSubmitInfo pWaitSemaphoreInfos()

pWaitSemaphoreInfosRaw

@Pointer(target=VkSemaphoreSubmitInfo.class)
@NotNull
public @NotNull MemorySegment pWaitSemaphoreInfosRaw()

pWaitSemaphoreInfosRaw

public void pWaitSemaphoreInfosRaw(@Pointer(target=VkSemaphoreSubmitInfo.class) @NotNull
 @NotNull MemorySegment value)

commandBufferInfoCount

@Unsigned
public int commandBufferInfoCount()

commandBufferInfoCount

public VkSubmitInfo2 commandBufferInfoCount(@Unsigned
 int value)

pCommandBufferInfos

public VkSubmitInfo2 pCommandBufferInfos(@Nullable
 @Nullable IVkCommandBufferSubmitInfo value)

pCommandBufferInfos

@Unsafe
@Nullable
public VkCommandBufferSubmitInfo.Ptr pCommandBufferInfos(int assumedCount)

pCommandBufferInfos

@Nullable
public @Nullable VkCommandBufferSubmitInfo pCommandBufferInfos()

pCommandBufferInfosRaw

@Pointer(target=VkCommandBufferSubmitInfo.class)
@NotNull
public @NotNull MemorySegment pCommandBufferInfosRaw()

pCommandBufferInfosRaw

public void pCommandBufferInfosRaw(@Pointer(target=VkCommandBufferSubmitInfo.class) @NotNull
 @NotNull MemorySegment value)

signalSemaphoreInfoCount

@Unsigned
public int signalSemaphoreInfoCount()

signalSemaphoreInfoCount

public VkSubmitInfo2 signalSemaphoreInfoCount(@Unsigned
 int value)

pSignalSemaphoreInfos

public VkSubmitInfo2 pSignalSemaphoreInfos(@Nullable
 @Nullable IVkSemaphoreSubmitInfo value)

pSignalSemaphoreInfos

@Unsafe
@Nullable
public VkSemaphoreSubmitInfo.Ptr pSignalSemaphoreInfos(int assumedCount)

pSignalSemaphoreInfos

@Nullable
public @Nullable VkSemaphoreSubmitInfo pSignalSemaphoreInfos()

pSignalSemaphoreInfosRaw

@Pointer(target=VkSemaphoreSubmitInfo.class)
@NotNull
public @NotNull MemorySegment pSignalSemaphoreInfosRaw()

pSignalSemaphoreInfosRaw

public void pSignalSemaphoreInfosRaw(@Pointer(target=VkSemaphoreSubmitInfo.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