Record Class VkLayerProperties

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

Represents a pointer to a VkLayerProperties structure in native memory.

Structure

typedef struct VkLayerProperties {
    char[VK_MAX_EXTENSION_NAME_SIZE] layerName;
    uint32_t specVersion;
    uint32_t implementationVersion;
    char[VK_MAX_DESCRIPTION_SIZE] description;
} VkLayerProperties;

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

      public static final MemoryLayout.PathElement PATH$layerName

    • PATH$specVersion

      public static final MemoryLayout.PathElement PATH$specVersion

    • PATH$implementationVersion

      public static final MemoryLayout.PathElement PATH$implementationVersion

    • PATH$description

      public static final MemoryLayout.PathElement PATH$description

    • LAYOUT$layerName

      public static final SequenceLayout LAYOUT$layerName

    • LAYOUT$specVersion

      public static final ValueLayout.OfInt LAYOUT$specVersion

    • LAYOUT$implementationVersion

      public static final ValueLayout.OfInt LAYOUT$implementationVersion

    • LAYOUT$description

      public static final SequenceLayout LAYOUT$description

    • SIZE$layerName

      public static final long SIZE$layerName

    • SIZE$specVersion

      public static final long SIZE$specVersion

    • SIZE$implementationVersion

      public static final long SIZE$implementationVersion

    • SIZE$description

      public static final long SIZE$description

    • OFFSET$layerName

      public static final long OFFSET$layerName

    • OFFSET$specVersion

      public static final long OFFSET$specVersion

    • OFFSET$implementationVersion

      public static final long OFFSET$implementationVersion

    • OFFSET$description

      public static final long OFFSET$description

  • Constructor Details

    • VkLayerProperties

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

  • Method Details

    • allocate

      public static VkLayerProperties allocate(Arena arena)

    • allocate

      public static VkLayerProperties.Ptr allocate(Arena arena, long count)

    • clone

      public static VkLayerProperties clone(Arena arena, VkLayerProperties src)

    • layerName

      public BytePtr layerName()

    • layerName

      public VkLayerProperties layerName(@NotNull @NotNull Consumer<BytePtr> consumer)

    • layerName

      public VkLayerProperties layerName(BytePtr value)

    • layerNameRaw

      @NotNull public @NotNull MemorySegment layerNameRaw()

    • specVersion

      @Unsigned public int specVersion()

    • specVersion

      public VkLayerProperties specVersion(@Unsigned int value)

    • implementationVersion

      @Unsigned public int implementationVersion()

    • implementationVersion

      public VkLayerProperties implementationVersion(@Unsigned int value)

    • description

      public BytePtr description()

    • description

      public VkLayerProperties description(@NotNull @NotNull Consumer<BytePtr> consumer)

    • description

      public VkLayerProperties description(BytePtr value)

    • descriptionRaw

      @NotNull public @NotNull MemorySegment descriptionRaw()

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • segment

      @NotNull public @NotNull MemorySegment segment()
      Returns the value of the segment record component.
      Specified by:
      segment in interface IPointer
      Returns:
      the value of the segment record component