diff options
author | David Thompson <dthompson2@worcester.edu> | 2021-04-13 11:30:50 -0400 |
---|---|---|
committer | David Thompson <dthompson2@worcester.edu> | 2021-04-13 11:30:50 -0400 |
commit | ce9d6e8ad28b2d84d1a292a871c23b66a4654b54 (patch) | |
tree | ade44e7bb7b891c9ae0ceba18633ef4b2a911a7c /manuals/guile-sdl2/Windows.html | |
parent | 2a30eb2a2d5472be3df1254d5d4d04310314e628 (diff) |
Add new guile-sdl2 and chickadee releases.
Diffstat (limited to 'manuals/guile-sdl2/Windows.html')
-rw-r--r-- | manuals/guile-sdl2/Windows.html | 115 |
1 files changed, 68 insertions, 47 deletions
diff --git a/manuals/guile-sdl2/Windows.html b/manuals/guile-sdl2/Windows.html index 2bb310a..463e0fa 100644 --- a/manuals/guile-sdl2/Windows.html +++ b/manuals/guile-sdl2/Windows.html @@ -1,6 +1,6 @@ <!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 +<!-- Copyright (C) 2016, 2017, 2018, 2019 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 @@ -13,10 +13,12 @@ A copy of the license is also available from the Free Software Foundation Web site at http://www.gnu.org/licenses/fdl.html. +* Guile-SDL2: (guile-sdl2). SDL2 bindings for Guile. + The document was typeset with http://www.texinfo.org/ (GNU Texinfo). --> -<!-- Created by GNU Texinfo 6.5, http://www.gnu.org/software/texinfo/ --> +<!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ --> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> <title>Windows (Guile-SDL2)</title> @@ -26,33 +28,24 @@ http://www.texinfo.org/ (GNU Texinfo). <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" rel="start" title="Top"> +<link href="Index.html" 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"> +<link href="Window-Management.html" rel="up" title="Window Management"> +<link href="OpenGL.html" rel="next" title="OpenGL"> +<link href="Window-Management.html" 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} @@ -87,17 +80,15 @@ ul.no-bullet {list-style: none} </head> <body lang="en"> -<a name="Windows"></a> -<div class="header"> +<span id="Windows"></span><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> [<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> +Next: <a href="OpenGL.html" accesskey="n" rel="next">OpenGL</a>, Up: <a href="Window-Management.html" accesskey="u" rel="up">Window Management</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Index.html" title="Index" rel="index">Index</a>]</p> </div> <hr> -<a name="Windows-1"></a> -<h4 class="subsection">3.2.1 Windows</h4> +<span id="Windows-1"></span><h4 class="subsection">3.2.1 Windows</h4> <dl> -<dt><a name="index-make_002dwindow"></a>Procedure: <strong>make-window</strong> <em>[#:title "Guile SDL2 Window"] [#: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> +<dt id="index-make_002dwindow">Procedure: <strong>make-window</strong> <em>[#:title "Guile SDL2 Window"] [#: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 @@ -108,97 +99,127 @@ 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> +<dt id="index-close_002dwindow_0021">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> +<dt id="index-call_002dwith_002dwindow">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> +<dt id="index-window_002dtitle">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>. +<dt id="index-window_002dsize">Procedure: <strong>window-size</strong> <em>window</em></dt> +<dd><p>Return 2 values for the dimensions of <var>window</var>. +</p></dd></dl> + +<dl> +<dt id="index-window_002dminimum_002dsize">Procedure: <strong>window-minimum-size</strong> <em>window</em></dt> +<dd><p>Return 2 values for the minimal dimensions that <var>window</var> can be. +Note that SDL does not always enforce this restriction, so you might +end up with a window size that is actually smaller than the value +returned by this procedure. </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. +<dt id="index-window_002dmaximum_002dsize">Procedure: <strong>window-maximum-size</strong> <em>window</em></dt> +<dd><p>Return 2 values for the maximum dimensions that <var>window</var> can be. </p></dd></dl> <dl> -<dt><a name="index-window_002did"></a>Procedure: <strong>window-id</strong> <em>window</em></dt> +<dt id="index-window_002dposition">Procedure: <strong>window-position</strong> <em>window</em></dt> +<dd><p>Return 2 values for the position of <var>window</var> on the display. +</p></dd></dl> + +<dl> +<dt id="index-window_002did">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->window</strong> <em>id</em></dt> +<dt id="index-id_002d_003ewindow">Procedure: <strong>id->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> +<dt id="index-hide_002dwindow_0021">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> +<dt id="index-show_002dwindow_0021">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> +<dt id="index-maximize_002dwindow_0021">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> +<dt id="index-minimize_002dwindow_0021">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> +<dt id="index-raise_002dwindow_0021">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> +<dt id="index-restore_002dwindow_0021">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> +<dt id="index-set_002dwindow_002dborder_0021">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> +<dt id="index-set_002dwindow_002dtitle_0021">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. +<dt id="index-set_002dwindow_002dposition_0021">Procedure: <strong>set-window-position!</strong> <em>window x y</em></dt> +<dd><p>Set the position of <var>window</var> to (<var>x</var>, <var>y</var>). +</p></dd></dl> + +<dl> +<dt id="index-set_002dwindow_002dsize_0021">Procedure: <strong>set-window-size!</strong> <em>window width height</em></dt> +<dd><p>Set the dimensions of <var>window</var> to <var>width</var> x <var>height</var> +pixels. +</p></dd></dl> + +<dl> +<dt id="index-set_002dwindow_002dminimum_002dsize_0021">Procedure: <strong>set-window-minimum-size!</strong> <em>window width height</em></dt> +<dd><p>Set the minimum dimensions of <var>window</var> to <var>width</var> x +<var>height</var> pixels. +</p></dd></dl> + +<dl> +<dt id="index-set_002dwindow_002dmaximum_002dsize_0021">Procedure: <strong>set-window-maximum-size!</strong> <em>window width height</em></dt> +<dd><p>Set the maximum dimensions of <var>window</var> to <var>width</var> x +<var>height</var> 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. +<dt id="index-set_002dwindow_002dresizable_0021">Procedure: <strong>set-window-resizable!</strong> <em>window resizable?</em></dt> +<dd><p>If <var>resizable</var> is <code>#t</code>, allow <var>window</var> to be resized, +otherwise disable resizing. </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> +<dt id="index-set_002dwindow_002dfullscreen_0021">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 "fake" fullscreen mode @@ -208,7 +229,7 @@ is used that takes the size of the desktop. <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> [<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> +Next: <a href="OpenGL.html" accesskey="n" rel="next">OpenGL</a>, Up: <a href="Window-Management.html" accesskey="u" rel="up">Window Management</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Index.html" title="Index" rel="index">Index</a>]</p> </div> |