diff options
| author | Mattias Andrée <maandree@kth.se> | 2023-01-26 21:58:22 +0100 |
|---|---|---|
| committer | Mattias Andrée <maandree@kth.se> | 2023-01-26 21:58:22 +0100 |
| commit | fe9be4a42abe4c7ddc06881efd47cc61d0e60076 (patch) | |
| tree | ffdf982723a8ae111f5f37a99689569beb574780 | |
| parent | m (diff) | |
| download | libglitter-fe9be4a42abe4c7ddc06881efd47cc61d0e60076.tar.gz libglitter-fe9be4a42abe4c7ddc06881efd47cc61d0e60076.tar.bz2 libglitter-fe9be4a42abe4c7ddc06881efd47cc61d0e60076.tar.xz | |
m doc
Signed-off-by: Mattias Andrée <maandree@kth.se>
| -rw-r--r-- | libglitter.h | 2 | ||||
| -rw-r--r-- | libglitter_create_render_context.3 | 7 |
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 () |