cl sf3

1.0.0

A library to parse and create SF3 files.

Table of Contents

About cl-sf3

This is an implementation of the SF3 (Simple File Format Family) standard. It provides easy parsing and creation of SF3 formatted files. Included are formats for images, audio, 3D models, rich text, logging, archives, and more.

How To

In order to parse an SF3 file of any type, simply use read-sf3. It will return an archive, audio, image, log, model, physics-model, table, text, or vector-graphic instance. In order to determine what type of file it is before parsing it fully, you can use tell-sf3. And in order to serialise an instance to file, you can similarly use write-sf3.

As per usual for systems like this that are implemented via binary-structures you can use pathnames, binary streams, octet-vectors, and foreign memory pointers as the storage object.

In order to construct the instances, each instance type has its own function prefixed with make-: make-archive, make-audio, make-image, make-log, make-model, make-physics-model, make-table, make-text, make-vector-graphic.

Finally, you can also get the specified file extension for a type via file-extension, and its mime-type via mime-type.

If you only have use of specific file formats, you can load support for only those formats by loading cl-sf3/audio, etc.

System Information

Version: 1.0.0

Dependencies:

cl-sf3/archive
cl-sf3/audio
cl-sf3/image
cl-sf3/log
cl-sf3/model
cl-sf3/physics-model
cl-sf3/table
cl-sf3/text
cl-sf3/vector-graphic

Author: Yukari Hafner

License: zlib

Homepage: https://shirakumo.org/docs/cl-sf3

Bug Tracker: https://shirakumo.org/projects/cl-sf3/issues

Sources: https://shirakumo.org/projects/cl-sf3.git

Definition Index

ORG.SHIRAKUMO.SF3

No documentation provided.

EXTERNAL STRUCTURE

ARCHIVE

Representation of an archive file.

See MAKE-ARCHIVE
See META-ENTRIES
See FILES
See ADD-FILE
See EXTRACT-FILE
See WRITE-SF3
See READ-SF3
See TELL-SF3

EXTERNAL STRUCTURE

ARCHIVE-META-ENTRY

Representation of an archive file metadata entry.

See MAKE-ARCHIVE-META-ENTRY
See MODIFICATION-TIME
See CHECKSUM
See MIME-TYPE
See PATH

EXTERNAL STRUCTURE

AUDIO

Representation of an audio file.

See MAKE-AUDIO
See DURATION
See SAMPLERATE
See CHANNELS
See CHANNEL-LAYOUT
See SAMPLE-FORMAT
See SAMPLES
See WRITE-SF3
See READ-SF3
See TELL-SF3

EXTERNAL STRUCTURE

BOX

Representation of a box shape.

See MAKE-BOX
See WIDTH
See HEIGHT
See DEPTH
See PHYSICS-MODEL (type)

EXTERNAL STRUCTURE

CIRCLE

Representation of a circle.

See BOUNDS
See FILL
See MAKE-CIRCLE

EXTERNAL STRUCTURE

COLOR

Representation of a color.

See R
See G
See B
See A
See MAKE-COLOR

EXTERNAL STRUCTURE

COLOR-OPTION

Representation of a color markup option.

See MAKE-COLOR-OPTION
See R
See G
See B
See MARKUP (type)

EXTERNAL STRUCTURE

COLUMN-SPEC

Representation of the specification for a column in a table.

See MAKE-COLUMN-SPEC
See NAME
See SIZE
See KIND
See COLUMN-SPEC-TYPE
See COLUMN-SPEC-ELEMENT-SIZE
See COLUMN-SPEC-ELEMENT-COUNT

EXTERNAL STRUCTURE

CURVE

Representation of a shape with a Bezier curve outline.

See POINTS
See FILL
See MAKE-CURVE

EXTERNAL STRUCTURE

CYLINDER

Representation of a cylindrical shape.

See MAKE-CYLINDER
See BOTTOM-RADIUS
See TOP-RADIUS
See HEIGHT
See PHYSICS-MODEL (type)

EXTERNAL STRUCTURE

ELLIPSOID

Representation of an ellipsoid shape.

See MAKE-ELLIPSOID
See WIDTH
See HEIGHT
See DEPTH
See PHYSICS-MODEL (type)

EXTERNAL STRUCTURE

HEADING-OPTION

Representation of a heading markup option.

See MAKE-HEADING-OPTION
See LEVEL

EXTERNAL STRUCTURE

IMAGE

Representation of an image file.

See WIDTH
See HEIGHT
See DEPTH
See CHANNELS
See PIXEL-FORMAT
See PIXEL-TYPE
See PIXEL-STRIDE
See PIXELS
See WRITE-SF3
See READ-SF3
See TELL-SF3

EXTERNAL STRUCTURE

LINE

Representation of a segmented line.

See POINTS
See COLOR
See THICKNESS
See MAKE-LINE

EXTERNAL STRUCTURE

LINK-OPTION

Representation of a link markup option.

See ADDRESS
See MAKE-LINK-OPTION

EXTERNAL STRUCTURE

LOG

Representation of a log file.

See MAKE-LOG
See START-TIME
See END-TIME
See CHUNKS
See LOG-APPEND-CHUNK
See LOG-APPEND-ENTRY-EXTEND
See LOG
See WRITE-SF3
See READ-SF3
See TELL-SF3

EXTERNAL STRUCTURE

LOG-CHUNK

Representation of a chunk of log entries in a log file.

See MAKE-LOG-CHUNK
See ENTRIES

EXTERNAL STRUCTURE

LOG-ENTRY

Representation of a single entry in a log file.

See SIZE
See TIME
See SEVERITY
See SOURCE
See CATEGORY
See MESSAGE
See MAKE-LOG-ENTRY

EXTERNAL STRUCTURE

MARKUP

Representation of a markup section.

See MAKE-MARKUP
See START
See END
See OPTION

EXTERNAL STRUCTURE

MESH

Representation of a convex mesh shape.

See MAKE-MESH
See VERTICES
See PHYSICS-MODEL (type)

EXTERNAL STRUCTURE

MODEL

Representation of a 3D model file.

See MAKE-MODEL
See VERTEX-ATTRIBUTES
See VERTEX-STRIDE
See TEXTURE-TYPES
See TEXTURES
See FACES
See VERTICES
See WRITE-SF3
See READ-SF3
See TELL-SF3

EXTERNAL STRUCTURE

PHYSICS-MODEL

Representation of a physics model.

See MAKE-PHYSICS-MODEL
See MASS
See TENSOR
See SHAPES
See WRITE-SF3
See READ-SF3
See TELL-SF3

EXTERNAL STRUCTURE

PILL

Representation of a pill-box shape.

See MAKE-PILL
See BOTTOM-RADIUS
See TOP-RADIUS
See HEIGHT
See PHYSICS-MODEL (type)

