Mercurial > sdl-ios-xcode
comparison include/SDL_shape.h @ 4779:bb179250fcb3
Doxygen commenting is all finished up.
author | Eli Gottlieb <eligottlieb@gmail.com> |
---|---|
date | Thu, 10 Jun 2010 17:50:38 -0400 |
parents | 9838d3525a1b |
children | 4f915a47b995 |
comparison
equal
deleted
inserted
replaced
4778:9838d3525a1b | 4779:bb179250fcb3 |
---|---|
34 #ifdef __cplusplus | 34 #ifdef __cplusplus |
35 /* *INDENT-OFF* */ | 35 /* *INDENT-OFF* */ |
36 extern "C" { | 36 extern "C" { |
37 /* *INDENT-ON* */ | 37 /* *INDENT-ON* */ |
38 #endif | 38 #endif |
39 | |
40 /** \file SDL_shape.h | |
41 * | |
42 * Header file for shaped windows. | |
43 */ | |
39 | 44 |
40 /** | 45 /** |
41 * \brief Create a shaped window with the specified position, dimensions, and flags. | 46 * \brief Create a shaped window with the specified position, dimensions, and flags. |
42 * | 47 * |
43 * \param title The title of the window, in UTF-8 encoding. | 48 * \param title The title of the window, in UTF-8 encoding. |
97 Uint8 binarizationCutoff; | 102 Uint8 binarizationCutoff; |
98 } SDL_WindowShapeParams; | 103 } SDL_WindowShapeParams; |
99 | 104 |
100 /** \brief A struct that tags the SDL_WindowShapeParams union with an enum describing the type of its contents. */ | 105 /** \brief A struct that tags the SDL_WindowShapeParams union with an enum describing the type of its contents. */ |
101 typedef struct SDL_WindowShapeMode { | 106 typedef struct SDL_WindowShapeMode { |
107 /** \brief The mode of these window-shape parameters. */ | |
102 WindowShapeMode mode; | 108 WindowShapeMode mode; |
109 /** \brief Window-shape parameters. */ | |
103 SDL_WindowShapeParams parameters; | 110 SDL_WindowShapeParams parameters; |
104 } SDL_WindowShapeMode; | 111 } SDL_WindowShapeMode; |
105 | 112 |
106 /** | 113 /** |
107 * \brief Set the shape parameters of a shaped window. | 114 * \brief Set the shape parameters of a shaped window. |