From 907bacea13fff7939edf67fba5b3a6eaf9f1f5dc Mon Sep 17 00:00:00 2001 From: Simon Ser Date: Thu, 28 May 2020 12:27:07 +0200 Subject: [PATCH] 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 Reviewed-by: Daniel Stone Reviewed-by: Eric Anholt Part-of: --- src/gbm/main/gbm.c | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/src/gbm/main/gbm.c b/src/gbm/main/gbm.c index ceeed5082e9..954b3c35b0d 100644 --- a/src/gbm/main/gbm.c +++ b/src/gbm/main/gbm.c @@ -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 -- 2.30.2