Blender V4.3
BLI_math_color.h File Reference

Go to the source code of this file.

Macros

Defines
#define BLI_YCC_ITU_BT601   0
 
#define BLI_YCC_ITU_BT709   1
 
#define BLI_YCC_JFIF_0_255   2
 
#define BLI_YUV_ITU_BT601   0
 
#define BLI_YUV_ITU_BT709   1
 

Functions

Conversion to RGB
void hsv_to_rgb (float h, float s, float v, float *r_r, float *r_g, float *r_b)
 
void hsv_to_rgb_v (const float hsv[3], float r_rgb[3])
 
void hsl_to_rgb (float h, float s, float l, float *r_r, float *r_g, float *r_b)
 
void hsl_to_rgb_v (const float hsl[3], float r_rgb[3])
 
void hex_to_rgb (const char *hexcol, float *r_r, float *r_g, float *r_b)
 
void yuv_to_rgb (float y, float u, float v, float *r_r, float *r_g, float *r_b, int colorspace)
 
void ycc_to_rgb (float y, float cb, float cr, float *r_r, float *r_g, float *r_b, int colorspace)
 
void cpack_to_rgb (unsigned int col, float *r_r, float *r_g, float *r_b)
 
Conversion to RGBA
void hex_to_rgba (const char *hexcol, float *r_r, float *r_g, float *r_b, float *r_a)
 
Conversion from RGB
void rgb_to_yuv (float r, float g, float b, float *r_y, float *r_u, float *r_v, int colorspace)
 
void rgb_to_ycc (float r, float g, float b, float *r_y, float *r_cb, float *r_cr, int colorspace)
 
void rgb_to_hsv (float r, float g, float b, float *r_h, float *r_s, float *r_v)
 
void rgb_to_hsv_v (const float rgb[3], float r_hsv[3])
 
void rgb_to_hsl (float r, float g, float b, float *r_h, float *r_s, float *r_l)
 
void rgb_to_hsl_v (const float rgb[3], float r_hsl[3])
 
void rgb_to_hsl_compat (float r, float g, float b, float *r_h, float *r_s, float *r_l)
 
void rgb_to_hsl_compat_v (const float rgb[3], float r_hsl[3])
 
void rgb_to_hsv_compat (float r, float g, float b, float *r_h, float *r_s, float *r_v)
 
void rgb_to_hsv_compat_v (const float rgb[3], float r_hsv[3])
 
unsigned int rgb_to_cpack (float r, float g, float b)
 
unsigned int hsv_to_cpack (float h, float s, float v)
 
Profile Transformations
float srgb_to_linearrgb (float c)
 
float linearrgb_to_srgb (float c)
 
void srgb_to_linearrgb_v3_v3 (float linear[3], const float srgb[3])
 
void linearrgb_to_srgb_v3_v3 (float srgb[3], const float linear[3])
 
MINLINE void srgb_to_linearrgb_v4 (float linear[4], const float srgb[4])
 
MINLINE void linearrgb_to_srgb_v4 (float srgb[4], const float linear[4])
 
MINLINE void srgb_to_linearrgb_predivide_v4 (float linear[4], const float srgb[4])
 
MINLINE void linearrgb_to_srgb_predivide_v4 (float srgb[4], const float linear[4])
 
MINLINE unsigned short to_srgb_table_lookup (float f)
 
MINLINE void linearrgb_to_srgb_ushort4 (unsigned short srgb[4], const float linear[4])
 
MINLINE void srgb_to_linearrgb_uchar4 (float linear[4], const unsigned char srgb[4])
 
MINLINE void srgb_to_linearrgb_uchar4_predivide (float linear[4], const unsigned char srgb[4])
 
MINLINE void linearrgb_to_srgb_uchar3 (unsigned char srgb[3], const float linear[3])
 
MINLINE void linearrgb_to_srgb_uchar4 (unsigned char srgb[4], const float linear[4])
 
void BLI_init_srgb_conversion (void)
 
Alpha Transformations
MINLINE void premul_to_straight_v4_v4 (float straight[4], const float premul[4])
 
MINLINE void premul_to_straight_v4 (float color[4])
 
MINLINE void straight_to_premul_v4_v4 (float premul[4], const float straight[4])
 
MINLINE void straight_to_premul_v4 (float color[4])
 
MINLINE void straight_uchar_to_premul_float (float result[4], const unsigned char color[4])
 
MINLINE void premul_float_to_straight_uchar (unsigned char *result, const float color[4])
 
