The cl-sf3 Reference Manual

3.1.1 cl-sf3/cl-sf3.asd

Source

cl-sf3.asd.

Parent Component

cl-sf3 (system).

ASDF Systems

• cl-sf3.
• cl-sf3/archive.
• cl-sf3/core.
• 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.

---

3.1.2 cl-sf3/archive/archive.lisp

Source

cl-sf3.asd.

Parent Component

cl-sf3/archive (system).

Public Interface

• add-file (method).
• add-file (method).
• add-file (method).
• archive (structure).
• archive-meta-entry (structure).
• checksum (method).
• (setf checksum) (method).
• extract-file (method).
• extract-file (method).
• extract-file (method).
• files (method).
• (setf files) (method).
• make-archive (function).
• make-archive-meta-entry (function).
• meta-entries (method).
• (setf meta-entries) (method).
• mime-type (method).
• (setf mime-type) (method).
• modification-time (method).
• (setf modification-time) (method).
• octet-size (method).
• octet-size (method).
• path (method).
• (setf path) (method).
• print-object (method).
• print-object (method).

Internals

• %add-file (function).
• %make-archive (function).
• archive-count (reader).
• (setf archive-count) (writer).
• archive-file-offsets (reader).
• (setf archive-file-offsets) (writer).
• archive-files (reader).
• (setf archive-files) (writer).
• archive-meta-entries (reader).
• (setf archive-meta-entries) (writer).
• archive-meta-entry-checksum (reader).
• (setf archive-meta-entry-checksum) (writer).
• archive-meta-entry-mime-type (reader).
• (setf archive-meta-entry-mime-type) (writer).
• archive-meta-entry-modification-time (reader).
• (setf archive-meta-entry-modification-time) (writer).
• archive-meta-entry-p (function).
• archive-meta-entry-path (reader).
• (setf archive-meta-entry-path) (writer).
• archive-meta-offsets (reader).
• (setf archive-meta-offsets) (writer).
• archive-meta-size (reader).
• (setf archive-meta-size) (writer).
• archive-p (function).
• copy-archive (function).
• copy-archive-meta-entry (function).
• read-archive (function).
• read-archive-meta-entry (function).
• read-io-octet-vector-archive (function).
• read-io-octet-vector-archive-meta-entry (function).
• read-io-stream-archive (function).
• read-io-stream-archive-meta-entry (function).
• write-archive (function).
• write-archive-meta-entry (function).
• write-io-octet-vector-archive (function).
• write-io-octet-vector-archive-meta-entry (function).
• write-io-stream-archive (function).
• write-io-stream-archive-meta-entry (function).

---

3.1.3 cl-sf3/core/package.lisp

Source

cl-sf3.asd.

Parent Component

cl-sf3/core (system).

Packages

org.shirakumo.sf3.

---

3.1.4 cl-sf3/core/toolkit.lisp

Dependency

package.lisp (file).

Source

cl-sf3.asd.

Parent Component

cl-sf3/core (system).

Public Interface

• universal-to-unix-time (function).
• unix-to-universal-time (function).

Internals

• +crc32/table+ (constant).
• crc32 (function).
• crc32-rotate (function).
• define-accessor (macro).
• define-accessors (macro).
• define-delegates (macro).
• define-print-method (macro).
• format-time (function).
• generate-crc32-table (function).
• lisp-type->bs-type (function).
• set-equal (function).

---

3.1.5 cl-sf3/core/sf3.lisp

Dependency

toolkit.lisp (file).

Source

cl-sf3.asd.

Parent Component

cl-sf3/core (system).

Public Interface

• checksum (method).
• (setf checksum) (method).
• file-extension (generic function).
• kind (method).
• (setf kind) (method).
• make-sf3-file-header (function).
• mime-type (generic function).
• octet-size (method).
• print-object (method).
• read-sf3 (function).
• sf3-file-header (structure).
• tell-sf3 (function).
• write-sf3 (function).

Internals

• %make-sf3-file-header (function).
• copy-sf3-file-header (function).
• read-io-octet-vector-sf3-file-header (function).
• read-io-stream-sf3-file-header (function).
• read-sf3-file-header (function).
• sf3-file-header-checksum (reader).
• (setf sf3-file-header-checksum) (writer).
• sf3-file-header-kind (reader).
• (setf sf3-file-header-kind) (writer).
• sf3-file-header-p (function).
• write-io-octet-vector-sf3-file-header (function).
• write-io-stream-sf3-file-header (function).
• write-sf3-file-header (function).

---

3.1.6 cl-sf3/core/documentation.lisp

Dependency

sf3.lisp (file).

Source

cl-sf3.asd.

Parent Component

cl-sf3/core (system).

---

3.1.7 cl-sf3/audio/audio.lisp

Source

cl-sf3.asd.

Parent Component

cl-sf3/audio (system).

Public Interface

