gem5  v21.1.0.2
imgwriter.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 
38 #ifndef __BASE_IMGWRITER_HH__
39 #define __BASE_IMGWRITER_HH__
40 
41 #include <ostream>
42 
43 #include "base/compiler.hh"
44 #include "base/framebuffer.hh"
45 
46 #include "enums/ImageFormat.hh"
47 
48 namespace gem5
49 {
50 
51 // write frame buffer to an image
52 class ImgWriter
53 {
54  public:
55  ImgWriter(const FrameBuffer *_fb)
56  : fb(*_fb)
57  {}
58 
59  virtual ~ImgWriter() {};
65  virtual void write(std::ostream &out) const = 0;
66  /*
67  * Return Image format as a string
68  *
69  * @return img extension (e.g. bmp for Bitmap)
70  */
71  virtual const char* getImgExtension() const = 0;
72 
73  protected:
74  const FrameBuffer &fb;
75 };
76 
90 std::unique_ptr<ImgWriter>
91 createImgWriter(enums::ImageFormat type, const FrameBuffer *fb);
92 
93 } // namespace gem5
94 
95 #endif //__BASE_IMGWRITER_HH__
gem5::ImgWriter::~ImgWriter
virtual ~ImgWriter()
Definition: imgwriter.hh:59
gem5::FrameBuffer
Internal gem5 representation of a frame buffer.
Definition: framebuffer.hh:68
gem5::ImgWriter::getImgExtension
virtual const char * getImgExtension() const =0
gem5::ImgWriter
Definition: imgwriter.hh:52
gem5::X86ISA::type
type
Definition: misc.hh:733
gem5::ArmISA::fb
Bitfield< 9 > fb
Definition: misc_types.hh:274
gem5::createImgWriter
std::unique_ptr< ImgWriter > createImgWriter(enums::ImageFormat type, const FrameBuffer *fb)
Factory Function which allocates a ImgWriter object and returns a smart pointer to it.
Definition: imgwriter.cc:53
compiler.hh
framebuffer.hh
gem5
Reference material can be found at the JEDEC website: UFS standard http://www.jedec....
Definition: decoder.cc:40
gem5::ImgWriter::fb
const FrameBuffer & fb
Definition: imgwriter.hh:74
gem5::ImgWriter::ImgWriter
ImgWriter(const FrameBuffer *_fb)
Definition: imgwriter.hh:55
gem5::ImgWriter::write
virtual void write(std::ostream &out) const =0
Write the frame buffer data into the provided ostream.

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