From b421d4e7e06f977436b6e6195b95ca44d884e0c0 Mon Sep 17 00:00:00 2001 From: David Thompson Date: Sun, 2 Jun 2019 20:50:28 -0400 Subject: Add guile-sdl2 manual. --- haunt.scm | 1 + manuals/guile-sdl2/API-Reference.html | 126 +++++ manuals/guile-sdl2/Basics.html | 136 +++++ manuals/guile-sdl2/Chat.html | 107 ++++ manuals/guile-sdl2/Contributing.html | 112 ++++ manuals/guile-sdl2/Copying-This-Manual.html | 108 ++++ manuals/guile-sdl2/Events.html | 581 +++++++++++++++++++++ manuals/guile-sdl2/Fonts.html | 146 ++++++ .../guile-sdl2/GNU-Free-Documentation-License.html | 576 ++++++++++++++++++++ manuals/guile-sdl2/Game-Controllers.html | 192 +++++++ manuals/guile-sdl2/Getting-the-Source.html | 125 +++++ manuals/guile-sdl2/Images.html | 127 +++++ manuals/guile-sdl2/Index.html | 490 +++++++++++++++++ manuals/guile-sdl2/Input.html | 114 ++++ manuals/guile-sdl2/Installation.html | 116 ++++ manuals/guile-sdl2/Introduction.html | 120 +++++ manuals/guile-sdl2/Joysticks.html | 155 ++++++ manuals/guile-sdl2/Keyboard.html | 117 +++++ manuals/guile-sdl2/Mouse.html | 127 +++++ manuals/guile-sdl2/OpenGL.html | 174 ++++++ manuals/guile-sdl2/Rects.html | 133 +++++ manuals/guile-sdl2/Rendering.html | 191 +++++++ manuals/guile-sdl2/Requirements.html | 118 +++++ manuals/guile-sdl2/Sound.html | 312 +++++++++++ manuals/guile-sdl2/Submitting-Patches.html | 106 ++++ manuals/guile-sdl2/Surfaces.html | 316 +++++++++++ manuals/guile-sdl2/Window-Management.html | 114 ++++ manuals/guile-sdl2/Windows.html | 217 ++++++++ manuals/guile-sdl2/index.html | 197 +++++++ 29 files changed, 5454 insertions(+) create mode 100644 manuals/guile-sdl2/API-Reference.html create mode 100644 manuals/guile-sdl2/Basics.html create mode 100644 manuals/guile-sdl2/Chat.html create mode 100644 manuals/guile-sdl2/Contributing.html create mode 100644 manuals/guile-sdl2/Copying-This-Manual.html create mode 100644 manuals/guile-sdl2/Events.html create mode 100644 manuals/guile-sdl2/Fonts.html create mode 100644 manuals/guile-sdl2/GNU-Free-Documentation-License.html create mode 100644 manuals/guile-sdl2/Game-Controllers.html create mode 100644 manuals/guile-sdl2/Getting-the-Source.html create mode 100644 manuals/guile-sdl2/Images.html create mode 100644 manuals/guile-sdl2/Index.html create mode 100644 manuals/guile-sdl2/Input.html create mode 100644 manuals/guile-sdl2/Installation.html create mode 100644 manuals/guile-sdl2/Introduction.html create mode 100644 manuals/guile-sdl2/Joysticks.html create mode 100644 manuals/guile-sdl2/Keyboard.html create mode 100644 manuals/guile-sdl2/Mouse.html create mode 100644 manuals/guile-sdl2/OpenGL.html create mode 100644 manuals/guile-sdl2/Rects.html create mode 100644 manuals/guile-sdl2/Rendering.html create mode 100644 manuals/guile-sdl2/Requirements.html create mode 100644 manuals/guile-sdl2/Sound.html create mode 100644 manuals/guile-sdl2/Submitting-Patches.html create mode 100644 manuals/guile-sdl2/Surfaces.html create mode 100644 manuals/guile-sdl2/Window-Management.html create mode 100644 manuals/guile-sdl2/Windows.html create mode 100644 manuals/guile-sdl2/index.html diff --git a/haunt.scm b/haunt.scm index 050cbac..e00054b 100644 --- a/haunt.scm +++ b/haunt.scm @@ -407,6 +407,7 @@ following modules:") "GNU Make" "GNU pkg-config") #:license "GNU LGPLv3+" + #:manual? #t #:releases `(("0.3.1" ,(date 2018 10 16)) ("0.3.0" ,(date 2018 07 10)) 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 @@ + + + + + + +API Reference (Guile-SDL2) + + + + + + + + + + + + + + + + + + + + +
+

+Next: , Previous: , Up: Top   [Contents][Index]

+
+
+ +

3 API Reference

+ + + + + + + + + + + + +
• Basics:  Initialization and other basic things. +
• Window Management:  Working with the window system. +
• Input:  Keyboard, mouse, joystick input. +
• Events:  Asynchronous event handling. +
• Rects:  2D rectangles. +
• Surfaces:  Software rendering. +
• Rendering:  Hardware accelerated rendering. +
• Images:  Loading and saving images. +
• Sound:  Sound effects and music. +
• Fonts:  Truetype and bitmap font rendering. +
+ + + + + + 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 @@ + + + + + + +Basics (Guile-SDL2) + + + + + + + + + + + + + + + + + + + + +
+

+Next: , Up: API Reference   [Contents][Index]

+
+
+ +

3.1 Basics

+ +
+
(use-modules (sdl2))
+
+ +
+
Procedure: sdl-init [subsystems]
+

Initialize the SDL library. This must be called before using any +other SDL procedure. +

+

subsystems is an optional list of symbols that specifies the +subsystems to initialize. All subsystems are initialized by default. +The possible flags are timer, audio, video, +haptic, game-controller, and events. +

+ +
+
Procedure: sdl-quit
+

Quit all activated SDL subsystems. This procedure should be called +upon all exit conditions. +

+ +
+
Procedure: sdl-version
+

Return a three element list containing the major, minor, and patch +version of the linked SDL library. +

+ +
+
Procedure: sdl-ticks
+

Return the number of milliseconds since the SDL library was +initialized. +

+ + + + + + 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 @@ + + + + + + +Chat (Guile-SDL2) + + + + + + + + + + + + + + + + + + + + +
+

+Previous: , Up: Contributing   [Contents][Index]

+
+
+ +

4.3 Chat

+ +

The maintainer of this library hangs out in the #guile channel +on irc.freenode.net, so help and general discussion may be found +there. +

+ + + + + 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 @@ + + + + + + +Contributing (Guile-SDL2) + + + + + + + + + + + + + + + + + + + + +
+

+Next: , Previous: , Up: Top   [Contents][Index]

+
+
+ +

4 Contributing

+ + + + + +
• Getting the Source:  Getting good with Git. +
• Submitting Patches:  Patches welcome! +
• Chat:  Let’s talk! +
+ + + + + + 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 @@ + + + + + + +Copying This Manual (Guile-SDL2) + + + + + + + + + + + + + + + + + + + + +
+

