Record Class VkExternalFenceProperties

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

Represents a pointer to a VkExternalFenceProperties structure in native memory.

Structure

typedef struct VkExternalFenceProperties {
    VkStructureType sType;
    void* pNext; // optional
    VkExternalFenceHandleTypeFlags exportFromImportedHandleTypes;
    VkExternalFenceHandleTypeFlags compatibleHandleTypes;
    VkExternalFenceFeatureFlags externalFenceFeatures; // optional
} VkExternalFenceProperties;

Auto initialization

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

  • sType = VK_STRUCTURE_TYPE_EXTERNAL_FENCE_PROPERTIES

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$exportFromImportedHandleTypes

      public static final MemoryLayout.PathElement PATH$exportFromImportedHandleTypes

    • PATH$compatibleHandleTypes

      public static final MemoryLayout.PathElement PATH$compatibleHandleTypes

    • PATH$externalFenceFeatures

      public static final MemoryLayout.PathElement PATH$externalFenceFeatures

    • LAYOUT$sType

      public static final ValueLayout.OfInt LAYOUT$sType

    • LAYOUT$pNext

      public static final AddressLayout LAYOUT$pNext

    • LAYOUT$exportFromImportedHandleTypes

      public static final ValueLayout.OfInt LAYOUT$exportFromImportedHandleTypes

    • LAYOUT$compatibleHandleTypes

      public static final ValueLayout.OfInt LAYOUT$compatibleHandleTypes

    • LAYOUT$externalFenceFeatures

      public static final ValueLayout.OfInt LAYOUT$externalFenceFeatures

    • SIZE$sType

      public static final long SIZE$sType

    • SIZE$pNext

      public static final long SIZE$pNext

    • SIZE$exportFromImportedHandleTypes

      public static final long SIZE$exportFromImportedHandleTypes

    • SIZE$compatibleHandleTypes

      public static final long SIZE$compatibleHandleTypes

    • SIZE$externalFenceFeatures

      public static final long SIZE$externalFenceFeatures

    • OFFSET$sType

      public static final long OFFSET$sType

    • OFFSET$pNext

      public static final long OFFSET$pNext

    • OFFSET$exportFromImportedHandleTypes

      public static final long OFFSET$exportFromImportedHandleTypes

    • OFFSET$compatibleHandleTypes

      public static final long OFFSET$compatibleHandleTypes

    • OFFSET$externalFenceFeatures

      public static final long OFFSET$externalFenceFeatures

  • Constructor Details

    • VkExternalFenceProperties

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

  • Method Details