The cepl.camera Reference Manual

Table of Contents

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

The cepl.camera Reference Manual

This is the cepl.camera Reference Manual, generated automatically by Declt version 2.4 "Will Decker" on Wed Jun 20 10:53:17 2018 GMT+0.


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

1 Introduction

CEPL.Camera

cepl.camera provides a camera type that plays well with cepl's space type and other features.


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.camera

Author

Chris Bagley <techsnuffle@gmail.com>

License

BSD 2 Clause

Description

A camera implementation for CEPL

Dependencies
Source

cepl.camera.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.camera.asd

Location

cepl.camera.asd

Systems

cepl.camera (system)


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

3.1.2 cepl.camera/package.lisp

Parent

cepl.camera (system)

Location

package.lisp

Packages

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

3.1.3 cepl.camera/generics.lisp

Dependency

package.lisp (file)

Parent

cepl.camera (system)

Location

generics.lisp

Exported Definitions

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

3.1.4 cepl.camera/base-camera.lisp

Dependency

generics.lisp (file)

Parent

cepl.camera (system)

Location

base-camera.lisp

Exported Definitions
Internal Definitions

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

3.1.5 cepl.camera/camera.lisp

Dependency

base-camera.lisp (file)

Parent

cepl.camera (system)

Location

camera.lisp

Exported Definitions
Internal Definitions

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

4 Packages

Packages are listed by definition order.


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

4.1 cepl.camera

Source

package.lisp (file)

Use List
Exported Definitions
Internal Definitions

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

4.2 cepl.camera.base

Source

package.lisp (file)

Use List
Used By List

cepl.camera

Exported Definitions
Internal Definitions

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

4.3 cepl.camera.generics

Source

package.lisp (file)

Use List
Used By List
Exported 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 Macros

Macro: using-camera CAMERA &body BODY
Package

cepl.camera

Source

camera.lisp (file)

Macro: with-base-camera SLOTS CAM &body BODY
Package

cepl.camera.base

Source

base-camera.lisp (file)


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

5.1.2 Functions

Function: camera-dimensions CAMERA
Function: (setf camera-dimensions) NEW-DIMENSIONS CAMERA
Package

cepl.camera.base

Source

base-camera.lisp (file)

Function: camera-fov CAMERA
Function: (setf camera-fov) VALUE CAMERA
Package

cepl.camera.base

Source

base-camera.lisp (file)

Function: camera-pos CAMERA
Function: (setf camera-pos) VALUE CAMERA
Package

cepl.camera

Source

camera.lisp (file)

Function: camera-resolution CAMERA
Function: (setf camera-resolution) NEW-RESOLUTION-V2 CAMERA
Package

cepl.camera.base

Source

base-camera.lisp (file)

Function: camera-rot CAMERA
Function: (setf camera-rot) VALUE CAMERA
Package

cepl.camera

Source

camera.lisp (file)

Function: camera-viewport CAMERA
Package

cepl.camera.base

Source

base-camera.lisp (file)

Function: make-base-camera &key VIEWPORT PROJECTION NEAR IN-SPACE FAR FOV
Package

cepl.camera.base

Source

base-camera.lisp (file)

Function: make-camera &key POS ROT VIEWPORT IN-SPACE PROJECTION NEAR FAR FOV
Package

cepl.camera

Source

camera.lisp (file)

Function: update-cam->clip BASE-CAMERA
Package

cepl.camera.base

Source

base-camera.lisp (file)


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

5.1.3 Generic functions

Generic Function: cam->clip CAMERA
Package

cepl.camera.generics

Source

generics.lisp (file)

Methods
Method: cam->clip (CAMERA base-camera)
Source

base-camera.lisp (file)

Generic Function: fov CAMERA
Generic Function: (setf fov) VAL CAMERA
Package

cepl.camera.base

Source

base-camera.lisp (file)

Methods
Method: fov (CAMERA base-camera)
Method: (setf fov) VALUE (CAMERA base-camera)
Generic Function: x->cam CAMERA
Package

cepl.camera.generics

Source

generics.lisp (file)

Methods
Method: x->cam (CAMERA camera)
Source

camera.lisp (file)


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

5.1.4 Structures

Structure: base-camera ()
Package

cepl.camera.base

Source

base-camera.lisp (file)

Direct superclasses

structure-object (structure)

Direct subclasses

camera (structure)

Direct methods
  • dimensions (method)
  • dimensions (method)
  • resolution (method)
  • resolution (method)
  • cam->clip (method)
  • viewport (method)
  • viewport (method)
  • fov (method)
  • fov (method)
Direct slots
Slot: viewport
Type

%cepl.types:viewport

Initform

(error "viewport must be supplied when making a camera")

Readers

base-camera-viewport (function)

Writers

(setf base-camera-viewport) (function)

