include/SDL_shape.h
author Eli Gottlieb <eligottlieb@gmail.com>
Thu, 10 Jun 2010 17:50:38 -0400
changeset 4779 bb179250fcb3
parent 4778 9838d3525a1b
child 4780 4f915a47b995
permissions -rw-r--r--
Doxygen commenting is all finished up.
     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 /** \file SDL_shape.h
    41  *
    42  * Header file for shaped windows.
    43  */
    44 
    45 /**
    46  *  \brief Create a shaped window with the specified position, dimensions, and flags.
    47  *  
    48  *  \param title The title of the window, in UTF-8 encoding.
    49  *  \param x     The x position of the window, ::SDL_WINDOWPOS_CENTERED, or 
    50  *               ::SDL_WINDOWPOS_UNDEFINED.
    51  *  \param y     The y position of the window, ::SDL_WINDOWPOS_CENTERED, or 
    52  *               ::SDL_WINDOWPOS_UNDEFINED.
    53  *  \param w     The width of the window.
    54  *  \param h     The height of the window.
    55  *  \param flags The flags for the window, a mask of SDL_WINDOW_BORDERLESS with any of the following: 
    56  *               ::SDL_WINDOW_OPENGL,     ::SDL_WINDOW_INPUT_GRABBED,
    57  *               ::SDL_WINDOW_SHOWN,      ::SDL_WINDOW_RESIZABLE,
    58  *               ::SDL_WINDOW_MAXIMIZED,  ::SDL_WINDOW_MINIMIZED,
    59  *		 ::SDL_WINDOW_BORDERLESS is always set, and ::SDL_WINDOW_FULLSCREEN is always unset.
    60  *  
    61  *  \return The id of the window created, or zero if window creation failed.
    62  *  
    63  *  \sa SDL_DestroyWindow()
    64  */
    65 extern DECLSPEC SDL_Window * SDLCALL SDL_CreateShapedWindow(const char *title,unsigned int x,unsigned int y,unsigned int w,unsigned int h,Uint32 flags);
    66 
    67 /**
    68  * \brief Return whether the given window is a shaped window. 
    69  *
    70  * \param window The window to query for being shaped.
    71  *
    72  * \return SDL_TRUE if the window is a shaped window and SDL_FALSE otherwise.
    73  * \sa SDL_CreateShapedWindow
    74  */
    75 extern DECLSPEC SDL_bool SDLCALL SDL_WindowIsShaped(const SDL_Window *window);
    76 
    77 /**
    78  * \brief Select the shape of a given window as a rendering target.
    79  *
    80  * \param window The window whose shape should become the current rendering target.
    81  *
    82  * \return 0 on success, -1 if something other than a valid shaped window is passed into \c window.
    83  *
    84  * The shape of the window given in \c window is selected as the new render target, and in the default mode (see
    85  * SDL_WindowShapeParams) the alpha channel of that render target determines which pixels of the window are part of its
    86  * visible shape and which are not according to a cutoff value.  All normal SDL rendering functions can be used on it,
    87  * and its own specific parameters can be examined and set with SDL_GetShapeParameters() and SDL_SetShapeParameters().
    88  * The final shape will be computed and the actual appearance of the window changed only upon a call to
    89  * SDL_RenderPresent().
    90  *
    91  * \sa SDL_GetShapeParameters
    92  * \sa SDL_SetShapeParameters
    93  * \sa SDL_RenderPresent
    94  */
    95 extern DECLSPEC int SDLCALL SDL_SelectShapeRenderer(const SDL_Window *window);
    96 
    97 /** \brief An enum denoting the specific type of contents present in an SDL_WindowShapeParams union. */
    98 typedef enum {ShapeModeDefault, ShapeModeBinarizeAlpha} WindowShapeMode;
    99 /** \brief A union containing parameters for shaped windows. */
   100 typedef union {
   101 	/** \brief a cutoff alpha value for binarization of the window shape's alpha channel. */
   102 	Uint8 binarizationCutoff;
   103 } SDL_WindowShapeParams;
   104 
   105 /** \brief A struct that tags the SDL_WindowShapeParams union with an enum describing the type of its contents. */
   106 typedef struct SDL_WindowShapeMode {
   107 	/** \brief The mode of these window-shape parameters. */
   108 	WindowShapeMode mode;
   109 	/** \brief Window-shape parameters. */
   110 	SDL_WindowShapeParams parameters;
   111 } SDL_WindowShapeMode;
   112 
   113 /**
   114  * \brief Set the shape parameters of a shaped window.
   115  *
   116  * \param window The shaped window whose parameters should be set.
   117  * \param shapeMode The parameters to set for the shaped window.
   118  *
   119  * \return 0 on success, -1 on invalid parameters in the shapeMode argument, or -2 if the SDL_Window given is not a
   120  *         shaped window.
   121  *
   122  * \sa SDL_WindowShapeMode
   123  * \sa SDL_GetShapeParameters
   124  */
   125 extern DECLSPEC int SDLCALL SDL_SetShapeParameters(SDL_Window *window,SDL_WindowShapeMode shapeMode);
   126 
   127 /**
   128  * \brief Set the shape parameters of a shaped window.
   129  *
   130  * \param window The shaped window whose parameters should be retrieved.
   131  * \param shapeMode An empty shape-parameters structure to fill.
   132  *
   133  * \return 0 on success, -1 on a null shapeMode, or -2 if the SDL_Window given is not a shaped window.
   134  *
   135  * \sa SDL_WindowShapeMode
   136  * \sa SDL_SetShapeParameters
   137  */
   138 extern DECLSPEC int SDLCALL SDL_GetShapeParameters(SDL_Window *window,SDL_WindowShapeMode *shapeMode);
   139 
   140 /* Ends C function definitions when using C++ */
   141 #ifdef __cplusplus
   142 /* *INDENT-OFF* */
   143 }
   144 /* *INDENT-ON* */
   145 #endif
   146 #include "close_code.h"
   147 
   148 #endif /* _SDL_shape_h */