include/backends/GP_SDL_Context.h

   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  *****************************************************************************/
  22
  23 #ifndef BACKENDS_GP_SDL_CONTEXT_H
  24 #define BACKENDS_GP_SDL_CONTEXT_H
  25
  26 #include <SDL/SDL.h>
  27 #include <core/GP_Context.h>
  28
  29 /*
  30  * This function lets you use GFXprim together with SDL. All you need to do
  31  * is to initialize context from surface. The usage is as follows:
  32  *
  33  * ...
  34  *
  35  * GP_Context c;
  36  *
  37  * if (GP_ContextFromSDLSurface(&c, surface)) {
  38  *      error("Failed to match PIXEL_TYPE for given surface");
  39  *      exit(1);
  40  * }
  41  *
  42  * ...
  43  *
  44  * Now you have initialized context that shares the pixel buffer with
  45  * the SDL surface.
  46  */
  47 int GP_ContextFromSDLSurface(GP_Context *c, const SDL_Surface *surf);
  48
  49 #endif /* BACKENDS_GP_SDL_CONTEXT_H */