OgreImage.h
Go to the documentation of this file.
1 /*
2 -----------------------------------------------------------------------------
3 This source file is part of OGRE
4  (Object-oriented Graphics Rendering Engine)
5 For the latest info, see http://www.ogre3d.org/
6 
7 Copyright (c) 2000-2013 Torus Knot Software Ltd
8 
9 Permission is hereby granted, free of charge, to any person obtaining a copy
10 of this software and associated documentation files (the "Software"), to deal
11 in the Software without restriction, including without limitation the rights
12 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
13 copies of the Software, and to permit persons to whom the Software is
14 furnished to do so, subject to the following conditions:
15 
16 The above copyright notice and this permission notice shall be included in
17 all copies or substantial portions of the Software.
18 
19 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
20 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
21 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
22 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
23 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
24 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
25 THE SOFTWARE.
26 -----------------------------------------------------------------------------
27 */
28 #ifndef _Image_H__
29 #define _Image_H__
30 
31 #include "OgrePrerequisites.h"
32 #include "OgreCommon.h"
33 #include "OgrePixelFormat.h"
34 #include "OgreDataStream.h"
35 
36 namespace Ogre {
45  {
46  IF_COMPRESSED = 0x00000001,
47  IF_CUBEMAP = 0x00000002,
48  IF_3D_TEXTURE = 0x00000004
49  };
61  class _OgreExport Image : public ImageAlloc
62  {
63  public:
64  typedef Ogre::Box Box;
65  typedef Ogre::Rect Rect;
66  public:
69  Image();
72  Image( const Image &img );
73 
76  virtual ~Image();
77 
80  Image & operator = ( const Image & img );
81 
101  Image & flipAroundY();
102 
117  Image & flipAroundX();
118 
165  Image& loadDynamicImage( uchar* data, uint32 width, uint32 height,
166  uint32 depth,
167  PixelFormat format, bool autoDelete = false,
168  size_t numFaces = 1, uint8 numMipMaps = 0);
169 
206  uint32 height, PixelFormat format)
207  {
208  return loadDynamicImage(data, width, height, 1, format);
209  }
229  Image & loadRawData(
230  DataStreamPtr& stream,
231  uint32 width, uint32 height, uint32 depth,
232  PixelFormat format,
233  size_t numFaces = 1, size_t numMipMaps = 0);
254  DataStreamPtr& stream,
255  uint32 width, uint32 height,
256  PixelFormat format )
257  {
258  return loadRawData(stream, width, height, 1, format);
259  }
260 
276  Image & load( const String& filename, const String& groupName );
277 
298  Image & load(DataStreamPtr& stream, const String& type = StringUtil::BLANK );
299 
310  Image & loadTwoImagesAsRGBA(const String& rgbFilename, const String& alphaFilename,
311  const String& groupName, PixelFormat format = PF_BYTE_RGBA);
312 
328  Image & loadTwoImagesAsRGBA(DataStreamPtr& rgbStream, DataStreamPtr& alphaStream, PixelFormat format = PF_BYTE_RGBA,
329  const String& rgbType = StringUtil::BLANK, const String& alphaType = StringUtil::BLANK);
330 
340  Image & combineTwoImagesAsRGBA(const Image& rgb, const Image& alpha, PixelFormat format = PF_BYTE_RGBA);
341 
342 
352  void save(const String& filename);
353 
358  DataStreamPtr encode(const String& formatextension);
359 
366  uchar* getData(void);
367 
374  const uchar * getData() const;
375 
378  size_t getSize() const;
379 
382  uint8 getNumMipmaps() const;
383 
386  bool hasFlag(const ImageFlags imgFlag) const;
387 
390  uint32 getWidth(void) const;
391 
394  uint32 getHeight(void) const;
395 
398  uint32 getDepth(void) const;
399 
403  size_t getNumFaces(void) const;
404 
407  size_t getRowSpan(void) const;
408 
411  PixelFormat getFormat() const;
412 
415  uchar getBPP() const;
416 
419  bool getHasAlpha() const;
420 
426  static void applyGamma( uchar *buffer, Real gamma, size_t size, uchar bpp );
427 
433  ColourValue getColourAt(size_t x, size_t y, size_t z) const;
434 
440  void setColourAt(ColourValue const &cv, size_t x, size_t y, size_t z);
441 
445  PixelBox getPixelBox(size_t face = 0, size_t mipmap = 0) const;
446 
448  void freeMemory();
449 
450  enum Filter
451  {
457  FILTER_BICUBIC
458  };
466  static void scale(const PixelBox &src, const PixelBox &dst, Filter filter = FILTER_BILINEAR);
467 
469  void resize(ushort width, ushort height, Filter filter = FILTER_BILINEAR);
470 
472  static size_t calculateSize(size_t mipmaps, size_t faces, uint32 width, uint32 height, uint32 depth, PixelFormat format);
473 
475  static String getFileExtFromMagic(DataStreamPtr stream);
476 
477  protected:
485  size_t mBufSize;
489  int mFlags;
490 
493 
497 
500  };
501 
504 
508 } // namespace
509 
510 #endif

Copyright © 2012 Torus Knot Software Ltd
Creative Commons License
This work is licensed under a Creative Commons Attribution-ShareAlike 3.0 Unported License.
Last modified Wed Oct 23 2013 06:57:24