API Reference (Guile-SDL2)

From ce9d6e8ad28b2d84d1a292a871c23b66a4654b54 Mon Sep 17 00:00:00 2001 From: David Thompson Date: Tue, 13 Apr 2021 11:30:50 -0400 Subject: Add new guile-sdl2 and chickadee releases. --- manuals/guile-sdl2/API-Reference.html | 57 +- manuals/guile-sdl2/Basics.html | 51 +- manuals/guile-sdl2/Blend-Modes.html | 203 +++++++ manuals/guile-sdl2/Chat.html | 33 +- manuals/guile-sdl2/Contributing.html | 39 +- manuals/guile-sdl2/Copying-This-Manual.html | 35 +- manuals/guile-sdl2/Events.html | 251 ++++---- manuals/guile-sdl2/Fonts.html | 120 +++- .../guile-sdl2/GNU-Free-Documentation-License.html | 46 +- manuals/guile-sdl2/Game-Controllers.html | 53 +- manuals/guile-sdl2/Getting-the-Source.html | 33 +- manuals/guile-sdl2/Hints.html | 116 ++++ manuals/guile-sdl2/Images.html | 41 +- manuals/guile-sdl2/Index.html | 641 +++++++++++---------- manuals/guile-sdl2/Input.html | 41 +- manuals/guile-sdl2/Installation.html | 35 +- manuals/guile-sdl2/Introduction.html | 37 +- manuals/guile-sdl2/Joysticks.html | 51 +- manuals/guile-sdl2/Keyboard.html | 37 +- manuals/guile-sdl2/Mouse.html | 41 +- manuals/guile-sdl2/OpenGL.html | 45 +- manuals/guile-sdl2/Rects.html | 63 +- manuals/guile-sdl2/Rendering.html | 205 +++++-- manuals/guile-sdl2/Requirements.html | 33 +- manuals/guile-sdl2/Sound.html | 99 ++-- manuals/guile-sdl2/Submitting-Patches.html | 33 +- manuals/guile-sdl2/Surfaces.html | 97 ++-- manuals/guile-sdl2/Window-Management.html | 37 +- manuals/guile-sdl2/Windows.html | 115 ++-- manuals/guile-sdl2/index.html | 105 ++-- 30 files changed, 1600 insertions(+), 1193 deletions(-) create mode 100644 manuals/guile-sdl2/Blend-Modes.html create mode 100644 manuals/guile-sdl2/Hints.html (limited to 'manuals/guile-sdl2') diff --git a/manuals/guile-sdl2/API-Reference.html b/manuals/guile-sdl2/API-Reference.html index 50560bb..26f284b 100644 --- a/manuals/guile-sdl2/API-Reference.html +++ b/manuals/guile-sdl2/API-Reference.html @@ -1,6 +1,6 @@ - - + API Reference (Guile-SDL2) @@ -26,33 +28,24 @@ http://www.texinfo.org/ (GNU Texinfo). - - + + - - - + + + + + + + + + + +

3.8 Blend Modes

+ +

(use-modules (sdl2 blend-mode))
+

+ +

SDL2 provides several of the most commonly used blend modes: +

Variable: none: No blending. +

+ +

Variable: blend: Alpha blending. +

+ +

Variable: add: Additive blending. +

+ +

Variable: mul: Multiplicative blending. +

+ +

Variable: mod: Color modulation. +

+ +

Custom blend modes can be created using the make-blend-mode +procedure. +

Procedure: make-blend-mode src-color-factor dst-color-factor color-operation src-alpha-factor dst-alpha-factor alpha-operation

Return a new custom blend mode for renderers. +

src-color-factor applies to the red, green, and blue components +of the source pixels. +

dst-color-factor applies to the red, green, and blue components of the +destination pixels. +

color-operation specifies how to combine the red, green, and blue +components of the source and destination pixels. +

src-alpha-factor applies to the alpha component of the source pixels. +

dst-alpha-factor applies to the alpha component of the destination +pixels. +

alpha-operation specifies how to combine the alpha component of the +source and destination pixels. +

Possible values for factors are zero, one, +src-color, one-minus-src-color, src-alpha, +one-minus-src-alpha, dst-color, +one-minus-dst-color, dst-alpha, and one-minus-dst +alpha. +

Possible values for operations are add, subtract, +rev-subtract, minimum, and maximum. +

+ +

Procedure: blend-mode? obj: Return #t if obj is a blend mode object. +

+ +

Procedure: blend-mode-src-color-factor blend-mode: Return the source red, green, and blue channel blend factor for +blend-mode. +

+ +

Procedure: blend-mode-dst-color-factor blend-mode: Return the destination red, green, and blue channel blend factor for +blend-mode. +

+ +

Procedure: blend-mode-color-operation blend-mode: Return the red, green, and blue channel blend operation for +blend-mode. +

+ +

Procedure: blend-mode-src-alpha-factor blend-mode: Return the source alpha channel blend factor for blend-mode. +

+ +

Procedure: blend-mode-dst-alpha-factor blend-mode: Return the destination alpha channel blend factor for +blend-mode. +

+ +

Procedure: blend-mode-alpha-operation blend-mode: Return the alpha channel blend operation for blend-mode. +

+ +

+ + + + + + diff --git a/manuals/guile-sdl2/Chat.html b/manuals/guile-sdl2/Chat.html index 1bd0642..434f53c 100644 --- a/manuals/guile-sdl2/Chat.html +++ b/manuals/guile-sdl2/Chat.html @@ -1,6 +1,6 @@ - - + Chat (Guile-SDL2) @@ -26,33 +28,24 @@ http://www.texinfo.org/ (GNU Texinfo). - - + + - - - + + + + + + + + + + +

3.12 Hints

+ +

(use-modules (sdl2 hints))
+

+ +

Procedure: get-hint hint: Get the string value of hint or #f if if hint is unset. +

+ +

Procedure: set-hint! hint value [priority]: Set hint to value at priority level priority. +priority can be one of the symbols default, normal or +override and defaults to normal. +value will automatically be converted to a string if it is a boolean +or a number. +

+ +

Inside SDL2, the macro SDL_HINT_SOME_HINT corresponds to the +environment variable SDL_SOME_HINT. In Guile-SDL2, this hint would be +represented by the symbol some-symbol. +

+ + + + + diff --git a/manuals/guile-sdl2/Images.html b/manuals/guile-sdl2/Images.html index 410d942..b4de67a 100644 --- a/manuals/guile-sdl2/Images.html +++ b/manuals/guile-sdl2/Images.html @@ -1,6 +1,6 @@ - - + Images (Guile-SDL2) @@ -26,33 +28,24 @@ http://www.texinfo.org/ (GNU Texinfo). - - + + - - - + + +