templates: Fix description block id, add description
[gfxprim/pasky.git] / include / core / GP_WritePixel.gen.h.t
blobb4ce29ea753d8dc80d0628d5dac4ca9dc42a3b8d
1 /*****************************************************************************
2  * This file is part of gfxprim library.                                     *
3  *                                                                           *
4  * Gfxprim is free software; you can redistribute it and/or                  *
5  * modify it under the terms of the GNU Lesser General Public                *
6  * License as published by the Free Software Foundation; either              *
7  * version 2.1 of the License, or (at your option) any later version.        *
8  *                                                                           *
9  * Gfxprim 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 GNU         *
12  * Lesser General Public License for more details.                           *
13  *                                                                           *
14  * You should have received a copy of the GNU Lesser General Public          *
15  * License along with gfxprim; if not, write to the Free Software            *
16  * Foundation, Inc., 51 Franklin Street, Fifth Floor,                        *
17  * Boston, MA  02110-1301  USA                                               *
18  *                                                                           *
19  * Copyright (C) 2009-2012 Cyril Hrubis <metan@ucw.cz>                       *
20  *                                                                           *
21  *****************************************************************************/
23 %% extends 'base.h.t'
25 {% block descr %}Write Pixels generated header{% endblock %}
27 {% block body %}
30  * These functions writes cnt pixels using value val starting at start address
31  * and additionally (for pixel sizes that are not aligned to the whole bytes)
32  * at off offset in the first byte (i.e. byte at the start address).
33  */
35 %% for ps in pixelsizes
36 %% if ps.needs_bit_endian()
37 void GP_WritePixels_{{ ps.suffix }}(void *start, uint8_t off,
38                             size_t cnt, unsigned int val);
40 %% else
41 void GP_WritePixels_{{ ps.suffix }}(void *start, size_t cnt, unsigned int val);
43 %% endif
44 %% endfor
46 {% endblock body %}