• audio (structure).
• channels (method).
• (setf channels) (method).
• duration (function).
• make-audio (function).
• octet-size (method).
• print-object (method).
• sample-format (method).
• (setf sample-format) (method).
• samplerate (method).
• (setf samplerate) (method).
• samples (method).
• (setf samples) (method).

Internals

• %make-audio (function).
• audio-channels (reader).
• (setf audio-channels) (writer).
• audio-frame-count (reader).
• (setf audio-frame-count) (writer).
• audio-p (function).
• audio-sample-count (function).
• audio-sample-format (reader).
• (setf audio-sample-format) (writer).
• audio-samplerate (reader).
• (setf audio-samplerate) (writer).
• audio-samples (reader).
• (setf audio-samples) (writer).
• channel-layout (function).
• copy-audio (function).
• read-audio (function).
• read-io-octet-vector-audio (function).
• read-io-stream-audio (function).
• write-audio (function).
• write-io-octet-vector-audio (function).
• write-io-stream-audio (function).

---

3.1.8 cl-sf3/image/image.lisp

Source

cl-sf3.asd.

Parent Component

cl-sf3/image (system).

Public Interface

• channels (method).
• (setf channels) (method).
• depth (method).
• (setf depth) (method).
• height (method).
• (setf height) (method).
• image (structure).
• make-image (function).
• octet-size (method).
• pixel-format (method).
• (setf pixel-format) (method).
• pixel-stride (function).
• pixel-type (function).
• pixels (method).
• (setf pixels) (method).
• print-object (method).
• width (method).
• (setf width) (method).

Internals

• %make-image (function).
• copy-image (function).
• image-channels (reader).
• (setf image-channels) (writer).
• image-depth (reader).
• (setf image-depth) (writer).
• image-height (reader).
• (setf image-height) (writer).
• image-p (function).
• image-pixel-count (function).
• image-pixel-format (reader).
• (setf image-pixel-format) (writer).
• image-pixels (reader).
• (setf image-pixels) (writer).
• image-width (reader).
• (setf image-width) (writer).
• read-image (function).
• read-io-octet-vector-image (function).
• read-io-stream-image (function).
• write-image (function).
• write-io-octet-vector-image (function).
• write-io-stream-image (function).

---

3.1.9 cl-sf3/log/log.lisp

Source

cl-sf3.asd.

Parent Component

cl-sf3/log (system).

Public Interface

• category (method).
• (setf category) (method).
• chunks (method).
• (setf chunks) (method).
• end-time (method).
• (setf end-time) (method).
• entries (method).
• (setf entries) (method).
• log (function).
• log (structure).
• log-append-chunk (function).
• log-append-entry-extend (function).
• log-chunk (structure).
• log-entry (structure).
• make-log (function).
• make-log-chunk (function).
• make-log-entry (function).
• message (method).
• (setf message) (method).
• octet-size (method).
• octet-size (method).
• octet-size (method).
• print-object (method).
• print-object (method).
• print-object (method).
• severity (method).
• (setf severity) (method).
• size (method).
• size (method).
• (setf size) (method).
• (setf size) (method).
• source (method).
• (setf source) (method).
• start-time (method).
• (setf start-time) (method).
• time (method).
• (setf time) (method).

Internals

• %make-log (function).
• %make-log-chunk (function).
• %make-log-entry (function).
• copy-log (function).
• copy-log-chunk (function).
• copy-log-entry (function).
• log-chunk-append-entry (function).
• log-chunk-capacity (function).
• log-chunk-entries (reader).
• (setf log-chunk-entries) (writer).
• log-chunk-entry-count (reader).
• (setf log-chunk-entry-count) (writer).
• log-chunk-entry-offsets (reader).
• (setf log-chunk-entry-offsets) (writer).
• log-chunk-p (function).
• log-chunk-remaining (function).
• log-chunk-size (reader).
• (setf log-chunk-size) (writer).
• log-chunks (reader).
• (setf log-chunks) (writer).
• log-end-time (reader).
• (setf log-end-time) (writer).
• log-entry-category (reader).
• (setf log-entry-category) (writer).
• log-entry-message (reader).
• (setf log-entry-message) (writer).
• log-entry-p (function).
• log-entry-severity (reader).
• (setf log-entry-severity) (writer).
• log-entry-size (reader).
• (setf log-entry-size) (writer).
• log-entry-source (reader).
• (setf log-entry-source) (writer).
• log-entry-time (reader).
• (setf log-entry-time) (writer).
• log-p (function).
• log-start-time (reader).
• (setf log-start-time) (writer).
• read-io-octet-vector-log (function).
• read-io-octet-vector-log-chunk (function).
• read-io-octet-vector-log-entry (function).
• read-io-stream-log (function).
• read-io-stream-log-chunk (function).
• read-io-stream-log-entry (function).
• read-log (function).
• read-log-chunk (function).
• read-log-entry (function).
• write-io-octet-vector-log (function).
• write-io-octet-vector-log-chunk (function).
• write-io-octet-vector-log-entry (function).
• write-io-stream-log (function).
• write-io-stream-log-chunk (function).
• write-io-stream-log-entry (function).
• write-log (function).
• write-log-chunk (function).
• write-log-entry (function).

