aboutsummaryrefslogtreecommitdiffstats
path: root/src
diff options
context:
space:
mode:
authorSimon Ser <[email protected]>2020-05-28 12:27:07 +0200
committerMarge Bot <[email protected]>2020-06-03 10:09:52 +0000
commit907bacea13fff7939edf67fba5b3a6eaf9f1f5dc (patch)
treee6c418c6b42e465d46a25052131ed6ab6f317ff0 /src
parent9f3956fea080d73d98fc28bc8cd148755b597b74 (diff)
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 <[email protected]> Reviewed-by: Daniel Stone <[email protected]> Reviewed-by: Eric Anholt <[email protected]> Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/5238>
Diffstat (limited to 'src')
-rw-r--r--src/gbm/main/gbm.c5
1 files changed, 5 insertions, 0 deletions
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