Record Class Version

java.lang.Object
java.lang.Record
club.doki7.vulkan.Version
@ValueBasedCandidate public record Version(@Unsigned int variant, @Unsigned int major, @Unsigned int minor, @Unsigned int patch) extends Record
Utility class for encoding/decoding Vulkan API versions
See Also:

  • Field Details

    • VK_API_VERSION_1_0

      public static final Version VK_API_VERSION_1_0

    • VK_API_VERSION_1_1

      public static final Version VK_API_VERSION_1_1

    • VK_API_VERSION_1_2

      public static final Version VK_API_VERSION_1_2

    • VK_API_VERSION_1_3

      public static final Version VK_API_VERSION_1_3

    • VK_API_VERSION_1_4

      public static final Version VK_API_VERSION_1_4

  • Constructor Details

    • Version

      public Version(@Unsigned int variant, @Unsigned int major, @Unsigned int minor, @Unsigned int patch)
      Creates an instance of a Version record class.
      Parameters:
      variant - the value for the variant record component
      major - the value for the major record component
      minor - the value for the minor record component
      patch - the value for the patch record component

  • Method Details

    • decode

      public static Version decode(@Unsigned int version)

    • encode

      @Unsigned public int encode()

    • 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 the compare method from their corresponding wrapper classes.
      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.

    • variant

      @Unsigned public int variant()
      Returns the value of the variant record component.
      Returns:
      the value of the variant record component

    • major

      @Unsigned public int major()
      Returns the value of the major record component.
      Returns:
      the value of the major record component

    • minor

      @Unsigned public int minor()
      Returns the value of the minor record component.
      Returns:
      the value of the minor record component

    • patch

      @Unsigned public int patch()
      Returns the value of the patch record component.
      Returns:
      the value of the patch record component