gbm: document that gbm_bo_map exposes a linear view

Drivers (Gallium, i965) expose a linear view of the buffer via
gbm_bo_map.

Signed-off-by: Simon Ser <contact@emersion.fr>
Reviewed-by: Daniel Stone <daniel@fooishbar.org>
Reviewed-by: Eric Anholt <eric@anholt.net>
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/5238>
This commit is contained in:
Simon Ser
2020-05-28 12:27:07 +02:00
committed by Marge Bot
parent 9f3956fea0
commit 907bacea13

View File

@@ -534,6 +534,11 @@ gbm_bo_import(struct gbm_device *gbm,
* This function maps a region of a gbm bo for cpu read and/or write
* access.
*
* The mapping exposes a linear view of the buffer object even if the buffer
* has a non-linear modifier.
*
* This function may require intermediate buffer copies (ie. it may be slow).
*
* \param bo The buffer object
* \param x The X (top left origin) starting position of the mapped region for
* the buffer