OgreImageCodec.h
Go to the documentation of this file.
/*
-----------------------------------------------------------------------------
This source file is part of OGRE
(Object-oriented Graphics Rendering Engine)
For the latest info, see http://www.ogre3d.org/
Copyright (c) 2000-2013 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 _ImageCodec_H__
#define _ImageCodec_H__
#include "OgreCodec.h"
#include "OgrePixelFormat.h"
namespace Ogre {
class _OgreExport ImageCodec : public Codec
{
public:
virtual ~ImageCodec();
class _OgrePrivate ImageData : public Codec::CodecData
{
public:
ImageData():
height(0), width(0), depth(1), size(0),
num_mipmaps(0), flags(0), format(PF_UNKNOWN)
{
}
uint32 height;
uint32 width;
uint32 depth;
size_t size;
uint8 num_mipmaps;
uint flags;
PixelFormat format;
public:
String dataType() const
{
return "ImageData";
}
};
public:
String getDataType() const
{
return "ImageData";
}
};
} // namespace
#endif
Ogre::ImageCodec::getDataType
String getDataType() const
Returns the type of the data that supported by this codec as a String.
Definition: OgreImageCodec.h:79
Ogre::Codec
Abstract class that defines a &#39;codec&#39;.
Definition: OgreCodec.h:56
Ogre::ImageCodec::ImageData::width
uint32 width
Definition: OgreImageCodec.h:62
OgreCodec.h
_OgreExport
#define _OgreExport
Definition: OgrePlatform.h:257
Ogre::uint
unsigned int uint
Definition: OgrePrerequisites.h:114
Ogre::ImageCodec::ImageData::size
size_t size
Definition: OgreImageCodec.h:64
Ogre::PF_UNKNOWN
Unknown pixel format.
Definition: OgrePixelFormat.h:46
OgrePixelFormat.h
Ogre::ImageCodec::ImageData::dataType
String dataType() const
Returns the type of the data.
Definition: OgreImageCodec.h:72
Ogre::ImageCodec::ImageData::depth
uint32 depth
Definition: OgreImageCodec.h:63
Ogre::ImageCodec::ImageData::ImageData
ImageData()
Definition: OgreImageCodec.h:56
Ogre::PixelFormat
PixelFormat
The pixel format used for images, textures, and render surfaces.
Definition: OgrePixelFormat.h:43
Ogre::ImageCodec::ImageData
Codec return class for images.
Definition: OgreImageCodec.h:53
Ogre::ImageCodec::ImageData::num_mipmaps
uint8 num_mipmaps
Definition: OgreImageCodec.h:66
_OgrePrivate
#define _OgrePrivate
Definition: OgrePlatform.h:258
Ogre::uint8
unsigned char uint8
Definition: OgrePlatform.h:361
Ogre::Codec::CodecData
Definition: OgreCodec.h:65
Ogre::String
_StringBase String
Definition: OgrePrerequisites.h:439
Ogre::ImageCodec::ImageData::flags
uint flags
Definition: OgreImageCodec.h:67
Ogre::ImageCodec
Codec specialized in images.
Definition: OgreImageCodec.h:47
Ogre::uint32
unsigned int uint32
Definition: OgrePlatform.h:359
Ogre
Definition: OgreAndroidLogListener.h:34
Ogre::ImageCodec::ImageData::format
PixelFormat format
Definition: OgreImageCodec.h:69
Ogre::ImageCodec::ImageData::height
uint32 height
Definition: OgreImageCodec.h:61

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