APIMisc

lv_color.h

API reference for lv_color.h

Report on GitHub
Summary
30Functions
2Enums
5Structs
12Macros
1Variables

Functions

misc/lv_color.h:250function

lv_color_format_get_bpp

Get the pixel size of a color format in bits, bpp

 
uint8_t lv_color_format_get_bpp(lv_color_format_t cf)
Parameters
NameTypeDescription
cflv_color_format_ta color format (LV_COLOR_FORMAT_...)

Returns: uint8_t — the pixel size in bits

See also: LV_COLOR_FORMAT_GET_BPP

misc/lv_color.h:258function

lv_color_format_get_size

Get the pixel size of a color format in bytes

 
uint8_t lv_color_format_get_size(lv_color_format_t cf)
Parameters
NameTypeDescription
cflv_color_format_ta color format (LV_COLOR_FORMAT_...)

Returns: uint8_t — the pixel size in bytes

See also: LV_COLOR_FORMAT_GET_SIZE

Enums

misc/lv_color.h:40enum

_lv_opacity_level_t

Opacity percentages.

NameValue
LV_OPA_TRANSP0
LV_OPA_00
LV_OPA_1025
LV_OPA_2051
LV_OPA_3076
LV_OPA_40102
LV_OPA_50127
LV_OPA_60153
LV_OPA_70178
LV_OPA_80204
LV_OPA_90229
LV_OPA_100255
LV_OPA_COVER255
misc/lv_color.h:139enum

lv_color_format_t