---

3.1.10 cl-sf3/model/model.lisp

Source

cl-sf3.asd.

Parent Component

cl-sf3/model (system).

Public Interface

• faces (method).
• (setf faces) (method).
• make-model (function).
• model (structure).
• octet-size (method).
• print-object (method).
• texture-types (function).
• textures (method).
• (setf textures) (method).
• vertex-attributes (function).
• vertex-stride (function).
• vertices (method).
• (setf vertices) (method).

Internals

• %make-model (function).
• copy-model (function).
• model-faces (reader).
• (setf model-faces) (writer).
• model-format (reader).
• (setf model-format) (writer).
• model-material-size (reader).
• (setf model-material-size) (writer).
• model-material-type (reader).
• (setf model-material-type) (writer).
• model-p (function).
• model-textures (reader).
• (setf model-textures) (writer).
• model-vertices (reader).
• (setf model-vertices) (writer).
• read-io-octet-vector-model (function).
• read-io-stream-model (function).
• read-model (function).
• write-io-octet-vector-model (function).
• write-io-stream-model (function).
• write-model (function).

---

3.1.11 cl-sf3/physics-model/physics-model.lisp

Source

cl-sf3.asd.

Parent Component

cl-sf3/physics-model (system).

Public Interface

• bottom-radius (method).
• bottom-radius (method).
• bottom-radius (method).
• (setf bottom-radius) (method).
• (setf bottom-radius) (method).
• (setf bottom-radius) (method).
• box (structure).
• cylinder (structure).
• data (method).
• (setf data) (method).
• depth (method).
• depth (method).
• depth (method).
• (setf depth) (method).
• (setf depth) (method).
• (setf depth) (method).
• ellipsoid (structure).
• height (method).
• height (method).
• height (method).
• height (method).
• height (method).
• (setf height) (method).
• (setf height) (method).
• (setf height) (method).
• (setf height) (method).
• (setf height) (method).
• make-box (function).
• make-cylinder (function).
• make-ellipsoid (function).
• make-mesh (function).
• make-physics-model (function).
• make-pill (function).
• make-shape (function).
• mass (method).
• (setf mass) (method).
• mesh (structure).
• octet-size (method).
• octet-size (method).
• octet-size (method).
• octet-size (method).
• octet-size (method).
• octet-size (method).
• octet-size (method).
• physics-model (structure).
• pill (structure).
• print-object (method).
• print-object (method).
• print-object (method).
• print-object (method).
• print-object (method).
• print-object (method).
• print-object (method).
• shape (structure).
• shapes (method).
• (setf shapes) (method).
• tensor (method).
• (setf tensor) (method).
• top-radius (method).
• top-radius (method).
• top-radius (method).
• (setf top-radius) (method).
• (setf top-radius) (method).
• (setf top-radius) (method).
• transform (method).
• (setf transform) (method).
• vertices (method).
• vertices (method).
• (setf vertices) (method).
• (setf vertices) (method).
• width (method).
• width (method).
• width (method).
• (setf width) (method).
• (setf width) (method).
• (setf width) (method).

Internals

