diff options
Diffstat (limited to 'manuals/guile-sdl2/Surfaces.html')
| -rw-r--r-- | manuals/guile-sdl2/Surfaces.html | 97 |
1 files changed, 44 insertions, 53 deletions
diff --git a/manuals/guile-sdl2/Surfaces.html b/manuals/guile-sdl2/Surfaces.html index 7a094fe..9597c80 100644 --- a/manuals/guile-sdl2/Surfaces.html +++ b/manuals/guile-sdl2/Surfaces.html @@ -1,6 +1,6 @@ <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> <html> -<!-- Copyright (C) 2016 David Thompson davet@gnu.org +<!-- 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 @@ -13,10 +13,12 @@ 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.5, http://www.gnu.org/software/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>Surfaces (Guile-SDL2)</title> @@ -26,33 +28,24 @@ http://www.texinfo.org/ (GNU Texinfo). <meta name="resource-type" content="document"> <meta name="distribution" content="global"> <meta name="Generator" content="makeinfo"> -<link href="index.html#Top" rel="start" title="Top"> -<link href="Index.html#Index" rel="index" title="Index"> +<link href="index.html" 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="API-Reference.html#API-Reference" rel="up" title="API Reference"> -<link href="Rendering.html#Rendering" rel="next" title="Rendering"> -<link href="Rects.html#Rects" rel="prev" title="Rects"> +<link href="API-Reference.html" rel="up" title="API Reference"> +<link href="Rendering.html" rel="next" title="Rendering"> +<link href="Rects.html" rel="prev" title="Rects"> <style type="text/css"> <!-- a.summary-letter {text-decoration: none} blockquote.indentedblock {margin-right: 0em} -blockquote.smallindentedblock {margin-right: 0em; font-size: smaller} -blockquote.smallquotation {font-size: smaller} div.display {margin-left: 3.2em} div.example {margin-left: 3.2em} div.lisp {margin-left: 3.2em} -div.smalldisplay {margin-left: 3.2em} -div.smallexample {margin-left: 3.2em} -div.smalllisp {margin-left: 3.2em} kbd {font-style: oblique} pre.display {font-family: inherit} pre.format {font-family: inherit} pre.menu-comment {font-family: serif} pre.menu-preformatted {font-family: serif} -pre.smalldisplay {font-family: inherit; font-size: smaller} -pre.smallexample {font-size: smaller} -pre.smallformat {font-family: inherit; font-size: smaller} -pre.smalllisp {font-size: smaller} span.nolinebreak {white-space: nowrap} span.roman {font-family: initial; font-weight: normal} span.sansserif {font-family: sans-serif; font-weight: normal} @@ -87,160 +80,158 @@ ul.no-bullet {list-style: none} </head> <body lang="en"> -<a name="Surfaces"></a> -<div class="header"> +<span id="Surfaces"></span><div class="header"> <p> -Next: <a href="Rendering.html#Rendering" accesskey="n" rel="next">Rendering</a>, Previous: <a href="Rects.html#Rects" accesskey="p" rel="prev">Rects</a>, Up: <a href="API-Reference.html#API-Reference" accesskey="u" rel="up">API Reference</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Index.html#Index" title="Index" rel="index">Index</a>]</p> +Next: <a href="Rendering.html" accesskey="n" rel="next">Rendering</a>, Previous: <a href="Rects.html" accesskey="p" rel="prev">Rects</a>, Up: <a href="API-Reference.html" accesskey="u" rel="up">API Reference</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Index.html" title="Index" rel="index">Index</a>]</p> </div> <hr> -<a name="Surfaces-1"></a> -<h3 class="section">3.6 Surfaces</h3> +<span id="Surfaces-1"></span><h3 class="section">3.6 Surfaces</h3> <div class="example"> <pre class="example">(use-modules (sdl2 surface)) </pre></div> <dl> -<dt><a name="index-color_003f"></a>Procedure: <strong>color?</strong> <em>c</em></dt> +<dt id="index-color_003f">Procedure: <strong>color?</strong> <em>c</em></dt> <dd><p>Return <code>#t</code> if <var>c</var> is a color. </p></dd></dl> <dl> -<dt><a name="index-color_002dr"></a>Procedure: <strong>color-r</strong> <em>c</em></dt> +<dt id="index-color_002dr">Procedure: <strong>color-r</strong> <em>c</em></dt> </dl> <dl> -<dt><a name="index-color_002dg"></a>Procedure: <strong>color-g</strong> <em>c</em></dt> +<dt id="index-color_002dg">Procedure: <strong>color-g</strong> <em>c</em></dt> </dl> <dl> -<dt><a name="index-color_002db"></a>Procedure: <strong>color-b</strong> <em>c</em></dt> +<dt id="index-color_002db">Procedure: <strong>color-b</strong> <em>c</em></dt> </dl> <dl> -<dt><a name="index-color_002da"></a>Procedure: <strong>color-a</strong> <em>c</em></dt> +<dt id="index-color_002da">Procedure: <strong>color-a</strong> <em>c</em></dt> </dl> <dl> -<dt><a name="index-palette_003f"></a>Procedure: <strong>palette?</strong> <em>p</em></dt> +<dt id="index-palette_003f">Procedure: <strong>palette?</strong> <em>p</em></dt> <dd><p>Return <code>#t</code> if <var>p</var> is a palette. </p></dd></dl> <dl> -<dt><a name="index-palette_002dlength"></a>Procedure: <strong>palette-length</strong> <em>palette</em></dt> +<dt id="index-palette_002dlength">Procedure: <strong>palette-length</strong> <em>palette</em></dt> <dd><p>Return the number of colors in <var>palette</var>. </p></dd></dl> <dl> -<dt><a name="index-palette_002dcolors"></a>Procedure: <strong>palette-colors</strong> <em>palette</em></dt> +<dt id="index-palette_002dcolors">Procedure: <strong>palette-colors</strong> <em>palette</em></dt> <dd><p>Return the colors in <var>palette</var>. </p></dd></dl> <dl> -<dt><a name="index-pixel_002dformat_003f"></a>Procedure: <strong>pixel-format?</strong> <em>pf</em></dt> +<dt id="index-pixel_002dformat_003f">Procedure: <strong>pixel-format?</strong> <em>pf</em></dt> <dd><p>Return <code>#t</code> if <var>pf</var> is a pixel format. </p></dd></dl> <dl> -<dt><a name="index-pixel_002dformat_002dname"></a>Procedure: <strong>pixel-format-name</strong> <em>pf</em></dt> +<dt id="index-pixel_002dformat_002dname">Procedure: <strong>pixel-format-name</strong> <em>pf</em></dt> <dd><p>Return the symbolic name of the pixel format <var>pf</var>. </p></dd></dl> <dl> -<dt><a name="index-pixel_002dformat_002dpalette"></a>Procedure: <strong>pixel-format-palette</strong> <em>pf</em></dt> +<dt id="index-pixel_002dformat_002dpalette">Procedure: <strong>pixel-format-palette</strong> <em>pf</em></dt> <dd><p>Return the palette for the pixel format <var>pf</var>. </p></dd></dl> <dl> -<dt><a name="index-pixel_002dformat_002dbits_002dper_002dpixel"></a>Procedure: <strong>pixel-format-bits-per-pixel</strong> <em>pf</em></dt> +<dt id="index-pixel_002dformat_002dbits_002dper_002dpixel">Procedure: <strong>pixel-format-bits-per-pixel</strong> <em>pf</em></dt> <dd><p>Return the number of bits per pixel for the pixel format <var>pf</var>. </p></dd></dl> <dl> -<dt><a name="index-pixel_002dformat_002dbytes_002dper_002dpixel"></a>Procedure: <strong>pixel-format-bytes-per-pixel</strong> <em>pf</em></dt> +<dt id="index-pixel_002dformat_002dbytes_002dper_002dpixel">Procedure: <strong>pixel-format-bytes-per-pixel</strong> <em>pf</em></dt> <dd><p>Return the number of bytes per pixel for the pixel format <var>pf</var>. </p></dd></dl> <dl> -<dt><a name="index-pixel_002dformat_002dred_002dmask"></a>Procedure: <strong>pixel-format-red-mask</strong> <em>pf</em></dt> +<dt id="index-pixel_002dformat_002dred_002dmask">Procedure: <strong>pixel-format-red-mask</strong> <em>pf</em></dt> <dd><p>Return the bitmask for the red component of a pixel in the pixel format <var>pf</var>. </p></dd></dl> <dl> -<dt><a name="index-pixel_002dformat_002dgreen_002dmask"></a>Procedure: <strong>pixel-format-green-mask</strong> <em>pf</em></dt> +<dt id="index-pixel_002dformat_002dgreen_002dmask">Procedure: <strong>pixel-format-green-mask</strong> <em>pf</em></dt> <dd><p>Return the bitmask for the green component of a pixel in the pixel format <var>pf</var>. </p></dd></dl> <dl> -<dt><a name="index-pixel_002dformat_002dblue_002dmask"></a>Procedure: <strong>pixel-format-blue-mask</strong> <em>pf</em></dt> +<dt id="index-pixel_002dformat_002dblue_002dmask">Procedure: <strong>pixel-format-blue-mask</strong> <em>pf</em></dt> <dd><p>Return the bitmask for the blue component of a pixel in the pixel format <var>pf</var>. </p></dd></dl> <dl> -<dt><a name="index-pixel_002dformat_002dalpha_002dmask"></a>Procedure: <strong>pixel-format-alpha-mask</strong> <em>pf</em></dt> +<dt id="index-pixel_002dformat_002dalpha_002dmask">Procedure: <strong>pixel-format-alpha-mask</strong> <em>pf</em></dt> <dd><p>Return the bitmask for the alpha component of a pixel in the pixel format <var>pf</var>. </p></dd></dl> <dl> -<dt><a name="index-make_002drgb_002dsurface"></a>Procedure: <strong>make-rgb-surface</strong> <em>width height depth</em></dt> +<dt id="index-make_002drgb_002dsurface">Procedure: <strong>make-rgb-surface</strong> <em>width height depth</em></dt> <dd><p>Create a new SDL surface with the dimensions <var>width</var> and <var>height</var> and <var>depth</var> bits per pixel. </p></dd></dl> <dl> -<dt><a name="index-bytevector_002d_003esurface"></a>Procedure: <strong>bytevector->surface</strong> <em>bv width height depth pitch</em></dt> +<dt id="index-bytevector_002d_003esurface">Procedure: <strong>bytevector->surface</strong> <em>bv width height depth pitch</em></dt> <dd><p>Convert <var>bv</var>, a bytevector of pixel data with dimensions <var>width</var>x<var>height</var>, to an SDL surface. Each pixel is <var>depth</var> bits in size, and each row of pixels is <var>pitch</var> bytes in size. </p></dd></dl> <dl> -<dt><a name="index-delete_002dsurface_0021"></a>Procedure: <strong>delete-surface!</strong> <em>surface</em></dt> +<dt id="index-delete_002dsurface_0021">Procedure: <strong>delete-surface!</strong> <em>surface</em></dt> <dd><p>Free the memory used by <var>surface</var>. </p></dd></dl> <dl> -<dt><a name="index-call_002dwith_002dsurface"></a>Procedure: <strong>call-with-surface</strong> <em>surface proc</em></dt> +<dt id="index-call_002dwith_002dsurface">Procedure: <strong>call-with-surface</strong> <em>surface proc</em></dt> <dd><p>Call <var>proc</var>, passing it <var>surface</var> and deleting <var>surface</var> upon exit of <var>proc</var>. </p></dd></dl> <dl> -<dt><a name="index-load_002dbmp"></a>Procedure: <strong>load-bmp</strong> <em>file</em></dt> +<dt id="index-load_002dbmp">Procedure: <strong>load-bmp</strong> <em>file</em></dt> <dd><p>Create a new surface from the bitmap data in <var>file</var>. </p></dd></dl> <dl> -<dt><a name="index-surface_002dwidth"></a>Procedure: <strong>surface-width</strong> <em>surface</em></dt> +<dt id="index-surface_002dwidth">Procedure: <strong>surface-width</strong> <em>surface</em></dt> <dd><p>Return the width of <var>surface</var> in pixels. </p></dd></dl> <dl> -<dt><a name="index-surface_002dheight"></a>Procedure: <strong>surface-height</strong> <em>surface</em></dt> +<dt id="index-surface_002dheight">Procedure: <strong>surface-height</strong> <em>surface</em></dt> <dd><p>Return the height of <var>surface</var> in pixels. </p></dd></dl> <dl> -<dt><a name="index-surface_002dpitch"></a>Procedure: <strong>surface-pitch</strong> <em>surface</em></dt> +<dt id="index-surface_002dpitch">Procedure: <strong>surface-pitch</strong> <em>surface</em></dt> <dd><p>Return the length of a row of pixels in <var>surface</var> in bytes. </p></dd></dl> <dl> -<dt><a name="index-surface_002dpixels"></a>Procedure: <strong>surface-pixels</strong> <em>surface</em></dt> +<dt id="index-surface_002dpixels">Procedure: <strong>surface-pixels</strong> <em>surface</em></dt> <dd><p>Return a bytevector containing the raw pixel data in <var>surface</var>. </p></dd></dl> <dl> -<dt><a name="index-surface_002dpixel_002dformat"></a>Procedure: <strong>surface-pixel-format</strong> <em>surface</em></dt> +<dt id="index-surface_002dpixel_002dformat">Procedure: <strong>surface-pixel-format</strong> <em>surface</em></dt> <dd><p>Return the pixel format for <var>surface</var>. </p></dd></dl> <dl> -<dt><a name="index-convert_002dsurface_002dformat"></a>Procedure: <strong>convert-surface-format</strong> <em>surface format</em></dt> +<dt id="index-convert_002dsurface_002dformat">Procedure: <strong>convert-surface-format</strong> <em>surface format</em></dt> <dd><p>Convert the pixels in <var>surface</var> to <var>format</var>, a symbol representing a specific pixel format, and return a new surface object. </p> @@ -286,20 +277,20 @@ specific pixel format, and return a new surface object. </dd></dl> <dl> -<dt><a name="index-blit_002dsurface"></a>Procedure: <strong>blit-surface</strong> <em><var>src</var> <var>src-rect</var> <var>dst</var> <var>dst-rect</var></em></dt> +<dt id="index-blit_002dsurface">Procedure: <strong>blit-surface</strong> <em><var>src</var> <var>src-rect</var> <var>dst</var> <var>dst-rect</var></em></dt> <dd><p>Blit the rectangle <var>src-rect</var> from the surface <var>src</var> to <var>dst-rect</var> of the surface <var>dst</var>. </p></dd></dl> <dl> -<dt><a name="index-blit_002dscaled"></a>Procedure: <strong>blit-scaled</strong> <em><var>src</var> <var>src-rect</var> <var>dst</var> <var>dst-rect</var></em></dt> +<dt id="index-blit_002dscaled">Procedure: <strong>blit-scaled</strong> <em><var>src</var> <var>src-rect</var> <var>dst</var> <var>dst-rect</var></em></dt> <dd><p>Blit the rectangle <var>src-rect</var> from the surface <var>src</var> to <var>dst-rect</var> of the surface <var>dst</var>, scaling the source to fit the destination. </p></dd></dl> <dl> -<dt><a name="index-fill_002drect"></a>Procedure: <strong>fill-rect</strong> <em><var>dst</var> <var>rect</var> <var>color</var></em></dt> +<dt id="index-fill_002drect">Procedure: <strong>fill-rect</strong> <em><var>dst</var> <var>rect</var> <var>color</var></em></dt> <dd><p>Fill <var>rect</var> with <var>color</var>, a 32-bit color encoded as an integer value, in the surface <var>dst</var>. </p></dd></dl> @@ -307,7 +298,7 @@ value, in the surface <var>dst</var>. <hr> <div class="header"> <p> -Next: <a href="Rendering.html#Rendering" accesskey="n" rel="next">Rendering</a>, Previous: <a href="Rects.html#Rects" accesskey="p" rel="prev">Rects</a>, Up: <a href="API-Reference.html#API-Reference" accesskey="u" rel="up">API Reference</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Index.html#Index" title="Index" rel="index">Index</a>]</p> +Next: <a href="Rendering.html" accesskey="n" rel="next">Rendering</a>, Previous: <a href="Rects.html" accesskey="p" rel="prev">Rects</a>, Up: <a href="API-Reference.html" accesskey="u" rel="up">API Reference</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Index.html" title="Index" rel="index">Index</a>]</p> </div> |