EXTERNAL STRUCTURE

POINT

Representation of a position on the canvas.

See X
See Y
See MAKE-POINT

EXTERNAL STRUCTURE

POLYGON

Representation of a closed polygon.

See POINTS
See FILL
See MAKE-POLYGON

EXTERNAL STRUCTURE

RECTANGLE

Representation of a rectangle.

See BOUNDS
See FILL
See MAKE-RECTANGLE

EXTERNAL STRUCTURE

SF3-FILE-HEADER

Representation of the generic header of an SF3 file.

See MAKE-SF3-FILE-HEADER
See KIND
See CHECKSUM

EXTERNAL STRUCTURE

SHAPE

Representation of an arbitrary physics shape.

You can also access the inner shape's attributes through this object
without needing to unpack the inner shape first.

See MAKE-SHAPE
See TRANSFORM
See DATA
See PHYSICS-MODEL (type)

EXTERNAL STRUCTURE

SHAPE-BOUNDS

Representation of the bounds of a shape.

The POINT defines the lower left corner, and the SIZE the extent of
the shape.

See POINT
See SIZE
See MAKE-SHAPE-BOUNDS

EXTERNAL STRUCTURE

SHAPE-FILL

Representation of the shape fill parameters.

See FILL-COLOR
See OUTLINE-COLOR
See OUTLINE-THICKNESS
See MAKE-SHAPE-FILL

EXTERNAL STRUCTURE

SIZE

Representation of an extent on the canvas.

See W
See H
See MAKE-SIZE

EXTERNAL STRUCTURE

SIZE-OPTION

Representation of a font size markup option.

See MAKE-SIZE-OPTION
See FONT-SIZE

EXTERNAL STRUCTURE

TABLE

Representation of a table.

See MAKE-TABLE
See COLUMN-COUNT
See ROW-COUNT
See COLUMN-SPECS
See ROW-DATA
See ROW
See CELL
See WRITE-SF3
See READ-SF3
See TELL-SF3

EXTERNAL STRUCTURE

TARGET-OPTION

Representation of a link target option.

See ADDRESS
See MAKE-TARGET-OPTION

EXTERNAL STRUCTURE

TEXT

Representation of a text with markup.

See MAKE-TEXT
See TEXT
See MARKUP
See WRITE-SF3
See READ-SF3
See TELL-SF3

EXTERNAL STRUCTURE

TEXT-SHAPE

Representation of a text shape.

See POINT
See COLOR
See FONT
See FONT-SIZE
See TEXT
See MAKE-TEXT-SHAPE

EXTERNAL STRUCTURE

VECTOR-GRAPHIC

Representation of a vector graphic image.

See WIDTH
See HEIGHT
See INSTRUCTIONS
See MAKE-VECTOR-GRAPHIC
See WRITE-SF3
See READ-SF3
See TELL-SF3

EXTERNAL FUNCTION

CELL

TABLE
ROW
COLUMN

Accesses the specified cell contents of the table.

If the cell contains multiple elements, it is encoded as a list.
When setting a cell, you may similarly set a list of elements, or a
single element value.

See TABLE (type)

EXTERNAL FUNCTION
(SETF CELL)
- VALUE
- TABLE
- ROW
- COLUMN
Source
No documentation provided.

EXTERNAL FUNCTION

COLUMN-SPEC-ELEMENT-COUNT

SPEC

Returns the number of elements stored in the column.

See KIND
See COLUMN-SPEC-ELEMENT-SIZE
See SIZE
See COLUMN-SPEC (type)

EXTERNAL FUNCTION

COLUMN-SPEC-ELEMENT-SIZE

SPEC

Returns the octet size of an element in the column.

See KIND
See COLUMN-SPEC (type)

EXTERNAL FUNCTION

COLUMN-SPEC-TYPE

SPEC

Returns the type of the column data.

This can be one of:
  :uint8
  :uint16
  :uint32
  :uint64
  :sint8
  :sint16
  :sint32
  :sint64
  :float16
  :float32
  :float64
  :string
  :timestamp
  :high-resolution-timestamp
  :boolean

See KIND
See COLUMN-SPEC (type)

EXTERNAL FUNCTION

DURATION

AUDIO

Returns the duration of the audio data contained in seconds as a float.

See AUDIO (type)

EXTERNAL FUNCTION

LOG

LOG
MESSAGE
&REST
ENTRY-ARGS

Create a new log entry and append it.

This is the same as invoking MAKE-LOG-ENTRY and
LOG-APPEND-ENTRY-EXTEND.

See MAKE-LOG-ENTRY
See LOG-APPEND-ENTRY-EXTEND
See LOG (type)
See LOG-ENTRY (type)

EXTERNAL FUNCTION

LOG-APPEND-CHUNK

LOG
&REST
ARGS

Append a new chunk to the log.

ARGS are passed on to MAKE-LOG-CHUNK.
The LOG is returned again.

See MAKE-LOG-CHUNK
See LOG (type)

EXTERNAL FUNCTION

LOG-APPEND-ENTRY-EXTEND

LOG
ENTRY
&REST
ARGS

Append a new entry to the log, creating a new chunk if necessary.

ARGS are passed on to MAKE-LOG-CHUNK.
The LOG is returned again.

See LOG-ENTRY (type)
See LOG (type)

EXTERNAL FUNCTION

MAKE-ARCHIVE

FILES

Create a new file archive

FILES should be a list of file specs, where a file spec is

  (FILE ...args)
  FILE

and will be passed to ADD-FILE, filling in the ARCHIVE argument.

See ARCHIVE (type)
See ADD-FILE

EXTERNAL FUNCTION
MAKE-ARCHIVE-META-ENTRY
- &KEY
- MODIFICATION-TIME
- CHECKSUM
- MIME-TYPE
- PATH
Source
```
Create an archive metadata entry.

See ARCHIVE-META-ENTRY
```

EXTERNAL FUNCTION

MAKE-AUDIO

SAMPLES
&KEY
SAMPLERATE
CHANNELS

Create a new audio file.

SAMPLES should be a vector with raw audio samples. The sample format
is inferred from the element-type of the vector. As such, you must
ensure the array is of the appropriate format. The array must also
have a multiple of CHANNELS elements.

See AUDIO (type)

EXTERNAL FUNCTION

MAKE-BOX

W
H
D
&KEY
TRANSFORM

Create a new box shape.

If the TRANSFORM is omitted, it is set to the identity matrix.
Otherwise it should be a 4x4 matrix in the form of a sequence of 16
single-floats.

See ELLIPSOID (type)
See SHAPE (type)

EXTERNAL FUNCTION

MAKE-CIRCLE

X
Y
W
H
&REST
FILL-ARGS

