/usr/include/OGRE/OgreAlignedAllocator.h is in libogre-dev 1.7.4+dfsg1-7.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 | /*
-----------------------------------------------------------------------------
This source file is part of OGRE
(Object-oriented Graphics Rendering Engine)
For the latest info, see http://www.ogre3d.org/
Copyright (c) 2000-2011 Torus Knot Software Ltd
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS 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 SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
-----------------------------------------------------------------------------
*/
#ifndef __AlignedAllocator_H__
#define __AlignedAllocator_H__
// Now we're only including this within OgreMemoryAllocatorConfig.h which is already in
// the prerequisites header (circlar reference)
//#include "OgrePrerequisites.h"
namespace Ogre {
/** \addtogroup Core
* @{
*/
/** \addtogroup Memory
* @{
*/
/** Class to provide aligned memory allocate functionality.
@remarks
All SIMD processing are friendly with aligned memory, and some SIMD routines
are designed for working with aligned memory only. If the data are intended to
use SIMD processing, it's need to be aligned for better performance boost.
In additional, most time cache boundary aligned data also lead to better
performance even if didn't used SIMD processing. So this class provides a couple
of functions for allocate aligned memory.
@par
Anyways, in general, you don't need to use this class directly, Ogre internally
will take care with most SIMD and cache friendly optimisation if possible.
@par
This isn't a "one-step" optimisation, there are a lot of underlying work to
achieve performance boost. If you didn't know what are you doing or what there
are going, just ignore this class.
@note
This class intended to use by advanced user only.
*/
class _OgreExport AlignedMemory
{
public:
/** Allocate memory with given alignment.
@param
size The size of memory need to allocate.
@param
alignment The alignment of result pointer, must be power of two
and in range [1, 128].
@returns
The allocated memory pointer.
@par
On failure, exception will be throw.
*/
static void* allocate(size_t size, size_t alignment);
/** Allocate memory with default platform dependent alignment.
@remarks
The default alignment depend on target machine, this function
guarantee aligned memory according with SIMD processing and
cache boundary friendly.
@param
size The size of memory need to allocate.
@returns
The allocated memory pointer.
@par
On failure, exception will be throw.
*/
static void* allocate(size_t size);
/** Deallocate memory that allocated by this class.
@param
p Pointer to the memory allocated by this class or <b>NULL</b> pointer.
@par
On <b>NULL</b> pointer, nothing happen.
*/
static void deallocate(void* p);
};
/** @} */
/** @} */
}
#endif // __AlignedAllocator_H__
|