gem5  v21.1.0.2
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 
49 namespace gem5
50 {
51 
53 class PngWriter : public ImgWriter
54 {
55  public:
60  PngWriter(const FrameBuffer *_fb)
61  : ImgWriter(_fb)
62  {}
63 
64  ~PngWriter() {};
65 
71  const char* getImgExtension() const override
72  { return _imgExtension; }
73 
79  void write(std::ostream &png) const override;
80  private:
82  struct GEM5_PACKED PngPixel24
83  {
84  PngPixel24 &operator=(const Pixel &rhs) {
85  red = rhs.red;
86  green = rhs.green;
87  blue = rhs.blue;
88 
89  return *this;
90  }
91  uint8_t red;
92  uint8_t green;
93  uint8_t blue;
94  };
95 
105 
106  typedef PngPixel24 PixelType;
107 
108  static const char* _imgExtension;
109 };
110 
111 } // namespace gem5
112 
113 #endif // __BASE_PNG_HH__
gem5::PngWriter::_imgExtension
static const char * _imgExtension
Definition: pngwriter.hh:108
gem5::PngWriter::PngPixel24::red
uint8_t red
Definition: pngwriter.hh:91
gem5::PngWriter::~PngWriter
~PngWriter()
Definition: pngwriter.hh:64
gem5::FrameBuffer
Internal gem5 representation of a frame buffer.
Definition: framebuffer.hh:68
gem5::PngWriter::getImgExtension
const char * getImgExtension() const override
Return Image format as a string.
Definition: pngwriter.hh:71
gem5::PngWriter::PngPixel24::green
uint8_t green
Definition: pngwriter.hh:92
imgwriter.hh
gem5::ImgWriter
Definition: imgwriter.hh:52
gem5::PngWriter::PngPixel24
Png Pixel type: not containing padding.
Definition: pngwriter.hh:82
gem5::Pixel::green
uint8_t green
Definition: pixel.hh:67
gem5::PngWriter::PngPixel24::blue
uint8_t blue
Definition: pngwriter.hh:93
gem5::Pixel::blue
uint8_t blue
Definition: pixel.hh:68
gem5::PngWriter::PixelType
PngPixel24 PixelType
Definition: pngwriter.hh:104
compiler.hh
gem5::SparcISA::red
Bitfield< 5 > red
Definition: misc.hh:122
framebuffer.hh
gem5::Pixel
Internal gem5 representation of a Pixel.
Definition: pixel.hh:58
gem5::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:60
gem5::PngWriter::PngStructHandle
Definition: pngwriter.cc:79
gem5::Pixel::red
uint8_t red
Definition: pixel.hh:66
gem5::PngWriter::write
void write(std::ostream &png) const override
Write the frame buffer data into the provided ostream.
Definition: pngwriter.cc:116
gem5::PngWriter::PngPixel24::operator=
PngPixel24 & operator=(const Pixel &rhs)
Definition: pngwriter.hh:84
gem5::PngWriter
Image writer implementing support for PNG.
Definition: pngwriter.hh:53
gem5
Reference material can be found at the JEDEC website: UFS standard http://www.jedec....
Definition: decoder.cc:40

Generated on Tue Sep 21 2021 12:24:57 for gem5 by doxygen 1.8.17