The cepl.sdl2-ttf Reference Manual

Table of Contents

The cepl.sdl2-ttf Reference Manual

This is the cepl.sdl2-ttf Reference Manual, generated automatically by Declt version 3.0 "Montgomery Scott" on Tue Dec 22 11:57:58 2020 GMT+0.

1 Introduction

CEPL.SDL2-TTF

A complementary library that adds a couple of simple helpers too ease making CEPL textures using the excellent sdl2-ttf.

API

#'init

Initialized sdl2-ttf only if not already initialized. Also checks that CEPL is initialized.

#'quit

Shuts down sdl2-ttf only if initialized

with-font

A helper macro that opens a font for the scope of the body

#'text-to-tex

This function takes:

• The string to render to a texture
• A font object
• A text color as a vector4 (defaults to (v! 255 255 255 0))

It returns a CEPL texture containing the text.

Example

(defun test ()
  (init)
  (with-font (font (asdf:system-relative-pathname
                    'sdl2-ttf-examples "examples/PROBE_10PX_OTF.otf"))
    (text-to-tex "hello world" font)))

2 Systems

The main system appears first, followed by any subsystem dependency.

2.1 cepl.sdl2-ttf

Author

Chris Bagley (Baggers) <techsnuffle@gmail.com>

License

BSD 2 Clause

Description

A few additional helpers for making working with sdl2-ttf even easier from CEPL

Dependencies

• cepl.sdl2
• sdl2-ttf
• rtg-math

Source

cepl.sdl2-ttf.asd (file)

Components

• package.lisp (file)
• text-to-tex.lisp (file)

3 Files

Files are sorted by type and then listed depth-first from the systems components trees.

3.1 Lisp

3.1.1 cepl.sdl2-ttf.asd

Location

cepl.sdl2-ttf.asd

Systems

cepl.sdl2-ttf (system)

3.1.2 cepl.sdl2-ttf/package.lisp

Parent

cepl.sdl2-ttf (system)

Location

package.lisp

Packages

cepl.sdl2-ttf

3.1.3 cepl.sdl2-ttf/text-to-tex.lisp

Dependency

package.lisp (file)

Parent

cepl.sdl2-ttf (system)

Location

text-to-tex.lisp

Exported Definitions

• init-cepl-sdl2-ttf (function)
• quit-cepl-sdl2-ttf (function)
• text-to-tex (function)
• with-font (macro)

Internal Definitions

test (function)

4 Packages

Packages are listed by definition order.

4.1 cepl.sdl2-ttf

Source

package.lisp (file)

Use List

• cepl
• rtg-math
• common-lisp

Exported Definitions

• init-cepl-sdl2-ttf (function)
• quit-cepl-sdl2-ttf (function)
• text-to-tex (function)
• with-font (macro)

Internal Definitions

test (function)

5 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.

5.1 Exported definitions

5.1.1 Macros

Macro: with-font (VAR-NAME PATH &optional POINT-SIZE) &body BODY

Package

cepl.sdl2-ttf

Source

text-to-tex.lisp (file)

5.1.2 Functions

Function: init-cepl-sdl2-ttf ()

Package

cepl.sdl2-ttf

Source

text-to-tex.lisp (file)

Function: quit-cepl-sdl2-ttf ()

Package

cepl.sdl2-ttf

Source

text-to-tex.lisp (file)

Function: text-to-tex TEXT FONT &optional COLOR

Package

cepl.sdl2-ttf

Source

text-to-tex.lisp (file)

5.2 Internal definitions

5.2.1 Functions

Function: test ()

Package

cepl.sdl2-ttf

Source

text-to-tex.lisp (file)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types