OgreDDSCodec.h
Go to the documentation of this file.
1/*
2-----------------------------------------------------------------------------
3This source file is part of OGRE
4(Object-oriented Graphics Rendering Engine)
5For the latest info, see http://www.ogre3d.org/
6
7Copyright (c) 2000-2013 Torus Knot Software Ltd
8
9Permission is hereby granted, free of charge, to any person obtaining a copy
10of this software and associated documentation files (the "Software"), to deal
11in the Software without restriction, including without limitation the rights
12to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
13copies of the Software, and to permit persons to whom the Software is
14furnished to do so, subject to the following conditions:
15
16The above copyright notice and this permission notice shall be included in
17all copies or substantial portions of the Software.
18
19THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
20IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
21FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
22AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
23LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
24OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
25THE SOFTWARE.
26-----------------------------------------------------------------------------
27*/
28#ifndef __OgreDDSCodec_H__
29#define __OgreDDSCodec_H__
30
31#include "OgreImageCodec.h"
32namespace Ogre {
40 // Forward declarations
41 struct DXTColourBlock;
42 struct DXTExplicitAlphaBlock;
43 struct DXTInterpolatedAlphaBlock;
44
51 {
52 private:
54
55 void flipEndian(void * pData, size_t size, size_t count) const;
56 void flipEndian(void * pData, size_t size) const;
57
61 uint32 gMask, uint32 bMask, uint32 aMask) const;
62
64 void unpackDXTColour(PixelFormat pf, const DXTColourBlock& block, ColourValue* pCol) const;
66 void unpackDXTAlpha(const DXTExplicitAlphaBlock& block, ColourValue* pCol) const;
68 void unpackDXTAlpha(const DXTInterpolatedAlphaBlock& block, ColourValue* pCol) const;
69
72 public:
74 virtual ~DDSCodec() { }
75
79 void encodeToFile(MemoryDataStreamPtr& input, const String& outFileName, CodecDataPtr& pData) const;
83 String magicNumberToFileExt(const char *magicNumberPtr, size_t maxbytes) const;
84
85 virtual String getType() const;
86
88 static void startup(void);
90 static void shutdown(void);
91
92 };
96} // namespace
97
98#endif
99
#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
Class representing colour.
Codec specialized in loading DDS (Direct Draw Surface) images.
Definition: OgreDDSCodec.h:51
virtual ~DDSCodec()
Definition: OgreDDSCodec.h:74
void unpackDXTAlpha(const DXTInterpolatedAlphaBlock &block, ColourValue *pCol) const
Unpack DXT alphas into array of 16 colour values.
DecodeResult decode(DataStreamPtr &input) const
Codes the data from the input chunk into the output chunk.
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.
PixelFormat convertFourCCFormat(uint32 fourcc) const
static void startup(void)
Static method to startup and register the DDS codec.
DataStreamPtr encode(MemoryDataStreamPtr &input, CodecDataPtr &pData) const
Codes the data in the input stream and saves the result in the output stream.
static DDSCodec * msInstance
Single registered codec instance.
Definition: OgreDDSCodec.h:71
PixelFormat convertDXToOgreFormat(uint32 fourcc) const
void flipEndian(void *pData, size_t size, size_t count) const
String magicNumberToFileExt(const char *magicNumberPtr, size_t maxbytes) const
Maps a magic number header to a file extension, if this codec recognises it.
void unpackDXTColour(PixelFormat pf, const DXTColourBlock &block, ColourValue *pCol) const
Unpack DXT colours into array of 16 colour values.
virtual String getType() const
Returns the type of the codec as a String.
static void shutdown(void)
Static method to shutdown and unregister the DDS codec.
void unpackDXTAlpha(const DXTExplicitAlphaBlock &block, ColourValue *pCol) const
Unpack DXT alphas into array of 16 colour values.
void flipEndian(void *pData, size_t size) const
PixelFormat convertPixelFormat(uint32 rgbBits, uint32 rMask, uint32 gMask, uint32 bMask, uint32 aMask) const
Codec specialized in images.
PixelFormat
The pixel format used for images, textures, and render surfaces.
unsigned int uint32
Definition: OgrePlatform.h:359
_StringBase String

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