include/SDL_shape.h
author David Ludwig <dludwig@pobox.com>
Mon, 01 Apr 2013 21:33:06 -0400
changeset 8453 499aa167ea79
parent 6885 700f1b25f77f
child 7191 75360622e65f
permissions -rw-r--r--
WinRT: made WinRT path retrieval be available in both UCS-2 and UTF-8 flavors
     1 /*
     2   Simple DirectMedia Layer
     3   Copyright (C) 1997-2013 Sam Lantinga <slouken@libsdl.org>
     4 
     5   This software is provided 'as-is', without any express or implied
     6   warranty.  In no event will the authors be held liable for any damages
     7   arising from the use of this software.
     8 
     9   Permission is granted to anyone to use this software for any purpose,
    10   including commercial applications, and to alter it and redistribute it
    11   freely, subject to the following restrictions:
    12 
    13   1. The origin of this software must not be misrepresented; you must not
    14      claim that you wrote the original software. If you use this software
    15      in a product, an acknowledgment in the product documentation would be
    16      appreciated but is not required.
    17   2. Altered source versions must be plainly marked as such, and must not be
    18      misrepresented as being the original software.
    19   3. This notice may not be removed or altered from any source distribution.
    20 */
    21 
    22 #ifndef _SDL_shape_h
    23 #define _SDL_shape_h
    24 
    25 #include "SDL_stdinc.h"
    26 #include "SDL_pixels.h"
    27 #include "SDL_rect.h"
    28 #include "SDL_surface.h"
    29 #include "SDL_video.h"
    30 
    31 #include "begin_code.h"
    32 /* Set up for C function definitions, even when using C++ */
    33 #ifdef __cplusplus
    34 /* *INDENT-OFF* */
    35 extern "C" {
    36 /* *INDENT-ON* */
    37 #endif
    38 
    39 /** \file SDL_shape.h
    40  *
    41  * Header file for the shaped window API.
    42  */
    43 
    44 #define SDL_NONSHAPEABLE_WINDOW -1
    45 #define SDL_INVALID_SHAPE_ARGUMENT -2
    46 #define SDL_WINDOW_LACKS_SHAPE -3
    47 
    48 /**
    49  *  \brief Create a window that can be shaped with the specified position, dimensions, and flags.
    50  *  
    51  *  \param title The title of the window, in UTF-8 encoding.
    52  *  \param x     The x position of the window, ::SDL_WINDOWPOS_CENTERED, or 
    53  *               ::SDL_WINDOWPOS_UNDEFINED.
    54  *  \param y     The y position of the window, ::SDL_WINDOWPOS_CENTERED, or 
    55  *               ::SDL_WINDOWPOS_UNDEFINED.
    56  *  \param w     The width of the window.
    57  *  \param h     The height of the window.
    58  *  \param flags The flags for the window, a mask of SDL_WINDOW_BORDERLESS with any of the following: 
    59  *               ::SDL_WINDOW_OPENGL,     ::SDL_WINDOW_INPUT_GRABBED,
    60  *               ::SDL_WINDOW_SHOWN,      ::SDL_WINDOW_RESIZABLE,
    61  *               ::SDL_WINDOW_MAXIMIZED,  ::SDL_WINDOW_MINIMIZED,
    62  *		 ::SDL_WINDOW_BORDERLESS is always set, and ::SDL_WINDOW_FULLSCREEN is always unset.
    63  *  
    64  *  \return The window created, or NULL if window creation failed.
    65  *  
    66  *  \sa SDL_DestroyWindow()
    67  */
    68 extern DECLSPEC SDL_Window * SDLCALL SDL_CreateShapedWindow(const char *title,unsigned int x,unsigned int y,unsigned int w,unsigned int h,Uint32 flags);
    69 
    70 /**
    71  * \brief Return whether the given window is a shaped window. 
    72  *
    73  * \param window The window to query for being shaped.
    74  *
    75  * \return SDL_TRUE if the window is a window that can be shaped, SDL_FALSE if the window is unshaped or NULL.
    76  * \sa SDL_CreateShapedWindow
    77  */
    78 extern DECLSPEC SDL_bool SDLCALL SDL_IsShapedWindow(const SDL_Window *window);
    79 
    80 /** \brief An enum denoting the specific type of contents present in an SDL_WindowShapeParams union. */
    81 typedef enum {
    82 	/** \brief The default mode, a binarized alpha cutoff of 1. */
    83 	ShapeModeDefault,
    84 	/** \brief A binarized alpha cutoff with a given integer value. */
    85 	ShapeModeBinarizeAlpha,
    86 	/** \brief A binarized alpha cutoff with a given integer value, but with the opposite comparison. */
    87 	ShapeModeReverseBinarizeAlpha,
    88 	/** \brief A color key is applied. */
    89 	ShapeModeColorKey
    90 } WindowShapeMode;
    91 
    92 #define SDL_SHAPEMODEALPHA(mode) (mode == ShapeModeDefault || mode == ShapeModeBinarizeAlpha || mode == ShapeModeReverseBinarizeAlpha)
    93 
    94 /** \brief A union containing parameters for shaped windows. */
    95 typedef union {
    96 	/** \brief a cutoff alpha value for binarization of the window shape's alpha channel. */
    97 	Uint8 binarizationCutoff;
    98 	SDL_Color colorKey;
    99 } SDL_WindowShapeParams;
   100 
   101 /** \brief A struct that tags the SDL_WindowShapeParams union with an enum describing the type of its contents. */
   102 typedef struct SDL_WindowShapeMode {
   103 	/** \brief The mode of these window-shape parameters. */
   104 	WindowShapeMode mode;
   105 	/** \brief Window-shape parameters. */
   106 	SDL_WindowShapeParams parameters;
   107 } SDL_WindowShapeMode;
   108 
   109 /**
   110  * \brief Set the shape and parameters of a shaped window.
   111  *
   112  * \param window The shaped window whose parameters should be set.
   113  * \param shape A surface encoding the desired shape for the window.
   114  * \param shape_mode The parameters to set for the shaped window.
   115  *
   116  * \return 0 on success, SDL_INVALID_SHAPE_ARGUMENT on invalid an invalid shape argument, or SDL_NONSHAPEABLE_WINDOW
   117  *           if the SDL_Window* given does not reference a valid shaped window.
   118  *
   119  * \sa SDL_WindowShapeMode
   120  * \sa SDL_GetShapedWindowMode.
   121  */
   122 extern DECLSPEC int SDLCALL SDL_SetWindowShape(SDL_Window *window,SDL_Surface *shape,SDL_WindowShapeMode *shape_mode);
   123 
   124 /**
   125  * \brief Get the shape parameters of a shaped window.
   126  *
   127  * \param window The shaped window whose parameters should be retrieved.
   128  * \param shape_mode An empty shape-mode structure to fill, or NULL to check whether the window has a shape.
   129  *
   130  * \return 0 if the window has a shape and, provided shape_mode was not NULL, shape_mode has been filled with the mode
   131  *           data, SDL_NONSHAPEABLE_WINDOW if the SDL_Window given is not a shaped window, or SDL_WINDOW_LACKS_SHAPE if
   132  *           the SDL_Window* given is a shapeable window currently lacking a shape.
   133  *
   134  * \sa SDL_WindowShapeMode
   135  * \sa SDL_SetWindowShape
   136  */
   137 extern DECLSPEC int SDLCALL SDL_GetShapedWindowMode(SDL_Window *window,SDL_WindowShapeMode *shape_mode);
   138 
   139 /* Ends C function definitions when using C++ */
   140 #ifdef __cplusplus
   141 /* *INDENT-OFF* */
   142 }
   143 /* *INDENT-ON* */
   144 #endif
   145 #include "close_code.h"
   146 
   147 #endif /* _SDL_shape_h */