NameValueDescription
LV_COLOR_FORMAT_UNKNOWN0
LV_COLOR_FORMAT_RAW0x01
LV_COLOR_FORMAT_RAW_ALPHA0x02
LV_COLOR_FORMAT_L80x06
LV_COLOR_FORMAT_I10x07
LV_COLOR_FORMAT_I20x08
LV_COLOR_FORMAT_I40x09
LV_COLOR_FORMAT_I80x0A
LV_COLOR_FORMAT_A80x0E
LV_COLOR_FORMAT_RGB5650x12
LV_COLOR_FORMAT_ARGB85650x13Not supported by sw renderer yet.
LV_COLOR_FORMAT_RGB565A80x14Color array followed by Alpha array
LV_COLOR_FORMAT_AL880x15L8 with alpha >
LV_COLOR_FORMAT_RGB565_SWAPPED0x1B
LV_COLOR_FORMAT_RGB8880x0F
LV_COLOR_FORMAT_ARGB88880x10
LV_COLOR_FORMAT_XRGB88880x11
LV_COLOR_FORMAT_ARGB8888_PREMULTIPLIED0x1A
LV_COLOR_FORMAT_A10x0B
LV_COLOR_FORMAT_A20x0C
LV_COLOR_FORMAT_A40x0D
LV_COLOR_FORMAT_ARGB15550x16
LV_COLOR_FORMAT_ARGB44440x17
LV_COLOR_FORMAT_ARGB22220X18
LV_COLOR_FORMAT_YUV_START0x20
LV_COLOR_FORMAT_I420LV_COLOR_FORMAT_YUV_START
LV_COLOR_FORMAT_I4220x21
LV_COLOR_FORMAT_I4440x22
LV_COLOR_FORMAT_I4000x23
LV_COLOR_FORMAT_NV210x24
LV_COLOR_FORMAT_NV120x25
LV_COLOR_FORMAT_YUY20x26
LV_COLOR_FORMAT_UYVY0x27
LV_COLOR_FORMAT_YUV_ENDLV_COLOR_FORMAT_UYVY
LV_COLOR_FORMAT_PROPRIETARY_START0x30
LV_COLOR_FORMAT_NEMA_TSC_STARTLV_COLOR_FORMAT_PROPRIETARY_START
LV_COLOR_FORMAT_NEMA_TSC4LV_COLOR_FORMAT_NEMA_TSC_START
LV_COLOR_FORMAT_NEMA_TSC60x31
LV_COLOR_FORMAT_NEMA_TSC6A0x32
LV_COLOR_FORMAT_NEMA_TSC6AP0x33
LV_COLOR_FORMAT_NEMA_TSC120x34
LV_COLOR_FORMAT_NEMA_TSC12A0x35
LV_COLOR_FORMAT_NEMA_TSC_ENDLV_COLOR_FORMAT_NEMA_TSC12A
LV_COLOR_FORMAT_NATIVELV_COLOR_FORMAT_RGB565
LV_COLOR_FORMAT_NATIVE_WITH_ALPHALV_COLOR_FORMAT_RGB565A8
Used by 47 functions
  • lv_display_set_color_format — param color_format
  • lv_draw_dma2d_cf_to_dma2d_output_cf — param cf
  • ppa_src_cf_supported — param cf
  • ppa_dest_cf_supported — param cf
  • lv_color_format_to_ppa_fill — param lv_fmt
  • lv_color_format_to_ppa_blend — param lv_fmt
  • lv_color_format_to_ppa_srm — param lv_fmt
  • lv_draw_layer_create — param color_format
  • lv_draw_layer_init — param color_format
  • lv_draw_buf_align — param color_format
  • lv_draw_buf_align_ex — param color_format
  • lv_draw_buf_width_to_stride — param color_format
  • lv_draw_buf_width_to_stride_ex — param color_format
  • lv_draw_buf_create — param cf
  • lv_draw_buf_create_ex — param cf
  • lv_draw_buf_init — param cf
  • lv_draw_buf_reshape — param cf
  • lv_nanovg_reshape_global_image — param cf
  • lv_nemagfx_is_cf_supported — param cf
  • lv_nemagfx_cf_to_nema — param cf
  • g2d_get_buf_format — param cf
  • g2d_rotate — param cf
  • lv_draw_pxp_rotate — param cf
  • pxp_get_out_px_format — param cf
  • pxp_get_as_px_format — param cf
  • pxp_get_ps_px_format — param cf
  • lv_draw_dave2d_transform — param cf
  • lv_draw_dave2d_lv_colour_fmt_to_d2_fmt — param colour_format
  • lv_draw_dave2d_is_dest_cf_supported — param cf
  • lv_snapshot_take — param cf
  • lv_snapshot_create_draw_buf — param cf
  • lv_snapshot_take_to_draw_buf — param cf
  • lv_snapshot_take_to_buf — param cf
  • lv_draw_sw_image_helium — param src_cf
  • lv_draw_sw_image_recolor_rgb888 — param src_cf
  • lv_draw_sw_transform — param cf
  • lv_draw_sw_unregister_blend_handler — param dest_cf
  • lv_draw_sw_get_blend_handler — param dest_cf
  • lv_draw_sw_rotate — param color_format
  • lv_vg_lite_is_dest_cf_supported — param cf
  • lv_vg_lite_is_src_cf_supported — param cf
  • lv_vg_lite_vg_fmt — param cf
  • lv_color_format_get_bpp — param cf
  • lv_color_format_get_size — param cf
  • lv_color_format_has_alpha — param src_cf
  • lv_canvas_set_buffer — param cf
  • lv_gif_set_color_format — param color_format

Structs

struct

lv_color_t

