wp_image_description_info_v1¤
Colorimetric image description information
Sends all matching events describing an image description object exactly once and finally sends the 'done' event.
This means - if the image description is parametric, it must send - primaries - named_primaries, if applicable - at least one of tf_power and tf_named, as applicable - luminances - target_primaries - target_luminance - if the image description is parametric, it may send, if applicable, - target_max_cll - target_max_fall - if the image description contains an ICC profile, it must send the icc_file event
Once a wp_image_description_info_v1 object has delivered a 'done' event it is automatically destroyed.
Every wp_image_description_info_v1 created from the same wp_image_description_v1 shall always return the exact same data.
Methods:
-
on_done–End of information.
-
on_icc_file–Icc profile matching the image description.
-
on_primaries–Primaries as chromaticity coordinates.
-
on_primaries_named–Named primaries.
-
on_tf_power–Transfer characteristic as a power curve.
-
on_tf_named–Named transfer characteristic.
-
on_luminances–Primary color volume luminance range and reference white.
-
on_target_primaries–Target primaries as chromaticity coordinates.
-
on_target_luminance–Target luminance range.
-
on_target_max_cll–Target maximum content light level.
-
on_target_max_fall–Target maximum frame-average light level.
done() -> None
End of information
Signals the end of information events and destroys the object.
Icc profile matching the image description
The icc argument provides a file descriptor to the client which may be memory-mapped to provide the ICC profile matching the image description. The fd is read-only, and if mapped then it must be mapped with MAP_PRIVATE by the client.
The ICC profile version and other details are determined by the compositor. There is no provision for a client to ask for a specific kind of a profile.
Parameters:
Primaries as chromaticity coordinates
Delivers the primary color volume primaries and white point using CIE 1931 xy chromaticity coordinates.
Each coordinate value is multiplied by 1 million to get the argument value to carry precision of 6 decimals.
Parameters:
Transfer characteristic as a power curve
The color component transfer characteristic of this image description is a pure power curve. This event provides the exponent of the power function. This curve represents the conversion from electrical to optical pixel or color values.
The curve exponent has been multiplied by 10000 to get the argument eexp value to carry the precision of 4 decimals.
Parameters:
tf_named(tf: transfer_function) -> None
Named transfer characteristic
Delivers the transfer characteristic using an explicitly enumerated named function.
Parameters:
-
(tf¤transfer_function) –Named transfer function
Primary color volume luminance range and reference white
Delivers the primary color volume luminance range and the reference white luminance level. These values include the minimum display emission and ambient flare luminances, assumed to be optically additive and have the chromaticity of the primary color volume white point.
The minimum luminance is multiplied by 10000 to get the argument 'min_lum' value and carries precision of 4 decimals. The maximum luminance and reference white luminance values are unscaled.
Parameters:
target_primaries(
r_x: int, r_y: int, g_x: int, g_y: int, b_x: int, b_y: int, w_x: int, w_y: int
) -> None
Target primaries as chromaticity coordinates
Provides the color primaries and white point of the target color volume using CIE 1931 xy chromaticity coordinates. This is compatible with the SMPTE ST 2086 definition of HDR static metadata for mastering displays.
While primary color volume is about how color is encoded, the target color volume is the actually displayable color volume. If target color volume is equal to the primary color volume, then this event is not sent.
Each coordinate value is multiplied by 1 million to get the argument value to carry precision of 6 decimals.
Parameters:
Target luminance range
Provides the luminance range that the image description is targeting as the minimum and maximum absolute luminance L. These values include the minimum display emission and ambient flare luminances, assumed to be optically additive and have the chromaticity of the primary color volume white point. This should be compatible with the SMPTE ST 2086 definition of HDR static metadata.
This luminance range is only theoretical and may not correspond to the luminance of light emitted on an actual display.
Min L value is multiplied by 10000 to get the argument min_lum value and carry precision of 4 decimals. Max L value is unscaled for max_lum.
Parameters:
Target maximum content light level
Provides the targeted max_cll of the image description. max_cll is defined by CTA-861-H.
This luminance is only theoretical and may not correspond to the luminance of light emitted on an actual display.
Parameters:
Target maximum frame-average light level
Provides the targeted max_fall of the image description. max_fall is defined by CTA-861-H.
This luminance is only theoretical and may not correspond to the luminance of light emitted on an actual display.
Parameters:
on_done() -> None
End of information.
Override to handle wayland.wp_image_description_info_v1.events.done.
on_icc_file(icc: fd, icc_size: int) -> None
Icc profile matching the image description.
Override to handle wayland.wp_image_description_info_v1.events.icc_file.
on_primaries(
r_x: int, r_y: int, g_x: int, g_y: int, b_x: int, b_y: int, w_x: int, w_y: int
) -> None
Primaries as chromaticity coordinates.
Override to handle wayland.wp_image_description_info_v1.events.primaries.
on_primaries_named(primaries: primaries) -> None
Named primaries.
Override to handle wayland.wp_image_description_info_v1.events.primaries_named.
on_tf_power(eexp: int) -> None
Transfer characteristic as a power curve.
Override to handle wayland.wp_image_description_info_v1.events.tf_power.
on_tf_named(tf: transfer_function) -> None
Named transfer characteristic.
Override to handle wayland.wp_image_description_info_v1.events.tf_named.
Primary color volume luminance range and reference white.
Override to handle wayland.wp_image_description_info_v1.events.luminances.
on_target_primaries(
r_x: int, r_y: int, g_x: int, g_y: int, b_x: int, b_y: int, w_x: int, w_y: int
) -> None
Target primaries as chromaticity coordinates.
Override to handle wayland.wp_image_description_info_v1.events.target_primaries.
Target luminance range.
Override to handle wayland.wp_image_description_info_v1.events.target_luminance.
on_target_max_cll(max_cll: int) -> None
Target maximum content light level.
Override to handle wayland.wp_image_description_info_v1.events.target_max_cll.
on_target_max_fall(max_fall: int) -> None
Target maximum frame-average light level.
Override to handle wayland.wp_image_description_info_v1.events.target_max_fall.