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
All Methods Static Methods Instance Methods Abstract Methods Default Methods Deprecated Methods Modifier and Type Method Description default @NotNull java.util.stream.Stream<? extends net.kyori.examination.ExaminableProperty>
examinableProperties()
static @NotNull HSVLike
fromRGB(@org.jetbrains.annotations.Range(from=0L, to=255L) int red, @org.jetbrains.annotations.Range(from=0L, to=255L) int green, @org.jetbrains.annotations.Range(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 @NotNull HSVLike
hsvLike(float h, float s, float v)
Creates a new HSVLike.static @NotNull HSVLike
of(float h, float s, float v)
Deprecated.for removal since 4.10.0, usehsvLike(float, float, float)
instead.float
s()
Gets the saturation component.float
v()
Gets the value component.
-
-
-
Method Detail
-
hsvLike
@NotNull static @NotNull HSVLike hsvLike(float h, float s, float v)
Creates a new HSVLike.- Parameters:
h
- hue color components
- saturation color componentv
- value color component- Returns:
- a new HSVLike
- Since:
- 4.10.0
-
of
@Deprecated @ScheduledForRemoval(inVersion="5.0.0") @NotNull static @NotNull HSVLike of(float h, float s, float v)
Deprecated.for removal since 4.10.0, usehsvLike(float, float, float)
instead.Creates a new HSVLike.- Parameters:
h
- hue color components
- saturation color componentv
- value color component- Returns:
- a new HSVLike
- Since:
- 4.6.0
-
fromRGB
@NotNull static @NotNull HSVLike fromRGB(@org.jetbrains.annotations.Range(from=0L, to=255L) int red, @org.jetbrains.annotations.Range(from=0L, to=255L) int green, @org.jetbrains.annotations.Range(from=0L, to=255L) int blue)
Creates a new HSVLike from the given red, green, and blue color components.- Parameters:
red
- red color componentgreen
- green color componentblue
- 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
@NotNull default @NotNull java.util.stream.Stream<? extends net.kyori.examination.ExaminableProperty> examinableProperties()
- Specified by:
examinableProperties
in interfacenet.kyori.examination.Examinable
-
-