Create a new circle instance.

X and Y should be the lower left corner coordinates, and W and H the
dimensions of the circle.
FILL-ARGS are passed verbatim to MAKE-SHAPE-FILL

See MAKE-SHAPE-FILL
See CIRCLE (type)

EXTERNAL FUNCTION

MAKE-COLOR

R
G
B
&OPTIONAL
A

Create a new color instance.

R G B and A should be numbers in the range [0,1] to indicate the value
of the corresponding color channel.

See COLOR (type)

EXTERNAL FUNCTION

MAKE-COLOR-OPTION

START
END
&OPTIONAL
R
G
B

Create a new color markup option.

The values should be in the range of [0,1].

See COLOR-OPTION (type)

EXTERNAL FUNCTION

MAKE-COLUMN-SPEC

NAME
&OPTIONAL
TYPE
LENGTH

Create a new column specification.

LENGTH is automatically converted to the octet-size of a multiple of
the TYPE, except for if the TYPE is :STRING, in which case the LENGTH
is taken to be the maximum length of the string in octets.

See COLUMN-SPEC (type)
See COLUMN-SPEC-TYPE

EXTERNAL FUNCTION

MAKE-CURVE

POINTS
&REST
FILL-ARGS

Create a new curve instance.

POINTS should be a sequence of POINT instances defining the Bezier
curve segments of the outline. Each outline segment is made up of four
points, the first and last being the edge points and the second and
third being the corresponding control points. For successive segments
the first and final edge point are shared as no gaps between segments
are allowed anyway.
FILL-ARGS are passed verbatim to MAKE-SHAPE-FILL

See MAKE-SHAPE-FILL
See CURVE (type)

EXTERNAL FUNCTION

MAKE-CYLINDER

BOTTOM-RADIUS
TOP-RADIUS
HEIGHT
&KEY
TRANSFORM

Create a new cylinder shape.

If the TRANSFORM is omitted, it is set to the identity matrix.
Otherwise it should be a 4x4 matrix in the form of a sequence of 16
single-floats.

See ELLIPSOID (type)
See SHAPE (type)

EXTERNAL FUNCTION

MAKE-ELLIPSOID

W
H
D
&KEY
TRANSFORM

Create a new ellipsoid shape.

If the TRANSFORM is omitted, it is set to the identity matrix.
Otherwise it should be a 4x4 matrix in the form of a sequence of 16
single-floats.

See ELLIPSOID (type)
See SHAPE (type)

EXTERNAL FUNCTION

MAKE-HEADING-OPTION

LEVEL

Create a new heading markup option.

The level should be a positive integer.

See HEADING-OPTION (type)

EXTERNAL FUNCTION

MAKE-IMAGE

PIXELS
WIDTH
HEIGHT
&KEY
DEPTH
PIXEL-TYPE

Create a new image file.

PIXELS should be a vector with raw pixel data. The pixel format
is inferred from the element-type of the vector. As such, you must
ensure the array is of the appropriate format. The array must also
have a multiple of WIDTH*HEIGHT*DEPTH*CHANNELS elements.

See PIXEL-TYPE
See IMAGE (type)

EXTERNAL FUNCTION

MAKE-LINE

POINTS
&KEY
THICKNESS
COLOR

Create a new line instance.

POINTS should be a sequence of POINT instances.
THICKNESS should be a positive number representing the thickness of
the line in pixels.
COLOR should be a COLOR instance describing the color of the line.

See LINE (type)

EXTERNAL FUNCTION

MAKE-LINK-OPTION

ADDRESS

Create a new hyperlink markup option.

The address should be a string naming the address of a corresponding
target-option, or an URL.

See TARGET-OPTION (type)
See LINK-OPTION (type)

EXTERNAL FUNCTION

MAKE-LOG

&KEY
START-TIME
END-TIME
ENTRIES

Create a new log instance.

The START-TIME and END-TIME should be given as a UNIVERSAL-TIME
timestamp and are converted to UNIX time for you. If END-TIME is not
given, the time is set to the maximal possible value, indicating that
the log file is not yet complete.

ENTRIES specifies the number of entries to allocate for in the first
chunk of the log file.

See MAKE-LOG-CHUNK
See END-TIME
See LOG (type)

EXTERNAL FUNCTION

MAKE-LOG-CHUNK

&KEY
ENTRIES

Create a new log chunk.

The ENTRIES count is the number of entries that the chunk will be
capable of storing.

See LOG-CHUNK (type)

EXTERNAL FUNCTION

MAKE-LOG-ENTRY

MESSAGE
&KEY
TIME
SEVERITY
SOURCE
CATEGORY

Create a new log entry.

The size of the entry is automatically computed based on the other
attributes. The TIME is given in UNIVERSAL-TIME format and
automatically converted to UNIX time for you.

See LOG-ENTRY (type)

EXTERNAL FUNCTION

MAKE-MARKUP

START
END
OPTION

Create a new markup section.

The START and END should be indices for the range of text to mark up,
where the END defines the index after which the option no longer
applies.

START and END must be positive integers, and END must be greater or
equal to START.

OPTION should be a valid markup option type:

  :BOLD
  :ITALIC
  :UNDERLINE
  :STRIKE
  :MONO
  COLOR-OPTION
  SIZE-OPTION
  HEADING-OPTION
  LINK-OPTION
  TARGET-OPTION

See MARKUP (type)

EXTERNAL FUNCTION

MAKE-MESH

VERTICES
&KEY
TRANSFORM

Create a new mesh shape.

VERTICES should be a sequence of single-floats, three of which each
describe a vertex' position. The vertices should collectively form a
convex hull.

If the TRANSFORM is omitted, it is set to the identity matrix.
Otherwise it should be a 4x4 matrix in the form of a sequence of 16
single-floats.

See ELLIPSOID (type)
See SHAPE (type)

EXTERNAL FUNCTION

MAKE-MODEL

FACES
VERTICES
&KEY
VERTEX-ATTRIBUTES
MATERIAL

Create a new 3D model instance.

FACES should be an (UNSIGNED-BYTE 32) array of vertex indices, and
VERTICES should be a SINGLE-FLOAT array of vertex attributes.

VERTEX-ATTRIBUTES should be the set of attributes as stored in
VERTICES. The attributes as stored in VERTICES MUST follow the order
of the attributes outlined in this set. The possible sets of
attributes can be seen in VERTEX-ATTRIBUTES.

MATERIAL should be a property list of relative paths to material
textures. The set of permissible keys can be seen in TEXTURE-TYPES.

See VERTEX-ATTRIBUTES
See TEXTURE-TYPES
See MODEL (type)

EXTERNAL FUNCTION

MAKE-PHYSICS-MODEL

