src/lib/planar.h

   1 /* Project 16 Source Code~
   2  * Copyright (C) 2012-2015 sparky4 & pngwen & andrius4669
   3  *
   4  * This file is part of Project 16.
   5  *
   6  * Project 16 is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 3 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * Project 16 is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program.  If not, see <http://www.gnu.org/licenses/>, or
  18  * write to the Free Software Foundation, Inc., 51 Franklin Street,
  19  * Fifth Floor, Boston, MA 02110-1301 USA.
  20  *
  21  */
  22 /*
  23  * Functions and types for a planar image buffer.
  24  * This is meant to be able to load into video memory faster.
  25  */
  26 #ifndef PLANAR_H
  27 #define PLANAR_H
  28
  29 #include "src/lib/bitmap.h"
  30 #include "src/lib/16_ca.h"
  31 #include "src/lib/16_mm.h"
  32 #include "src/lib/16_hc.h"
  33
  34 typedef struct {
  35         byte huge *plane[4];     /* 4 planes of image data */
  36         word width;         /* width of the image (spread across 4 planes) */
  37         word height;        /* height of the image (spread across 4 planes) */
  38         word pwidth;        /* the number of bytes in each plane */
  39 } planar_buf_t;
  40
  41 /* creates a planar buffer from the bitmap data.
  42    The planar buffer is dynamically allocated, and should
  43    be destroyed with the planar_buf_free function when no longer
  44    needed.
  45  */
  46 planar_buf_t *planar_buf_from_bitmap(bitmap_t *b);
  47
  48 /* allocates a planar buffer with specified dimensions */
  49 planar_buf_t *planar_buf_alloc(word width, word height);
  50
  51 /* deallocates a planar buffer */
  52 void planar_buf_free(planar_buf_t *p);
  53 #endif