• %make-box (function).
• %make-cylinder (function).
• %make-ellipsoid (function).
• %make-mesh (function).
• %make-physics-model (function).
• %make-pill (function).
• *identity* (special variable).
• box-depth (reader).
• (setf box-depth) (writer).
• box-height (reader).
• (setf box-height) (writer).
• box-p (function).
• box-width (reader).
• (setf box-width) (writer).
• copy-box (function).
• copy-cylinder (function).
• copy-ellipsoid (function).
• copy-mesh (function).
• copy-physics-model (function).
• copy-pill (function).
• copy-shape (function).
• cylinder-bottom-radius (reader).
• (setf cylinder-bottom-radius) (writer).
• cylinder-height (reader).
• (setf cylinder-height) (writer).
• cylinder-p (function).
• cylinder-top-radius (reader).
• (setf cylinder-top-radius) (writer).
• ellipsoid-depth (reader).
• (setf ellipsoid-depth) (writer).
• ellipsoid-height (reader).
• (setf ellipsoid-height) (writer).
• ellipsoid-p (function).
• ellipsoid-width (reader).
• (setf ellipsoid-width) (writer).
• mesh-p (function).
• mesh-vertex-count (reader).
• (setf mesh-vertex-count) (writer).
• mesh-vertices (reader).
• (setf mesh-vertices) (writer).
• physics-model-mass (reader).
• (setf physics-model-mass) (writer).
• physics-model-p (function).
• physics-model-shapes (reader).
• (setf physics-model-shapes) (writer).
• physics-model-tensor (reader).
• (setf physics-model-tensor) (writer).
• pill-bottom-radius (reader).
• (setf pill-bottom-radius) (writer).
• pill-height (reader).
• (setf pill-height) (writer).
• pill-p (function).
• pill-top-radius (reader).
• (setf pill-top-radius) (writer).
• read-box (function).
• read-cylinder (function).
• read-ellipsoid (function).
• read-io-octet-vector-box (function).
• read-io-octet-vector-cylinder (function).
• read-io-octet-vector-ellipsoid (function).
• read-io-octet-vector-mesh (function).
• read-io-octet-vector-physics-model (function).
• read-io-octet-vector-pill (function).
• read-io-octet-vector-shape (function).
• read-io-stream-box (function).
• read-io-stream-cylinder (function).
• read-io-stream-ellipsoid (function).
• read-io-stream-mesh (function).
• read-io-stream-physics-model (function).
• read-io-stream-pill (function).
• read-io-stream-shape (function).
• read-mesh (function).
• read-physics-model (function).
• read-pill (function).
• read-shape (function).
• shape-data (reader).
• (setf shape-data) (writer).
• shape-p (function).
• shape-transform (reader).
• (setf shape-transform) (writer).
• write-box (function).
• write-cylinder (function).
• write-ellipsoid (function).
• write-io-octet-vector-box (function).
• write-io-octet-vector-cylinder (function).
• write-io-octet-vector-ellipsoid (function).
• write-io-octet-vector-mesh (function).
• write-io-octet-vector-physics-model (function).
• write-io-octet-vector-pill (function).
• write-io-octet-vector-shape (function).
• write-io-stream-box (function).
• write-io-stream-cylinder (function).
• write-io-stream-ellipsoid (function).
• write-io-stream-mesh (function).
• write-io-stream-physics-model (function).
• write-io-stream-pill (function).
• write-io-stream-shape (function).
• write-mesh (function).
• write-physics-model (function).
• write-pill (function).
• write-shape (function).

---

3.1.12 cl-sf3/table/table.lisp

Source

cl-sf3.asd.

Parent Component

cl-sf3/table (system).

Public Interface

• cell (function).
• (setf cell) (function).
• column-count (method).
• (setf column-count) (method).
• column-spec (structure).
• column-spec-element-count (function).
• column-spec-element-size (function).
• column-spec-type (function).
• column-specs (method).
• (setf column-specs) (method).
• kind (method).
• (setf kind) (method).
• make-column-spec (function).
• make-table (function).
• octet-size (method).
• octet-size (method).
• print-object (method).
• print-object (method).
• row (function).
• row-count (method).
• (setf row-count) (method).
• row-data (method).
• (setf row-data) (method).
• size (method).
• (setf size) (method).
• table (structure).

Internals

• %make-column-spec (function).
• %make-table (function).
• column-spec-kind (reader).
• (setf column-spec-kind) (writer).
• column-spec-length (reader).
• (setf column-spec-length) (writer).
• column-spec-name (reader).
• (setf column-spec-name) (writer).
• column-spec-p (function).
• column-spec-reader (function).
• column-spec-writer (function).
• copy-column-spec (function).
• copy-table (function).
• high-resolution-timestamp (function).
• (setf high-resolution-timestamp) (function).
• name (method).
• (setf name) (method).
• read-column-spec (function).
• read-io-octet-vector-column-spec (function).
• read-io-octet-vector-table (function).
• read-io-stream-column-spec (function).
• read-io-stream-table (function).
• read-table (function).
• table-column-count (reader).
• (setf table-column-count) (writer).
• table-column-specs (reader).
• (setf table-column-specs) (writer).
• table-p (function).
• table-row-count (reader).
• (setf table-row-count) (writer).
• table-row-data (reader).
• (setf table-row-data) (writer).
• table-row-length (reader).
• (setf table-row-length) (writer).
• table-spec-length (reader).
• (setf table-spec-length) (writer).
• type->column-spec-kind (function).
• write-column-spec (function).
• write-io-octet-vector-column-spec (function).
• write-io-octet-vector-table (function).
• write-io-stream-column-spec (function).
• write-io-stream-table (function).
• write-table (function).

---

3.1.13 cl-sf3/text/text.lisp

Source

cl-sf3.asd.

Parent Component

cl-sf3/text (system).

Public Interface

