Skip to content

Commit 9cebc19

Browse files
josuahkartben
authored andcommitted
doc: releases: 4.1: announce switch to video_bits_per_pixel()
The previous commit introduces video_bits_per_pixel() and converts all invocation relying on video_pix_fmt_bpp(), 3rd-party users will need to do the same on their code, and this is not a 100% drop-in API, so better document it on the release notes. Signed-off-by: Josuah Demangeon <[email protected]>
1 parent 21da345 commit 9cebc19

File tree

2 files changed

+8
-0
lines changed

2 files changed

+8
-0
lines changed

doc/releases/migration-guide-4.1.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -354,6 +354,11 @@ Video
354354
The new ``video-controls.h`` source now contains description of each control ID to help
355355
disambiguating.
356356

357+
* The ``video_pix_fmt_bpp()`` function was returning a byte count, this got replaced by
358+
``video_bits_per_pixel()`` which return a bit count. For instance, invocations such as
359+
``pitch = width * video_pix_fmt_bpp(pixfmt)`` needs to be replaced by an equivalent
360+
``pitch = width * video_bits_per_pixel(pixfmt) / BITS_PER_BYTE``.
361+
357362
Watchdog
358363
========
359364

doc/releases/release-notes-4.1.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -300,6 +300,9 @@ Drivers and Sensors
300300
* Changed :file:`include/zephyr/drivers/video-controls.h` to have control IDs (CIDs) matching
301301
those present in the Linux kernel.
302302

303+
* Changed ``video_pix_fmt_bpp()`` returning the byte count and only supports 8-bit depth,
304+
into ``video_bits_per_pixel()`` returning the bit count and supports any color depth.
305+
303306
* Watchdog
304307

305308
* Added :kconfig:option:`CONFIG_HAS_WDT_NO_CALLBACKS` which drivers select when they do not support

0 commit comments

Comments
 (0)