Add guile-sdl2 manual.

author: David Thompson <dthompson@vistahigherlearning.com> 2019-06-02 20:50:28 -0400
committer: David Thompson <dthompson@vistahigherlearning.com> 2019-06-02 20:50:28 -0400
commit: b421d4e7e06f977436b6e6195b95ca44d884e0c0 (patch)
tree: cd6e040b7d0fea82b5f766d1508c7278ff50fac0 /manuals/guile-sdl2/Windows.html
parent: 179da31b16bcf711c14020ec85472c145fc4be51 (diff)
1 files changed, 217 insertions, 0 deletions
diff --git a/manuals/guile-sdl2/Windows.html b/manuals/guile-sdl2/Windows.html
new file mode 100644
index 0000000..2bb310a
--- /dev/null
+++ b/manuals/guile-sdl2/Windows.html
@@ -0,0 +1,217 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<html>
+<!-- Copyright (C) 2016  David Thompson davet@gnu.org
+
+Permission is granted to copy, distribute and/or modify this document
+under the terms of the GNU Free Documentation License, Version 1.3
+or any later version published by the Free Software Foundation;
+with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.
+A copy of the license is included in the section entitled "GNU
+Free Documentation License".
+
+A copy of the license is also available from the Free Software
+Foundation Web site at http://www.gnu.org/licenses/fdl.html.
+
+
+The document was typeset with
+http://www.texinfo.org/ (GNU Texinfo).
+ -->
+<!-- Created by GNU Texinfo 6.5, http://www.gnu.org/software/texinfo/ -->
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<title>Windows (Guile-SDL2)</title>
+
+<meta name="description" content="Windows (Guile-SDL2)">
+<meta name="keywords" content="Windows (Guile-SDL2)">
+<meta name="resource-type" content="document">
+<meta name="distribution" content="global">
+<meta name="Generator" content="makeinfo">
+<link href="index.html#Top" rel="start" title="Top">
+<link href="Index.html#Index" rel="index" title="Index">
+<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
+<link href="Window-Management.html#Window-Management" rel="up" title="Window Management">
+<link href="OpenGL.html#OpenGL" rel="next" title="OpenGL">
+<link href="Window-Management.html#Window-Management" rel="prev" title="Window Management">
+<style type="text/css">
+<!--
+a.summary-letter {text-decoration: none}
+blockquote.indentedblock {margin-right: 0em}
+blockquote.smallindentedblock {margin-right: 0em; font-size: smaller}
+blockquote.smallquotation {font-size: smaller}
+div.display {margin-left: 3.2em}
+div.example {margin-left: 3.2em}
+div.lisp {margin-left: 3.2em}
+div.smalldisplay {margin-left: 3.2em}
+div.smallexample {margin-left: 3.2em}
+div.smalllisp {margin-left: 3.2em}
+kbd {font-style: oblique}
+pre.display {font-family: inherit}
+pre.format {font-family: inherit}
+pre.menu-comment {font-family: serif}
+pre.menu-preformatted {font-family: serif}
+pre.smalldisplay {font-family: inherit; font-size: smaller}
+pre.smallexample {font-size: smaller}
+pre.smallformat {font-family: inherit; font-size: smaller}
+pre.smalllisp {font-size: smaller}
+span.nolinebreak {white-space: nowrap}
+span.roman {font-family: initial; font-weight: normal}
+span.sansserif {font-family: sans-serif; font-weight: normal}
+ul.no-bullet {list-style: none}
+@media (min-width: 1140px) {
+    body {
+        margin-left: 14rem;
+        margin-right: 4rem;
+        max-width: 52rem;
+    }
+}
+
+@media (min-width: 800px) and (max-width: 1140px) {
+    body {
+        margin-left: 6rem;
+        margin-right: 4rem;
+        max-width: 52rem;
+    }
+}
+
+@media (max-width: 800px) {
+    body {
+        margin: 1rem;
+    }
+}
+
+-->
+</style>
+<link rel="stylesheet" type="text/css" href="https://dthompson.us/css/dthompson.css">
+
+
+</head>
+
+<body lang="en">
+<a name="Windows"></a>
+<div class="header">
+<p>
+Next: <a href="OpenGL.html#OpenGL" accesskey="n" rel="next">OpenGL</a>, Up: <a href="Window-Management.html#Window-Management" accesskey="u" rel="up">Window Management</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Index.html#Index" title="Index" rel="index">Index</a>]</p>
+</div>
+<hr>
+<a name="Windows-1"></a>
+<h4 class="subsection">3.2.1 Windows</h4>
+
+<dl>
+<dt><a name="index-make_002dwindow"></a>Procedure: <strong>make-window</strong> <em>[#:title &quot;Guile SDL2 Window&quot;]                           [#:position (#f #f)]                           [#:size (640 480)]                           [#:maximize? #f]                           [#:minimize? #f]                           [#:opengl? #f]                           [#:border? #t]                           [#:fullscreen? #f]                           [#:fullscreen-desktop? #f]                           [#:grab-input? #f]                           [#:high-dpi? #f]</em></dt>
+<dd><p>Create a new window named <var>title</var> with dimensions <var>size</var> located
+at <var>position</var> on the display.  <var>position</var> and <var>size</var> are
+two-element lists in the form <code>(x y)</code>, where each coordinate is
+measured in pixels.  In the case of <var>position</var>, a coordinate may use
+the special symbol <var>center</var> to indicate that the window should be
+centered on that axis, or <code>#f</code> to indicate that it does not matter
+where the window is located on that axis.
+</p></dd></dl>
+
+<dl>
+<dt><a name="index-close_002dwindow_0021"></a>Procedure: <strong>close-window!</strong> <em>window</em></dt>
+<dd><p>Close <var>window</var>.
+</p></dd></dl>
+
+<dl>
+<dt><a name="index-call_002dwith_002dwindow"></a>Procedure: <strong>call-with-window</strong> <em>window proc</em></dt>
+<dd><p>Call <var>proc</var> with <var>window</var>, an SDL window object, and close it
+when <var>proc</var> returns or otherwise exits.
+</p></dd></dl>
+
+<dl>
+<dt><a name="index-window_002dtitle"></a>Procedure: <strong>window-title</strong> <em>window</em></dt>
+<dd><p>Return the title for <var>window</var>.
+</p></dd></dl>
+
+<dl>
+<dt><a name="index-window_002dsize"></a>Procedure: <strong>window-size</strong> <em>window</em></dt>
+<dd><p>Return the dimensions of <var>window</var>.
+</p></dd></dl>
+
+<dl>
+<dt><a name="index-window_002dposition"></a>Procedure: <strong>window-position</strong> <em>window</em></dt>
+<dd><p>Return the position of <var>window</var> on the display.
+</p></dd></dl>
+
+<dl>
+<dt><a name="index-window_002did"></a>Procedure: <strong>window-id</strong> <em>window</em></dt>
+<dd><p>Return the numeric ID of <var>window</var>.
+</p></dd></dl>
+
+<dl>
+<dt><a name="index-id_002d_003ewindow"></a>Procedure: <strong>id-&gt;window</strong> <em>id</em></dt>
+<dd><p>Return the window corresponding to <var>ID</var>, a positive integer, or
+<code>#f</code> if there is no such window.
+</p></dd></dl>
+
+<dl>
+<dt><a name="index-hide_002dwindow_0021"></a>Procedure: <strong>hide-window!</strong> <em>window</em></dt>
+<dd><p>Hide <var>window</var>.
+</p></dd></dl>
+
+<dl>
+<dt><a name="index-show_002dwindow_0021"></a>Procedure: <strong>show-window!</strong> <em>window</em></dt>
+<dd><p>Show <var>window</var> and focus on it.
+</p></dd></dl>
+
+<dl>
+<dt><a name="index-maximize_002dwindow_0021"></a>Procedure: <strong>maximize-window!</strong> <em>window</em></dt>
+<dd><p>Make <var>window</var> as large as possible.
+</p></dd></dl>
+
+<dl>
+<dt><a name="index-minimize_002dwindow_0021"></a>Procedure: <strong>minimize-window!</strong> <em>window</em></dt>
+<dd><p>Shrink <var>window</var> to an iconic representation.
+</p></dd></dl>
+
+<dl>
+<dt><a name="index-raise_002dwindow_0021"></a>Procedure: <strong>raise-window!</strong> <em>window</em></dt>
+<dd><p>Raise <var>window</var> above all other windows and set input focus.
+</p></dd></dl>
+
+<dl>
+<dt><a name="index-restore_002dwindow_0021"></a>Procedure: <strong>restore-window!</strong> <em>window</em></dt>
+<dd><p>Restore the size and position of a minimized or maximized <var>window</var>.
+</p></dd></dl>
+
+<dl>
+<dt><a name="index-set_002dwindow_002dborder_0021"></a>Procedure: <strong>set-window-border!</strong> <em>window border?</em></dt>
+<dd><p>When <var>border?</var>, draw the usual border around <var>window</var>, otherwise
+remove the border.
+</p></dd></dl>
+
+<dl>
+<dt><a name="index-set_002dwindow_002dtitle_0021"></a>Procedure: <strong>set-window-title!</strong> <em>window title</em></dt>
+<dd><p>Set the title of <var>window</var> to the string <var>title</var>.
+</p></dd></dl>
+
+<dl>
+<dt><a name="index-set_002dwindow_002dposition_0021"></a>Procedure: <strong>set-window-position!</strong> <em>window position</em></dt>
+<dd><p>Set the position of <var>window</var> to <var>position</var>, a two-element list
+of (x,y) coordinates measured in pixels.
+</p></dd></dl>
+
+<dl>
+<dt><a name="index-set_002dwindow_002dsize_0021"></a>Procedure: <strong>set-window-size!</strong> <em>window size</em></dt>
+<dd><p>Set the dimensions of <var>window</var> to <var>size</var>, a two-element list of
+(width,height) coordinates measured in pixels.
+</p></dd></dl>
+
+<dl>
+<dt><a name="index-set_002dwindow_002dfullscreen_0021"></a>Procedure: <strong>set-window-fullscreen!</strong> <em>window fullscreen? [#:desktop?]</em></dt>
+<dd><p>Toggle fullscreen mode on/off for <var>window</var>.  If <var>fullscreen?</var>,
+fullscreen mode is activated, otherwise it is deactivated.  If
+<var>fullscreen?</var> and <var>desktop?</var>, a special &quot;fake&quot; fullscreen mode
+is used that takes the size of the desktop.
+</p></dd></dl>
+
+<hr>
+<div class="header">
+<p>
+Next: <a href="OpenGL.html#OpenGL" accesskey="n" rel="next">OpenGL</a>, Up: <a href="Window-Management.html#Window-Management" accesskey="u" rel="up">Window Management</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Index.html#Index" title="Index" rel="index">Index</a>]</p>
+</div>
+
+
+
+</body>
+</html>
author	David Thompson <dthompson@vistahigherlearning.com>	2019-06-02 20:50:28 -0400
committer	David Thompson <dthompson@vistahigherlearning.com>	2019-06-02 20:50:28 -0400
commit	b421d4e7e06f977436b6e6195b95ca44d884e0c0 (patch)
tree	cd6e040b7d0fea82b5f766d1508c7278ff50fac0 /manuals/guile-sdl2/Windows.html
parent	179da31b16bcf711c14020ec85472c145fc4be51 (diff)