/* -*- tab-width: 4; -*- */
/* vi: set sw=2 ts=4: */

/*
Copyright (c) 2010 The Khronos Group Inc.

Permission is hereby granted, free of charge, to any person obtaining a
copy of this software and/or associated documentation files (the
"Materials"), to deal in the Materials without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Materials, and to
permit persons to whom the Materials are furnished to do so, subject to
the following conditions:

The above copyright notice and this permission notice shall be included
unaltered in all copies or substantial portions of the Materials.
Any additions, deletions, or changes to the original source files
must be clearly indicated in accompanying documentation.

If only executable code is distributed, then the accompanying
documentation must state that "this software is based in part on the
work of the Khronos Group".

THE MATERIALS ARE PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
MATERIALS OR THE USE OR OTHER DEALINGS IN THE MATERIALS.
*/

/*
 * Author: Maksim Kolesin from original code
 * by Mark Callow and Georg Kolling
 */

#ifndef _KTXSTREAM_H_
#define _KTXSTREAM_H_

#include "ktx.h"

/* @private is not preventing the typedefs, structs and defines from
 * appearing in the Doxygen output even though EXTRACT_PRIVATE is NO
 * in the config file. To prevent these items appearing I have changed
 * the special comments to ordinary comments, and have set
 * HIDE_UNDOC_MEMBERS = YES in the Doxygen config file.
 *
 * Items declared "static" are omitted, as expected, due to EXTRACT_STATIC
 * being NO, so there is no need to convert those to ordinary comments.
 */
/*
 * @private
 * @~English
 * @brief type for a pointer to a stream reading function
 */
typedef KTX_error_code(*ktxStream_read)(void* dst, const GLsizei count, void* src);
/*
 * @private
 * @~English
 * @brief type for a pointer to a stream skipping function
 */
typedef KTX_error_code(*ktxStream_skip)(const GLsizei count, void* src);
/*
 * @private
 * @~English
 * @brief type for a pointer to a stream reading function
 */
typedef KTX_error_code(*ktxStream_write)(const void *src, const GLsizei size, const GLsizei count, void* dst);

/*
 * @private
 * @~English
 * @brief KTX stream interface
 */
struct ktxStream
{
	void* src;                              /**< pointer to the stream source */
	ktxStream_read read;    /**< pointer to function for reading bytes */
	ktxStream_skip skip;    /**< pointer to function for skipping bytes */
	ktxStream_write write;  /**< pointer to function for writing bytes */
};

#endif /* _KTXSTREAM_H_ */