Record Class VkAccelerationStructureInstanceKHR

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

Represents a pointer to a VkAccelerationStructureInstanceKHR structure in native memory.

Structure

typedef struct VkAccelerationStructureInstanceKHR {
    VkTransformMatrixKHR transform;
    uint32_t instanceCustomIndex : 24;
    uint32_t mask : 8;
    uint32_t instanceShaderBindingTableRecordOffset : 24;
    uint32_t flags : 8;
    uint64_t accelerationStructureReference;
} VkAccelerationStructureInstanceKHR;

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

      public static final MemoryLayout.PathElement PATH$transform

    • PATH$bitfield$instanceCustomIndex$mask

      public static final MemoryLayout.PathElement PATH$bitfield$instanceCustomIndex$mask

    • PATH$bitfield$instanceShaderBindingTableRecordOffset$flags

      public static final MemoryLayout.PathElement PATH$bitfield$instanceShaderBindingTableRecordOffset$flags

    • PATH$accelerationStructureReference

      public static final MemoryLayout.PathElement PATH$accelerationStructureReference

    • LAYOUT$transform

      public static final StructLayout LAYOUT$transform

    • LAYOUT$bitfield$instanceCustomIndex$mask

      public static final ValueLayout.OfInt LAYOUT$bitfield$instanceCustomIndex$mask

    • LAYOUT$bitfield$instanceShaderBindingTableRecordOffset$flags

      public static final ValueLayout.OfInt LAYOUT$bitfield$instanceShaderBindingTableRecordOffset$flags

    • LAYOUT$accelerationStructureReference

      public static final ValueLayout.OfLong LAYOUT$accelerationStructureReference

    • SIZE$transform

      public static final long SIZE$transform

    • SIZE$accelerationStructureReference

      public static final long SIZE$accelerationStructureReference

    • OFFSET$transform

      public static final long OFFSET$transform

    • OFFSET$bitfield$instanceCustomIndex$mask

      public static final long OFFSET$bitfield$instanceCustomIndex$mask

    • OFFSET$bitfield$instanceShaderBindingTableRecordOffset$flags

      public static final long OFFSET$bitfield$instanceShaderBindingTableRecordOffset$flags

    • OFFSET$accelerationStructureReference

      public static final long OFFSET$accelerationStructureReference

  • Constructor Details

    • VkAccelerationStructureInstanceKHR

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

  • Method Details