Slot: space
Type

cepl.spaces:vec-space

Initform

(error "cepl: bug in cepl, space not provided when space-camera was created")

Readers

base-camera-space (function)

Writers

(setf base-camera-space) (function)

Slot: perspective
Type

boolean

Initform

t

Readers

base-camera-perspective (function)

Writers

(setf base-camera-perspective) (function)

Slot: in-space
Type

(or null cepl.spaces:vec-space)

Readers

base-camera-in-space (function)

Writers

(setf base-camera-in-space) (function)

Slot: near
Type

single-float

Initform

1.0

Readers

base-camera-near (function)

Writers

(setf base-camera-near) (function)

Slot: far
Type

single-float

Initform

1.0

Readers

base-camera-far (function)

Writers

(setf base-camera-far) (function)

Slot: fov
Type

single-float

Initform

90.0

Readers

base-camera-fov (function)

Writers

(setf base-camera-fov) (function)

Structure: camera ()
Package

cepl.camera

Source

camera.lisp (file)

Direct superclasses

base-camera (structure)

Direct methods
  • x->cam (method)
  • print-object (method)
Direct slots
Slot: uid
Type

fixnum

Initform

(incf cepl.camera::*uids*)

Readers

%camera-uid (function)

Writers

(setf %camera-uid) (function)

Slot: pos
Type

glsl-symbols.types:vec3

Initform

(rtg-math.base-vectors:v! 0 0 0)

Readers

%camera-pos (function)

Writers

(setf %camera-pos) (function)

Slot: rot
Type

rtg-math.types:quaternion

Initform

(rtg-math.quaternions:identity)

Readers

%camera-rot (function)

Writers

(setf %camera-rot) (function)


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

5.2 Internal definitions


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

5.2.1 Special variables

Special Variable: *uids*
Package

cepl.camera

Source

camera.lisp (file)


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

5.2.2 Functions

Function: %camera-far INSTANCE
Function: (setf %camera-far) VALUE INSTANCE
Package

cepl.camera

Source

camera.lisp (file)

Function: %camera-fov INSTANCE
Function: (setf %camera-fov) VALUE INSTANCE
Package

cepl.camera

Source

camera.lisp (file)

Function: %camera-in-space INSTANCE
Function: (setf %camera-in-space) VALUE INSTANCE
Package

cepl.camera

Source

camera.lisp (file)

Function: %camera-near INSTANCE
Function: (setf %camera-near) VALUE INSTANCE
Package

cepl.camera

Source

camera.lisp (file)

Function: %camera-perspective INSTANCE
Function: (setf %camera-perspective) VALUE INSTANCE
Package

cepl.camera

Source

camera.lisp (file)

Function: %camera-pos INSTANCE
Function: (setf %camera-pos) VALUE INSTANCE
Package

cepl.camera

Source

camera.lisp (file)

Function: %camera-rot INSTANCE
Function: (setf %camera-rot) VALUE INSTANCE
Package

cepl.camera

Source

camera.lisp (file)

Function: %camera-space INSTANCE
Function: (setf %camera-space) VALUE INSTANCE
Package

cepl.camera

Source

camera.lisp (file)

Function: %camera-uid INSTANCE
Function: (setf %camera-uid) VALUE INSTANCE
Package

cepl.camera

Source

camera.lisp (file)

Function: %camera-viewport INSTANCE
Function: (setf %camera-viewport) VALUE INSTANCE
Package

cepl.camera

Source

camera.lisp (file)

Function: %make-base-camera &key (VIEWPORT VIEWPORT) (SPACE SPACE) (PERSPECTIVE PERSPECTIVE) (IN-SPACE IN-SPACE) (NEAR NEAR) (FAR FAR) (FOV FOV)
Package

cepl.camera.base

Source

base-camera.lisp (file)

Function: %make-camera &key (VIEWPORT VIEWPORT) (SPACE SPACE) (PERSPECTIVE PERSPECTIVE) (IN-SPACE IN-SPACE) (NEAR NEAR) (FAR FAR) (FOV FOV) (UID UID) (POS POS) (ROT ROT)
Package

cepl.camera

Source

camera.lisp (file)

Function: base-camera-far INSTANCE
Function: (setf base-camera-far) VALUE INSTANCE
Package

cepl.camera.base

Source

base-camera.lisp (file)

Function: base-camera-fov INSTANCE
Function: (setf base-camera-fov) VALUE INSTANCE
Package

cepl.camera.base

Source

base-camera.lisp (file)

Function: base-camera-in-space INSTANCE
Function: (setf base-camera-in-space) VALUE INSTANCE
Package

cepl.camera.base

Source

base-camera.lisp (file)

Function: base-camera-near INSTANCE
Function: (setf base-camera-near) VALUE INSTANCE
Package

