include/SDL_shape.h
author Eli Gottlieb <eligottlieb@gmail.com>
Sat, 05 Jun 2010 15:01:40 -0400
changeset 4774 90576a84d30d
parent 4769 83f9b95da263
child 4776 29dcad9c58b3
permissions -rw-r--r--
Updated SDL_shape.h by adding a line break... somehow it's not being tracked correctly.`
     1 /*
     2     SDL - Simple DirectMedia Layer
     3     Copyright (C) 2010 Eli Gottlieb
     4 
     5     This library is free software; you can redistribute it and/or
     6     modify it under the terms of the GNU Lesser General Public
     7     License as published by the Free Software Foundation; either
     8     version 2.1 of the License, or (at your option) any later version.
     9 
    10     This library is distributed in the hope that it will be useful,
    11     but WITHOUT ANY WARRANTY; without even the implied warranty of
    12     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
    13     Lesser General Public License for more details.
    14 
    15     You should have received a copy of the GNU Lesser General Public
    16     License along with this library; if not, write to the Free Software
    17     Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
    18 
    19     Eli Gottlieb
    20     eligottlieb@gmail.com
    21 */
    22 
    23 #ifndef _SDL_shape_h
    24 #define _SDL_shape_h
    25 
    26 #include "SDL_stdinc.h"
    27 #include "SDL_pixels.h"
    28 #include "SDL_rect.h"
    29 #include "SDL_surface.h"
    30 #include "SDL_video.h"
    31 
    32 #include "begin_code.h"
    33 /* Set up for C function definitions, even when using C++ */
    34 #ifdef __cplusplus
    35 /* *INDENT-OFF* */
    36 extern "C" {
    37 /* *INDENT-ON* */
    38 #endif
    39 
    40 /**
    41  *  \brief Create a shaped window with the specified position, dimensions, and flags.
    42  *  
    43  *  \param title The title of the window, in UTF-8 encoding.
    44  *  \param x     The x position of the window, ::SDL_WINDOWPOS_CENTERED, or 
    45  *               ::SDL_WINDOWPOS_UNDEFINED.
    46  *  \param y     The y position of the window, ::SDL_WINDOWPOS_CENTERED, or 
    47  *               ::SDL_WINDOWPOS_UNDEFINED.
    48  *  \param w     The width of the window.
    49  *  \param h     The height of the window.
    50  *  \param flags The flags for the window, a mask of SDL_WINDOW_BORDERLESS with any of the following: 
    51  *               ::SDL_WINDOW_OPENGL,     ::SDL_WINDOW_INPUT_GRABBED,
    52  *               ::SDL_WINDOW_SHOWN,      ::SDL_WINDOW_RESIZABLE,
    53  *               ::SDL_WINDOW_MAXIMIZED,  ::SDL_WINDOW_MINIMIZED,
    54  *		 ::SDL_WINDOW_BORDERLESS is always set, and ::SDL_WINDOW_FULLSCREEN is always unset.
    55  *  
    56  *  \return The id of the window created, or zero if window creation failed.
    57  *  
    58  *  \sa SDL_DestroyWindow()
    59  */
    60 extern DECLSPEC SDL_Window * SDLCALL SDL_CreateShapedWindow(const char *title,unsigned int x,unsigned int y,unsigned int w,unsigned int h,Uint32 flags);
    61 
    62 extern DECLSPEC SDL_bool SDLCALL SDL_WindowIsShaped(const SDL_Window *window);
    63 extern DECLSPEC int SDLCALL SDL_SelectShapeRenderer(const SDL_Window *window);
    64 
    65 
    66 /* Ends C function definitions when using C++ */
    67 #ifdef __cplusplus
    68 /* *INDENT-OFF* */
    69 }
    70 /* *INDENT-ON* */
    71 #endif
    72 #include "close_code.h"
    73 
    74 #endif /* _SDL_shape_h */