lift/gamma/gain / ASC-CDL conversion
void lift_gamma_gain_to_asc_cdl (const float *lift, const float *gamma, const float *gain, float *offset, float *slope, float *power)
 

Other

#define rgba_char_args_set_fl(col, r, g, b, a)    rgba_char_args_set(col, (r) * 255, (g) * 255, (b) * 255, (a) * 255)
 
#define rgba_float_args_set_ch(col, r, g, b, a)    rgba_float_args_set(col, (r) / 255.0f, (g) / 255.0f, (b) / 255.0f, (a) / 255.0f)
 
int constrain_rgb (float *r, float *g, float *b)
 
void minmax_rgb (short c[3])
 
void hsv_clamp_v (float hsv[3], float v_max)
 
void rgb_float_set_hue_float_offset (float rgb[3], float hue_offset)
 
void rgb_byte_set_hue_float_offset (unsigned char rgb[3], float hue_offset)
 
void rgb_uchar_to_float (float r_col[3], const unsigned char col_ub[3])
 
void rgba_uchar_to_float (float r_col[4], const unsigned char col_ub[4])
 
void rgb_float_to_uchar (unsigned char r_col[3], const float col_f[3])
 
void rgba_float_to_uchar (unsigned char r_col[4], const float col_f[4])
 
MINLINE float rgb_to_grayscale (const float rgb[3])
 
MINLINE unsigned char rgb_to_grayscale_byte (const unsigned char rgb[3])
 
MINLINE int compare_rgb_uchar (const unsigned char col_a[3], const unsigned char col_b[3], int limit)
 
MINLINE float dither_random_value (float s, float t)
 
MINLINE void float_to_byte_dither_v3 (unsigned char b[3], const float f[3], float dither, float s, float t)
 
MINLINE void rgba_uchar_args_set (unsigned char col[4], unsigned char r, unsigned char g, unsigned char b, unsigned char a)
 
MINLINE void rgba_float_args_set (float col[4], float r, float g, float b, float a)
 
MINLINE void rgba_uchar_args_test_set (unsigned char col[4], unsigned char r, unsigned char g, unsigned char b, unsigned char a)
 
MINLINE void cpack_cpy_3ub (unsigned char r_col[3], unsigned int pack)
 

Macro Definition Documentation

◆ BLI_YCC_ITU_BT601

◆ BLI_YCC_ITU_BT709

◆ BLI_YCC_JFIF_0_255

◆ BLI_YUV_ITU_BT601

#define BLI_YUV_ITU_BT601   0

Definition at line 27 of file BLI_math_color.h.

Referenced by rgb_to_yuv(), and yuv_to_rgb().

◆ BLI_YUV_ITU_BT709

◆ rgba_char_args_set_fl

#define rgba_char_args_set_fl ( col,
r,
g,
b,
a )    rgba_char_args_set(col, (r) * 255, (g) * 255, (b) * 255, (a) * 255)

Definition at line 187 of file BLI_math_color.h.

◆ rgba_float_args_set_ch

#define rgba_float_args_set_ch ( col,
r,
g,
b,
a )    rgba_float_args_set(col, (r) / 255.0f, (g) / 255.0f, (b) / 255.0f, (a) / 255.0f)

Definition at line 190 of file BLI_math_color.h.

Referenced by widgetbase_set_uniform_colors_ubv().

Function Documentation

◆ BLI_init_srgb_conversion()

◆ compare_rgb_uchar()

MINLINE int compare_rgb_uchar ( const unsigned char col_a[3],
const unsigned char col_b[3],
int limit )

Definition at line 217 of file math_color_inline.c.

References abs(), b, and int.

◆ constrain_rgb()

int constrain_rgb ( float * r,
float * g,
float * b )

If the requested RGB shade contains a negative weight for one of the primaries, it lies outside the color gamut accessible from the given triple of primaries. Desaturate it by adding white, equal quantities of R, G, and B, enough to make RGB all positive. The function returns 1 if the components were modified, zero otherwise.

Definition at line 709 of file math_color.cc.

References b, min_ffff(), and w().

◆ cpack_cpy_3ub()

MINLINE void cpack_cpy_3ub ( unsigned char r_col[3],
unsigned int pack )

Definition at line 185 of file math_color_inline.c.

◆ cpack_to_rgb()

void cpack_to_rgb ( unsigned int col,
float * r_r,
float * r_g,
float * r_b )

Definition at line 395 of file math_color.cc.

References col, and float.

Referenced by BKE_palette_from_hash().

◆ dither_random_value()

MINLINE float dither_random_value ( float s,
float t )

Return triangle noise in [-0.5..1.5] range.

