Record Class VkVideoEncodeInfoKHR

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

Represents a pointer to a VkVideoEncodeInfoKHR structure in native memory.

Structure

typedef struct VkVideoEncodeInfoKHR {
    VkStructureType sType;
    void const* pNext; // optional
    VkVideoEncodeFlagsKHR flags; // optional
    VkBuffer dstBuffer;
    VkDeviceSize dstBufferOffset;
    VkDeviceSize dstBufferRange;
    VkVideoPictureResourceInfoKHR srcPictureResource;
    VkVideoReferenceSlotInfoKHR const* pSetupReferenceSlot; // optional
    uint32_t referenceSlotCount; // optional
    VkVideoReferenceSlotInfoKHR const* pReferenceSlots; // optional
    uint32_t precedingExternallyEncodedBytes;
} VkVideoEncodeInfoKHR;

Auto initialization

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

  • sType = VK_STRUCTURE_TYPE_VIDEO_ENCODE_INFO_KHR
  • srcPictureResource.autoInit()

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: