Documentation for <wlr/render/color.h>

Back to index

Table of contents

enum wlr_alpha_mode 

enum wlr_alpha_mode {
	WLR_COLOR_ALPHA_MODE_PREMULTIPLIED_ELECTRICAL,
	WLR_COLOR_ALPHA_MODE_PREMULTIPLIED_OPTICAL,
	WLR_COLOR_ALPHA_MODE_STRAIGHT,
};

Specifies alpha blending modes. Note that premultiplied_electrical is the default, so there is no "none" or "unset" value.

enum wlr_color_chroma_location 

enum wlr_color_chroma_location {
	WLR_COLOR_CHROMA_LOCATION_NONE,
	WLR_COLOR_CHROMA_LOCATION_TYPE0,
	WLR_COLOR_CHROMA_LOCATION_TYPE1,
	WLR_COLOR_CHROMA_LOCATION_TYPE2,
	WLR_COLOR_CHROMA_LOCATION_TYPE3,
	WLR_COLOR_CHROMA_LOCATION_TYPE4,
	WLR_COLOR_CHROMA_LOCATION_TYPE5,
};

Chroma sample locations, corresponding to Chroma420SampleLocType code points in H.273. NONE means the value is unset or unknown.

struct wlr_color_cie1931_xy 

struct wlr_color_cie1931_xy {
	float x, y;
};

CIE 1931 xy chromaticity coordinates.

enum wlr_color_encoding 

enum wlr_color_encoding {
	WLR_COLOR_ENCODING_NONE,
	WLR_COLOR_ENCODING_IDENTITY,
	WLR_COLOR_ENCODING_BT709,
	WLR_COLOR_ENCODING_FCC,
	WLR_COLOR_ENCODING_BT601,
	WLR_COLOR_ENCODING_SMPTE240,
	WLR_COLOR_ENCODING_BT2020,
	WLR_COLOR_ENCODING_BT2020_CL,
	WLR_COLOR_ENCODING_ICTCP,
};

Well-known color encodings, each representing a set of matrix coefficients used to convert that particular YCbCr encoding to RGB. NONE means the value is unset or unknown.

struct wlr_color_luminances 

struct wlr_color_luminances {
	float min, max, reference;
};

Luminance range and reference white luminance level, in cd/m².

enum wlr_color_named_primaries 

enum wlr_color_named_primaries {
	WLR_COLOR_NAMED_PRIMARIES_SRGB,
	WLR_COLOR_NAMED_PRIMARIES_BT2020,
};

Well-known color primaries.

struct wlr_color_primaries 

struct wlr_color_primaries {
	struct wlr_color_cie1931_xy red, green, blue, white;
};

Color primaries and white point describing a color volume.

enum wlr_color_range 

enum wlr_color_range {
	WLR_COLOR_RANGE_NONE,
	WLR_COLOR_RANGE_LIMITED,
	WLR_COLOR_RANGE_FULL,
};

Specifies whether a particular color-encoding uses full- or limited-range values. NONE means the value is unset or unknown.

enum wlr_color_transfer_function 

enum wlr_color_transfer_function {
	WLR_COLOR_TRANSFER_FUNCTION_SRGB,
	WLR_COLOR_TRANSFER_FUNCTION_ST2084_PQ,
	WLR_COLOR_TRANSFER_FUNCTION_EXT_LINEAR,
};

Well-known color transfer functions.

struct wlr_color_transform 

struct wlr_color_transform;

A color transformation formula, which maps a linear color space with sRGB primaries to an output color space.

For ease of use, this type is heap allocated and reference counted. Use wlr_color_transform_ref()/wlr_color_transform_unref(). The initial reference count after creation is 1.

Color transforms are immutable; their type/parameters should not be changed, and this API provides no functions to modify them after creation.

This formula may be implemented using a 3d look-up table, or some other means.

wlr_color_transform_init_linear_to_icc() 

struct wlr_color_transform *wlr_color_transform_init_linear_to_icc(​const void *data, size_t size);

Initialize a color transformation to convert linear (with sRGB(?) primaries) to an ICC profile. Returns NULL on failure.

wlr_color_transform_init_linear_to_inverse_eotf() 

struct wlr_color_transform *wlr_color_transform_init_linear_to_inverse_eotf(​enum wlr_color_transfer_function tf);

Initialize a color transformation to apply EOTF⁻¹ encoding. Returns NULL on failure.

wlr_color_transform_init_lut_3x1d() 

struct wlr_color_transform *wlr_color_transform_init_lut_3x1d(​size_t dim, const uint16_t *r, const uint16_t *g, const uint16_t *b);

Initialize a color transformation to apply three 1D look-up tables. dim is the number of elements in each individual LUT. Returns NULL on failure.

wlr_color_transform_ref() 

struct wlr_color_transform *wlr_color_transform_ref(​struct wlr_color_transform *tr);

Increase the reference count of the color transform by 1.

wlr_color_transform_unref() 

void wlr_color_transform_unref(​struct wlr_color_transform *tr);

Reduce the reference count of the color transform by 1; freeing it and all associated resources when the reference count hits zero.