• address (method).
• address (method).
• address (method).
• (setf address) (method).
• (setf address) (method).
• (setf address) (method).
• b (method).
• b (method).
• (setf b) (method).
• (setf b) (method).
• color-option (structure).
• font (method).
• (setf font) (method).
• font-option (structure).
• font-size (method).
• (setf font-size) (method).
• g (method).
• g (method).
• (setf g) (method).
• (setf g) (method).
• heading-option (structure).
• level (method).
• level (method).
• (setf level) (method).
• (setf level) (method).
• link-option (structure).
• make-color-option (function).
• make-font-option (function).
• make-heading-option (function).
• make-link-option (function).
• make-markup (function).
• make-size-option (function).
• make-target-option (function).
• make-text (function).
• markup (method).
• (setf markup) (method).
• markup (structure).
• octet-size (method).
• octet-size (method).
• octet-size (method).
• octet-size (method).
• octet-size (method).
• octet-size (method).
• octet-size (method).
• octet-size (method).
• print-object (method).
• print-object (method).
• print-object (method).
• print-object (method).
• print-object (method).
• print-object (method).
• print-object (method).
• r (method).
• r (method).
• (setf r) (method).
• (setf r) (method).
• size (method).
• (setf size) (method).
• size-option (structure).
• target-option (structure).
• text (method).
• (setf text) (method).
• text (structure).

Internals

• %make-color-option (function).
• %make-font-option (function).
• %make-heading-option (function).
• %make-link-option (function).
• %make-markup (function).
• %make-size-option (function).
• %make-target-option (function).
• %make-text (function).
• color-option-b (reader).
• (setf color-option-b) (writer).
• color-option-g (reader).
• (setf color-option-g) (writer).
• color-option-p (function).
• color-option-r (reader).
• (setf color-option-r) (writer).
• copy-color-option (function).
• copy-font-option (function).
• copy-heading-option (function).
• copy-link-option (function).
• copy-markup (function).
• copy-size-option (function).
• copy-target-option (function).
• copy-text (function).
• end (method).
• (setf end) (method).
• font-family (method).
• (setf font-family) (method).
• font-option-font-family (reader).
• (setf font-option-font-family) (writer).
• font-option-p (function).
• heading-option-level (reader).
• (setf heading-option-level) (writer).
• heading-option-p (function).
• link-option-address (reader).
• (setf link-option-address) (writer).
• link-option-p (function).
• markup-end (reader).
• (setf markup-end) (writer).
• markup-option (reader).
• (setf markup-option) (writer).
• markup-p (function).
• markup-start (reader).
• (setf markup-start) (writer).
• option (method).
• (setf option) (method).
• read-color-option (function).
• read-font-option (function).
• read-heading-option (function).
• read-io-octet-vector-color-option (function).
• read-io-octet-vector-font-option (function).
• read-io-octet-vector-heading-option (function).
• read-io-octet-vector-link-option (function).
• read-io-octet-vector-markup (function).
• read-io-octet-vector-size-option (function).
• read-io-octet-vector-target-option (function).
• read-io-octet-vector-text (function).
• read-io-stream-color-option (function).
• read-io-stream-font-option (function).
• read-io-stream-heading-option (function).
• read-io-stream-link-option (function).
• read-io-stream-markup (function).
• read-io-stream-size-option (function).
• read-io-stream-target-option (function).
• read-io-stream-text (function).
• read-link-option (function).
• read-markup (function).
• read-size-option (function).
• read-target-option (function).
• read-text (function).
• size-option-font-size (reader).
• (setf size-option-font-size) (writer).
• size-option-p (function).
• start (method).
• (setf start) (method).
• target-option-address (reader).
• (setf target-option-address) (writer).
• target-option-p (function).
• text-markup-options (reader).
• (setf text-markup-options) (writer).
• text-markup-size (reader).
• (setf text-markup-size) (writer).
• text-p (function).
• text-text (reader).
• (setf text-text) (writer).
• write-color-option (function).
• write-font-option (function).
• write-heading-option (function).
• write-io-octet-vector-color-option (function).
• write-io-octet-vector-font-option (function).
• write-io-octet-vector-heading-option (function).
• write-io-octet-vector-link-option (function).
• write-io-octet-vector-markup (function).
• write-io-octet-vector-size-option (function).
• write-io-octet-vector-target-option (function).
• write-io-octet-vector-text (function).
• write-io-stream-color-option (function).
• write-io-stream-font-option (function).
• write-io-stream-heading-option (function).
• write-io-stream-link-option (function).
• write-io-stream-markup (function).
• write-io-stream-size-option (function).
• write-io-stream-target-option (function).
• write-io-stream-text (function).
• write-link-option (function).
• write-markup (function).
• write-size-option (function).
• write-target-option (function).
• write-text (function).

---

3.1.14 cl-sf3/vector-graphic/vector-graphic.lisp

Source

cl-sf3.asd.

Parent Component

cl-sf3/vector-graphic (system).

Public Interface