MemberTypeDescription
blueuint8_t
greenuint8_t
reduint8_t
Used by 69 functions
  • lv_obj_set_style_bg_color — param value
  • lv_obj_set_style_bg_grad_color — param value
  • lv_obj_set_style_bg_image_recolor — param value
  • lv_obj_set_style_border_color — param value
  • lv_obj_set_style_outline_color — param value
  • lv_obj_set_style_shadow_color — param value
  • lv_obj_set_style_image_recolor — param value
  • lv_obj_set_style_line_color — param value
  • lv_obj_set_style_arc_color — param value
  • lv_obj_set_style_text_color — param value
  • lv_obj_set_style_text_outline_stroke_color — param value
  • lv_obj_set_style_drop_shadow_color — param value
  • lv_obj_set_style_recolor — param value
  • lv_subject_init_color — param color
  • lv_subject_set_color — param color
  • lv_draw_dma2d_color_to_dma2d_color — param color
  • lv_eve_color — param color
  • lv_draw_vector_dsc_set_fill_color — param color
  • lv_draw_vector_dsc_set_stroke_color — param color
  • lv_nanovg_color_convert — param color
  • g2d_rgba_to_u32 — param color
  • lv_draw_dave2d_lv_colour_to_d2_colour — param color
  • lv_draw_sw_image_recolor_rgb565 — param color
  • lv_draw_sw_image_recolor_rgb888 — param color
  • lv_draw_sw_grad_color_calculate — param color_out
  • lv_vg_lite_color — param color
  • lv_opengles_render_fill — param color
  • lv_barcode_set_dark_color — param color
  • lv_barcode_set_light_color — param color
  • lv_qrcode_set_dark_color — param color
  • lv_qrcode_set_light_color — param color
  • lv_color_to_32 — param color
  • lv_color_to_int — param c
  • lv_color_eq — param c1
  • lv_color_eq — param c2
  • lv_color_is_in_range — param color
  • lv_color_is_in_range — param l_color
  • lv_color_is_in_range — param h_color
  • lv_color_to_u16 — param color
  • lv_color_to_u32 — param color
  • lv_color_lighten — param c
  • lv_color_darken — param c
  • lv_color_to_hsv — param color
  • lv_color_luminance — param c
  • lv_color_mix — param c1
  • lv_color_mix — param c2
  • lv_color_brightness — param c
  • lv_grad_init_stops — param colors
  • lv_style_set_bg_color — param value
  • lv_style_set_bg_grad_color — param value
  • lv_style_set_bg_image_recolor — param value
  • lv_style_set_border_color — param value
  • lv_style_set_outline_color — param value
  • lv_style_set_shadow_color — param value
  • lv_style_set_image_recolor — param value
  • lv_style_set_line_color — param value
  • lv_style_set_arc_color — param value
  • lv_style_set_text_color — param value
  • lv_style_set_text_outline_stroke_color — param value
  • lv_style_set_drop_shadow_color — param value
  • lv_style_set_recolor — param value
  • lv_theme_default_init — param color_primary
  • lv_theme_default_init — param color_secondary
  • lv_canvas_set_px — param color
  • lv_canvas_fill_bg — param color
  • lv_chart_add_series — param color
  • lv_chart_set_series_color — param color
  • lv_chart_add_cursor — param color
  • lv_led_set_color — param color
struct

lv_color16_t

MemberTypeDescription
blueuint16_t
greenuint16_t
reduint16_t
Used by 3 functions
  • lv_color16_to_color — param c
  • lv_color16_premultiply — param c
  • lv_color16_luminance — param c
struct

lv_color32_t

MemberTypeDescription
blueuint8_t
greenuint8_t
reduint8_t
alphauint8_t
Used by 17 functions
  • lv_obj_style_apply_recolor — param color
  • lv_draw_buf_set_palette — param color
  • lv_image_buf_set_palette — param c
  • lv_draw_vector_dsc_set_fill_color32 — param color
  • lv_draw_vector_dsc_set_stroke_color32 — param color
  • lv_nanovg_image_cache_get_handle — param color
  • lv_color32_eq — param c1
  • lv_color32_eq — param c2
  • lv_color_premultiply — param c
  • lv_color32_luminance — param c
  • lv_color_mix32 — param fg
  • lv_color_mix32 — param bg
  • lv_color_mix32_premultiplied — param fg
  • lv_color_mix32_premultiplied — param bg
  • lv_color_over32 — param fg
  • lv_color_over32 — param bg
  • lv_canvas_set_palette — param color
struct

lv_color_hsv_t

MemberTypeDescription
huint16_t
suint8_t
vuint8_t
struct

lv_color16a_t

MemberTypeDescription
lumiuint8_t
alphauint8_t

Macros

misc/lv_color.h:29macro

LV_COLOR_NATIVE_WITH_ALPHA_SIZE

 
#define LV_COLOR_NATIVE_WITH_ALPHA_SIZE 3
misc/lv_color.h:56macro

LV_OPA_MIN

 
#define LV_OPA_MIN 2

Fully transparent if opa <= LV_OPA_MIN

misc/lv_color.h:57macro

LV_OPA_MAX

 
#define LV_OPA_MAX 253

Fully cover if opa >= LV_OPA_MAX

misc/lv_color.h:65macro

LV_COLOR_FORMAT_GET_BPP

 
#define LV_COLOR_FORMAT_GET_BPP(cf)

Get the pixel size of a color format in bits, bpp

Parameters
NameDescription
cfa color format (LV_COLOR_FORMAT_...)

Returns: the pixel size in bits

See also: lv_color_format_get_bpp

misc/lv_color.h:103macro

