Record Class VkViewport

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

Represents a pointer to a VkViewport structure in native memory.

Structure

typedef struct VkViewport {
    float x;
    float y;
    float width;
    float height;
    float minDepth;
    float maxDepth;
} VkViewport;

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

      public static final MemoryLayout.PathElement PATH$x

    • PATH$y

      public static final MemoryLayout.PathElement PATH$y

    • PATH$width

      public static final MemoryLayout.PathElement PATH$width

    • PATH$height

      public static final MemoryLayout.PathElement PATH$height

    • PATH$minDepth

      public static final MemoryLayout.PathElement PATH$minDepth

    • PATH$maxDepth

      public static final MemoryLayout.PathElement PATH$maxDepth

    • LAYOUT$x

      public static final ValueLayout.OfFloat LAYOUT$x

    • LAYOUT$y

      public static final ValueLayout.OfFloat LAYOUT$y

    • LAYOUT$width

      public static final ValueLayout.OfFloat LAYOUT$width

    • LAYOUT$height

      public static final ValueLayout.OfFloat LAYOUT$height

    • LAYOUT$minDepth

      public static final ValueLayout.OfFloat LAYOUT$minDepth

    • LAYOUT$maxDepth

      public static final ValueLayout.OfFloat LAYOUT$maxDepth

    • SIZE$x

      public static final long SIZE$x

    • SIZE$y

      public static final long SIZE$y

    • SIZE$width

      public static final long SIZE$width

    • SIZE$height

      public static final long SIZE$height

    • SIZE$minDepth

      public static final long SIZE$minDepth

    • SIZE$maxDepth

      public static final long SIZE$maxDepth

    • OFFSET$x

      public static final long OFFSET$x

    • OFFSET$y

      public static final long OFFSET$y

    • OFFSET$width

      public static final long OFFSET$width

    • OFFSET$height

      public static final long OFFSET$height

    • OFFSET$minDepth

      public static final long OFFSET$minDepth

    • OFFSET$maxDepth

      public static final long OFFSET$maxDepth

  • Constructor Details

    • VkViewport

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

  • Method Details

    • allocate

      public static VkViewport allocate(Arena arena)

    • allocate

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

    • clone

      public static VkViewport clone(Arena arena, VkViewport src)

    • x

      public float x()

    • x

      public VkViewport x(float value)

    • y

      public float y()

    • y

      public VkViewport y(float value)

    • width

      public float width()

    • width

      public VkViewport width(float value)

    • height

      public float height()

    • height

      public VkViewport height(float value)

    • minDepth

      public float minDepth()

    • minDepth

      public VkViewport minDepth(float value)

    • maxDepth

      public float maxDepth()

    • maxDepth

      public VkViewport maxDepth(float 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