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-01-16 20:15:31 +0100
commitaeb0f798768d33b76263ac4f6ea06fce35cc9cfa (patch)
tree6b6dbc9200a8a204e809955a2722a026d8bb6594
parent8045f01e2a1879b1266281e64fe292b038766168 (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 34a5c9fb01..f72531a7a9 100644
--- a/include/GL/internal/dri_interface.h
+++ b/include/GL/internal/dri_interface.h
@@ -1536,6 +1536,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,