gmio/src/gmio_core/streampos.h
2016-01-20 18:23:09 +01:00

48 lines
1.5 KiB
C

/****************************************************************************
** gmio
** Copyright Fougue (2 Mar. 2015)
** contact@fougue.pro
**
** This software is a reusable library whose purpose is to provide complete
** I/O support for various CAD file formats (eg. STL)
**
** This software is governed by the CeCILL-B license under French law and
** abiding by the rules of distribution of free software. You can use,
** modify and/ or redistribute the software under the terms of the CeCILL-B
** license as circulated by CEA, CNRS and INRIA at the following URL
** "http://www.cecill.info/licences/Licence_CeCILL-B_V1-en.html".
****************************************************************************/
/*! \file streampos.h
* Declaration of gmio_streampos and utility functions
*
* \addtogroup gmio_core
* @{
*/
#ifndef GMIO_STREAMPOS_H
#define GMIO_STREAMPOS_H
#include "global.h"
/*! Size of the byte array gmio_streampos::cookie */
enum { GMIO_STREAMPOS_COOKIE_SIZE = 32 /* bytes */ };
/*! Specifies a position within a stream
*
* The information in gmio_streampos objects is usually filled by a call to
* gmio_stream::func_get_pos(), which takes a pointer to an object of this type
* as argument.
*
* The content of a gmio_streampos object is not meant to be read directly,
* but only to be used as an argument in a call to gmio_stream::func_set_pos()
*/
struct gmio_streampos
{
/*! Stores the actual(concrete) stream position object */
uint8_t cookie[GMIO_STREAMPOS_COOKIE_SIZE];
};
#endif /* GMIO_STREAMPOS_H */
/*! @} */