Color picker (lv_cpicker)¶

Overview¶

The color picker object draws a color band and knob that enable users to choose a color’s hue, saturation, and/or value.

Types of color pickers¶

The color band of a color picker can currently be drawn in two ways:

As a linear bar (LV_CPICKER_TYPE_RECT).
As a circular ring (LV_CPICKER_TYPE_DISC).

You can switch between these modes with lv_cpicker_set_type(cpicker, type).

Notes¶

In circular mode, the width and height of the color picker should be the same.

Styles¶

To set the style of a color picker object, use lv_cpicker_set_style(cpicker, LV_CPICKER_STYLE_XXX, &style). XXX can either be MAIN or INDICATOR, which represent the color band and knob, respectively.

line.width - the thickness of the color ring (in DISC mode)
body.[main/grad]_color - the background color of the color picker

Events¶

Besides the Generic events the following Special events are sent by color pickers:

LV_EVENT_VALUE_CHANGED - sent when the color changes.

Learn more about Events.

Keys¶

No Keys are processed by the object type.

Learn more about Keys.

Example¶

There is no official example available for this object type yet, but here is some sample test code:

    const lv_coord_t pickerSize = 200;

	/* Set the style of the color ring */
    static lv_style_t styleMain;
    lv_style_copy(&styleMain, &lv_style_plain);
    styleMain.line.width = 30;
	/* Make the background white */
    styleMain.body.main_color = styleMain.body.grad_color = LV_COLOR_WHITE;

	/* Set the style of the knob */
    static lv_style_t styleIndicator;
    lv_style_copy(&styleIndicator, &lv_style_pretty);
    styleIndicator.body.border.color = LV_COLOR_WHITE;
	/* Ensure that the knob is fully opaque */
    styleIndicator.body.opa = LV_OPA_COVER;
    styleIndicator.body.border.opa = LV_OPA_COVER;

    lv_obj_t * scr = lv_scr_act();

    lv_obj_t * colorPicker = lv_cpicker_create(scr, NULL);
    lv_obj_set_size(colorPicker, pickerSize, pickerSize);
	/* Choose the 'DISC' type */
    lv_cpicker_set_type(colorPicker, LV_CPICKER_TYPE_DISC);
    lv_obj_align(colorPicker, NULL, LV_ALIGN_CENTER, 0, 0);
	/* Set the styles */
    lv_cpicker_set_style(colorPicker, LV_CPICKER_STYLE_MAIN, &styleMain);
    lv_cpicker_set_style(colorPicker, LV_CPICKER_STYLE_INDICATOR, &styleIndicator);
	/* Change the knob's color to that of the selected color */
    lv_cpicker_set_indic_colored(colorPicker, true);

API¶

Typedefs

typedef uint8_t lv_cpicker_type_t¶

typedef uint8_t lv_cpicker_color_mode_t¶

typedef uint8_t lv_cpicker_style_t¶

Enums

enum [anonymous]¶

Values:

enumerator LV_CPICKER_TYPE_RECT¶

enumerator LV_CPICKER_TYPE_DISC¶

enum [anonymous]¶

Values:

enumerator LV_CPICKER_COLOR_MODE_HUE¶

enumerator LV_CPICKER_COLOR_MODE_SATURATION¶

enumerator LV_CPICKER_COLOR_MODE_VALUE¶

enum [anonymous]¶

Values:

enumerator LV_CPICKER_STYLE_MAIN¶

enumerator LV_CPICKER_STYLE_INDICATOR¶

Functions

lv_obj_t *lv_cpicker_create(lv_obj_t *par, const lv_obj_t *copy)¶

Create a colorpicker objects

Return

pointer to the created colorpicker

Parameters

par: pointer to an object, it will be the parent of the new colorpicker
copy: pointer to a colorpicker object, if not NULL then the new object will be copied from it

void lv_cpicker_set_type(lv_obj_t *cpicker, lv_cpicker_type_t type)¶

Set a new type for a colorpicker

Parameters

cpicker: pointer to a colorpicker object
type: new type of the colorpicker (from ‘lv_cpicker_type_t’ enum)

void lv_cpicker_set_style(lv_obj_t *cpicker, lv_cpicker_style_t type, lv_style_t *style)¶

Set a style of a colorpicker.

Parameters

cpicker: pointer to colorpicker object
type: which style should be set
style: pointer to a style

bool lv_cpicker_set_hue(lv_obj_t *cpicker, uint16_t hue)¶

Set the current hue of a colorpicker.

Return