diff options
| author | David Thompson <dthompson2@worcester.edu> | 2016-08-19 20:40:12 -0400 |
|---|---|---|
| committer | David Thompson <dthompson2@worcester.edu> | 2016-08-19 20:40:12 -0400 |
| commit | 9224412274e1e1a31a959083bb257a7d6ab2b113 (patch) | |
| tree | c82ef8b0136037aa1b278957f42ae665188861be /manuals/sly/Window-Creation.html | |
| parent | c47d942552568e9a866e9d4887944e0c074dec93 (diff) | |
Add Sly manual.
Diffstat (limited to 'manuals/sly/Window-Creation.html')
| -rw-r--r-- | manuals/sly/Window-Creation.html | 177 |
1 files changed, 177 insertions, 0 deletions
diff --git a/manuals/sly/Window-Creation.html b/manuals/sly/Window-Creation.html new file mode 100644 index 0000000..5e6dfc7 --- /dev/null +++ b/manuals/sly/Window-Creation.html @@ -0,0 +1,177 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> +<html> +<!-- Copyright (C) 2013, 2014 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.0, http://www.gnu.org/software/texinfo/ --> +<head> +<title>Sly: Window Creation</title> + +<meta name="description" content="Sly: Window Creation"> +<meta name="keywords" content="Sly: Window Creation"> +<meta name="resource-type" content="document"> +<meta name="distribution" content="global"> +<meta name="Generator" content="makeinfo"> +<meta charset="UTF-8"> +<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="Booting.html#Booting" rel="up" title="Booting"> +<link href="The-Game-Loop.html#The-Game-Loop" rel="next" title="The Game Loop"> +<link href="Booting.html#Booting" rel="prev" title="Booting"> +<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.nocodebreak {white-space: nowrap} +span.nolinebreak {white-space: nowrap} +span.roman {font-family: serif; font-weight: normal} +span.sansserif {font-family: sans-serif; font-weight: normal} +ul.no-bullet {list-style: none} +--> +</style> + + +</head> + +<body lang="en"> +<a name="Window-Creation"></a> +<div class="header"> +<p> +Next: <a href="The-Game-Loop.html#The-Game-Loop" accesskey="n" rel="next">The Game Loop</a>, Up: <a href="Booting.html#Booting" accesskey="u" rel="up">Booting</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> +</div> +<hr> +<a name="Window-Creation-1"></a> +<h4 class="subsection">4.1.1 Window Creation</h4> + +<div class="example"> +<pre class="example">(use-modules (sly window)) +</pre></div> + +<p>Sly uses the windowing features of SDL 1.2 under the hood, which +currently restricts Sly applications to using only a single window. +SDL2 support will come in a future release. +</p> +<p>The window data structure: +</p> +<dl> +<dt><a name="index-make_002dwindow"></a>Scheme Procedure: <strong>make-window</strong> <em>[<var>#:title</var>] [<var>#:resolution</var>] [<var>#:fullscreen?</var>]</em></dt> +<dd><p>Create a new window object. <code>title</code> is a string to display in +the window’s title bar. <code>resolution</code> is a 2D vector that +specifies the dimensions of the window in pixels. <code>fullscreen?</code> +is a boolean that toggles fullscreen mode. +</p></dd></dl> + +<dl> +<dt><a name="index-window_003f"></a>Scheme Procedure: <strong>window?</strong> <em><var>obj</var></em></dt> +<dd><p>Return <code>#t</code> if <code>obj</code> is a window. +</p></dd></dl> + +<dl> +<dt><a name="index-window_002dtitle"></a>Scheme Procedure: <strong>window-title</strong> <em><var>window</var></em></dt> +<dd><p>Return the title of <code>window</code>. +</p></dd></dl> + +<dl> +<dt><a name="index-window_002dresolution"></a>Scheme Procedure: <strong>window-resolution</strong> <em><var>window</var></em></dt> +<dd><p>Return the resolution of <code>window</code>. +</p></dd></dl> + +<dl> +<dt><a name="index-window_002dfullscreen_003f"></a>Scheme Procedure: <strong>window-fullscreen?</strong> <em><var>window</var></em></dt> +<dd><p>Return <code>#t</code> if <code>window</code> is set to fullscreen mode. +</p></dd></dl> + +<p>The following signals hold the state of the current window: +</p> +<dl> +<dt><a name="index-window_002dwidth"></a>Scheme Signal: <strong>window-width</strong></dt> +<dd><p>The width of the current window. +</p></dd></dl> + +<dl> +<dt><a name="index-window_002dheight"></a>Scheme Signal: <strong>window-height</strong></dt> +<dd><p>The height of the current window. +</p></dd></dl> + +<dl> +<dt><a name="index-window_002dsize"></a>Scheme Signal: <strong>window-size</strong></dt> +<dd><p>The size of the current window as a 2D vector. +</p></dd></dl> + +<p>In addition to signals, the following hooks are triggered upon certain +changes to window state: +</p> +<dl> +<dt><a name="index-window_002dresize_002dhook"></a>Scheme Variable: <strong>window-resize-hook</strong></dt> +<dd><p>This hook is run when the current window is resized. Procedures added +to this hook should accept two arguments: Numbers <code>width</code> and +<code>height</code>, the new dimensions of the window in pixels. +</p></dd></dl> + +<dl> +<dt><a name="index-window_002dclose_002dhook"></a>Scheme Variable: <strong>window-close-hook</strong></dt> +<dd><p>This hook is run when the close button is clicked. Note that this +event is simply a request from the user to close the window, it does +not mean that the window has actually been closed. Procedures added +to this hook should accept no arguments. +</p></dd></dl> + +<p>The following procedures are used to open/close windows: +</p> +<dl> +<dt><a name="index-open_002dwindow"></a>Scheme Procedure: <strong>open-window</strong> <em>[<var>window</var>]</em></dt> +<dd><p>Open the game window using the settings in <code>window</code>. +</p></dd></dl> + +<dl> +<dt><a name="index-close_002dwindow"></a>Scheme Procedure: <strong>close-window</strong></dt> +<dd><p>Close the currently open window. +</p></dd></dl> + +<dl> +<dt><a name="index-with_002dwindow"></a>Scheme Syntax: <strong>with-window</strong> <em><var>window</var> <var>body</var> …</em></dt> +<dd><p>Evaluate <code>body</code> in the context of <code>window</code>. <code>window</code> +is opened before evaluating <code>body</code>, and closed afterwards. +</p></dd></dl> + +<hr> +<div class="header"> +<p> +Next: <a href="The-Game-Loop.html#The-Game-Loop" accesskey="n" rel="next">The Game Loop</a>, Up: <a href="Booting.html#Booting" accesskey="u" rel="up">Booting</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> +</div> + + + +</body> +</html> |