returnBuffer.h

Classes:

class
Simple circular buffer class for temporary return storage.
Detailed Description

 1
 2//-----------------------------------------------------------------------------
 3// Copyright (c) 2012 GarageGames, LLC
 4//
 5// Permission is hereby granted, free of charge, to any person obtaining a copy
 6// of this software and associated documentation files (the "Software"), to
 7// deal in the Software without restriction, including without limitation the
 8// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
 9// sell copies of the Software, and to permit persons to whom the Software is
10// furnished to do so, subject to the following conditions:
11//
12// The above copyright notice and this permission notice shall be included in
13// all copies or substantial portions of the Software.
14//
15// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
20// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
21// IN THE SOFTWARE.
22//-----------------------------------------------------------------------------
23
24#ifndef _RETURNBUFFER_H_
25#define _RETURNBUFFER_H_
26
27#ifndef _PLATFORM_H_
28   #include <platform/platform.h>
29#endif
30
31/// Simple circular buffer class for temporary return storage.
32class ReturnBuffer
33{
34   char *mBuffer;
35   U32 mBufferSize;
36   U32 mStart;
37
38   /// Possibly expand the buffer to be larger than newSize
39   void ensureSize(U32 newSize);
40
41public:
42   ReturnBuffer();
43   ~ReturnBuffer();
44
45   /// Get a temporary buffer with a given size (and alignment)
46   /// @note The buffer will be re-used so do not consider it permanent
47   char *getBuffer(U32 size, U32 alignment = 16);
48};
49
50#endif //_RETURNBUFFER_H_
51