cepl.camera.base

Source

base-camera.lisp (file)

Function: base-camera-p OBJECT
Package

cepl.camera.base

Source

base-camera.lisp (file)

Function: base-camera-perspective INSTANCE
Function: (setf base-camera-perspective) VALUE INSTANCE
Package

cepl.camera.base

Source

base-camera.lisp (file)

Function: base-camera-space INSTANCE
Function: (setf base-camera-space) VALUE INSTANCE
Package

cepl.camera.base

Source

base-camera.lisp (file)

Function: base-camera-viewport INSTANCE
Function: (setf base-camera-viewport) VALUE INSTANCE
Package

cepl.camera.base

Source

base-camera.lisp (file)

Function: camera-p OBJECT
Package

cepl.camera

Source

camera.lisp (file)

Function: copy-base-camera INSTANCE
Package

cepl.camera.base

Source

base-camera.lisp (file)

Function: copy-camera INSTANCE
Package

cepl.camera

Source

camera.lisp (file)

Function: update-x->cam CAMERA
Package

cepl.camera

Source

camera.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.camera.asd: The cepl<dot>camera<dot>asd file
cepl.camera/base-camera.lisp: The cepl<dot>camera/base-camera<dot>lisp file
cepl.camera/camera.lisp: The cepl<dot>camera/camera<dot>lisp file
cepl.camera/generics.lisp: The cepl<dot>camera/generics<dot>lisp file
cepl.camera/package.lisp: The cepl<dot>camera/package<dot>lisp file

F
File, Lisp, cepl.camera.asd: The cepl<dot>camera<dot>asd file
File, Lisp, cepl.camera/base-camera.lisp: The cepl<dot>camera/base-camera<dot>lisp file
File, Lisp, cepl.camera/camera.lisp: The cepl<dot>camera/camera<dot>lisp file
File, Lisp, cepl.camera/generics.lisp: The cepl<dot>camera/generics<dot>lisp file
File, Lisp, cepl.camera/package.lisp: The cepl<dot>camera/package<dot>lisp file

L
Lisp File, cepl.camera.asd: The cepl<dot>camera<dot>asd file
Lisp File, cepl.camera/base-camera.lisp: The cepl<dot>camera/base-camera<dot>lisp file
Lisp File, cepl.camera/camera.lisp: The cepl<dot>camera/camera<dot>lisp file
Lisp File, cepl.camera/generics.lisp: The cepl<dot>camera/generics<dot>lisp file
Lisp File, cepl.camera/package.lisp: The cepl<dot>camera/package<dot>lisp file

Jump to:   C   F   L  

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

A.2 Functions

