Record Class VkDeviceGroupSubmitInfo

java.lang.Object

java.lang.Record

club.doki7.vulkan.datatype.VkDeviceGroupSubmitInfo

All Implemented Interfaces:

IPointer, IVkDeviceGroupSubmitInfo

@ValueBasedCandidate
@UnsafeConstructor
public record VkDeviceGroupSubmitInfo(@NotNull MemorySegment segment)
extends Record
implements IVkDeviceGroupSubmitInfo

Represents a pointer to a VkDeviceGroupSubmitInfo structure in native memory.

Structure

typedef struct VkDeviceGroupSubmitInfo {
    VkStructureType sType;
    void const* pNext; // optional
    uint32_t waitSemaphoreCount; // optional
    uint32_t const* pWaitSemaphoreDeviceIndices; // optional
    uint32_t commandBufferCount; // optional
    uint32_t const* pCommandBufferDeviceMasks; // optional
    uint32_t signalSemaphoreCount; // optional
    uint32_t const* pSignalSemaphoreDeviceIndices; // optional
} VkDeviceGroupSubmitInfo;

Auto initialization

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

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

• VkDeviceGroupSubmitInfo

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	VkDeviceGroupSubmitInfo.Ptr	Represents a pointer to / an array of VkDeviceGroupSubmitInfo 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$pCommandBufferDeviceMasks
static final AddressLayout	LAYOUT$pNext
static final AddressLayout	LAYOUT$pSignalSemaphoreDeviceIndices
static final AddressLayout	LAYOUT$pWaitSemaphoreDeviceIndices
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$pCommandBufferDeviceMasks
static final long	OFFSET$pNext
static final long	OFFSET$pSignalSemaphoreDeviceIndices
static final long	OFFSET$pWaitSemaphoreDeviceIndices
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$pCommandBufferDeviceMasks
static final MemoryLayout.PathElement	PATH$pNext
static final MemoryLayout.PathElement	PATH$pSignalSemaphoreDeviceIndices
static final MemoryLayout.PathElement	PATH$pWaitSemaphoreDeviceIndices
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$pCommandBufferDeviceMasks
static final long	SIZE$pNext
static final long	SIZE$pSignalSemaphoreDeviceIndices
static final long	SIZE$pWaitSemaphoreDeviceIndices
static final long	SIZE$signalSemaphoreCount
static final long	SIZE$sType
static final long	SIZE$waitSemaphoreCount

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static VkDeviceGroupSubmitInfo	allocate(Arena arena)
static VkDeviceGroupSubmitInfo.Ptr	allocate(Arena arena, long count)
void	autoInit()
static VkDeviceGroupSubmitInfo	clone(Arena arena, VkDeviceGroupSubmitInfo src)
int	commandBufferCount()
VkDeviceGroupSubmitInfo	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.
@Nullable IntPtr	pCommandBufferDeviceMasks()	Note: the returned IntPtr does not have correct IntPtr.size() property.
VkDeviceGroupSubmitInfo	pCommandBufferDeviceMasks(@Nullable IntPtr value)
@NotNull MemorySegment	pCommandBufferDeviceMasksRaw()
void	pCommandBufferDeviceMasksRaw(@NotNull MemorySegment value)
@NotNull MemorySegment	pNext()
VkDeviceGroupSubmitInfo	pNext(@Nullable IPointer pointer)
VkDeviceGroupSubmitInfo	pNext(@NotNull MemorySegment value)
@Nullable IntPtr	pSignalSemaphoreDeviceIndices()	Note: the returned IntPtr does not have correct IntPtr.size() property.
VkDeviceGroupSubmitInfo	pSignalSemaphoreDeviceIndices(@Nullable IntPtr value)
@NotNull MemorySegment	pSignalSemaphoreDeviceIndicesRaw()
void	pSignalSemaphoreDeviceIndicesRaw(@NotNull MemorySegment value)
@Nullable IntPtr	pWaitSemaphoreDeviceIndices()	Note: the returned IntPtr does not have correct IntPtr.size() property.
VkDeviceGroupSubmitInfo	pWaitSemaphoreDeviceIndices(@Nullable IntPtr value)
@NotNull MemorySegment	pWaitSemaphoreDeviceIndicesRaw()
void	pWaitSemaphoreDeviceIndicesRaw(@NotNull MemorySegment value)
@NotNull MemorySegment	segment()	Returns the value of the segment record component.
int	signalSemaphoreCount()
VkDeviceGroupSubmitInfo	signalSemaphoreCount(int value)
int	sType()
VkDeviceGroupSubmitInfo	sType(int value)
final String	toString()	Returns a string representation of this record class.
int	waitSemaphoreCount()
VkDeviceGroupSubmitInfo	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$pWaitSemaphoreDeviceIndices

public static final MemoryLayout.PathElement PATH$pWaitSemaphoreDeviceIndices

PATH$commandBufferCount

public static final MemoryLayout.PathElement PATH$commandBufferCount

PATH$pCommandBufferDeviceMasks

public static final MemoryLayout.PathElement PATH$pCommandBufferDeviceMasks

PATH$signalSemaphoreCount

public static final MemoryLayout.PathElement PATH$signalSemaphoreCount

PATH$pSignalSemaphoreDeviceIndices