MASS
TENSOR
&REST
SHAPES

Create a new physics model.

The MASS should be expressed in Kg. The TENSOR should be a sequence of
9 single-floats, describing the overall inertia tensor of the entire
model.

SHAPES should be the SHAPE instances that make up the physics model's
hull.

See MAKE-ELLIPSOID
See MAKE-BOX
See MAKE-CYLINDER
See MAKE-PILL
See MAKE-MESH
See PHYSICS-MODEL (type)

EXTERNAL FUNCTION

MAKE-PILL

BOTTOM-RADIUS
TOP-RADIUS
HEIGHT
&KEY
TRANSFORM

Create a new pill shape.

If the TRANSFORM is omitted, it is set to the identity matrix.
Otherwise it should be a 4x4 matrix in the form of a sequence of 16
single-floats.

See ELLIPSOID (type)
See SHAPE (type)

EXTERNAL FUNCTION

MAKE-POINT

X
Y

Create a new point instance.

X and Y should be coordinates of the position.

See POINT (type)

EXTERNAL FUNCTION

MAKE-POLYGON

POINTS
&REST
FILL-ARGS

Create a new polygon instance.

POINTS should be a sequence of POINT instances defining the edges of
the outline of the polygon.
FILL-ARGS are passed verbatim to MAKE-SHAPE-FILL

See MAKE-SHAPE-FILL
See POLYGON (type)

EXTERNAL FUNCTION

MAKE-RECTANGLE

X
Y
W
H
&REST
FILL-ARGS

Create a new rectangle instance.

X and Y should be the lower left corner coordinates, and W and H the
dimensions of the rectangle.
FILL-ARGS are passed verbatim to MAKE-SHAPE-FILL

See MAKE-SHAPE-FILL
See RECTANGLE (type)

EXTERNAL FUNCTION

MAKE-SF3-FILE-HEADER

KIND
&OPTIONAL
CHECKSUM

Create a new SF3-FILE-HEADER instance.

The KIND should name the type of file format stored.

See SF3-FILE-HEADER (type)

EXTERNAL FUNCTION

MAKE-SHAPE

&KEY
TRANSFORM
DATA

Create a new shape.

This is typically not necessary as the shape constructors individually
automatically wrap the shape data in a SHAPE instance.

See SHAPE (type)

EXTERNAL FUNCTION

MAKE-SHAPE-BOUNDS

X
Y
W
H

Create a new shape-bounds instance.

X and Y should be the lower left corner coordinates, and W and H the
dimensions of the extent.

See SHAPE-BOUNDS (type)

EXTERNAL FUNCTION

MAKE-SHAPE-FILL

&KEY
FILL-COLOR
OUTLINE-COLOR
OUTLINE-THICKNESS

Create a new shape-fill instance.

FILL-COLOR and OUTLINE-COLOR should be COLOR instances.
OUTLINE-THICKNESS should be a positive number representing the
thickness of the outline in pixels.

See SHAPE-FILL (type)

EXTERNAL FUNCTION

MAKE-SIZE

W
H

Create a new size instance.

W and H should be positive numbers representing the dimensions of the
extent.

See SIZE (type)

EXTERNAL FUNCTION

MAKE-SIZE-OPTION

FONT-SIZE

Create a new size markup option.

The size should be a positive number.

See SIZE-OPTION (type)

EXTERNAL FUNCTION

MAKE-TABLE

COLUMNS
DATA

Create a new table.

COLUMNS should be specifications of the columns in the table, where
each spec should be either a COLUMN-SPEC instance, a list of arguments
to MAKE-COLUMN-SPEC, or a string to pass to MAKE-COLUMN-SPEC.

The DATA should be a sequence of sequences, where each inner sequence
must have the same number of entries as COLUMNS. In cases where a
column can hold multiple elements, the cells for this column may
either be specified via a single element, or a list of elements.

See CELL
See MAKE-COLUMN-SPEC
See TABLE (type)

EXTERNAL FUNCTION

MAKE-TARGET-OPTION

ADDRESS

Create a new link target markup option.

The address should be a string naming the target.

See TARGET-OPTION (type)
See LINK-OPTION (type)

EXTERNAL FUNCTION

MAKE-TEXT

TEXT
&REST
MARKUP

Create a new text instance.

TEXT should be a string to mark up.
MARKUP should be a number of markup specs, which can either be a
MARKUP instance, or a list composed of a START and END index and
either a valid markup option instance, or the name of an option and
the arguments for its corresponding constructor.

For example (0 1 :COLOR 1 0 0) or simply (0 1 :BOLD).

See TEXT (type)

EXTERNAL FUNCTION

MAKE-TEXT-SHAPE

X
Y
TEXT
&KEY
COLOR
FONT
FONT-SIZE

Create a new text-shape instance.

X and Y define the point in the middle of the baseline of the first
character in the TEXT. COLOR should be a COLOR instance to define the
"foreground" color of the text. FONT should be a string identifier
of the font family to use for the text. FONT-SIZE should be a positive
number defining the height of a text line in pixels.

See TEXT-SHAPE (type)

EXTERNAL FUNCTION

MAKE-VECTOR-GRAPHIC

WIDTH
HEIGHT
INSTRUCTIONS

Create a new vector graphic image.

WIDTH and HEIGHT should be the dimensions of the image canvas.
INSTRUCTIONS should be a sequence of drawing instructions, which may
be one of the following:

  LINE
  RECTANGLE
  CIRCLE
  POLYGON
  CURVE
  TEXT-SHAPE
  (ARRAY SINGLE-FLOAT (6))

In the array case it represents a 3x2 transform matrix to be applied.
to all following instructions until the next transform matrix.

See VECTOR-GRAPHIC (type)

EXTERNAL FUNCTION

PIXEL-STRIDE

IMAGE

Returns the number of elements that constitute a pixel.

See IMAGE (type)

EXTERNAL FUNCTION

PIXEL-TYPE

IMAGE

Returns the pixel type of the image file.

The pixel type can be one of:

  :V
  :VA
  :RGB
  :RGBA
  :AV
  :BGR
  :ABGR
  :ARGB
  :BGRA
  :CMYK
  :KYMC

Which describes the color channel purpose and arrangement within the
pixel data.

See IMAGE (type)

EXTERNAL FUNCTION

READ-SF3

STORAGE
&REST
ARGS

Read an SF3 file from the given storage.

Depending on the storage backend, additional arguments may be
necessary. The following backends are supported:

  PATHNAME
  STREAM
  OCTET-VECTOR (optionally accepts :START and :END key arguments)
  FOREIGN-POINTER (requires a SIZE argument)

If successful returns the format instance.
If parsing fails, an error is signalled.

