Record Class VkExtent3D

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

Represents a pointer to a VkExtent3D structure in native memory.

Structure

typedef struct VkExtent3D {
    uint32_t width;
    uint32_t height;
    uint32_t depth;
} VkExtent3D;

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

      public static final MemoryLayout.PathElement PATH$width

    • PATH$height

      public static final MemoryLayout.PathElement PATH$height

    • PATH$depth

      public static final MemoryLayout.PathElement PATH$depth

    • LAYOUT$width

      public static final ValueLayout.OfInt LAYOUT$width

    • LAYOUT$height

      public static final ValueLayout.OfInt LAYOUT$height

    • LAYOUT$depth

      public static final ValueLayout.OfInt LAYOUT$depth

    • SIZE$width

      public static final long SIZE$width

    • SIZE$height

      public static final long SIZE$height

    • SIZE$depth

      public static final long SIZE$depth

    • OFFSET$width

      public static final long OFFSET$width

    • OFFSET$height

      public static final long OFFSET$height

    • OFFSET$depth

      public static final long OFFSET$depth

  • Constructor Details

    • VkExtent3D

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

  • Method Details

    • allocate

      public static VkExtent3D allocate(Arena arena)

    • allocate

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

    • clone

      public static VkExtent3D clone(Arena arena, VkExtent3D src)

    • width

      @Unsigned public int width()

    • width

      public VkExtent3D width(@Unsigned int value)

    • height

      @Unsigned public int height()

    • height

      public VkExtent3D height(@Unsigned int value)

    • depth

      @Unsigned public int depth()

    • depth

      public VkExtent3D depth(@Unsigned int value)

    • 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