public static final MemoryLayout.PathElement PATH$pSignalSemaphoreDeviceIndices

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$pWaitSemaphoreDeviceIndices

public static final AddressLayout LAYOUT$pWaitSemaphoreDeviceIndices

LAYOUT$commandBufferCount

public static final ValueLayout.OfInt LAYOUT$commandBufferCount

LAYOUT$pCommandBufferDeviceMasks

public static final AddressLayout LAYOUT$pCommandBufferDeviceMasks

LAYOUT$signalSemaphoreCount

public static final ValueLayout.OfInt LAYOUT$signalSemaphoreCount

LAYOUT$pSignalSemaphoreDeviceIndices

public static final AddressLayout LAYOUT$pSignalSemaphoreDeviceIndices

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$pWaitSemaphoreDeviceIndices

public static final long SIZE$pWaitSemaphoreDeviceIndices

SIZE$commandBufferCount

public static final long SIZE$commandBufferCount

SIZE$pCommandBufferDeviceMasks

public static final long SIZE$pCommandBufferDeviceMasks

SIZE$signalSemaphoreCount

public static final long SIZE$signalSemaphoreCount

SIZE$pSignalSemaphoreDeviceIndices

public static final long SIZE$pSignalSemaphoreDeviceIndices

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$pWaitSemaphoreDeviceIndices

public static final long OFFSET$pWaitSemaphoreDeviceIndices

OFFSET$commandBufferCount

public static final long OFFSET$commandBufferCount

OFFSET$pCommandBufferDeviceMasks

public static final long OFFSET$pCommandBufferDeviceMasks

OFFSET$signalSemaphoreCount

public static final long OFFSET$signalSemaphoreCount

OFFSET$pSignalSemaphoreDeviceIndices

public static final long OFFSET$pSignalSemaphoreDeviceIndices

Constructor Details

VkDeviceGroupSubmitInfo

public VkDeviceGroupSubmitInfo(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a VkDeviceGroupSubmitInfo record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static VkDeviceGroupSubmitInfo allocate(Arena arena)

allocate

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

clone

public static VkDeviceGroupSubmitInfo clone(Arena arena,
 VkDeviceGroupSubmitInfo src)

autoInit

public void autoInit()

sType

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

sType

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

pNext

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

pNext

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

pNext

public VkDeviceGroupSubmitInfo pNext(@Nullable
 @Nullable IPointer pointer)

waitSemaphoreCount

@Unsigned
public int waitSemaphoreCount()

waitSemaphoreCount

public VkDeviceGroupSubmitInfo waitSemaphoreCount(@Unsigned
 int value)

pWaitSemaphoreDeviceIndices

@Nullable
@Unsigned
public @Nullable IntPtr pWaitSemaphoreDeviceIndices()

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 from or writing to the buffer.

pWaitSemaphoreDeviceIndices

public VkDeviceGroupSubmitInfo pWaitSemaphoreDeviceIndices(@Nullable @Unsigned
 @Nullable IntPtr value)

pWaitSemaphoreDeviceIndicesRaw

@Pointer(comment="uint32_t*")
@NotNull
public @NotNull MemorySegment pWaitSemaphoreDeviceIndicesRaw()

pWaitSemaphoreDeviceIndicesRaw

public void pWaitSemaphoreDeviceIndicesRaw(@Pointer(comment="uint32_t*") @NotNull
 @NotNull MemorySegment value)

commandBufferCount

@Unsigned
public int commandBufferCount()

commandBufferCount

public VkDeviceGroupSubmitInfo commandBufferCount(@Unsigned
 int value)

pCommandBufferDeviceMasks

@Nullable
@Unsigned
public @Nullable IntPtr pCommandBufferDeviceMasks()

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 from or writing to the buffer.

pCommandBufferDeviceMasks

public VkDeviceGroupSubmitInfo pCommandBufferDeviceMasks(@Nullable @Unsigned
 @Nullable IntPtr value)

pCommandBufferDeviceMasksRaw

@Pointer(comment="uint32_t*")
@NotNull
public @NotNull MemorySegment pCommandBufferDeviceMasksRaw()

pCommandBufferDeviceMasksRaw

public void pCommandBufferDeviceMasksRaw(@Pointer(comment="uint32_t*") @NotNull
 @NotNull MemorySegment value)

signalSemaphoreCount

@Unsigned
public int signalSemaphoreCount()

signalSemaphoreCount

public VkDeviceGroupSubmitInfo signalSemaphoreCount(@Unsigned
 int value)

pSignalSemaphoreDeviceIndices

@Nullable
@Unsigned
public @Nullable IntPtr pSignalSemaphoreDeviceIndices()

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 from or writing to the buffer.

pSignalSemaphoreDeviceIndices

public VkDeviceGroupSubmitInfo pSignalSemaphoreDeviceIndices(@Nullable @Unsigned
 @Nullable IntPtr value)

pSignalSemaphoreDeviceIndicesRaw

@Pointer(comment="uint32_t*")
@NotNull
public @NotNull MemorySegment pSignalSemaphoreDeviceIndicesRaw()

pSignalSemaphoreDeviceIndicesRaw

public void pSignalSemaphoreDeviceIndicesRaw(@Pointer(comment="uint32_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