include/IMemoryReadFile.h

   1 // Copyright Michael Zeilfelder\r
   2 // This file is part of the "Irrlicht Engine".\r
   3 // For conditions of distribution and use, see copyright notice in irrlicht.h\r
   4 \r
   5 #ifndef __I_MEMORY_READ_FILE_H_INCLUDED__\r
   6 #define __I_MEMORY_READ_FILE_H_INCLUDED__\r
   7 \r
   8 #include "IReadFile.h"\r
   9 \r
  10 namespace irr\r
  11 {\r
  12 namespace io\r
  13 {\r
  14 \r
  15         //! Interface providing read access to a memory read file.\r
  16         class IMemoryReadFile : public IReadFile\r
  17         {\r
  18         public:\r
  19                 //! Get direct access to internal buffer of memory block used as file.\r
  20                 /** It's usually better to use the IReadFile functions to access\r
  21                 the file content. But as that buffer exist over the full life-time\r
  22                 of a CMemoryReadFile, it's sometimes nice to avoid the additional\r
  23                 data-copy which read() needs.\r
  24                 */\r
  25                 virtual const void *getBuffer() const = 0;\r
  26         };\r
  27 } // end namespace io\r
  28 } // end namespace irr\r
  29 \r
  30 #endif\r
  31 \r