Definition at line 235 of file math_color_inline.c.

References floorf, and sinf.

Referenced by float_to_byte_dither_v3(), float_to_byte_dither_v4(), and ushort_to_byte_dither_v4().

◆ float_to_byte_dither_v3()

MINLINE void float_to_byte_dither_v3 ( unsigned char b[3],
const float f[3],
float dither,
float s,
float t )

◆ hex_to_rgb()

void hex_to_rgb ( const char * hexcol,
float * r_r,
float * r_g,
float * r_b )

Definition at line 185 of file math_color.cc.

References hex_to_rgba().

Referenced by BKE_gpencil_palette_ensure().

◆ hex_to_rgba()

void hex_to_rgba ( const char * hexcol,
float * r_r,
float * r_g,
float * r_b,
float * r_a )

Definition at line 190 of file math_color.cc.

References CLAMP, and float.

Referenced by hex_to_rgb(), and ui_colorpicker_hex_rna_cb().

◆ hsl_to_rgb()

◆ hsl_to_rgb_v()

◆ hsv_clamp_v()

void hsv_clamp_v ( float hsv[3],
float v_max )

Clamp hsv to usable values.

Definition at line 349 of file math_color.cc.

References CLAMP, floorf, and UNLIKELY.

◆ hsv_to_cpack()

unsigned int hsv_to_cpack ( float h,
float s,
float v )

We define a 'cpack' here as a (3 byte color code) number that can be expressed like 0xFFAA66 or so. For that reason it is sensitive for endianness... with this function it works correctly.

See also
imm_cpack

Definition at line 358 of file math_color.cc.

References b, col, hsv_to_rgb(), and v.

◆ hsv_to_rgb()

◆ hsv_to_rgb_v()

◆ lift_gamma_gain_to_asc_cdl()

void lift_gamma_gain_to_asc_cdl ( const float * lift,
const float * gamma,
const float * gain,
float * offset,
float * slope,
float * power )

Definition at line 728 of file math_color.cc.

References FLT_MAX, and power().

◆ linearrgb_to_srgb()

◆ linearrgb_to_srgb_predivide_v4()

MINLINE void linearrgb_to_srgb_predivide_v4 ( float srgb[4],
const float linear[4] )

◆ linearrgb_to_srgb_uchar3()

MINLINE void linearrgb_to_srgb_uchar3 ( unsigned char srgb[3],
const float linear[3] )

◆ linearrgb_to_srgb_uchar4()

◆ linearrgb_to_srgb_ushort4()

MINLINE void linearrgb_to_srgb_ushort4 ( unsigned short srgb[4],
const float linear[4] )

Definition at line 123 of file math_color_inline.c.

References to_srgb_table_lookup(), and unit_float_to_ushort_clamp.

Referenced by IMB_buffer_byte_from_float().

◆ linearrgb_to_srgb_v3_v3()

◆ linearrgb_to_srgb_v4()

◆ minmax_rgb()

void minmax_rgb ( short c[3])

Definition at line 685 of file math_color.cc.

◆ premul_float_to_straight_uchar()

◆ premul_to_straight_v4()

MINLINE void premul_to_straight_v4 ( float color[4])

Definition at line 279 of file math_color_inline.c.

References premul_to_straight_v4_v4().

Referenced by project_paint_uvpixel_init().

◆ premul_to_straight_v4_v4()

◆ rgb_byte_set_hue_float_offset()

void rgb_byte_set_hue_float_offset ( unsigned char rgb[3],
float hue_offset )

Applies an HUE offset to a byte RGB color.

Definition at line 767 of file math_color.cc.

References rgb_float_set_hue_float_offset(), rgb_float_to_uchar(), and rgb_uchar_to_float().

Referenced by color3ubv_from_seq().

◆ rgb_float_set_hue_float_offset()

void rgb_float_set_hue_float_offset ( float rgb[3],
float hue_offset )

Applies an HUE offset to a float RGB color.

Definition at line 750 of file math_color.cc.

References hsv_to_rgb(), and rgb_to_hsv().

Referenced by rgb_byte_set_hue_float_offset().

◆ rgb_float_to_uchar()

◆ rgb_to_cpack()

unsigned int rgb_to_cpack ( float r,
float g,
float b )

◆ rgb_to_grayscale()

MINLINE float rgb_to_grayscale ( const float rgb[3])

ITU-R BT.709 primaries https://en.wikipedia.org/wiki/Relative_luminance

Real values are: Y = 0.2126390059(R) + 0.7151686788(G) + 0.0721923154(B) according to: "Derivation of Basic Television Color Equations", RP 177-1993

