gem5  v21.1.0.2
framebuffer.hh
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2015 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_FRAMEBUFFER_HH__
39 #define __BASE_FRAMEBUFFER_HH__
40 
41 #include <cmath>
42 #include <cstdint>
43 
44 #include <string>
45 #include <vector>
46 
47 #include "base/compiler.hh"
48 #include "base/cprintf.hh"
49 #include "base/pixel.hh"
50 #include "base/str.hh"
51 #include "base/types.hh"
52 #include "sim/serialize.hh"
53 
54 namespace gem5
55 {
56 
68 class FrameBuffer : public Serializable
69 {
70  public:
77  FrameBuffer(unsigned width, unsigned height);
79  FrameBuffer();
80 
81  virtual ~FrameBuffer();
82 
83  void serialize(CheckpointOut &cp) const override;
84  void unserialize(CheckpointIn &cp) override;
85 
96  void resize(unsigned width, unsigned height);
97 
99  unsigned width() const { return _width; }
101  unsigned height() const { return _height; }
103  unsigned area() const { return _width * _height; }
104 
110  void fill(const Pixel &pixel);
114  void clear();
115 
123  void copyIn(const uint8_t *fb, const PixelConverter &conv);
131  void copyIn(const std::vector<uint8_t> &fb, const PixelConverter &conv) {
132  copyIn(fb.data(), conv);
133  }
134 
142  void copyOut(uint8_t *fb, const PixelConverter &conv) const;
150  void copyOut(std::vector<uint8_t> &fb, const PixelConverter &conv) const {
151  copyOut(fb.data(), conv);
152  }
153 
160  const Pixel &pixel(unsigned x, unsigned y) const {
161  assert(x < _width);
162  assert(y < _height);
163 
164  return pixels[y * _width + x];
165  }
166 
173  Pixel &pixel(unsigned x, unsigned y) {
174  assert(x < _width);
175  assert(y < _height);
176 
177  return pixels[y * _width + x];
178  }
179 
184  uint64_t getHash() const;
185 
192  static const FrameBuffer dummy;
193 
196 
197  protected:
199  unsigned _width;
201  unsigned _height;
202 };
203 
204 } // namespace gem5
205 
206 #endif // __BASE_FRAMEBUFFER_HH__
gem5::FrameBuffer::_height
unsigned _height
Height in pixels.
Definition: framebuffer.hh:201
gem5::FrameBuffer
Internal gem5 representation of a frame buffer.
Definition: framebuffer.hh:68
serialize.hh
gem5::FrameBuffer::dummy
static const FrameBuffer dummy
Static "dummy" frame buffer.
Definition: framebuffer.hh:192
gem5::FrameBuffer::copyOut
void copyOut(uint8_t *fb, const PixelConverter &conv) const
Store the contents of this frame buffer in an external buffer of the same width and height as this fr...
Definition: framebuffer.cc:116
gem5::CheckpointIn
Definition: serialize.hh:68
gem5::FrameBuffer::area
unsigned area() const
Total number of pixels in frame buffer.
Definition: framebuffer.hh:103
gem5::FrameBuffer::width
unsigned width() const
Frame buffer width in pixels.
Definition: framebuffer.hh:99
std::vector< uint8_t >
gem5::FrameBuffer::FrameBuffer
FrameBuffer()
Create an empty (0x0) frame buffer.
Definition: framebuffer.cc:56
gem5::FrameBuffer::~FrameBuffer
virtual ~FrameBuffer()
Definition: framebuffer.cc:61
gem5::FrameBuffer::height
unsigned height() const
Frame buffer height in pixels.
Definition: framebuffer.hh:101
gem5::FrameBuffer::clear
void clear()
Fill the frame buffer with black pixels.
Definition: framebuffer.cc:99
gem5::FrameBuffer::copyOut
void copyOut(std::vector< uint8_t > &fb, const PixelConverter &conv) const
Store the contents of this frame buffer in an external buffer of the same width and height as this fr...
Definition: framebuffer.hh:150
gem5::FrameBuffer::getHash
uint64_t getHash() const
Create a hash of the image that can be used for quick comparisons.
Definition: framebuffer.cc:125
str.hh
gem5::FrameBuffer::fill
void fill(const Pixel &pixel)
Fill the frame buffer with a single pixel value.
Definition: framebuffer.cc:92
gem5::Serializable
Basic support for object serialization.
Definition: serialize.hh:169
gem5::FrameBuffer::unserialize
void unserialize(CheckpointIn &cp) override
Unserialize an object.
Definition: framebuffer.cc:75
gem5::FrameBuffer::pixel
const Pixel & pixel(unsigned x, unsigned y) const
Get a pixel from an (x, y) coordinate.
Definition: framebuffer.hh:160
gem5::ArmISA::fb
Bitfield< 9 > fb
Definition: misc_types.hh:274
gem5::FrameBuffer::resize
void resize(unsigned width, unsigned height)
Resize the frame buffer.
Definition: framebuffer.cc:83
gem5::FrameBuffer::pixel
Pixel & pixel(unsigned x, unsigned y)
Get a pixel from an (x, y) coordinate.
Definition: framebuffer.hh:173
cprintf.hh
compiler.hh
gem5::Pixel
Internal gem5 representation of a Pixel.
Definition: pixel.hh:58
gem5::FrameBuffer::_width
unsigned _width
Width in pixels.
Definition: framebuffer.hh:199
gem5::PixelConverter
Configurable RGB pixel converter.
Definition: pixel.hh:91
pixel.hh
gem5::RiscvISA::x
Bitfield< 3 > x
Definition: pagetable.hh:73
types.hh
gem5::FrameBuffer::pixels
std::vector< Pixel > pixels
Frame buffer backing store.
Definition: framebuffer.hh:195
gem5::FrameBuffer::copyIn
void copyIn(const uint8_t *fb, const PixelConverter &conv)
Fill the frame buffer with pixel data from an external buffer of the same width and height as this fr...
Definition: framebuffer.cc:107
gem5::FrameBuffer::copyIn
void copyIn(const std::vector< uint8_t > &fb, const PixelConverter &conv)
Fill the frame buffer with pixel data from an external buffer of the same width and height as this fr...
Definition: framebuffer.hh:131
gem5::CheckpointOut
std::ostream CheckpointOut
Definition: serialize.hh:66
gem5
Reference material can be found at the JEDEC website: UFS standard http://www.jedec....
Definition: decoder.cc:40
gem5::FrameBuffer::serialize
void serialize(CheckpointOut &cp) const override
Serialize an object.
Definition: framebuffer.cc:67

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