Sophie

Sophie

distrib > Mageia > 5 > i586 > media > core-release > by-pkgid > 7281b619e6b612f5388cfad6b0e56530 > files > 88

sdl2-docs-2.0.3-4.mga5.noarch.rpm

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.8"/>
<title>My Project: SDL_shape.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td style="padding-left: 0.5em;">
   <div id="projectname">My Project
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.8 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
      <li><a href="annotated.html"><span>Classes</span></a></li>
      <li class="current"><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="files.html"><span>File&#160;List</span></a></li>
      <li><a href="globals.html"><span>File&#160;Members</span></a></li>
    </ul>
  </div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Pages</a></div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#define-members">Macros</a> &#124;
<a href="#typedef-members">Typedefs</a> &#124;
<a href="#enum-members">Enumerations</a> &#124;
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">SDL_shape.h File Reference</div>  </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &quot;<a class="el" href="SDL__stdinc_8h_source.html">SDL_stdinc.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="SDL__pixels_8h_source.html">SDL_pixels.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="SDL__rect_8h_source.html">SDL_rect.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="SDL__surface_8h_source.html">SDL_surface.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="SDL__video_8h_source.html">SDL_video.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="begin__code_8h_source.html">begin_code.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="close__code_8h_source.html">close_code.h</a>&quot;</code><br />
</div>
<p><a href="SDL__shape_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">union &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="unionSDL__WindowShapeParams.html">SDL_WindowShapeParams</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">A union containing parameters for shaped windows.  <a href="unionSDL__WindowShapeParams.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structSDL__WindowShapeMode.html">SDL_WindowShapeMode</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">A struct that tags the <a class="el" href="unionSDL__WindowShapeParams.html" title="A union containing parameters for shaped windows. ">SDL_WindowShapeParams</a> union with an enum describing the type of its contents.  <a href="structSDL__WindowShapeMode.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:a45e50a0ce349a4e200338d634fa73de5"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a45e50a0ce349a4e200338d634fa73de5"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><b>SDL_NONSHAPEABLE_WINDOW</b>&#160;&#160;&#160;-1</td></tr>
<tr class="separator:a45e50a0ce349a4e200338d634fa73de5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1cfaf1e1a560ef7f68f59f46a9a0b1fd"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1cfaf1e1a560ef7f68f59f46a9a0b1fd"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><b>SDL_INVALID_SHAPE_ARGUMENT</b>&#160;&#160;&#160;-2</td></tr>
<tr class="separator:a1cfaf1e1a560ef7f68f59f46a9a0b1fd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa7306c8f1a1b87b398a9842383303232"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa7306c8f1a1b87b398a9842383303232"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><b>SDL_WINDOW_LACKS_SHAPE</b>&#160;&#160;&#160;-3</td></tr>
<tr class="separator:aa7306c8f1a1b87b398a9842383303232"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af8e3c7bdeca58eb82cb8faed8d385cdc"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af8e3c7bdeca58eb82cb8faed8d385cdc"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><b>SDL_SHAPEMODEALPHA</b>(mode)&#160;&#160;&#160;(mode == <a class="el" href="SDL__shape_8h.html#aa30948f2699e316a43b740eccebe5c20aca1bc38c9b5179cbed0e9e176cd84d9e">ShapeModeDefault</a> || mode == <a class="el" href="SDL__shape_8h.html#aa30948f2699e316a43b740eccebe5c20a0ba1cff6129858a1136728ffdc787926">ShapeModeBinarizeAlpha</a> || mode == <a class="el" href="SDL__shape_8h.html#aa30948f2699e316a43b740eccebe5c20ae478c81ede522586674806541e145993">ShapeModeReverseBinarizeAlpha</a>)</td></tr>
<tr class="separator:af8e3c7bdeca58eb82cb8faed8d385cdc"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:a6c00a109057f1e6055dd807600171300"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6c00a109057f1e6055dd807600171300"></a>
typedef struct <a class="el" href="structSDL__WindowShapeMode.html">SDL_WindowShapeMode</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="SDL__shape_8h.html#a6c00a109057f1e6055dd807600171300">SDL_WindowShapeMode</a></td></tr>
<tr class="memdesc:a6c00a109057f1e6055dd807600171300"><td class="mdescLeft">&#160;</td><td class="mdescRight">A struct that tags the <a class="el" href="unionSDL__WindowShapeParams.html" title="A union containing parameters for shaped windows. ">SDL_WindowShapeParams</a> union with an enum describing the type of its contents. <br /></td></tr>
<tr class="separator:a6c00a109057f1e6055dd807600171300"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:aa30948f2699e316a43b740eccebe5c20"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="SDL__shape_8h.html#aa30948f2699e316a43b740eccebe5c20">WindowShapeMode</a> { <a class="el" href="SDL__shape_8h.html#aa30948f2699e316a43b740eccebe5c20aca1bc38c9b5179cbed0e9e176cd84d9e">ShapeModeDefault</a>, 
<a class="el" href="SDL__shape_8h.html#aa30948f2699e316a43b740eccebe5c20a0ba1cff6129858a1136728ffdc787926">ShapeModeBinarizeAlpha</a>, 
<a class="el" href="SDL__shape_8h.html#aa30948f2699e316a43b740eccebe5c20ae478c81ede522586674806541e145993">ShapeModeReverseBinarizeAlpha</a>, 
<a class="el" href="SDL__shape_8h.html#aa30948f2699e316a43b740eccebe5c20a1d3ca52e90d5b3086e22120c2899f214">ShapeModeColorKey</a>
 }</td></tr>
