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