Skip to content

lightness()

Gets the lightness value of a color.

lightness() extracts the HSL lightness value from a color object, an array of color components, or a CSS color string.

By default, lightness() returns a color's HSL lightness in the range 0 to 100. If the colorMode() is set to HSL, it returns the lightness value in the given range.

Examples

lightness example 1

function setup()
  size(100, 100)

  background(50)

  -- Use HSL color.
  colorMode(HSL)

  -- Create a color object using HSL values.
  local c = color(0, 100, 75)

  -- Draw the left rectangle.
  noStroke()
  fill(c)
  rect(15, 15, 35, 70)

  -- Set 'lightValue' to 75.
  local lightValue = lightness(c)

  -- Draw the right rectangle.
  fill(lightValue)
  rect(50, 15, 35, 70)

  describe('Two rectangles. The left one is salmon pink and the right one is gray.')
end

lightness example 2

function setup()
  size(100, 100)

  background(50)

  -- Use HSL color.
  colorMode(HSL)

  -- Create a color array.
  local c = {0, 100, 75}

  -- Draw the left rectangle.
  noStroke()
  fill(c)
  rect(15, 15, 35, 70)

  -- Set 'lightValue' to 75.
  local lightValue = lightness(c)

  -- Draw the right rectangle.
  fill(lightValue)
  rect(50, 15, 35, 70)

  describe('Two rectangles. The left one is salmon pink and the right one is gray.')
end

lightness example 3

function setup()
  size(100, 100)

  background(50)

  -- Use HSL color with values in the range 0-255.
  colorMode(HSL, 255)

  -- Create a color object using HSL values.
  local c = color(0, 255, 191.5)

  -- Draw the left rectangle.
  noStroke()
  fill(c)
  rect(15, 15, 35, 70)

  -- Set 'lightValue' to 191.5.
  local lightValue = lightness(c)

  -- Draw the right rectangle.
  fill(lightValue)
  rect(50, 15, 35, 70)

  describe('Two rectangles. The left one is salmon pink and the right one is gray.')
end

Syntax

lightness(color)

Parameters

Parameter
color Color/Number/String.