+Next: , Previous: , Up: Top   [Contents][Index]

+
+
+ +

Appendix A Copying This Manual

+ + + +
• GNU Free Documentation License:  License for copying this manual. +
+ + + + + + 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 @@ + + + + + + +Events (Guile-SDL2) + + + + + + + + + + + + + + + + + + + + +
+

+Next: , Previous: , Up: API Reference   [Contents][Index]

+
+
+ +

3.4 Events

+ +
+
(use-modules (sdl2 events))
+
+ +
+
Procedure: make-quit-event timestamp
+
+ +
+
Procedure: quit-event? e
+

Return #t if e is a quit event. +

+ +
+
Procedure: quit-event-timestamp e
+
+ +
+
Procedure: make-window-event timestamp window-id type vector
+
+ +
+
Procedure: window-event? e
+

Return #t if e is a window event. +

+ +
+
Procedure: window-shown-event? e
+

Return #t if e is a window shown event. +

+ +
+
Procedure: window-hidden-event? e
+

Return #t if e is a window hidden event. +

+ +
+
Procedure: window-exposed-event? e
+

Return #t if e is a window exposed event. +

+ +
+
Procedure: window-moved-event? e
+

Return #t if e is a window moved event. +

+ +
+
Procedure: window-resized-event? e
+

Return #t if e is a window resized event. +

+ +
+
Procedure: window-size-changed-event? e
+

Return #t if e is a window size changed event. +

+ +
+
Procedure: window-minimized-event? e
+

Return #t if e is a window minimized event. +

+ +
+
Procedure: window-maximized-event? e
+

Return #t if e is a window maximized event. +

+ +
+
Procedure: window-restored-event? e
+

Return #t if e is a window restored event. +

+ +
+
Procedure: window-enter-event? e
+

Return #t if e is a window enter event. +

+ +
+
Procedure: window-leave-event? e
+

Return #t if e is a window leave event. +

+ +
+
Procedure: window-focus-gained-event? e
+

Return #t if e is a window focus gained event. +

+ +
+
Procedure: window-focus-lost-event? e
+

Return #t if e is a window focus lost event. +

+ +
+
Procedure: window-closed-event? e
+

Return #t if e is a window closed event. +

+ +
+
Procedure: window-event-timestamp e
+
+ +
+
Procedure: window-event-window-id e
+
+ +
+
Procedure: window-event-type e
+
+ +
+
Procedure: window-event-vector e
+
+ +
+
Procedure: make-keyboard-event timestamp window-id pressed? repeat? key scancode modifiers
+
+ +
+
Procedure: keyboard-event? e
+

Return #t if e is a keyboard event. +

+ +
+
Procedure: keyboard-down-event? e
+

Return #t if e is a key press event. +

+ +
+
Procedure: keyboard-up-event? e
+

Return #t if e is a key release event. +

+ +
+
Procedure: keyboard-event-timestamp e
+
+ +
+
Procedure: keyboard-event-window-id e
+
+ +
+
Procedure: keyboard-event-pressed? e
+
+ +
+
Procedure: keyboard-event-repeat? e
+
+ +
+
Procedure: keyboard-event-key e
+
+ +
+
Procedure: keyboard-event-scancode e
+
+ +
+
Procedure: keyboard-event-modifiers e
+
+ +
+
Procedure: make-text-input-event timestamp window-id text
+
+ +
+
Procedure: text-input-event? e
+

Return #t if e is a text input event. +

+ +
+
Procedure: text-input-event-timestamp e
+
+ +
+
Procedure: text-input-event-window-id e
+
+ +
+
Procedure: text-input-event-text e
+
+ +
+
Procedure: make-mouse-button-event timestamp window-id which button pressed? clicks x y
+
+ +
+
Procedure: mouse-button-event? e
+

Return #t if e is a mouse button event. +

+ +
+
Procedure: mouse-button-down-event? e
+

Return #t if e is a mouse button down event. +

+ +
+
Procedure: mouse-button-up-event? e
+

Return #t if e is a mouse button up event. +

+ +
+
Procedure: mouse-button-event-timestamp e
+
+ +
+
Procedure: mouse-button-event-window-id e
+
+ +
+
Procedure: mouse-button-event-which e
+
+ +
+
Procedure: mouse-button-event-button e
+
+ +
+
Procedure: mouse-button-event-pressed? e
+
+ +
+
Procedure: mouse-button-event-clicks e
+
+ +
+
Procedure: mouse-button-event-x e
+
+ +
+
Procedure: mouse-button-event-y e
+
+ +
+
Procedure: make-mouse-motion-event timestamp window-id which buttons x y x-rel y-rel
+
+ +
+
Procedure: mouse-motion-event? e
+

Return #t if e is a mouse motion event. +

+ +
+
Procedure: mouse-motion-event-timestamp e
+
+ +
+
Procedure: mouse-motion-event-window-id e
+
+ +
+
Procedure: mouse-motion-event-which e
+
+ +
+
Procedure: mouse-motion-event-buttons e
+
+ +
+
Procedure: mouse-motion-event-x e
+
+ +
+
Procedure: mouse-motion-event-y e
+
+ +
+
Procedure: mouse-motion-event-x-rel e
+
+ +
+
Procedure: mouse-motion-event-y-rel e
+
+ +
+
Procedure: make-joystick-axis-event timestamp which axis value
+
+ +
+
Procedure: joystick-axis-event? e
+

Return #t if e is a joystick axis event. +

+ +
+
Procedure: joystick-axis-event-timestamp e
+
+ +
+
Procedure: joystick-axis-event-which e
+
+ +
+
Procedure: joystick-axis-event-button e
+
+ +
+
Procedure: joystick-axis-event-pressed? e
+
+ +
+
Procedure: make-joystick-ball-event timestamp which ball x-rel y-rel
+
+ +
+
Procedure: joystick-ball-event? e
+

Return #t if e is a joystick ball event. +

+ +
+
Procedure: joystick-ball-event-timestamp e
+
+ +
+
Procedure: joystick-ball-event-which e
+
+ +
+
Procedure: joystick-ball-event-ball e
+
+ +
+
Procedure: joystick-ball-event-x-rel e
+
+ +
+
Procedure: joystick-ball-event-y-rel e
+
+ +
+
Procedure: make-joystick-hat-event timestamp which hat value
+
+ +
+
Procedure: joystick-hat-event? e
+

Return #t if e is a joystick hat event. +

+ +
+
Procedure: joystick-hat-event-timestamp e
+
+ +
+
Procedure: joystick-hat-event-which e
+
+ +
+
Procedure: joystick-hat-event-hat e
+
+ +
+
Procedure: joystick-hat-event-value e
+
+ +
+
Procedure: make-joystick-device-event timestamp which action
+
+ +
+
Procedure: joystick-device-event? e
+

Return #t if e is a joystick device event. +