<tr class="memdesc:aa30948f2699e316a43b740eccebe5c20"><td class="mdescLeft">&#160;</td><td class="mdescRight">An enum denoting the specific type of contents present in an <a class="el" href="unionSDL__WindowShapeParams.html" title="A union containing parameters for shaped windows. ">SDL_WindowShapeParams</a> union.  <a href="SDL__shape_8h.html#aa30948f2699e316a43b740eccebe5c20">More...</a><br /></td></tr>
<tr class="separator:aa30948f2699e316a43b740eccebe5c20"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a5a7bed102a3db4d91e6a8e21be0f9950"><td class="memItemLeft" align="right" valign="top">DECLSPEC <a class="el" href="SDL__video_8h.html#a55a196c7d3b8497538632c79ae1e6392">SDL_Window</a> *SDLCALL&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="SDL__shape_8h.html#a5a7bed102a3db4d91e6a8e21be0f9950">SDL_CreateShapedWindow</a> (const char *title, unsigned <a class="el" href="SDL__thread_8h.html#a6a64f9be4433e4de6e2f2f548cf3c08e">int</a> x, unsigned <a class="el" href="SDL__thread_8h.html#a6a64f9be4433e4de6e2f2f548cf3c08e">int</a> y, unsigned <a class="el" href="SDL__thread_8h.html#a6a64f9be4433e4de6e2f2f548cf3c08e">int</a> w, unsigned <a class="el" href="SDL__thread_8h.html#a6a64f9be4433e4de6e2f2f548cf3c08e">int</a> h, <a class="el" href="SDL__stdinc_8h.html#add440eff171ea5f55cb00c4a9ab8672d">Uint32</a> flags)</td></tr>
<tr class="memdesc:a5a7bed102a3db4d91e6a8e21be0f9950"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a window that can be shaped with the specified position, dimensions, and flags.  <a href="#a5a7bed102a3db4d91e6a8e21be0f9950">More...</a><br /></td></tr>
<tr class="separator:a5a7bed102a3db4d91e6a8e21be0f9950"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a28630f0f6b298bac4d0efe850d7d327e"><td class="memItemLeft" align="right" valign="top">DECLSPEC SDL_bool SDLCALL&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="SDL__shape_8h.html#a28630f0f6b298bac4d0efe850d7d327e">SDL_IsShapedWindow</a> (const <a class="el" href="SDL__video_8h.html#a55a196c7d3b8497538632c79ae1e6392">SDL_Window</a> *window)</td></tr>
<tr class="memdesc:a28630f0f6b298bac4d0efe850d7d327e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return whether the given window is a shaped window.  <a href="#a28630f0f6b298bac4d0efe850d7d327e">More...</a><br /></td></tr>
<tr class="separator:a28630f0f6b298bac4d0efe850d7d327e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a90d52818802235df9689922be5a4cf5a"><td class="memItemLeft" align="right" valign="top">DECLSPEC <a class="el" href="SDL__thread_8h.html#a6a64f9be4433e4de6e2f2f548cf3c08e">int</a> SDLCALL&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="SDL__shape_8h.html#a90d52818802235df9689922be5a4cf5a">SDL_SetWindowShape</a> (<a class="el" href="SDL__video_8h.html#a55a196c7d3b8497538632c79ae1e6392">SDL_Window</a> *window, <a class="el" href="structSDL__Surface.html">SDL_Surface</a> *shape, <a class="el" href="structSDL__WindowShapeMode.html">SDL_WindowShapeMode</a> *shape_mode)</td></tr>
<tr class="memdesc:a90d52818802235df9689922be5a4cf5a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the shape and parameters of a shaped window.  <a href="#a90d52818802235df9689922be5a4cf5a">More...</a><br /></td></tr>
<tr class="separator:a90d52818802235df9689922be5a4cf5a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a64dba6f6440cf6984d8da868fd758711"><td class="memItemLeft" align="right" valign="top">DECLSPEC <a class="el" href="SDL__thread_8h.html#a6a64f9be4433e4de6e2f2f548cf3c08e">int</a> SDLCALL&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="SDL__shape_8h.html#a64dba6f6440cf6984d8da868fd758711">SDL_GetShapedWindowMode</a> (<a class="el" href="SDL__video_8h.html#a55a196c7d3b8497538632c79ae1e6392">SDL_Window</a> *window, <a class="el" href="structSDL__WindowShapeMode.html">SDL_WindowShapeMode</a> *shape_mode)</td></tr>
<tr class="memdesc:a64dba6f6440cf6984d8da868fd758711"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the shape parameters of a shaped window.  <a href="#a64dba6f6440cf6984d8da868fd758711">More...</a><br /></td></tr>
<tr class="separator:a64dba6f6440cf6984d8da868fd758711"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Header file for the shaped window API. </p>
</div><h2 class="groupheader">Enumeration Type Documentation</h2>
<a class="anchor" id="aa30948f2699e316a43b740eccebe5c20"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="SDL__shape_8h.html#aa30948f2699e316a43b740eccebe5c20">WindowShapeMode</a></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>An enum denoting the specific type of contents present in an <a class="el" href="unionSDL__WindowShapeParams.html" title="A union containing parameters for shaped windows. ">SDL_WindowShapeParams</a> union. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a class="anchor" id="aa30948f2699e316a43b740eccebe5c20aca1bc38c9b5179cbed0e9e176cd84d9e"></a>ShapeModeDefault&#160;</td><td class="fielddoc">
<p>The default mode, a binarized alpha cutoff of 1. </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="aa30948f2699e316a43b740eccebe5c20a0ba1cff6129858a1136728ffdc787926"></a>ShapeModeBinarizeAlpha&#160;</td><td class="fielddoc">
<p>A binarized alpha cutoff with a given integer value. </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="aa30948f2699e316a43b740eccebe5c20ae478c81ede522586674806541e145993"></a>ShapeModeReverseBinarizeAlpha&#160;</td><td class="fielddoc">
<p>A binarized alpha cutoff with a given integer value, but with the opposite comparison. </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="aa30948f2699e316a43b740eccebe5c20a1d3ca52e90d5b3086e22120c2899f214"></a>ShapeModeColorKey&#160;</td><td class="fielddoc">
<p>A color key is applied. </p>
</td></tr>
</table>

