Package net.kyori.adventure.util

Interface HSVLike

All Superinterfaces:
net.kyori.examination.Examinable
public interface HSVLike
extends net.kyori.examination.Examinable
Something that can provide hue, saturation, and value color components.

Provided values should be in the range [0, 1].

Since:
4.6.0

  • Method Summary

    Modifier and Type Method Description
    default @NonNull Stream<? extends net.kyori.examination.ExaminableProperty> examinableProperties()  
    static @NonNull HSVLike fromRGB​(@org.checkerframework.common.value.qual.IntRange(from=0L, to=255L) int red, @org.checkerframework.common.value.qual.IntRange(from=0L, to=255L) int green, @org.checkerframework.common.value.qual.IntRange(from=0L, to=255L) int blue)
    Creates a new HSVLike from the given red, green, and blue color components.
    float h()
    Gets the hue component.
    static @NonNull HSVLike of​(float h, float s, float v)
    Creates a new HSVLike.
    float s()
    Gets the saturation component.
    float v()
    Gets the value component.

    Methods inherited from interface net.kyori.examination.Examinable

    examinableName, examine

  • Method Details

    • of

      static @NonNull HSVLike of​(float h, float s, float v)
      Creates a new HSVLike.
      Parameters:
      h - hue color component
      s - saturation color component
      v - value color component
      Returns:
      a new HSVLike
      Since:
      4.6.0

    • fromRGB

      static @NonNull HSVLike fromRGB​(@org.checkerframework.common.value.qual.IntRange(from=0L, to=255L) int red, @org.checkerframework.common.value.qual.IntRange(from=0L, to=255L) int green, @org.checkerframework.common.value.qual.IntRange(from=0L, to=255L) int blue)
      Creates a new HSVLike from the given red, green, and blue color components.
      Parameters:
      red - red color component
      green - green color component
      blue - blue color component
      Returns:
      a new HSVLike
      Since:
      4.6.0

    • h

      float h()
      Gets the hue component.
      Returns:
      the hue component
      Since:
      4.6.0

    • s

      float s()
      Gets the saturation component.
      Returns:
      the saturation component
      Since:
      4.6.0

    • v

      float v()
      Gets the value component.
      Returns:
      the value component
      Since:
      4.6.0

    • examinableProperties

      default @NonNull Stream<? extends net.kyori.examination.ExaminableProperty> examinableProperties()
      Specified by:
      examinableProperties in interface net.kyori.examination.Examinable