summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNicolai Hähnle <nicolai.haehnle@amd.com>2017-12-05 11:03:35 +0100
committerNicolai Hähnle <nicolai.haehnle@amd.com>2018-03-14 09:04:05 +0100
commita8c0eb215b496817e2262104c800b2e0d6a2105e (patch)
treea9d1f4cda26d542eac4f72b4cc81d17fc13f7a45
parent2afbc57fe66dd37c4be8513a7e3135aeae008df2 (diff)
dri_interface: document error behavior of mapImage
This function is meant to return NULL on error, unlike some other APIs (such as mmap()), which return MAP_FAILED.
-rw-r--r--include/GL/internal/dri_interface.h2
1 files changed, 2 insertions, 0 deletions
diff --git a/include/GL/internal/dri_interface.h b/include/GL/internal/dri_interface.h
index 4f4795c7ae..3c8bbe5ff8 100644
--- a/include/GL/internal/dri_interface.h
+++ b/include/GL/internal/dri_interface.h
@@ -1562,6 +1562,8 @@ struct __DRIimageExtensionRec {
* Returns the byte stride in *stride, and an opaque pointer to data
* tracking the mapping in **data, which must be passed to unmapImage().
*
+ * Returns NULL on error.
+ *
* \since 12
*/
void *(*mapImage)(__DRIcontext *context, __DRIimage *image,