LISPBUILDER-SDL-GFX -

 

Abstract

LISPBUILDER-SDL-GFX provides a Lisp wrapper for the SDL_gfx library, and provides support for renering several graphics primitives directly to SDL surfaces. LISPBUILDER-SDL-GFX has a dependency on the LISPBUILDER-SDL package. LISPBUILDER-SDL-GFX is distributed under the MIT-style license.

Current Version: The current version of LISPBUILDER-SDL-GFX is version 0.2.

Package Overview

Functions and symbols exported from the LISPBUILDER-SDL-GFX package are accessible from the LISPBUILDER-SDL-GFX: prefix or the shorter form SDL-GFX: nickname.

Simple Example

(defun width-height ()
  (let ((width 200) (height 200))
    (sdl:with-init ()
      (sdl:window width height :title-caption "Width and Height, from Processing.org")
      (sdl:clear-display (sdl:color :r 127 :g 127 :b 127))
      (loop for i from 0 to height by 20
	 do (progn (sdl-gfx:draw-box (sdl:rectangle :x 0 :y i :w 200 :h 10)
				     :color sdl:*black*)
		   (sdl-gfx:draw-box (sdl:rectangle :x i :y 0 :w 10 :h 200)
				     :color sdl:*white*)))
      (sdl:with-events ()
	(:quit-event () t)
	(:video-expose-event () (sdl:update-display))))))
      

The LISPBUILDER-SDL-GFX dictionary Index

1. *default-font*
2. *font-10x20*
3. *font-5x7*
4. *font-5x8*
5. *font-6x10*
6. *font-6x12*
7. *font-6x13*
8. *font-6x13b*
9. *font-6x13o*
10. *font-6x9*
11. *font-7x13*
12. *font-7x13b*
13. *font-7x13o*
14. *font-7x14*
15. *font-7x14b*
16. *font-8x13*
17. *font-8x13b*
18. *font-8x13o*
19. *font-8x8*
20. *font-9x15*
21. *font-9x15b*
22. *font-9x18*
23. *font-9x18b*
24. draw-aa-circle
25. draw-aa-circle-*
26. draw-aa-ellipse
27. draw-aa-ellipse-*
28. draw-aa-line
29. draw-aa-line-*
30. draw-aa-polygon
31. draw-aa-trigon
32. draw-bezier
33. draw-box
34. draw-box-*
35. draw-character-shaded
36. draw-character-shaded-*
37. draw-character-solid
38. draw-character-solid-*
39. draw-circle
40. draw-circle-*
41. draw-curve
42. draw-ellipse
43. draw-ellipse-*
44. draw-filled-circle
45. draw-filled-circle-*
46. draw-filled-ellipse
47. draw-filled-ellipse-*
48. draw-filled-pie
49. draw-filled-pie-*
50. draw-filled-polygon
51. draw-filled-trigon
52. draw-font
53. draw-font
54. draw-font-at
55. draw-font-at-*
56. draw-hline
57. draw-line
58. draw-line-*
59. draw-pie
60. draw-pie-*
61. draw-pixel
62. draw-pixel-*
63. draw-polygon
64. draw-rectangle
65. draw-rectangle-*
66. draw-shape
67. draw-string-shaded
68. draw-string-shaded-*
69. draw-string-solid
70. draw-string-solid-*
71. draw-trigon
72. draw-vline
73. font
74. font-height
75. font-width
76. free-font
77. initialise-default-font
78. initialise-font
79. render-string-shaded
80. render-string-solid
81. roto-zoom-size
82. roto-zoom-size-xy
83. roto-zoom-xy
84. set-default-font
85. with-bezier
86. with-curve
87. with-shape
88. zoom-surface
89. zoom-surface-size

Compatibility

Download

• Development: Available via anonymous SVN at:

  	      svn co https://lispbuilder.svn.sourceforge.net/svnroot/lispbuilder lispbuilder
  	    

• Stable: The latest stable versions are available from the LISPBUILDER-SDL repository on SourceForge.
• The Edi Weitz 'Starter Pack' Version: The stable version of Lispbuilder, suitable for the installation of installation LISPBUILDER-SDL-GFX using the Lisp Starter Pack from Edi Weitz is can be downloaded from http://www.balooga.com/lispbuilder/lispbuilder-sdl-gfx.zip.

Installation

See the LISPBUILDER documentation for installation instructions.

Using LISPBUILDER-SDL-GFX

See the LISPBUILDER documentation for Usage instructions.

Running Examples in LISPBUILDER-SDL-GFX-EXAMPLES

