Record Class VkCommandBufferBeginInfo

java.lang.Object
java.lang.Record
club.doki7.vulkan.datatype.VkCommandBufferBeginInfo
All Implemented Interfaces:
IPointer, IVkCommandBufferBeginInfo
@ValueBasedCandidate @UnsafeConstructor public record VkCommandBufferBeginInfo(@NotNull MemorySegment segment) extends Record implements IVkCommandBufferBeginInfo

Represents a pointer to a VkCommandBufferBeginInfo structure in native memory.

Structure

typedef struct VkCommandBufferBeginInfo {
    VkStructureType sType;
    void const* pNext; // optional
    VkCommandBufferUsageFlags flags; // optional
    VkCommandBufferInheritanceInfo const* pInheritanceInfo; // optional
} VkCommandBufferBeginInfo;

Auto initialization

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

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