pngUtils.h

Engine/source/gfx/bitmap/pngUtils.h

More...

Classes:

class

This class is used to write PNGs in row batches.

Detailed Description

 1
 2//-----------------------------------------------------------------------------
 3// Copyright (c) 2012 GarageGames, LLC
 4//
 5// Permission is hereby granted, free of charge, to any person obtaining a copy
 6// of this software and associated documentation files (the "Software"), to
 7// deal in the Software without restriction, including without limitation the
 8// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
 9// sell copies of the Software, and to permit persons to whom the Software is
10// furnished to do so, subject to the following conditions:
11//
12// The above copyright notice and this permission notice shall be included in
13// all copies or substantial portions of the Software.
14//
15// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
20// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
21// IN THE SOFTWARE.
22//-----------------------------------------------------------------------------
23
24#ifndef _PNG_UTILS_H_
25#define _PNG_UTILS_H_
26
27#ifndef _GFXENUMS_H_
28#include "gfx/gfxEnums.h"
29#endif
30
31struct DeferredPNGWriterData; // This is used to avoid including png.h in this header
32class GBitmap;
33class Stream;
34
35/// This class is used to write PNGs in row batches
36class DeferredPNGWriter {
37protected:
38   DeferredPNGWriterData *mData;
39   bool mActive;
40
41public:
42   DeferredPNGWriter();
43   ~DeferredPNGWriter();
44
45   bool begin( GFXFormat format, S32 width, S32 height, Stream &stream, U32 compressionLevel );      
46   void append( GBitmap* bitmap, U32 rows );
47   void end();
48};
49
50#endif
51