Record Class VkSurfaceCapabilities2KHR

java.lang.Object
java.lang.Record
club.doki7.vulkan.datatype.VkSurfaceCapabilities2KHR
All Implemented Interfaces:
IPointer, IVkSurfaceCapabilities2KHR

@ValueBasedCandidate @UnsafeConstructor public record VkSurfaceCapabilities2KHR(@NotNull MemorySegment segment) extends Record implements IVkSurfaceCapabilities2KHR

Represents a pointer to a VkSurfaceCapabilities2KHR structure in native memory.

Structure Link icon

typedef struct VkSurfaceCapabilities2KHR {
    VkStructureType sType;
    void* pNext; // optional
    VkSurfaceCapabilitiesKHR surfaceCapabilities;
} VkSurfaceCapabilities2KHR;

Auto initialization Link icon

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

  • sType = VK_STRUCTURE_TYPE_SURFACE_CAPABILITIES_2_KHR

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 Link icon

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:
  • Field Details Link icon

    • LAYOUT Link icon

      public static final StructLayout LAYOUT
    • BYTES Link icon

      public static final long BYTES
    • PATH$sType Link icon

      public static final MemoryLayout.PathElement PATH$sType
    • PATH$pNext Link icon

      public static final MemoryLayout.PathElement PATH$pNext
    • PATH$surfaceCapabilities Link icon

      public static final MemoryLayout.PathElement PATH$surfaceCapabilities
    • LAYOUT$sType Link icon

      public static final ValueLayout.OfInt LAYOUT$sType
    • LAYOUT$pNext Link icon

      public static final AddressLayout LAYOUT$pNext
    • LAYOUT$surfaceCapabilities Link icon

      public static final StructLayout LAYOUT$surfaceCapabilities
    • SIZE$sType Link icon

      public static final long SIZE$sType
    • SIZE$pNext Link icon

      public static final long SIZE$pNext
    • SIZE$surfaceCapabilities Link icon

      public static final long SIZE$surfaceCapabilities
    • OFFSET$sType Link icon

      public static final long OFFSET$sType
    • OFFSET$pNext Link icon

      public static final long OFFSET$pNext
    • OFFSET$surfaceCapabilities Link icon

      public static final long OFFSET$surfaceCapabilities
  • Constructor Details Link icon

    • VkSurfaceCapabilities2KHR Link icon

      public VkSurfaceCapabilities2KHR(@NotNull @NotNull MemorySegment segment)
      Creates an instance of a VkSurfaceCapabilities2KHR record class.
      Parameters:
      segment - the value for the segment record component
  • Method Details Link icon