Enter the following at the REPL to load the examples included in the LISPBUILDER-SDL-GFX-EXAMPLES package:

	  (asdf:operate 'asdf:load-op :lispbuilder-sdl-gfx-examples)
	

Run the examples by entering any of the following at the REPL:

• (SDL-GFX-EXAMPLES:RECURSION)
• (SDL-GFX-EXAMPLES:METABALLS)
• (SDL-GFX-EXAMPLES:POINTS-AND-LINES)
• (SDL-GFX-EXAMPLES:FUNCTIONS)
• (SDL-GFX-EXAMPLES:WIDTH-HEIGHT)
• (SDL-GFX-EXAMPLES:INBUILT-FONT)
• (SDL-GFX-EXAMPLES:BEZIER)
• (SDL-GFX-EXAMPLES:VERTICES)
• (SDL-GFX-EXAMPLES:SHAPE-PRIMITIVES)
• (SDL-GFX-EXAMPLES:SETUP-AND-DRAW)
• (SDL-GFX-EXAMPLES:DISTANCE-2D)
• (SDL-GFX-EXAMPLES:RANDOM-CIRCLES)
• (SDL-GFX-EXAMPLES:OBJECTS)

Dependencies

LISPBUILDER-SDL-GFX has a dependency on LISPBUILDER-SDL.

License

LISPBUILDER-SDL-GFX is distributed under the MIT-style license.

The LISPBUILDER-SDL-GFX dictionary

[Special variable]
*default-font*

When a LISPBUILDER-SDL-GFX function or macro has an OPTIONAL or KEYword argument FONT, the default action is to bind to *DEFAULT-FONT*.*DEFAULT-FONT* is set to NIL initially. A font must be initialized by calling INITIALISE-DEFAULT-FONT prior to use.

[Special variable]
*font-10x20*

Contains the font data for an 10x20 bitmap font.

[Special variable]
*font-5x7*

Contains the font data for an 5x7 bitmap font.

[Special variable]
*font-5x8*

Contains the font data for an 5x8 bitmap font.

[Special variable]
*font-6x10*

Contains the font data for an 6x10 bitmap font.

[Special variable]
*font-6x12*

Contains the font data for an 6x12 bitmap font.

[Special variable]
*font-6x13*

Contains the font data for an 6x13 bitmap font.

[Special variable]
*font-6x13b*

Contains the font data for an 6x13 bitmap font.

[Special variable]
*font-6x13o*

Contains the font data for an 6x13 bitmap font.

[Special variable]
*font-6x9*

Contains the font data for an 6x9 bitmap font.

[Special variable]
*font-7x13*

Contains the font data for an 7x13 bitmap font.

[Special variable]
*font-7x13b*

Contains the font data for an 7x13 bitmap font.

[Special variable]
*font-7x13o*

Contains the font data for an 7x13 bitmap font.

[Special variable]
*font-7x14*

Contains the font data for an 7x14 bitmap font.

[Special variable]
*font-7x14b*

Contains the font data for an 7x14 bitmap font.

[Special variable]
*font-8x13*

Contains the font data for an 8x13 bitmap font.

[Special variable]
*font-8x13b*

Contains the font data for an 8x13 bitmap font.

[Special variable]
*font-8x13o*

Contains the font data for an 8x13 bitmap font.

[Special variable]
*font-8x8*

Contains the font data for an 8x8 bitmap font.

[Special variable]
*font-9x15*

Contains the font data for an 9x15 bitmap font.

[Special variable]
*font-9x15b*

Contains the font data for an 9x15 bitmap font.

[Special variable]
*font-9x18*

Contains the font data for an 9x18 bitmap font.

[Special variable]
*font-9x18b*

Contains the font data for an 9x18 bitmap font.

[Function]
draw-aa-circle p1 r &key surface color => result

See DRAW-AA-CIRCLE-*.

Parameters

• P1 is the X/Y coordinate of the center of the antialiased circle, of type SDL:POINT.

[Function]
draw-aa-circle-* x y r &key surface color => result

Draws the circumference of a circle of color COLOR to the surface SURFACE using anti-aliasing. Use DRAW-FILLED-CIRCLE-* to draw a filled circle.

Parameters

• X and Y specify the center coordinate of the circle, of type INTEGER.
• R is the circle radius, of type INTEGER.
• SURFACE is the target surface, of type SDL:SDL-SURFACE. Bound to SDL:*DEFAULT-SURFACE* if unspecified.
• COLOR is the circumference color, of type SDL:COLOR or SDL:COLOR-A. Bound to SDL:*DEFAULT-COLOR* if unspecified.

[Function]
draw-aa-ellipse p1 rx ry &key surface color => result

See DRAW-AA-ELLIPSE-*.

Parameters

• P1 is the X/Y coordinate of the center of the ellipse, of type SDL:POINT.

[Function]
draw-aa-ellipse-* x y rx ry &key surface color => result

Draws the circumference of an ellipse of color COLOR to the surface SURFACE using anti-aliasing. Use DRAW-FILLED-ELLIPSE-* to draw a filled ellipse.

Parameters

• X and Y specify the center coordinate of the ellipse, of type INTEGER.
• RX and RY specify the ellipse radius, of type INTEGER.
• SURFACE is the target surface, of type SDL:SDL-SURFACE. Bound to SDL:*DEFAULT-SURFACE* if unspecified.
• COLOR is the circumference color, of type SDL:COLOR or SDL:COLOR-A. Bound to SDL:*DEFAULT-COLOR* if unspecified.

[Function]
draw-aa-line point1 point2 &key surface color => result

See DRAW-AA-LINE-*-*

Parameters

• POINT1 and POINT2 are the start and end x/y co-ordinates of the line, of type SDL:POINT.

[Function]
draw-aa-line-* x1 y1 x2 y2 &key surface color => result

Draws an antialiased line of color COLOR to the surface SURFACE.

Parameters

• X1Y1 are the start X/Y coordinates of the line, of type INTEGER.
• X2Y2 are the end X/Y coordinates of the line, of type INTEGER.
• SURFACE is the target surface, of type SDL:SDL-SURFACE. Bound to SDL:*DEFAULT-SURFACE* if unspecified.
• COLOR is the line color, of type SDL:COLOR or SDL:COLOR-A. Bound to SDL:*DEFAULT-COLOR* if unspecified.

[Function]
draw-aa-polygon points &key surface color => result

Draw the circumference of a polygon of color COLOR to surface SURFACE using the vertices in POINTS. The polygon is anti-aliased. Use DRAW-FILLED-POLYGON-* to draw a filled polygon.

Parameters

• POINTS is the list of vertices of type SDL:POINT.
• SURFACE is the target surface, of type SDL:SDL-SURFACE. Bound to SDL:*DEFAULT-SURFACE* if unspecified.
• COLOR is the circumference color, of type SDL:COLOR or SDL:COLOR-A. Bound to SDL:*DEFAULT-COLOR* if unspecified.

[Function]
draw-aa-trigon point1 point2 point3 &key surface color => result

Draw the outline of a trigon or triangle, of color COLOR to surface SURFACE using anti-aliasing. Use DRAW-FILLED-TRIGON-* to draw a filled trigon.

Parameters

• POINT1, POINT2 and POINT3 specify the vertices of the trigon, of type SDL:POINT.
• SURFACE is the target surface, of type SDL:SDL-SURFACE. Bound to SDL:*DEFAULT-SURFACE* if unspecified.
• COLOR is the circumference color, of type SDL:COLOR or SDL:COLOR-A. Bound to SDL:*DEFAULT-COLOR* if unspecified.

[Function]
draw-bezier points steps &key surface color => result

Draw a bezier curve of color COLOR to the surface SURFACE. The shape of the Bezier curve is defined by several control points. A control point is a vertex containing an X and Y coordinate pair.

Parameters

• POINTS is the list of control points of type SDL:POINT.
• STEPS is the number of segments used to draw the Bezier curve. The greater the number of segments, the smoother the Bezier curve.
• SURFACE is the target surface, of type SDL:SDL-SURFACE. Bound to SDL:*DEFAULT-SURFACE* if unspecified.
• COLOR is the line color, of type SDL:COLOR or SDL:COLOR-A. Bound to SDL:*DEFAULT-COLOR* if unspecified.

Example

(DRAW-BEZIER (LIST (SDL:POINT :X 60  :Y 40)
                     (SDL:POINT :X 160 :Y 10)
                     (SDL:POINT :X 170 :Y 150)
                     (SDL:POINT :X 60 :Y 150))
               10)

[Function]
draw-box rect &key surface color => result

See DRAW-BOX-*.

Parameters

• RECT is the rectangle to fill, of type SDL:RECTANGLE.

[Function]
draw-box-* x y w h &key surface color => result

Draws a filled rectangle of color COLOR to surface SURFACE.

Parameters

• X and Y are the INTEGER coordinates of the top-left corner of the rectangle.
• W and H are the width and height of the rectangle, of type INTEGER.
• SURFACE is the target surface, of type SDL:SDL-SURFACE. Bound to SDL:*DEFAULT-SURFACE* if unspecified.
• COLOR is the fill color, of type SDL:COLOR or SDL:COLOR-A. Bound to SDL:*DEFAULT-COLOR* if unspecified.

[Function]
draw-character-shaded c p1 fg-color bg-color &key font surface => result

See DRAW-CHARACTER-SHADED-*.

Parameters

• P1 is the x and y position to render the character, of type SDL:POINT.

[Function]
draw-character-shaded-* c x y fg-color bg-color &key font surface => result

Draw the character C at location XY using font FONT with text color FG-COLOR and background color BG-COLOR onto surface SURFACE. The surface background is filled with BG-COLOR so the surface cannot be keyed over other surfaces.

• C is the character to render.
• X and Y are the x and y position coordinates, as INTEGERS.
• FG-COLOR color is the character color, of type SDL:SDL-COLOR
• BG-COLOR color is the background color used to fill the surface SURFACE, of type SDL:SDL-COLOR
• FONT is the font face used to render the character. Of type FONT. Bound to *DEFAULT-FONT* if unspecified.
• SURFACE is the target surface, of type SDL:SDL-SURFACE. Bound to SDL:*DEFAULT-SURFACE* if unspecified.

Returns

• Returns the font FONT.

Example

(DRAW-CHARACTER-SHADED-* "Hello World!" 0 0 F-COLOR B-COLOR :SURFACE A-SURFACE)

[Function]
draw-character-solid c p1 &key font surface color => result

See DRAW-CHARACTER-SOLID-*.

Parameters

• P1 is the x and y position to render the character, of type SDL:POINT.

[Function]
draw-character-solid-* c x y &key font surface color => result

Draw character C at location XY using font FONT with text color COLOR onto surface SURFACE. The character is keyed onto SURFACE.

Parameters

• C is the character to render.
• X and Y are the x and y position coordinates, as INTEGERS.
• FONT is the font face used to render the character. Of type FONT. Bound to *DEFAULT-FONT* if unspecified.
• SURFACE is the target surface, of type SDL:SDL-SURFACE. Bound to SDL:*DEFAULT-SURFACE* if unspecified.
• COLOR color is the character color, of type SDL:SDL-COLOR.

Returns

• Returns the font FONT.

Example

(DRAW-CHARACTER-SOLID-* "Hello World!" 0 0 :SURFACE A-SURFACE :COLOR A-COLOR)

[Function]
draw-circle p1 r &key surface color => result

See DRAW-CIRCLE-*.

Parameters

• P1 is the X/Y coordinate of the center of the circle, of type SDL:POINT.

[Function]
draw-circle-* x y r &key surface color => result

Draws a circle circumference of color COLOR to the surface SURFACE. Use DRAW-FILLED-CIRCLE-* to draw a filled circle.

Parameters

• X and Y specify the center coordinate of the circle, of type INTEGER.
• R is the circle radius, of type INTEGER.
• SURFACE is the target surface, of type SDL:SDL-SURFACE. Bound to SDL:*DEFAULT-SURFACE* if unspecified.
• COLOR is the circumference color, of type SDL:COLOR or SDL:COLOR-A. Bound to SDL:*DEFAULT-COLOR* if unspecified.

[Function]
draw-curve points type segments &key surface color => result

Draw a Cattmul-Rom spline using color COLOR to the surface SURFACE. The shape of the curve is defined by waypoints. A waypoint is a vertex containing an X and Y coordinate pair.

Parameters

• POINTS is a list of waypoints or vetices for the spline, of type SDL:POINT
• TYPE describes the line style used to draw the curve and may be one of :LINE-STRIP, :LINES, or :POINTS. Use :LINE-STRIP to draw a single continuous line through the specified waypoints. Use :LINES to draw a line between alternate waypoint pairs. Use :POINTS to draw a single pixel at each waypoint.
• SEGMENTS is the number of segments used to draw the Catmull-Rom spline. Default is 10 segments if unspecified. The greater the number of segments, the smoother the spline.
• SURFACE is the target surface, of type SDL:SDL-SURFACE.
• COLOR is the line color, of type SDL:COLOR or SDL:COLOR-A. Bound to SDL:*DEFAULT-COLOR* if unspecified.

Example

(DRAW-CURVE (LIST (SDL:POINT :X 60  :Y 40)
    	  (SDL:POINT :X 160 :Y 10)
	  (SDL:POINT :X 170 :Y 150)
	  (SDL:POINT :X 60  :Y 150))
    :LINE-STRIP
    10)

[Function]
draw-ellipse p1 rx ry &key surface color => result

See DRAW-ELLIPSE-*.

Parameters

• P1 is the X/Y coordinate of the center of the ellipse, of type SDL:POINT.

[Function]
draw-ellipse-* x y rx ry &key surface color => result

Draws an ellipse circumference of color COLOR to the surface SURFACE. Use DRAW-FILLED-ELLIPSE-* to draw a filled ellipse.

Parameters

• X and Y specify the center coordinate of the ellipse, of type INTEGER.
• RX and RY specify the ellipse radius, of type INTEGER.
• SURFACE is the target surface, of type SDL:SDL-SURFACE. Bound to SDL:*DEFAULT-SURFACE* if unspecified.
• COLOR is the circumference color, of type SDL:COLOR or SDL:COLOR-A. Bound to SDL:*DEFAULT-COLOR* if unspecified.

[Function]
draw-filled-circle p1 r &key surface color => result

See DRAW-FILLED-CIRCLE-*.

Parameters

• P1 is the X/Y coordinate of the center of the filled circle, of type SDL:POINT.

[Function]
draw-filled-circle-* x y r &key surface color => result

Draws a filled circle of color COLOR to the surface SURFACE.

Parameters

• X and Y specify the center coordinate of the circle, of type INTEGER.
• R is the circle radius, of type INTEGER.
• SURFACE is the target surface, of type SDL:SDL-SURFACE. Bound to SDL:*DEFAULT-SURFACE* if unspecified.
• COLOR is the fill color, of type SDL:COLOR or SDL:COLOR-A. Bound to SDL:*DEFAULT-COLOR* if unspecified.

[Function]
draw-filled-ellipse p1 rx ry &key surface color => result

See DRAW-FILLED-ELLIPSE-*.

Parameters

• P1 is the X/Y coordinate of the center of the filled ellipse, of type SDL:POINT.

[Function]
draw-filled-ellipse-* x y rx ry &key surface color => result

Draws a filled ellipse of color COLOR to the surface SURFACE.

Parameters

• X and Y specify the center coordinate of the ellipse, of type INTEGER.
• RX and RY specify the ellipse radius, of type INTEGER.
• SURFACE is the target surface, of type SDL:SDL-SURFACE. Bound to SDL:*DEFAULT-SURFACE* if unspecified.
• COLOR is the fill color, of type SDL:COLOR or SDL:COLOR-A. Bound to SDL:*DEFAULT-COLOR* if unspecified.

[Function]
draw-filled-pie p1 rad start end &key surface color => result

See DRAW-FILLED-PIE-*.

Parameters

• P1 is the X/Y coordinate of the center of the filled pie, of type SDL:POINT.

[Function]
draw-filled-pie-* x y rad start end &key surface color => result

Draws a filled pie of color COLOR to the surface SURFACE.

Parameters

• X and Y specify the center coordinate of the pie, of type INTEGER.
• RAD is the pie radius, of type INTEGER.
• START is the pie start, of type INTEGER.
• END is the pie end, of type INTEGER.
• SURFACE is the target surface, of type SDL:SDL-SURFACE. Bound to SDL:*DEFAULT-SURFACE* if unspecified.
• COLOR is the fill color, of type SDL:COLOR or SDL:COLOR-A. Bound to SDL:*DEFAULT-COLOR* if unspecified.

[Function]
draw-filled-polygon points &key surface color => result

Draw a filled polygon, of color COLOR to surface SURFACE.

Parameters

• POINTS is the list of vertices of type SDL:POINT.
• SURFACE is the target surface, of type SDL:SDL-SURFACE. Bound to SDL:*DEFAULT-SURFACE* if unspecified.
• COLOR is the fill color, of type SDL:COLOR or SDL:COLOR-A. Bound to SDL:*DEFAULT-COLOR* if unspecified.

[Function]
draw-filled-trigon point1 point2 point3 &key surface color => result

Draw a filled trigon, of color COLOR to surface SURFACE.

Parameters

• POINT1, POINT2 and POINT3 specify the vertices of the trigon, of type SDL:POINT.
• SURFACE is the target surface, of type SDL:SDL-SURFACE. Bound to SDL:*DEFAULT-SURFACE* if unspecified.
• COLOR is the fill color, of type SDL:COLOR or SDL:COLOR-A. Bound to SDL:*DEFAULT-COLOR* if unspecified.

[Generic function]
draw-font &key font surface => result

Blit the cached SURFACE in FONT to the destination surface SURFACE. The cached surface is created during a previous call to any of the DRAW-STRING* functions. Uses POSITION in the cached SURFACE to render to the X/Y coordinates on the destination SURFACE.

This function can speed up blitting when the text remains unchanged between screen updates.

[Function]
draw-font &key font surface => result

[Generic function]
draw-font-at position &key font surface => result

See DRAW-FONT. POINT is used to position the cached SURFACE, where POINT is of type SDL:POINT.

[Method]
draw-font-at position &key font surface => result

[Generic function]
draw-font-at-* x y &key font surface => result

See DRAW-FONT. X and Y are used to position the cached SURFACE, where X and Y are INTEGERS.

[Method]
draw-font-at-* x y &key font surface => result

[Function]
draw-hline x1 x2 y &key surface color => result

Draw a horizontal line of color COLOR from X1 to X2 through Y onto the surface SURFACE.

Parameters

• X1 and X2 are the horizontal start and end points of the line, of type INTEGER.
• Y is the vertical INTEGER coordinate that the horizontal line must intersect.
• SURFACE is the target surface, of type SDL:SDL-SURFACE. Bound to SDL:*DEFAULT-SURFACE* if unspecified.
• COLOR is the line color, of type SDL:COLOR or SDL:COLOR-A. Bound to SDL:*DEFAULT-COLOR* if unspecified.

[Function]
draw-line point1 point2 &key surface color => result

See DRAW-LINE-*.

Parameters

• POINT1 and POINT2 are the start and end x/y co-ordinates of the line, of type SDL:POINT.

[Function]
draw-line-* x1 y1 x2 y2 &key surface color => result

Draws a line of color COLOR to the surface SURFACE.

Parameters

• X1Y1 are the start X/Y coordinates of the line, of type INTEGER.
• X2Y2 are the end X/Y coordinates of the line, of type INTEGER.
• SURFACE is the target surface, of type SDL:SDL-SURFACE. Bound to SDL:*DEFAULT-SURFACE* if unspecified.
• COLOR is the line color, of type SDL:COLOR or SDL:COLOR-A. Bound to SDL:*DEFAULT-COLOR* if unspecified.

[Function]
draw-pie p1 rad start end &key surface color => result

See DRAW-PIE-*.

Parameters

• P1 is the X/Y coordinate of the center of the pie, of type SDL:POINT.

[Function]
draw-pie-* x y rad start end &key surface color => result

Draws a pie of color COLOR to the surface SURFACE. Use DRAW-FILLED-PIE-* to draw a filled pie.

Parameters

• X and Y specify the center coordinate of the pie, of type INTEGER.
• RAD is the pie radius, of type INTEGER.
• START is the pie start, of type INTEGER.
• END is the pie end, of type INTEGER.
• SURFACE is the target surface, of type SDL:SDL-SURFACE. Bound to SDL:*DEFAULT-SURFACE* if unspecified.
• COLOR is the circumference color, of type SDL:COLOR or SDL:COLOR-A. Bound to SDL:*DEFAULT-COLOR* if unspecified.

[Function]
draw-pixel position &key surface color => result

See DRAW-PIXEL-*.

Parameters

• POSITION is the X/Y coordinate of the pixel, of type SDL:POINT.

[Function]
draw-pixel-* x y &key surface color => result

Draw a single pixel of color COLOR to the surface SURFACE at the specified X and Y coordiates.

Parameters

• X and Y specify the coordinates of the pixel, and are of type INTEGER.
• SURFACE is the target surface, of type SDL:SDL-SURFACE. Bound to SDL:*DEFAULT-SURFACE* if unspecified.
• COLOR is the pixel color, of type SDL:COLOR or SDL:COLOR-A. Bound to SDL:*DEFAULT-COLOR* if unspecified.

[Function]
draw-polygon points &key surface color => result

Draw the circumference of a polygon of color COLOR to surface SURFACE using the vertices in POINTS. Use DRAW-FILLED-POLYGON-* to draw a filled polygon.

Parameters

• POINTS is the list of vertices for the polygon. POINTS is a list of SDL:POINTs.
• SURFACE is the target surface, of type SDL:SDL-SURFACE. Bound to SDL:*DEFAULT-SURFACE* if unspecified.
• COLOR is the circumference color, of type SDL:COLOR or SDL:COLOR-A. Bound to SDL:*DEFAULT-COLOR* if unspecified.

[Function]
draw-rectangle rect &key surface color => result

See DRAW-RECTANGLE-*.

Parameters

• RECT is the rectangle to draw, of type SDL:RECTANGLE.

[Function]
draw-rectangle-* x y w h &key surface color => result

Draw a rectangle outline of color COLOR to the surface SURFACE.

Parameters

• X and Y are the INTEGER coordinates of the top-left corner of the rectangle.
• W and H are the width and height of the rectangle, of type INTEGER.
• SURFACE is the target surface, of type SDL:SDL-SURFACE. Bound to SDL:*DEFAULT-SURFACE* if unspecified.
• COLOR is the line color, of type SDL:COLOR or SDL:COLOR-A. Bound to SDL:*DEFAULT-COLOR* if unspecified.

[Function]
draw-shape points type &key surface color => result

Draw a polygon of color COLOR to the surface SURFACE using the vertices in POINTS.

Parameters

• POINTS is a list of vertices, of type SDL:POINT
• TYPE describes the line style used to draw the polygon and may be one of :LINE-STRIP, :LINES, or :POINTS. Use :LINE-STRIP to draw a single continuous line through the specified waypoints. Use :LINES to draw a line between alternate waypoint pairs. Use :POINTS to draw a single pixel at each waypoint.
• SURFACE is the target surface, of type SDL:SDL-SURFACE. Bound to SDL:*DEFAULT-SURFACE* if unspecified.
• COLOR is the line color, of type SDL:COLOR or SDL:COLOR-A. Bound to SDL:*DEFAULT-COLOR* if unspecified.

Example

(DRAW-SHAPE (LIST (SDL:POINT :X 60  :Y 40)
	    (SDL:POINT :X 160 :Y 10)
	    (SDL:POINT :X 170 :Y 150)
	    (SDL:POINT :X 60  :Y 150))
    :LINE-STRIP)

[Function]
draw-string-shaded c p1 fg-color bg-color &key font surface => result

See DRAW-STRING-SHADED-*.

Parameters

• P1 is the x and y position to render the text, of type SDL:POINT.

[Function]
draw-string-shaded-* c x y fg-color bg-color &key font surface => result

Draw text C using at location XY using font FONT with text color FG-COLOR and background color BG-COLOR onto surface SURFACE. The surface background is filled with BG-COLOR so the surface cannot be keyed over other surfaces.

• C is the text to render.
• X and Y are the x and y position coordinates, as INTEGERS.
• FG-COLOR color is the text color, of type SDL:SDL-COLOR
• BG-COLOR color is the background color used to fill the surface SURFACE, of type SDL:SDL-COLOR
• FONT is the font face used to render the text. Of type FONT. Bound to *DEFAULT-FONT* if unspecified.
• SURFACE is the target surface, of type SDL:SDL-SURFACE. Bound to SDL:*DEFAULT-SURFACE* if unspecified.

Returns

• Returns the font FONT.

Example

(DRAW-STRING-SHADED-* "Hello World!" 0 0 F-COLOR B-COLOR :SURFACE A-SURFACE)

[Function]
draw-string-solid c p1 &key font surface color => result

See DRAW-STRING-SOLID-*.

Parameters

• P1 is the x and y position to render the text, of type SDL:POINT.

[Function]
draw-string-solid-* c x y &key font surface color => result

Draw text C at location XY using font FONT with color COLOR onto surface SURFACE. The text is keyed onto SURFACE.

Parameters

• C is the text to render.
• X and Y are the x and y position coordinates, as INTEGERS.
• FONT is the font face used to render the string. Of type FONT. Bound to *DEFAULT-FONT* if unspecified.
• SURFACE is the target surface, of type SDL:SDL-SURFACE. Bound to SDL:*DEFAULT-SURFACE* if unspecified.
• COLOR color is the text color, of type SDL:SDL-COLOR.

Returns

• Returns the font FONT.

Example

(DRAW-STRING-SOLID-* "Hello World!" 0 0 :SURFACE A-SURFACE :COLOR A-COLOR)

[Function]
draw-trigon point1 point2 point3 &key surface color => result

Draw the outline of a trigon or triangle, of color COLOR to surface SURFACE. Use DRAW-FILLED-TRIGON-* to draw a filled trigon.

Parameters

• POINT1, POINT2 and POINT3 specify the vertices of the trigon, of type SDL:POINT.
• SURFACE is the target surface, of type SDL:SDL-SURFACE. Bound to SDL:*DEFAULT-SURFACE* if unspecified.
• COLOR is the circumference color, of type SDL:COLOR or SDL:COLOR-A. Bound to SDL:*DEFAULT-COLOR* if unspecified.

[Function]
draw-vline x y1 y2 &key surface color => result

Draw a vertical line of color COLOR from Y1 to Y2 through X onto the surface SURFACE.

Parameters

• X is the horizontal INTEGER coordinate that the vertical line must intersect.
• Y1 and Y2 are the vertical start and end points of the line, of type INTEGER.
• SURFACE is the target surface, of type SDL:SDL-SURFACE. Bound to SDL:*DEFAULT-SURFACE* if unspecified.
• COLOR is the line color, of type SDL:COLOR or SDL:COLOR-A. Bound to SDL:*DEFAULT-COLOR* if unspecified.

[Standard class]
font

A FONT object manages the resources for the font. These resources include any cached surface as well as the foreign array containing the font data.

The cached surface is created by a call to any of the RENDER-STRING* functions. Use DRAW-FONT, DRAW-FONT-AT or DRAW-FONT-AT-* to draw the cached surface.

Prior to the first call to a RENDER-STRING* function, the cached surface is NIL.

[Generic function]
font-height font => result

[Method]
font-height (font font) => result

[Generic function]
font-width font => result

[Method]
font-width (font font) => result

[Generic function]
free-font font => result

[Method]
free-font (font font) => result

Free resources associated with the font FONT. This includes freeing the cached surface and the foreign array containing the font data.

[Function]
initialise-default-font &optional font-definition => result

Creates a new FONT object from the font definition in FONT-DEFINITION. Sets the font FONT as the default font to be used for subsequent font rendering or drawing operations.

Binds the symbol *DEFAULT-FONT* to font. Functions that take a FONT argument use *DEFAULT-FONT* unless otherwise specified. Returns a new FONT, or NIL if unsuccessful.

[Function]
initialise-font font-definition => result

Creates a new FONT object from the font data in FONT-DEFINITION. Returns a new FONT, or NIL if unsuccessful.

[Function]
render-string-shaded string fg-color bg-color &key font free cache => result

Render the string STRING using font FONT with text color FG-COLOR and background color BG-COLOR to a new SURFACE. The dimensions of the new surface are height == FONT height, and width == FONT width * STRING length. The surface background is filled with BG-COLOR so the surface cannot be keyed over other surfaces. Use :CACHE T to cache the new surface in the FONT object. When :FREE T any exisiting cached surface in FONT is automatically freed. When :FREE NIL the caller is responsible for freeing any existing cached surface in FONT.

Parameters

• STRING is the text to render.
• FONT is the font face used to render the STRING. Of type FONT. Bound to *DEFAULT-FONT* if unspecified.
• FG-COLOR color is the text color, of type SDL:SDL-COLOR
• BG-COLOR color is the background color used to fill the surface, of type SDL:SDL-COLOR
• FREE when T will free any exisitng cached surface in FONT.
• CACHE when T will cache the newly created SURFACE in FONT.

Returns

• Returns a new cached surface SDL:SDL-SURFACE.

Example

(DRAW-STRING-SHADED "Hello World!" F-COLOR B-COLOR)

[Function]
render-string-solid string &key font color free cache => result

Render the string STRING using font FONT with text color COLOR to a new SURFACE. The dimensions of the new surface are height == FONT height, and width == FONT width * STRING length. The surface background is transparent and therefore can be keyed over other surfaces. Use :CACHE T to cache the new surface in the FONT object. When :FREE T any exisiting cached surface in FONT is automatically freed. When :FREE NIL the caller is responsible for freeing any existing cached surface in FONT.

Parameters

• STRING is the text to render.
• FONT is the font face used to render the STRING. Of type FONT. Bound to *DEFAULT-FONT* if unspecified.
• COLOR color is the text color, of type SDL:SDL-COLOR.
• FREE when T will free any exisitng cached surface in FONT.
• CACHE when T will cache the newly created SURFACE in FONT.

Returns

• Returns a new cached surface SDL:SDL-SURFACE.

Example

(DRAW-STRING-SOLID "Hello World!" :COLOR A-COLOR)

[Function]
roto-zoom-size width height angle zoom => result

[Function]
roto-zoom-size-xy width height angle zoomx zoomy => result

[Function]
roto-zoom-xy angle zoomx zoomy smooth &key surface => result

[Function]
set-default-font font => result

Sets the font FONT as the default font to be used for subsequent font rendering or drawing operations. Binds the symbol *DEFAULT-FONT* to font. Functions that take a FONT argument use *DEFAULT-FONT* unless otherwise specified. Returns a new FONT, or NIL if unsuccessful.

[Macro]
with-bezier (&optional segments) declaration* statement* => result

Draw a bezier curve of color *DEFAULT-COLOR* to the surface *DEFAULT-SURFACE*. The shape of the Bezier curve is defined by control points. A control point is a vertex containing an X and Y coordinate pair.

Local Methods

A vertex may be added using:

• ADD-VERTEX which accepts an SDL:POINT, or
• ADD-VERTEX-* which is the x/y spread version

ADD-VERTEX and ADD-VERTEX-* are valid only within the scop of WITH-BEZIER.

Parameters

• SEGMENTS is the number of segments used to draw the Bezier curve. Default is 10 segments if unspecified. The greater the number of segments, the smoother the curve.

Example

(SDL:WITH-COLOR (COL (SDL:COLOR))
   (WITH-BEZIER (30)
     (ADD-VERTEX-* 60  40)
     (ADD-VERTEX-* 160 10)
     (ADD-VERTEX-* 170 150)
     (ADD-VERTEX-* 60  150)))

[Macro]
with-curve (shape-type &optional segments) declaration* statement* => result

Draw a Cattmul-Rom spline of color *DEFAULT-COLOR* to the surface *DEFAULT-SURFACE*. The shape of the curve is defined by waypoints. A waypoint is a vertex containing an X and Y coordinate pair.

Local Methods

A vertex may be added using:

• ADD-VERTEX which accepts an SDL:POINT, or
• ADD-VERTEX-* which is the x/y spread version

ADD-VERTEX and ADD-VERTEX-* are valid only within the scope of WITH-CURVE.

Parameters

• SHAPE-TYPE describes the line style used to draw the curve and may be one of :LINE-STRIP, :LINES, or :POINTS. Use :LINE-STRIP to draw a single continuous line through the specified waypoints. Use :LINES to draw a line between alternate waypoint pairs. Use :POINTS to draw a single pixel at each waypoint.
• SEGMENTS is the number of segments used to draw the Catmull-Rom spline. Default is 10 segments if unspecified. The greater the number of segments, the smoother the spline.

Example

(SDL:WITH-COLOR (COL (SDL:COLOR))
   (WITH-CURVE (:LINE-STRIP 30)
     (ADD-VERTEX-* 60  40)
     (ADD-VERTEX-* 160 10)
     (ADD-VERTEX-* 170 150)
     (ADD-VERTEX-* 60  150)))

[Macro]
with-shape (shape-type) declaration* statement* => result

Draw a polygon of color *DEFAULT-COLOR* to the surface *DEFAULT-SURFACE*.

Local Methods

A vertex may be added using:

• ADD-VERTEX which accepts an SDL:POINT, or
• ADD-VERTEX-* which is the x/y spread version

ADD-VERTEX and ADD-VERTEX-* are valid only within the scop of WITH-SHAPE.

Parameters

• SHAPE-TYPE describes the line style used to draw the shape and may be one of :LINE-STRIP, :LINES, or :POINTS. Use :LINE-STRIP to draw a single continuous line through the specified waypoints. Use :LINES to draw a line between alternate waypoint pairs. Use :POINTS to draw a single pixel at each waypoint.

Example

(SDL:WITH-COLOR (COL (SDL:COLOR))
   (WITH-SHAPE (:POINTS)
     (ADD-VERTEX-* 60  40)
     (ADD-VERTEX-* 160 10)
     (ADD-VERTEX-* 170 150)
     (ADD-VERTEX-* 60  150)))

[Function]
zoom-surface zoomx zoomy smooth &key surface => result

[Function]
zoom-surface-size width height zoomx zoomy => result

Acknowledgements

• Documentation prepared using:
• Edi Weitz's DOCUMENTATION-TEMPLATE.
• Gary King's CL-MARKDOWN.

BACK