See TELL-SF3
See ARCHIVE (type)
See AUDIO (type)
See IMAGE (type)
See LOG (type)
See MODEL (type)
See PHYSICS-MODEL (type)
See TABLE (type)
See TEXT (type)
See VECTOR-GRAPHIC (type)

EXTERNAL FUNCTION

ROW

TABLE
ROW

Returns the specified row contents of the table as a list.

If a cell contains multiple elements, it is encoded as a list.

See TABLE (type)

EXTERNAL FUNCTION

TELL-SF3

STORAGE
&REST
ARGS

Determine the type of SF3 file within the storage.

Depending on the storage backend, additional arguments may be
necessary. The following backends are supported:

  PATHNAME
  STREAM
  OCTET-VECTOR (optionally accepts :START and :END key arguments)
  FOREIGN-POINTER (requires a SIZE argument)

If successful returns the type of file stored.
If parsing of even the SF3 header fails, an error is signalled.

See READ-SF3
See ARCHIVE (type)
See AUDIO (type)
See IMAGE (type)
See LOG (type)
See MODEL (type)
See PHYSICS-MODEL (type)
See TABLE (type)
See TEXT (type)
See VECTOR-GRAPHIC (type)

EXTERNAL FUNCTION

TEXTURE-TYPES

MODEL

Returns the set of textures that makes up the material.

The textures are stored in the order of the returned set.

See TEXTURES
See MODEL (type)

EXTERNAL FUNCTION

UNIX-TO-UNIVERSAL-TIME

UNIX-TIME

Convert a UNIX timestamp to a Common Lisp universal-time timestamp

EXTERNAL FUNCTION

VERTEX-ATTRIBUTES

MODEL

Returns the set of vertex attributes stored per vertex.

These sets are possible:

  (:position)
  (:position :uv)
  (:position :color)
  (:position :normal)
  (:position :uv :normal)
  (:position :color :normal)
  (:position :uv :normal :tangent)
  (:position :color :normal :tangent)

Each attribute corresponds to three float values in the vertices
array, except for :UV which corresponds to two.

See VERTEX-STRIDE
See MODEL (type)

EXTERNAL FUNCTION

VERTEX-STRIDE

MODEL

Returns the number of float values that constitute each vertex.

See VERTICES
See MODEL (type)

EXTERNAL FUNCTION

WRITE-SF3

OBJECT
STORAGE
&REST
ARGS

Write an SF3 file to the given storage.

Depending on the storage backend, additional arguments may be
necessary. The following backends are supported:

  PATHNAME
  STREAM
  OCTET-VECTOR (optionally accepts :START and :END key arguments)
  FOREIGN-POINTER (requires a SIZE argument)

If successful returns the storage.
If serialisation fails, an error is signalled.

See ARCHIVE (type)
See AUDIO (type)
See IMAGE (type)
See LOG (type)
See MODEL (type)
See PHYSICS-MODEL (type)
See TABLE (type)
See TEXT (type)
See VECTOR-GRAPHIC (type)

EXTERNAL GENERIC-FUNCTION

A

ENTRY

Accesses the alpha channel of the color.

See COLOR (type)

EXTERNAL GENERIC-FUNCTION
(SETF A)
- VALUE
- ENTRY
No documentation provided.

EXTERNAL GENERIC-FUNCTION

ADD-FILE

FILE
ARCHIVE
&KEY
MIME-TYPE
PATH
MODIFICATION-TIME

Add a new file to the archive.

Returns the modified ARCHIVE.

The FILE may be an octet-vector, string, or a pathname. In the former
two cases you must also pass the PATH keyword argument. In all cases
you may also specify the MIME-TYPE and MODIFICATION-TIME. If you do
not, they are determined automatically.

See FILES
See META-ENTRIES
See ARCHIVE (type)
See ARCHIVE-META-ENTRY (type)

EXTERNAL GENERIC-FUNCTION

ADDRESS

ENTRY

Accesses the address.

See LINK-OPTION (type)
See TARGET-OPTION (type)

EXTERNAL GENERIC-FUNCTION
(SETF ADDRESS)
- VALUE
- ENTRY
No documentation provided.

EXTERNAL GENERIC-FUNCTION

B

ENTRY

Accesses the blue component of the color.

See COLOR-OPTION (type)
See COLOR (type)

EXTERNAL GENERIC-FUNCTION
(SETF B)
- VALUE
- ENTRY
No documentation provided.

EXTERNAL GENERIC-FUNCTION

BOTTOM-RADIUS

ENTRY

Accesses the bottom radius of the shape.

See CYLINDER (type)
See PILL (type)

EXTERNAL GENERIC-FUNCTION
(SETF BOTTOM-RADIUS)
- VALUE
- ENTRY
No documentation provided.

EXTERNAL GENERIC-FUNCTION

BOUNDS

ENTRY

Accesses the bounds of the shape.

See SHAPE-BOUNDS (type)
See RECTANGLE (type)
See CIRCLE (type)

EXTERNAL GENERIC-FUNCTION
(SETF BOUNDS)
- VALUE
- ENTRY
No documentation provided.

EXTERNAL GENERIC-FUNCTION

CATEGORY

ENTRY

Access the category of the entry.

This is a string at most 255 characters long.

See LOG-ENTRY (type)

EXTERNAL GENERIC-FUNCTION
(SETF CATEGORY)
- VALUE
- ENTRY
No documentation provided.

EXTERNAL GENERIC-FUNCTION

CHANNELS

ENTRY

Accesses the channel information of the file.

For audio files, this is the channel count.
For image files, this is the pixel format identifier.

See PIXEL-TYPE
See CHANNEL-LAYOUT
See IMAGE (type)
See AUDIO (type)

EXTERNAL GENERIC-FUNCTION
(SETF CHANNELS)
- VALUE
- ENTRY
No documentation provided.

EXTERNAL GENERIC-FUNCTION

CHECKSUM

ENTRY

Access the CRC32 checksum.

See ARCHIVE-META-ENTRY (type)
See SF3-FILE-HEADER (type)

EXTERNAL GENERIC-FUNCTION
(SETF CHECKSUM)
- VALUE
- ENTRY
No documentation provided.

EXTERNAL GENERIC-FUNCTION

CHUNKS

ENTRY

Access the chunks vector of the log.

See LOG (type)
See LOG-CHUNK (type)
See LOG-APPEND-CHUNK

EXTERNAL GENERIC-FUNCTION
(SETF CHUNKS)
- VALUE
- ENTRY
No documentation provided.
EXTERNAL GENERIC-FUNCTION
COLOR
- ENTRY
No documentation provided.
EXTERNAL GENERIC-FUNCTION
(SETF COLOR)
- VALUE
- ENTRY
No documentation provided.

EXTERNAL GENERIC-FUNCTION

COLUMN-COUNT