Jump to:   %   (  
B   C   F   G   M   U   W   X  
Index Entry  Section

%
%camera-far: Internal functions
%camera-fov: Internal functions
%camera-in-space: Internal functions
%camera-near: Internal functions
%camera-perspective: Internal functions
%camera-pos: Internal functions
%camera-rot: Internal functions
%camera-space: Internal functions
%camera-uid: Internal functions
%camera-viewport: Internal functions
%make-base-camera: Internal functions
%make-camera: Internal functions

(
(setf %camera-far): Internal functions
(setf %camera-fov): Internal functions
(setf %camera-in-space): Internal functions
(setf %camera-near): Internal functions
(setf %camera-perspective): Internal functions
(setf %camera-pos): Internal functions
(setf %camera-rot): Internal functions
(setf %camera-space): Internal functions
(setf %camera-uid): Internal functions
(setf %camera-viewport): Internal functions
(setf base-camera-far): Internal functions
(setf base-camera-fov): Internal functions
(setf base-camera-in-space): Internal functions
(setf base-camera-near): Internal functions
(setf base-camera-perspective): Internal functions
(setf base-camera-space): Internal functions
(setf base-camera-viewport): Internal functions
(setf camera-dimensions): Exported functions
(setf camera-fov): Exported functions
(setf camera-pos): Exported functions
(setf camera-resolution): Exported functions
(setf camera-rot): Exported functions
(setf fov): Exported generic functions
(setf fov): Exported generic functions

B
base-camera-far: Internal functions
base-camera-fov: Internal functions
base-camera-in-space: Internal functions
base-camera-near: Internal functions
base-camera-p: Internal functions
base-camera-perspective: Internal functions
base-camera-space: Internal functions
base-camera-viewport: Internal functions

C
cam->clip: Exported generic functions
cam->clip: Exported generic functions
camera-dimensions: Exported functions
camera-fov: Exported functions
camera-p: Internal functions
camera-pos: Exported functions
camera-resolution: Exported functions
camera-rot: Exported functions
camera-viewport: Exported functions
copy-base-camera: Internal functions
copy-camera: Internal functions

F
fov: Exported generic functions
fov: Exported generic functions
Function, %camera-far: Internal functions
Function, %camera-fov: Internal functions
Function, %camera-in-space: Internal functions
Function, %camera-near: Internal functions
Function, %camera-perspective: Internal functions
Function, %camera-pos: Internal functions
Function, %camera-rot: Internal functions
Function, %camera-space: Internal functions
Function, %camera-uid: Internal functions
Function, %camera-viewport: Internal functions
Function, %make-base-camera: Internal functions
Function, %make-camera: Internal functions
Function, (setf %camera-far): Internal functions
Function, (setf %camera-fov): Internal functions
Function, (setf %camera-in-space): Internal functions
Function, (setf %camera-near): Internal functions
Function, (setf %camera-perspective): Internal functions
Function, (setf %camera-pos): Internal functions
Function, (setf %camera-rot): Internal functions
Function, (setf %camera-space): Internal functions
Function, (setf %camera-uid): Internal functions
Function, (setf %camera-viewport): Internal functions
Function, (setf base-camera-far): Internal functions
Function, (setf base-camera-fov): Internal functions
Function, (setf base-camera-in-space): Internal functions
Function, (setf base-camera-near): Internal functions
Function, (setf base-camera-perspective): Internal functions
Function, (setf base-camera-space): Internal functions
Function, (setf base-camera-viewport): Internal functions
Function, (setf camera-dimensions): Exported functions
Function, (setf camera-fov): Exported functions
Function, (setf camera-pos): Exported functions
Function, (setf camera-resolution): Exported functions
Function, (setf camera-rot): Exported functions
Function, base-camera-far: Internal functions
Function, base-camera-fov: Internal functions
Function, base-camera-in-space: Internal functions
Function, base-camera-near: Internal functions
Function, base-camera-p: Internal functions
Function, base-camera-perspective: Internal functions
Function, base-camera-space: Internal functions
Function, base-camera-viewport: Internal functions
Function, camera-dimensions: Exported functions
Function, camera-fov: Exported functions
Function, camera-p: Internal functions
Function, camera-pos: Exported functions
Function, camera-resolution: Exported functions
Function, camera-rot: Exported functions
Function, camera-viewport: Exported functions
Function, copy-base-camera: Internal functions
Function, copy-camera: Internal functions
Function, make-base-camera: Exported functions
Function, make-camera: Exported functions
Function, update-cam->clip: Exported functions
Function, update-x->cam: Internal functions

G
Generic Function, (setf fov): Exported generic functions
Generic Function, cam->clip: Exported generic functions
Generic Function, fov: Exported generic functions
Generic Function, x->cam: Exported generic functions

M
Macro, using-camera: Exported macros
Macro, with-base-camera: Exported macros
make-base-camera: Exported functions
make-camera: Exported functions
Method, (setf fov): Exported generic functions
Method, cam->clip: Exported generic functions
Method, fov: Exported generic functions
Method, x->cam: Exported generic functions

U
update-cam->clip: Exported functions
update-x->cam: Internal functions
using-camera: Exported macros

W
with-base-camera: Exported macros

X
x->cam: Exported generic functions
x->cam: Exported generic functions

Jump to:   %   (  
B   C   F   G   M   U   W   X  

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

A.3 Variables

Jump to:   *  
F   I   N   P   R   S   U   V  
Index Entry  Section

*
*uids*: Internal special variables

F
far: Exported structures
fov: Exported structures

I
in-space: Exported structures

N
near: Exported structures

P
perspective: Exported structures
pos: Exported structures

R
rot: Exported structures

S
Slot, far: Exported structures
Slot, fov: Exported structures
Slot, in-space: Exported structures
Slot, near: Exported structures
Slot, perspective: Exported structures
Slot, pos: Exported structures
Slot, rot: Exported structures
Slot, space: Exported structures
Slot, uid: Exported structures
Slot, viewport: Exported structures
space: Exported structures
Special Variable, *uids*: Internal special variables

U
uid: Exported structures

V
viewport: Exported structures

Jump to:   *  
F   I   N   P   R   S   U   V  

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

A.4 Data types

Jump to:   B   C   P   S  
Index Entry  Section

B
base-camera: Exported structures

C
camera: Exported structures
cepl.camera: The cepl<dot>camera system
cepl.camera: The cepl<dot>camera package
cepl.camera.base: The cepl<dot>camera<dot>base package
cepl.camera.generics: The cepl<dot>camera<dot>generics package

P
Package, cepl.camera: The cepl<dot>camera package
Package, cepl.camera.base: The cepl<dot>camera<dot>base package
Package, cepl.camera.generics: The cepl<dot>camera<dot>generics package

S
Structure, base-camera: Exported structures
Structure, camera: Exported structures
System, cepl.camera: The cepl<dot>camera system

Jump to:   B   C   P   S