+ +
+
Procedure: joystick-device-event-timestamp e
+
+ +
+
Procedure: joystick-device-event-which e
+
+ +
+
Procedure: joystick-device-event-action e
+
+ +
+
Procedure: make-controller-axis-event timestamp which axis value
+
+ +
+
Procedure: controller-axis-event? e
+

Return #t if e is a game controller axis event. +

+ +
+
Procedure: controller-axis-event-timestamp e
+
+ +
+
Procedure: controller-axis-event-which e
+
+ +
+
Procedure: controller-axis-event-axis e
+
+ +
+
Procedure: controller-axis-event-value e
+
+ +
+
Procedure: make-controller-button-event timestamp which button pressed?
+
+ +
+
Procedure: controller-button-event? e
+

Return #t if event is a game controller button event. +

+ +
+
Procedure: controller-button-down-event? e
+
+ +
+
Procedure: controller-button-up-event? e
+
+ +
+
Procedure: controller-button-event-timestamp e
+
+ +
+
Procedure: controller-button-event-which e
+
+ +
+
Procedure: controller-button-event-button e
+
+ +
+
Procedure: controller-button-event-pressed? e
+
+ +
+
Procedure: make-controller-device-event timestamp which action
+
+ +
+
Procedure: controller-device-event? e
+

Return #t if event is a game controller device event. +

+ +
+
Procedure: controller-added-event? e
+

Return #t if event is a game controller device event with the +’added’ action. +

+ +
+
Procedure: controller-removed-event? e
+

Return #t if event is a game controller device event with the +’removed’ action. +

+ +
+
Procedure: controller-remapped-event? e
+

Return #t if event is a game controller device event with the +’remapped’ action. +

+ +
+
Procedure: controller-device-event-timestamp e
+
+ +
+
Procedure: controller-device-event-which e
+
+ +
+
Procedure: controller-device-event-action e
+
+ +
+
Procedure: poll-event
+
+ +
+
+

+Next: , Previous: , Up: API Reference   [Contents][Index]

+
+ + + + + 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 @@ + + + + + + +Fonts (Guile-SDL2) + + + + + + + + + + + + + + + + + + + + +
+

+Previous: , Up: API Reference   [Contents][Index]

+
+
+ +

3.10 Fonts

+ +
+
(use-modules (sdl2 ttf))
+
+ +
+
Procedure: ttf-init
+

Initialize the TTF system. +

+ +
+
Procedure: ttf-quit
+

Shut down and clean up the TTF system. +

+ +
+
Procedure: load-font file point-size
+

Load TTF font from file and return a new font object whose glyph size is +point-size. +

+ +
+
Procedure: delete-font! font
+

Delete the memory allocated for font. +

+ +
+
Procedure: font-height font
+

Return the maximum height of font. +

+ +
+
Procedure: render-font-solid font text color
+

Render text, a UTF-8 encoded string, using font and color, the +foreground color, and return a surface containing the results. +

+ +
+
Procedure: render-font-blended font text color
+

Render text, a UTF-8 encoded string, using font and color, the +foreground color, and return a high-quality alpha-blended surface containing the +results. +

+ + + + + + 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 @@ + + + + + + +GNU Free Documentation License (Guile-SDL2) + + + + + + + + + + + + + + + + + + + + +
+

+Up: Copying This Manual   [Contents][Index]

+
+
+ +

A.1 GNU Free Documentation License

+
Version 1.3, 3 November 2008 +
+ +
+
Copyright © 2000, 2001, 2002, 2007, 2008 Free Software Foundation, Inc.
+http://fsf.org/
+
+Everyone is permitted to copy and distribute verbatim copies
+of this license document, but changing it is not allowed.
+
+ +
    +
  1. PREAMBLE + +

    The purpose of this License is to make a manual, textbook, or other +functional and useful document free 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. +

    +

    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. +

    +

    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. +

    +
  2. APPLICABILITY AND DEFINITIONS + +

    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. +

    +

    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. +

    +

    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. +

    +

    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. +

    +

    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. +

    +

    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”. +

    +

    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. +

    +

    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. +

    +

    The “publisher” means any person or entity that distributes copies +of the Document to the public. +

    +

    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. +

    +

    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. +

    +
  3. VERBATIM COPYING + +

    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. +

    +

    You may also lend copies, under the same conditions stated above, and +you may publicly display copies. +

    +
  4. COPYING IN QUANTITY + +

    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. +

    +

    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. +

    +

    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. +

    +

    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. +

    +
  5. MODIFICATIONS + +

    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: +

    +
      +
    1. 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. + +
    2. 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. + +
    3. State on the Title page the name of the publisher of the +Modified Version, as the publisher. + +
    4. Preserve all the copyright notices of the Document. + +
    5. Add an appropriate copyright notice for your modifications +adjacent to the other copyright notices. + +
    6. 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. + +
    7. Preserve in that license notice the full lists of Invariant Sections +and required Cover Texts given in the Document’s license notice. + +
    8. Include an unaltered copy of this License. + +
    9. 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. + +
    10. 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. + +
    11. 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. + +
    12. 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. + +
    13. Delete any section Entitled “Endorsements”. Such a section +may not be included in the Modified Version. + +
    14. Do not retitle any existing section to be Entitled “Endorsements” or +to conflict in title with any Invariant Section. + +
    15. Preserve any Warranty Disclaimers. +
    + +

    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. +

    +

    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. +

    +

    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. +

    +

    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. +

    +
  6. COMBINING DOCUMENTS + +

    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. +

    +

    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. +

    +

    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.” +

    +
  7. COLLECTIONS OF DOCUMENTS + +

    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. +

    +

    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. +

    +
  8. AGGREGATION WITH INDEPENDENT WORKS + +

    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. +

    +

    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. +

    +
  9. TRANSLATION + +

    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. +

    +

    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. +

    +
  10. TERMINATION + +

    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. +

    +

    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. +

    +

    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. +

    +

    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. +

    +
  11. FUTURE REVISIONS OF THIS LICENSE + +

    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 +http://www.gnu.org/copyleft/. +

    +

    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. +

    +
  12. RELICENSING + +

    “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. +

    +

    “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. +

    +

    “Incorporate” means to publish or republish a Document, in whole or +in part, as part of another Document. +

    +

    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. +

    +

    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. +

    +
+ + +

ADDENDUM: How to use this License for your documents

+ +

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: +

+
+
  Copyright (C)  year  your name.
+  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''.
+
+ +

If you have Invariant Sections, Front-Cover Texts and Back-Cover Texts, +replace the “with…Texts.” line with this: +

+
+
    with the Invariant Sections being list their titles, with
+    the Front-Cover Texts being list, and with the Back-Cover Texts
+    being list.
+
+ +

If you have Invariant Sections without Cover Texts, or some other +combination of the three, merge those two alternatives to suit the +situation. +

+

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. +

+ +
+
+

+Up: Copying This Manual   [Contents][Index]

