OgreFreeImageCodec.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 _FreeImageCodec_H__
29 #define _FreeImageCodec_H__
30 
31 #include "OgreImageCodec.h"
32 // Forward-declaration to avoid external dependency on FreeImage
33 struct FIBITMAP;
34 
35 namespace Ogre {
36 
49  {
50  private:
52  unsigned int mFreeImageType;
53 
56 
58  FIBITMAP* encodeBitmap(MemoryDataStreamPtr& input, CodecDataPtr& pData) const;
59 
60  public:
61  FreeImageCodec(const String &type, unsigned int fiType);
62  virtual ~FreeImageCodec() { }
63 
67  void encodeToFile(MemoryDataStreamPtr& input, const String& outFileName, CodecDataPtr& pData) const;
70 
71 
72  virtual String getType() const;
73 
75  String magicNumberToFileExt(const char *magicNumberPtr, size_t maxbytes) const;
76 
78  static void startup(void);
80  static void shutdown(void);
81  };
85 } // namespace
86 
87 #endif
#define _OgreExport
Definition: OgrePlatform.h:257
std::pair< MemoryDataStreamPtr, CodecDataPtr > DecodeResult
Result of a decoding; both a decoded data stream and CodecData metadata.
Definition: OgreCodec.h:141
Codec specialized in images loaded using FreeImage.
list< ImageCodec * >::type RegisteredCodecList
virtual String getType() const
Returns the type of the codec as a String.
void encodeToFile(MemoryDataStreamPtr &input, const String &outFileName, CodecDataPtr &pData) const
Codes the data in the input chunk and saves the result in the output filename provided.
DataStreamPtr encode(MemoryDataStreamPtr &input, CodecDataPtr &pData) const
Codes the data in the input stream and saves the result in the output stream.
String magicNumberToFileExt(const char *magicNumberPtr, size_t maxbytes) const
Maps a magic number header to a file extension, if this codec recognises it.
DecodeResult decode(DataStreamPtr &input) const
Codes the data from the input chunk into the output chunk.
FreeImageCodec(const String &type, unsigned int fiType)
static RegisteredCodecList msCodecList
FIBITMAP * encodeBitmap(MemoryDataStreamPtr &input, CodecDataPtr &pData) const
Common encoding routine.
static void shutdown(void)
Static method to shutdown FreeImage and unregister the FreeImage codecs.
static void startup(void)
Static method to startup FreeImage and register the FreeImage codecs.
Codec specialized in images.
Reference-counted shared pointer, used for objects where implicit destruction is required.
_StringBase String
std::list< T, A > type

Copyright © 2012 Torus Knot Software Ltd
Creative Commons License
This work is licensed under a Creative Commons Attribution-ShareAlike 3.0 Unported License.