Record Class VkFramebufferAttachmentsCreateInfo.Ptr

java.lang.Object
java.lang.Record
club.doki7.vulkan.datatype.VkFramebufferAttachmentsCreateInfo.Ptr
All Implemented Interfaces:
IPointer, IVkFramebufferAttachmentsCreateInfo, Iterable<VkFramebufferAttachmentsCreateInfo>
Enclosing class:
VkFramebufferAttachmentsCreateInfo

@ValueBasedCandidate @UnsafeConstructor public static record VkFramebufferAttachmentsCreateInfo.Ptr(@NotNull MemorySegment segment) extends Record implements IVkFramebufferAttachmentsCreateInfo, Iterable<VkFramebufferAttachmentsCreateInfo>

Represents a pointer to / an array of VkFramebufferAttachmentsCreateInfo structure(s) in native memory.

Technically speaking, this type has no difference with VkFramebufferAttachmentsCreateInfo. This type is introduced mainly for user to distinguish between a pointer to a single structure and a pointer to (potentially) an array of structure(s). APIs should use interface IVkFramebufferAttachmentsCreateInfo to handle both types uniformly. See package level documentation for more details.

Contracts Link icon

The property segment() should always be not-null (segment != NULL && !segment.equals(MemorySegment.NULL)), and properly aligned to VkFramebufferAttachmentsCreateInfo.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.