• a (method).
• (setf a) (method).
• b (method).
• (setf b) (method).
• bounds (method).
• bounds (method).
• (setf bounds) (method).
• (setf bounds) (method).
• circle (structure).
• color (method).
• color (method).
• (setf color) (method).
• (setf color) (method).
• color (structure).
• curve (structure).
• fill (method).
• fill (method).
• fill (method).
• fill (method).
• (setf fill) (method).
• (setf fill) (method).
• (setf fill) (method).
• (setf fill) (method).
• fill-color (method).
• (setf fill-color) (method).
• font (method).
• (setf font) (method).
• font-size (method).
• (setf font-size) (method).
• g (method).
• (setf g) (method).
• h (method).
• (setf h) (method).
• height (method).
• height (method).
• (setf height) (method).
• (setf height) (method).
• instructions (method).
• (setf instructions) (method).
• line (structure).
• make-circle (function).
• make-color (function).
• make-curve (function).
• make-line (function).
• make-point (function).
• make-polygon (function).
• make-rectangle (function).
• make-shape-bounds (function).
• make-shape-fill (function).
• make-size (function).
• make-text-shape (function).
• make-vector-graphic (function).
• octet-size (method).
• octet-size (method).
• octet-size (method).
• octet-size (method).
• octet-size (method).
• octet-size (method).
• octet-size (method).
• octet-size (method).
• octet-size (method).
• octet-size (method).
• octet-size (method).
• octet-size (method).
• outline-color (method).
• (setf outline-color) (method).
• outline-thickness (method).
• (setf outline-thickness) (method).
• point (method).
• point (method).
• (setf point) (method).
• (setf point) (method).
• point (structure).
• points (method).
• points (method).
• points (method).
• (setf points) (method).
• (setf points) (method).
• (setf points) (method).
• polygon (structure).
• print-object (method).
• print-object (method).
• print-object (method).
• print-object (method).
• print-object (method).
• print-object (method).
• print-object (method).
• print-object (method).
• print-object (method).
• print-object (method).
• r (method).
• (setf r) (method).
• rectangle (structure).
• shape-bounds (structure).
• shape-fill (structure).
• size (method).
• (setf size) (method).
• size (structure).
• text (method).
• (setf text) (method).
• text-shape (structure).
• thickness (method).
• (setf thickness) (method).
• vector-graphic (structure).
• w (method).
• (setf w) (method).
• width (method).
• width (method).
• (setf width) (method).
• (setf width) (method).
• x (method).
• (setf x) (method).
• y (method).
• (setf y) (method).

Internals