+
+ + + + + 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 @@ + + + + + + +Game Controllers (Guile-SDL2) + + + + + + + + + + + + + + + + + + + + +
+

+Previous: , Up: Input   [Contents][Index]

+
+
+ +

3.3.4 Game Controllers

+ +
+
(use-modules (sdl2 input game-controller))
+
+ +
+
Procedure: load-game-controller-mappings! file
+

Load game controller mapping from file and return the number of +mappings added this way. +

+

See https://raw.github.com/gabomdq/SDL_GameControllerDB/master/gamecontrollerdb.txt +for a community maintained controller mapping file. +

+ +
+
Procedure: open-game-controller joystick-index
+

Return a game controller object for the physical joystick device associated +with the joystick-index. +

+ +
+
Procedure: close-game-controller controller
+

Close controller. +

+ +
+
Procedure: game-controller? controller
+

Close controller. +

+ +
+
Procedure: game-controller-attached? controller
+

Return #t if controller is currently in use. +

+ +
+
Procedure: game-controller-joystick controller
+

Return the underlying joystick object associated with controller. +

+ +
+
Procedure: game-controller-name controller
+

Return the human readable name for controller. +

+ +
+
Procedure: game-controller-axis controller axis
+

Return a number in the range [-32768, 32767] representing the +current state of axis on controller. +

+

axis may be one of the following symbols: +

    +
  • left-x +
  • left-y +
  • right-x +
  • right-y +
  • trigger-left +
  • trigger-right +
+
+ +
+
Procedure: game-controller-button-pressed? controller button
+

Return #t if button is pressed on controller. +

+

button may be one of the following symbols: +

    +
  • a +
  • b +
  • x +
  • y +
  • back +
  • guide +
  • start +
  • left-stick +
  • right-stick +
  • left-shoulder +
  • right-shoulder +
  • dpad-up +
  • dpad-down +
  • dpad-left +
  • dpad-right +
+
+ +
+
Procedure: game-controller-index? joystick-index
+

Return #t if joystick-index is a valid game controller index. +

+ + + + + + 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 @@ + + + + + + +Getting the Source (Guile-SDL2) + + + + + + + + + + + + + + + + + + + + +
+

+Next: , Up: Contributing   [Contents][Index]

+
+
+ +

4.1 Getting the Source

+ +

Guile-SDL2 is developed using the Git version control system. The +repository can be cloned with the following command: +

+
+
git clone https://git.dthompson.us/guile-sdl2.git
+
+ +

To build the source code from a Git checkout, run the following: +

+
+
./bootstrap
+./configure
+make
+
+ +

To start a Guile REPL with a pre-configured load path for using +Guile-SDL2, use the pre-inst-env script: +

+
+
./pre-inst-env guile
+
+ + + + + + 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 @@ + + + + + + +Images (Guile-SDL2) + + + + + + + + + + + + + + + + + + + + +
+

+Next: , Previous: , Up: API Reference   [Contents][Index]

+
+
+ +

3.8 Images

+ +
+
(use-modules (sdl2 image))
+
+ +
+
Procedure: image-init
+

Initialize dynamically loaded image libraries. +

+ +
+
Procedure: image-quit
+

Clean up dynamically loaded image libraries. +

+ +
+
Procedure: load-image file
+

Load the image in file and return an SDL surface. +

+ +
+
Procedure: save-png surface file
+

Save surface to file as a PNG formatted image. +

+ + + + + + 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 @@ + + + + + + +Index (Guile-SDL2) + + + + + + + + + + + + + + + + + + + +
+

+Previous: , Up: Top   [Contents][Index]

+
+
+ +

Index

