decode_planar_parallel: add doxygen documenation

mainly important is the notice that decoding to planar formats (currently
to i420) should not be used
This commit is contained in:
Martin Pulec
2026-03-02 12:56:32 +01:00
parent e667364445
commit 4e8e2fa652

View File

@@ -65,9 +65,18 @@ struct from_planar_data {
/// functions to decode whole buffer of packed data to planar or packed
typedef void decode_planar_func_t(struct from_planar_data d);
void decode_planar_parallel(decode_planar_func_t *dec,
struct from_planar_data d, int num_threads);
/**
* run the @ref decode_planar_func_t in parallel
* @param dec fn to run, must be to packed format (or set num_threads=1
* if the conversion is to a planar format)
* @param num_threads number of threads (0 = auto - use the number of logical
* cores)
*/
void decode_planar_parallel(decode_planar_func_t *dec,
struct from_planar_data d, int num_threads);
// XX in the conversion names below indicates that in_depth must be set.
// If =8, byte per input sample is used, if >8, 16 bits.
decode_planar_func_t gbrap_to_rgb;
decode_planar_func_t gbrap_to_rgba;
decode_planar_func_t gbrp10le_to_rgb;