• %make-circle (function).
• %make-color (function).
• %make-curve (function).
• %make-line (function).
• %make-point (function).
• %make-polygon (function).
• %make-rectangle (function).
• %make-shape-bounds (function).
• %make-shape-fill (function).
• %make-size (function).
• %make-text-shape (function).
• %make-vector-graphic (function).
• circle-bounds (reader).
• (setf circle-bounds) (writer).
• circle-fill (reader).
• (setf circle-fill) (writer).
• circle-p (function).
• color-a (reader).
• (setf color-a) (writer).
• color-b (reader).
• (setf color-b) (writer).
• color-g (reader).
• (setf color-g) (writer).
• color-p (function).
• color-r (reader).
• (setf color-r) (writer).
• copy-circle (function).
• copy-color (function).
• copy-curve (function).
• copy-line (function).
• copy-point (function).
• copy-polygon (function).
• copy-rectangle (function).
• copy-shape-bounds (function).
• copy-shape-fill (function).
• copy-size (function).
• copy-text-shape (function).
• copy-vector-graphic (function).
• curve-fill (reader).
• (setf curve-fill) (writer).
• curve-p (function).
• curve-points (reader).
• (setf curve-points) (writer).
• line-color (reader).
• (setf line-color) (writer).
• line-p (function).
• line-points (reader).
• (setf line-points) (writer).
• line-thickness (reader).
• (setf line-thickness) (writer).
• point-p (function).
• point-x (reader).
• (setf point-x) (writer).
• point-y (reader).
• (setf point-y) (writer).
• polygon-fill (reader).
• (setf polygon-fill) (writer).
• polygon-p (function).
• polygon-points (reader).
• (setf polygon-points) (writer).
• read-circle (function).
• read-color (function).
• read-curve (function).
• read-io-octet-vector-circle (function).
• read-io-octet-vector-color (function).
• read-io-octet-vector-curve (function).
• read-io-octet-vector-line (function).
• read-io-octet-vector-point (function).
• read-io-octet-vector-polygon (function).
• read-io-octet-vector-rectangle (function).
• read-io-octet-vector-shape-bounds (function).
• read-io-octet-vector-shape-fill (function).
• read-io-octet-vector-size (function).
• read-io-octet-vector-text-shape (function).
• read-io-octet-vector-vector-graphic (function).
• read-io-stream-circle (function).
• read-io-stream-color (function).
• read-io-stream-curve (function).
• read-io-stream-line (function).
• read-io-stream-point (function).
• read-io-stream-polygon (function).
• read-io-stream-rectangle (function).
• read-io-stream-shape-bounds (function).
• read-io-stream-shape-fill (function).
• read-io-stream-size (function).
• read-io-stream-text-shape (function).
• read-io-stream-vector-graphic (function).
• read-line (function).
• read-point (function).
• read-polygon (function).
• read-rectangle (function).
• read-shape-bounds (function).
• read-shape-fill (function).
• read-size (function).
• read-text-shape (function).
• read-vector-graphic (function).
• rectangle-bounds (reader).
• (setf rectangle-bounds) (writer).
• rectangle-fill (reader).
• (setf rectangle-fill) (writer).
• rectangle-p (function).
• shape-bounds-p (function).
• shape-bounds-point (reader).
• (setf shape-bounds-point) (writer).
• shape-bounds-size (reader).
• (setf shape-bounds-size) (writer).
• shape-fill-fill-color (reader).
• (setf shape-fill-fill-color) (writer).
• shape-fill-outline-color (reader).
• (setf shape-fill-outline-color) (writer).
• shape-fill-outline-thickness (reader).
• (setf shape-fill-outline-thickness) (writer).
• shape-fill-p (function).
• size-h (reader).
• (setf size-h) (writer).
• size-p (function).
• size-w (reader).
• (setf size-w) (writer).
• text-shape-color (reader).
• (setf text-shape-color) (writer).
• text-shape-font (reader).
• (setf text-shape-font) (writer).
• text-shape-font-size (reader).
• (setf text-shape-font-size) (writer).
• text-shape-p (function).
• text-shape-point (reader).
• (setf text-shape-point) (writer).
• text-shape-text (reader).
• (setf text-shape-text) (writer).
• vector-graphic-height (reader).
• (setf vector-graphic-height) (writer).
• vector-graphic-instructions (reader).
• (setf vector-graphic-instructions) (writer).
• vector-graphic-p (function).
• vector-graphic-width (reader).
• (setf vector-graphic-width) (writer).
• write-circle (function).
• write-color (function).
• write-curve (function).
• write-io-octet-vector-circle (function).
• write-io-octet-vector-color (function).
• write-io-octet-vector-curve (function).
• write-io-octet-vector-line (function).
• write-io-octet-vector-point (function).
• write-io-octet-vector-polygon (function).
• write-io-octet-vector-rectangle (function).
• write-io-octet-vector-shape-bounds (function).
• write-io-octet-vector-shape-fill (function).
• write-io-octet-vector-size (function).
• write-io-octet-vector-text-shape (function).
• write-io-octet-vector-vector-graphic (function).
• write-io-stream-circle (function).
• write-io-stream-color (function).
• write-io-stream-curve (function).
• write-io-stream-line (function).
• write-io-stream-point (function).
• write-io-stream-polygon (function).
• write-io-stream-rectangle (function).
• write-io-stream-shape-bounds (function).
• write-io-stream-shape-fill (function).
• write-io-stream-size (function).
• write-io-stream-text-shape (function).
• write-io-stream-vector-graphic (function).
• write-line (function).
• write-point (function).
• write-polygon (function).
• write-rectangle (function).
• write-shape-bounds (function).
• write-shape-fill (function).
• write-size (function).
• write-text-shape (function).
• write-vector-graphic (function).

---

5.1.1 Ordinary functions

Function: cell (table row column) ¶

Package

org.shirakumo.sf3.

Source

table.lisp.

Function: (setf cell) (table row column) ¶

Package

org.shirakumo.sf3.

Source

table.lisp.

Function: column-spec-element-count (spec) ¶

Package

org.shirakumo.sf3.

Source

table.lisp.

Function: column-spec-element-size (spec) ¶

Package

org.shirakumo.sf3.

Source

table.lisp.

Function: column-spec-type (spec) ¶

Package

org.shirakumo.sf3.

Source

table.lisp.

Function: duration (audio) ¶

Package

org.shirakumo.sf3.

Source

audio.lisp.

Function: log (log message &rest entry-args &key time &allow-other-keys) ¶

Package

org.shirakumo.sf3.

Source

log.lisp.

Function: log-append-chunk (log &rest args) ¶

Package

org.shirakumo.sf3.

Source

log.lisp.

Function: log-append-entry-extend (log entry &rest args) ¶

Package

org.shirakumo.sf3.

Source

log.lisp.

Function: make-archive (files) ¶

Package

org.shirakumo.sf3.

Source

archive.lisp.

Function: make-archive-meta-entry (&key modification-time checksum mime-type path) ¶

Package

org.shirakumo.sf3.

Source

archive.lisp.

Function: make-audio (samples &key samplerate channels) ¶

Package

org.shirakumo.sf3.

Source

audio.lisp.

Function: make-box (w h d &key transform) ¶

Package

org.shirakumo.sf3.

Source

physics-model.lisp.

Function: make-circle (x y w h &rest fill-args) ¶

Package

org.shirakumo.sf3.

Source

vector-graphic.lisp.

Function: make-color (r g b &optional a) ¶

Package

org.shirakumo.sf3.

Source

vector-graphic.lisp.

Function: make-color-option (start end &optional r g b) ¶

Package

org.shirakumo.sf3.

Source

text.lisp.