+ +
Jump to:   % +   +
+B +   +C +   +D +   +F +   +G +   +H +   +I +   +J +   +K +   +L +   +M +   +N +   +O +   +P +   +Q +   +R +   +S +   +T +   +W +   +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Index Entry  Section
%
%default-chunk-size: Sound
%default-format: Sound
%default-frequency: Sound
B
blit-scaled: Surfaces
blit-surface: Surfaces
bytevector->surface: Surfaces
C
call-with-gl-context: OpenGL
call-with-renderer: Rendering
call-with-surface: Surfaces
call-with-window: Windows
channel-paused?: Sound
channel-playing?: Sound
chunk?: Sound
clear-renderer: Rendering
close-audio: Sound
close-game-controller: Game Controllers
close-joystick: Joysticks
close-window!: Windows
color-a: Surfaces
color-b: Surfaces
color-g: Surfaces
color-r: Surfaces
color?: Surfaces
controller-added-event?: Events
controller-axis-event-axis: Events
controller-axis-event-timestamp: Events
controller-axis-event-value: Events
controller-axis-event-which: Events
controller-axis-event?: Events
controller-button-down-event?: Events
controller-button-event-button: Events
controller-button-event-pressed?: Events
controller-button-event-timestamp: Events
controller-button-event-which: Events
controller-button-event?: Events
controller-button-up-event?: Events
controller-device-event-action: Events
controller-device-event-timestamp: Events
controller-device-event-which: Events
controller-device-event?: Events
controller-remapped-event?: Events
controller-removed-event?: Events
convert-surface-format: Surfaces
D
delete-chunk!: Sound
delete-font!: Fonts
delete-gl-context!: OpenGL
delete-music!: Sound
delete-renderer!: Rendering
delete-surface!: Surfaces
delete-texture!: Rendering
F
fill-rect: Surfaces
font-height: Fonts
G
game-controller-attached?: Game Controllers
game-controller-axis: Game Controllers
game-controller-button-pressed?: Game Controllers
game-controller-index?: Game Controllers
game-controller-joystick: Game Controllers
game-controller-name: Game Controllers
game-controller?: Game Controllers
H
hide-window!: Windows
I
id->window: Windows
image-init: Images
image-quit: Images
J
joystick-axis-event-button: Events
joystick-axis-event-pressed?: Events
joystick-axis-event-timestamp: Events
joystick-axis-event-which: Events
joystick-axis-event?: Events
joystick-ball-event-ball: Events
joystick-ball-event-timestamp: Events
joystick-ball-event-which: Events
joystick-ball-event-x-rel: Events
joystick-ball-event-y-rel: Events
joystick-ball-event?: Events
joystick-device-event-action: Events
joystick-device-event-timestamp: Events
joystick-device-event-which: Events
joystick-device-event?: Events
joystick-hat-event-hat: Events
joystick-hat-event-timestamp: Events
joystick-hat-event-value: Events
joystick-hat-event-which: Events
joystick-hat-event?: Events
joystick-instance-id: Joysticks
joystick-num-axes: Joysticks
joystick-num-balls: Joysticks
joystick-num-buttons: Joysticks
joystick-num-hats: Joysticks
joystick-power-level: Joysticks
K
key-pressed?: Keyboard
key-released?: Keyboard
keyboard-down-event?: Events
keyboard-event-key: Events
keyboard-event-modifiers: Events
keyboard-event-pressed?: Events
keyboard-event-repeat?: Events
keyboard-event-scancode: Events
keyboard-event-timestamp: Events
keyboard-event-window-id: Events
keyboard-event?: Events
keyboard-up-event?: Events
L
load-bmp: Surfaces
load-chunk: Sound
load-font: Fonts
load-game-controller-mappings!: Game Controllers
load-image: Images
load-music: Sound
M
make-controller-axis-event: Events
make-controller-button-event: Events
make-controller-device-event: Events
make-gl-context: OpenGL
make-joystick-axis-event: Events
make-joystick-ball-event: Events
make-joystick-device-event: Events
make-joystick-hat-event: Events
make-keyboard-event: Events
make-mouse-button-event: Events
make-mouse-motion-event: Events
make-quit-event: Events
make-rect: Rects
make-renderer: Rendering
make-rgb-surface: Surfaces
make-text-input-event: Events
make-window: Windows
make-window-event: Events
maximize-window!: Windows
minimize-window!: Windows
mixer-init: Sound
mixer-quit: Sound
mouse-button-down-event?: Events
mouse-button-event-button: Events
mouse-button-event-clicks: Events
mouse-button-event-pressed?: Events
mouse-button-event-timestamp: Events
mouse-button-event-which: Events
mouse-button-event-window-id: Events
mouse-button-event-x: Events
mouse-button-event-y: Events
mouse-button-event?: Events
mouse-button-pressed?: Mouse
mouse-button-released?: Mouse
mouse-button-up-event?: Events
mouse-motion-event-buttons: Events
mouse-motion-event-timestamp: Events
mouse-motion-event-which: Events
mouse-motion-event-window-id: Events
mouse-motion-event-x: Events
mouse-motion-event-x-rel: Events
mouse-motion-event-y: Events
mouse-motion-event-y-rel: Events
mouse-motion-event?: Events
mouse-x: Mouse
mouse-y: Mouse
music-paused?: Sound
music-playing?: Sound
music-volume: Sound
music?: Sound
N
num-joysticks: Joysticks
O
open-audio: Sound
open-game-controller: Game Controllers
open-joystick: Joysticks
P
palette-colors: Surfaces
palette-length: Surfaces
palette?: Surfaces
pause-channel!: Sound
pause-music!: Sound
paused-channels-count: Sound
pixel-format-alpha-mask: Surfaces
pixel-format-bits-per-pixel: Surfaces
pixel-format-blue-mask: Surfaces
pixel-format-bytes-per-pixel: Surfaces
pixel-format-green-mask: Surfaces
pixel-format-name: Surfaces
pixel-format-palette: Surfaces
pixel-format-red-mask: Surfaces
pixel-format?: Surfaces
play-chunk!: Sound
play-music!: Sound
playing-channels-count: Sound
poll-event: Events
present-renderer: Rendering
Q
quit-event-timestamp: Events
quit-event?: Events
R
raise-window!: Windows
rect-height: Rects
rect-width: Rects
rect-x: Rects
rect-y: Rects
render-copy: Rendering
render-draw-line: Rendering
render-draw-lines: Rendering
render-draw-point: Rendering
render-draw-points: Rendering
render-font-blended: Fonts
render-font-solid: Fonts
renderer?: Rendering
restore-window!: Windows
resume-channel!: Sound
resume-music!: Sound
rewind-music!: Sound
S
save-png: Images
sdl-init: Basics
sdl-quit: Basics
sdl-ticks: Basics
sdl-version: Basics
set-channel-volume!: Sound
set-chunk-volume!: Sound
set-gl-attribute!: OpenGL
set-gl-swap-interval!: OpenGL
set-music-volume!: Sound
set-window-border!: Windows
set-window-fullscreen!: Windows
set-window-position!: Windows
set-window-size!: Windows
set-window-title!: Windows
show-window!: Windows
stop-channel!: Sound
stop-music!: Sound
surface->texture: Rendering
surface-height: Surfaces
surface-pitch: Surfaces
surface-pixel-format: Surfaces
surface-pixels: Surfaces
surface-width: Surfaces
swap-gl-window: OpenGL
T
text-input-event-text: Events
text-input-event-timestamp: Events
text-input-event-window-id: Events
text-input-event?: Events
ttf-init: Fonts
ttf-quit: Fonts
W
window-closed-event?: Events
window-enter-event?: Events
window-event-timestamp: Events
window-event-type: Events
window-event-vector: Events
window-event-window-id: Events
window-event?: Events
window-exposed-event?: Events
window-focus-gained-event?: Events
window-focus-lost-event?: Events
window-hidden-event?: Events
window-id: Windows
window-leave-event?: Events
window-maximized-event?: Events
window-minimized-event?: Events
window-moved-event?: Events
window-position: Windows
window-resized-event?: Events
window-restored-event?: Events
window-shown-event?: Events
window-size: Windows
window-size-changed-event?: Events
window-title: Windows
+
Jump to:   % +   +
+B +   +C +   +D +   +F +   +G +   +H +   +I +   +J +   +K +   +L +   +M +   +N +   +O +   +P +   +Q +   +R +   +S +   +T +   +W +   +
+ +
+
+

+Previous: , Up: Top   [Contents][Index]

+
+ + + + + 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 @@ + + + + + + +Input (Guile-SDL2) + + + + + + + + + + + + + + + + + + + + +
+

+Next: , Previous: , Up: API Reference   [Contents][Index]

+
+
+ +

3.3 Input

+ + + + + + +
• Keyboard:  Keyboard input. +
• Mouse:  Mouse input. +
• Joysticks:  Joystick input. +
• Game Controllers:  Game controller input. +
+ + + + + + 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 @@ + + + + + + +Installation (Guile-SDL2) + + + + + + + + + + + + + + + + + + + + +
+

+Next: , Previous: , Up: Top   [Contents][Index]

+
+
+ +

2 Installation

+ +

Guile-SDL2 is available for download from its website at +dthompson.us/projects/guile-sdl2.html. This section describes +the software requirements of Guile-SDL2, as well as how to install it. +

+

The build procedure for Guile-SDL2 is the same as for GNU software +packages, and is not covered here. Please see the files +README.org and INSTALL.org for additional details. +

+ + +
• Requirements:  Software needed to build and run Guile-SDL2. +
+ + + + + + 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 @@ + + + + + + +Introduction (Guile-SDL2) + + + + + + + + + + + + + + + + + + + + +
+

+Next: , Previous: , Up: Top   [Contents][Index]

+
+
+ +

1 Introduction

+ +

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. +

+

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 API Reference +

+

As of this writing, the bindings are useful, but incomplete. +If you find an SDL2 feature that you cannot use with Guile-SDL2, let +us know and maybe send a patch! see Contributing +

+ + + + + 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 @@ + + + + + + +Joysticks (Guile-SDL2) + + + + + + + + + + + + + + + + + + + + +
+

+Next: , Previous: , Up: Input   [Contents][Index]

+
+
+ +

3.3.3 Joysticks

