Record Class VkSubmitInfo

java.lang.Object

java.lang.Record

club.doki7.vulkan.datatype.VkSubmitInfo

All Implemented Interfaces:

IPointer, IVkSubmitInfo

@ValueBasedCandidate
@UnsafeConstructor
public record VkSubmitInfo(@NotNull MemorySegment segment)
extends Record
implements IVkSubmitInfo

Represents a pointer to a VkSubmitInfo structure in native memory.

Structure

typedef struct VkSubmitInfo {
    VkStructureType sType;
    void const* pNext; // optional
    uint32_t waitSemaphoreCount; // optional
    VkSemaphore const* pWaitSemaphores; // optional
    VkPipelineStageFlags const* pWaitDstStageMask; // optional
    uint32_t commandBufferCount; // optional
    VkCommandBuffer const* pCommandBuffers; // optional
    uint32_t signalSemaphoreCount; // optional
    VkSemaphore const* pSignalSemaphores; // optional
} VkSubmitInfo;

Auto initialization

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

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

• VkSubmitInfo

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	VkSubmitInfo.Ptr	Represents a pointer to / an array of VkSubmitInfo 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$commandBufferCount
static final AddressLayout	LAYOUT$pCommandBuffers
static final AddressLayout	LAYOUT$pNext
static final AddressLayout	LAYOUT$pSignalSemaphores
static final AddressLayout	LAYOUT$pWaitDstStageMask
static final AddressLayout	LAYOUT$pWaitSemaphores
static final ValueLayout.OfInt	LAYOUT$signalSemaphoreCount
static final ValueLayout.OfInt	LAYOUT$sType
static final ValueLayout.OfInt	LAYOUT$waitSemaphoreCount
static final long	OFFSET$commandBufferCount
static final long	OFFSET$pCommandBuffers
static final long	OFFSET$pNext
static final long	OFFSET$pSignalSemaphores
static final long	OFFSET$pWaitDstStageMask
static final long	OFFSET$pWaitSemaphores
static final long	OFFSET$signalSemaphoreCount
static final long	OFFSET$sType
static final long	OFFSET$waitSemaphoreCount
static final MemoryLayout.PathElement	PATH$commandBufferCount
static final MemoryLayout.PathElement	PATH$pCommandBuffers
static final MemoryLayout.PathElement	PATH$pNext
static final MemoryLayout.PathElement	PATH$pSignalSemaphores
static final MemoryLayout.PathElement	PATH$pWaitDstStageMask
static final MemoryLayout.PathElement	PATH$pWaitSemaphores
static final MemoryLayout.PathElement	PATH$signalSemaphoreCount
static final MemoryLayout.PathElement	PATH$sType
static final MemoryLayout.PathElement	PATH$waitSemaphoreCount
static final long	SIZE$commandBufferCount
static final long	SIZE$pCommandBuffers
static final long	SIZE$pNext
static final long	SIZE$pSignalSemaphores
static final long	SIZE$pWaitDstStageMask
static final long	SIZE$pWaitSemaphores
static final long	SIZE$signalSemaphoreCount
static final long	SIZE$sType
static final long	SIZE$waitSemaphoreCount

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static VkSubmitInfo	allocate(Arena arena)
static VkSubmitInfo.Ptr	allocate(Arena arena, long count)
void	autoInit()
static VkSubmitInfo	clone(Arena arena, VkSubmitInfo src)
int	commandBufferCount()
VkSubmitInfo	commandBufferCount(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.
VkCommandBuffer.Ptr	pCommandBuffers()	Note: the returned VkCommandBuffer.Ptr does not have correct VkCommandBuffer.Ptr.size() property.
VkSubmitInfo	pCommandBuffers(VkCommandBuffer.Ptr value)
@NotNull MemorySegment	pCommandBuffersRaw()
void	pCommandBuffersRaw(@NotNull MemorySegment value)
@NotNull MemorySegment	pNext()
VkSubmitInfo	pNext(@Nullable IPointer pointer)
VkSubmitInfo	pNext(@NotNull MemorySegment value)
VkSemaphore.Ptr	pSignalSemaphores()	Note: the returned VkSemaphore.Ptr does not have correct VkSemaphore.Ptr.size() property.
VkSubmitInfo	pSignalSemaphores(VkSemaphore.Ptr value)
@NotNull MemorySegment	pSignalSemaphoresRaw()
void	pSignalSemaphoresRaw(@NotNull MemorySegment value)
@Nullable IntPtr	pWaitDstStageMask()	Note: the returned IntPtr does not have correct IntPtr.size() property.
VkSubmitInfo	pWaitDstStageMask(@Nullable IntPtr value)
@NotNull MemorySegment	pWaitDstStageMaskRaw()
void	pWaitDstStageMaskRaw(@NotNull MemorySegment value)
VkSemaphore.Ptr	pWaitSemaphores()	Note: the returned VkSemaphore.Ptr does not have correct VkSemaphore.Ptr.size() property.
VkSubmitInfo	pWaitSemaphores(VkSemaphore.Ptr value)
@NotNull MemorySegment	pWaitSemaphoresRaw()
void	pWaitSemaphoresRaw(@NotNull MemorySegment value)
@NotNull MemorySegment	segment()	Returns the value of the segment record component.
int	signalSemaphoreCount()
VkSubmitInfo	signalSemaphoreCount(int value)
int	sType()
VkSubmitInfo	sType(int value)
final String	toString()	Returns a string representation of this record class.
int	waitSemaphoreCount()
VkSubmitInfo	waitSemaphoreCount(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$waitSemaphoreCount

public static final MemoryLayout.PathElement PATH$waitSemaphoreCount

PATH$pWaitSemaphores

public static final MemoryLayout.PathElement PATH$pWaitSemaphores

PATH$pWaitDstStageMask

public static final MemoryLayout.PathElement PATH$pWaitDstStageMask

PATH$commandBufferCount

public static final MemoryLayout.PathElement PATH$commandBufferCount

PATH$pCommandBuffers

public static final MemoryLayout.PathElement PATH$pCommandBuffers

PATH$signalSemaphoreCount

public static final MemoryLayout.PathElement PATH$signalSemaphoreCount

PATH$pSignalSemaphores

public static final MemoryLayout.PathElement PATH$pSignalSemaphores

LAYOUT$sType

public static final ValueLayout.OfInt LAYOUT$sType

LAYOUT$pNext

public static final AddressLayout LAYOUT$pNext

LAYOUT$waitSemaphoreCount

public static final ValueLayout.OfInt LAYOUT$waitSemaphoreCount

LAYOUT$pWaitSemaphores

public static final AddressLayout LAYOUT$pWaitSemaphores

LAYOUT$pWaitDstStageMask

public static final AddressLayout LAYOUT$pWaitDstStageMask

LAYOUT$commandBufferCount

public static final ValueLayout.OfInt LAYOUT$commandBufferCount

LAYOUT$pCommandBuffers

public static final AddressLayout LAYOUT$pCommandBuffers

LAYOUT$signalSemaphoreCount

public static final ValueLayout.OfInt LAYOUT$signalSemaphoreCount

LAYOUT$pSignalSemaphores

public static final AddressLayout LAYOUT$pSignalSemaphores

SIZE$sType

public static final long SIZE$sType

SIZE$pNext

public static final long SIZE$pNext

SIZE$waitSemaphoreCount

public static final long SIZE$waitSemaphoreCount

SIZE$pWaitSemaphores

public static final long SIZE$pWaitSemaphores

SIZE$pWaitDstStageMask

public static final long SIZE$pWaitDstStageMask

SIZE$commandBufferCount

public static final long SIZE$commandBufferCount

SIZE$pCommandBuffers

public static final long SIZE$pCommandBuffers

SIZE$signalSemaphoreCount

public static final long SIZE$signalSemaphoreCount

SIZE$pSignalSemaphores

public static final long SIZE$pSignalSemaphores

OFFSET$sType

public static final long OFFSET$sType

OFFSET$pNext

public static final long OFFSET$pNext

OFFSET$waitSemaphoreCount

public static final long OFFSET$waitSemaphoreCount

OFFSET$pWaitSemaphores

public static final long OFFSET$pWaitSemaphores

OFFSET$pWaitDstStageMask

public static final long OFFSET$pWaitDstStageMask

OFFSET$commandBufferCount

public static final long OFFSET$commandBufferCount

OFFSET$pCommandBuffers

public static final long OFFSET$pCommandBuffers

OFFSET$signalSemaphoreCount

public static final long OFFSET$signalSemaphoreCount

OFFSET$pSignalSemaphores

public static final long OFFSET$pSignalSemaphores

Constructor Details

VkSubmitInfo

public VkSubmitInfo(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a VkSubmitInfo record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static VkSubmitInfo allocate(Arena arena)

allocate

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

clone

public static VkSubmitInfo clone(Arena arena,
 VkSubmitInfo src)

autoInit

public void autoInit()

sType

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

sType

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

pNext

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

pNext

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

pNext

public VkSubmitInfo pNext(@Nullable
 @Nullable IPointer pointer)

waitSemaphoreCount

@Unsigned
public int waitSemaphoreCount()

waitSemaphoreCount

public VkSubmitInfo waitSemaphoreCount(@Unsigned
 int value)

pWaitSemaphores

@Nullable
public VkSemaphore.Ptr pWaitSemaphores()

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

pWaitSemaphores

public VkSubmitInfo pWaitSemaphores(@Nullable
 VkSemaphore.Ptr value)

pWaitSemaphoresRaw

@Pointer(target=VkSemaphore.class)
@NotNull
public @NotNull MemorySegment pWaitSemaphoresRaw()

pWaitSemaphoresRaw

public void pWaitSemaphoresRaw(@Pointer(target=VkSemaphore.class) @NotNull
 @NotNull MemorySegment value)

pWaitDstStageMask

@Nullable
@Bitmask(VkPipelineStageFlags.class)
public @Nullable IntPtr pWaitDstStageMask()

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

pWaitDstStageMask

public VkSubmitInfo pWaitDstStageMask(@Nullable @Bitmask(VkPipelineStageFlags.class)
 @Nullable IntPtr value)

pWaitDstStageMaskRaw

@Pointer(target=VkPipelineStageFlags.class)
@NotNull
public @NotNull MemorySegment pWaitDstStageMaskRaw()

pWaitDstStageMaskRaw

public void pWaitDstStageMaskRaw(@Pointer(target=VkPipelineStageFlags.class) @NotNull
 @NotNull MemorySegment value)

commandBufferCount

@Unsigned
public int commandBufferCount()

commandBufferCount

public VkSubmitInfo commandBufferCount(@Unsigned
 int value)

pCommandBuffers

@Nullable
public VkCommandBuffer.Ptr pCommandBuffers()

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

pCommandBuffers

public VkSubmitInfo pCommandBuffers(@Nullable
 VkCommandBuffer.Ptr value)

pCommandBuffersRaw

@Pointer(target=VkCommandBuffer.class)
@NotNull
public @NotNull MemorySegment pCommandBuffersRaw()

pCommandBuffersRaw

public void pCommandBuffersRaw(@Pointer(target=VkCommandBuffer.class) @NotNull
 @NotNull MemorySegment value)

signalSemaphoreCount

@Unsigned
public int signalSemaphoreCount()

signalSemaphoreCount

public VkSubmitInfo signalSemaphoreCount(@Unsigned
 int value)

pSignalSemaphores

@Nullable
public VkSemaphore.Ptr pSignalSemaphores()

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

pSignalSemaphores

public VkSubmitInfo pSignalSemaphores(@Nullable
 VkSemaphore.Ptr value)

pSignalSemaphoresRaw

@Pointer(target=VkSemaphore.class)
@NotNull
public @NotNull MemorySegment pSignalSemaphoresRaw()

pSignalSemaphoresRaw

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