From 78a1ac540ec1bd1e336f066f6691451643e7b99d Mon Sep 17 00:00:00 2001 From: Simon Ser Date: Wed, 10 May 2023 18:52:56 +0200 Subject: [PATCH] render/pixel-format: add docs --- include/render/pixel_format.h | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/include/render/pixel_format.h b/include/render/pixel_format.h index f5b67d031..04a095b29 100644 --- a/include/render/pixel_format.h +++ b/include/render/pixel_format.h @@ -3,6 +3,11 @@ #include +/** + * Information about a pixel format. + * + * A pixel format is identified via its DRM four character code (see ). + */ struct wlr_pixel_format_info { uint32_t drm_format; @@ -18,11 +23,25 @@ struct wlr_pixel_format_info { bool has_alpha; }; +/** + * Get pixel format information from a DRM FourCC. + * + * NULL is returned if the pixel format is unknown. + */ const struct wlr_pixel_format_info *drm_get_pixel_format_info(uint32_t fmt); +/** + * Check whether a stride is large enough for a given pixel format and width. + */ bool pixel_format_info_check_stride(const struct wlr_pixel_format_info *info, int32_t stride, int32_t width); +/** + * Convert an enum wl_shm_format to a DRM FourCC. + */ uint32_t convert_wl_shm_format_to_drm(enum wl_shm_format fmt); +/** + * Convert a DRM FourCC to an enum wl_shm_format. + */ enum wl_shm_format convert_drm_format_to_wl_shm(uint32_t fmt); #endif