summaryrefslogtreecommitdiff
path: root/manuals/guile-sdl2/Windows.html
blob: 3353d31397eaca016bf298b16f618a3d84fd0ce0 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<!-- Copyright (C) 2016, 2017, 2018, 2019  David Thompson davet@gnu.org

Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.3
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.


* Guile-SDL2: (guile-sdl2).     SDL2 bindings for Guile.

The document was typeset with
http://www.texinfo.org/ (GNU Texinfo).
 -->
<!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ -->
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>Windows (Guile-SDL2)</title>

<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" rel="start" title="Top">
<link href="Index.html" rel="index" title="Index">
<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
<link href="Window-Management.html" rel="up" title="Window Management">
<link href="OpenGL.html" rel="next" title="OpenGL">
<link href="Window-Management.html" rel="prev" title="Window Management">
<style type="text/css">
<!--
a.summary-letter {text-decoration: none}
blockquote.indentedblock {margin-right: 0em}
div.display {margin-left: 3.2em}
div.example {margin-left: 3.2em}
div.lisp {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}
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">
<span id="Windows"></span><div class="header">
<p>
Next: <a href="OpenGL.html" accesskey="n" rel="next">OpenGL</a>, Up: <a href="Window-Management.html" accesskey="u" rel="up">Window Management</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Index.html" title="Index" rel="index">Index</a>]</p>
</div>
<hr>
<span id="Windows-1"></span><h4 class="subsection">3.2.1 Windows</h4>

