The clutz Reference Manual

Table of Contents

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

The clutz Reference Manual

This is the clutz Reference Manual, generated automatically by Declt version 2.4 "Will Decker" on Wed Jun 20 11:35:49 2018 GMT+0.


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

1 Introduction

CLUTZ

Simple Common Lisp API for handling OS windows and GL contexts not unlike glut, but based on different technologies.


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 clutz

Author

Pavel Korolev

Contact

dev@borodust.org

License

MIT

Description

Cross-platform utility toolkit for supporting simple Common Lisp OpenGL applications

Dependencies
Source

clutz.asd (file)

Component

clutz.lisp (file)


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 clutz.asd

Location

clutz.asd

Systems

clutz (system)


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

3.1.2 clutz/clutz.lisp

Parent

clutz (system)

Location

clutz.lisp

Packages

clutz

Exported Definitions
Internal Definitions

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

4 Packages

Packages are listed by definition order.


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

4.1 clutz

Source

clutz.lisp (file)

Use List

common-lisp

Exported Definitions
Internal Definitions

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 Functions

Function: cursor-position APPLICATION &optional VECTOR
Package

clutz

Source

clutz.lisp (file)

Function: mouse-button-state APPLICATION BUTTON
Package

clutz

Source

clutz.lisp (file)

Function: run APPLICATION &key BLOCKING
Package

clutz

Source

clutz.lisp (file)

Function: window-size APPLICATION &optional VECTOR
Package

clutz

Source

clutz.lisp (file)


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

5.1.2 Generic functions

Generic Function: destroy APPLICATION
Package

clutz

Source

clutz.lisp (file)

Methods
Method: destroy APP
Generic Function: init APPLICATION
Package

clutz

Source

clutz.lisp (file)

Methods
Method: init APP
Generic Function: render APPLICATION
Package

clutz

Source

clutz.lisp (file)

Methods
Method: render APP

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

5.1.3 Classes

Class: application ()
Package

clutz

Source

clutz.lisp (file)

Direct superclasses

standard-object (class)

Direct methods
Direct slots
Slot: window
Readers

%window-of (generic function)

Writers

(setf %window-of) (generic function)

Slot: opengl-version
Initargs

:opengl-version

Initform

(quote (3 3))

Slot: window-title
Initargs

:window-title

Initform

"clutz"

Slot: window-width
Initargs

:window-width

Initform

640

Slot: window-height
Initargs

:window-height

Initform

480

Slot: v-sync
Initargs

:v-sync

Initform

t

Readers

v-sync-enabled-p (generic function)


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

5.2 Internal definitions


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

5.2.1 Functions

Function: create-window APPLICATION
Package

clutz

Source

clutz.lisp (file)

Function: main APPLICATION
Package

clutz

Source

clutz.lisp (file)


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

5.2.2 Generic functions

Generic Function: %window-of OBJECT
Generic Function: (setf %window-of) NEW-VALUE OBJECT
Package

clutz

Methods
Method: %window-of (APPLICATION application)

automatically generated reader method

Source

clutz.lisp (file)

Method: (setf %window-of) NEW-VALUE (APPLICATION application)

automatically generated writer method

Source

clutz.lisp (file)

Generic Function: v-sync-enabled-p OBJECT
Package

clutz

Methods
Method: v-sync-enabled-p (APPLICATION application)

automatically generated reader method

Source

clutz.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
clutz.asd: The clutz<dot>asd file
clutz/clutz.lisp: The clutz/clutz<dot>lisp file

F
File, Lisp, clutz.asd: The clutz<dot>asd file
File, Lisp, clutz/clutz.lisp: The clutz/clutz<dot>lisp file

L
Lisp File, clutz.asd: The clutz<dot>asd file
Lisp File, clutz/clutz.lisp: The clutz/clutz<dot>lisp file

Jump to:   C   F   L  

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

A.2 Functions

Jump to:   %   (  
C   D   F   G   I   M   R   V   W  
Index Entry  Section

%
%window-of: Internal generic functions
%window-of: Internal generic functions

(
(setf %window-of): Internal generic functions
(setf %window-of): Internal generic functions

C
create-window: Internal functions
cursor-position: Exported functions

D
destroy: Exported generic functions
destroy: Exported generic functions

F
Function, create-window: Internal functions
Function, cursor-position: Exported functions
Function, main: Internal functions
Function, mouse-button-state: Exported functions
Function, run: Exported functions
Function, window-size: Exported functions

G
Generic Function, %window-of: Internal generic functions
Generic Function, (setf %window-of): Internal generic functions
Generic Function, destroy: Exported generic functions
Generic Function, init: Exported generic functions
Generic Function, render: Exported generic functions
Generic Function, v-sync-enabled-p: Internal generic functions

I
init: Exported generic functions
init: Exported generic functions

M
main: Internal functions
Method, %window-of: Internal generic functions
Method, (setf %window-of): Internal generic functions
Method, destroy: Exported generic functions
Method, init: Exported generic functions
Method, render: Exported generic functions
Method, v-sync-enabled-p: Internal generic functions
mouse-button-state: Exported functions

R
render: Exported generic functions
render: Exported generic functions
run: Exported functions

V
v-sync-enabled-p: Internal generic functions
v-sync-enabled-p: Internal generic functions

W
window-size: Exported functions

Jump to:   %   (  
C   D   F   G   I   M   R   V   W  

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

A.3 Variables

Jump to:   O   S   V   W  
Index Entry  Section

O
opengl-version: Exported classes

S
Slot, opengl-version: Exported classes
Slot, v-sync: Exported classes
Slot, window: Exported classes
Slot, window-height: Exported classes
Slot, window-title: Exported classes
Slot, window-width: Exported classes

V
v-sync: Exported classes

W
window: Exported classes
window-height: Exported classes
window-title: Exported classes
window-width: Exported classes

Jump to:   O   S   V   W  

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

A.4 Data types

Jump to:   A   C   P   S  
Index Entry  Section

A
application: Exported classes

C
Class, application: Exported classes
clutz: The clutz system
clutz: The clutz package

P
Package, clutz: The clutz package

S
System, clutz: The clutz system

Jump to:   A   C   P   S