+ +
+
(use-modules (sdl2 input joystick))
+
+ +
+
Procedure: num-joysticks
+

Return the current number of connected joystick devices. +

+ +
+
Procedure: open-joystick device-index
+

Return a joystick object for the physical joystick device associated +with device-index. +

+ +
+
Procedure: close-joystick joystick
+

Close joystick. +

+ +
+
Procedure: joystick-instance-id joystick
+

Return the instance id of joystick. +

+ +
+
Procedure: joystick-power-level joystick
+

Return the symbolic battery power level for joystick, either +unknown, empty, low, medium, full, +or wired. +

+ +
+
Procedure: joystick-num-axes joystick
+

Return the number of axes for joystick. +

+ +
+
Procedure: joystick-num-balls joystick
+

Return the number of balls for joystick. +

+ +
+
Procedure: joystick-num-buttons joystick
+

Return the number of buttons for joystick. +

+ +
+
Procedure: joystick-num-hats joystick
+

Return the number of hats for joystick. +

+ + + + + + 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 @@ + + + + + + +Keyboard (Guile-SDL2) + + + + + + + + + + + + + + + + + + + + +
+

+Next: , Up: Input   [Contents][Index]

+
+
+ +

3.3.1 Keyboard

+ +
+
(use-modules (sdl2 input keyboard))
+
+ +
+
Procedure: key-pressed? key
+

Return #t if key is currently being pressed. +

+ +
+
Procedure: key-released? key
+

Return #t is key is not currently being pressed. +

+ + + + + + 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 @@ + + + + + + +Mouse (Guile-SDL2) + + + + + + + + + + + + + + + + + + + + +
+

+Next: , Previous: , Up: Input   [Contents][Index]

+
+
+ +

3.3.2 Mouse

+ +
+
(use-modules (sdl2 input mouse))
+
+ +
+
Procedure: mouse-x
+

Return the x coordinate of the mouse cursor. +

+ +
+
Procedure: mouse-y
+

Return the y coordinate of the mouse cursor. +

+ +
+
Procedure: mouse-button-pressed? button
+

Return #t if button is currently being pressed. +

+ +
+
Procedure: mouse-button-released? button
+

Return #t if button is not currently being pressed. +

+ + + + + + 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 @@ + + + + + + +OpenGL (Guile-SDL2) + + + + + + + + + + + + + + + + + + + + +
+

+Previous: , Up: Window Management   [Contents][Index]

+
+
+ +

3.2.2 OpenGL

+ +
+
Procedure: make-gl-context window
+

Create an OpenGL context for window. +

+ +
+
Procedure: delete-gl-context! context
+

Delete context, an OpenGL context object. +

+ +
+
Procedure: call-with-gl-context window proc
+

Call proc with a new OpenGL context created for window, and +close the context when proc returns or otherwise exits. +

+ +
+
Procedure: swap-gl-window window
+

Update window with OpenGL rendering. +

+ +
+
Procedure: set-gl-attribute! attr value
+

Set the OpenGL attribute represented by the symbol attr to +value. Possible values for attr are: +

+
    +
  • red-size +
  • green-size +
  • blue-size +
  • alpha-size +
  • buffer-size +
  • double-buffer +
  • depth-size +
  • stencil-size +
  • accum-red-size +
  • accum-green-size +
  • accum-blue-size +
  • stereo +
  • multisample-buffers +
  • multisample-samples +
  • retained-backing +
  • context-major-version +
  • context-minor-version +
  • context-egl +
  • context-flags +
  • context-profile-mask +
  • share-with-current-context +
  • framebuffer-srgb-capable +
+ +
+ +
+
Procedure: set-gl-swap-interval! interval
+

Set the framebuffer swap interval for the current OpenGL context to the +type indicated by the symbol interval. Possible values of +interval are: +

+
    +
  • immediate, for immediate updates +
  • vsync, for updates synchronized with the screen’s vertical retrace +
  • late-swap-tear, for late swap tearing +
+ +

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. +

+ + + + + + 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 @@ + + + + + + +Rects (Guile-SDL2) + + + + + + + + + + + + + + + + + + + + +
+

+Next: , Previous: , Up: API Reference   [Contents][Index]

+
+
+ +

3.5 Rects

+ +
+
(use-modules (sdl2 rect))
+
+ +
+
Procedure: make-rect x y width height
+

Return a new rectangle whose upper-left corner is at (x, +y) and is width pixels wide and height pixels high. +

+ +
+
Procedure: rect-x rect
+

Return the X coordinate of rect. +

+ +
+
Procedure: rect-y rect
+

Return the Y coordinate of rect. +

+ +
+
Procedure: rect-width rect
+

Return the width of rect. +

+ +
+
Procedure: rect-height rect
+

Return the height of rect. +

+ + + + + + 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 @@ + + + + + + +Rendering (Guile-SDL2) + + + + + + + + + + + + + + + + + + + + +
+

+Next: , Previous: , Up: API Reference   [Contents][Index]

+
+
+ +

3.7 Rendering