As this sums slightly above 1.0, the document recommends to use: 0.2126(R) + 0.7152(G) + 0.0722(B), as used here.

The high precision values are used to calculate the rounded byte weights so they add up to 255: 54(R) + 182(G) + 19(B)

Definition at line 203 of file math_color_inline.c.

Referenced by button2d_draw_intern(), blender::bke::color_to_bool(), blender::bke::color_to_float(), blender::bke::color_to_int(), ED_view3d_text_colors_get(), file_draw_preview(), blender::nodes::node_fn_compare_cc::get_multi_function(), ui_tooltip_region_draw_cb(), and widget_swatch().

◆ rgb_to_grayscale_byte()

MINLINE unsigned char rgb_to_grayscale_byte ( const unsigned char rgb[3])

◆ rgb_to_hsl()

◆ rgb_to_hsl_compat()

void rgb_to_hsl_compat ( float r,
float g,
float b,
float * r_h,
float * r_s,
float * r_l )

Definition at line 292 of file math_color.cc.

References b, and rgb_to_hsl().

Referenced by rgb_to_hsl_compat_v().

◆ rgb_to_hsl_compat_v()

void rgb_to_hsl_compat_v ( const float rgb[3],
float r_hsl[3] )

◆ rgb_to_hsl_v()

◆ rgb_to_hsv()

◆ rgb_to_hsv_compat()

void rgb_to_hsv_compat ( float r,
float g,
float b,
float * r_h,
float * r_s,
float * r_v )

Definition at line 323 of file math_color.cc.

References b, e, and rgb_to_hsv().

Referenced by rgb_to_hsv_compat_v().

◆ rgb_to_hsv_compat_v()

void rgb_to_hsv_compat_v ( const float rgb[3],
float r_hsv[3] )

◆ rgb_to_hsv_v()

◆ rgb_to_ycc()

void rgb_to_ycc ( float r,
float g,
float b,
float * r_y,
float * r_cb,
float * r_cr,
int colorspace )

The RGB inputs are supposed gamma corrected and in the range 0 - 1.0f

Output YCC have a range of 16-235 and 16-240 except with JFIF_0_255 where the range is 0-255.

Definition at line 115 of file math_color.cc.

References b, BLI_assert_msg, BLI_YCC_ITU_BT601, BLI_YCC_ITU_BT709, BLI_YCC_JFIF_0_255, and y.

Referenced by scopes_update_cb(), TEST(), and blender::compositor::ConvertRGBToYCCOperation::update_memory_buffer_partial().

◆ rgb_to_yuv()

◆ rgb_uchar_to_float()

◆ rgba_float_args_set()

◆ rgba_float_to_uchar()

◆ rgba_uchar_args_set()

MINLINE void rgba_uchar_args_set ( unsigned char col[4],
unsigned char r,
unsigned char g,
unsigned char b,
unsigned char a )

Definition at line 156 of file math_color_inline.c.

References b, and col.

Referenced by action_group_colors_sync().

◆ rgba_uchar_args_test_set()

MINLINE void rgba_uchar_args_test_set ( unsigned char col[4],
unsigned char r,
unsigned char g,
unsigned char b,
unsigned char a )

Definition at line 174 of file math_color_inline.c.

References b, and col.

◆ rgba_uchar_to_float()

◆ srgb_to_linearrgb()

◆ srgb_to_linearrgb_predivide_v4()

MINLINE void srgb_to_linearrgb_predivide_v4 ( float linear[4],
const float srgb[4] )

◆ srgb_to_linearrgb_uchar4()

◆ srgb_to_linearrgb_uchar4_predivide()

MINLINE void srgb_to_linearrgb_uchar4_predivide ( float linear[4],
const unsigned char srgb[4] )

◆ srgb_to_linearrgb_v3_v3()

◆ srgb_to_linearrgb_v4()

◆ straight_to_premul_v4()

◆ straight_to_premul_v4_v4()

MINLINE void straight_to_premul_v4_v4 ( float premul[4],
const float straight[4] )

◆ straight_uchar_to_premul_float()

◆ to_srgb_table_lookup()

MINLINE unsigned short to_srgb_table_lookup ( float f)

Definition at line 108 of file math_color_inline.c.

References BLI_color_to_srgb_table.

Referenced by linearrgb_to_srgb_ushort4().

◆ ycc_to_rgb()

void ycc_to_rgb ( float y,
float cb,
float cr,
float * r_r,
float * r_g,
float * r_b,
int colorspace )

◆ yuv_to_rgb()