LV_COLOR_FORMAT_GET_SIZE

 
#define LV_COLOR_FORMAT_GET_SIZE(cf) \
    ((LV_COLOR_FORMAT_GET_BPP(cf) + 7) >> 3)

Get the pixel size of a color format in bytes

Parameters
NameDescription
cfa color format (LV_COLOR_FORMAT_...)

Returns: the pixel size in bytes

See also: lv_color_format_get_size

misc/lv_color.h:223macro

LV_COLOR_FORMAT_IS_ALPHA_ONLY

 
#define LV_COLOR_FORMAT_IS_ALPHA_ONLY(cf) \
    ((cf) >= LV_COLOR_FORMAT_A1 && (cf) <= LV_COLOR_FORMAT_A8)
misc/lv_color.h:224macro

LV_COLOR_FORMAT_IS_INDEXED

 
#define LV_COLOR_FORMAT_IS_INDEXED(cf) \
    ((cf) >= LV_COLOR_FORMAT_I1 && (cf) <= LV_COLOR_FORMAT_I8)
misc/lv_color.h:225macro

LV_COLOR_FORMAT_IS_YUV

 
#define LV_COLOR_FORMAT_IS_YUV(cf) \
    ((cf) >= LV_COLOR_FORMAT_YUV_START && (cf) <= LV_COLOR_FORMAT_YUV_END)
misc/lv_color.h:226macro

LV_COLOR_INDEXED_PALETTE_SIZE

 
#define LV_COLOR_INDEXED_PALETTE_SIZE(cf) \
    ((cf) == LV_COLOR_FORMAT_I1 ? 2 : \
                                               (cf) == LV_COLOR_FORMAT_I2 ? 4 : \
                                               (cf) == LV_COLOR_FORMAT_I4 ? 16 : \
                                               (cf) == LV_COLOR_FORMAT_I8 ? 256 : 0)
misc/lv_color.h:235macro

LV_COLOR_MAKE

 
#define LV_COLOR_MAKE(r8, g8, b8) \
    {b8, g8, r8}
misc/lv_color.h:237macro

LV_OPA_MIX2

 
#define LV_OPA_MIX2(a1, a2) \
    ((lv_opa_t)(((int32_t)(a1) * (a2)) >> 8))
misc/lv_color.h:238macro

LV_OPA_MIX3

 
#define LV_OPA_MIX3(a1, a2, a3) \
    ((lv_opa_t)(((int32_t)(a1) * (a2) * (a3)) >> 16))

Variables

misc/lv_color.h:488variable

lv_color_filter_shade

 
const lv_color_filter_dsc_t lv_color_filter_shade

Dependencies

Indirect dependencies

How is this guide?

Last updated on

lv_circle_buf.h

API reference for lv_circle_buf.h

lv_color_op.h

API reference for lv_color_op.h

On this page

Functionslv_color_format_get_bpplv_color_format_get_sizelv_color_format_has_alphalv_color_to_32lv_color_to_intlv_color_eqlv_color32_eqlv_color_hexlv_color_makelv_color32_makelv_color_hex3lv_color_is_in_rangelv_color16_to_colorlv_color_to_u16lv_color_to_u32lv_color_16_16_mixlv_color_lightenlv_color_darkenlv_color_hsv_to_rgblv_color_rgb_to_hsvlv_color_to_hsvlv_color_whitelv_color_blacklv_color_premultiplylv_color16_premultiplylv_color_luminancelv_color16_luminancelv_color24_luminancelv_color32_luminancelv_color_swap_16Enums_lv_opacity_level_tlv_color_format_tStructslv_color_tlv_color16_tlv_color32_tlv_color_hsv_tlv_color16a_tMacrosLV_COLOR_NATIVE_WITH_ALPHA_SIZELV_OPA_MINLV_OPA_MAXLV_COLOR_FORMAT_GET_BPPLV_COLOR_FORMAT_GET_SIZELV_COLOR_FORMAT_IS_ALPHA_ONLYLV_COLOR_FORMAT_IS_INDEXEDLV_COLOR_FORMAT_IS_YUVLV_COLOR_INDEXED_PALETTE_SIZELV_COLOR_MAKELV_OPA_MIX2LV_OPA_MIX3Variableslv_color_filter_shadeDependencies