+ +
+
(use-modules (sdl2 render))
+
+ +
+
Procedure: make-renderer window [#:optional flags='(accelerated vsync)]
+

Return a new renderer for window created with the options specified +in flags, a list of symbols. The valid symbols that may appear in +flags are: +

+
    +
  • software, to use a software renderer fallback +
  • accelerated, to use hardware acceleration +
  • vsync, to synchronize rendering with the monitor’s refresh rate +
  • texture, for render to texture support +
+
+ +
+
Procedure: renderer? r
+

Return #t if r is a renderer. +

+ +
+
Procedure: delete-renderer! renderer
+

Delete the rendering context renderer. +

+ +
+
Procedure: call-with-renderer renderer proc
+

Call proc, passing it renderer and closing renderer upon exit +of proc. +

+ +
+
Procedure: clear-renderer renderer
+

Clear the rendering target renderer with the current drawing color. +

+ +
+
Procedure: present-renderer renderer
+

Display renderer. +

+ +
+
Procedure: render-copy renderer texture [#:angle 0] [#:srcrect] [#:dstrect] [#:center]
+

Copy texture to the rendering target of renderer. +

+ +
+
Procedure: render-draw-line renderer x1 y1 x2 y2
+

Draw a line from (x1, y1) to (x2, y2) on the +current rendering target of renderer. +

+ +
+
Procedure: render-draw-lines renderer point
+

Draw a series of connected lines from points on the current +rendering target of renderer. +

+ +
+
Procedure: render-draw-point renderer x y
+

Draw a point at (x, y) on the current rendering target +of renderer. +

+ +
+
Procedure: render-draw-points renderer points
+

Draw a multiple points from points on the current rendering +target of renderer. +

+ +
+
Procedure: surface->texture renderer surface
+

Convert surface to a texture suitable for renderer. +

+ +
+
Procedure: delete-texture! texture
+

Free the memory used by texture. +

+ +
+
+

+Next: , Previous: , Up: API Reference   [Contents][Index]

+
+ + + + + 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 @@ + + + + + + +Requirements (Guile-SDL2) + + + + + + + + + + + + + + + + + + + + +
+

+Up: Installation   [Contents][Index]

+
+
+ +

2.1 Requirements

+ +

Guile-SDL2 depends on the following packages: +

+ + +

Guile-SDL2 has the following optional dependencies: +

+ + + + + + + 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 @@ + + + + + + +Sound (Guile-SDL2) + + + + + + + + + + + + + + + + + + + + +
+

+Next: , Previous: , Up: API Reference   [Contents][Index]

+
+
+ +

3.9 Sound

+ +
+
(use-modules (sdl2 mixer))
+
+ +
+
Scheme Variable: %default-frequency
+
+ +
+
Scheme Variable: %default-format
+
+ +
+
Scheme Variable: %default-chunk-size
+
+ +
+
Procedure: mixer-init [#:optional formats='(flac mod modplug mp3 ogg fluidsynth)]
+

Initialize mixer library with support for formats, a list of +symbols representing audio file formats. Possible formats are: +

+
    +
  • flac +
  • mod +
  • modplug +
  • mp3 +
  • ogg +
  • fluidsynth +
+
+ +
+
Procedure: mixer-quit
+

Shutdown mixer library. +

+ +
+
Procedure: open-audio [#:frequency=%default-frequency] [#:format=%default-format] [#:stereo?=#t] [#:chunk-size=%default-chunk-size]
+

Initialize the mixer API. frequency specificies the sample rate in +hertz. When stereo? is #t, two output channels are used, otherwise +mono output is used instead. chunk-size specifies the number of bytes +used per output sample. format is a symbol that specifies the output +sample format. Possible values are: +

+
    +
  • u8 +
  • s8 +
  • u16lsb +
  • s16lsb +
  • u16msb +
  • s16msb +
  • u16 +
  • s16 +
  • s32lsb +
  • s32msb +
  • s32 +
  • f32lsb +
  • f32msb +
  • f32 +
+
+ +
+
Procedure: close-audio
+

Shut down the mixer API. +

+ +
+
Procedure: chunk? c
+

Return #t if c is a chunk. +

+ +
+
Procedure: load-chunk file
+

Load the audio data in file and return an audio chunk. +

+ +
+
Procedure: delete-chunk! chunk
+

Free the memory used for chunk. +

+ +
+
Procedure: set-chunk-volume! chunk volume
+

Set the loudness of chunk to volume, an integer in the range +[0,128]. Return the previous chunk volume setting. +

+ +
+
Procedure: play-chunk! chunk [#:loops=0] [#:channel]
+

Play chunk on channel, an integer channel identifier or #f +to use the first unreserved audio channel. chunk will play loops + +1 times. Return the channel identifier that chunk is played on. +

+ +
+
Procedure: set-channel-volume! channel volume
+

Set the loudness of channel, an integer channel identifier or #f +for all channels, to volume, an integer in the range [0,128]. Return +the previous volume of channel, or the average of all channels if +channel is #f. +

+ +
+
Procedure: pause-channel! channel
+

Pause playback on channel, an integer channel identifier, or #f to +pause all channels. +

+ +
+
Procedure: resume-channel! channel
+

Resume playback on channel, an integer channel identifier, or #f to +resume all channels. +

+ +
+
Procedure: stop-channel! channel
+

Halt playback on channel, an integer channel identifier, or #f to +halt all channels. +

+ +
+
Procedure: channel-playing? channel
+

Return #t if channel is playing. +

+ +
+
Procedure: playing-channels-count
+

Return the number of channels currently playing. +

+ +
+
Procedure: channel-paused? channel
+

Return #t if channel is paused. +

+ +
+
Procedure: paused-channels-count
+

Return the number of channels that are paused. +

+ +
+
Procedure: music? m
+

Return #t if m is music. +

+ +
+
Procedure: load-music file
+

Load music from file. +

+ +
+
Procedure: delete-music! music
+

Delete the memory used for music. +

+ +
+
Procedure: play-music! music [#:optional loops=1]
+

Play music, repeated loops times. loops may be #f, in +which case the music loops indefinitely. +

+ +
+
Procedure: set-music-volume! volume
+

Set music loudness to volume, an integer in the range [0,128]. Return the +previous volume. +

+ +
+
Procedure: music-volume
+

Return the music volume. +

+ +
+
Procedure: pause-music!
+

Puase the music. +

+ +
+
Procedure: resume-music!
+

Resume music playback. +

+ +
+
Procedure: rewind-music!
+

Start music playback from the beginning. Rewinding is only supported for MOD, +OGG, MP3, and native MIDI music. +

+ +
+
Procedure: stop-music!
+

Halt music playback. +

+ +
+
Procedure: music-playing?
+

Return #t if music is currently playing. +

+ +
+
Procedure: music-paused?
+

Return #t if music is currently paused. +

+ +
+
+

+Next: , Previous: , Up: API Reference   [Contents][Index]

+
+ + + + + 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 @@ + + + + + + +Submitting Patches (Guile-SDL2) + + + + + + + + + + + + + + + + + + + + +
+

+Next: , Previous: , Up: Contributing   [Contents][Index]

+
+
+ +

4.2 Submitting Patches

+ +

Patches generated by git format-patch may be sent to +davet@gnu.org. Thanks in advance! +

+ + + + + 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 @@ + + + + + + +Surfaces (Guile-SDL2) + + + + + + + + + + + + + + + + + + + + +
+

+Next: , Previous: , Up: API Reference   [Contents][Index]

+
+
+ +

3.6 Surfaces

+ +
+
(use-modules (sdl2 surface))
+
+ +
+
Procedure: color? c
+

Return #t if c is a color. +

+ +
+
Procedure: color-r c
+
+ +
+
Procedure: color-g c
+
+ +
+
Procedure: color-b c
+
+ +
+
Procedure: color-a c
+
+ +
+
Procedure: palette? p
+

Return #t if p is a palette. +

+ +
+
Procedure: palette-length palette
+

Return the number of colors in palette. +

+ +
+
Procedure: palette-colors palette
+

Return the colors in palette. +

+ +
+
Procedure: pixel-format? pf
+

Return #t if pf is a pixel format. +

+ +
+
Procedure: pixel-format-name pf
+

Return the symbolic name of the pixel format pf. +

+ +
+
Procedure: pixel-format-palette pf
+

Return the palette for the pixel format pf. +

+ +
+
Procedure: pixel-format-bits-per-pixel pf
+

Return the number of bits per pixel for the pixel format pf. +

+ +
+
Procedure: pixel-format-bytes-per-pixel pf
+

Return the number of bytes per pixel for the pixel format pf. +

+ +
+
Procedure: pixel-format-red-mask pf
+

Return the bitmask for the red component of a pixel in the pixel format +pf. +

+ +
+
Procedure: pixel-format-green-mask pf
+

Return the bitmask for the green component of a pixel in the pixel format +pf. +

+ +
+
Procedure: pixel-format-blue-mask pf
+

Return the bitmask for the blue component of a pixel in the pixel format +pf. +

+ +
+
Procedure: pixel-format-alpha-mask pf
+

Return the bitmask for the alpha component of a pixel in the pixel format +pf. +

+ +
+
Procedure: make-rgb-surface width height depth
+

Create a new SDL surface with the dimensions width and height and +depth bits per pixel. +

+ +
+
Procedure: bytevector->surface bv width height depth pitch
+

Convert bv, a bytevector of pixel data with dimensions +widthxheight, to an SDL surface. Each pixel is depth bits in +size, and each row of pixels is pitch bytes in size. +

+ +
+
Procedure: delete-surface! surface
+

Free the memory used by surface. +

+ +
+
Procedure: call-with-surface surface proc
+

Call proc, passing it surface and deleting surface upon exit +of proc. +

+ +
+
Procedure: load-bmp file
+

Create a new surface from the bitmap data in file. +

+ +
+
Procedure: surface-width surface
+

Return the width of surface in pixels. +

+ +
+
Procedure: surface-height surface
+

Return the height of surface in pixels. +

+ +
+
Procedure: surface-pitch surface
+

Return the length of a row of pixels in surface in bytes. +

+ +
+
Procedure: surface-pixels surface
+

Return a bytevector containing the raw pixel data in surface. +

+ +
+
Procedure: surface-pixel-format surface
+

Return the pixel format for surface. +

+ +
+
Procedure: convert-surface-format surface format
+

Convert the pixels in surface to format, a symbol representing a +specific pixel format, and return a new surface object. +

+

Valid format types are: +

+
    +
  • index1lsb +
  • index1msb +
  • index4lsb +
  • index4msb +
  • index8 +
  • rgb332 +
  • rgb444 +
  • rgb555 +
  • bgr555 +
  • argb4444 +
  • rgba4444 +
  • abgr4444 +
  • bgra4444 +
  • argb1555 +
  • rgba5551 +
  • abgr1555 +
  • bgra5551 +
  • rgb565 +
  • bgr565 +
  • rgb24 +
  • bgr24 +
  • rgb888 +
  • rgbx8888 +
  • bgr888 +
  • bgrx8888 +
  • argb8888 +
  • rgba8888 +
  • abgr8888 +
  • bgra8888 +
  • argb2101010 +
  • yv12 +
  • iyuv +
  • yuy2 +
  • uyvy +
  • yvyu +
+
+ +
+
Procedure: blit-surface src src-rect dst dst-rect
+

Blit the rectangle src-rect from the surface src to +dst-rect of the surface dst. +

+ +
+
Procedure: blit-scaled src src-rect dst dst-rect
+

Blit the rectangle src-rect from the surface src to +dst-rect of the surface dst, scaling the source to fit the +destination. +

+ +
+
Procedure: fill-rect dst rect color
+

Fill rect with color, a 32-bit color encoded as an integer +value, in the surface dst. +

+ +
+
+

+Next: , Previous: , Up: API Reference   [Contents][Index]

+
+ + + + + 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 @@ + + + + + + +Window Management (Guile-SDL2) + + + + + + + + + + + + + + + + + + + + +
+

+Next: , Previous: , Up: API Reference   [Contents][Index]

+
+
+ +

3.2 Window Management

+ + + + +
• Windows:  Window manipulation. +
• OpenGL:  OpenGL contexts. +
+ +
+
(use-modules (sdl2 video))
+
+ + + + + + 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 @@ + + + + + + +Windows (Guile-SDL2) + + + + + + + + + + + + + + + + + + + + +
+

+Next: , Up: Window Management   [Contents][Index]

+
+
+ +

3.2.1 Windows

+ +
+
Procedure: make-window [#: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]
+

Create a new window named title with dimensions size located +at position on the display. position and size are +two-element lists in the form (x y), where each coordinate is +measured in pixels. In the case of position, a coordinate may use +the special symbol center to indicate that the window should be +centered on that axis, or #f to indicate that it does not matter +where the window is located on that axis. +

+ +
+
Procedure: close-window! window
+

Close window. +

+ +
+
Procedure: call-with-window window proc
+

Call proc with window, an SDL window object, and close it +when proc returns or otherwise exits. +

+ +
+
Procedure: window-title window
+

Return the title for window. +

+ +
+
Procedure: window-size window
+

Return the dimensions of window. +

+ +
+
Procedure: window-position window
+

Return the position of window on the display. +

+ +
+
Procedure: window-id window
+

Return the numeric ID of window. +

+ +
+
Procedure: id->window id
+

Return the window corresponding to ID, a positive integer, or +#f if there is no such window. +

+ +
+
Procedure: hide-window! window
+

Hide window. +

+ +
+
Procedure: show-window! window
+

Show window and focus on it. +

+ +
+
Procedure: maximize-window! window
+

Make window as large as possible. +

+ +
+
Procedure: minimize-window! window
+

Shrink window to an iconic representation. +

+ +
+
Procedure: raise-window! window
+

Raise window above all other windows and set input focus. +

+ +
+
Procedure: restore-window! window
+

Restore the size and position of a minimized or maximized window. +

+ +
+
Procedure: set-window-border! window border?
+

When border?, draw the usual border around window, otherwise +remove the border. +

+ +
+
Procedure: set-window-title! window title
+

Set the title of window to the string title. +

+ +
+
Procedure: set-window-position! window position
+

Set the position of window to position, a two-element list +of (x,y) coordinates measured in pixels. +

+ +
+
Procedure: set-window-size! window size
+

Set the dimensions of window to size, a two-element list of +(width,height) coordinates measured in pixels. +

+ +
+
Procedure: set-window-fullscreen! window fullscreen? [#:desktop?]
+

Toggle fullscreen mode on/off for window. If fullscreen?, +fullscreen mode is activated, otherwise it is deactivated. If +fullscreen? and desktop?, a special "fake" fullscreen mode +is used that takes the size of the desktop. +

+ +
+
+

+Next: , Up: Window Management   [Contents][Index]

+
+ + + + + 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 @@ + + + + + + +Top (Guile-SDL2) + + + + + + + + + + + + + + + + + + +

Guile-SDL2

+ + + +

Table of Contents

+ +
+ + +
+ + + +
+

+Next: , Up: (dir)   [Contents][Index]

+
+
+ +

Guile-SDL2

+ +

Copyright © 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 +GNU Texinfo. +

+ + + + + + + + + +
• Introduction:  About Guile-SDL2. +
• Installation:  Installing Guile-SDL2. +
• API Reference:  High-level Scheme interfaces to SDL2. +
• Contributing:  Guidelines for hacking Guile-SDL2. +
+
+
• Copying This Manual:  The GNU Free Documentation License and you! +
• Index:   +
+ + +
+
+

+Next: , Up: (dir)   [Contents][Index]

+
+ + + + + -- cgit v1.2.3