ENTRY

Accesses the number of columns in the table.

See TABLE (type)

EXTERNAL GENERIC-FUNCTION
(SETF COLUMN-COUNT)
- VALUE
- ENTRY
No documentation provided.

EXTERNAL GENERIC-FUNCTION

COLUMN-SPECS

ENTRY

Accesses the vector of column specifications in the table.

See COLUMN-SPEC (type)
See TABLE (type)

EXTERNAL GENERIC-FUNCTION
(SETF COLUMN-SPECS)
- VALUE
- ENTRY
No documentation provided.

EXTERNAL GENERIC-FUNCTION

DATA

ENTRY

Accesses the inner data of the physics shape.

See SHAPE (type)

EXTERNAL GENERIC-FUNCTION
(SETF DATA)
- VALUE
- ENTRY
No documentation provided.

EXTERNAL GENERIC-FUNCTION

DEPTH

ENTRY

Accesses the depth of the object.

See IMAGE (type)
See ELLIPSOID (type)
See BOX (type)

EXTERNAL GENERIC-FUNCTION
(SETF DEPTH)
- VALUE
- ENTRY
No documentation provided.

EXTERNAL GENERIC-FUNCTION

END-TIME

ENTRY

Access the ending time of the log.

This is a UNIX timestamp. If the timestamp is equivalent to the most
positive 63 bit number, the end time is considered to be
"tentative" and the log file unfinished.

See UNIX-TO-UNIVERSAL-TIME
See UNIVERSAL-TO-UNIX-TIME
See LOG (type)

EXTERNAL GENERIC-FUNCTION
(SETF END-TIME)
- VALUE
- ENTRY
No documentation provided.

EXTERNAL GENERIC-FUNCTION

ENTRIES

ENTRY

Access the vector of log-entries in the chunk.

See LOG-ENTRY (type)
See LOG-CHUNK (type)

EXTERNAL GENERIC-FUNCTION
(SETF ENTRIES)
- VALUE
- ENTRY
No documentation provided.

EXTERNAL GENERIC-FUNCTION

EXTRACT-FILE

FILE
ARCHIVE
&KEY
PATH
IF-EXISTS
VERIFY
PRESERVE-MODIFICATION-TIME
&ALLOW-OTHER-KEYS

Extract a file from the archive to disk.

FILE may either be the path of the file to extract, the index of the
file, or T for all files.

If VERIFY is true, the resulting file on disk is checked against the
stored CRC-32 checksum.

If PRESERVE-MODIFICATION-TIME is true, the resulting file will have
the modification time as stored in the archive.

See FILES
See META-ENTRIES
See ARCHIVE (type)
See ARCHIVE-META-ENTRY (type)

EXTERNAL GENERIC-FUNCTION

FACES

ENTRY

Accesses the vector of vertex indices that make up the faces.

See MODEL (type)

EXTERNAL GENERIC-FUNCTION
(SETF FACES)
- VALUE
- ENTRY
No documentation provided.

EXTERNAL GENERIC-FUNCTION

FILE-EXTENSION

OBJECT

Returns the file extension to be used with the given object or format type.

See ARCHIVE (type)
See AUDIO (type)
See IMAGE (type)
See LOG (type)
See MODEL (type)
See PHYSICS-MODEL (type)
See TABLE (type)
See TEXT (type)
See VECTOR-GRAPHIC (type)

EXTERNAL GENERIC-FUNCTION

FILES

ENTRY

Access the vector of file payloads.

File payloads are stored as octet vectors.
In order to get the associated file metadata, look at the
ARCHIVE-META-ENTRY of the same index in the META-ENTRIES vector.

See ARCHIVE (type)
See META-ENTRIES

EXTERNAL GENERIC-FUNCTION
(SETF FILES)
- VALUE
- ENTRY
No documentation provided.

EXTERNAL GENERIC-FUNCTION

FILL

ENTRY

Accesses the fill description of the shape.

See SHAPE-FILL (type)
See CURVE (type)
See POLYGON (type)
See RECTANGLE (type)
See CIRCLE (type)

EXTERNAL GENERIC-FUNCTION
(SETF FILL)
- VALUE
- ENTRY
No documentation provided.

EXTERNAL GENERIC-FUNCTION

FILL-COLOR

ENTRY

Accesses the fill color of the fill specification.

See SHAPE-FILL (type)

EXTERNAL GENERIC-FUNCTION
(SETF FILL-COLOR)
- VALUE
- ENTRY
No documentation provided.

EXTERNAL GENERIC-FUNCTION

FONT

ENTRY

Accesses the font-family descriptor of the text.

See TEXT-SHAPE (type)

EXTERNAL GENERIC-FUNCTION
(SETF FONT)
- VALUE
- ENTRY
No documentation provided.

EXTERNAL GENERIC-FUNCTION

FONT-SIZE

ENTRY

Accesses the font-size of the object.

The size describes the height of a line of text from its baseline in
pixels.

See TEXT-SHAPE (type)
See SIZE-OPTION (type)

EXTERNAL GENERIC-FUNCTION
(SETF FONT-SIZE)
- VALUE
- ENTRY
No documentation provided.

EXTERNAL GENERIC-FUNCTION

G

ENTRY

Accesses the green component of the color.

See COLOR-OPTION (type)
See COLOR (type)

EXTERNAL GENERIC-FUNCTION
(SETF G)
- VALUE
- ENTRY
No documentation provided.

EXTERNAL GENERIC-FUNCTION

H

ENTRY

Accesses the HEIGHT extent of the size.

See SIZE (type)

EXTERNAL GENERIC-FUNCTION
(SETF H)
- VALUE
- ENTRY
No documentation provided.

EXTERNAL GENERIC-FUNCTION

HEIGHT

ENTRY

Accesses the height of the object.

See IMAGE (type)
See VECTOR-GRAPHIC (type)
See ELLIPSOID (type)
See BOX (type)
See SIZE (type)
See PILL (type)
See CYLINDER (type)

EXTERNAL GENERIC-FUNCTION
(SETF HEIGHT)
- VALUE
- ENTRY
No documentation provided.

EXTERNAL GENERIC-FUNCTION

INSTRUCTIONS

ENTRY

Accesses the vector of drawing instructions that make up the image.

The elements may be instances of the following types:

  LINE
  RECTANGLE
  CIRCLE
  POLYGON
  CURVE
  TEXT-SHAPE
  (ARRAY SINGLE-FLOAT (6))

See VECTOR-GRAPHIC (type)

EXTERNAL GENERIC-FUNCTION
(SETF INSTRUCTIONS)
- VALUE
- ENTRY
No documentation provided.

EXTERNAL GENERIC-FUNCTION

KIND

ENTRY

Accesses the kind of the type stored.

