Record Class VkFormatProperties3

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

Represents a pointer to a VkFormatProperties3 structure in native memory.

Structure

typedef struct VkFormatProperties3 {
    VkStructureType sType;
    void* pNext; // optional
    VkFormatFeatureFlags2 linearTilingFeatures; // optional
    VkFormatFeatureFlags2 optimalTilingFeatures; // optional
    VkFormatFeatureFlags2 bufferFeatures; // optional
} VkFormatProperties3;

Auto initialization

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

  • sType = VK_STRUCTURE_TYPE_FORMAT_PROPERTIES_3

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:

  • 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$linearTilingFeatures

      public static final MemoryLayout.PathElement PATH$linearTilingFeatures

    • PATH$optimalTilingFeatures

      public static final MemoryLayout.PathElement PATH$optimalTilingFeatures

    • PATH$bufferFeatures

      public static final MemoryLayout.PathElement PATH$bufferFeatures

    • LAYOUT$sType

      public static final ValueLayout.OfInt LAYOUT$sType

    • LAYOUT$pNext

      public static final AddressLayout LAYOUT$pNext

    • LAYOUT$linearTilingFeatures

      public static final ValueLayout.OfLong LAYOUT$linearTilingFeatures

    • LAYOUT$optimalTilingFeatures

      public static final ValueLayout.OfLong LAYOUT$optimalTilingFeatures

    • LAYOUT$bufferFeatures

      public static final ValueLayout.OfLong LAYOUT$bufferFeatures

    • SIZE$sType

      public static final long SIZE$sType

    • SIZE$pNext

      public static final long SIZE$pNext

    • SIZE$linearTilingFeatures

      public static final long SIZE$linearTilingFeatures

    • SIZE$optimalTilingFeatures

      public static final long SIZE$optimalTilingFeatures

    • SIZE$bufferFeatures

      public static final long SIZE$bufferFeatures

    • OFFSET$sType

      public static final long OFFSET$sType

    • OFFSET$pNext

      public static final long OFFSET$pNext

    • OFFSET$linearTilingFeatures

      public static final long OFFSET$linearTilingFeatures

    • OFFSET$optimalTilingFeatures

      public static final long OFFSET$optimalTilingFeatures

    • OFFSET$bufferFeatures

      public static final long OFFSET$bufferFeatures

  • Constructor Details

    • VkFormatProperties3

      public VkFormatProperties3(@NotNull @NotNull MemorySegment segment)
      Creates an instance of a VkFormatProperties3 record class.
      Parameters:
      segment - the value for the segment record component

  • Method Details