aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--libglitter.h2
-rw-r--r--libglitter_create_render_context.37
2 files changed, 9 insertions, 0 deletions
diff --git a/libglitter.h b/libglitter.h
index 9b2f30f..27dfd0d 100644
--- a/libglitter.h
+++ b/libglitter.h
@@ -172,6 +172,8 @@ int libglitter_enable_acceleration(uint64_t, int, void (*)(int, int, void *), vo
* the other one is 1, `ncellvalues` will not be used as it is preknown
* that all its values are 1; in the future this could also happen for
* other situations where `noutputs == widthmul * heightmul`
+ *
+ * The returned object will contain references to `cellmap` and `ncellvalues`
*/
LIBGLITTER_RENDER_CONTEXT *libglitter_create_render_context(size_t, size_t, size_t, size_t,
const uint8_t *, const uint8_t *);
diff --git a/libglitter_create_render_context.3 b/libglitter_create_render_context.3
index 574ccf6..d69c9f7 100644
--- a/libglitter_create_render_context.3
+++ b/libglitter_create_render_context.3
@@ -99,6 +99,13 @@ shall be the number of times the value
appears in
.IR cellmap .
.RE
+.PP
+The returned object will contain references to
+.I cellmap
+and
+.IR ncellvalues .
+This means that they must remain in memory and
+unmodified for the lifetime of the returned object.
.SH RETURN VALUES
The
.BR libglitter_create_render_context ()