See COLUMN-SPEC-TYPE
See COLUMN-SPEC (type)
See SF3-FILE-HEADER (type)

EXTERNAL GENERIC-FUNCTION
(SETF KIND)
- VALUE
- ENTRY
No documentation provided.

EXTERNAL GENERIC-FUNCTION

LEVEL

ENTRY

Accesses the heading level.

See HEADING-OPTION (type)

EXTERNAL GENERIC-FUNCTION
(SETF LEVEL)
- VALUE
- ENTRY
No documentation provided.
EXTERNAL GENERIC-FUNCTION
MARKUP
- ENTRY
No documentation provided.
EXTERNAL GENERIC-FUNCTION
(SETF MARKUP)
- VALUE
- ENTRY
No documentation provided.

EXTERNAL GENERIC-FUNCTION

MASS

ENTRY

Accesses the mass of the overall physics model in Kg.

See PHYSICS-MODEL (type)

EXTERNAL GENERIC-FUNCTION
(SETF MASS)
- VALUE
- ENTRY
No documentation provided.

EXTERNAL GENERIC-FUNCTION

MESSAGE

ENTRY

Access the message of the entry.

This is mostly free-form, application-specific text about the log
event.

See LOG-ENTRY (type)

EXTERNAL GENERIC-FUNCTION
(SETF MESSAGE)
- VALUE
- ENTRY
No documentation provided.

EXTERNAL GENERIC-FUNCTION

META-ENTRIES

ENTRY

Access the vector of archive metadata entries.

The metadata entries give you information about a file's path, type,
and so on.

See ARCHIVE (type)
See ARCHIVE-META-ENTRY (type)
See FILES

EXTERNAL GENERIC-FUNCTION
(SETF META-ENTRIES)
- VALUE
- ENTRY
No documentation provided.

EXTERNAL GENERIC-FUNCTION

MIME-TYPE

OBJECT

Access the media mime-type.

You can also pass any SF3 file structure or its type to this to get
its intended mime-type back.

See ARCHIVE-META-ENTRY (type)
See ARCHIVE (type)
See AUDIO (type)
See IMAGE (type)
See LOG (type)
See MODEL (type)
See PHYSICS-MODEL (type)
See TABLE (type)
See TEXT (type)
See VECTOR-GRAPHIC (type)

EXTERNAL GENERIC-FUNCTION
(SETF MIME-TYPE)
- VALUE
- ENTRY
No documentation provided.

EXTERNAL GENERIC-FUNCTION

MODIFICATION-TIME

ENTRY

Access the modification time of the metadata entry.

The modification time is a UNIX timestamp.

See UNIX-TO-UNIVERSAL-TIME
See UNIVERSAL-TO-UNIX-TIME
See ARCHIVE-META-ENTRY (type)

EXTERNAL GENERIC-FUNCTION
(SETF MODIFICATION-TIME)
- VALUE
- ENTRY
No documentation provided.

EXTERNAL GENERIC-FUNCTION

OUTLINE-COLOR

ENTRY

Accesses the outline color of the fill specification.

See SHAPE-FILL (type)

EXTERNAL GENERIC-FUNCTION
(SETF OUTLINE-COLOR)
- VALUE
- ENTRY
No documentation provided.

EXTERNAL GENERIC-FUNCTION

OUTLINE-THICKNESS

ENTRY

Accesses the outline thickness of the fill specification.

See SHAPE-FILL (type)

EXTERNAL GENERIC-FUNCTION
(SETF OUTLINE-THICKNESS)
- VALUE
- ENTRY
No documentation provided.

EXTERNAL GENERIC-FUNCTION

PATH

ENTRY

Access the path of the file.

This is a string describing a relative UNIX namestring for the related
file.

See ARCHIVE-META-ENTRY (type)

EXTERNAL GENERIC-FUNCTION
(SETF PATH)
- VALUE
- ENTRY
No documentation provided.

EXTERNAL GENERIC-FUNCTION

PIXEL-FORMAT

ENTRY

Accesses the format of the pixel channel elements.

This corresponds to the pixel data vector element-type.

See PIXELS
See IMAGE (type)

EXTERNAL GENERIC-FUNCTION
(SETF PIXEL-FORMAT)
- VALUE
- ENTRY
No documentation provided.

EXTERNAL GENERIC-FUNCTION

PIXELS

ENTRY

Accesses the pixel data of the image.

The vector contains the pixel data in "row-major" order, with
channel data interleaved. Meaning to access a specific channel value
the index is computed as:

  channel + PIXEL-STRIDE * (x + WIDTH * (y + HEIGHT * d))

See PIXEL-STRIDE
See WIDTH
See HEIGHT
See IMAGE (type)

EXTERNAL GENERIC-FUNCTION
(SETF PIXELS)
- VALUE
- ENTRY
No documentation provided.

EXTERNAL GENERIC-FUNCTION

POINT

ENTRY

Accesses the lower left corner point of the extent.

See SHAPE-BOUNDS (type)

EXTERNAL GENERIC-FUNCTION
(SETF POINT)
- VALUE
- ENTRY
No documentation provided.

EXTERNAL GENERIC-FUNCTION

POINTS

ENTRY

Accesses the vector of outline points of the shape.

See POLYGON (type)
See CURVE (type)
See POINT (type)

EXTERNAL GENERIC-FUNCTION
(SETF POINTS)
- VALUE
- ENTRY
No documentation provided.

EXTERNAL GENERIC-FUNCTION

R

ENTRY

Accesses the red component of the color.

See COLOR-OPTION (type)
See COLOR (type)

EXTERNAL GENERIC-FUNCTION
(SETF R)
- VALUE
- ENTRY
No documentation provided.

EXTERNAL GENERIC-FUNCTION

ROW-COUNT

ENTRY

Accesses the number of rows in the table.

See TABLE (type)

EXTERNAL GENERIC-FUNCTION
(SETF ROW-COUNT)
- VALUE
- ENTRY
No documentation provided.

EXTERNAL GENERIC-FUNCTION

ROW-DATA

ENTRY

Accesses the raw, encoded row data.

The data is encoded as an octet vector.
In order to decode data, please use the ROW and CELL functions.

See ROW
See CELL
See TABLE (type)

EXTERNAL GENERIC-FUNCTION
(SETF ROW-DATA)
- VALUE
- ENTRY
No documentation provided.

EXTERNAL GENERIC-FUNCTION

SAMPLE-FORMAT

ENTRY

Accesses the sample format type of the audio file.

May be one of:
  :SINT8
  :SINT16
  :SINT32
  :SINT64
  :UINT8
  :UINT16
  :UINT32
  :UINT64
  :FLOAT16
  :FLOAT32
  :FLOAT64