Function: make-column-spec (name &optional type length) ¶

Package

org.shirakumo.sf3.

Source

table.lisp.

Function: make-curve (points &rest fill-args) ¶

Package

org.shirakumo.sf3.

Source

vector-graphic.lisp.

Function: make-cylinder (bottom-radius top-radius height &key transform) ¶

Package

org.shirakumo.sf3.

Source

physics-model.lisp.

Function: make-ellipsoid (w h d &key transform) ¶

Package

org.shirakumo.sf3.

Source

physics-model.lisp.

Function: make-font-option (font) ¶

Package

org.shirakumo.sf3.

Source

text.lisp.

Function: make-heading-option (level) ¶

Package

org.shirakumo.sf3.

Source

text.lisp.

Function: make-image (pixels width height &key depth pixel-type) ¶

Package

org.shirakumo.sf3.

Source

image.lisp.

Function: make-line (points &key thickness color) ¶

Package

org.shirakumo.sf3.

Source

vector-graphic.lisp.

Function: make-link-option (address) ¶

Package

org.shirakumo.sf3.

Source

text.lisp.

Function: make-log (&key start-time end-time entries) ¶

Package

org.shirakumo.sf3.

Source

log.lisp.

Function: make-log-chunk (&key entries) ¶

Package

org.shirakumo.sf3.

Source

log.lisp.

Function: make-log-entry (message &key time severity source category) ¶

Package

org.shirakumo.sf3.

Source

log.lisp.

Function: make-markup (start end option) ¶

Package

org.shirakumo.sf3.

Source

text.lisp.

Function: make-mesh (vertices &key transform) ¶

Package

org.shirakumo.sf3.

Source

physics-model.lisp.

Function: make-model (faces vertices &key vertex-attributes material) ¶

Package

org.shirakumo.sf3.

Source

model.lisp.

Function: make-physics-model (mass tensor &rest shapes) ¶

Package

org.shirakumo.sf3.

Source

physics-model.lisp.

Function: make-pill (bottom-radius top-radius height &key transform) ¶

Package

org.shirakumo.sf3.

Source

physics-model.lisp.

Function: make-point (x y) ¶

Package

org.shirakumo.sf3.

Source

vector-graphic.lisp.

Function: make-polygon (points &rest fill-args) ¶

Package

org.shirakumo.sf3.

Source

vector-graphic.lisp.

Function: make-rectangle (x y w h &rest fill-args) ¶

Package

org.shirakumo.sf3.

Source

vector-graphic.lisp.

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)

Package

org.shirakumo.sf3.

Source

sf3.lisp.

Function: make-shape (&key transform data) ¶

Package

org.shirakumo.sf3.

Source

physics-model.lisp.

Function: make-shape-bounds (x y w h) ¶

Package

org.shirakumo.sf3.

Source

vector-graphic.lisp.

Function: make-shape-fill (&key fill-color outline-color outline-thickness) ¶

Package

org.shirakumo.sf3.

Source

vector-graphic.lisp.

Function: make-size (w h) ¶

Package

org.shirakumo.sf3.

Source

vector-graphic.lisp.

Function: make-size-option (font-size) ¶

Package

org.shirakumo.sf3.

Source

text.lisp.

Function: make-table (columns data) ¶

Package

org.shirakumo.sf3.

Source

table.lisp.

Function: make-target-option (address) ¶

Package

org.shirakumo.sf3.

Source

text.lisp.

Function: make-text (text &rest markup) ¶

Package

org.shirakumo.sf3.

Source

text.lisp.

Function: make-text-shape (x y text &key color font font-size) ¶

Package

org.shirakumo.sf3.

Source

vector-graphic.lisp.

Function: make-vector-graphic (width height instructions) ¶

Package

org.shirakumo.sf3.

Source

vector-graphic.lisp.

Function: pixel-stride (image) ¶

Package

org.shirakumo.sf3.

Source

image.lisp.

Function: pixel-type (image) ¶

Package

org.shirakumo.sf3.

Source

image.lisp.

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)

Package

org.shirakumo.sf3.

Source

sf3.lisp.

Function: row (table row) ¶

Package

org.shirakumo.sf3.

Source

table.lisp.

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)

Package

org.shirakumo.sf3.

Source

sf3.lisp.

Function: texture-types (model) ¶

Package

org.shirakumo.sf3.

Source

model.lisp.

Function: universal-to-unix-time (universal-time) ¶

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

Package

org.shirakumo.sf3.

Source

toolkit.lisp.

Function: unix-to-universal-time (unix-time) ¶

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

Package

org.shirakumo.sf3.

Source

toolkit.lisp.

Function: vertex-attributes (model) ¶

Package

org.shirakumo.sf3.

Source

model.lisp.

Function: vertex-stride (model) ¶

Package

org.shirakumo.sf3.

Source

model.lisp.

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)

Package

org.shirakumo.sf3.

Source

sf3.lisp.

---