2 Copyright (C) 2012-2014 Carl Hetherington <cth@carlh.net>
4 This program is free software; you can redistribute it and/or modify
5 it under the terms of the GNU General Public License as published by
6 the Free Software Foundation; either version 2 of the License, or
7 (at your option) any later version.
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 GNU General Public License for more details.
14 You should have received a copy of the GNU General Public License
15 along with this program; if not, write to the Free Software
16 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
20 /** @file src/argb_frame.h
21 * @brief ARGBFrame class.
31 * @brief A single frame of picture data held in an ARGB buffer.
33 * The format of the data is:
36 * Byte /- 0 -------|- 1 --------|- 2 --------|- 3 --------|- 4 --------|- 5 --------| ...
37 * |(0, 0) Blue|(0, 0)Green |(0, 0) Red |(0, 0) Alpha|(0, 1) Blue |(0, 1) Green| ...
40 * So that the first byte is the blue component of the pixel at x=0, y=0, the second
41 * is the green component, and so on.
43 * Lines are packed so that the second row directly follows the first.
45 class ARGBFrame : boost::noncopyable
48 ARGBFrame (Size size);
51 /** @return pointer to the image data */
52 uint8_t* data () const {
56 /** @return length of one picture row in bytes */
59 /** @return size of the picture in pixels */
65 Size _size; ///< frame size in pixels
66 uint8_t* _data; ///< pointer to image data