diff options
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 | |
parent | 179da31b16bcf711c14020ec85472c145fc4be51 (diff) |
Add guile-sdl2 manual.
Diffstat (limited to 'manuals/guile-sdl2')
28 files changed, 5453 insertions, 0 deletions
diff --git a/manuals/guile-sdl2/API-Reference.html b/manuals/guile-sdl2/API-Reference.html new file mode 100644 index 0000000..50560bb --- /dev/null +++ b/manuals/guile-sdl2/API-Reference.html @@ -0,0 +1,126 @@ +<!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>API Reference (Guile-SDL2)</title> + +<meta name="description" content="API Reference (Guile-SDL2)"> +<meta name="keywords" content="API Reference (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="index.html#Top" rel="up" title="Top"> +<link href="Basics.html#Basics" rel="next" title="Basics"> +<link href="Requirements.html#Requirements" rel="prev" title="Requirements"> +<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="API-Reference"></a> +<div class="header"> +<p> +Next: <a href="Contributing.html#Contributing" accesskey="n" rel="next">Contributing</a>, Previous: <a href="Installation.html#Installation" accesskey="p" rel="prev">Installation</a>, Up: <a href="index.html#Top" accesskey="u" rel="up">Top</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="API-Reference-1"></a> +<h2 class="chapter">3 API Reference</h2> + +<table class="menu" border="0" cellspacing="0"> +<tr><td align="left" valign="top">• <a href="Basics.html#Basics" accesskey="1">Basics</a>:</td><td> </td><td align="left" valign="top">Initialization and other basic things. +</td></tr> +<tr><td align="left" valign="top">• <a href="Window-Management.html#Window-Management" accesskey="2">Window Management</a>:</td><td> </td><td align="left" valign="top">Working with the window system. +</td></tr> +<tr><td align="left" valign="top">• <a href="Input.html#Input" accesskey="3">Input</a>:</td><td> </td><td align="left" valign="top">Keyboard, mouse, joystick input. +</td></tr> +<tr><td align="left" valign="top">• <a href="Events.html#Events" accesskey="4">Events</a>:</td><td> </td><td align="left" valign="top">Asynchronous event handling. +</td></tr> +<tr><td align="left" valign="top">• <a href="Rects.html#Rects" accesskey="5">Rects</a>:</td><td> </td><td align="left" valign="top">2D rectangles. +</td></tr> +<tr><td align="left" valign="top">• <a href="Surfaces.html#Surfaces" accesskey="6">Surfaces</a>:</td><td> </td><td align="left" valign="top">Software rendering. +</td></tr> +<tr><td align="left" valign="top">• <a href="Rendering.html#Rendering" accesskey="7">Rendering</a>:</td><td> </td><td align="left" valign="top">Hardware accelerated rendering. +</td></tr> +<tr><td align="left" valign="top">• <a href="Images.html#Images" accesskey="8">Images</a>:</td><td> </td><td align="left" valign="top">Loading and saving images. +</td></tr> +<tr><td align="left" valign="top">• <a href="Sound.html#Sound" accesskey="9">Sound</a>:</td><td> </td><td align="left" valign="top">Sound effects and music. +</td></tr> +<tr><td align="left" valign="top">• <a href="Fonts.html#Fonts">Fonts</a>:</td><td> </td><td align="left" valign="top">Truetype and bitmap font rendering. +</td></tr> +</table> + + + + +</body> +</html> diff --git a/manuals/guile-sdl2/Basics.html b/manuals/guile-sdl2/Basics.html new file mode 100644 index 0000000..60bd97c --- /dev/null +++ b/manuals/guile-sdl2/Basics.html @@ -0,0 +1,136 @@ +<!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>Basics (Guile-SDL2)</title> + +<meta name="description" content="Basics (Guile-SDL2)"> +<meta name="keywords" content="Basics (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="API-Reference.html#API-Reference" rel="up" title="API Reference"> +<link href="Window-Management.html#Window-Management" rel="next" title="Window Management"> +<link href="API-Reference.html#API-Reference" rel="prev" title="API Reference"> +<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="Basics"></a> +<div class="header"> +<p> +Next: <a href="Window-Management.html#Window-Management" accesskey="n" rel="next">Window Management</a>, Up: <a href="API-Reference.html#API-Reference" accesskey="u" rel="up">API Reference</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="Basics-1"></a> +<h3 class="section">3.1 Basics</h3> + +<div class="example"> +<pre class="example">(use-modules (sdl2)) +</pre></div> + +<dl> +<dt><a name="index-sdl_002dinit"></a>Procedure: <strong>sdl-init</strong> <em>[<var>subsystems</var>]</em></dt> +<dd><p>Initialize the SDL library. This must be called before using any +other SDL procedure. +</p> +<p><var>subsystems</var> is an optional list of symbols that specifies the +subsystems to initialize. All subsystems are initialized by default. +The possible flags are <code>timer</code>, <code>audio</code>, <code>video</code>, +<code>haptic</code>, <code>game-controller</code>, and <code>events</code>. +</p></dd></dl> + +<dl> +<dt><a name="index-sdl_002dquit"></a>Procedure: <strong>sdl-quit</strong></dt> +<dd><p>Quit all activated SDL subsystems. This procedure should be called +upon all exit conditions. +</p></dd></dl> + +<dl> +<dt><a name="index-sdl_002dversion"></a>Procedure: <strong>sdl-version</strong></dt> +<dd><p>Return a three element list containing the major, minor, and patch +version of the linked SDL library. +</p></dd></dl> + +<dl> +<dt><a name="index-sdl_002dticks"></a>Procedure: <strong>sdl-ticks</strong></dt> +<dd><p>Return the number of milliseconds since the SDL library was +initialized. +</p></dd></dl> + + + + +</body> +</html> diff --git a/manuals/guile-sdl2/Chat.html b/manuals/guile-sdl2/Chat.html new file mode 100644 index 0000000..1bd0642 --- /dev/null +++ b/manuals/guile-sdl2/Chat.html @@ -0,0 +1,107 @@ +<!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>Chat (Guile-SDL2)</title> + +<meta name="description" content="Chat (Guile-SDL2)"> +<meta name="keywords" content="Chat (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="Contributing.html#Contributing" rel="up" title="Contributing"> +<link href="Copying-This-Manual.html#Copying-This-Manual" rel="next" title="Copying This Manual"> +<link href="Submitting-Patches.html#Submitting-Patches" rel="prev" title="Submitting Patches"> +<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="Chat"></a> +<div class="header"> +<p> +Previous: <a href="Submitting-Patches.html#Submitting-Patches" accesskey="p" rel="prev">Submitting Patches</a>, Up: <a href="Contributing.html#Contributing" accesskey="u" rel="up">Contributing</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="Chat-1"></a> +<h3 class="section">4.3 Chat</h3> + +<p>The maintainer of this library hangs out in the <code>#guile</code> channel +on <a href="irc.freenode.net">irc.freenode.net</a>, so help and general discussion may be found +there. +</p> + + + +</body> +</html> diff --git a/manuals/guile-sdl2/Contributing.html b/manuals/guile-sdl2/Contributing.html new file mode 100644 index 0000000..0159bd0 --- /dev/null +++ b/manuals/guile-sdl2/Contributing.html @@ -0,0 +1,112 @@ +<!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>Contributing (Guile-SDL2)</title> + +<meta name="description" content="Contributing (Guile-SDL2)"> +<meta name="keywords" content="Contributing (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="index.html#Top" rel="up" title="Top"> +<link href="Getting-the-Source.html#Getting-the-Source" rel="next" title="Getting the Source"> +<link href="Fonts.html#Fonts" rel="prev" title="Fonts"> +<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="Contributing"></a> +<div class="header"> +<p> +Next: <a href="Copying-This-Manual.html#Copying-This-Manual" accesskey="n" rel="next">Copying This Manual</a>, Previous: <a href="API-Reference.html#API-Reference" accesskey="p" rel="prev">API Reference</a>, Up: <a href="index.html#Top" accesskey="u" rel="up">Top</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="Contributing-1"></a> +<h2 class="chapter">4 Contributing</h2> + +<table class="menu" border="0" cellspacing="0"> +<tr><td align="left" valign="top">• <a href="Getting-the-Source.html#Getting-the-Source" accesskey="1">Getting the Source</a>:</td><td> </td><td align="left" valign="top">Getting good with Git. +</td></tr> +<tr><td align="left" valign="top">• <a href="Submitting-Patches.html#Submitting-Patches" accesskey="2">Submitting Patches</a>:</td><td> </td><td align="left" valign="top">Patches welcome! +</td></tr> +<tr><td align="left" valign="top">• <a href="Chat.html#Chat" accesskey="3">Chat</a>:</td><td> </td><td align="left" valign="top">Let’s talk! +</td></tr> +</table> + + + + +</body> +</html> diff --git a/manuals/guile-sdl2/Copying-This-Manual.html b/manuals/guile-sdl2/Copying-This-Manual.html new file mode 100644 index 0000000..575df18 --- /dev/null +++ b/manuals/guile-sdl2/Copying-This-Manual.html @@ -0,0 +1,108 @@ +<!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>Copying This Manual (Guile-SDL2)</title> + +<meta name="description" content="Copying This Manual (Guile-SDL2)"> +<meta name="keywords" content="Copying This Manual (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="index.html#Top" rel="up" title="Top"> +<link href="GNU-Free-Documentation-License.html#GNU-Free-Documentation-License" rel="next" title="GNU Free Documentation License"> +<link href="Chat.html#Chat" rel="prev" title="Chat"> +<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="Copying-This-Manual"></a> +<div class="header"> +<p> +Next: <a href="Index.html#Index" accesskey="n" rel="next">Index</a>, Previous: <a href="Contributing.html#Contributing" accesskey="p" rel="prev">Contributing</a>, Up: <a href="index.html#Top" accesskey="u" rel="up">Top</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="Copying-This-Manual-1"></a> +<h2 class="appendix">Appendix A Copying This Manual</h2> + +<table class="menu" border="0" cellspacing="0"> +<tr><td align="left" valign="top">• <a href="GNU-Free-Documentation-License.html#GNU-Free-Documentation-License" accesskey="1">GNU Free Documentation License</a>:</td><td> </td><td align="left" valign="top">License for copying this manual. +</td></tr> +</table> + + + + +</body> +</html> diff --git a/manuals/guile-sdl2/Events.html b/manuals/guile-sdl2/Events.html new file mode 100644 index 0000000..54b7f34 --- /dev/null +++ b/manuals/guile-sdl2/Events.html @@ -0,0 +1,581 @@ +<!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>Events (Guile-SDL2)</title> + +<meta name="description" content="Events (Guile-SDL2)"> +<meta name="keywords" content="Events (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="API-Reference.html#API-Reference" rel="up" title="API Reference"> +<link href="Rects.html#Rects" rel="next" title="Rects"> +<link href="Game-Controllers.html#Game-Controllers" rel="prev" title="Game Controllers"> +<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="Events"></a> +<div class="header"> +<p> +Next: <a href="Rects.html#Rects" accesskey="n" rel="next">Rects</a>, Previous: <a href="Input.html#Input" accesskey="p" rel="prev">Input</a>, Up: <a href="API-Reference.html#API-Reference" accesskey="u" rel="up">API Reference</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="Events-1"></a> +<h3 class="section">3.4 Events</h3> + +<div class="example"> +<pre class="example">(use-modules (sdl2 events)) +</pre></div> + +<dl> +<dt><a name="index-make_002dquit_002devent"></a>Procedure: <strong>make-quit-event</strong> <em>timestamp</em></dt> +</dl> + +<dl> +<dt><a name="index-quit_002devent_003f"></a>Procedure: <strong>quit-event?</strong> <em>e</em></dt> +<dd><p>Return <code>#t</code> if <var>e</var> is a quit event. +</p></dd></dl> + +<dl> +<dt><a name="index-quit_002devent_002dtimestamp"></a>Procedure: <strong>quit-event-timestamp</strong> <em>e</em></dt> +</dl> + +<dl> +<dt><a name="index-make_002dwindow_002devent"></a>Procedure: <strong>make-window-event</strong> <em>timestamp window-id type vector</em></dt> +</dl> + +<dl> +<dt><a name="index-window_002devent_003f"></a>Procedure: <strong>window-event?</strong> <em>e</em></dt> +<dd><p>Return <code>#t</code> if <var>e</var> is a window event. +</p></dd></dl> + +<dl> +<dt><a name="index-window_002dshown_002devent_003f"></a>Procedure: <strong>window-shown-event?</strong> <em>e</em></dt> +<dd><p>Return <code>#t</code> if <var>e</var> is a window shown event. +</p></dd></dl> + +<dl> +<dt><a name="index-window_002dhidden_002devent_003f"></a>Procedure: <strong>window-hidden-event?</strong> <em>e</em></dt> +<dd><p>Return <code>#t</code> if <var>e</var> is a window hidden event. +</p></dd></dl> + +<dl> +<dt><a name="index-window_002dexposed_002devent_003f"></a>Procedure: <strong>window-exposed-event?</strong> <em>e</em></dt> +<dd><p>Return <code>#t</code> if <var>e</var> is a window exposed event. +</p></dd></dl> + +<dl> +<dt><a name="index-window_002dmoved_002devent_003f"></a>Procedure: <strong>window-moved-event?</strong> <em>e</em></dt> +<dd><p>Return <code>#t</code> if <var>e</var> is a window moved event. +</p></dd></dl> + +<dl> +<dt><a name="index-window_002dresized_002devent_003f"></a>Procedure: <strong>window-resized-event?</strong> <em>e</em></dt> +<dd><p>Return <code>#t</code> if <var>e</var> is a window resized event. +</p></dd></dl> + +<dl> +<dt><a name="index-window_002dsize_002dchanged_002devent_003f"></a>Procedure: <strong>window-size-changed-event?</strong> <em>e</em></dt> +<dd><p>Return <code>#t</code> if <var>e</var> is a window size changed event. +</p></dd></dl> + +<dl> +<dt><a name="index-window_002dminimized_002devent_003f"></a>Procedure: <strong>window-minimized-event?</strong> <em>e</em></dt> +<dd><p>Return <code>#t</code> if <var>e</var> is a window minimized event. +</p></dd></dl> + +<dl> +<dt><a name="index-window_002dmaximized_002devent_003f"></a>Procedure: <strong>window-maximized-event?</strong> <em>e</em></dt> +<dd><p>Return <code>#t</code> if <var>e</var> is a window maximized event. +</p></dd></dl> + +<dl> +<dt><a name="index-window_002drestored_002devent_003f"></a>Procedure: <strong>window-restored-event?</strong> <em>e</em></dt> +<dd><p>Return <code>#t</code> if <var>e</var> is a window restored event. +</p></dd></dl> + +<dl> +<dt><a name="index-window_002denter_002devent_003f"></a>Procedure: <strong>window-enter-event?</strong> <em>e</em></dt> +<dd><p>Return <code>#t</code> if <var>e</var> is a window enter event. +</p></dd></dl> + +<dl> +<dt><a name="index-window_002dleave_002devent_003f"></a>Procedure: <strong>window-leave-event?</strong> <em>e</em></dt> +<dd><p>Return <code>#t</code> if <var>e</var> is a window leave event. +</p></dd></dl> + +<dl> +<dt><a name="index-window_002dfocus_002dgained_002devent_003f"></a>Procedure: <strong>window-focus-gained-event?</strong> <em>e</em></dt> +<dd><p>Return <code>#t</code> if <var>e</var> is a window focus gained event. +</p></dd></dl> + +<dl> +<dt><a name="index-window_002dfocus_002dlost_002devent_003f"></a>Procedure: <strong>window-focus-lost-event?</strong> <em>e</em></dt> +<dd><p>Return <code>#t</code> if <var>e</var> is a window focus lost event. +</p></dd></dl> + +<dl> +<dt><a name="index-window_002dclosed_002devent_003f"></a>Procedure: <strong>window-closed-event?</strong> <em>e</em></dt> +<dd><p>Return <code>#t</code> if <var>e</var> is a window closed event. +</p></dd></dl> + +<dl> +<dt><a name="index-window_002devent_002dtimestamp"></a>Procedure: <strong>window-event-timestamp</strong> <em>e</em></dt> +</dl> + +<dl> +<dt><a name="index-window_002devent_002dwindow_002did"></a>Procedure: <strong>window-event-window-id</strong> <em>e</em></dt> +</dl> + +<dl> +<dt><a name="index-window_002devent_002dtype"></a>Procedure: <strong>window-event-type</strong> <em>e</em></dt> +</dl> + +<dl> +<dt><a name="index-window_002devent_002dvector"></a>Procedure: <strong>window-event-vector</strong> <em>e</em></dt> +</dl> + +<dl> +<dt><a name="index-make_002dkeyboard_002devent"></a>Procedure: <strong>make-keyboard-event</strong> <em>timestamp window-id pressed? repeat? key scancode modifiers</em></dt> +</dl> + +<dl> +<dt><a name="index-keyboard_002devent_003f"></a>Procedure: <strong>keyboard-event?</strong> <em>e</em></dt> +<dd><p>Return <code>#t</code> if <var>e</var> is a keyboard event. +</p></dd></dl> + +<dl> +<dt><a name="index-keyboard_002ddown_002devent_003f"></a>Procedure: <strong>keyboard-down-event?</strong> <em>e</em></dt> +<dd><p>Return <code>#t</code> if <var>e</var> is a key press event. +</p></dd></dl> + +<dl> +<dt><a name="index-keyboard_002dup_002devent_003f"></a>Procedure: <strong>keyboard-up-event?</strong> <em>e</em></dt> +<dd><p>Return <code>#t</code> if <var>e</var> is a key release event. +</p></dd></dl> + +<dl> +<dt><a name="index-keyboard_002devent_002dtimestamp"></a>Procedure: <strong>keyboard-event-timestamp</strong> <em>e</em></dt> +</dl> + +<dl> +<dt><a name="index-keyboard_002devent_002dwindow_002did"></a>Procedure: <strong>keyboard-event-window-id</strong> <em>e</em></dt> +</dl> + +<dl> +<dt><a name="index-keyboard_002devent_002dpressed_003f"></a>Procedure: <strong>keyboard-event-pressed?</strong> <em>e</em></dt> +</dl> + +<dl> +<dt><a name="index-keyboard_002devent_002drepeat_003f"></a>Procedure: <strong>keyboard-event-repeat?</strong> <em>e</em></dt> +</dl> + +<dl> +<dt><a name="index-keyboard_002devent_002dkey"></a>Procedure: <strong>keyboard-event-key</strong> <em>e</em></dt> +</dl> + +<dl> +<dt><a name="index-keyboard_002devent_002dscancode"></a>Procedure: <strong>keyboard-event-scancode</strong> <em>e</em></dt> +</dl> + +<dl> +<dt><a name="index-keyboard_002devent_002dmodifiers"></a>Procedure: <strong>keyboard-event-modifiers</strong> <em>e</em></dt> +</dl> + +<dl> +<dt><a name="index-make_002dtext_002dinput_002devent"></a>Procedure: <strong>make-text-input-event</strong> <em>timestamp window-id text</em></dt> +</dl> + +<dl> +<dt><a name="index-text_002dinput_002devent_003f"></a>Procedure: <strong>text-input-event?</strong> <em>e</em></dt> +<dd><p>Return <code>#t</code> if <var>e</var> is a text input event. +</p></dd></dl> + +<dl> +<dt><a name="index-text_002dinput_002devent_002dtimestamp"></a>Procedure: <strong>text-input-event-timestamp</strong> <em>e</em></dt> +</dl> + +<dl> +<dt><a name="index-text_002dinput_002devent_002dwindow_002did"></a>Procedure: <strong>text-input-event-window-id</strong> <em>e</em></dt> +</dl> + +<dl> +<dt><a name="index-text_002dinput_002devent_002dtext"></a>Procedure: <strong>text-input-event-text</strong> <em>e</em></dt> +</dl> + +<dl> +<dt><a name="index-make_002dmouse_002dbutton_002devent"></a>Procedure: <strong>make-mouse-button-event</strong> <em>timestamp window-id which button pressed? clicks x y</em></dt> +</dl> + +<dl> +<dt><a name="index-mouse_002dbutton_002devent_003f"></a>Procedure: <strong>mouse-button-event?</strong> <em>e</em></dt> +<dd><p>Return <code>#t</code> if <var>e</var> is a mouse button event. +</p></dd></dl> + +<dl> +<dt><a name="index-mouse_002dbutton_002ddown_002devent_003f"></a>Procedure: <strong>mouse-button-down-event?</strong> <em>e</em></dt> +<dd><p>Return <code>#t</code> if <var>e</var> is a mouse button down event. +</p></dd></dl> + +<dl> +<dt><a name="index-mouse_002dbutton_002dup_002devent_003f"></a>Procedure: <strong>mouse-button-up-event?</strong> <em>e</em></dt> +<dd><p>Return <code>#t</code> if <var>e</var> is a mouse button up event. +</p></dd></dl> + +<dl> +<dt><a name="index-mouse_002dbutton_002devent_002dtimestamp"></a>Procedure: <strong>mouse-button-event-timestamp</strong> <em>e</em></dt> +</dl> + +<dl> +<dt><a name="index-mouse_002dbutton_002devent_002dwindow_002did"></a>Procedure: <strong>mouse-button-event-window-id</strong> <em>e</em></dt> +</dl> + +<dl> +<dt><a name="index-mouse_002dbutton_002devent_002dwhich"></a>Procedure: <strong>mouse-button-event-which</strong> <em>e</em></dt> +</dl> + +<dl> +<dt><a name="index-mouse_002dbutton_002devent_002dbutton"></a>Procedure: <strong>mouse-button-event-button</strong> <em>e</em></dt> +</dl> + +<dl> +<dt><a name="index-mouse_002dbutton_002devent_002dpressed_003f"></a>Procedure: <strong>mouse-button-event-pressed?</strong> <em>e</em></dt> +</dl> + +<dl> +<dt><a name="index-mouse_002dbutton_002devent_002dclicks"></a>Procedure: <strong>mouse-button-event-clicks</strong> <em>e</em></dt> +</dl> + +<dl> +<dt><a name="index-mouse_002dbutton_002devent_002dx"></a>Procedure: <strong>mouse-button-event-x</strong> <em>e</em></dt> +</dl> + +<dl> +<dt><a name="index-mouse_002dbutton_002devent_002dy"></a>Procedure: <strong>mouse-button-event-y</strong> <em>e</em></dt> +</dl> + +<dl> +<dt><a name="index-make_002dmouse_002dmotion_002devent"></a>Procedure: <strong>make-mouse-motion-event</strong> <em>timestamp window-id which buttons x y x-rel y-rel</em></dt> +</dl> + +<dl> +<dt><a name="index-mouse_002dmotion_002devent_003f"></a>Procedure: <strong>mouse-motion-event?</strong> <em>e</em></dt> +<dd><p>Return <code>#t</code> if <var>e</var> is a mouse motion event. +</p></dd></dl> + +<dl> +<dt><a name="index-mouse_002dmotion_002devent_002dtimestamp"></a>Procedure: <strong>mouse-motion-event-timestamp</strong> <em>e</em></dt> +</dl> + +<dl> +<dt><a name="index-mouse_002dmotion_002devent_002dwindow_002did"></a>Procedure: <strong>mouse-motion-event-window-id</strong> <em>e</em></dt> +</dl> + +<dl> +<dt><a name="index-mouse_002dmotion_002devent_002dwhich"></a>Procedure: <strong>mouse-motion-event-which</strong> <em>e</em></dt> +</dl> + +<dl> +<dt><a name="index-mouse_002dmotion_002devent_002dbuttons"></a>Procedure: <strong>mouse-motion-event-buttons</strong> <em>e</em></dt> +</dl> + +<dl> +<dt><a name="index-mouse_002dmotion_002devent_002dx"></a>Procedure: <strong>mouse-motion-event-x</strong> <em>e</em></dt> +</dl> + +<dl> +<dt><a name="index-mouse_002dmotion_002devent_002dy"></a>Procedure: <strong>mouse-motion-event-y</strong> <em>e</em></dt> +</dl> + +<dl> +<dt><a name="index-mouse_002dmotion_002devent_002dx_002drel"></a>Procedure: <strong>mouse-motion-event-x-rel</strong> <em>e</em></dt> +</dl> + +<dl> +<dt><a name="index-mouse_002dmotion_002devent_002dy_002drel"></a>Procedure: <strong>mouse-motion-event-y-rel</strong> <em>e</em></dt> +</dl> + +<dl> +<dt><a name="index-make_002djoystick_002daxis_002devent"></a>Procedure: <strong>make-joystick-axis-event</strong> <em>timestamp which axis value</em></dt> +</dl> + +<dl> +<dt><a name="index-joystick_002daxis_002devent_003f"></a>Procedure: <strong>joystick-axis-event?</strong> <em>e</em></dt> +<dd><p>Return <code>#t</code> if <var>e</var> is a joystick axis event. +</p></dd></dl> + +<dl> +<dt><a name="index-joystick_002daxis_002devent_002dtimestamp"></a>Procedure: <strong>joystick-axis-event-timestamp</strong> <em>e</em></dt> +</dl> + +<dl> +<dt><a name="index-joystick_002daxis_002devent_002dwhich"></a>Procedure: <strong>joystick-axis-event-which</strong> <em>e</em></dt> +</dl> + +<dl> +<dt><a name="index-joystick_002daxis_002devent_002dbutton"></a>Procedure: <strong>joystick-axis-event-button</strong> <em>e</em></dt> +</dl> + +<dl> +<dt><a name="index-joystick_002daxis_002devent_002dpressed_003f"></a>Procedure: <strong>joystick-axis-event-pressed?</strong> <em>e</em></dt> +</dl> + +<dl> +<dt><a name="index-make_002djoystick_002dball_002devent"></a>Procedure: <strong>make-joystick-ball-event</strong> <em>timestamp which ball x-rel y-rel</em></dt> +</dl> + +<dl> +<dt><a name="index-joystick_002dball_002devent_003f"></a>Procedure: <strong>joystick-ball-event?</strong> <em>e</em></dt> +<dd><p>Return <code>#t</code> if <var>e</var> is a joystick ball event. +</p></dd></dl> + +<dl> +<dt><a name="index-joystick_002dball_002devent_002dtimestamp"></a>Procedure: <strong>joystick-ball-event-timestamp</strong> <em>e</em></dt> +</dl> + +<dl> +<dt><a name="index-joystick_002dball_002devent_002dwhich"></a>Procedure: <strong>joystick-ball-event-which</strong> <em>e</em></dt> +</dl> + +<dl> +<dt><a name="index-joystick_002dball_002devent_002dball"></a>Procedure: <strong>joystick-ball-event-ball</strong> <em>e</em></dt> +</dl> + +<dl> +<dt><a name="index-joystick_002dball_002devent_002dx_002drel"></a>Procedure: <strong>joystick-ball-event-x-rel</strong> <em>e</em></dt> +</dl> + +<dl> +<dt><a name="index-joystick_002dball_002devent_002dy_002drel"></a>Procedure: <strong>joystick-ball-event-y-rel</strong> <em>e</em></dt> +</dl> + +<dl> +<dt><a name="index-make_002djoystick_002dhat_002devent"></a>Procedure: <strong>make-joystick-hat-event</strong> <em>timestamp which hat value</em></dt> +</dl> + +<dl> +<dt><a name="index-joystick_002dhat_002devent_003f"></a>Procedure: <strong>joystick-hat-event?</strong> <em>e</em></dt> +<dd><p>Return <code>#t</code> if <var>e</var> is a joystick hat event. +</p></dd></dl> + +<dl> +<dt><a name="index-joystick_002dhat_002devent_002dtimestamp"></a>Procedure: <strong>joystick-hat-event-timestamp</strong> <em>e</em></dt> +</dl> + +<dl> +<dt><a name="index-joystick_002dhat_002devent_002dwhich"></a>Procedure: <strong>joystick-hat-event-which</strong> <em>e</em></dt> +</dl> + +<dl> +<dt><a name="index-joystick_002dhat_002devent_002dhat"></a>Procedure: <strong>joystick-hat-event-hat</strong> <em>e</em></dt> +</dl> + +<dl> +<dt><a name="index-joystick_002dhat_002devent_002dvalue"></a>Procedure: <strong>joystick-hat-event-value</strong> <em>e</em></dt> +</dl> + +<dl> +<dt><a name="index-make_002djoystick_002ddevice_002devent"></a>Procedure: <strong>make-joystick-device-event</strong> <em>timestamp which action</em></dt> +</dl> + +<dl> +<dt><a name="index-joystick_002ddevice_002devent_003f"></a>Procedure: <strong>joystick-device-event?</strong> <em>e</em></dt> +<dd><p>Return <code>#t</code> if <var>e</var> is a joystick device event. +</p></dd></dl> + +<dl> +<dt><a name="index-joystick_002ddevice_002devent_002dtimestamp"></a>Procedure: <strong>joystick-device-event-timestamp</strong> <em>e</em></dt> +</dl> + +<dl> +<dt><a name="index-joystick_002ddevice_002devent_002dwhich"></a>Procedure: <strong>joystick-device-event-which</strong> <em>e</em></dt> +</dl> + +<dl> +<dt><a name="index-joystick_002ddevice_002devent_002daction"></a>Procedure: <strong>joystick-device-event-action</strong> <em>e</em></dt> +</dl> + +<dl> +<dt><a name="index-make_002dcontroller_002daxis_002devent"></a>Procedure: <strong>make-controller-axis-event</strong> <em>timestamp which axis value</em></dt> +</dl> + +<dl> +<dt><a name="index-controller_002daxis_002devent_003f"></a>Procedure: <strong>controller-axis-event?</strong> <em>e</em></dt> +<dd><p>Return <code>#t</code> if <var>e</var> is a game controller axis event. +</p></dd></dl> + +<dl> +<dt><a name="index-controller_002daxis_002devent_002dtimestamp"></a>Procedure: <strong>controller-axis-event-timestamp</strong> <em>e</em></dt> +</dl> + +<dl> +<dt><a name="index-controller_002daxis_002devent_002dwhich"></a>Procedure: <strong>controller-axis-event-which</strong> <em>e</em></dt> +</dl> + +<dl> +<dt><a name="index-controller_002daxis_002devent_002daxis"></a>Procedure: <strong>controller-axis-event-axis</strong> <em>e</em></dt> +</dl> + +<dl> +<dt><a name="index-controller_002daxis_002devent_002dvalue"></a>Procedure: <strong>controller-axis-event-value</strong> <em>e</em></dt> +</dl> + +<dl> +<dt><a name="index-make_002dcontroller_002dbutton_002devent"></a>Procedure: <strong>make-controller-button-event</strong> <em>timestamp which button pressed?</em></dt> +</dl> + +<dl> +<dt><a name="index-controller_002dbutton_002devent_003f"></a>Procedure: <strong>controller-button-event?</strong> <em>e</em></dt> +<dd><p>Return <code>#t</code> if <var>event</var> is a game controller button event. +</p></dd></dl> + +<dl> +<dt><a name="index-controller_002dbutton_002ddown_002devent_003f"></a>Procedure: <strong>controller-button-down-event?</strong> <em>e</em></dt> +</dl> + +<dl> +<dt><a name="index-controller_002dbutton_002dup_002devent_003f"></a>Procedure: <strong>controller-button-up-event?</strong> <em>e</em></dt> +</dl> + +<dl> +<dt><a name="index-controller_002dbutton_002devent_002dtimestamp"></a>Procedure: <strong>controller-button-event-timestamp</strong> <em>e</em></dt> +</dl> + +<dl> +<dt><a name="index-controller_002dbutton_002devent_002dwhich"></a>Procedure: <strong>controller-button-event-which</strong> <em>e</em></dt> +</dl> + +<dl> +<dt><a name="index-controller_002dbutton_002devent_002dbutton"></a>Procedure: <strong>controller-button-event-button</strong> <em>e</em></dt> +</dl> + +<dl> +<dt><a name="index-controller_002dbutton_002devent_002dpressed_003f"></a>Procedure: <strong>controller-button-event-pressed?</strong> <em>e</em></dt> +</dl> + +<dl> +<dt><a name="index-make_002dcontroller_002ddevice_002devent"></a>Procedure: <strong>make-controller-device-event</strong> <em>timestamp which action</em></dt> +</dl> + +<dl> +<dt><a name="index-controller_002ddevice_002devent_003f"></a>Procedure: <strong>controller-device-event?</strong> <em>e</em></dt> +<dd><p>Return <code>#t</code> if <var>event</var> is a game controller device event. +</p></dd></dl> + +<dl> +<dt><a name="index-controller_002dadded_002devent_003f"></a>Procedure: <strong>controller-added-event?</strong> <em>e</em></dt> +<dd><p>Return <code>#t</code> if <var>event</var> is a game controller device event with the +’added’ action. +</p></dd></dl> + +<dl> +<dt><a name="index-controller_002dremoved_002devent_003f"></a>Procedure: <strong>controller-removed-event?</strong> <em>e</em></dt> +<dd><p>Return <code>#t</code> if <var>event</var> is a game controller device event with the +’removed’ action. +</p></dd></dl> + +<dl> +<dt><a name="index-controller_002dremapped_002devent_003f"></a>Procedure: <strong>controller-remapped-event?</strong> <em>e</em></dt> +<dd><p>Return <code>#t</code> if <var>event</var> is a game controller device event with the +’remapped’ action. +</p></dd></dl> + +<dl> +<dt><a name="index-controller_002ddevice_002devent_002dtimestamp"></a>Procedure: <strong>controller-device-event-timestamp</strong> <em>e</em></dt> +</dl> + +<dl> +<dt><a name="index-controller_002ddevice_002devent_002dwhich"></a>Procedure: <strong>controller-device-event-which</strong> <em>e</em></dt> +</dl> + +<dl> +<dt><a name="index-controller_002ddevice_002devent_002daction"></a>Procedure: <strong>controller-device-event-action</strong> <em>e</em></dt> +</dl> + +<dl> +<dt><a name="index-poll_002devent"></a>Procedure: <strong>poll-event</strong></dt> +</dl> + +<hr> +<div class="header"> +<p> +Next: <a href="Rects.html#Rects" accesskey="n" rel="next">Rects</a>, Previous: <a href="Input.html#Input" accesskey="p" rel="prev">Input</a>, Up: <a href="API-Reference.html#API-Reference" accesskey="u" rel="up">API Reference</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> diff --git a/manuals/guile-sdl2/Fonts.html b/manuals/guile-sdl2/Fonts.html new file mode 100644 index 0000000..ed15bc1 --- /dev/null +++ b/manuals/guile-sdl2/Fonts.html @@ -0,0 +1,146 @@ +<!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>Fonts (Guile-SDL2)</title> + +<meta name="description" content="Fonts (Guile-SDL2)"> +<meta name="keywords" content="Fonts (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="API-Reference.html#API-Reference" rel="up" title="API Reference"> +<link href="Contributing.html#Contributing" rel="next" title="Contributing"> +<link href="Sound.html#Sound" rel="prev" title="Sound"> +<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="Fonts"></a> +<div class="header"> +<p> +Previous: <a href="Sound.html#Sound" accesskey="p" rel="prev">Sound</a>, Up: <a href="API-Reference.html#API-Reference" accesskey="u" rel="up">API Reference</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="Fonts-1"></a> +<h3 class="section">3.10 Fonts</h3> + +<div class="example"> +<pre class="example">(use-modules (sdl2 ttf)) +</pre></div> + +<dl> +<dt><a name="index-ttf_002dinit"></a>Procedure: <strong>ttf-init</strong></dt> +<dd><p>Initialize the TTF system. +</p></dd></dl> + +<dl> +<dt><a name="index-ttf_002dquit"></a>Procedure: <strong>ttf-quit</strong></dt> +<dd><p>Shut down and clean up the TTF system. +</p></dd></dl> + +<dl> +<dt><a name="index-load_002dfont"></a>Procedure: <strong>load-font</strong> <em>file point-size</em></dt> +<dd><p>Load TTF font from <var>file</var> and return a new font object whose glyph size is +<var>point-size</var>. +</p></dd></dl> + +<dl> +<dt><a name="index-delete_002dfont_0021"></a>Procedure: <strong>delete-font!</strong> <em>font</em></dt> +<dd><p>Delete the memory allocated for <var>font</var>. +</p></dd></dl> + +<dl> +<dt><a name="index-font_002dheight"></a>Procedure: <strong>font-height</strong> <em>font</em></dt> +<dd><p>Return the maximum height of <var>font</var>. +</p></dd></dl> + +<dl> +<dt><a name="index-render_002dfont_002dsolid"></a>Procedure: <strong>render-font-solid</strong> <em>font text color</em></dt> +<dd><p>Render <var>text</var>, a UTF-8 encoded string, using <var>font</var> and <var>color</var>, the +foreground color, and return a surface containing the results. +</p></dd></dl> + +<dl> +<dt><a name="index-render_002dfont_002dblended"></a>Procedure: <strong>render-font-blended</strong> <em>font text color</em></dt> +<dd><p>Render <var>text</var>, a UTF-8 encoded string, using <var>font</var> and <var>color</var>, the +foreground color, and return a high-quality alpha-blended surface containing the +results. +</p></dd></dl> + + + + +</body> +</html> diff --git a/manuals/guile-sdl2/GNU-Free-Documentation-License.html b/manuals/guile-sdl2/GNU-Free-Documentation-License.html new file mode 100644 index 0000000..7c1ea44 --- /dev/null +++ b/manuals/guile-sdl2/GNU-Free-Documentation-License.html @@ -0,0 +1,576 @@ +<!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>GNU Free Documentation License (Guile-SDL2)</title> + +<meta name="description" content="GNU Free Documentation License (Guile-SDL2)"> +<meta name="keywords" content="GNU Free Documentation License (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="Copying-This-Manual.html#Copying-This-Manual" rel="up" title="Copying This Manual"> +<link href="Index.html#Index" rel="next" title="Index"> +<link href="Copying-This-Manual.html#Copying-This-Manual" rel="prev" title="Copying This Manual"> +<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="GNU-Free-Documentation-License"></a> +<div class="header"> +<p> +Up: <a href="Copying-This-Manual.html#Copying-This-Manual" accesskey="u" rel="up">Copying This Manual</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="GNU-Free-Documentation-License-1"></a> +<h3 class="section">A.1 GNU Free Documentation License</h3> +<div align="center">Version 1.3, 3 November 2008 +</div> + +<div class="display"> +<pre class="display">Copyright © 2000, 2001, 2002, 2007, 2008 Free Software Foundation, Inc. +<a href="http://fsf.org/">http://fsf.org/</a> + +Everyone is permitted to copy and distribute verbatim copies +of this license document, but changing it is not allowed. +</pre></div> + +<ol start="0"> +<li> PREAMBLE + +<p>The purpose of this License is to make a manual, textbook, or other +functional and useful document <em>free</em> in the sense of freedom: to +assure everyone the effective freedom to copy and redistribute it, +with or without modifying it, either commercially or noncommercially. +Secondarily, this License preserves for the author and publisher a way +to get credit for their work, while not being considered responsible +for modifications made by others. +</p> +<p>This License is a kind of “copyleft”, which means that derivative +works of the document must themselves be free in the same sense. It +complements the GNU General Public License, which is a copyleft +license designed for free software. +</p> +<p>We have designed this License in order to use it for manuals for free +software, because free software needs free documentation: a free +program should come with manuals providing the same freedoms that the +software does. But this License is not limited to software manuals; +it can be used for any textual work, regardless of subject matter or +whether it is published as a printed book. We recommend this License +principally for works whose purpose is instruction or reference. +</p> +</li><li> APPLICABILITY AND DEFINITIONS + +<p>This License applies to any manual or other work, in any medium, that +contains a notice placed by the copyright holder saying it can be +distributed under the terms of this License. Such a notice grants a +world-wide, royalty-free license, unlimited in duration, to use that +work under the conditions stated herein. The “Document”, below, +refers to any such manual or work. Any member of the public is a +licensee, and is addressed as “you”. You accept the license if you +copy, modify or distribute the work in a way requiring permission +under copyright law. +</p> +<p>A “Modified Version” of the Document means any work containing the +Document or a portion of it, either copied verbatim, or with +modifications and/or translated into another language. +</p> +<p>A “Secondary Section” is a named appendix or a front-matter section +of the Document that deals exclusively with the relationship of the +publishers or authors of the Document to the Document’s overall +subject (or to related matters) and contains nothing that could fall +directly within that overall subject. (Thus, if the Document is in +part a textbook of mathematics, a Secondary Section may not explain +any mathematics.) The relationship could be a matter of historical +connection with the subject or with related matters, or of legal, +commercial, philosophical, ethical or political position regarding +them. +</p> +<p>The “Invariant Sections” are certain Secondary Sections whose titles +are designated, as being those of Invariant Sections, in the notice +that says that the Document is released under this License. If a +section does not fit the above definition of Secondary then it is not +allowed to be designated as Invariant. The Document may contain zero +Invariant Sections. If the Document does not identify any Invariant +Sections then there are none. +</p> +<p>The “Cover Texts” are certain short passages of text that are listed, +as Front-Cover Texts or Back-Cover Texts, in the notice that says that +the Document is released under this License. A Front-Cover Text may +be at most 5 words, and a Back-Cover Text may be at most 25 words. +</p> +<p>A “Transparent” copy of the Document means a machine-readable copy, +represented in a format whose specification is available to the +general public, that is suitable for revising the document +straightforwardly with generic text editors or (for images composed of +pixels) generic paint programs or (for drawings) some widely available +drawing editor, and that is suitable for input to text formatters or +for automatic translation to a variety of formats suitable for input +to text formatters. A copy made in an otherwise Transparent file +format whose markup, or absence of markup, has been arranged to thwart +or discourage subsequent modification by readers is not Transparent. +An image format is not Transparent if used for any substantial amount +of text. A copy that is not “Transparent” is called “Opaque”. +</p> +<p>Examples of suitable formats for Transparent copies include plain +ASCII without markup, Texinfo input format, LaTeX input +format, SGML or XML using a publicly available +DTD, and standard-conforming simple HTML, +PostScript or PDF designed for human modification. Examples +of transparent image formats include PNG, XCF and +JPG. Opaque formats include proprietary formats that can be +read and edited only by proprietary word processors, SGML or +XML for which the DTD and/or processing tools are +not generally available, and the machine-generated HTML, +PostScript or PDF produced by some word processors for +output purposes only. +</p> +<p>The “Title Page” means, for a printed book, the title page itself, +plus such following pages as are needed to hold, legibly, the material +this License requires to appear in the title page. For works in +formats which do not have any title page as such, “Title Page” means +the text near the most prominent appearance of the work’s title, +preceding the beginning of the body of the text. +</p> +<p>The “publisher” means any person or entity that distributes copies +of the Document to the public. +</p> +<p>A section “Entitled XYZ” means a named subunit of the Document whose +title either is precisely XYZ or contains XYZ in parentheses following +text that translates XYZ in another language. (Here XYZ stands for a +specific section name mentioned below, such as “Acknowledgements”, +“Dedications”, “Endorsements”, or “History”.) To “Preserve the Title” +of such a section when you modify the Document means that it remains a +section “Entitled XYZ” according to this definition. +</p> +<p>The Document may include Warranty Disclaimers next to the notice which +states that this License applies to the Document. These Warranty +Disclaimers are considered to be included by reference in this +License, but only as regards disclaiming warranties: any other +implication that these Warranty Disclaimers may have is void and has +no effect on the meaning of this License. +</p> +</li><li> VERBATIM COPYING + +<p>You may copy and distribute the Document in any medium, either +commercially or noncommercially, provided that this License, the +copyright notices, and the license notice saying this License applies +to the Document are reproduced in all copies, and that you add no other +conditions whatsoever to those of this License. You may not use +technical measures to obstruct or control the reading or further +copying of the copies you make or distribute. However, you may accept +compensation in exchange for copies. If you distribute a large enough +number of copies you must also follow the conditions in section 3. +</p> +<p>You may also lend copies, under the same conditions stated above, and +you may publicly display copies. +</p> +</li><li> COPYING IN QUANTITY + +<p>If you publish printed copies (or copies in media that commonly have +printed covers) of the Document, numbering more than 100, and the +Document’s license notice requires Cover Texts, you must enclose the +copies in covers that carry, clearly and legibly, all these Cover +Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on +the back cover. Both covers must also clearly and legibly identify +you as the publisher of these copies. The front cover must present +the full title with all words of the title equally prominent and +visible. You may add other material on the covers in addition. +Copying with changes limited to the covers, as long as they preserve +the title of the Document and satisfy these conditions, can be treated +as verbatim copying in other respects. +</p> +<p>If the required texts for either cover are too voluminous to fit +legibly, you should put the first ones listed (as many as fit +reasonably) on the actual cover, and continue the rest onto adjacent +pages. +</p> +<p>If you publish or distribute Opaque copies of the Document numbering +more than 100, you must either include a machine-readable Transparent +copy along with each Opaque copy, or state in or with each Opaque copy +a computer-network location from which the general network-using +public has access to download using public-standard network protocols +a complete Transparent copy of the Document, free of added material. +If you use the latter option, you must take reasonably prudent steps, +when you begin distribution of Opaque copies in quantity, to ensure +that this Transparent copy will remain thus accessible at the stated +location until at least one year after the last time you distribute an +Opaque copy (directly or through your agents or retailers) of that +edition to the public. +</p> +<p>It is requested, but not required, that you contact the authors of the +Document well before redistributing any large number of copies, to give +them a chance to provide you with an updated version of the Document. +</p> +</li><li> MODIFICATIONS + +<p>You may copy and distribute a Modified Version of the Document under +the conditions of sections 2 and 3 above, provided that you release +the Modified Version under precisely this License, with the Modified +Version filling the role of the Document, thus licensing distribution +and modification of the Modified Version to whoever possesses a copy +of it. In addition, you must do these things in the Modified Version: +</p> +<ol type="A" start="1"> +<li> Use in the Title Page (and on the covers, if any) a title distinct +from that of the Document, and from those of previous versions +(which should, if there were any, be listed in the History section +of the Document). You may use the same title as a previous version +if the original publisher of that version gives permission. + +</li><li> List on the Title Page, as authors, one or more persons or entities +responsible for authorship of the modifications in the Modified +Version, together with at least five of the principal authors of the +Document (all of its principal authors, if it has fewer than five), +unless they release you from this requirement. + +</li><li> State on the Title page the name of the publisher of the +Modified Version, as the publisher. + +</li><li> Preserve all the copyright notices of the Document. + +</li><li> Add an appropriate copyright notice for your modifications +adjacent to the other copyright notices. + +</li><li> Include, immediately after the copyright notices, a license notice +giving the public permission to use the Modified Version under the +terms of this License, in the form shown in the Addendum below. + +</li><li> Preserve in that license notice the full lists of Invariant Sections +and required Cover Texts given in the Document’s license notice. + +</li><li> Include an unaltered copy of this License. + +</li><li> Preserve the section Entitled “History”, Preserve its Title, and add +to it an item stating at least the title, year, new authors, and +publisher of the Modified Version as given on the Title Page. If +there is no section Entitled “History” in the Document, create one +stating the title, year, authors, and publisher of the Document as +given on its Title Page, then add an item describing the Modified +Version as stated in the previous sentence. + +</li><li> Preserve the network location, if any, given in the Document for +public access to a Transparent copy of the Document, and likewise +the network locations given in the Document for previous versions +it was based on. These may be placed in the “History” section. +You may omit a network location for a work that was published at +least four years before the Document itself, or if the original +publisher of the version it refers to gives permission. + +</li><li> For any section Entitled “Acknowledgements” or “Dedications”, Preserve +the Title of the section, and preserve in the section all the +substance and tone of each of the contributor acknowledgements and/or +dedications given therein. + +</li><li> Preserve all the Invariant Sections of the Document, +unaltered in their text and in their titles. Section numbers +or the equivalent are not considered part of the section titles. + +</li><li> Delete any section Entitled “Endorsements”. Such a section +may not be included in the Modified Version. + +</li><li> Do not retitle any existing section to be Entitled “Endorsements” or +to conflict in title with any Invariant Section. + +</li><li> Preserve any Warranty Disclaimers. +</li></ol> + +<p>If the Modified Version includes new front-matter sections or +appendices that qualify as Secondary Sections and contain no material +copied from the Document, you may at your option designate some or all +of these sections as invariant. To do this, add their titles to the +list of Invariant Sections in the Modified Version’s license notice. +These titles must be distinct from any other section titles. +</p> +<p>You may add a section Entitled “Endorsements”, provided it contains +nothing but endorsements of your Modified Version by various +parties—for example, statements of peer review or that the text has +been approved by an organization as the authoritative definition of a +standard. +</p> +<p>You may add a passage of up to five words as a Front-Cover Text, and a +passage of up to 25 words as a Back-Cover Text, to the end of the list +of Cover Texts in the Modified Version. Only one passage of +Front-Cover Text and one of Back-Cover Text may be added by (or +through arrangements made by) any one entity. If the Document already +includes a cover text for the same cover, previously added by you or +by arrangement made by the same entity you are acting on behalf of, +you may not add another; but you may replace the old one, on explicit +permission from the previous publisher that added the old one. +</p> +<p>The author(s) and publisher(s) of the Document do not by this License +give permission to use their names for publicity for or to assert or +imply endorsement of any Modified Version. +</p> +</li><li> COMBINING DOCUMENTS + +<p>You may combine the Document with other documents released under this +License, under the terms defined in section 4 above for modified +versions, provided that you include in the combination all of the +Invariant Sections of all of the original documents, unmodified, and +list them all as Invariant Sections of your combined work in its +license notice, and that you preserve all their Warranty Disclaimers. +</p> +<p>The combined work need only contain one copy of this License, and +multiple identical Invariant Sections may be replaced with a single +copy. If there are multiple Invariant Sections with the same name but +different contents, make the title of each such section unique by +adding at the end of it, in parentheses, the name of the original +author or publisher of that section if known, or else a unique number. +Make the same adjustment to the section titles in the list of +Invariant Sections in the license notice of the combined work. +</p> +<p>In the combination, you must combine any sections Entitled “History” +in the various original documents, forming one section Entitled +“History”; likewise combine any sections Entitled “Acknowledgements”, +and any sections Entitled “Dedications”. You must delete all +sections Entitled “Endorsements.” +</p> +</li><li> COLLECTIONS OF DOCUMENTS + +<p>You may make a collection consisting of the Document and other documents +released under this License, and replace the individual copies of this +License in the various documents with a single copy that is included in +the collection, provided that you follow the rules of this License for +verbatim copying of each of the documents in all other respects. +</p> +<p>You may extract a single document from such a collection, and distribute +it individually under this License, provided you insert a copy of this +License into the extracted document, and follow this License in all +other respects regarding verbatim copying of that document. +</p> +</li><li> AGGREGATION WITH INDEPENDENT WORKS + +<p>A compilation of the Document or its derivatives with other separate +and independent documents or works, in or on a volume of a storage or +distribution medium, is called an “aggregate” if the copyright +resulting from the compilation is not used to limit the legal rights +of the compilation’s users beyond what the individual works permit. +When the Document is included in an aggregate, this License does not +apply to the other works in the aggregate which are not themselves +derivative works of the Document. +</p> +<p>If the Cover Text requirement of section 3 is applicable to these +copies of the Document, then if the Document is less than one half of +the entire aggregate, the Document’s Cover Texts may be placed on +covers that bracket the Document within the aggregate, or the +electronic equivalent of covers if the Document is in electronic form. +Otherwise they must appear on printed covers that bracket the whole +aggregate. +</p> +</li><li> TRANSLATION + +<p>Translation is considered a kind of modification, so you may +distribute translations of the Document under the terms of section 4. +Replacing Invariant Sections with translations requires special +permission from their copyright holders, but you may include +translations of some or all Invariant Sections in addition to the +original versions of these Invariant Sections. You may include a +translation of this License, and all the license notices in the +Document, and any Warranty Disclaimers, provided that you also include +the original English version of this License and the original versions +of those notices and disclaimers. In case of a disagreement between +the translation and the original version of this License or a notice +or disclaimer, the original version will prevail. +</p> +<p>If a section in the Document is Entitled “Acknowledgements”, +“Dedications”, or “History”, the requirement (section 4) to Preserve +its Title (section 1) will typically require changing the actual +title. +</p> +</li><li> TERMINATION + +<p>You may not copy, modify, sublicense, or distribute the Document +except as expressly provided under this License. Any attempt +otherwise to copy, modify, sublicense, or distribute it is void, and +will automatically terminate your rights under this License. +</p> +<p>However, if you cease all violation of this License, then your license +from a particular copyright holder is reinstated (a) provisionally, +unless and until the copyright holder explicitly and finally +terminates your license, and (b) permanently, if the copyright holder +fails to notify you of the violation by some reasonable means prior to +60 days after the cessation. +</p> +<p>Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. +</p> +<p>Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, receipt of a copy of some or all of the same material does +not give you any rights to use it. +</p> +</li><li> FUTURE REVISIONS OF THIS LICENSE + +<p>The Free Software Foundation may publish new, revised versions +of the GNU Free Documentation License from time to time. Such new +versions will be similar in spirit to the present version, but may +differ in detail to address new problems or concerns. See +<a href="http://www.gnu.org/copyleft/">http://www.gnu.org/copyleft/</a>. +</p> +<p>Each version of the License is given a distinguishing version number. +If the Document specifies that a particular numbered version of this +License “or any later version” applies to it, you have the option of +following the terms and conditions either of that specified version or +of any later version that has been published (not as a draft) by the +Free Software Foundation. If the Document does not specify a version +number of this License, you may choose any version ever published (not +as a draft) by the Free Software Foundation. If the Document +specifies that a proxy can decide which future versions of this +License can be used, that proxy’s public statement of acceptance of a +version permanently authorizes you to choose that version for the +Document. +</p> +</li><li> RELICENSING + +<p>“Massive Multiauthor Collaboration Site” (or “MMC Site”) means any +World Wide Web server that publishes copyrightable works and also +provides prominent facilities for anybody to edit those works. A +public wiki that anybody can edit is an example of such a server. A +“Massive Multiauthor Collaboration” (or “MMC”) contained in the +site means any set of copyrightable works thus published on the MMC +site. +</p> +<p>“CC-BY-SA” means the Creative Commons Attribution-Share Alike 3.0 +license published by Creative Commons Corporation, a not-for-profit +corporation with a principal place of business in San Francisco, +California, as well as future copyleft versions of that license +published by that same organization. +</p> +<p>“Incorporate” means to publish or republish a Document, in whole or +in part, as part of another Document. +</p> +<p>An MMC is “eligible for relicensing” if it is licensed under this +License, and if all works that were first published under this License +somewhere other than this MMC, and subsequently incorporated in whole +or in part into the MMC, (1) had no cover texts or invariant sections, +and (2) were thus incorporated prior to November 1, 2008. +</p> +<p>The operator of an MMC Site may republish an MMC contained in the site +under CC-BY-SA on the same site at any time before August 1, 2009, +provided the MMC is eligible for relicensing. +</p> +</li></ol> + +<a name="ADDENDUM_003a-How-to-use-this-License-for-your-documents"></a> +<h3 class="heading">ADDENDUM: How to use this License for your documents</h3> + +<p>To use this License in a document you have written, include a copy of +the License in the document and put the following copyright and +license notices just after the title page: +</p> +<div class="smallexample"> +<pre class="smallexample"> Copyright (C) <var>year</var> <var>your name</var>. + 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''. +</pre></div> + +<p>If you have Invariant Sections, Front-Cover Texts and Back-Cover Texts, +replace the “with…Texts.” line with this: +</p> +<div class="smallexample"> +<pre class="smallexample"> with the Invariant Sections being <var>list their titles</var>, with + the Front-Cover Texts being <var>list</var>, and with the Back-Cover Texts + being <var>list</var>. +</pre></div> + +<p>If you have Invariant Sections without Cover Texts, or some other +combination of the three, merge those two alternatives to suit the +situation. +</p> +<p>If your document contains nontrivial examples of program code, we +recommend releasing these examples in parallel under your choice of +free software license, such as the GNU General Public License, +to permit their use in free software. +</p> + +<hr> +<div class="header"> +<p> +Up: <a href="Copying-This-Manual.html#Copying-This-Manual" accesskey="u" rel="up">Copying This Manual</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> diff --git a/manuals/guile-sdl2/Game-Controllers.html b/manuals/guile-sdl2/Game-Controllers.html new file mode 100644 index 0000000..1b77c66 --- /dev/null +++ b/manuals/guile-sdl2/Game-Controllers.html @@ -0,0 +1,192 @@ +<!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>Game Controllers (Guile-SDL2)</title> + +<meta name="description" content="Game Controllers (Guile-SDL2)"> +<meta name="keywords" content="Game Controllers (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="Input.html#Input" rel="up" title="Input"> +<link href="Events.html#Events" rel="next" title="Events"> +<link href="Joysticks.html#Joysticks" rel="prev" title="Joysticks"> +<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="Game-Controllers"></a> +<div class="header"> +<p> +Previous: <a href="Joysticks.html#Joysticks" accesskey="p" rel="prev">Joysticks</a>, Up: <a href="Input.html#Input" accesskey="u" rel="up">Input</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="Game-Controllers-1"></a> +<h4 class="subsection">3.3.4 Game Controllers</h4> + +<div class="example"> +<pre class="example">(use-modules (sdl2 input game-controller)) +</pre></div> + +<dl> +<dt><a name="index-load_002dgame_002dcontroller_002dmappings_0021"></a>Procedure: <strong>load-game-controller-mappings!</strong> <em>file</em></dt> +<dd><p>Load game controller mapping from <var>file</var> and return the number of +mappings added this way. +</p> +<p>See <a href="https://raw.github.com/gabomdq/SDL_GameControllerDB/master/gamecontrollerdb.txt">https://raw.github.com/gabomdq/SDL_GameControllerDB/master/gamecontrollerdb.txt</a> +for a community maintained controller mapping file. +</p></dd></dl> + +<dl> +<dt><a name="index-open_002dgame_002dcontroller"></a>Procedure: <strong>open-game-controller</strong> <em>joystick-index</em></dt> +<dd><p>Return a game controller object for the physical joystick device associated +with the <var>joystick-index</var>. +</p></dd></dl> + +<dl> +<dt><a name="index-close_002dgame_002dcontroller"></a>Procedure: <strong>close-game-controller</strong> <em>controller</em></dt> +<dd><p>Close <var>controller</var>. +</p></dd></dl> + +<dl> +<dt><a name="index-game_002dcontroller_003f"></a>Procedure: <strong>game-controller?</strong> <em>controller</em></dt> +<dd><p>Close <var>controller</var>. +</p></dd></dl> + +<dl> +<dt><a name="index-game_002dcontroller_002dattached_003f"></a>Procedure: <strong>game-controller-attached?</strong> <em>controller</em></dt> +<dd><p>Return <code>#t</code> if <var>controller</var> is currently in use. +</p></dd></dl> + +<dl> +<dt><a name="index-game_002dcontroller_002djoystick"></a>Procedure: <strong>game-controller-joystick</strong> <em>controller</em></dt> +<dd><p>Return the underlying joystick object associated with <var>controller</var>. +</p></dd></dl> + +<dl> +<dt><a name="index-game_002dcontroller_002dname"></a>Procedure: <strong>game-controller-name</strong> <em>controller</em></dt> +<dd><p>Return the human readable name for <var>controller</var>. +</p></dd></dl> + +<dl> +<dt><a name="index-game_002dcontroller_002daxis"></a>Procedure: <strong>game-controller-axis</strong> <em>controller axis</em></dt> +<dd><p>Return a number in the range [-32768, 32767] representing the +current state of <var>axis</var> on <var>controller</var>. +</p> +<p><var>axis</var> may be one of the following symbols: +</p><ul> +<li> <code>left-x</code> +</li><li> <code>left-y</code> +</li><li> <code>right-x</code> +</li><li> <code>right-y</code> +</li><li> <code>trigger-left</code> +</li><li> <code>trigger-right</code> +</li></ul> +</dd></dl> + +<dl> +<dt><a name="index-game_002dcontroller_002dbutton_002dpressed_003f"></a>Procedure: <strong>game-controller-button-pressed?</strong> <em>controller button</em></dt> +<dd><p>Return <code>#t</code> if <var>button</var> is pressed on <var>controller</var>. +</p> +<p><var>button</var> may be one of the following symbols: +</p><ul> +<li> <code>a</code> +</li><li> <code>b</code> +</li><li> <code>x</code> +</li><li> <code>y</code> +</li><li> <code>back</code> +</li><li> <code>guide</code> +</li><li> <code>start</code> +</li><li> <code>left-stick</code> +</li><li> <code>right-stick</code> +</li><li> <code>left-shoulder</code> +</li><li> <code>right-shoulder</code> +</li><li> <code>dpad-up</code> +</li><li> <code>dpad-down</code> +</li><li> <code>dpad-left</code> +</li><li> <code>dpad-right</code> +</li></ul> +</dd></dl> + +<dl> +<dt><a name="index-game_002dcontroller_002dindex_003f"></a>Procedure: <strong>game-controller-index?</strong> <em>joystick-index</em></dt> +<dd><p>Return <code>#t</code> if <var>joystick-index</var> is a valid game controller index. +</p></dd></dl> + + + + +</body> +</html> diff --git a/manuals/guile-sdl2/Getting-the-Source.html b/manuals/guile-sdl2/Getting-the-Source.html new file mode 100644 index 0000000..7f8f4cd --- /dev/null +++ b/manuals/guile-sdl2/Getting-the-Source.html @@ -0,0 +1,125 @@ +<!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>Getting the Source (Guile-SDL2)</title> + +<meta name="description" content="Getting the Source (Guile-SDL2)"> +<meta name="keywords" content="Getting the Source (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="Contributing.html#Contributing" rel="up" title="Contributing"> +<link href="Submitting-Patches.html#Submitting-Patches" rel="next" title="Submitting Patches"> +<link href="Contributing.html#Contributing" rel="prev" title="Contributing"> +<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="Getting-the-Source"></a> +<div class="header"> +<p> +Next: <a href="Submitting-Patches.html#Submitting-Patches" accesskey="n" rel="next">Submitting Patches</a>, Up: <a href="Contributing.html#Contributing" accesskey="u" rel="up">Contributing</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="Getting-the-Source-1"></a> +<h3 class="section">4.1 Getting the Source</h3> + +<p>Guile-SDL2 is developed using the Git version control system. The +repository can be cloned with the following command: +</p> +<div class="example"> +<pre class="example">git clone https://git.dthompson.us/guile-sdl2.git +</pre></div> + +<p>To build the source code from a Git checkout, run the following: +</p> +<div class="example"> +<pre class="example">./bootstrap +./configure +make +</pre></div> + +<p>To start a Guile REPL with a pre-configured load path for using +Guile-SDL2, use the <code>pre-inst-env</code> script: +</p> +<div class="example"> +<pre class="example">./pre-inst-env guile +</pre></div> + + + + +</body> +</html> diff --git a/manuals/guile-sdl2/Images.html b/manuals/guile-sdl2/Images.html new file mode 100644 index 0000000..410d942 --- /dev/null +++ b/manuals/guile-sdl2/Images.html @@ -0,0 +1,127 @@ +<!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>Images (Guile-SDL2)</title> + +<meta name="description" content="Images (Guile-SDL2)"> +<meta name="keywords" content="Images (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="API-Reference.html#API-Reference" rel="up" title="API Reference"> +<link href="Sound.html#Sound" rel="next" title="Sound"> +<link href="Rendering.html#Rendering" rel="prev" title="Rendering"> +<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="Images"></a> +<div class="header"> +<p> +Next: <a href="Sound.html#Sound" accesskey="n" rel="next">Sound</a>, Previous: <a href="Rendering.html#Rendering" accesskey="p" rel="prev">Rendering</a>, Up: <a href="API-Reference.html#API-Reference" accesskey="u" rel="up">API Reference</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="Images-1"></a> +<h3 class="section">3.8 Images</h3> + +<div class="example"> +<pre class="example">(use-modules (sdl2 image)) +</pre></div> + +<dl> +<dt><a name="index-image_002dinit"></a>Procedure: <strong>image-init</strong></dt> +<dd><p>Initialize dynamically loaded image libraries. +</p></dd></dl> + +<dl> +<dt><a name="index-image_002dquit"></a>Procedure: <strong>image-quit</strong></dt> +<dd><p>Clean up dynamically loaded image libraries. +</p></dd></dl> + +<dl> +<dt><a name="index-load_002dimage"></a>Procedure: <strong>load-image</strong> <em>file</em></dt> +<dd><p>Load the image in <var>file</var> and return an SDL surface. +</p></dd></dl> + +<dl> +<dt><a name="index-save_002dpng"></a>Procedure: <strong>save-png</strong> <em>surface file</em></dt> +<dd><p>Save <var>surface</var> to <var>file</var> as a PNG formatted image. +</p></dd></dl> + + + + +</body> +</html> diff --git a/manuals/guile-sdl2/Index.html b/manuals/guile-sdl2/Index.html new file mode 100644 index 0000000..cc332b2 --- /dev/null +++ b/manuals/guile-sdl2/Index.html @@ -0,0 +1,490 @@ +<!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>Index (Guile-SDL2)</title> + +<meta name="description" content="Index (Guile-SDL2)"> +<meta name="keywords" content="Index (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" rel="index" title="Index"> +<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents"> +<link href="index.html#Top" rel="up" title="Top"> +<link href="GNU-Free-Documentation-License.html#GNU-Free-Documentation-License" rel="prev" title="GNU Free Documentation License"> +<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="Index"></a> +<div class="header"> +<p> +Previous: <a href="Copying-This-Manual.html#Copying-This-Manual" accesskey="p" rel="prev">Copying This Manual</a>, Up: <a href="index.html#Top" accesskey="u" rel="up">Top</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p> +</div> +<hr> +<a name="Index-1"></a> +<h2 class="unnumbered">Index</h2> + +<table><tr><th valign="top">Jump to: </th><td><a class="summary-letter" href="#Index_fn_symbol-1"><b>%</b></a> + +<br> +<a class="summary-letter" href="#Index_fn_letter-B"><b>B</b></a> + +<a class="summary-letter" href="#Index_fn_letter-C"><b>C</b></a> + +<a class="summary-letter" href="#Index_fn_letter-D"><b>D</b></a> + +<a class="summary-letter" href="#Index_fn_letter-F"><b>F</b></a> + +<a class="summary-letter" href="#Index_fn_letter-G"><b>G</b></a> + +<a class="summary-letter" href="#Index_fn_letter-H"><b>H</b></a> + +<a class="summary-letter" href="#Index_fn_letter-I"><b>I</b></a> + +<a class="summary-letter" href="#Index_fn_letter-J"><b>J</b></a> + +<a class="summary-letter" href="#Index_fn_letter-K"><b>K</b></a> + +<a class="summary-letter" href="#Index_fn_letter-L"><b>L</b></a> + +<a class="summary-letter" href="#Index_fn_letter-M"><b>M</b></a> + +<a class="summary-letter" href="#Index_fn_letter-N"><b>N</b></a> + +<a class="summary-letter" href="#Index_fn_letter-O"><b>O</b></a> + +<a class="summary-letter" href="#Index_fn_letter-P"><b>P</b></a> + +<a class="summary-letter" href="#Index_fn_letter-Q"><b>Q</b></a> + +<a class="summary-letter" href="#Index_fn_letter-R"><b>R</b></a> + +<a class="summary-letter" href="#Index_fn_letter-S"><b>S</b></a> + +<a class="summary-letter" href="#Index_fn_letter-T"><b>T</b></a> + +<a class="summary-letter" href="#Index_fn_letter-W"><b>W</b></a> + +</td></tr></table> +<table class="index-fn" border="0"> +<tr><td></td><th align="left">Index Entry</th><td> </td><th align="left"> Section</th></tr> +<tr><td colspan="4"> <hr></td></tr> +<tr><th><a name="Index_fn_symbol-1">%</a></th><td></td><td></td></tr> +<tr><td></td><td valign="top"><a href="Sound.html#index-_0025default_002dchunk_002dsize"><code>%default-chunk-size</code></a>:</td><td> </td><td valign="top"><a href="Sound.html#Sound">Sound</a></td></tr> +<tr><td></td><td valign="top"><a href="Sound.html#index-_0025default_002dformat"><code>%default-format</code></a>:</td><td> </td><td valign="top"><a href="Sound.html#Sound">Sound</a></td></tr> +<tr><td></td><td valign="top"><a href="Sound.html#index-_0025default_002dfrequency"><code>%default-frequency</code></a>:</td><td> </td><td valign="top"><a href="Sound.html#Sound">Sound</a></td></tr> +<tr><td colspan="4"> <hr></td></tr> +<tr><th><a name="Index_fn_letter-B">B</a></th><td></td><td></td></tr> +<tr><td></td><td valign="top"><a href="Surfaces.html#index-blit_002dscaled"><code>blit-scaled</code></a>:</td><td> </td><td valign="top"><a href="Surfaces.html#Surfaces">Surfaces</a></td></tr> +<tr><td></td><td valign="top"><a href="Surfaces.html#index-blit_002dsurface"><code>blit-surface</code></a>:</td><td> </td><td valign="top"><a href="Surfaces.html#Surfaces">Surfaces</a></td></tr> +<tr><td></td><td valign="top"><a href="Surfaces.html#index-bytevector_002d_003esurface"><code>bytevector->surface</code></a>:</td><td> </td><td valign="top"><a href="Surfaces.html#Surfaces">Surfaces</a></td></tr> +<tr><td colspan="4"> <hr></td></tr> +<tr><th><a name="Index_fn_letter-C">C</a></th><td></td><td></td></tr> +<tr><td></td><td valign="top"><a href="OpenGL.html#index-call_002dwith_002dgl_002dcontext"><code>call-with-gl-context</code></a>:</td><td> </td><td valign="top"><a href="OpenGL.html#OpenGL">OpenGL</a></td></tr> +<tr><td></td><td valign="top"><a href="Rendering.html#index-call_002dwith_002drenderer"><code>call-with-renderer</code></a>:</td><td> </td><td valign="top"><a href="Rendering.html#Rendering">Rendering</a></td></tr> +<tr><td></td><td valign="top"><a href="Surfaces.html#index-call_002dwith_002dsurface"><code>call-with-surface</code></a>:</td><td> </td><td valign="top"><a href="Surfaces.html#Surfaces">Surfaces</a></td></tr> +<tr><td></td><td valign="top"><a href="Windows.html#index-call_002dwith_002dwindow"><code>call-with-window</code></a>:</td><td> </td><td valign="top"><a href="Windows.html#Windows">Windows</a></td></tr> +<tr><td></td><td valign="top"><a href="Sound.html#index-channel_002dpaused_003f"><code>channel-paused?</code></a>:</td><td> </td><td valign="top"><a href="Sound.html#Sound">Sound</a></td></tr> +<tr><td></td><td valign="top"><a href="Sound.html#index-channel_002dplaying_003f"><code>channel-playing?</code></a>:</td><td> </td><td valign="top"><a href="Sound.html#Sound">Sound</a></td></tr> +<tr><td></td><td valign="top"><a href="Sound.html#index-chunk_003f"><code>chunk?</code></a>:</td><td> </td><td valign="top"><a href="Sound.html#Sound">Sound</a></td></tr> +<tr><td></td><td valign="top"><a href="Rendering.html#index-clear_002drenderer"><code>clear-renderer</code></a>:</td><td> </td><td valign="top"><a href="Rendering.html#Rendering">Rendering</a></td></tr> +<tr><td></td><td valign="top"><a href="Sound.html#index-close_002daudio"><code>close-audio</code></a>:</td><td> </td><td valign="top"><a href="Sound.html#Sound">Sound</a></td></tr> +<tr><td></td><td valign="top"><a href="Game-Controllers.html#index-close_002dgame_002dcontroller"><code>close-game-controller</code></a>:</td><td> </td><td valign="top"><a href="Game-Controllers.html#Game-Controllers">Game Controllers</a></td></tr> +<tr><td></td><td valign="top"><a href="Joysticks.html#index-close_002djoystick"><code>close-joystick</code></a>:</td><td> </td><td valign="top"><a href="Joysticks.html#Joysticks">Joysticks</a></td></tr> +<tr><td></td><td valign="top"><a href="Windows.html#index-close_002dwindow_0021"><code>close-window!</code></a>:</td><td> </td><td valign="top"><a href="Windows.html#Windows">Windows</a></td></tr> +<tr><td></td><td valign="top"><a href="Surfaces.html#index-color_002da"><code>color-a</code></a>:</td><td> </td><td valign="top"><a href="Surfaces.html#Surfaces">Surfaces</a></td></tr> +<tr><td></td><td valign="top"><a href="Surfaces.html#index-color_002db"><code>color-b</code></a>:</td><td> </td><td valign="top"><a href="Surfaces.html#Surfaces">Surfaces</a></td></tr> +<tr><td></td><td valign="top"><a href="Surfaces.html#index-color_002dg"><code>color-g</code></a>:</td><td> </td><td valign="top"><a href="Surfaces.html#Surfaces">Surfaces</a></td></tr> +<tr><td></td><td valign="top"><a href="Surfaces.html#index-color_002dr"><code>color-r</code></a>:</td><td> </td><td valign="top"><a href="Surfaces.html#Surfaces">Surfaces</a></td></tr> +<tr><td></td><td valign="top"><a href="Surfaces.html#index-color_003f"><code>color?</code></a>:</td><td> </td><td valign="top"><a href="Surfaces.html#Surfaces">Surfaces</a></td></tr> +<tr><td></td><td valign="top"><a href="Events.html#index-controller_002dadded_002devent_003f"><code>controller-added-event?</code></a>:</td><td> </td><td valign="top"><a href="Events.html#Events">Events</a></td></tr> +<tr><td></td><td valign="top"><a href="Events.html#index-controller_002daxis_002devent_002daxis"><code>controller-axis-event-axis</code></a>:</td><td> </td><td valign="top"><a href="Events.html#Events">Events</a></td></tr> +<tr><td></td><td valign="top"><a href="Events.html#index-controller_002daxis_002devent_002dtimestamp"><code>controller-axis-event-timestamp</code></a>:</td><td> </td><td valign="top"><a href="Events.html#Events">Events</a></td></tr> +<tr><td></td><td valign="top"><a href="Events.html#index-controller_002daxis_002devent_002dvalue"><code>controller-axis-event-value</code></a>:</td><td> </td><td valign="top"><a href="Events.html#Events">Events</a></td></tr> +<tr><td></td><td valign="top"><a href="Events.html#index-controller_002daxis_002devent_002dwhich"><code>controller-axis-event-which</code></a>:</td><td> </td><td valign="top"><a href="Events.html#Events">Events</a></td></tr> +<tr><td></td><td valign="top"><a href="Events.html#index-controller_002daxis_002devent_003f"><code>controller-axis-event?</code></a>:</td><td> </td><td valign="top"><a href="Events.html#Events">Events</a></td></tr> +<tr><td></td><td valign="top"><a href="Events.html#index-controller_002dbutton_002ddown_002devent_003f"><code>controller-button-down-event?</code></a>:</td><td> </td><td valign="top"><a href="Events.html#Events">Events</a></td></tr> +<tr><td></td><td valign="top"><a href="Events.html#index-controller_002dbutton_002devent_002dbutton"><code>controller-button-event-button</code></a>:</td><td> </td><td valign="top"><a href="Events.html#Events">Events</a></td></tr> +<tr><td></td><td valign="top"><a href="Events.html#index-controller_002dbutton_002devent_002dpressed_003f"><code>controller-button-event-pressed?</code></a>:</td><td> </td><td valign="top"><a href="Events.html#Events">Events</a></td></tr> +<tr><td></td><td valign="top"><a href="Events.html#index-controller_002dbutton_002devent_002dtimestamp"><code>controller-button-event-timestamp</code></a>:</td><td> </td><td valign="top"><a href="Events.html#Events">Events</a></td></tr> +<tr><td></td><td valign="top"><a href="Events.html#index-controller_002dbutton_002devent_002dwhich"><code>controller-button-event-which</code></a>:</td><td> </td><td valign="top"><a href="Events.html#Events">Events</a></td></tr> +<tr><td></td><td valign="top"><a href="Events.html#index-controller_002dbutton_002devent_003f"><code>controller-button-event?</code></a>:</td><td> </td><td valign="top"><a href="Events.html#Events">Events</a></td></tr> +<tr><td></td><td valign="top"><a href="Events.html#index-controller_002dbutton_002dup_002devent_003f"><code>controller-button-up-event?</code></a>:</td><td> </td><td valign="top"><a href="Events.html#Events">Events</a></td></tr> +<tr><td></td><td valign="top"><a href="Events.html#index-controller_002ddevice_002devent_002daction"><code>controller-device-event-action</code></a>:</td><td> </td><td valign="top"><a href="Events.html#Events">Events</a></td></tr> +<tr><td></td><td valign="top"><a href="Events.html#index-controller_002ddevice_002devent_002dtimestamp"><code>controller-device-event-timestamp</code></a>:</td><td> </td><td valign="top"><a href="Events.html#Events">Events</a></td></tr> +<tr><td></td><td valign="top"><a href="Events.html#index-controller_002ddevice_002devent_002dwhich"><code>controller-device-event-which</code></a>:</td><td> </td><td valign="top"><a href="Events.html#Events">Events</a></td></tr> +<tr><td></td><td valign="top"><a href="Events.html#index-controller_002ddevice_002devent_003f"><code>controller-device-event?</code></a>:</td><td> </td><td valign="top"><a href="Events.html#Events">Events</a></td></tr> +<tr><td></td><td valign="top"><a href="Events.html#index-controller_002dremapped_002devent_003f"><code>controller-remapped-event?</code></a>:</td><td> </td><td valign="top"><a href="Events.html#Events">Events</a></td></tr> +<tr><td></td><td valign="top"><a href="Events.html#index-controller_002dremoved_002devent_003f"><code>controller-removed-event?</code></a>:</td><td> </td><td valign="top"><a href="Events.html#Events">Events</a></td></tr> +<tr><td></td><td valign="top"><a href="Surfaces.html#index-convert_002dsurface_002dformat"><code>convert-surface-format</code></a>:</td><td> </td><td valign="top"><a href="Surfaces.html#Surfaces">Surfaces</a></td></tr> +<tr><td colspan="4"> <hr></td></tr> +<tr><th><a name="Index_fn_letter-D">D</a></th><td></td><td></td></tr> +<tr><td></td><td valign="top"><a href="Sound.html#index-delete_002dchunk_0021"><code>delete-chunk!</code></a>:</td><td> </td><td valign="top"><a href="Sound.html#Sound">Sound</a></td></tr> +<tr><td></td><td valign="top"><a href="Fonts.html#index-delete_002dfont_0021"><code>delete-font!</code></a>:</td><td> </td><td valign="top"><a href="Fonts.html#Fonts">Fonts</a></td></tr> +<tr><td></td><td valign="top"><a href="OpenGL.html#index-delete_002dgl_002dcontext_0021"><code>delete-gl-context!</code></a>:</td><td> </td><td valign="top"><a href="OpenGL.html#OpenGL">OpenGL</a></td></tr> +<tr><td></td><td valign="top"><a href="Sound.html#index-delete_002dmusic_0021"><code>delete-music!</code></a>:</td><td> </td><td valign="top"><a href="Sound.html#Sound">Sound</a></td></tr> +<tr><td></td><td valign="top"><a href="Rendering.html#index-delete_002drenderer_0021"><code>delete-renderer!</code></a>:</td><td> </td><td valign="top"><a href="Rendering.html#Rendering">Rendering</a></td></tr> +<tr><td></td><td valign="top"><a href="Surfaces.html#index-delete_002dsurface_0021"><code>delete-surface!</code></a>:</td><td> </td><td valign="top"><a href="Surfaces.html#Surfaces">Surfaces</a></td></tr> +<tr><td></td><td valign="top"><a href="Rendering.html#index-delete_002dtexture_0021"><code>delete-texture!</code></a>:</td><td> </td><td valign="top"><a href="Rendering.html#Rendering">Rendering</a></td></tr> +<tr><td colspan="4"> <hr></td></tr> +<tr><th><a name="Index_fn_letter-F">F</a></th><td></td><td></td></tr> +<tr><td></td><td valign="top"><a href="Surfaces.html#index-fill_002drect"><code>fill-rect</code></a>:</td><td> </td><td valign="top"><a href="Surfaces.html#Surfaces">Surfaces</a></td></tr> +<tr><td></td><td valign="top"><a href="Fonts.html#index-font_002dheight"><code>font-height</code></a>:</td><td> </td><td valign="top"><a href="Fonts.html#Fonts">Fonts</a></td></tr> +<tr><td colspan="4"> <hr></td></tr> +<tr><th><a name="Index_fn_letter-G">G</a></th><td></td><td></td></tr> +<tr><td></td><td valign="top"><a href="Game-Controllers.html#index-game_002dcontroller_002dattached_003f"><code>game-controller-attached?</code></a>:</td><td> </td><td valign="top"><a href="Game-Controllers.html#Game-Controllers">Game Controllers</a></td></tr> +<tr><td></td><td valign="top"><a href="Game-Controllers.html#index-game_002dcontroller_002daxis"><code>game-controller-axis</code></a>:</td><td> </td><td valign="top"><a href="Game-Controllers.html#Game-Controllers">Game Controllers</a></td></tr> +<tr><td></td><td valign="top"><a href="Game-Controllers.html#index-game_002dcontroller_002dbutton_002dpressed_003f"><code>game-controller-button-pressed?</code></a>:</td><td> </td><td valign="top"><a href="Game-Controllers.html#Game-Controllers">Game Controllers</a></td></tr> +<tr><td></td><td valign="top"><a href="Game-Controllers.html#index-game_002dcontroller_002dindex_003f"><code>game-controller-index?</code></a>:</td><td> </td><td valign="top"><a href="Game-Controllers.html#Game-Controllers">Game Controllers</a></td></tr> +<tr><td></td><td valign="top"><a href="Game-Controllers.html#index-game_002dcontroller_002djoystick"><code>game-controller-joystick</code></a>:</td><td> </td><td valign="top"><a href="Game-Controllers.html#Game-Controllers">Game Controllers</a></td></tr> +<tr><td></td><td valign="top"><a href="Game-Controllers.html#index-game_002dcontroller_002dname"><code>game-controller-name</code></a>:</td><td> </td><td valign="top"><a href="Game-Controllers.html#Game-Controllers">Game Controllers</a></td></tr> +<tr><td></td><td valign="top"><a href="Game-Controllers.html#index-game_002dcontroller_003f"><code>game-controller?</code></a>:</td><td> </td><td valign="top"><a href="Game-Controllers.html#Game-Controllers">Game Controllers</a></td></tr> +<tr><td colspan="4"> <hr></td></tr> +<tr><th><a name="Index_fn_letter-H">H</a></th><td></td><td></td></tr> +<tr><td></td><td valign="top"><a href="Windows.html#index-hide_002dwindow_0021"><code>hide-window!</code></a>:</td><td> </td><td valign="top"><a href="Windows.html#Windows">Windows</a></td></tr> +<tr><td colspan="4"> <hr></td></tr> +<tr><th><a name="Index_fn_letter-I">I</a></th><td></td><td></td></tr> +<tr><td></td><td valign="top"><a href="Windows.html#index-id_002d_003ewindow"><code>id->window</code></a>:</td><td> </td><td valign="top"><a href="Windows.html#Windows">Windows</a></td></tr> +<tr><td></td><td valign="top"><a href="Images.html#index-image_002dinit"><code>image-init</code></a>:</td><td> </td><td valign="top"><a href="Images.html#Images">Images</a></td></tr> +<tr><td></td><td valign="top"><a href="Images.html#index-image_002dquit"><code>image-quit</code></a>:</td><td> </td><td valign="top"><a href="Images.html#Images">Images</a></td></tr> +<tr><td colspan="4"> <hr></td></tr> +<tr><th><a name="Index_fn_letter-J">J</a></th><td></td><td></td></tr> +<tr><td></td><td valign="top"><a href="Events.html#index-joystick_002daxis_002devent_002dbutton"><code>joystick-axis-event-button</code></a>:</td><td> </td><td valign="top"><a href="Events.html#Events">Events</a></td></tr> +<tr><td></td><td valign="top"><a href="Events.html#index-joystick_002daxis_002devent_002dpressed_003f"><code>joystick-axis-event-pressed?</code></a>:</td><td> </td><td valign="top"><a href="Events.html#Events">Events</a></td></tr> +<tr><td></td><td valign="top"><a href="Events.html#index-joystick_002daxis_002devent_002dtimestamp"><code>joystick-axis-event-timestamp</code></a>:</td><td> </td><td valign="top"><a href="Events.html#Events">Events</a></td></tr> +<tr><td></td><td valign="top"><a href="Events.html#index-joystick_002daxis_002devent_002dwhich"><code>joystick-axis-event-which</code></a>:</td><td> </td><td valign="top"><a href="Events.html#Events">Events</a></td></tr> +<tr><td></td><td valign="top"><a href="Events.html#index-joystick_002daxis_002devent_003f"><code>joystick-axis-event?</code></a>:</td><td> </td><td valign="top"><a href="Events.html#Events">Events</a></td></tr> +<tr><td></td><td valign="top"><a href="Events.html#index-joystick_002dball_002devent_002dball"><code>joystick-ball-event-ball</code></a>:</td><td> </td><td valign="top"><a href="Events.html#Events">Events</a></td></tr> +<tr><td></td><td valign="top"><a href="Events.html#index-joystick_002dball_002devent_002dtimestamp"><code>joystick-ball-event-timestamp</code></a>:</td><td> </td><td valign="top"><a href="Events.html#Events">Events</a></td></tr> +<tr><td></td><td valign="top"><a href="Events.html#index-joystick_002dball_002devent_002dwhich"><code>joystick-ball-event-which</code></a>:</td><td> </td><td valign="top"><a href="Events.html#Events">Events</a></td></tr> +<tr><td></td><td valign="top"><a href="Events.html#index-joystick_002dball_002devent_002dx_002drel"><code>joystick-ball-event-x-rel</code></a>:</td><td> </td><td valign="top"><a href="Events.html#Events">Events</a></td></tr> +<tr><td></td><td valign="top"><a href="Events.html#index-joystick_002dball_002devent_002dy_002drel"><code>joystick-ball-event-y-rel</code></a>:</td><td> </td><td valign="top"><a href="Events.html#Events">Events</a></td></tr> +<tr><td></td><td valign="top"><a href="Events.html#index-joystick_002dball_002devent_003f"><code>joystick-ball-event?</code></a>:</td><td> </td><td valign="top"><a href="Events.html#Events">Events</a></td></tr> +<tr><td></td><td valign="top"><a href="Events.html#index-joystick_002ddevice_002devent_002daction"><code>joystick-device-event-action</code></a>:</td><td> </td><td valign="top"><a href="Events.html#Events">Events</a></td></tr> +<tr><td></td><td valign="top"><a href="Events.html#index-joystick_002ddevice_002devent_002dtimestamp"><code>joystick-device-event-timestamp</code></a>:</td><td> </td><td valign="top"><a href="Events.html#Events">Events</a></td></tr> +<tr><td></td><td valign="top"><a href="Events.html#index-joystick_002ddevice_002devent_002dwhich"><code>joystick-device-event-which</code></a>:</td><td> </td><td valign="top"><a href="Events.html#Events">Events</a></td></tr> +<tr><td></td><td valign="top"><a href="Events.html#index-joystick_002ddevice_002devent_003f"><code>joystick-device-event?</code></a>:</td><td> </td><td valign="top"><a href="Events.html#Events">Events</a></td></tr> +<tr><td></td><td valign="top"><a href="Events.html#index-joystick_002dhat_002devent_002dhat"><code>joystick-hat-event-hat</code></a>:</td><td> </td><td valign="top"><a href="Events.html#Events">Events</a></td></tr> +<tr><td></td><td valign="top"><a href="Events.html#index-joystick_002dhat_002devent_002dtimestamp"><code>joystick-hat-event-timestamp</code></a>:</td><td> </td><td valign="top"><a href="Events.html#Events">Events</a></td></tr> +<tr><td></td><td valign="top"><a href="Events.html#index-joystick_002dhat_002devent_002dvalue"><code>joystick-hat-event-value</code></a>:</td><td> </td><td valign="top"><a href="Events.html#Events">Events</a></td></tr> +<tr><td></td><td valign="top"><a href="Events.html#index-joystick_002dhat_002devent_002dwhich"><code>joystick-hat-event-which</code></a>:</td><td> </td><td valign="top"><a href="Events.html#Events">Events</a></td></tr> +<tr><td></td><td valign="top"><a href="Events.html#index-joystick_002dhat_002devent_003f"><code>joystick-hat-event?</code></a>:</td><td> </td><td valign="top"><a href="Events.html#Events">Events</a></td></tr> +<tr><td></td><td valign="top"><a href="Joysticks.html#index-joystick_002dinstance_002did"><code>joystick-instance-id</code></a>:</td><td> </td><td valign="top"><a href="Joysticks.html#Joysticks">Joysticks</a></td></tr> +<tr><td></td><td valign="top"><a href="Joysticks.html#index-joystick_002dnum_002daxes"><code>joystick-num-axes</code></a>:</td><td> </td><td valign="top"><a href="Joysticks.html#Joysticks">Joysticks</a></td></tr> +<tr><td></td><td valign="top"><a href="Joysticks.html#index-joystick_002dnum_002dballs"><code>joystick-num-balls</code></a>:</td><td> </td><td valign="top"><a href="Joysticks.html#Joysticks">Joysticks</a></td></tr> +<tr><td></td><td valign="top"><a href="Joysticks.html#index-joystick_002dnum_002dbuttons"><code>joystick-num-buttons</code></a>:</td><td> </td><td valign="top"><a href="Joysticks.html#Joysticks">Joysticks</a></td></tr> +<tr><td></td><td valign="top"><a href="Joysticks.html#index-joystick_002dnum_002dhats"><code>joystick-num-hats</code></a>:</td><td> </td><td valign="top"><a href="Joysticks.html#Joysticks">Joysticks</a></td></tr> +<tr><td></td><td valign="top"><a href="Joysticks.html#index-joystick_002dpower_002dlevel"><code>joystick-power-level</code></a>:</td><td> </td><td valign="top"><a href="Joysticks.html#Joysticks">Joysticks</a></td></tr> +<tr><td colspan="4"> <hr></td></tr> +<tr><th><a name="Index_fn_letter-K">K</a></th><td></td><td></td></tr> +<tr><td></td><td valign="top"><a href="Keyboard.html#index-key_002dpressed_003f"><code>key-pressed?</code></a>:</td><td> </td><td valign="top"><a href="Keyboard.html#Keyboard">Keyboard</a></td></tr> +<tr><td></td><td valign="top"><a href="Keyboard.html#index-key_002dreleased_003f"><code>key-released?</code></a>:</td><td> </td><td valign="top"><a href="Keyboard.html#Keyboard">Keyboard</a></td></tr> +<tr><td></td><td valign="top"><a href="Events.html#index-keyboard_002ddown_002devent_003f"><code>keyboard-down-event?</code></a>:</td><td> </td><td valign="top"><a href="Events.html#Events">Events</a></td></tr> +<tr><td></td><td valign="top"><a href="Events.html#index-keyboard_002devent_002dkey"><code>keyboard-event-key</code></a>:</td><td> </td><td valign="top"><a href="Events.html#Events">Events</a></td></tr> +<tr><td></td><td valign="top"><a href="Events.html#index-keyboard_002devent_002dmodifiers"><code>keyboard-event-modifiers</code></a>:</td><td> </td><td valign="top"><a href="Events.html#Events">Events</a></td></tr> +<tr><td></td><td valign="top"><a href="Events.html#index-keyboard_002devent_002dpressed_003f"><code>keyboard-event-pressed?</code></a>:</td><td> </td><td valign="top"><a href="Events.html#Events">Events</a></td></tr> +<tr><td></td><td valign="top"><a href="Events.html#index-keyboard_002devent_002drepeat_003f"><code>keyboard-event-repeat?</code></a>:</td><td> </td><td valign="top"><a href="Events.html#Events">Events</a></td></tr> +<tr><td></td><td valign="top"><a href="Events.html#index-keyboard_002devent_002dscancode"><code>keyboard-event-scancode</code></a>:</td><td> </td><td valign="top"><a href="Events.html#Events">Events</a></td></tr> +<tr><td></td><td valign="top"><a href="Events.html#index-keyboard_002devent_002dtimestamp"><code>keyboard-event-timestamp</code></a>:</td><td> </td><td valign="top"><a href="Events.html#Events">Events</a></td></tr> +<tr><td></td><td valign="top"><a href="Events.html#index-keyboard_002devent_002dwindow_002did"><code>keyboard-event-window-id</code></a>:</td><td> </td><td valign="top"><a href="Events.html#Events">Events</a></td></tr> +<tr><td></td><td valign="top"><a href="Events.html#index-keyboard_002devent_003f"><code>keyboard-event?</code></a>:</td><td> </td><td valign="top"><a href="Events.html#Events">Events</a></td></tr> +<tr><td></td><td valign="top"><a href="Events.html#index-keyboard_002dup_002devent_003f"><code>keyboard-up-event?</code></a>:</td><td> </td><td valign="top"><a href="Events.html#Events">Events</a></td></tr> +<tr><td colspan="4"> <hr></td></tr> +<tr><th><a name="Index_fn_letter-L">L</a></th><td></td><td></td></tr> +<tr><td></td><td valign="top"><a href="Surfaces.html#index-load_002dbmp"><code>load-bmp</code></a>:</td><td> </td><td valign="top"><a href="Surfaces.html#Surfaces">Surfaces</a></td></tr> +<tr><td></td><td valign="top"><a href="Sound.html#index-load_002dchunk"><code>load-chunk</code></a>:</td><td> </td><td valign="top"><a href="Sound.html#Sound">Sound</a></td></tr> +<tr><td></td><td valign="top"><a href="Fonts.html#index-load_002dfont"><code>load-font</code></a>:</td><td> </td><td valign="top"><a href="Fonts.html#Fonts">Fonts</a></td></tr> +<tr><td></td><td valign="top"><a href="Game-Controllers.html#index-load_002dgame_002dcontroller_002dmappings_0021"><code>load-game-controller-mappings!</code></a>:</td><td> </td><td valign="top"><a href="Game-Controllers.html#Game-Controllers">Game Controllers</a></td></tr> +<tr><td></td><td valign="top"><a href="Images.html#index-load_002dimage"><code>load-image</code></a>:</td><td> </td><td valign="top"><a href="Images.html#Images">Images</a></td></tr> +<tr><td></td><td valign="top"><a href="Sound.html#index-load_002dmusic"><code>load-music</code></a>:</td><td> </td><td valign="top"><a href="Sound.html#Sound">Sound</a></td></tr> +<tr><td colspan="4"> <hr></td></tr> +<tr><th><a name="Index_fn_letter-M">M</a></th><td></td><td></td></tr> +<tr><td></td><td valign="top"><a href="Events.html#index-make_002dcontroller_002daxis_002devent"><code>make-controller-axis-event</code></a>:</td><td> </td><td valign="top"><a href="Events.html#Events">Events</a></td></tr> +<tr><td></td><td valign="top"><a href="Events.html#index-make_002dcontroller_002dbutton_002devent"><code>make-controller-button-event</code></a>:</td><td> </td><td valign="top"><a href="Events.html#Events">Events</a></td></tr> +<tr><td></td><td valign="top"><a href="Events.html#index-make_002dcontroller_002ddevice_002devent"><code>make-controller-device-event</code></a>:</td><td> </td><td valign="top"><a href="Events.html#Events">Events</a></td></tr> +<tr><td></td><td valign="top"><a href="OpenGL.html#index-make_002dgl_002dcontext"><code>make-gl-context</code></a>:</td><td> </td><td valign="top"><a href="OpenGL.html#OpenGL">OpenGL</a></td></tr> +<tr><td></td><td valign="top"><a href="Events.html#index-make_002djoystick_002daxis_002devent"><code>make-joystick-axis-event</code></a>:</td><td> </td><td valign="top"><a href="Events.html#Events">Events</a></td></tr> +<tr><td></td><td valign="top"><a href="Events.html#index-make_002djoystick_002dball_002devent"><code>make-joystick-ball-event</code></a>:</td><td> </td><td valign="top"><a href="Events.html#Events">Events</a></td></tr> +<tr><td></td><td valign="top"><a href="Events.html#index-make_002djoystick_002ddevice_002devent"><code>make-joystick-device-event</code></a>:</td><td> </td><td valign="top"><a href="Events.html#Events">Events</a></td></tr> +<tr><td></td><td valign="top"><a href="Events.html#index-make_002djoystick_002dhat_002devent"><code>make-joystick-hat-event</code></a>:</td><td> </td><td valign="top"><a href="Events.html#Events">Events</a></td></tr> +<tr><td></td><td valign="top"><a href="Events.html#index-make_002dkeyboard_002devent"><code>make-keyboard-event</code></a>:</td><td> </td><td valign="top"><a href="Events.html#Events">Events</a></td></tr> +<tr><td></td><td valign="top"><a href="Events.html#index-make_002dmouse_002dbutton_002devent"><code>make-mouse-button-event</code></a>:</td><td> </td><td valign="top"><a href="Events.html#Events">Events</a></td></tr> +<tr><td></td><td valign="top"><a href="Events.html#index-make_002dmouse_002dmotion_002devent"><code>make-mouse-motion-event</code></a>:</td><td> </td><td valign="top"><a href="Events.html#Events">Events</a></td></tr> +<tr><td></td><td valign="top"><a href="Events.html#index-make_002dquit_002devent"><code>make-quit-event</code></a>:</td><td> </td><td valign="top"><a href="Events.html#Events">Events</a></td></tr> +<tr><td></td><td valign="top"><a href="Rects.html#index-make_002drect"><code>make-rect</code></a>:</td><td> </td><td valign="top"><a href="Rects.html#Rects">Rects</a></td></tr> +<tr><td></td><td valign="top"><a href="Rendering.html#index-make_002drenderer"><code>make-renderer</code></a>:</td><td> </td><td valign="top"><a href="Rendering.html#Rendering">Rendering</a></td></tr> +<tr><td></td><td valign="top"><a href="Surfaces.html#index-make_002drgb_002dsurface"><code>make-rgb-surface</code></a>:</td><td> </td><td valign="top"><a href="Surfaces.html#Surfaces">Surfaces</a></td></tr> +<tr><td></td><td valign="top"><a href="Events.html#index-make_002dtext_002dinput_002devent"><code>make-text-input-event</code></a>:</td><td> </td><td valign="top"><a href="Events.html#Events">Events</a></td></tr> +<tr><td></td><td valign="top"><a href="Windows.html#index-make_002dwindow"><code>make-window</code></a>:</td><td> </td><td valign="top"><a href="Windows.html#Windows">Windows</a></td></tr> +<tr><td></td><td valign="top"><a href="Events.html#index-make_002dwindow_002devent"><code>make-window-event</code></a>:</td><td> </td><td valign="top"><a href="Events.html#Events">Events</a></td></tr> +<tr><td></td><td valign="top"><a href="Windows.html#index-maximize_002dwindow_0021"><code>maximize-window!</code></a>:</td><td> </td><td valign="top"><a href="Windows.html#Windows">Windows</a></td></tr> +<tr><td></td><td valign="top"><a href="Windows.html#index-minimize_002dwindow_0021"><code>minimize-window!</code></a>:</td><td> </td><td valign="top"><a href="Windows.html#Windows">Windows</a></td></tr> +<tr><td></td><td valign="top"><a href="Sound.html#index-mixer_002dinit"><code>mixer-init</code></a>:</td><td> </td><td valign="top"><a href="Sound.html#Sound">Sound</a></td></tr> +<tr><td></td><td valign="top"><a href="Sound.html#index-mixer_002dquit"><code>mixer-quit</code></a>:</td><td> </td><td valign="top"><a href="Sound.html#Sound">Sound</a></td></tr> +<tr><td></td><td valign="top"><a href="Events.html#index-mouse_002dbutton_002ddown_002devent_003f"><code>mouse-button-down-event?</code></a>:</td><td> </td><td valign="top"><a href="Events.html#Events">Events</a></td></tr> +<tr><td></td><td valign="top"><a href="Events.html#index-mouse_002dbutton_002devent_002dbutton"><code>mouse-button-event-button</code></a>:</td><td> </td><td valign="top"><a href="Events.html#Events">Events</a></td></tr> +<tr><td></td><td valign="top"><a href="Events.html#index-mouse_002dbutton_002devent_002dclicks"><code>mouse-button-event-clicks</code></a>:</td><td> </td><td valign="top"><a href="Events.html#Events">Events</a></td></tr> +<tr><td></td><td valign="top"><a href="Events.html#index-mouse_002dbutton_002devent_002dpressed_003f"><code>mouse-button-event-pressed?</code></a>:</td><td> </td><td valign="top"><a href="Events.html#Events">Events</a></td></tr> +<tr><td></td><td valign="top"><a href="Events.html#index-mouse_002dbutton_002devent_002dtimestamp"><code>mouse-button-event-timestamp</code></a>:</td><td> </td><td valign="top"><a href="Events.html#Events">Events</a></td></tr> +<tr><td></td><td valign="top"><a href="Events.html#index-mouse_002dbutton_002devent_002dwhich"><code>mouse-button-event-which</code></a>:</td><td> </td><td valign="top"><a href="Events.html#Events">Events</a></td></tr> +<tr><td></td><td valign="top"><a href="Events.html#index-mouse_002dbutton_002devent_002dwindow_002did"><code>mouse-button-event-window-id</code></a>:</td><td> </td><td valign="top"><a href="Events.html#Events">Events</a></td></tr> +<tr><td></td><td valign="top"><a href="Events.html#index-mouse_002dbutton_002devent_002dx"><code>mouse-button-event-x</code></a>:</td><td> </td><td valign="top"><a href="Events.html#Events">Events</a></td></tr> +<tr><td></td><td valign="top"><a href="Events.html#index-mouse_002dbutton_002devent_002dy"><code>mouse-button-event-y</code></a>:</td><td> </td><td valign="top"><a href="Events.html#Events">Events</a></td></tr> +<tr><td></td><td valign="top"><a href="Events.html#index-mouse_002dbutton_002devent_003f"><code>mouse-button-event?</code></a>:</td><td> </td><td valign="top"><a href="Events.html#Events">Events</a></td></tr> +<tr><td></td><td valign="top"><a href="Mouse.html#index-mouse_002dbutton_002dpressed_003f"><code>mouse-button-pressed?</code></a>:</td><td> </td><td valign="top"><a href="Mouse.html#Mouse">Mouse</a></td></tr> +<tr><td></td><td valign="top"><a href="Mouse.html#index-mouse_002dbutton_002dreleased_003f"><code>mouse-button-released?</code></a>:</td><td> </td><td valign="top"><a href="Mouse.html#Mouse">Mouse</a></td></tr> +<tr><td></td><td valign="top"><a href="Events.html#index-mouse_002dbutton_002dup_002devent_003f"><code>mouse-button-up-event?</code></a>:</td><td> </td><td valign="top"><a href="Events.html#Events">Events</a></td></tr> +<tr><td></td><td valign="top"><a href="Events.html#index-mouse_002dmotion_002devent_002dbuttons"><code>mouse-motion-event-buttons</code></a>:</td><td> </td><td valign="top"><a href="Events.html#Events">Events</a></td></tr> +<tr><td></td><td valign="top"><a href="Events.html#index-mouse_002dmotion_002devent_002dtimestamp"><code>mouse-motion-event-timestamp</code></a>:</td><td> </td><td valign="top"><a href="Events.html#Events">Events</a></td></tr> +<tr><td></td><td valign="top"><a href="Events.html#index-mouse_002dmotion_002devent_002dwhich"><code>mouse-motion-event-which</code></a>:</td><td> </td><td valign="top"><a href="Events.html#Events">Events</a></td></tr> +<tr><td></td><td valign="top"><a href="Events.html#index-mouse_002dmotion_002devent_002dwindow_002did"><code>mouse-motion-event-window-id</code></a>:</td><td> </td><td valign="top"><a href="Events.html#Events">Events</a></td></tr> +<tr><td></td><td valign="top"><a href="Events.html#index-mouse_002dmotion_002devent_002dx"><code>mouse-motion-event-x</code></a>:</td><td> </td><td valign="top"><a href="Events.html#Events">Events</a></td></tr> +<tr><td></td><td valign="top"><a href="Events.html#index-mouse_002dmotion_002devent_002dx_002drel"><code>mouse-motion-event-x-rel</code></a>:</td><td> </td><td valign="top"><a href="Events.html#Events">Events</a></td></tr> +<tr><td></td><td valign="top"><a href="Events.html#index-mouse_002dmotion_002devent_002dy"><code>mouse-motion-event-y</code></a>:</td><td> </td><td valign="top"><a href="Events.html#Events">Events</a></td></tr> +<tr><td></td><td valign="top"><a href="Events.html#index-mouse_002dmotion_002devent_002dy_002drel"><code>mouse-motion-event-y-rel</code></a>:</td><td> </td><td valign="top"><a href="Events.html#Events">Events</a></td></tr> +<tr><td></td><td valign="top"><a href="Events.html#index-mouse_002dmotion_002devent_003f"><code>mouse-motion-event?</code></a>:</td><td> </td><td valign="top"><a href="Events.html#Events">Events</a></td></tr> +<tr><td></td><td valign="top"><a href="Mouse.html#index-mouse_002dx"><code>mouse-x</code></a>:</td><td> </td><td valign="top"><a href="Mouse.html#Mouse">Mouse</a></td></tr> +<tr><td></td><td valign="top"><a href="Mouse.html#index-mouse_002dy"><code>mouse-y</code></a>:</td><td> </td><td valign="top"><a href="Mouse.html#Mouse">Mouse</a></td></tr> +<tr><td></td><td valign="top"><a href="Sound.html#index-music_002dpaused_003f"><code>music-paused?</code></a>:</td><td> </td><td valign="top"><a href="Sound.html#Sound">Sound</a></td></tr> +<tr><td></td><td valign="top"><a href="Sound.html#index-music_002dplaying_003f"><code>music-playing?</code></a>:</td><td> </td><td valign="top"><a href="Sound.html#Sound">Sound</a></td></tr> +<tr><td></td><td valign="top"><a href="Sound.html#index-music_002dvolume"><code>music-volume</code></a>:</td><td> </td><td valign="top"><a href="Sound.html#Sound">Sound</a></td></tr> +<tr><td></td><td valign="top"><a href="Sound.html#index-music_003f"><code>music?</code></a>:</td><td> </td><td valign="top"><a href="Sound.html#Sound">Sound</a></td></tr> +<tr><td colspan="4"> <hr></td></tr> +<tr><th><a name="Index_fn_letter-N">N</a></th><td></td><td></td></tr> +<tr><td></td><td valign="top"><a href="Joysticks.html#index-num_002djoysticks"><code>num-joysticks</code></a>:</td><td> </td><td valign="top"><a href="Joysticks.html#Joysticks">Joysticks</a></td></tr> +<tr><td colspan="4"> <hr></td></tr> +<tr><th><a name="Index_fn_letter-O">O</a></th><td></td><td></td></tr> +<tr><td></td><td valign="top"><a href="Sound.html#index-open_002daudio"><code>open-audio</code></a>:</td><td> </td><td valign="top"><a href="Sound.html#Sound">Sound</a></td></tr> +<tr><td></td><td valign="top"><a href="Game-Controllers.html#index-open_002dgame_002dcontroller"><code>open-game-controller</code></a>:</td><td> </td><td valign="top"><a href="Game-Controllers.html#Game-Controllers">Game Controllers</a></td></tr> +<tr><td></td><td valign="top"><a href="Joysticks.html#index-open_002djoystick"><code>open-joystick</code></a>:</td><td> </td><td valign="top"><a href="Joysticks.html#Joysticks">Joysticks</a></td></tr> +<tr><td colspan="4"> <hr></td></tr> +<tr><th><a name="Index_fn_letter-P">P</a></th><td></td><td></td></tr> +<tr><td></td><td valign="top"><a href="Surfaces.html#index-palette_002dcolors"><code>palette-colors</code></a>:</td><td> </td><td valign="top"><a href="Surfaces.html#Surfaces">Surfaces</a></td></tr> +<tr><td></td><td valign="top"><a href="Surfaces.html#index-palette_002dlength"><code>palette-length</code></a>:</td><td> </td><td valign="top"><a href="Surfaces.html#Surfaces">Surfaces</a></td></tr> +<tr><td></td><td valign="top"><a href="Surfaces.html#index-palette_003f"><code>palette?</code></a>:</td><td> </td><td valign="top"><a href="Surfaces.html#Surfaces">Surfaces</a></td></tr> +<tr><td></td><td valign="top"><a href="Sound.html#index-pause_002dchannel_0021"><code>pause-channel!</code></a>:</td><td> </td><td valign="top"><a href="Sound.html#Sound">Sound</a></td></tr> +<tr><td></td><td valign="top"><a href="Sound.html#index-pause_002dmusic_0021"><code>pause-music!</code></a>:</td><td> </td><td valign="top"><a href="Sound.html#Sound">Sound</a></td></tr> +<tr><td></td><td valign="top"><a href="Sound.html#index-paused_002dchannels_002dcount"><code>paused-channels-count</code></a>:</td><td> </td><td valign="top"><a href="Sound.html#Sound">Sound</a></td></tr> +<tr><td></td><td valign="top"><a href="Surfaces.html#index-pixel_002dformat_002dalpha_002dmask"><code>pixel-format-alpha-mask</code></a>:</td><td> </td><td valign="top"><a href="Surfaces.html#Surfaces">Surfaces</a></td></tr> +<tr><td></td><td valign="top"><a href="Surfaces.html#index-pixel_002dformat_002dbits_002dper_002dpixel"><code>pixel-format-bits-per-pixel</code></a>:</td><td> </td><td valign="top"><a href="Surfaces.html#Surfaces">Surfaces</a></td></tr> +<tr><td></td><td valign="top"><a href="Surfaces.html#index-pixel_002dformat_002dblue_002dmask"><code>pixel-format-blue-mask</code></a>:</td><td> </td><td valign="top"><a href="Surfaces.html#Surfaces">Surfaces</a></td></tr> +<tr><td></td><td valign="top"><a href="Surfaces.html#index-pixel_002dformat_002dbytes_002dper_002dpixel"><code>pixel-format-bytes-per-pixel</code></a>:</td><td> </td><td valign="top"><a href="Surfaces.html#Surfaces">Surfaces</a></td></tr> +<tr><td></td><td valign="top"><a href="Surfaces.html#index-pixel_002dformat_002dgreen_002dmask"><code>pixel-format-green-mask</code></a>:</td><td> </td><td valign="top"><a href="Surfaces.html#Surfaces">Surfaces</a></td></tr> +<tr><td></td><td valign="top"><a href="Surfaces.html#index-pixel_002dformat_002dname"><code>pixel-format-name</code></a>:</td><td> </td><td valign="top"><a href="Surfaces.html#Surfaces">Surfaces</a></td></tr> +<tr><td></td><td valign="top"><a href="Surfaces.html#index-pixel_002dformat_002dpalette"><code>pixel-format-palette</code></a>:</td><td> </td><td valign="top"><a href="Surfaces.html#Surfaces">Surfaces</a></td></tr> +<tr><td></td><td valign="top"><a href="Surfaces.html#index-pixel_002dformat_002dred_002dmask"><code>pixel-format-red-mask</code></a>:</td><td> </td><td valign="top"><a href="Surfaces.html#Surfaces">Surfaces</a></td></tr> +<tr><td></td><td valign="top"><a href="Surfaces.html#index-pixel_002dformat_003f"><code>pixel-format?</code></a>:</td><td> </td><td valign="top"><a href="Surfaces.html#Surfaces">Surfaces</a></td></tr> +<tr><td></td><td valign="top"><a href="Sound.html#index-play_002dchunk_0021"><code>play-chunk!</code></a>:</td><td> </td><td valign="top"><a href="Sound.html#Sound">Sound</a></td></tr> +<tr><td></td><td valign="top"><a href="Sound.html#index-play_002dmusic_0021"><code>play-music!</code></a>:</td><td> </td><td valign="top"><a href="Sound.html#Sound">Sound</a></td></tr> +<tr><td></td><td valign="top"><a href="Sound.html#index-playing_002dchannels_002dcount"><code>playing-channels-count</code></a>:</td><td> </td><td valign="top"><a href="Sound.html#Sound">Sound</a></td></tr> +<tr><td></td><td valign="top"><a href="Events.html#index-poll_002devent"><code>poll-event</code></a>:</td><td> </td><td valign="top"><a href="Events.html#Events">Events</a></td></tr> +<tr><td></td><td valign="top"><a href="Rendering.html#index-present_002drenderer"><code>present-renderer</code></a>:</td><td> </td><td valign="top"><a href="Rendering.html#Rendering">Rendering</a></td></tr> +<tr><td colspan="4"> <hr></td></tr> +<tr><th><a name="Index_fn_letter-Q">Q</a></th><td></td><td></td></tr> +<tr><td></td><td valign="top"><a href="Events.html#index-quit_002devent_002dtimestamp"><code>quit-event-timestamp</code></a>:</td><td> </td><td valign="top"><a href="Events.html#Events">Events</a></td></tr> +<tr><td></td><td valign="top"><a href="Events.html#index-quit_002devent_003f"><code>quit-event?</code></a>:</td><td> </td><td valign="top"><a href="Events.html#Events">Events</a></td></tr> +<tr><td colspan="4"> <hr></td></tr> +<tr><th><a name="Index_fn_letter-R">R</a></th><td></td><td></td></tr> +<tr><td></td><td valign="top"><a href="Windows.html#index-raise_002dwindow_0021"><code>raise-window!</code></a>:</td><td> </td><td valign="top"><a href="Windows.html#Windows">Windows</a></td></tr> +<tr><td></td><td valign="top"><a href="Rects.html#index-rect_002dheight"><code>rect-height</code></a>:</td><td> </td><td valign="top"><a href="Rects.html#Rects">Rects</a></td></tr> +<tr><td></td><td valign="top"><a href="Rects.html#index-rect_002dwidth"><code>rect-width</code></a>:</td><td> </td><td valign="top"><a href="Rects.html#Rects">Rects</a></td></tr> +<tr><td></td><td valign="top"><a href="Rects.html#index-rect_002dx"><code>rect-x</code></a>:</td><td> </td><td valign="top"><a href="Rects.html#Rects">Rects</a></td></tr> +<tr><td></td><td valign="top"><a href="Rects.html#index-rect_002dy"><code>rect-y</code></a>:</td><td> </td><td valign="top"><a href="Rects.html#Rects">Rects</a></td></tr> +<tr><td></td><td valign="top"><a href="Rendering.html#index-render_002dcopy"><code>render-copy</code></a>:</td><td> </td><td valign="top"><a href="Rendering.html#Rendering">Rendering</a></td></tr> +<tr><td></td><td valign="top"><a href="Rendering.html#index-render_002ddraw_002dline"><code>render-draw-line</code></a>:</td><td> </td><td valign="top"><a href="Rendering.html#Rendering">Rendering</a></td></tr> +<tr><td></td><td valign="top"><a href="Rendering.html#index-render_002ddraw_002dlines"><code>render-draw-lines</code></a>:</td><td> </td><td valign="top"><a href="Rendering.html#Rendering">Rendering</a></td></tr> +<tr><td></td><td valign="top"><a href="Rendering.html#index-render_002ddraw_002dpoint"><code>render-draw-point</code></a>:</td><td> </td><td valign="top"><a href="Rendering.html#Rendering">Rendering</a></td></tr> +<tr><td></td><td valign="top"><a href="Rendering.html#index-render_002ddraw_002dpoints"><code>render-draw-points</code></a>:</td><td> </td><td valign="top"><a href="Rendering.html#Rendering">Rendering</a></td></tr> +<tr><td></td><td valign="top"><a href="Fonts.html#index-render_002dfont_002dblended"><code>render-font-blended</code></a>:</td><td> </td><td valign="top"><a href="Fonts.html#Fonts">Fonts</a></td></tr> +<tr><td></td><td valign="top"><a href="Fonts.html#index-render_002dfont_002dsolid"><code>render-font-solid</code></a>:</td><td> </td><td valign="top"><a href="Fonts.html#Fonts">Fonts</a></td></tr> +<tr><td></td><td valign="top"><a href="Rendering.html#index-renderer_003f"><code>renderer?</code></a>:</td><td> </td><td valign="top"><a href="Rendering.html#Rendering">Rendering</a></td></tr> +<tr><td></td><td valign="top"><a href="Windows.html#index-restore_002dwindow_0021"><code>restore-window!</code></a>:</td><td> </td><td valign="top"><a href="Windows.html#Windows">Windows</a></td></tr> +<tr><td></td><td valign="top"><a href="Sound.html#index-resume_002dchannel_0021"><code>resume-channel!</code></a>:</td><td> </td><td valign="top"><a href="Sound.html#Sound">Sound</a></td></tr> +<tr><td></td><td valign="top"><a href="Sound.html#index-resume_002dmusic_0021"><code>resume-music!</code></a>:</td><td> </td><td valign="top"><a href="Sound.html#Sound">Sound</a></td></tr> +<tr><td></td><td valign="top"><a href="Sound.html#index-rewind_002dmusic_0021"><code>rewind-music!</code></a>:</td><td> </td><td valign="top"><a href="Sound.html#Sound">Sound</a></td></tr> +<tr><td colspan="4"> <hr></td></tr> +<tr><th><a name="Index_fn_letter-S">S</a></th><td></td><td></td></tr> +<tr><td></td><td valign="top"><a href="Images.html#index-save_002dpng"><code>save-png</code></a>:</td><td> </td><td valign="top"><a href="Images.html#Images">Images</a></td></tr> +<tr><td></td><td valign="top"><a href="Basics.html#index-sdl_002dinit"><code>sdl-init</code></a>:</td><td> </td><td valign="top"><a href="Basics.html#Basics">Basics</a></td></tr> +<tr><td></td><td valign="top"><a href="Basics.html#index-sdl_002dquit"><code>sdl-quit</code></a>:</td><td> </td><td valign="top"><a href="Basics.html#Basics">Basics</a></td></tr> +<tr><td></td><td valign="top"><a href="Basics.html#index-sdl_002dticks"><code>sdl-ticks</code></a>:</td><td> </td><td valign="top"><a href="Basics.html#Basics">Basics</a></td></tr> +<tr><td></td><td valign="top"><a href="Basics.html#index-sdl_002dversion"><code>sdl-version</code></a>:</td><td> </td><td valign="top"><a href="Basics.html#Basics">Basics</a></td></tr> +<tr><td></td><td valign="top"><a href="Sound.html#index-set_002dchannel_002dvolume_0021"><code>set-channel-volume!</code></a>:</td><td> </td><td valign="top"><a href="Sound.html#Sound">Sound</a></td></tr> +<tr><td></td><td valign="top"><a href="Sound.html#index-set_002dchunk_002dvolume_0021"><code>set-chunk-volume!</code></a>:</td><td> </td><td valign="top"><a href="Sound.html#Sound">Sound</a></td></tr> +<tr><td></td><td valign="top"><a href="OpenGL.html#index-set_002dgl_002dattribute_0021"><code>set-gl-attribute!</code></a>:</td><td> </td><td valign="top"><a href="OpenGL.html#OpenGL">OpenGL</a></td></tr> +<tr><td></td><td valign="top"><a href="OpenGL.html#index-set_002dgl_002dswap_002dinterval_0021"><code>set-gl-swap-interval!</code></a>:</td><td> </td><td valign="top"><a href="OpenGL.html#OpenGL">OpenGL</a></td></tr> +<tr><td></td><td valign="top"><a href="Sound.html#index-set_002dmusic_002dvolume_0021"><code>set-music-volume!</code></a>:</td><td> </td><td valign="top"><a href="Sound.html#Sound">Sound</a></td></tr> +<tr><td></td><td valign="top"><a href="Windows.html#index-set_002dwindow_002dborder_0021"><code>set-window-border!</code></a>:</td><td> </td><td valign="top"><a href="Windows.html#Windows">Windows</a></td></tr> +<tr><td></td><td valign="top"><a href="Windows.html#index-set_002dwindow_002dfullscreen_0021"><code>set-window-fullscreen!</code></a>:</td><td> </td><td valign="top"><a href="Windows.html#Windows">Windows</a></td></tr> +<tr><td></td><td valign="top"><a href="Windows.html#index-set_002dwindow_002dposition_0021"><code>set-window-position!</code></a>:</td><td> </td><td valign="top"><a href="Windows.html#Windows">Windows</a></td></tr> +<tr><td></td><td valign="top"><a href="Windows.html#index-set_002dwindow_002dsize_0021"><code>set-window-size!</code></a>:</td><td> </td><td valign="top"><a href="Windows.html#Windows">Windows</a></td></tr> +<tr><td></td><td valign="top"><a href="Windows.html#index-set_002dwindow_002dtitle_0021"><code>set-window-title!</code></a>:</td><td> </td><td valign="top"><a href="Windows.html#Windows">Windows</a></td></tr> +<tr><td></td><td valign="top"><a href="Windows.html#index-show_002dwindow_0021"><code>show-window!</code></a>:</td><td> </td><td valign="top"><a href="Windows.html#Windows">Windows</a></td></tr> +<tr><td></td><td valign="top"><a href="Sound.html#index-stop_002dchannel_0021"><code>stop-channel!</code></a>:</td><td> </td><td valign="top"><a href="Sound.html#Sound">Sound</a></td></tr> +<tr><td></td><td valign="top"><a href="Sound.html#index-stop_002dmusic_0021"><code>stop-music!</code></a>:</td><td> </td><td valign="top"><a href="Sound.html#Sound">Sound</a></td></tr> +<tr><td></td><td valign="top"><a href="Rendering.html#index-surface_002d_003etexture"><code>surface->texture</code></a>:</td><td> </td><td valign="top"><a href="Rendering.html#Rendering">Rendering</a></td></tr> +<tr><td></td><td valign="top"><a href="Surfaces.html#index-surface_002dheight"><code>surface-height</code></a>:</td><td> </td><td valign="top"><a href="Surfaces.html#Surfaces">Surfaces</a></td></tr> +<tr><td></td><td valign="top"><a href="Surfaces.html#index-surface_002dpitch"><code>surface-pitch</code></a>:</td><td> </td><td valign="top"><a href="Surfaces.html#Surfaces">Surfaces</a></td></tr> +<tr><td></td><td valign="top"><a href="Surfaces.html#index-surface_002dpixel_002dformat"><code>surface-pixel-format</code></a>:</td><td> </td><td valign="top"><a href="Surfaces.html#Surfaces">Surfaces</a></td></tr> +<tr><td></td><td valign="top"><a href="Surfaces.html#index-surface_002dpixels"><code>surface-pixels</code></a>:</td><td> </td><td valign="top"><a href="Surfaces.html#Surfaces">Surfaces</a></td></tr> +<tr><td></td><td valign="top"><a href="Surfaces.html#index-surface_002dwidth"><code>surface-width</code></a>:</td><td> </td><td valign="top"><a href="Surfaces.html#Surfaces">Surfaces</a></td></tr> +<tr><td></td><td valign="top"><a href="OpenGL.html#index-swap_002dgl_002dwindow"><code>swap-gl-window</code></a>:</td><td> </td><td valign="top"><a href="OpenGL.html#OpenGL">OpenGL</a></td></tr> +<tr><td colspan="4"> <hr></td></tr> +<tr><th><a name="Index_fn_letter-T">T</a></th><td></td><td></td></tr> +<tr><td></td><td valign="top"><a href="Events.html#index-text_002dinput_002devent_002dtext"><code>text-input-event-text</code></a>:</td><td> </td><td valign="top"><a href="Events.html#Events">Events</a></td></tr> +<tr><td></td><td valign="top"><a href="Events.html#index-text_002dinput_002devent_002dtimestamp"><code>text-input-event-timestamp</code></a>:</td><td> </td><td valign="top"><a href="Events.html#Events">Events</a></td></tr> +<tr><td></td><td valign="top"><a href="Events.html#index-text_002dinput_002devent_002dwindow_002did"><code>text-input-event-window-id</code></a>:</td><td> </td><td valign="top"><a href="Events.html#Events">Events</a></td></tr> +<tr><td></td><td valign="top"><a href="Events.html#index-text_002dinput_002devent_003f"><code>text-input-event?</code></a>:</td><td> </td><td valign="top"><a href="Events.html#Events">Events</a></td></tr> +<tr><td></td><td valign="top"><a href="Fonts.html#index-ttf_002dinit"><code>ttf-init</code></a>:</td><td> </td><td valign="top"><a href="Fonts.html#Fonts">Fonts</a></td></tr> +<tr><td></td><td valign="top"><a href="Fonts.html#index-ttf_002dquit"><code>ttf-quit</code></a>:</td><td> </td><td valign="top"><a href="Fonts.html#Fonts">Fonts</a></td></tr> +<tr><td colspan="4"> <hr></td></tr> +<tr><th><a name="Index_fn_letter-W">W</a></th><td></td><td></td></tr> +<tr><td></td><td valign="top"><a href="Events.html#index-window_002dclosed_002devent_003f"><code>window-closed-event?</code></a>:</td><td> </td><td valign="top"><a href="Events.html#Events">Events</a></td></tr> +<tr><td></td><td valign="top"><a href="Events.html#index-window_002denter_002devent_003f"><code>window-enter-event?</code></a>:</td><td> </td><td valign="top"><a href="Events.html#Events">Events</a></td></tr> +<tr><td></td><td valign="top"><a href="Events.html#index-window_002devent_002dtimestamp"><code>window-event-timestamp</code></a>:</td><td> </td><td valign="top"><a href="Events.html#Events">Events</a></td></tr> +<tr><td></td><td valign="top"><a href="Events.html#index-window_002devent_002dtype"><code>window-event-type</code></a>:</td><td> </td><td valign="top"><a href="Events.html#Events">Events</a></td></tr> +<tr><td></td><td valign="top"><a href="Events.html#index-window_002devent_002dvector"><code>window-event-vector</code></a>:</td><td> </td><td valign="top"><a href="Events.html#Events">Events</a></td></tr> +<tr><td></td><td valign="top"><a href="Events.html#index-window_002devent_002dwindow_002did"><code>window-event-window-id</code></a>:</td><td> </td><td valign="top"><a href="Events.html#Events">Events</a></td></tr> +<tr><td></td><td valign="top"><a href="Events.html#index-window_002devent_003f"><code>window-event?</code></a>:</td><td> </td><td valign="top"><a href="Events.html#Events">Events</a></td></tr> +<tr><td></td><td valign="top"><a href="Events.html#index-window_002dexposed_002devent_003f"><code>window-exposed-event?</code></a>:</td><td> </td><td valign="top"><a href="Events.html#Events">Events</a></td></tr> +<tr><td></td><td valign="top"><a href="Events.html#index-window_002dfocus_002dgained_002devent_003f"><code>window-focus-gained-event?</code></a>:</td><td> </td><td valign="top"><a href="Events.html#Events">Events</a></td></tr> +<tr><td></td><td valign="top"><a href="Events.html#index-window_002dfocus_002dlost_002devent_003f"><code>window-focus-lost-event?</code></a>:</td><td> </td><td valign="top"><a href="Events.html#Events">Events</a></td></tr> +<tr><td></td><td valign="top"><a href="Events.html#index-window_002dhidden_002devent_003f"><code>window-hidden-event?</code></a>:</td><td> </td><td valign="top"><a href="Events.html#Events">Events</a></td></tr> +<tr><td></td><td valign="top"><a href="Windows.html#index-window_002did"><code>window-id</code></a>:</td><td> </td><td valign="top"><a href="Windows.html#Windows">Windows</a></td></tr> +<tr><td></td><td valign="top"><a href="Events.html#index-window_002dleave_002devent_003f"><code>window-leave-event?</code></a>:</td><td> </td><td valign="top"><a href="Events.html#Events">Events</a></td></tr> +<tr><td></td><td valign="top"><a href="Events.html#index-window_002dmaximized_002devent_003f"><code>window-maximized-event?</code></a>:</td><td> </td><td valign="top"><a href="Events.html#Events">Events</a></td></tr> +<tr><td></td><td valign="top"><a href="Events.html#index-window_002dminimized_002devent_003f"><code>window-minimized-event?</code></a>:</td><td> </td><td valign="top"><a href="Events.html#Events">Events</a></td></tr> +<tr><td></td><td valign="top"><a href="Events.html#index-window_002dmoved_002devent_003f"><code>window-moved-event?</code></a>:</td><td> </td><td valign="top"><a href="Events.html#Events">Events</a></td></tr> +<tr><td></td><td valign="top"><a href="Windows.html#index-window_002dposition"><code>window-position</code></a>:</td><td> </td><td valign="top"><a href="Windows.html#Windows">Windows</a></td></tr> +<tr><td></td><td valign="top"><a href="Events.html#index-window_002dresized_002devent_003f"><code>window-resized-event?</code></a>:</td><td> </td><td valign="top"><a href="Events.html#Events">Events</a></td></tr> +<tr><td></td><td valign="top"><a href="Events.html#index-window_002drestored_002devent_003f"><code>window-restored-event?</code></a>:</td><td> </td><td valign="top"><a href="Events.html#Events">Events</a></td></tr> +<tr><td></td><td valign="top"><a href="Events.html#index-window_002dshown_002devent_003f"><code>window-shown-event?</code></a>:</td><td> </td><td valign="top"><a href="Events.html#Events">Events</a></td></tr> +<tr><td></td><td valign="top"><a href="Windows.html#index-window_002dsize"><code>window-size</code></a>:</td><td> </td><td valign="top"><a href="Windows.html#Windows">Windows</a></td></tr> +<tr><td></td><td valign="top"><a href="Events.html#index-window_002dsize_002dchanged_002devent_003f"><code>window-size-changed-event?</code></a>:</td><td> </td><td valign="top"><a href="Events.html#Events">Events</a></td></tr> +<tr><td></td><td valign="top"><a href="Windows.html#index-window_002dtitle"><code>window-title</code></a>:</td><td> </td><td valign="top"><a href="Windows.html#Windows">Windows</a></td></tr> +<tr><td colspan="4"> <hr></td></tr> +</table> +<table><tr><th valign="top">Jump to: </th><td><a class="summary-letter" href="#Index_fn_symbol-1"><b>%</b></a> + +<br> +<a class="summary-letter" href="#Index_fn_letter-B"><b>B</b></a> + +<a class="summary-letter" href="#Index_fn_letter-C"><b>C</b></a> + +<a class="summary-letter" href="#Index_fn_letter-D"><b>D</b></a> + +<a class="summary-letter" href="#Index_fn_letter-F"><b>F</b></a> + +<a class="summary-letter" href="#Index_fn_letter-G"><b>G</b></a> + +<a class="summary-letter" href="#Index_fn_letter-H"><b>H</b></a> + +<a class="summary-letter" href="#Index_fn_letter-I"><b>I</b></a> + +<a class="summary-letter" href="#Index_fn_letter-J"><b>J</b></a> + +<a class="summary-letter" href="#Index_fn_letter-K"><b>K</b></a> + +<a class="summary-letter" href="#Index_fn_letter-L"><b>L</b></a> + +<a class="summary-letter" href="#Index_fn_letter-M"><b>M</b></a> + +<a class="summary-letter" href="#Index_fn_letter-N"><b>N</b></a> + +<a class="summary-letter" href="#Index_fn_letter-O"><b>O</b></a> + +<a class="summary-letter" href="#Index_fn_letter-P"><b>P</b></a> + +<a class="summary-letter" href="#Index_fn_letter-Q"><b>Q</b></a> + +<a class="summary-letter" href="#Index_fn_letter-R"><b>R</b></a> + +<a class="summary-letter" href="#Index_fn_letter-S"><b>S</b></a> + +<a class="summary-letter" href="#Index_fn_letter-T"><b>T</b></a> + +<a class="summary-letter" href="#Index_fn_letter-W"><b>W</b></a> + +</td></tr></table> + +<hr> +<div class="header"> +<p> +Previous: <a href="Copying-This-Manual.html#Copying-This-Manual" accesskey="p" rel="prev">Copying This Manual</a>, Up: <a href="index.html#Top" accesskey="u" rel="up">Top</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p> +</div> + + + +</body> +</html> diff --git a/manuals/guile-sdl2/Input.html b/manuals/guile-sdl2/Input.html new file mode 100644 index 0000000..5020666 --- /dev/null +++ b/manuals/guile-sdl2/Input.html @@ -0,0 +1,114 @@ +<!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>Input (Guile-SDL2)</title> + +<meta name="description" content="Input (Guile-SDL2)"> +<meta name="keywords" content="Input (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="API-Reference.html#API-Reference" rel="up" title="API Reference"> +<link href="Keyboard.html#Keyboard" rel="next" title="Keyboard"> +<link href="OpenGL.html#OpenGL" rel="prev" title="OpenGL"> +<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="Input"></a> +<div class="header"> +<p> +Next: <a href="Events.html#Events" accesskey="n" rel="next">Events</a>, Previous: <a href="Window-Management.html#Window-Management" accesskey="p" rel="prev">Window Management</a>, Up: <a href="API-Reference.html#API-Reference" accesskey="u" rel="up">API Reference</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="Input-1"></a> +<h3 class="section">3.3 Input</h3> + +<table class="menu" border="0" cellspacing="0"> +<tr><td align="left" valign="top">• <a href="Keyboard.html#Keyboard" accesskey="1">Keyboard</a>:</td><td> </td><td align="left" valign="top">Keyboard input. +</td></tr> +<tr><td align="left" valign="top">• <a href="Mouse.html#Mouse" accesskey="2">Mouse</a>:</td><td> </td><td align="left" valign="top">Mouse input. +</td></tr> +<tr><td align="left" valign="top">• <a href="Joysticks.html#Joysticks" accesskey="3">Joysticks</a>:</td><td> </td><td align="left" valign="top">Joystick input. +</td></tr> +<tr><td align="left" valign="top">• <a href="Game-Controllers.html#Game-Controllers" accesskey="4">Game Controllers</a>:</td><td> </td><td align="left" valign="top">Game controller input. +</td></tr> +</table> + + + + +</body> +</html> diff --git a/manuals/guile-sdl2/Installation.html b/manuals/guile-sdl2/Installation.html new file mode 100644 index 0000000..26fc5e5 --- /dev/null +++ b/manuals/guile-sdl2/Installation.html @@ -0,0 +1,116 @@ +<!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>Installation (Guile-SDL2)</title> + +<meta name="description" content="Installation (Guile-SDL2)"> +<meta name="keywords" content="Installation (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="index.html#Top" rel="up" title="Top"> +<link href="Requirements.html#Requirements" rel="next" title="Requirements"> +<link href="Introduction.html#Introduction" rel="prev" title="Introduction"> +<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="Installation"></a> +<div class="header"> +<p> +Next: <a href="API-Reference.html#API-Reference" accesskey="n" rel="next">API Reference</a>, Previous: <a href="Introduction.html#Introduction" accesskey="p" rel="prev">Introduction</a>, Up: <a href="index.html#Top" accesskey="u" rel="up">Top</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="Installation-1"></a> +<h2 class="chapter">2 Installation</h2> + +<p>Guile-SDL2 is available for download from its website at +<a href="dthompson.us/projects/guile-sdl2.html">dthompson.us/projects/guile-sdl2.html</a>. This section describes +the software requirements of Guile-SDL2, as well as how to install it. +</p> +<p>The build procedure for Guile-SDL2 is the same as for GNU software +packages, and is not covered here. Please see the files +<samp>README.org</samp> and <samp>INSTALL.org</samp> for additional details. +</p> +<table class="menu" border="0" cellspacing="0"> +<tr><td align="left" valign="top">• <a href="Requirements.html#Requirements" accesskey="1">Requirements</a>:</td><td> </td><td align="left" valign="top">Software needed to build and run Guile-SDL2. +</td></tr> +</table> + + + + +</body> +</html> diff --git a/manuals/guile-sdl2/Introduction.html b/manuals/guile-sdl2/Introduction.html new file mode 100644 index 0000000..ac4ad50 --- /dev/null +++ b/manuals/guile-sdl2/Introduction.html @@ -0,0 +1,120 @@ +<!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>Introduction (Guile-SDL2)</title> + +<meta name="description" content="Introduction (Guile-SDL2)"> +<meta name="keywords" content="Introduction (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="index.html#Top" rel="up" title="Top"> +<link href="Installation.html#Installation" rel="next" title="Installation"> +<link href="index.html#Top" rel="prev" title="Top"> +<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="Introduction"></a> +<div class="header"> +<p> +Next: <a href="Installation.html#Installation" accesskey="n" rel="next">Installation</a>, Previous: <a href="index.html#Top" accesskey="p" rel="prev">Top</a>, Up: <a href="index.html#Top" accesskey="u" rel="up">Top</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="Introduction-1"></a> +<h2 class="chapter">1 Introduction</h2> + +<p>Guile-SDL2 provides both low-level and high-level Guile Scheme +bindings to the Simple DirectMedia Layer version 2.0 C library. The +bindings are written in pure Scheme by using Guile’s foreign function +interface. In addition to the SDL2 core library, bindings are also +provided for the SDL2_image, SDL2_mixer, and SDL2_ttf add-on +libraries. +</p> +<p>While Guile-SDL2 does provide direct, low-level bindings for the SDL2 +C API, its main feature is exposing high-level interfaces that Scheme +programmers will find comfortable to use, hiding away the ugly, +foreign C details. This manual will cover only the high-level API. +see <a href="API-Reference.html#API-Reference">API Reference</a> +</p> +<p>As of this writing, the bindings are useful, but <em>incomplete</em>. +If you find an SDL2 feature that you cannot use with Guile-SDL2, let +us know and maybe send a patch! see <a href="Contributing.html#Contributing">Contributing</a> +</p> + + + +</body> +</html> diff --git a/manuals/guile-sdl2/Joysticks.html b/manuals/guile-sdl2/Joysticks.html new file mode 100644 index 0000000..4ce9098 --- /dev/null +++ b/manuals/guile-sdl2/Joysticks.html @@ -0,0 +1,155 @@ +<!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>Joysticks (Guile-SDL2)</title> + +<meta name="description" content="Joysticks (Guile-SDL2)"> +<meta name="keywords" content="Joysticks (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="Input.html#Input" rel="up" title="Input"> +<link href="Game-Controllers.html#Game-Controllers" rel="next" title="Game Controllers"> +<link href="Mouse.html#Mouse" rel="prev" title="Mouse"> +<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="Joysticks"></a> +<div class="header"> +<p> +Next: <a href="Game-Controllers.html#Game-Controllers" accesskey="n" rel="next">Game Controllers</a>, Previous: <a href="Mouse.html#Mouse" accesskey="p" rel="prev">Mouse</a>, Up: <a href="Input.html#Input" accesskey="u" rel="up">Input</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="Joysticks-1"></a> +<h4 class="subsection">3.3.3 Joysticks</h4> + +<div class="example"> +<pre class="example">(use-modules (sdl2 input joystick)) +</pre></div> + +<dl> +<dt><a name="index-num_002djoysticks"></a>Procedure: <strong>num-joysticks</strong></dt> +<dd><p>Return the current number of connected joystick devices. +</p></dd></dl> + +<dl> +<dt><a name="index-open_002djoystick"></a>Procedure: <strong>open-joystick</strong> <em>device-index</em></dt> +<dd><p>Return a joystick object for the physical joystick device associated +with <var>device-index</var>. +</p></dd></dl> + +<dl> +<dt><a name="index-close_002djoystick"></a>Procedure: <strong>close-joystick</strong> <em>joystick</em></dt> +<dd><p>Close <var>joystick</var>. +</p></dd></dl> + +<dl> +<dt><a name="index-joystick_002dinstance_002did"></a>Procedure: <strong>joystick-instance-id</strong> <em>joystick</em></dt> +<dd><p>Return the instance id of <var>joystick</var>. +</p></dd></dl> + +<dl> +<dt><a name="index-joystick_002dpower_002dlevel"></a>Procedure: <strong>joystick-power-level</strong> <em>joystick</em></dt> +<dd><p>Return the symbolic battery power level for <var>joystick</var>, either +<code>unknown</code>, <code>empty</code>, <code>low</code>, <code>medium</code>, <code>full</code>, +or <code>wired</code>. +</p></dd></dl> + +<dl> +<dt><a name="index-joystick_002dnum_002daxes"></a>Procedure: <strong>joystick-num-axes</strong> <em>joystick</em></dt> +<dd><p>Return the number of axes for <var>joystick</var>. +</p></dd></dl> + +<dl> +<dt><a name="index-joystick_002dnum_002dballs"></a>Procedure: <strong>joystick-num-balls</strong> <em>joystick</em></dt> +<dd><p>Return the number of balls for <var>joystick</var>. +</p></dd></dl> + +<dl> +<dt><a name="index-joystick_002dnum_002dbuttons"></a>Procedure: <strong>joystick-num-buttons</strong> <em>joystick</em></dt> +<dd><p>Return the number of buttons for <var>joystick</var>. +</p></dd></dl> + +<dl> +<dt><a name="index-joystick_002dnum_002dhats"></a>Procedure: <strong>joystick-num-hats</strong> <em>joystick</em></dt> +<dd><p>Return the number of hats for <var>joystick</var>. +</p></dd></dl> + + + + +</body> +</html> diff --git a/manuals/guile-sdl2/Keyboard.html b/manuals/guile-sdl2/Keyboard.html new file mode 100644 index 0000000..7acfd81 --- /dev/null +++ b/manuals/guile-sdl2/Keyboard.html @@ -0,0 +1,117 @@ +<!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>Keyboard (Guile-SDL2)</title> + +<meta name="description" content="Keyboard (Guile-SDL2)"> +<meta name="keywords" content="Keyboard (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="Input.html#Input" rel="up" title="Input"> +<link href="Mouse.html#Mouse" rel="next" title="Mouse"> +<link href="Input.html#Input" rel="prev" title="Input"> +<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="Keyboard"></a> +<div class="header"> +<p> +Next: <a href="Mouse.html#Mouse" accesskey="n" rel="next">Mouse</a>, Up: <a href="Input.html#Input" accesskey="u" rel="up">Input</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="Keyboard-1"></a> +<h4 class="subsection">3.3.1 Keyboard</h4> + +<div class="example"> +<pre class="example">(use-modules (sdl2 input keyboard)) +</pre></div> + +<dl> +<dt><a name="index-key_002dpressed_003f"></a>Procedure: <strong>key-pressed?</strong> <em>key</em></dt> +<dd><p>Return <code>#t</code> if <var>key</var> is currently being pressed. +</p></dd></dl> + +<dl> +<dt><a name="index-key_002dreleased_003f"></a>Procedure: <strong>key-released?</strong> <em>key</em></dt> +<dd><p>Return <code>#t</code> is <var>key</var> is not currently being pressed. +</p></dd></dl> + + + + +</body> +</html> diff --git a/manuals/guile-sdl2/Mouse.html b/manuals/guile-sdl2/Mouse.html new file mode 100644 index 0000000..8b79e72 --- /dev/null +++ b/manuals/guile-sdl2/Mouse.html @@ -0,0 +1,127 @@ +<!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>Mouse (Guile-SDL2)</title> + +<meta name="description" content="Mouse (Guile-SDL2)"> +<meta name="keywords" content="Mouse (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="Input.html#Input" rel="up" title="Input"> +<link href="Joysticks.html#Joysticks" rel="next" title="Joysticks"> +<link href="Keyboard.html#Keyboard" rel="prev" title="Keyboard"> +<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="Mouse"></a> +<div class="header"> +<p> +Next: <a href="Joysticks.html#Joysticks" accesskey="n" rel="next">Joysticks</a>, Previous: <a href="Keyboard.html#Keyboard" accesskey="p" rel="prev">Keyboard</a>, Up: <a href="Input.html#Input" accesskey="u" rel="up">Input</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="Mouse-1"></a> +<h4 class="subsection">3.3.2 Mouse</h4> + +<div class="example"> +<pre class="example">(use-modules (sdl2 input mouse)) +</pre></div> + +<dl> +<dt><a name="index-mouse_002dx"></a>Procedure: <strong>mouse-x</strong></dt> +<dd><p>Return the x coordinate of the mouse cursor. +</p></dd></dl> + +<dl> +<dt><a name="index-mouse_002dy"></a>Procedure: <strong>mouse-y</strong></dt> +<dd><p>Return the y coordinate of the mouse cursor. +</p></dd></dl> + +<dl> +<dt><a name="index-mouse_002dbutton_002dpressed_003f"></a>Procedure: <strong>mouse-button-pressed?</strong> <em>button</em></dt> +<dd><p>Return <code>#t</code> if <var>button</var> is currently being pressed. +</p></dd></dl> + +<dl> +<dt><a name="index-mouse_002dbutton_002dreleased_003f"></a>Procedure: <strong>mouse-button-released?</strong> <em>button</em></dt> +<dd><p>Return <code>#t</code> if <var>button</var> is not currently being pressed. +</p></dd></dl> + + + + +</body> +</html> diff --git a/manuals/guile-sdl2/OpenGL.html b/manuals/guile-sdl2/OpenGL.html new file mode 100644 index 0000000..e05fa3f --- /dev/null +++ b/manuals/guile-sdl2/OpenGL.html @@ -0,0 +1,174 @@ +<!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>OpenGL (Guile-SDL2)</title> + +<meta name="description" content="OpenGL (Guile-SDL2)"> +<meta name="keywords" content="OpenGL (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="Input.html#Input" rel="next" title="Input"> +<link href="Windows.html#Windows" rel="prev" title="Windows"> +<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="OpenGL"></a> +<div class="header"> +<p> +Previous: <a href="Windows.html#Windows" accesskey="p" rel="prev">Windows</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> +</div> +<hr> +<a name="OpenGL-1"></a> +<h4 class="subsection">3.2.2 OpenGL</h4> + +<dl> +<dt><a name="index-make_002dgl_002dcontext"></a>Procedure: <strong>make-gl-context</strong> <em>window</em></dt> +<dd><p>Create an OpenGL context for <var>window</var>. +</p></dd></dl> + +<dl> +<dt><a name="index-delete_002dgl_002dcontext_0021"></a>Procedure: <strong>delete-gl-context!</strong> <em>context</em></dt> +<dd><p>Delete <var>context</var>, an OpenGL context object. +</p></dd></dl> + +<dl> +<dt><a name="index-call_002dwith_002dgl_002dcontext"></a>Procedure: <strong>call-with-gl-context</strong> <em>window proc</em></dt> +<dd><p>Call <var>proc</var> with a new OpenGL context created for <var>window</var>, and +close the context when <var>proc</var> returns or otherwise exits. +</p></dd></dl> + +<dl> +<dt><a name="index-swap_002dgl_002dwindow"></a>Procedure: <strong>swap-gl-window</strong> <em>window</em></dt> +<dd><p>Update <var>window</var> with OpenGL rendering. +</p></dd></dl> + +<dl> +<dt><a name="index-set_002dgl_002dattribute_0021"></a>Procedure: <strong>set-gl-attribute!</strong> <em>attr value</em></dt> +<dd><p>Set the OpenGL attribute represented by the symbol <var>attr</var> to +<var>value</var>. Possible values for <var>attr</var> are: +</p> +<ul> +<li> <code>red-size</code> +</li><li> <code>green-size</code> +</li><li> <code>blue-size</code> +</li><li> <code>alpha-size</code> +</li><li> <code>buffer-size</code> +</li><li> <code>double-buffer</code> +</li><li> <code>depth-size</code> +</li><li> <code>stencil-size</code> +</li><li> <code>accum-red-size</code> +</li><li> <code>accum-green-size</code> +</li><li> <code>accum-blue-size</code> +</li><li> <code>stereo</code> +</li><li> <code>multisample-buffers</code> +</li><li> <code>multisample-samples</code> +</li><li> <code>retained-backing</code> +</li><li> <code>context-major-version</code> +</li><li> <code>context-minor-version</code> +</li><li> <code>context-egl</code> +</li><li> <code>context-flags</code> +</li><li> <code>context-profile-mask</code> +</li><li> <code>share-with-current-context</code> +</li><li> <code>framebuffer-srgb-capable</code> +</li></ul> + +</dd></dl> + +<dl> +<dt><a name="index-set_002dgl_002dswap_002dinterval_0021"></a>Procedure: <strong>set-gl-swap-interval!</strong> <em>interval</em></dt> +<dd><p>Set the framebuffer swap interval for the current OpenGL context to the +type indicated by the symbol <var>interval</var>. Possible values of +<var>interval</var> are: +</p> +<ul> +<li> <code>immediate</code>, for immediate updates +</li><li> <code>vsync</code>, for updates synchronized with the screen’s vertical retrace +</li><li> <code>late-swap-tear</code>, for late swap tearing +</li></ul> + +<p>Late swap tearing works the same as vsync, but if the vertical retrace +has been missed for a given frame, buffers are swapped immediately, +which might be less jarring for the user during occasional framerate +drops. +</p></dd></dl> + + + + +</body> +</html> diff --git a/manuals/guile-sdl2/Rects.html b/manuals/guile-sdl2/Rects.html new file mode 100644 index 0000000..1b5693f --- /dev/null +++ b/manuals/guile-sdl2/Rects.html @@ -0,0 +1,133 @@ +<!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>Rects (Guile-SDL2)</title> + +<meta name="description" content="Rects (Guile-SDL2)"> +<meta name="keywords" content="Rects (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="API-Reference.html#API-Reference" rel="up" title="API Reference"> +<link href="Surfaces.html#Surfaces" rel="next" title="Surfaces"> +<link href="Events.html#Events" rel="prev" title="Events"> +<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="Rects"></a> +<div class="header"> +<p> +Next: <a href="Surfaces.html#Surfaces" accesskey="n" rel="next">Surfaces</a>, Previous: <a href="Events.html#Events" accesskey="p" rel="prev">Events</a>, Up: <a href="API-Reference.html#API-Reference" accesskey="u" rel="up">API Reference</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="Rects-1"></a> +<h3 class="section">3.5 Rects</h3> + +<div class="example"> +<pre class="example">(use-modules (sdl2 rect)) +</pre></div> + +<dl> +<dt><a name="index-make_002drect"></a>Procedure: <strong>make-rect</strong> <em><var>x</var> <var>y</var> <var>width</var> <var>height</var></em></dt> +<dd><p>Return a new rectangle whose upper-left corner is at (<var>x</var>, +<var>y</var>) and is <var>width</var> pixels wide and <var>height</var> pixels high. +</p></dd></dl> + +<dl> +<dt><a name="index-rect_002dx"></a>Procedure: <strong>rect-x</strong> <em><var>rect</var></em></dt> +<dd><p>Return the X coordinate of <var>rect</var>. +</p></dd></dl> + +<dl> +<dt><a name="index-rect_002dy"></a>Procedure: <strong>rect-y</strong> <em><var>rect</var></em></dt> +<dd><p>Return the Y coordinate of <var>rect</var>. +</p></dd></dl> + +<dl> +<dt><a name="index-rect_002dwidth"></a>Procedure: <strong>rect-width</strong> <em><var>rect</var></em></dt> +<dd><p>Return the width of <var>rect</var>. +</p></dd></dl> + +<dl> +<dt><a name="index-rect_002dheight"></a>Procedure: <strong>rect-height</strong> <em><var>rect</var></em></dt> +<dd><p>Return the height of <var>rect</var>. +</p></dd></dl> + + + + +</body> +</html> diff --git a/manuals/guile-sdl2/Rendering.html b/manuals/guile-sdl2/Rendering.html new file mode 100644 index 0000000..236d4e8 --- /dev/null +++ b/manuals/guile-sdl2/Rendering.html @@ -0,0 +1,191 @@ +<!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>Rendering (Guile-SDL2)</title> + +<meta name="description" content="Rendering (Guile-SDL2)"> +<meta name="keywords" content="Rendering (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="API-Reference.html#API-Reference" rel="up" title="API Reference"> +<link href="Images.html#Images" rel="next" title="Images"> +<link href="Surfaces.html#Surfaces" rel="prev" title="Surfaces"> +<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="Rendering"></a> +<div class="header"> +<p> +Next: <a href="Images.html#Images" accesskey="n" rel="next">Images</a>, Previous: <a href="Surfaces.html#Surfaces" accesskey="p" rel="prev">Surfaces</a>, Up: <a href="API-Reference.html#API-Reference" accesskey="u" rel="up">API Reference</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="Rendering-1"></a> +<h3 class="section">3.7 Rendering</h3> + +<div class="example"> +<pre class="example">(use-modules (sdl2 render)) +</pre></div> + +<dl> +<dt><a name="index-make_002drenderer"></a>Procedure: <strong>make-renderer</strong> <em>window [#:optional flags='(accelerated vsync)]</em></dt> +<dd><p>Return a new renderer for <var>window</var> created with the options specified +in <var>flags</var>, a list of symbols. The valid symbols that may appear in +<var>flags</var> are: +</p> +<ul> +<li> software, to use a software renderer fallback +</li><li> accelerated, to use hardware acceleration +</li><li> vsync, to synchronize rendering with the monitor’s refresh rate +</li><li> texture, for render to texture support +</li></ul> +</dd></dl> + +<dl> +<dt><a name="index-renderer_003f"></a>Procedure: <strong>renderer?</strong> <em>r</em></dt> +<dd><p>Return <code>#t</code> if <var>r</var> is a renderer. +</p></dd></dl> + +<dl> +<dt><a name="index-delete_002drenderer_0021"></a>Procedure: <strong>delete-renderer!</strong> <em>renderer</em></dt> +<dd><p>Delete the rendering context <var>renderer</var>. +</p></dd></dl> + +<dl> +<dt><a name="index-call_002dwith_002drenderer"></a>Procedure: <strong>call-with-renderer</strong> <em>renderer proc</em></dt> +<dd><p>Call <var>proc</var>, passing it <var>renderer</var> and closing <var>renderer</var> upon exit +of <var>proc</var>. +</p></dd></dl> + +<dl> +<dt><a name="index-clear_002drenderer"></a>Procedure: <strong>clear-renderer</strong> <em>renderer</em></dt> +<dd><p>Clear the rendering target <var>renderer</var> with the current drawing color. +</p></dd></dl> + +<dl> +<dt><a name="index-present_002drenderer"></a>Procedure: <strong>present-renderer</strong> <em>renderer</em></dt> +<dd><p>Display <var>renderer</var>. +</p></dd></dl> + +<dl> +<dt><a name="index-render_002dcopy"></a>Procedure: <strong>render-copy</strong> <em>renderer texture [#:angle 0] [#:srcrect] [#:dstrect] [#:center]</em></dt> +<dd><p>Copy <var>texture</var> to the rendering target of <var>renderer</var>. +</p></dd></dl> + +<dl> +<dt><a name="index-render_002ddraw_002dline"></a>Procedure: <strong>render-draw-line</strong> <em>renderer x1 y1 x2 y2</em></dt> +<dd><p>Draw a line from (<var>x1</var>, <var>y1</var>) to (<var>x2</var>, <var>y2</var>) on the +current rendering target of <var>renderer</var>. +</p></dd></dl> + +<dl> +<dt><a name="index-render_002ddraw_002dlines"></a>Procedure: <strong>render-draw-lines</strong> <em>renderer point</em></dt> +<dd><p>Draw a series of connected lines from <var>points</var> on the current +rendering target of <var>renderer</var>. +</p></dd></dl> + +<dl> +<dt><a name="index-render_002ddraw_002dpoint"></a>Procedure: <strong>render-draw-point</strong> <em>renderer x y</em></dt> +<dd><p>Draw a point at (<var>x</var>, <var>y</var>) on the current rendering target +of <var>renderer</var>. +</p></dd></dl> + +<dl> +<dt><a name="index-render_002ddraw_002dpoints"></a>Procedure: <strong>render-draw-points</strong> <em>renderer points</em></dt> +<dd><p>Draw a multiple points from <var>points</var> on the current rendering +target of <var>renderer</var>. +</p></dd></dl> + +<dl> +<dt><a name="index-surface_002d_003etexture"></a>Procedure: <strong>surface->texture</strong> <em>renderer surface</em></dt> +<dd><p>Convert <var>surface</var> to a texture suitable for <var>renderer</var>. +</p></dd></dl> + +<dl> +<dt><a name="index-delete_002dtexture_0021"></a>Procedure: <strong>delete-texture!</strong> <em>texture</em></dt> +<dd><p>Free the memory used by <var>texture</var>. +</p></dd></dl> + +<hr> +<div class="header"> +<p> +Next: <a href="Images.html#Images" accesskey="n" rel="next">Images</a>, Previous: <a href="Surfaces.html#Surfaces" accesskey="p" rel="prev">Surfaces</a>, Up: <a href="API-Reference.html#API-Reference" accesskey="u" rel="up">API Reference</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> diff --git a/manuals/guile-sdl2/Requirements.html b/manuals/guile-sdl2/Requirements.html new file mode 100644 index 0000000..17cd527 --- /dev/null +++ b/manuals/guile-sdl2/Requirements.html @@ -0,0 +1,118 @@ +<!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>Requirements (Guile-SDL2)</title> + +<meta name="description" content="Requirements (Guile-SDL2)"> +<meta name="keywords" content="Requirements (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="Installation.html#Installation" rel="up" title="Installation"> +<link href="API-Reference.html#API-Reference" rel="next" title="API Reference"> +<link href="Installation.html#Installation" rel="prev" title="Installation"> +<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="Requirements"></a> +<div class="header"> +<p> +Up: <a href="Installation.html#Installation" accesskey="u" rel="up">Installation</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="Requirements-1"></a> +<h3 class="section">2.1 Requirements</h3> + +<p>Guile-SDL2 depends on the following packages: +</p> +<ul> +<li> <a href="https://gnu.org/software/guile">GNU Guile</a>, version 2.0.11 or later; +</li><li> <a href="https://libsdl.org">SDL2</a>, version 2.0.0 or later; +</li></ul> + +<p>Guile-SDL2 has the following optional dependencies: +</p> +<ul> +<li> <a href="https://www.libsdl.org/projects/SDL_image">SDL2_image</a>, version 2.0.0 or later; +</li><li> <a href="https://www.libsdl.org/projects/SDL_mixer">SDL2_mixer</a>, version 2.0.0 or later; +</li><li> <a href="https://www.libsdl.org/projects/SDL_ttf">SDL2_ttf</a>, version 2.0.0 or later; +</li></ul> + + + + +</body> +</html> diff --git a/manuals/guile-sdl2/Sound.html b/manuals/guile-sdl2/Sound.html new file mode 100644 index 0000000..f98ceb7 --- /dev/null +++ b/manuals/guile-sdl2/Sound.html @@ -0,0 +1,312 @@ +<!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>Sound (Guile-SDL2)</title> + +<meta name="description" content="Sound (Guile-SDL2)"> +<meta name="keywords" content="Sound (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="API-Reference.html#API-Reference" rel="up" title="API Reference"> +<link href="Fonts.html#Fonts" rel="next" title="Fonts"> +<link href="Images.html#Images" rel="prev" title="Images"> +<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="Sound"></a> +<div class="header"> +<p> +Next: <a href="Fonts.html#Fonts" accesskey="n" rel="next">Fonts</a>, Previous: <a href="Images.html#Images" accesskey="p" rel="prev">Images</a>, Up: <a href="API-Reference.html#API-Reference" accesskey="u" rel="up">API Reference</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="Sound-1"></a> +<h3 class="section">3.9 Sound</h3> + +<div class="example"> +<pre class="example">(use-modules (sdl2 mixer)) +</pre></div> + +<dl> +<dt><a name="index-_0025default_002dfrequency"></a>Scheme Variable: <strong>%default-frequency</strong></dt> +</dl> + +<dl> +<dt><a name="index-_0025default_002dformat"></a>Scheme Variable: <strong>%default-format</strong></dt> +</dl> + +<dl> +<dt><a name="index-_0025default_002dchunk_002dsize"></a>Scheme Variable: <strong>%default-chunk-size</strong></dt> +</dl> + +<dl> +<dt><a name="index-mixer_002dinit"></a>Procedure: <strong>mixer-init</strong> <em>[#:optional formats='(flac mod modplug mp3 ogg fluidsynth)]</em></dt> +<dd><p>Initialize mixer library with support for <var>formats</var>, a list of +symbols representing audio file formats. Possible formats are: +</p> +<ul> +<li> flac +</li><li> mod +</li><li> modplug +</li><li> mp3 +</li><li> ogg +</li><li> fluidsynth +</li></ul> +</dd></dl> + +<dl> +<dt><a name="index-mixer_002dquit"></a>Procedure: <strong>mixer-quit</strong></dt> +<dd><p>Shutdown mixer library. +</p></dd></dl> + +<dl> +<dt><a name="index-open_002daudio"></a>Procedure: <strong>open-audio</strong> <em>[#:frequency=%default-frequency] [#:format=%default-format] [#:stereo?=#t] [#:chunk-size=%default-chunk-size]</em></dt> +<dd><p>Initialize the mixer API. <var>frequency</var> specificies the sample rate in +hertz. When <var>stereo?</var> is <code>#t</code>, two output channels are used, otherwise +mono output is used instead. <var>chunk-size</var> specifies the number of bytes +used per output sample. <var>format</var> is a symbol that specifies the output +sample format. Possible values are: +</p> +<ul> +<li> u8 +</li><li> s8 +</li><li> u16lsb +</li><li> s16lsb +</li><li> u16msb +</li><li> s16msb +</li><li> u16 +</li><li> s16 +</li><li> s32lsb +</li><li> s32msb +</li><li> s32 +</li><li> f32lsb +</li><li> f32msb +</li><li> f32 +</li></ul> +</dd></dl> + +<dl> +<dt><a name="index-close_002daudio"></a>Procedure: <strong>close-audio</strong></dt> +<dd><p>Shut down the mixer API. +</p></dd></dl> + +<dl> +<dt><a name="index-chunk_003f"></a>Procedure: <strong>chunk?</strong> <em>c</em></dt> +<dd><p>Return <code>#t</code> if <var>c</var> is a chunk. +</p></dd></dl> + +<dl> +<dt><a name="index-load_002dchunk"></a>Procedure: <strong>load-chunk</strong> <em>file</em></dt> +<dd><p>Load the audio data in <var>file</var> and return an audio chunk. +</p></dd></dl> + +<dl> +<dt><a name="index-delete_002dchunk_0021"></a>Procedure: <strong>delete-chunk!</strong> <em>chunk</em></dt> +<dd><p>Free the memory used for <var>chunk</var>. +</p></dd></dl> + +<dl> +<dt><a name="index-set_002dchunk_002dvolume_0021"></a>Procedure: <strong>set-chunk-volume!</strong> <em>chunk volume</em></dt> +<dd><p>Set the loudness of <var>chunk</var> to <var>volume</var>, an integer in the range +[0,128]. Return the previous chunk volume setting. +</p></dd></dl> + +<dl> +<dt><a name="index-play_002dchunk_0021"></a>Procedure: <strong>play-chunk!</strong> <em>chunk [#:loops=0] [#:channel]</em></dt> +<dd><p>Play <var>chunk</var> on <var>channel</var>, an integer channel identifier or <code>#f</code> +to use the first unreserved audio channel. <var>chunk</var> will play <var>loops</var> + +1 times. Return the channel identifier that <var>chunk</var> is played on. +</p></dd></dl> + +<dl> +<dt><a name="index-set_002dchannel_002dvolume_0021"></a>Procedure: <strong>set-channel-volume!</strong> <em>channel volume</em></dt> +<dd><p>Set the loudness of <var>channel</var>, an integer channel identifier or <code>#f</code> +for all channels, to <var>volume</var>, an integer in the range [0,128]. Return +the previous volume of <var>channel</var>, or the average of all channels if +<var>channel</var> is <code>#f</code>. +</p></dd></dl> + +<dl> +<dt><a name="index-pause_002dchannel_0021"></a>Procedure: <strong>pause-channel!</strong> <em>channel</em></dt> +<dd><p>Pause playback on <var>channel</var>, an integer channel identifier, or <code>#f</code> to +pause all channels. +</p></dd></dl> + +<dl> +<dt><a name="index-resume_002dchannel_0021"></a>Procedure: <strong>resume-channel!</strong> <em>channel</em></dt> +<dd><p>Resume playback on <var>channel</var>, an integer channel identifier, or <code>#f</code> to +resume all channels. +</p></dd></dl> + +<dl> +<dt><a name="index-stop_002dchannel_0021"></a>Procedure: <strong>stop-channel!</strong> <em>channel</em></dt> +<dd><p>Halt playback on <var>channel</var>, an integer channel identifier, or <code>#f</code> to +halt all channels. +</p></dd></dl> + +<dl> +<dt><a name="index-channel_002dplaying_003f"></a>Procedure: <strong>channel-playing?</strong> <em>channel</em></dt> +<dd><p>Return <code>#t</code> if <var>channel</var> is playing. +</p></dd></dl> + +<dl> +<dt><a name="index-playing_002dchannels_002dcount"></a>Procedure: <strong>playing-channels-count</strong></dt> +<dd><p>Return the number of channels currently playing. +</p></dd></dl> + +<dl> +<dt><a name="index-channel_002dpaused_003f"></a>Procedure: <strong>channel-paused?</strong> <em>channel</em></dt> +<dd><p>Return <code>#t</code> if <var>channel</var> is paused. +</p></dd></dl> + +<dl> +<dt><a name="index-paused_002dchannels_002dcount"></a>Procedure: <strong>paused-channels-count</strong></dt> +<dd><p>Return the number of channels that are paused. +</p></dd></dl> + +<dl> +<dt><a name="index-music_003f"></a>Procedure: <strong>music?</strong> <em>m</em></dt> +<dd><p>Return <code>#t</code> if <var>m</var> is music. +</p></dd></dl> + +<dl> +<dt><a name="index-load_002dmusic"></a>Procedure: <strong>load-music</strong> <em>file</em></dt> +<dd><p>Load music from <var>file</var>. +</p></dd></dl> + +<dl> +<dt><a name="index-delete_002dmusic_0021"></a>Procedure: <strong>delete-music!</strong> <em>music</em></dt> +<dd><p>Delete the memory used for <var>music</var>. +</p></dd></dl> + +<dl> +<dt><a name="index-play_002dmusic_0021"></a>Procedure: <strong>play-music!</strong> <em>music [#:optional loops=1]</em></dt> +<dd><p>Play <var>music</var>, repeated <var>loops</var> times. <var>loops</var> may be <code>#f</code>, in +which case the music loops indefinitely. +</p></dd></dl> + +<dl> +<dt><a name="index-set_002dmusic_002dvolume_0021"></a>Procedure: <strong>set-music-volume!</strong> <em>volume</em></dt> +<dd><p>Set music loudness to <var>volume</var>, an integer in the range [0,128]. Return the +previous volume. +</p></dd></dl> + +<dl> +<dt><a name="index-music_002dvolume"></a>Procedure: <strong>music-volume</strong></dt> +<dd><p>Return the music volume. +</p></dd></dl> + +<dl> +<dt><a name="index-pause_002dmusic_0021"></a>Procedure: <strong>pause-music!</strong></dt> +<dd><p>Puase the music. +</p></dd></dl> + +<dl> +<dt><a name="index-resume_002dmusic_0021"></a>Procedure: <strong>resume-music!</strong></dt> +<dd><p>Resume music playback. +</p></dd></dl> + +<dl> +<dt><a name="index-rewind_002dmusic_0021"></a>Procedure: <strong>rewind-music!</strong></dt> +<dd><p>Start music playback from the beginning. Rewinding is only supported for MOD, +OGG, MP3, and native MIDI music. +</p></dd></dl> + +<dl> +<dt><a name="index-stop_002dmusic_0021"></a>Procedure: <strong>stop-music!</strong></dt> +<dd><p>Halt music playback. +</p></dd></dl> + +<dl> +<dt><a name="index-music_002dplaying_003f"></a>Procedure: <strong>music-playing?</strong></dt> +<dd><p>Return <code>#t</code> if music is currently playing. +</p></dd></dl> + +<dl> +<dt><a name="index-music_002dpaused_003f"></a>Procedure: <strong>music-paused?</strong></dt> +<dd><p>Return <code>#t</code> if music is currently paused. +</p></dd></dl> + +<hr> +<div class="header"> +<p> +Next: <a href="Fonts.html#Fonts" accesskey="n" rel="next">Fonts</a>, Previous: <a href="Images.html#Images" accesskey="p" rel="prev">Images</a>, Up: <a href="API-Reference.html#API-Reference" accesskey="u" rel="up">API Reference</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> diff --git a/manuals/guile-sdl2/Submitting-Patches.html b/manuals/guile-sdl2/Submitting-Patches.html new file mode 100644 index 0000000..9b3b1a0 --- /dev/null +++ b/manuals/guile-sdl2/Submitting-Patches.html @@ -0,0 +1,106 @@ +<!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>Submitting Patches (Guile-SDL2)</title> + +<meta name="description" content="Submitting Patches (Guile-SDL2)"> +<meta name="keywords" content="Submitting Patches (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="Contributing.html#Contributing" rel="up" title="Contributing"> +<link href="Chat.html#Chat" rel="next" title="Chat"> +<link href="Getting-the-Source.html#Getting-the-Source" rel="prev" title="Getting the Source"> +<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="Submitting-Patches"></a> +<div class="header"> +<p> +Next: <a href="Chat.html#Chat" accesskey="n" rel="next">Chat</a>, Previous: <a href="Getting-the-Source.html#Getting-the-Source" accesskey="p" rel="prev">Getting the Source</a>, Up: <a href="Contributing.html#Contributing" accesskey="u" rel="up">Contributing</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="Submitting-Patches-1"></a> +<h3 class="section">4.2 Submitting Patches</h3> + +<p>Patches generated by <code>git format-patch</code> may be sent to +<a href="mailto:davet@gnu.org">davet@gnu.org</a>. Thanks in advance! +</p> + + + +</body> +</html> diff --git a/manuals/guile-sdl2/Surfaces.html b/manuals/guile-sdl2/Surfaces.html new file mode 100644 index 0000000..7a094fe --- /dev/null +++ b/manuals/guile-sdl2/Surfaces.html @@ -0,0 +1,316 @@ +<!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>Surfaces (Guile-SDL2)</title> + +<meta name="description" content="Surfaces (Guile-SDL2)"> +<meta name="keywords" content="Surfaces (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="API-Reference.html#API-Reference" rel="up" title="API Reference"> +<link href="Rendering.html#Rendering" rel="next" title="Rendering"> +<link href="Rects.html#Rects" rel="prev" title="Rects"> +<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="Surfaces"></a> +<div class="header"> +<p> +Next: <a href="Rendering.html#Rendering" accesskey="n" rel="next">Rendering</a>, Previous: <a href="Rects.html#Rects" accesskey="p" rel="prev">Rects</a>, Up: <a href="API-Reference.html#API-Reference" accesskey="u" rel="up">API Reference</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="Surfaces-1"></a> +<h3 class="section">3.6 Surfaces</h3> + +<div class="example"> +<pre class="example">(use-modules (sdl2 surface)) +</pre></div> + +<dl> +<dt><a name="index-color_003f"></a>Procedure: <strong>color?</strong> <em>c</em></dt> +<dd><p>Return <code>#t</code> if <var>c</var> is a color. +</p></dd></dl> + +<dl> +<dt><a name="index-color_002dr"></a>Procedure: <strong>color-r</strong> <em>c</em></dt> +</dl> + +<dl> +<dt><a name="index-color_002dg"></a>Procedure: <strong>color-g</strong> <em>c</em></dt> +</dl> + +<dl> +<dt><a name="index-color_002db"></a>Procedure: <strong>color-b</strong> <em>c</em></dt> +</dl> + +<dl> +<dt><a name="index-color_002da"></a>Procedure: <strong>color-a</strong> <em>c</em></dt> +</dl> + +<dl> +<dt><a name="index-palette_003f"></a>Procedure: <strong>palette?</strong> <em>p</em></dt> +<dd><p>Return <code>#t</code> if <var>p</var> is a palette. +</p></dd></dl> + +<dl> +<dt><a name="index-palette_002dlength"></a>Procedure: <strong>palette-length</strong> <em>palette</em></dt> +<dd><p>Return the number of colors in <var>palette</var>. +</p></dd></dl> + +<dl> +<dt><a name="index-palette_002dcolors"></a>Procedure: <strong>palette-colors</strong> <em>palette</em></dt> +<dd><p>Return the colors in <var>palette</var>. +</p></dd></dl> + +<dl> +<dt><a name="index-pixel_002dformat_003f"></a>Procedure: <strong>pixel-format?</strong> <em>pf</em></dt> +<dd><p>Return <code>#t</code> if <var>pf</var> is a pixel format. +</p></dd></dl> + +<dl> +<dt><a name="index-pixel_002dformat_002dname"></a>Procedure: <strong>pixel-format-name</strong> <em>pf</em></dt> +<dd><p>Return the symbolic name of the pixel format <var>pf</var>. +</p></dd></dl> + +<dl> +<dt><a name="index-pixel_002dformat_002dpalette"></a>Procedure: <strong>pixel-format-palette</strong> <em>pf</em></dt> +<dd><p>Return the palette for the pixel format <var>pf</var>. +</p></dd></dl> + +<dl> +<dt><a name="index-pixel_002dformat_002dbits_002dper_002dpixel"></a>Procedure: <strong>pixel-format-bits-per-pixel</strong> <em>pf</em></dt> +<dd><p>Return the number of bits per pixel for the pixel format <var>pf</var>. +</p></dd></dl> + +<dl> +<dt><a name="index-pixel_002dformat_002dbytes_002dper_002dpixel"></a>Procedure: <strong>pixel-format-bytes-per-pixel</strong> <em>pf</em></dt> +<dd><p>Return the number of bytes per pixel for the pixel format <var>pf</var>. +</p></dd></dl> + +<dl> +<dt><a name="index-pixel_002dformat_002dred_002dmask"></a>Procedure: <strong>pixel-format-red-mask</strong> <em>pf</em></dt> +<dd><p>Return the bitmask for the red component of a pixel in the pixel format +<var>pf</var>. +</p></dd></dl> + +<dl> +<dt><a name="index-pixel_002dformat_002dgreen_002dmask"></a>Procedure: <strong>pixel-format-green-mask</strong> <em>pf</em></dt> +<dd><p>Return the bitmask for the green component of a pixel in the pixel format +<var>pf</var>. +</p></dd></dl> + +<dl> +<dt><a name="index-pixel_002dformat_002dblue_002dmask"></a>Procedure: <strong>pixel-format-blue-mask</strong> <em>pf</em></dt> +<dd><p>Return the bitmask for the blue component of a pixel in the pixel format +<var>pf</var>. +</p></dd></dl> + +<dl> +<dt><a name="index-pixel_002dformat_002dalpha_002dmask"></a>Procedure: <strong>pixel-format-alpha-mask</strong> <em>pf</em></dt> +<dd><p>Return the bitmask for the alpha component of a pixel in the pixel format +<var>pf</var>. +</p></dd></dl> + +<dl> +<dt><a name="index-make_002drgb_002dsurface"></a>Procedure: <strong>make-rgb-surface</strong> <em>width height depth</em></dt> +<dd><p>Create a new SDL surface with the dimensions <var>width</var> and <var>height</var> and +<var>depth</var> bits per pixel. +</p></dd></dl> + +<dl> +<dt><a name="index-bytevector_002d_003esurface"></a>Procedure: <strong>bytevector->surface</strong> <em>bv width height depth pitch</em></dt> +<dd><p>Convert <var>bv</var>, a bytevector of pixel data with dimensions +<var>width</var>x<var>height</var>, to an SDL surface. Each pixel is <var>depth</var> bits in +size, and each row of pixels is <var>pitch</var> bytes in size. +</p></dd></dl> + +<dl> +<dt><a name="index-delete_002dsurface_0021"></a>Procedure: <strong>delete-surface!</strong> <em>surface</em></dt> +<dd><p>Free the memory used by <var>surface</var>. +</p></dd></dl> + +<dl> +<dt><a name="index-call_002dwith_002dsurface"></a>Procedure: <strong>call-with-surface</strong> <em>surface proc</em></dt> +<dd><p>Call <var>proc</var>, passing it <var>surface</var> and deleting <var>surface</var> upon exit +of <var>proc</var>. +</p></dd></dl> + +<dl> +<dt><a name="index-load_002dbmp"></a>Procedure: <strong>load-bmp</strong> <em>file</em></dt> +<dd><p>Create a new surface from the bitmap data in <var>file</var>. +</p></dd></dl> + +<dl> +<dt><a name="index-surface_002dwidth"></a>Procedure: <strong>surface-width</strong> <em>surface</em></dt> +<dd><p>Return the width of <var>surface</var> in pixels. +</p></dd></dl> + +<dl> +<dt><a name="index-surface_002dheight"></a>Procedure: <strong>surface-height</strong> <em>surface</em></dt> +<dd><p>Return the height of <var>surface</var> in pixels. +</p></dd></dl> + +<dl> +<dt><a name="index-surface_002dpitch"></a>Procedure: <strong>surface-pitch</strong> <em>surface</em></dt> +<dd><p>Return the length of a row of pixels in <var>surface</var> in bytes. +</p></dd></dl> + +<dl> +<dt><a name="index-surface_002dpixels"></a>Procedure: <strong>surface-pixels</strong> <em>surface</em></dt> +<dd><p>Return a bytevector containing the raw pixel data in <var>surface</var>. +</p></dd></dl> + +<dl> +<dt><a name="index-surface_002dpixel_002dformat"></a>Procedure: <strong>surface-pixel-format</strong> <em>surface</em></dt> +<dd><p>Return the pixel format for <var>surface</var>. +</p></dd></dl> + +<dl> +<dt><a name="index-convert_002dsurface_002dformat"></a>Procedure: <strong>convert-surface-format</strong> <em>surface format</em></dt> +<dd><p>Convert the pixels in <var>surface</var> to <var>format</var>, a symbol representing a +specific pixel format, and return a new surface object. +</p> +<p>Valid format types are: +</p> +<ul> +<li> <code>index1lsb</code> +</li><li> <code>index1msb</code> +</li><li> <code>index4lsb</code> +</li><li> <code>index4msb</code> +</li><li> <code>index8</code> +</li><li> <code>rgb332</code> +</li><li> <code>rgb444</code> +</li><li> <code>rgb555</code> +</li><li> <code>bgr555</code> +</li><li> <code>argb4444</code> +</li><li> <code>rgba4444</code> +</li><li> <code>abgr4444</code> +</li><li> <code>bgra4444</code> +</li><li> <code>argb1555</code> +</li><li> <code>rgba5551</code> +</li><li> <code>abgr1555</code> +</li><li> <code>bgra5551</code> +</li><li> <code>rgb565</code> +</li><li> <code>bgr565</code> +</li><li> <code>rgb24</code> +</li><li> <code>bgr24</code> +</li><li> <code>rgb888</code> +</li><li> <code>rgbx8888</code> +</li><li> <code>bgr888</code> +</li><li> <code>bgrx8888</code> +</li><li> <code>argb8888</code> +</li><li> <code>rgba8888</code> +</li><li> <code>abgr8888</code> +</li><li> <code>bgra8888</code> +</li><li> <code>argb2101010</code> +</li><li> <code>yv12</code> +</li><li> <code>iyuv</code> +</li><li> <code>yuy2</code> +</li><li> <code>uyvy</code> +</li><li> <code>yvyu</code> +</li></ul> +</dd></dl> + +<dl> +<dt><a name="index-blit_002dsurface"></a>Procedure: <strong>blit-surface</strong> <em><var>src</var> <var>src-rect</var> <var>dst</var> <var>dst-rect</var></em></dt> +<dd><p>Blit the rectangle <var>src-rect</var> from the surface <var>src</var> to +<var>dst-rect</var> of the surface <var>dst</var>. +</p></dd></dl> + +<dl> +<dt><a name="index-blit_002dscaled"></a>Procedure: <strong>blit-scaled</strong> <em><var>src</var> <var>src-rect</var> <var>dst</var> <var>dst-rect</var></em></dt> +<dd><p>Blit the rectangle <var>src-rect</var> from the surface <var>src</var> to +<var>dst-rect</var> of the surface <var>dst</var>, scaling the source to fit the +destination. +</p></dd></dl> + +<dl> +<dt><a name="index-fill_002drect"></a>Procedure: <strong>fill-rect</strong> <em><var>dst</var> <var>rect</var> <var>color</var></em></dt> +<dd><p>Fill <var>rect</var> with <var>color</var>, a 32-bit color encoded as an integer +value, in the surface <var>dst</var>. +</p></dd></dl> + +<hr> +<div class="header"> +<p> +Next: <a href="Rendering.html#Rendering" accesskey="n" rel="next">Rendering</a>, Previous: <a href="Rects.html#Rects" accesskey="p" rel="prev">Rects</a>, Up: <a href="API-Reference.html#API-Reference" accesskey="u" rel="up">API Reference</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> diff --git a/manuals/guile-sdl2/Window-Management.html b/manuals/guile-sdl2/Window-Management.html new file mode 100644 index 0000000..60ef06d --- /dev/null +++ b/manuals/guile-sdl2/Window-Management.html @@ -0,0 +1,114 @@ +<!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>Window Management (Guile-SDL2)</title> + +<meta name="description" content="Window Management (Guile-SDL2)"> +<meta name="keywords" content="Window Management (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="API-Reference.html#API-Reference" rel="up" title="API Reference"> +<link href="Windows.html#Windows" rel="next" title="Windows"> +<link href="Basics.html#Basics" rel="prev" title="Basics"> +<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="Window-Management"></a> +<div class="header"> +<p> +Next: <a href="Input.html#Input" accesskey="n" rel="next">Input</a>, Previous: <a href="Basics.html#Basics" accesskey="p" rel="prev">Basics</a>, Up: <a href="API-Reference.html#API-Reference" accesskey="u" rel="up">API Reference</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-Management-1"></a> +<h3 class="section">3.2 Window Management</h3> + +<table class="menu" border="0" cellspacing="0"> +<tr><td align="left" valign="top">• <a href="Windows.html#Windows" accesskey="1">Windows</a>:</td><td> </td><td align="left" valign="top">Window manipulation. +</td></tr> +<tr><td align="left" valign="top">• <a href="OpenGL.html#OpenGL" accesskey="2">OpenGL</a>:</td><td> </td><td align="left" valign="top">OpenGL contexts. +</td></tr> +</table> + +<div class="example"> +<pre class="example">(use-modules (sdl2 video)) +</pre></div> + + + + +</body> +</html> 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> [<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 "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 +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->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 "fake" 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> [<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> diff --git a/manuals/guile-sdl2/index.html b/manuals/guile-sdl2/index.html new file mode 100644 index 0000000..7e9f574 --- /dev/null +++ b/manuals/guile-sdl2/index.html @@ -0,0 +1,197 @@ +<!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>Top (Guile-SDL2)</title> + +<meta name="description" content="Top (Guile-SDL2)"> +<meta name="keywords" content="Top (Guile-SDL2)"> +<meta name="resource-type" content="document"> +<meta name="distribution" content="global"> +<meta name="Generator" content="makeinfo"> +<link href="#Top" rel="start" title="Top"> +<link href="Index.html#Index" rel="index" title="Index"> +<link href="#SEC_Contents" rel="contents" title="Table of Contents"> +<link href="../dir/index.html" rel="up" title="(dir)"> +<link href="Introduction.html#Introduction" rel="next" title="Introduction"> +<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"> +<h1 class="settitle" align="center">Guile-SDL2</h1> + + +<a name="SEC_Contents"></a> +<h2 class="contents-heading">Table of Contents</h2> + +<div class="contents"> + +<ul class="no-bullet"> + <li><a name="toc-Introduction-1" href="Introduction.html#Introduction">1 Introduction</a></li> + <li><a name="toc-Installation-1" href="Installation.html#Installation">2 Installation</a> + <ul class="no-bullet"> + <li><a name="toc-Requirements-1" href="Requirements.html#Requirements">2.1 Requirements</a></li> + </ul></li> + <li><a name="toc-API-Reference-1" href="API-Reference.html#API-Reference">3 API Reference</a> + <ul class="no-bullet"> + <li><a name="toc-Basics-1" href="Basics.html#Basics">3.1 Basics</a></li> + <li><a name="toc-Window-Management-1" href="Window-Management.html#Window-Management">3.2 Window Management</a> + <ul class="no-bullet"> + <li><a name="toc-Windows-1" href="Windows.html#Windows">3.2.1 Windows</a></li> + <li><a name="toc-OpenGL-1" href="OpenGL.html#OpenGL">3.2.2 OpenGL</a></li> + </ul></li> + <li><a name="toc-Input-1" href="Input.html#Input">3.3 Input</a> + <ul class="no-bullet"> + <li><a name="toc-Keyboard-1" href="Keyboard.html#Keyboard">3.3.1 Keyboard</a></li> + <li><a name="toc-Mouse-1" href="Mouse.html#Mouse">3.3.2 Mouse</a></li> + <li><a name="toc-Joysticks-1" href="Joysticks.html#Joysticks">3.3.3 Joysticks</a></li> + <li><a name="toc-Game-Controllers-1" href="Game-Controllers.html#Game-Controllers">3.3.4 Game Controllers</a></li> + </ul></li> + <li><a name="toc-Events-1" href="Events.html#Events">3.4 Events</a></li> + <li><a name="toc-Rects-1" href="Rects.html#Rects">3.5 Rects</a></li> + <li><a name="toc-Surfaces-1" href="Surfaces.html#Surfaces">3.6 Surfaces</a></li> + <li><a name="toc-Rendering-1" href="Rendering.html#Rendering">3.7 Rendering</a></li> + <li><a name="toc-Images-1" href="Images.html#Images">3.8 Images</a></li> + <li><a name="toc-Sound-1" href="Sound.html#Sound">3.9 Sound</a></li> + <li><a name="toc-Fonts-1" href="Fonts.html#Fonts">3.10 Fonts</a></li> + </ul></li> + <li><a name="toc-Contributing-1" href="Contributing.html#Contributing">4 Contributing</a> + <ul class="no-bullet"> + <li><a name="toc-Getting-the-Source-1" href="Getting-the-Source.html#Getting-the-Source">4.1 Getting the Source</a></li> + <li><a name="toc-Submitting-Patches-1" href="Submitting-Patches.html#Submitting-Patches">4.2 Submitting Patches</a></li> + <li><a name="toc-Chat-1" href="Chat.html#Chat">4.3 Chat</a></li> + </ul></li> + <li><a name="toc-Copying-This-Manual-1" href="Copying-This-Manual.html#Copying-This-Manual">Appendix A Copying This Manual</a> + <ul class="no-bullet"> + <li><a name="toc-GNU-Free-Documentation-License-1" href="GNU-Free-Documentation-License.html#GNU-Free-Documentation-License">A.1 GNU Free Documentation License</a></li> + </ul></li> + <li><a name="toc-Index-1" href="Index.html#Index">Index</a></li> +</ul> +</div> + + +<a name="Top"></a> +<div class="header"> +<p> +Next: <a href="Introduction.html#Introduction" accesskey="n" rel="next">Introduction</a>, Up: <a href="../dir/index.html" accesskey="u" rel="up">(dir)</a> [<a href="#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="Guile_002dSDL2"></a> +<h1 class="top">Guile-SDL2</h1> + +<p>Copyright © 2016 David Thompson <a href="mailto:davet@gnu.org">davet@gnu.org</a> +</p> +<blockquote> +<p>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”. +</p> +<p>A copy of the license is also available from the Free Software +Foundation Web site at <a href="http://www.gnu.org/licenses/fdl.html">http://www.gnu.org/licenses/fdl.html</a>. +</p> +</blockquote> + +<p>The document was typeset with +<a href="http://www.texinfo.org/">GNU Texinfo</a>. +</p> + + +<table class="menu" border="0" cellspacing="0"> +<tr><td align="left" valign="top">• <a href="Introduction.html#Introduction" accesskey="1">Introduction</a>:</td><td> </td><td align="left" valign="top">About Guile-SDL2. +</td></tr> +<tr><td align="left" valign="top">• <a href="Installation.html#Installation" accesskey="2">Installation</a>:</td><td> </td><td align="left" valign="top">Installing Guile-SDL2. +</td></tr> +<tr><td align="left" valign="top">• <a href="API-Reference.html#API-Reference" accesskey="3">API Reference</a>:</td><td> </td><td align="left" valign="top">High-level Scheme interfaces to SDL2. +</td></tr> +<tr><td align="left" valign="top">• <a href="Contributing.html#Contributing" accesskey="4">Contributing</a>:</td><td> </td><td align="left" valign="top">Guidelines for hacking Guile-SDL2. +</td></tr> +<tr><th colspan="3" align="left" valign="top"><pre class="menu-comment"> + +</pre></th></tr><tr><td align="left" valign="top">• <a href="Copying-This-Manual.html#Copying-This-Manual" accesskey="5">Copying This Manual</a>:</td><td> </td><td align="left" valign="top">The GNU Free Documentation License and you! +</td></tr> +<tr><td align="left" valign="top">• <a href="Index.html#Index" accesskey="6">Index</a>:</td><td> </td><td align="left" valign="top"> +</td></tr> +</table> + + +<hr> +<div class="header"> +<p> +Next: <a href="Introduction.html#Introduction" accesskey="n" rel="next">Introduction</a>, Up: <a href="../dir/index.html" accesskey="u" rel="up">(dir)</a> [<a href="#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> |