col2hcl: convert R color to HCL color matrix

In jmw86069/jamba: Just Analysis Methods Base

convert R color to HCL color matrix

Description

convert R color to HCL color matrix

Usage

col2hcl(
  x,
  maxColorValue = 255,
  model = getOption("jam.model", c("hcl", "polarLUV", "polarLAB")),
  ...
)

Arguments

x	character R compatible color, either a color name, hex value, or a mixture of the two. Any value compatible with grDevices::col2rgb().
maxColorValue	numeric maximum value to return, useful when the downstream alpha range should be 255. By default maxValue=1 is returned.
model	character color model to use "hcl" to use farver HCL "polarLUV" for the standard R conventional HCL, "polarLAB" which uses the LAB-based HCL values.
...	additional arguments are ignored.

Details

This function takes an R color and converts to an HCL matrix, using the colorspace package, and RGB and polarLUV functions. It is also used to maintain alpha transparency, to enable interconversion via other color manipulation functions as well.

When model="hcl" this function uses farver::decode_colour() and bypasses colorspace. In future the colorspace dependency will likely be removed in favor of using farver. In any event, model="hcl" is equivalent to using model="polarLUV" and fixup=TRUE, except that it should be much faster.

Value

numeric matrix with H, C, L values.

See Also

Other jam color functions: alpha2col(), applyCLrange(), col2alpha(), col2hsl(), col2hsv(), color2gradient(), fixYellow(), fixYellowHue(), getColorRamp(), hcl2col(), hsl2col(), hsv2col(), isColor(), kable_coloring(), makeColorDarker(), rainbow2(), rgb2col(), setCLranges(), setTextContrastColor(), showColors(), unalpha(), warpRamp()

Examples

col2hcl("#FF000044")

jmw86069/jamba documentation built on Feb. 28, 2025, 9:07 p.m.