/usr/include/CEGUI/CEGUITexture.h is in libcegui-mk2-dev 0.7.6-2ubuntu4.
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 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 | /***********************************************************************
filename: CEGUITexture.h
created: 21/2/2004
author: Paul D Turner
purpose: Defines abstract interface for texture objects. Texture
objects are created & destroyed by the Renderer.
*************************************************************************/
/***************************************************************************
* Copyright (C) 2004 - 2009 Paul D Turner & The CEGUI Development Team
*
* 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 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 _CEGUITexture_h_
#define _CEGUITexture_h_
#include "CEGUIBase.h"
#include "CEGUIString.h"
// Start of CEGUI namespace section
namespace CEGUI
{
/*!
\brief
Abstract base class specifying the required interface for Texture objects.
Texture objects are created via the Renderer. The actual inner workings of
any Texture object are dependant upon the Renderer (and underlying API) in
use. This base class defines the minimal set of functions that is required
for the rest of the system to work. Texture objects are only created
through the Renderer object's texture creation functions.
*/
class CEGUIEXPORT Texture
{
public:
/*!
\brief
Enumerated type containing the supported pixel formats that can be
passed to loadFromMemory
*/
enum PixelFormat
{
//! Each pixel is 3 bytes. RGB in that order.
PF_RGB,
//! Each pixel is 4 bytes. RGBA in that order.
PF_RGBA
};
/*!
\brief
Returns the current pixel size of the texture.
\return
Reference to a Size object that describes the size of the texture in
pixels.
*/
virtual const Size& getSize() const = 0;
/*!
\brief
Returns the original pixel size of the data loaded into the texture.
\return
reference to a Size object that describes the original size, in pixels,
of the data loaded into the texture.
*/
virtual const Size& getOriginalDataSize() const = 0;
/*!
\brief
Returns pixel to texel scale values that should be used for converting
pixel values to texture co-ords.
\return
Reference to a Vector2 object that describes the scaling values required
to accurately map pixel positions to texture co-ordinates.
*/
virtual const Vector2& getTexelScaling() const = 0;
/*!
\brief
Loads the specified image file into the texture. The texture is resized
as required to hold the image.
\param filename
The filename of the image file that is to be loaded into the texture
\param resourceGroup
Resource group identifier to be passed to the resource provider when
loading the image file.
\return
Nothing.
*/
virtual void loadFromFile(const String& filename,
const String& resourceGroup) = 0;
/*!
\brief
Loads (copies) an image in memory into the texture. The texture is
resized as required to hold the image.
\param buffer
Pointer to the buffer containing the image data.
\param buffer_size
Size of the buffer (in pixels as specified by \a pixelFormat)
\param pixel_format
PixelFormat value describing the format contained in \a buffPtr.
\return
Nothing.
*/
virtual void loadFromMemory(const void* buffer,
const Size& buffer_size,
PixelFormat pixel_format) = 0;
/*!
\brief
Save / dump the content of the texture to a memory buffer. The dumped
pixel format is always RGBA (4 bytes per pixel).
\param buffer
Pointer to the buffer that is to receive the image data. You must make
sure that this buffer is large enough to hold the dumped texture data,
the required pixel dimensions can be established by calling getSize.
*/
virtual void saveToMemory(void* buffer) = 0;
/*!
\brief
Destructor for Texture base class.
*/
virtual ~Texture() {}
};
} // End of CEGUI namespace section
#endif // end of guard _CEGUITexture_h_
|