Record Class VkCommandBufferAllocateInfo

java.lang.Object

java.lang.Record

club.doki7.vulkan.datatype.VkCommandBufferAllocateInfo

All Implemented Interfaces:

IPointer, IVkCommandBufferAllocateInfo

@ValueBasedCandidate
@UnsafeConstructor
public record VkCommandBufferAllocateInfo(@NotNull MemorySegment segment)
extends Record
implements IVkCommandBufferAllocateInfo

Represents a pointer to a VkCommandBufferAllocateInfo structure in native memory.

Structure

typedef struct VkCommandBufferAllocateInfo {
    VkStructureType sType;
    void const* pNext; // optional
    VkCommandPool commandPool;
    VkCommandBufferLevel level;
    uint32_t commandBufferCount;
} VkCommandBufferAllocateInfo;

Auto initialization

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

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

• VkCommandBufferAllocateInfo

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

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

Method Summary

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

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

public static final MemoryLayout.PathElement PATH$commandPool

PATH$level

public static final MemoryLayout.PathElement PATH$level

PATH$commandBufferCount

public static final MemoryLayout.PathElement PATH$commandBufferCount

LAYOUT$sType

public static final ValueLayout.OfInt LAYOUT$sType

LAYOUT$pNext

public static final AddressLayout LAYOUT$pNext

LAYOUT$commandPool

public static final AddressLayout LAYOUT$commandPool

LAYOUT$level

public static final ValueLayout.OfInt LAYOUT$level

LAYOUT$commandBufferCount

public static final ValueLayout.OfInt LAYOUT$commandBufferCount

SIZE$sType

public static final long SIZE$sType

SIZE$pNext

public static final long SIZE$pNext

SIZE$commandPool

public static final long SIZE$commandPool

SIZE$level

public static final long SIZE$level

SIZE$commandBufferCount

public static final long SIZE$commandBufferCount

OFFSET$sType

public static final long OFFSET$sType

OFFSET$pNext

public static final long OFFSET$pNext

OFFSET$commandPool

public static final long OFFSET$commandPool

OFFSET$level

public static final long OFFSET$level

OFFSET$commandBufferCount

public static final long OFFSET$commandBufferCount

Constructor Details

VkCommandBufferAllocateInfo

public VkCommandBufferAllocateInfo(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a VkCommandBufferAllocateInfo record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static VkCommandBufferAllocateInfo allocate(Arena arena)

allocate

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

clone

public static VkCommandBufferAllocateInfo clone(Arena arena,
 VkCommandBufferAllocateInfo src)

autoInit

public void autoInit()

sType

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

sType

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

pNext

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

pNext

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

pNext

public VkCommandBufferAllocateInfo pNext(@Nullable
 @Nullable IPointer pointer)

commandPool

@Nullable
public @Nullable VkCommandPool commandPool()

commandPool

public VkCommandBufferAllocateInfo commandPool(@Nullable
 @Nullable VkCommandPool value)

level

@EnumType(VkCommandBufferLevel.class)
public int level()

level

public VkCommandBufferAllocateInfo level(@EnumType(VkCommandBufferLevel.class)
 int value)

commandBufferCount

@Unsigned
public int commandBufferCount()

commandBufferCount

public VkCommandBufferAllocateInfo commandBufferCount(@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