diff options
author | Sebastian Rasmussen <sebras@gmail.com> | 2016-08-21 01:37:49 +0800 |
---|---|---|
committer | Sebastian Rasmussen <sebras@gmail.com> | 2016-08-22 22:27:57 +0800 |
commit | cb375a3bd6a845fe0e3b8079358dc5c3bf3a994e (patch) | |
tree | 882182a7e6313304cb21ff0ea4bbd4e7e0c287f3 /include | |
parent | 269f40b7e103521f9b93a9e9d8ea61577fb3fbdf (diff) | |
download | mupdf-cb375a3bd6a845fe0e3b8079358dc5c3bf3a994e.tar.xz |
Document part of fz_stream interface.
Diffstat (limited to 'include')
-rw-r--r-- | include/mupdf/fitz/stream.h | 11 |
1 files changed, 11 insertions, 0 deletions
diff --git a/include/mupdf/fitz/stream.h b/include/mupdf/fitz/stream.h index ea7b57f3..9baf0e0f 100644 --- a/include/mupdf/fitz/stream.h +++ b/include/mupdf/fitz/stream.h @@ -226,6 +226,17 @@ struct fz_stream_s fz_stream_meta_fn *meta; }; +/* + fz_new_stream: Create a new stream object with the given + internal state and function pointers. + + next: Should provide the next set of bytes (up to max) of stream + data. Return the number of bytes read, or EOF when there is no + more data. + + close: Should clean up and free the internal state. May not + throw exceptions. +*/ fz_stream *fz_new_stream(fz_context *ctx, void *state, fz_stream_next_fn *next, fz_stream_close_fn *close); fz_stream *fz_keep_stream(fz_context *ctx, fz_stream *stm); |