The cepl.sdl2-ttf Reference Manual

Table of Contents

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

The cepl.sdl2-ttf Reference Manual

This is the cepl.sdl2-ttf Reference Manual, generated automatically by Declt version 2.3 "Robert April" on Tue Feb 20 07:49:19 2018 GMT+0.


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

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:

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)))

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

2 Systems

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


Previous: , Up: Systems   [Contents][Index]

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
Source

cepl.sdl2-ttf.asd (file)

Components

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

3 Files

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


Previous: , Up: Files   [Contents][Index]

3.1 Lisp


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.1 cepl.sdl2-ttf.asd

Location

cepl.sdl2-ttf.asd

Systems

cepl.sdl2-ttf (system)


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.2 cepl.sdl2-ttf/package.lisp

Parent

cepl.sdl2-ttf (system)

Location

package.lisp

Packages

cepl.sdl2-ttf


Previous: , Up: Lisp files   [Contents][Index]

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
Internal Definitions

test (function)


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

4 Packages

Packages are listed by definition order.


Previous: , Up: Packages   [Contents][Index]

4.1 cepl.sdl2-ttf

Source

package.lisp (file)

Use List
Exported Definitions
Internal Definitions

test (function)


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

5 Definitions

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


Next: , Previous: , Up: Definitions   [Contents][Index]

5.1 Exported definitions


Next: , Previous: , Up: Exported definitions   [Contents][Index]

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)


Previous: , Up: Exported definitions   [Contents][Index]

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)


Previous: , Up: Definitions   [Contents][Index]

5.2 Internal definitions


Previous: , Up: Internal definitions   [Contents][Index]

5.2.1 Functions

Function: test ()
Package

cepl.sdl2-ttf

Source

text-to-tex.lisp (file)


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

Appendix A Indexes


Next: , Previous: , Up: Indexes   [Contents][Index]

A.1 Concepts

Jump to:   C   F   L  
Index Entry  Section

C
cepl.sdl2-ttf.asd: The cepl<dot>sdl2-ttf<dot>asd file
cepl.sdl2-ttf/package.lisp: The cepl<dot>sdl2-ttf/package<dot>lisp file
cepl.sdl2-ttf/text-to-tex.lisp: The cepl<dot>sdl2-ttf/text-to-tex<dot>lisp file

F
File, Lisp, cepl.sdl2-ttf.asd: The cepl<dot>sdl2-ttf<dot>asd file
File, Lisp, cepl.sdl2-ttf/package.lisp: The cepl<dot>sdl2-ttf/package<dot>lisp file
File, Lisp, cepl.sdl2-ttf/text-to-tex.lisp: The cepl<dot>sdl2-ttf/text-to-tex<dot>lisp file

L
Lisp File, cepl.sdl2-ttf.asd: The cepl<dot>sdl2-ttf<dot>asd file
Lisp File, cepl.sdl2-ttf/package.lisp: The cepl<dot>sdl2-ttf/package<dot>lisp file
Lisp File, cepl.sdl2-ttf/text-to-tex.lisp: The cepl<dot>sdl2-ttf/text-to-tex<dot>lisp file

Jump to:   C   F   L  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.2 Functions

Jump to:   F   I   M   Q   T   W  
Index Entry  Section

F
Function, init-cepl-sdl2-ttf: Exported functions
Function, quit-cepl-sdl2-ttf: Exported functions
Function, test: Internal functions
Function, text-to-tex: Exported functions

I
init-cepl-sdl2-ttf: Exported functions

M
Macro, with-font: Exported macros

Q
quit-cepl-sdl2-ttf: Exported functions

T
test: Internal functions
text-to-tex: Exported functions

W
with-font: Exported macros

Jump to:   F   I   M   Q   T   W  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.3 Variables


Previous: , Up: Indexes   [Contents][Index]

A.4 Data types

Jump to:   C   P   S  
Index Entry  Section

C
cepl.sdl2-ttf: The cepl<dot>sdl2-ttf system
cepl.sdl2-ttf: The cepl<dot>sdl2-ttf package

P
Package, cepl.sdl2-ttf: The cepl<dot>sdl2-ttf package

S
System, cepl.sdl2-ttf: The cepl<dot>sdl2-ttf system

Jump to:   C   P   S