<dl>
<dt id="index-make_002dwindow">Procedure: <strong>make-window</strong> <em>[#:title &quot;Guile SDL2 Window&quot;]                           [#:position (#f #f)]                           [#:size (640 480)]                           [#:maximize? #f]                           [#:minimize? #f]                           [#:opengl? #f]                           [#:border? #t]                           [#:fullscreen? #f]                           [#:fullscreen-desktop? #f]                           [#:grab-input? #f]                           [#:high-dpi? #f]</em></dt>
<dd><p>Create a new window named <var>title</var> with dimensions <var>size</var> located
at <var>position</var> on the display.  <var>position</var> and <var>size</var> are
two-element lists in the form <code>(x y)</code>, where each coordinate is
measured in pixels.  In the case of <var>position</var>, a coordinate may use
the special symbol <var>center</var> to indicate that the window should be
centered on that axis, or <code>#f</code> to indicate that it does not matter
where the window is located on that axis.
</p></dd></dl>

<dl>
<dt id="index-close_002dwindow_0021">Procedure: <strong>close-window!</strong> <em>window</em></dt>
<dd><p>Close <var>window</var>.
</p></dd></dl>

<dl>
<dt id="index-call_002dwith_002dwindow">Procedure: <strong>call-with-window</strong> <em>window proc</em></dt>
<dd><p>Call <var>proc</var> with <var>window</var>, an SDL window object, and close it
when <var>proc</var> returns or otherwise exits.
</p></dd></dl>

<dl>
<dt id="index-window_002dtitle">Procedure: <strong>window-title</strong> <em>window</em></dt>
<dd><p>Return the title for <var>window</var>.
</p></dd></dl>

<dl>
<dt id="index-window_002dsize">Procedure: <strong>window-size</strong> <em>window</em></dt>
<dd><p>Return 2 values for the dimensions of <var>window</var>.
</p></dd></dl>

<dl>
<dt id="index-window_002dminimum_002dsize">Procedure: <strong>window-minimum-size</strong> <em>window</em></dt>
<dd><p>Return 2 values for the minimal dimensions that <var>window</var> can be.
Note that SDL does not always enforce this restriction, so you might
end up with a window size that is actually smaller than the value
returned by this procedure.
</p></dd></dl>

<dl>
<dt id="index-window_002dmaximum_002dsize">Procedure: <strong>window-maximum-size</strong> <em>window</em></dt>
<dd><p>Return 2 values for the maximum dimensions that <var>window</var> can be.
</p></dd></dl>

<dl>
<dt id="index-window_002dposition">Procedure: <strong>window-position</strong> <em>window</em></dt>
<dd><p>Return 2 values for the position of <var>window</var> on the display.
</p></dd></dl>

<dl>
<dt id="index-window_002did">Procedure: <strong>window-id</strong> <em>window</em></dt>
<dd><p>Return the numeric ID of <var>window</var>.
</p></dd></dl>

<dl>
<dt id="index-id_002d_003ewindow">Procedure: <strong>id-&gt;window</strong> <em>id</em></dt>
<dd><p>Return the window corresponding to <var>ID</var>, a positive integer, or
<code>#f</code> if there is no such window.
</p></dd></dl>

<dl>
<dt id="index-hide_002dwindow_0021">Procedure: <strong>hide-window!</strong> <em>window</em></dt>
<dd><p>Hide <var>window</var>.
</p></dd></dl>

<dl>
<dt id="index-show_002dwindow_0021">Procedure: <strong>show-window!</strong> <em>window</em></dt>
<dd><p>Show <var>window</var> and focus on it.
</p></dd></dl>

<dl>
<dt id="index-maximize_002dwindow_0021">Procedure: <strong>maximize-window!</strong> <em>window</em></dt>
<dd><p>Make <var>window</var> as large as possible.
</p></dd></dl>

<dl>
<dt id="index-minimize_002dwindow_0021">Procedure: <strong>minimize-window!</strong> <em>window</em></dt>
<dd><p>Shrink <var>window</var> to an iconic representation.
</p></dd></dl>

<dl>
<dt id="index-raise_002dwindow_0021">Procedure: <strong>raise-window!</strong> <em>window</em></dt>
<dd><p>Raise <var>window</var> above all other windows and set input focus.
</p></dd></dl>

<dl>
<dt id="index-restore_002dwindow_0021">Procedure: <strong>restore-window!</strong> <em>window</em></dt>
<dd><p>Restore the size and position of a minimized or maximized <var>window</var>.
</p></dd></dl>

<dl>
<dt id="index-set_002dwindow_002dborder_0021">Procedure: <strong>set-window-border!</strong> <em>window border?</em></dt>
<dd><p>When <var>border?</var>, draw the usual border around <var>window</var>, otherwise
remove the border.
</p></dd></dl>

<dl>
<dt id="index-set_002dwindow_002dtitle_0021">Procedure: <strong>set-window-title!</strong> <em>window title</em></dt>
<dd><p>Set the title of <var>window</var> to the string <var>title</var>.
</p></dd></dl>

<dl>
<dt id="index-set_002dwindow_002dicon_0021">Procedure: <strong>set-window-icon!</strong> <em>window icon</em></dt>
<dd><p>Set the icon of <var>window</var> to the surface <var>icon</var>.
</p></dd></dl>

<dl>
<dt id="index-set_002dwindow_002dposition_0021">Procedure: <strong>set-window-position!</strong> <em>window x y</em></dt>
<dd><p>Set the position of <var>window</var> to (<var>x</var>, <var>y</var>).
</p></dd></dl>

<dl>
<dt id="index-set_002dwindow_002dsize_0021">Procedure: <strong>set-window-size!</strong> <em>window width height</em></dt>
<dd><p>Set the dimensions of <var>window</var> to <var>width</var> x <var>height</var>
pixels.
</p></dd></dl>

<dl>
<dt id="index-set_002dwindow_002dminimum_002dsize_0021">Procedure: <strong>set-window-minimum-size!</strong> <em>window width height</em></dt>
<dd><p>Set the minimum dimensions of <var>window</var> to <var>width</var> x
<var>height</var> pixels.
</p></dd></dl>

<dl>
<dt id="index-set_002dwindow_002dmaximum_002dsize_0021">Procedure: <strong>set-window-maximum-size!</strong> <em>window width height</em></dt>
<dd><p>Set the maximum dimensions of <var>window</var> to <var>width</var> x
<var>height</var> pixels.
</p></dd></dl>

<dl>
<dt id="index-set_002dwindow_002dresizable_0021">Procedure: <strong>set-window-resizable!</strong> <em>window resizable?</em></dt>
<dd><p>If <var>resizable</var> is <code>#t</code>, allow <var>window</var> to be resized,
otherwise disable resizing.
</p></dd></dl>

<dl>
<dt id="index-set_002dwindow_002dfullscreen_0021">Procedure: <strong>set-window-fullscreen!</strong> <em>window fullscreen? [#:desktop?]</em></dt>
<dd><p>Toggle fullscreen mode on/off for <var>window</var>.  If <var>fullscreen?</var>,
fullscreen mode is activated, otherwise it is deactivated.  If
<var>fullscreen?</var> and <var>desktop?</var>, a special &quot;fake&quot; fullscreen mode
is used that takes the size of the desktop.
</p></dd></dl>

<hr>
<div class="header">
<p>
Next: <a href="OpenGL.html" accesskey="n" rel="next">OpenGL</a>, Up: <a href="Window-Management.html" accesskey="u" rel="up">Window Management</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Index.html" title="Index" rel="index">Index</a>]</p>
</div>



</body>
</html>