gem5  v20.1.0.0
pngwriter.hh
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2017 ARM Limited
3  * All rights reserved
4  *
5  * The license below extends only to copyright in the software and shall
6  * not be construed as granting a license to any other intellectual
7  * property including but not limited to intellectual property relating
8  * to a hardware implementation of the functionality of the software
9  * licensed hereunder. You may use the software subject to the license
10  * terms below provided that you ensure that this notice is replicated
11  * unmodified and in its entirety in all distributions of the software,
12  * modified or unmodified, in source code or in binary form.
13  *
14  * Redistribution and use in source and binary forms, with or without
15  * modification, are permitted provided that the following conditions are
16  * met: redistributions of source code must retain the above copyright
17  * notice, this list of conditions and the following disclaimer;
18  * redistributions in binary form must reproduce the above copyright
19  * notice, this list of conditions and the following disclaimer in the
20  * documentation and/or other materials provided with the distribution;
21  * neither the name of the copyright holders nor the names of its
22  * contributors may be used to endorse or promote products derived from
23  * this software without specific prior written permission.
24  *
25  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
26  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
27  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
28  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
29  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
30  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
31  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
32  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
33  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
34  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
35  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36  */
37 
42 #ifndef __BASE_PNG_HH__
43 #define __BASE_PNG_HH__
44 
45 #include "base/compiler.hh"
46 #include "base/framebuffer.hh"
47 #include "base/imgwriter.hh"
48 
50 class PngWriter : public ImgWriter
51 {
52  public:
57  PngWriter(const FrameBuffer *_fb)
58  : ImgWriter(_fb)
59  {}
60 
61  ~PngWriter() {};
62 
68  const char* getImgExtension() const override
69  { return _imgExtension; }
70 
76  void write(std::ostream &png) const override;
77  private:
79  struct PngPixel24 {
80  PngPixel24 &operator=(const Pixel &rhs) {
81  red = rhs.red;
82  green = rhs.green;
83  blue = rhs.blue;
84 
85  return *this;
86  }
87  uint8_t red;
88  uint8_t green;
89  uint8_t blue;
91 
101 
102  typedef PngPixel24 PixelType;
103 
104  static const char* _imgExtension;
105 };
106 
107 #endif // __BASE_PNG_HH__
PngWriter::M5_ATTR_PACKED
struct PngWriter::PngPixel24 M5_ATTR_PACKED
Pixel::blue
uint8_t blue
Definition: pixel.hh:64
Pixel::red
uint8_t red
Definition: pixel.hh:62
PngWriter::PngPixel24::green
uint8_t green
Definition: pngwriter.hh:88
PngWriter::PngPixel24::red
uint8_t red
Definition: pngwriter.hh:87
PngWriter::_imgExtension
static const char * _imgExtension
Definition: pngwriter.hh:104
imgwriter.hh
ImgWriter
Definition: imgwriter.hh:49
PngWriter::PngWriter
PngWriter(const FrameBuffer *_fb)
Create a png that takes data in a given mode & size and outputs to an ostream.
Definition: pngwriter.hh:57
compiler.hh
PngWriter::PngStructHandle
Definition: pngwriter.cc:76
Pixel
Internal gem5 representation of a Pixel.
Definition: pixel.hh:54
PngWriter::write
void write(std::ostream &png) const override
Write the frame buffer data into the provided ostream.
Definition: pngwriter.cc:112
PngWriter
Image writer implementing support for PNG.
Definition: pngwriter.hh:50
framebuffer.hh
PngWriter::PngPixel24::blue
uint8_t blue
Definition: pngwriter.hh:89
PngWriter::PngPixel24::operator=
PngPixel24 & operator=(const Pixel &rhs)
Definition: pngwriter.hh:80
PngWriter::PixelType
PngPixel24 PixelType
Definition: pngwriter.hh:100
FrameBuffer
Internal gem5 representation of a frame buffer.
Definition: framebuffer.hh:65
PngWriter::getImgExtension
const char * getImgExtension() const override
Return Image format as a string.
Definition: pngwriter.hh:68
PngWriter::PngPixel24
Png Pixel type: not containing padding.
Definition: pngwriter.hh:79
PngWriter::~PngWriter
~PngWriter()
Definition: pngwriter.hh:61
Pixel::green
uint8_t green
Definition: pixel.hh:63

Generated on Wed Sep 30 2020 14:02:07 for gem5 by doxygen 1.8.17