</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="a5a7bed102a3db4d91e6a8e21be0f9950"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">DECLSPEC <a class="el" href="SDL__video_8h.html#a55a196c7d3b8497538632c79ae1e6392">SDL_Window</a>* SDLCALL SDL_CreateShapedWindow </td>
          <td>(</td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>title</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">unsigned <a class="el" href="SDL__thread_8h.html#a6a64f9be4433e4de6e2f2f548cf3c08e">int</a>&#160;</td>
          <td class="paramname"><em>x</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">unsigned <a class="el" href="SDL__thread_8h.html#a6a64f9be4433e4de6e2f2f548cf3c08e">int</a>&#160;</td>
          <td class="paramname"><em>y</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">unsigned <a class="el" href="SDL__thread_8h.html#a6a64f9be4433e4de6e2f2f548cf3c08e">int</a>&#160;</td>
          <td class="paramname"><em>w</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">unsigned <a class="el" href="SDL__thread_8h.html#a6a64f9be4433e4de6e2f2f548cf3c08e">int</a>&#160;</td>
          <td class="paramname"><em>h</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="SDL__stdinc_8h.html#add440eff171ea5f55cb00c4a9ab8672d">Uint32</a>&#160;</td>
          <td class="paramname"><em>flags</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Create a window that can be shaped with the specified position, dimensions, and flags. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">title</td><td>The title of the window, in UTF-8 encoding. </td></tr>
    <tr><td class="paramname">x</td><td>The x position of the window, ::SDL_WINDOWPOS_CENTERED, or ::SDL_WINDOWPOS_UNDEFINED. </td></tr>
    <tr><td class="paramname">y</td><td>The y position of the window, ::SDL_WINDOWPOS_CENTERED, or ::SDL_WINDOWPOS_UNDEFINED. </td></tr>
    <tr><td class="paramname">w</td><td>The width of the window. </td></tr>
    <tr><td class="paramname">h</td><td>The height of the window. </td></tr>
    <tr><td class="paramname">flags</td><td>The flags for the window, a mask of SDL_WINDOW_BORDERLESS with any of the following: <a class="el" href="SDL__video_8h.html#ab10f4fd6a082ef06fcae96860c95fb18a5cf8af096f1870b0c2b12267cabd1f7a">SDL_WINDOW_OPENGL</a>, <a class="el" href="SDL__video_8h.html#ab10f4fd6a082ef06fcae96860c95fb18aaf410e1082e45a55ef9176163610dba2">SDL_WINDOW_INPUT_GRABBED</a>, <a class="el" href="SDL__video_8h.html#ab10f4fd6a082ef06fcae96860c95fb18adda25e98e54964c0c2ec9ac31f5e629c">SDL_WINDOW_HIDDEN</a>, <a class="el" href="SDL__video_8h.html#ab10f4fd6a082ef06fcae96860c95fb18aaf59a5e2f762aa2b6d2e49b0ca220fd8">SDL_WINDOW_RESIZABLE</a>, <a class="el" href="SDL__video_8h.html#ab10f4fd6a082ef06fcae96860c95fb18acd8063a617f2ce05f694ecdbf56f811a">SDL_WINDOW_MAXIMIZED</a>, <a class="el" href="SDL__video_8h.html#ab10f4fd6a082ef06fcae96860c95fb18a7f08ee26b5773412a212233ddc168c5a">SDL_WINDOW_MINIMIZED</a>, <a class="el" href="SDL__video_8h.html#ab10f4fd6a082ef06fcae96860c95fb18af7baea7dc9c0e4f09b28793504b02e4c">SDL_WINDOW_BORDERLESS</a> is always set, and <a class="el" href="SDL__video_8h.html#ab10f4fd6a082ef06fcae96860c95fb18ac7b8279bdf5e22a0b4a95aae3d846923">SDL_WINDOW_FULLSCREEN</a> is always unset.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The window created, or NULL if window creation failed.</dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="SDL__video_8h.html#a72609295a4faee0587268339ccff80c2" title="Destroy a window. ">SDL_DestroyWindow()</a> </dd></dl>

</div>
</div>
<a class="anchor" id="a64dba6f6440cf6984d8da868fd758711"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">DECLSPEC <a class="el" href="SDL__thread_8h.html#a6a64f9be4433e4de6e2f2f548cf3c08e">int</a> SDLCALL SDL_GetShapedWindowMode </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="SDL__video_8h.html#a55a196c7d3b8497538632c79ae1e6392">SDL_Window</a> *&#160;</td>
          <td class="paramname"><em>window</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="structSDL__WindowShapeMode.html">SDL_WindowShapeMode</a> *&#160;</td>
          <td class="paramname"><em>shape_mode</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Get the shape parameters of a shaped window. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">window</td><td>The shaped window whose parameters should be retrieved. </td></tr>
    <tr><td class="paramname">shape_mode</td><td>An empty shape-mode structure to fill, or NULL to check whether the window has a shape.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 if the window has a shape and, provided shape_mode was not NULL, shape_mode has been filled with the mode data, SDL_NONSHAPEABLE_WINDOW if the SDL_Window given is not a shaped window, or SDL_WINDOW_LACKS_SHAPE if the SDL_Window* given is a shapeable window currently lacking a shape.</dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="structSDL__WindowShapeMode.html" title="A struct that tags the SDL_WindowShapeParams union with an enum describing the type of its contents...">SDL_WindowShapeMode</a> </dd>
<dd>
<a class="el" href="SDL__shape_8h.html#a90d52818802235df9689922be5a4cf5a" title="Set the shape and parameters of a shaped window. ">SDL_SetWindowShape</a> </dd></dl>

</div>
</div>
<a class="anchor" id="a28630f0f6b298bac4d0efe850d7d327e"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">DECLSPEC SDL_bool SDLCALL SDL_IsShapedWindow </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="SDL__video_8h.html#a55a196c7d3b8497538632c79ae1e6392">SDL_Window</a> *&#160;</td>
          <td class="paramname"><em>window</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Return whether the given window is a shaped window. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">window</td><td>The window to query for being shaped.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>SDL_TRUE if the window is a window that can be shaped, SDL_FALSE if the window is unshaped or NULL. </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="SDL__shape_8h.html#a5a7bed102a3db4d91e6a8e21be0f9950" title="Create a window that can be shaped with the specified position, dimensions, and flags. ">SDL_CreateShapedWindow</a> </dd></dl>

</div>
</div>
<a class="anchor" id="a90d52818802235df9689922be5a4cf5a"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">DECLSPEC <a class="el" href="SDL__thread_8h.html#a6a64f9be4433e4de6e2f2f548cf3c08e">int</a> SDLCALL SDL_SetWindowShape </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="SDL__video_8h.html#a55a196c7d3b8497538632c79ae1e6392">SDL_Window</a> *&#160;</td>
          <td class="paramname"><em>window</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="structSDL__Surface.html">SDL_Surface</a> *&#160;</td>
          <td class="paramname"><em>shape</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="structSDL__WindowShapeMode.html">SDL_WindowShapeMode</a> *&#160;</td>
          <td class="paramname"><em>shape_mode</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Set the shape and parameters of a shaped window. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">window</td><td>The shaped window whose parameters should be set. </td></tr>
    <tr><td class="paramname">shape</td><td>A surface encoding the desired shape for the window. </td></tr>
    <tr><td class="paramname">shape_mode</td><td>The parameters to set for the shaped window.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 on success, SDL_INVALID_SHAPE_ARGUMENT on invalid an invalid shape argument, or SDL_NONSHAPEABLE_WINDOW if the SDL_Window* given does not reference a valid shaped window.</dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="structSDL__WindowShapeMode.html" title="A struct that tags the SDL_WindowShapeParams union with an enum describing the type of its contents...">SDL_WindowShapeMode</a> </dd>
<dd>
<a class="el" href="SDL__shape_8h.html#a64dba6f6440cf6984d8da868fd758711" title="Get the shape parameters of a shaped window. ">SDL_GetShapedWindowMode</a>. </dd></dl>

</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Oct 16 2014 16:33:09 for My Project by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.8
</small></address>
</body>
</html>