This will also correspond to the element-type of the SAMPLES array,
except for :FLOAT16, which is encoded as (unsigned-byte 16) due to
lack of support for short-floats in most implementations.

See AUDIO (type)

EXTERNAL GENERIC-FUNCTION
(SETF SAMPLE-FORMAT)
- VALUE
- ENTRY
No documentation provided.

EXTERNAL GENERIC-FUNCTION

SAMPLERATE

ENTRY

Accesses the samplerate of the audio file in Hertz.

See AUDIO (type)

EXTERNAL GENERIC-FUNCTION
(SETF SAMPLERATE)
- VALUE
- ENTRY
No documentation provided.

EXTERNAL GENERIC-FUNCTION

SAMPLES

ENTRY

Accesses the sample data of the audio file.

This is a raw PCM data vector structured as audio frames, interleaving
the channels in each frame according to the layout in CHANNEL-LAYOUT.

See AUDIO (type)

EXTERNAL GENERIC-FUNCTION
(SETF SAMPLES)
- VALUE
- ENTRY
No documentation provided.

EXTERNAL GENERIC-FUNCTION

SEVERITY

ENTRY

Accesses the severity number of the entry.

The more positive the number, the more severe, the more negative the
more detailed it is meant to be, with 0 being treated as "neutral".

See LOG-ENTRY (type)

EXTERNAL GENERIC-FUNCTION
(SETF SEVERITY)
- VALUE
- ENTRY
No documentation provided.

EXTERNAL GENERIC-FUNCTION

SHAPES

ENTRY

Accesses the vector of shapes that make up the physics model.

See SHAPE (type)
See PHYSICS-MODEL (type)

EXTERNAL GENERIC-FUNCTION
(SETF SHAPES)
- VALUE
- ENTRY
No documentation provided.

EXTERNAL GENERIC-FUNCTION

SIZE

ENTRY

Accesses the dimensions of the extent.

See SHAPE-BOUNDS (type)

EXTERNAL GENERIC-FUNCTION
(SETF SIZE)
- VALUE
- ENTRY
No documentation provided.

EXTERNAL GENERIC-FUNCTION

SOURCE

ENTRY

Access the source indicator of the entry.

This is a string at most 255 characters long.

See LOG-ENTRY (type)

EXTERNAL GENERIC-FUNCTION
(SETF SOURCE)
- VALUE
- ENTRY
No documentation provided.

EXTERNAL GENERIC-FUNCTION

START-TIME

ENTRY

Access the starting time of the log.

This is a UNIX timestamp.

See UNIX-TO-UNIVERSAL-TIME
See UNIVERSAL-TO-UNIX-TIME
See LOG (type)

EXTERNAL GENERIC-FUNCTION
(SETF START-TIME)
- VALUE
- ENTRY
No documentation provided.

EXTERNAL GENERIC-FUNCTION

TENSOR

ENTRY

Accesses the inertia tensor matrix of the physics shape.

The inertia tensor is a row-major 9-element single-float vector that
stores the 3x3 inertia tensor matrix.

See PHYSICS-MODEL (type)

EXTERNAL GENERIC-FUNCTION
(SETF TENSOR)
- VALUE
- ENTRY
No documentation provided.

EXTERNAL GENERIC-FUNCTION

TEXT

ENTRY

Accesses the string text of the element.

See TEXT (type)
See TEXT-SHAPE (type)

EXTERNAL GENERIC-FUNCTION
(SETF TEXT)
- VALUE
- ENTRY
No documentation provided.

EXTERNAL GENERIC-FUNCTION

TEXTURES

ENTRY

Accesses the vector of paths for the material's textures.

See TEXTURE-TYPES
See MODEL (type)

EXTERNAL GENERIC-FUNCTION
(SETF TEXTURES)
- VALUE
- ENTRY
No documentation provided.

EXTERNAL GENERIC-FUNCTION

THICKNESS

ENTRY

Accesses the thickness of the line.

See LINE (type)

EXTERNAL GENERIC-FUNCTION
(SETF THICKNESS)
- VALUE
- ENTRY
No documentation provided.

EXTERNAL GENERIC-FUNCTION

TIME

ENTRY

Accesses the time at which the entry was created.

This is a UNIX timestamp.

See UNIX-TO-UNIVERSAL-TIME
See UNIVERSAL-TO-UNIX-TIME
See LOG-ENTRY (type)

EXTERNAL GENERIC-FUNCTION
(SETF TIME)
- VALUE
- ENTRY
No documentation provided.

EXTERNAL GENERIC-FUNCTION

TOP-RADIUS

ENTRY

Accesses the top radius of the shape.

See CYLINDER (type)
See PILL (type)

EXTERNAL GENERIC-FUNCTION
(SETF TOP-RADIUS)
- VALUE
- ENTRY
No documentation provided.

EXTERNAL GENERIC-FUNCTION

TRANSFORM

ENTRY

Accesses the transform matrix of the shape.

The transform matrix is a row-major 16-element single-float vector
that stores the 4x4 affine transformation matrix to position the shape
relative to origin of the entire model.

See SHAPE (type)
See PHYSICS-MODEL (type)

EXTERNAL GENERIC-FUNCTION
(SETF TRANSFORM)
- VALUE
- ENTRY
No documentation provided.

EXTERNAL GENERIC-FUNCTION

VERTICES

ENTRY

Access the vector of vertex attribute data.

In the case of a MESH this is only position data.

See VERTEX-ATTRIBUTES
See VERTEX-STRIDE
See MODEL (type)
See MESH (type)

EXTERNAL GENERIC-FUNCTION
(SETF VERTICES)
- VALUE
- ENTRY
No documentation provided.

EXTERNAL GENERIC-FUNCTION

W

ENTRY

Accesses the WIDTH extent of the size.

See SIZE (type)

EXTERNAL GENERIC-FUNCTION
(SETF W)
- VALUE
- ENTRY
No documentation provided.

EXTERNAL GENERIC-FUNCTION

WIDTH

ENTRY

Accesses the width of the object.

See IMAGE (type)
See VECTOR-GRAPHIC (type)
See ELLIPSOID (type)
See BOX (type)
See SIZE (type)

EXTERNAL GENERIC-FUNCTION
(SETF WIDTH)
- VALUE
- ENTRY
No documentation provided.

EXTERNAL GENERIC-FUNCTION

X

ENTRY

Accesses the X position of the point.

See POINT (type)

EXTERNAL GENERIC-FUNCTION
(SETF X)
- VALUE
- ENTRY
No documentation provided.

EXTERNAL GENERIC-FUNCTION

Y

ENTRY

Accesses the Y position of the point.

See POINT (type)

EXTERNAL GENERIC-FUNCTION
(SETF Y)
- VALUE
- ENTRY
No documentation provided.