The cl-gltf Reference Manual

Table of Contents

The cl-gltf Reference Manual

This is the cl-gltf Reference Manual, version 1.0.0, generated automatically by Declt version 3.0 "Montgomery Scott" on Sun May 15 03:50:09 2022 GMT+0.

1 Introduction

## How To
For the purposes of this tutorial we'll assume the package ``org.shirakumo.fraf.gltf`` has the local nickname ``gltf``. After loading the library, you can parse a glTF or GLB file as follows:

:: common lisp
(gltf:with-gltf (gltf #p"my-model.gltf")
  (describe gltf))
::

``describe`` will emit the full structure of the parsed glTF file. From there you can use the accessors from this package to traverse the structures and convert the information as you need.

Of particular importance are the ``accessor``s, which provide a convenient way to parse out the information from the raw underlying byte buffers that they index into. An ``accessor`` is a ``sequence``, so you can simply use ``length`` and ``elt`` to traverse the data.

However, note that cl-gltf makes no assumptions about a math library or anything of the sort, so by default it will parse the data out to vectors of the respective element type (usually floats). That buffer will also be shared between ``elt`` calls to avoid excessive consing. Thus, if you are just copying the data out of the buffers to another place, this should be ideal.

However, if you would like to customise the way the data is read out, such as to convert it into other structures automatically, you can do so. Either set the ``element-reader`` function on the accessor, or provide a specialised method on the ``construct-element-reader`` function. See the respective docstrings for more info.

## To Do
The following are still left to do:

- Loading from pointers or byte arrays
- Direct support of the ratified extensions
- Writing files

2 Systems

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

2.1 cl-gltf

Maintainer

Nicolas Hafner <shinmera@tymoon.eu>

Author

Nicolas Hafner <shinmera@tymoon.eu>

Home Page

https://shirakumo.github.io/cl-gltf/

Source Control

(:git "https://github.com/shirakumo/cl-gltf.git")

Bug Tracker

https://github.com/shirakumo/cl-gltf/issues

License

zlib

Description

A library to parse the glTF file format.

Version

1.0.0

Dependencies

• documentation-utils
• trivial-extensible-sequences
• mmap
• shasht
• cffi
• qbase64
• nibbles
• static-vectors

Source

cl-gltf.asd (file)

Components

• package.lisp (file)
• element.lisp (file)
• format.lisp (file)
• accessor.lisp (file)
• parser.lisp (file)
• documentation.lisp (file)

3 Files

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

3.1 Lisp

3.1.1 cl-gltf.asd

Location

cl-gltf.asd

Systems

cl-gltf (system)

3.1.2 cl-gltf/package.lisp

Parent

cl-gltf (system)

Location

package.lisp

Packages

org.shirakumo.fraf.gltf

3.1.3 cl-gltf/element.lisp

Dependency

package.lisp (file)

Parent

cl-gltf (system)

Location

element.lisp

Internal Definitions

• *describe-indent* (special variable)
• define-element (macro)
• describe-slot (function)
• initargs (generic function)
• initargs (method)
• normalize-slotdef (function)
• removef (function)
• to-json-name (function)

3.1.4 cl-gltf/format.lisp

Dependency

element.lisp (file)

Parent

cl-gltf (system)

Location

format.lisp

Exported Definitions

• accessors (method)
• (setf accessors) (method)
• albedo (method)
• (setf albedo) (method)
• albedo-factor (method)
• (setf albedo-factor) (method)
• alpha-cutoff (method)
• (setf alpha-cutoff) (method)
• alpha-mode (method)
• (setf alpha-mode) (method)
• animation (class)
• animation-channel (class)
• animation-channel-target (class)
• animation-sampler (class)
• animations (method)
• (setf animations) (method)
• aspect-ratio (method)
• (setf aspect-ratio) (method)
• asset (method)
• (setf asset) (method)
• asset (class)
• attributes (method)
• (setf attributes) (method)
• buffer-view (method)
• (setf buffer-view) (method)
• buffer-views (method)
• (setf buffer-views) (method)
• buffers (method)
• (setf buffers) (method)
• camera (method)
• (setf camera) (method)
• camera (class)
• cameras (method)
• (setf cameras) (method)
• channels (method)
• (setf channels) (method)
• children (method)
• (setf children) (method)
• copyright (method)
• (setf copyright) (method)
• double-sided-p (method)
• (setf double-sided-p) (method)
• emissive-factor (method)
• (setf emissive-factor) (method)
• emissive-texture (method)
• (setf emissive-texture) (method)
• extensions (method)
• (setf extensions) (method)
• extras (method)
• (setf extras) (method)
• fov (method)
• (setf fov) (method)
• generator (method)
• (setf generator) (method)
• gltf (method)
• gltf (class)
• gltf-element (class)
• idx (method)
• (setf idx) (method)
• image (class)
• images (method)
• (setf images) (method)
• indexed-element (class)
• indices (method)
• (setf indices) (method)
• input (method)
• (setf input) (method)
• interpolation (method)
• (setf interpolation) (method)
• inverse-bind-matrices (method)
• (setf inverse-bind-matrices) (method)
• joints (method)
• (setf joints) (method)
• mag-filter (method)
• (setf mag-filter) (method)
• material (method)
• (setf material) (method)
• material (class)
• materials (method)
• (setf materials) (method)
• matrix (method)
• (setf matrix) (method)
• mesh (method)
• (setf mesh) (method)
• mesh (class)
• mesh-primitive (class)
• meshes (method)
• (setf meshes) (method)
• metallic-factor (method)
• (setf metallic-factor) (method)
• mime-type (method)
• (setf mime-type) (method)
• min-filter (method)
• (setf min-filter) (method)
• min-version (method)
• (setf min-version) (method)
• mode (method)
• (setf mode) (method)
• name (method)
• (setf name) (method)
• named-element (class)
• node (method)
• (setf node) (method)
• node (class)
• nodes (method)
• (setf nodes) (method)
• nodes (method)
• (setf nodes) (method)
• normal-texture (method)
• (setf normal-texture) (method)
• occlusion-texture (method)
• (setf occlusion-texture) (method)
• orthographic-camera (class)
• output (method)
• (setf output) (method)
• parent (method)
• (setf parent) (method)
• path (method)
• path (method)
• (setf path) (method)
• pbr (method)
• (setf pbr) (method)
• pbr (class)
• perspective-camera (class)
• primitives (method)
• (setf primitives) (method)
• rotation (method)
• (setf rotation) (method)
• roughness-factor (method)
• (setf roughness-factor) (method)
• sampler (method)
• (setf sampler) (method)
• sampler (method)
• (setf sampler) (method)
• sampler (class)
• samplers (method)
• (setf samplers) (method)
• samplers (method)
• (setf samplers) (method)
• scale (method)
• (setf scale) (method)
• scale (method)
• (setf scale) (method)
• scene (class)
• scenes (method)
• (setf scenes) (method)
• skeleton (method)
• (setf skeleton) (method)
• skin (method)
• (setf skin) (method)
• skin (class)
• skins (method)
• (setf skins) (method)
• source (method)
• (setf source) (method)
• strength (method)
• (setf strength) (method)
• target (method)
• (setf target) (method)
• targets (method)
• (setf targets) (method)
• tex-coord (method)
• (setf tex-coord) (method)
• texture (method)
• (setf texture) (method)
• texture (class)
• texture-info (class)
• textures (method)
• (setf textures) (method)
• translation (method)
• (setf translation) (method)
• uri (method)
• (setf uri) (method)
• uri (method)
• (setf uri) (method)
• uri-element (class)
• version (method)
• (setf version) (method)
• weights (method)
• (setf weights) (method)
• weights (method)
• (setf weights) (method)
• wrap-s (method)
• (setf wrap-s) (method)
• wrap-t (method)
• (setf wrap-t) (method)
• xmag (method)
• (setf xmag) (method)
• ymag (method)
• (setf ymag) (method)
• zfar (method)
• (setf zfar) (method)
• zfar (method)
• (setf zfar) (method)
• znear (method)
• (setf znear) (method)
• znear (method)
• (setf znear) (method)

Internal Definitions

• initargs (method)
• initargs (method)
• initargs (method)
• initargs (method)
• initargs (method)
• initargs (method)
• initargs (method)
• initargs (method)
• initargs (method)
• initargs (method)
• initargs (method)
• initargs (method)
• initargs (method)
• initargs (method)
• initargs (method)
• initargs (method)
• initargs (method)
• initargs (method)
• initargs (method)
• initargs (method)
• initargs (method)
• initargs (method)
• initargs (method)
• initargs (method)
• matallic-roughness (method)
• (setf matallic-roughness) (method)

3.1.5 cl-gltf/accessor.lisp

Dependency

format.lisp (file)

Parent

cl-gltf (system)

Location

accessor.lisp

Exported Definitions

• accessor (class)
• buffer (method)
• (setf buffer) (method)
• buffer (method)
• buffer (class)
• buffer-view (method)
• (setf buffer-view) (method)
• buffer-view (class)
• byte-length (method)
• (setf byte-length) (method)
• byte-length (method)
• (setf byte-length) (method)
• byte-offset (method)
• (setf byte-offset) (method)
• byte-offset (method)
• (setf byte-offset) (method)
• byte-stride (method)
• byte-stride (method)
• (setf byte-stride) (method)
• component-type (method)
• (setf component-type) (method)
• construct-element-reader (method)
• construct-element-reader (method)
• construct-element-writer (method)
• construct-element-writer (method)
• element-reader (generic function)
• element-reader (method)
• element-reader (method)
• element-reader (method)
• element-reader (method)
• element-reader (method)
• element-reader (method)
• element-reader (method)
• element-reader (method)
• element-reader (method)
• element-reader (method)
• element-reader (method)
• element-reader (method)
• (setf element-reader) (method)
• element-type (method)
• (setf element-type) (method)
• element-writer (generic function)
• element-writer (method)
• element-writer (method)
• element-writer (method)
• element-writer (method)
• element-writer (method)
• element-writer (method)
• element-writer (method)
• element-writer (method)
• element-writer (method)
• element-writer (method)
• element-writer (method)
• element-writer (method)
• (setf element-writer) (method)
• maximum (method)
• (setf maximum) (method)
• minimum (method)
• (setf minimum) (method)
• normalized (method)
• (setf normalized) (method)
• size (method)
• (setf size) (method)
• start (method)
• start (method)
• start (method)
• target (method)
• (setf target) (method)

Internal Definitions

• define-element-accessor (macro)
• element-byte-stride (generic function)
• element-byte-stride (method)
• element-byte-stride (method)
• element-byte-stride (method)
• element-byte-stride (method)
• element-byte-stride (method)
• element-byte-stride (method)
• element-byte-stride (method)
• element-byte-stride (method)
• element-byte-stride (method)
• element-byte-stride (method)
• element-byte-stride (method)
• element-count (generic function)
• element-count (method)
• element-count (method)
• element-count (method)
• element-count (method)
• element-count (method)
• element-count (method)
• element-count (method)
• element-count (method)
• initargs (method)
• initargs (method)
• initargs (method)
• lisp-element-type (generic function)
• lisp-element-type (method)
• lisp-element-type (method)
• lisp-element-type (method)
• lisp-element-type (method)
• lisp-element-type (method)
• lisp-element-type (method)
• lisp-element-type (method)
• lisp-element-type (method)
• lisp-element-type (method)
• lisp-element-type (method)
• lisp-element-type (method)
• mmap (method)
• mmap-buffer (class)
• normalize-type (generic function)
• normalize-type (method)
• normalize-type (method)
• normalize-type (method)
• normalize-type (method)
• normalize-type (method)
• normalize-type (method)
• normalize-type (method)
• normalize-type (method)
• normalize-type (method)
• normalize-type (method)
• normalize-type (method)
• sparse-accessor (class)
• static-buffer (class)
• uri-buffer (class)

3.1.6 cl-gltf/parser.lisp

Dependency

accessor.lisp (file)

Parent

cl-gltf (system)

Location

parser.lisp

Exported Definitions

• parse (function)
• with-gltf (macro)

Internal Definitions

• parse-from (generic function)
• parse-from (method)
• parse-from (method)
• parse-from (method)
• parse-from (method)
• parse-from (method)
• parse-from (method)
• parse-from (method)
• parse-from (method)
• parse-from (method)
• parse-from (method)
• parse-from (method)
• parse-from (method)
• parse-from (method)
• parse-from (method)
• parse-glb-stream (function)
• resolve (method)
• resolve (method)
• resolve (method)

3.1.7 cl-gltf/documentation.lisp

Dependency

parser.lisp (file)

Parent

cl-gltf (system)

Location

documentation.lisp

4 Packages

Packages are listed by definition order.

4.1 org.shirakumo.fraf.gltf

Source

package.lisp (file)

Use List

common-lisp

Exported Definitions

• accessor (class)
• accessors (generic function)
• accessors (method)
• (setf accessors) (method)
• (setf accessors) (generic function)
• albedo (generic function)
• albedo (method)
• (setf albedo) (method)
• (setf albedo) (generic function)
• albedo-factor (generic function)
• albedo-factor (method)
• (setf albedo-factor) (method)
• (setf albedo-factor) (generic function)
• alpha-cutoff (generic function)
• alpha-cutoff (method)
• (setf alpha-cutoff) (method)
• (setf alpha-cutoff) (generic function)
• alpha-mode (generic function)
• alpha-mode (method)
• (setf alpha-mode) (method)
• (setf alpha-mode) (generic function)
• animation (class)
• animation-channel (class)
• animation-channel-target (class)
• animation-sampler (class)
• animations (generic function)
• animations (method)
• (setf animations) (method)
• (setf animations) (generic function)
• aspect-ratio (generic function)
• aspect-ratio (method)
• (setf aspect-ratio) (method)
• (setf aspect-ratio) (generic function)
• asset (generic function)
• asset (method)
• (setf asset) (method)
• (setf asset) (generic function)
• asset (class)
• attributes (generic function)
• attributes (method)
• (setf attributes) (method)
• (setf attributes) (generic function)
• buffer (generic function)
• buffer (method)
• (setf buffer) (method)
• buffer (method)
• (setf buffer) (generic function)
• buffer (class)
• buffer-view (generic function)
• buffer-view (method)
• (setf buffer-view) (method)
• buffer-view (method)
• (setf buffer-view) (method)
• (setf buffer-view) (generic function)
• buffer-view (class)
• buffer-views (generic function)
• buffer-views (method)
• (setf buffer-views) (method)
• (setf buffer-views) (generic function)
• buffers (generic function)
• buffers (method)
• (setf buffers) (method)
• (setf buffers) (generic function)
• byte-length (generic function)
• byte-length (method)
• (setf byte-length) (method)
• byte-length (method)
• (setf byte-length) (method)
• (setf byte-length) (generic function)
• byte-offset (generic function)
• byte-offset (method)
• (setf byte-offset) (method)
• byte-offset (method)
• (setf byte-offset) (method)
• (setf byte-offset) (generic function)
• byte-stride (generic function)
• byte-stride (method)
• byte-stride (method)
• (setf byte-stride) (method)
• (setf byte-stride) (generic function)
• camera (generic function)
• camera (method)
• (setf camera) (method)
• (setf camera) (generic function)
• camera (class)
• cameras (generic function)
• cameras (method)
• (setf cameras) (method)
• (setf cameras) (generic function)
• channels (generic function)
• channels (method)
• (setf channels) (method)
• (setf channels) (generic function)
• children (generic function)
• children (method)
• (setf children) (method)
• (setf children) (generic function)
• component-type (generic function)
• component-type (method)
• (setf component-type) (method)
• (setf component-type) (generic function)
• construct-element-reader (generic function)
• construct-element-reader (method)
• construct-element-reader (method)
• construct-element-writer (generic function)
• construct-element-writer (method)
• construct-element-writer (method)
• copyright (generic function)
• copyright (method)
• (setf copyright) (method)
• (setf copyright) (generic function)
• double-sided-p (generic function)
• double-sided-p (method)
• (setf double-sided-p) (method)
• (setf double-sided-p) (generic function)
• element-reader (generic function)
• element-reader (method)
• element-reader (method)
• element-reader (method)
• element-reader (method)
• element-reader (method)
• element-reader (method)
• element-reader (method)
• element-reader (method)
• element-reader (method)
• element-reader (method)
• element-reader (method)
• element-reader (method)
• (setf element-reader) (generic function)
• (setf element-reader) (method)
• element-type (generic function)
• element-type (method)
• (setf element-type) (method)
• (setf element-type) (generic function)
• element-writer (generic function)
• element-writer (method)
• element-writer (method)
• element-writer (method)
• element-writer (method)
• element-writer (method)
• element-writer (method)
• element-writer (method)
• element-writer (method)
• element-writer (method)
• element-writer (method)
• element-writer (method)
• element-writer (method)
• (setf element-writer) (generic function)
• (setf element-writer) (method)
• emissive-factor (generic function)
• emissive-factor (method)
• (setf emissive-factor) (method)
• (setf emissive-factor) (generic function)
• emissive-texture (generic function)
• emissive-texture (method)
• (setf emissive-texture) (method)
• (setf emissive-texture) (generic function)
• extensions (generic function)
• extensions (method)
• (setf extensions) (method)
• (setf extensions) (generic function)
• extras (generic function)
• extras (method)
• (setf extras) (method)
• (setf extras) (generic function)
• fov (generic function)
• fov (method)
• (setf fov) (method)
• (setf fov) (generic function)
• generator (generic function)
• generator (method)
• (setf generator) (method)
• (setf generator) (generic function)
• gltf (generic function)
• gltf (method)
• gltf (class)
• gltf-element (class)
• idx (generic function)
• idx (method)
• (setf idx) (method)
• (setf idx) (generic function)
• image (class)
• images (generic function)
• images (method)
• (setf images) (method)
• (setf images) (generic function)
• indexed-element (class)
• indices (generic function)
• indices (method)
• (setf indices) (method)
• (setf indices) (generic function)
• input (generic function)
• input (method)
• (setf input) (method)
• (setf input) (generic function)
• interpolation (generic function)
• interpolation (method)
• (setf interpolation) (method)
• (setf interpolation) (generic function)
• inverse-bind-matrices (generic function)
• inverse-bind-matrices (method)
• (setf inverse-bind-matrices) (method)
• (setf inverse-bind-matrices) (generic function)
• joints (generic function)
• joints (method)
• (setf joints) (method)
• (setf joints) (generic function)
• mag-filter (generic function)
• mag-filter (method)
• (setf mag-filter) (method)
• (setf mag-filter) (generic function)
• material (generic function)
• material (method)
• (setf material) (method)
• (setf material) (generic function)
• material (class)
• materials (generic function)
• materials (method)
• (setf materials) (method)
• (setf materials) (generic function)
• matrix (generic function)
• matrix (method)
• (setf matrix) (method)
• (setf matrix) (generic function)
• maximum (generic function)
• maximum (method)
• (setf maximum) (method)
• (setf maximum) (generic function)
• mesh (generic function)
• mesh (method)
• (setf mesh) (method)
• (setf mesh) (generic function)
• mesh (class)
• mesh-primitive (class)
• meshes (generic function)
• meshes (method)
• (setf meshes) (method)
• (setf meshes) (generic function)
• metallic-factor (generic function)
• metallic-factor (method)
• (setf metallic-factor) (method)
• (setf metallic-factor) (generic function)
• mime-type (generic function)
• mime-type (method)
• (setf mime-type) (method)
• (setf mime-type) (generic function)
• min-filter (generic function)
• min-filter (method)
• (setf min-filter) (method)
• (setf min-filter) (generic function)
• min-version (generic function)
• min-version (method)
• (setf min-version) (method)
• (setf min-version) (generic function)
• minimum (generic function)
• minimum (method)
• (setf minimum) (method)
• (setf minimum) (generic function)
• mode (generic function)
• mode (method)
• (setf mode) (method)
• (setf mode) (generic function)
• name (generic function)
• name (method)
• (setf name) (method)
• (setf name) (generic function)
• named-element (class)
• node (generic function)
• node (method)
• (setf node) (method)
• (setf node) (generic function)
• node (class)
• nodes (generic function)
• nodes (method)
• (setf nodes) (method)
• nodes (method)
• (setf nodes) (method)
• (setf nodes) (generic function)
• normal-texture (generic function)
• normal-texture (method)
• (setf normal-texture) (method)
• (setf normal-texture) (generic function)
• normalized (generic function)
• normalized (method)
• (setf normalized) (method)
• (setf normalized) (generic function)
• occlusion-texture (generic function)
• occlusion-texture (method)
• (setf occlusion-texture) (method)
• (setf occlusion-texture) (generic function)
• orthographic-camera (class)
• output (generic function)
• output (method)
• (setf output) (method)
• (setf output) (generic function)
• parent (generic function)
• parent (method)
• (setf parent) (method)
• (setf parent) (generic function)
• parse (function)
• path (generic function)
• path (method)
• path (method)
• (setf path) (generic function)
• (setf path) (method)
• pbr (generic function)
• pbr (method)
• (setf pbr) (method)
• (setf pbr) (generic function)
• pbr (class)
• perspective-camera (class)
• primitives (generic function)
• primitives (method)
• (setf primitives) (method)
• (setf primitives) (generic function)
• rotation (generic function)
• rotation (method)
• (setf rotation) (method)
• (setf rotation) (generic function)
• roughness-factor (generic function)
• roughness-factor (method)
• (setf roughness-factor) (method)
• (setf roughness-factor) (generic function)
• sampler (generic function)
• sampler (method)
• (setf sampler) (method)
• sampler (method)
• (setf sampler) (method)
• (setf sampler) (generic function)
• sampler (class)
• samplers (generic function)
• samplers (method)
• (setf samplers) (method)
• samplers (method)
• (setf samplers) (method)
• (setf samplers) (generic function)
• scale (generic function)
• scale (method)
• (setf scale) (method)
• scale (method)
• (setf scale) (method)
• (setf scale) (generic function)
• scene (class)
• scenes (generic function)
• scenes (method)
• (setf scenes) (method)
• (setf scenes) (generic function)
• size (generic function)
• size (method)
• (setf size) (method)
• (setf size) (generic function)
• skeleton (generic function)
• skeleton (method)
• (setf skeleton) (method)
• (setf skeleton) (generic function)
• skin (generic function)
• skin (method)
• (setf skin) (method)
• (setf skin) (generic function)
• skin (class)
• skins (generic function)
• skins (method)
• (setf skins) (method)
• (setf skins) (generic function)
• source (generic function)
• source (method)
• (setf source) (method)
• (setf source) (generic function)
• start (generic function)
• start (method)
• start (method)
• start (method)
• strength (generic function)
• strength (method)
• (setf strength) (method)
• (setf strength) (generic function)
• target (generic function)
• target (method)
• (setf target) (method)
• target (method)
• (setf target) (method)
• (setf target) (generic function)
• targets (generic function)
• targets (method)
• (setf targets) (method)
• (setf targets) (generic function)
• tex-coord (generic function)
• tex-coord (method)
• (setf tex-coord) (method)
• (setf tex-coord) (generic function)
• texture (generic function)
• texture (method)
• (setf texture) (method)
• (setf texture) (generic function)
• texture (class)
• texture-info (class)
• textures (generic function)
• textures (method)
• (setf textures) (method)
• (setf textures) (generic function)
• translation (generic function)
• translation (method)
• (setf translation) (method)
• (setf translation) (generic function)
• uri (generic function)
• uri (method)
• (setf uri) (method)
• uri (method)
• (setf uri) (method)
• (setf uri) (generic function)
• uri-element (class)
• version (generic function)
• version (method)
• (setf version) (method)
• (setf version) (generic function)
• weights (generic function)
• weights (method)
• (setf weights) (method)
• weights (method)
• (setf weights) (method)
• (setf weights) (generic function)
• with-gltf (macro)
• wrap-s (generic function)
• wrap-s (method)
• (setf wrap-s) (method)
• (setf wrap-s) (generic function)
• wrap-t (generic function)
• wrap-t (method)
• (setf wrap-t) (method)
• (setf wrap-t) (generic function)
• xmag (generic function)
• xmag (method)
• (setf xmag) (method)
• (setf xmag) (generic function)
• ymag (generic function)
• ymag (method)
• (setf ymag) (method)
• (setf ymag) (generic function)
• zfar (generic function)
• zfar (method)
• (setf zfar) (method)
• zfar (method)
• (setf zfar) (method)
• (setf zfar) (generic function)
• znear (generic function)
• znear (method)
• (setf znear) (method)
• znear (method)
• (setf znear) (method)
• (setf znear) (generic function)

Internal Definitions

• *describe-indent* (special variable)
• define-element (macro)
• define-element-accessor (macro)
• describe-slot (function)
• element-byte-stride (generic function)
• element-byte-stride (method)
• element-byte-stride (method)
• element-byte-stride (method)
• element-byte-stride (method)
• element-byte-stride (method)
• element-byte-stride (method)
• element-byte-stride (method)
• element-byte-stride (method)
• element-byte-stride (method)
• element-byte-stride (method)
• element-byte-stride (method)
• element-count (generic function)
• element-count (method)
• element-count (method)
• element-count (method)
• element-count (method)
• element-count (method)
• element-count (method)
• element-count (method)
• element-count (method)
• initargs (generic function)
• initargs (method)
• initargs (method)
• initargs (method)
• initargs (method)
• initargs (method)
• initargs (method)
• initargs (method)
• initargs (method)
• initargs (method)
• initargs (method)
• initargs (method)
• initargs (method)
• initargs (method)
• initargs (method)
• initargs (method)
• initargs (method)
• initargs (method)
• initargs (method)
• initargs (method)
• initargs (method)
• initargs (method)
• initargs (method)
• initargs (method)
• initargs (method)
• initargs (method)
• initargs (method)
• initargs (method)
• initargs (method)
• lisp-element-type (generic function)
• lisp-element-type (method)
• lisp-element-type (method)
• lisp-element-type (method)
• lisp-element-type (method)
• lisp-element-type (method)
• lisp-element-type (method)
• lisp-element-type (method)
• lisp-element-type (method)
• lisp-element-type (method)
• lisp-element-type (method)
• lisp-element-type (method)
• matallic-roughness (generic function)
• matallic-roughness (method)
• (setf matallic-roughness) (method)
• (setf matallic-roughness) (generic function)
• mmap (generic function)
• mmap (method)
• mmap-buffer (class)
• normalize-slotdef (function)
• normalize-type (generic function)
• normalize-type (method)
• normalize-type (method)
• normalize-type (method)
• normalize-type (method)
• normalize-type (method)
• normalize-type (method)
• normalize-type (method)
• normalize-type (method)
• normalize-type (method)
• normalize-type (method)
• normalize-type (method)
• parse-from (generic function)
• parse-from (method)
• parse-from (method)
• parse-from (method)
• parse-from (method)
• parse-from (method)
• parse-from (method)
• parse-from (method)
• parse-from (method)
• parse-from (method)
• parse-from (method)
• parse-from (method)
• parse-from (method)
• parse-from (method)
• parse-from (method)
• parse-glb-stream (function)
• removef (function)
• resolve (generic function)
• resolve (method)
• resolve (method)
• resolve (method)
• sparse-accessor (class)
• static-buffer (class)
• to-json-name (function)
• uri-buffer (class)

5 Definitions

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

5.1 Exported definitions

5.1.1 Macros

Macro: with-gltf (GLTF FILE) &body BODY

Parses a glTF file and handles cleanup safely.

GLTF must be a variable to which the GLTF instance is bound within the execution of BODY. It is **not** safe to let the GLTF instance escape from the body.

See PARSE
See GLTF (type)

Package

org.shirakumo.fraf.gltf

Source

parser.lisp (file)

5.1.2 Functions

Function: parse FILE

Parses a glTF file and returns the constructed GLTF instance.

This function can parse glTF files in both textual glTF format with external buffers, glTF format with embedded buffers, and GLB binary format from files, strings, and streams.

Note: you **must** call CLOSE on the glTF file or its individual buffers when you are done with the file. Failing to do so will cause file descriptors or other resources to stay allocated indefinitely. It is therefore strongly recommended that you use WITH-GLTF to handle the resource cleanup safely.

Consequently, any access to BUFFERs, BUFFER-VIEWs, or ACCESSORs after CLOSE has been called on the GLTF instance or the respective underlying buffer leads to undefined behaviour. DON’T DO IT.

See WITH-GLTF
See GLTF (type)

Package

org.shirakumo.fraf.gltf

Source

parser.lisp (file)

5.1.3 Generic functions

Generic Function: accessors OBJECT

Accesses the array of accessor objects.

See ACCESSOR
See GLTF

Package

org.shirakumo.fraf.gltf

Writer

(setf accessors) (generic function)

Methods

Method: accessors (GLTF gltf)

automatically generated reader method

Source

format.lisp (file)

Generic Function: (setf accessors) NEW-VALUE OBJECT

Package

org.shirakumo.fraf.gltf

Reader

accessors (generic function)

Methods

Method: (setf accessors) NEW-VALUE (GLTF gltf)

automatically generated writer method

Source

format.lisp (file)

Generic Function: albedo OBJECT

Accesses the texture-info for the albedo channel of the material.

See TEXTURE-INFO
See PBR

Package

org.shirakumo.fraf.gltf

Writer

(setf albedo) (generic function)

Methods

Method: albedo (PBR pbr)

automatically generated reader method

Source

format.lisp (file)

Generic Function: (setf albedo) NEW-VALUE OBJECT

Package

org.shirakumo.fraf.gltf

Reader

albedo (generic function)

Methods

Method: (setf albedo) NEW-VALUE (PBR pbr)

automatically generated writer method

Source

format.lisp (file)

Generic Function: albedo-factor OBJECT

Accesses the albedo-factor for the material.

This should be an array of four float values representing the per-channel strength factors.

See PBR

Package

org.shirakumo.fraf.gltf

Writer

(setf albedo-factor) (generic function)

Methods

Method: albedo-factor (PBR pbr)

automatically generated reader method

Source

format.lisp (file)

Generic Function: (setf albedo-factor) NEW-VALUE OBJECT

Package

org.shirakumo.fraf.gltf

Reader

albedo-factor (generic function)

Methods

Method: (setf albedo-factor) NEW-VALUE (PBR pbr)

automatically generated writer method

Source

format.lisp (file)

Generic Function: alpha-cutoff OBJECT

Accesses the alpha cutoff value when the material is in mask mode.

See MATERIAL

Package

org.shirakumo.fraf.gltf

Writer

(setf alpha-cutoff) (generic function)

Methods

Method: alpha-cutoff (MATERIAL material)

automatically generated reader method

Source

format.lisp (file)

Generic Function: (setf alpha-cutoff) NEW-VALUE OBJECT

Package

org.shirakumo.fraf.gltf

Reader

alpha-cutoff (generic function)

Methods

Method: (setf alpha-cutoff) NEW-VALUE (MATERIAL material)

automatically generated writer method

Source

format.lisp (file)

Generic Function: alpha-mode OBJECT

Accesses the alpha-blending mode of the material.

Can be one of the following:
:OPAQUE
:MASK
:BLEND

See MATERIAL

Package

org.shirakumo.fraf.gltf

Writer

(setf alpha-mode) (generic function)

Methods

Method: alpha-mode (MATERIAL material)

automatically generated reader method

Source

format.lisp (file)

Generic Function: (setf alpha-mode) NEW-VALUE OBJECT

Package

org.shirakumo.fraf.gltf

Reader

alpha-mode (generic function)

Methods

Method: (setf alpha-mode) NEW-VALUE (MATERIAL material)

automatically generated writer method

Source

format.lisp (file)

Generic Function: animations OBJECT

Accesses the array of animation objects.

See ANIMATION
See GLTF

Package

org.shirakumo.fraf.gltf

Writer

(setf animations) (generic function)

Methods

Method: animations (GLTF gltf)

automatically generated reader method

Source

format.lisp (file)

Generic Function: (setf animations) NEW-VALUE OBJECT

Package

org.shirakumo.fraf.gltf

Reader

animations (generic function)

Methods

Method: (setf animations) NEW-VALUE (GLTF gltf)

automatically generated writer method

Source

format.lisp (file)

Generic Function: aspect-ratio OBJECT

Accesses the view aspect ratio of the camera.

See PERSPECTIVE-CAMERA

Package

org.shirakumo.fraf.gltf

Writer

(setf aspect-ratio) (generic function)

Methods

Method: aspect-ratio (PERSPECTIVE-CAMERA perspective-camera)

automatically generated reader method

Source

format.lisp (file)

Generic Function: (setf aspect-ratio) NEW-VALUE OBJECT

Package

org.shirakumo.fraf.gltf

Reader

aspect-ratio (generic function)

Methods

Method: (setf aspect-ratio) NEW-VALUE (PERSPECTIVE-CAMERA perspective-camera)

automatically generated writer method

Source

format.lisp (file)

Generic Function: asset OBJECT

Accesses the asset object.

See ASSET
See GLTF

Package

org.shirakumo.fraf.gltf

Writer

(setf asset) (generic function)

Methods

Method: asset (GLTF gltf)

automatically generated reader method

Source

format.lisp (file)

Generic Function: (setf asset) NEW-VALUE OBJECT

Package

org.shirakumo.fraf.gltf

Reader

asset (generic function)

Methods

Method: (setf asset) NEW-VALUE (GLTF gltf)

automatically generated writer method

Source

format.lisp (file)

Generic Function: attributes OBJECT

Accesses the hash table of mesh attributes.

The values are ACCESSORs
The keys are keywords, out of: :POSITION
:NORMAL
:TANGENT
:TEXCOORD_0 ...
:COLOR_0 ...
:JOINTS_0 ...
:WEIGHTS_0 ...

See ACCESSOR
See MESH-PRIMITIVE

Package

org.shirakumo.fraf.gltf

Writer

(setf attributes) (generic function)

Methods

Method: attributes (MESH-PRIMITIVE mesh-primitive)

automatically generated reader method

Source

format.lisp (file)

Generic Function: (setf attributes) NEW-VALUE OBJECT

Package

org.shirakumo.fraf.gltf

Reader

attributes (generic function)

Methods

Method: (setf attributes) NEW-VALUE (MESH-PRIMITIVE mesh-primitive)

automatically generated writer method

Source

format.lisp (file)

Generic Function: buffer OBJECT

Returns the buffer indexed into by the buffer-view.

See BUFFER
See BUFFER-VIEW

Package

org.shirakumo.fraf.gltf

Writer

(setf buffer) (generic function)

Methods

Method: buffer (BUFFER-VIEW buffer-view)

automatically generated reader method

Source

accessor.lisp (file)

Method: buffer (STATIC-BUFFER static-buffer)

automatically generated reader method

Source

accessor.lisp (file)

Generic Function: (setf buffer) NEW-VALUE OBJECT

Package

org.shirakumo.fraf.gltf

Reader

buffer (generic function)

Methods

Method: (setf buffer) NEW-VALUE (BUFFER-VIEW buffer-view)

automatically generated writer method

Source

accessor.lisp (file)

Generic Function: buffer-view OBJECT

Returns the buffer-view this accessor indexes into.

See ACCESSOR

Package

org.shirakumo.fraf.gltf

Writer

(setf buffer-view) (generic function)

Methods

Method: buffer-view (ACCESSOR accessor)

automatically generated reader method

Source

accessor.lisp (file)

Method: buffer-view (IMAGE image)

automatically generated reader method

Source

format.lisp (file)

Generic Function: (setf buffer-view) NEW-VALUE OBJECT

Package

org.shirakumo.fraf.gltf

Reader

buffer-view (generic function)

Methods

Method: (setf buffer-view) NEW-VALUE (ACCESSOR accessor)

automatically generated writer method

Source

accessor.lisp (file)

Method: (setf buffer-view) NEW-VALUE (IMAGE image)

automatically generated writer method

Source

format.lisp (file)

Generic Function: buffer-views OBJECT

Accesses the array of buffer-view objects.

See BUFFER-VIEW
See GLTF

Package

org.shirakumo.fraf.gltf

Writer

(setf buffer-views) (generic function)

Methods

Method: buffer-views (GLTF gltf)

automatically generated reader method

Source

format.lisp (file)

Generic Function: (setf buffer-views) NEW-VALUE OBJECT

Package

org.shirakumo.fraf.gltf

Reader

buffer-views (generic function)

Methods

Method: (setf buffer-views) NEW-VALUE (GLTF gltf)

automatically generated writer method

Source

format.lisp (file)

Generic Function: buffers OBJECT

Accesses the array of buffer objects.

See GLTF
See BUFFER

Package

org.shirakumo.fraf.gltf

Writer

(setf buffers) (generic function)

Methods

Method: buffers (GLTF gltf)

automatically generated reader method

Source

format.lisp (file)

Generic Function: (setf buffers) NEW-VALUE OBJECT

Package

org.shirakumo.fraf.gltf

Reader

buffers (generic function)

Methods

Method: (setf buffers) NEW-VALUE (GLTF gltf)

automatically generated writer method

Source

format.lisp (file)

Generic Function: byte-length OBJECT

Returns the length of the buffer in octets.

See BUFFER
See BUFFER-VIEW

Package

org.shirakumo.fraf.gltf

Writer

(setf byte-length) (generic function)

Methods

Method: byte-length (BUFFER-VIEW buffer-view)

automatically generated reader method

Source

accessor.lisp (file)

Method: byte-length (BUFFER buffer)

automatically generated reader method

Source

accessor.lisp (file)

Generic Function: (setf byte-length) NEW-VALUE OBJECT

Package

org.shirakumo.fraf.gltf

Reader

byte-length (generic function)

Methods

Method: (setf byte-length) NEW-VALUE (BUFFER-VIEW buffer-view)

automatically generated writer method

Source

accessor.lisp (file)

Method: (setf byte-length) NEW-VALUE (BUFFER buffer)

automatically generated writer method

Source

accessor.lisp (file)

Generic Function: byte-offset OBJECT

Returns the offset in octets from the start of the buffer.

See ACCESSOR
See BUFFER-VIEW

Package

org.shirakumo.fraf.gltf

Writer

(setf byte-offset) (generic function)

Methods

Method: byte-offset (ACCESSOR accessor)

automatically generated reader method

Source

accessor.lisp (file)

Method: byte-offset (BUFFER-VIEW buffer-view)

automatically generated reader method

Source

accessor.lisp (file)

Generic Function: (setf byte-offset) NEW-VALUE OBJECT

Package

org.shirakumo.fraf.gltf

Reader

byte-offset (generic function)

Methods

Method: (setf byte-offset) NEW-VALUE (ACCESSOR accessor)

automatically generated writer method

Source

accessor.lisp (file)

Method: (setf byte-offset) NEW-VALUE (BUFFER-VIEW buffer-view)

automatically generated writer method

Source

accessor.lisp (file)

Generic Function: byte-stride OBJECT

Returns the number of bytes between valid elements in the buffer.

Note that this may be NIL.

See ACCESSOR
See BUFFER-VIEW

Package

org.shirakumo.fraf.gltf

Writer

(setf byte-stride) (generic function)

Methods

Method: byte-stride (ACCESSOR accessor)

automatically generated reader method

Source

accessor.lisp (file)

Method: byte-stride (BUFFER-VIEW buffer-view)

automatically generated reader method

Source

accessor.lisp (file)

Generic Function: (setf byte-stride) NEW-VALUE OBJECT

Package

org.shirakumo.fraf.gltf

Reader

byte-stride (generic function)

Methods

Method: (setf byte-stride) NEW-VALUE (BUFFER-VIEW buffer-view)

automatically generated writer method

Source

accessor.lisp (file)

Generic Function: camera OBJECT

Accesses the camera attached to the node.

See CAMERA
See NODE

Package

org.shirakumo.fraf.gltf

Writer

(setf camera) (generic function)

Methods

Method: camera (NODE node)

automatically generated reader method

Source

format.lisp (file)

Generic Function: (setf camera) NEW-VALUE OBJECT

Package

org.shirakumo.fraf.gltf

Reader

camera (generic function)

Methods

Method: (setf camera) NEW-VALUE (NODE node)

automatically generated writer method

Source

format.lisp (file)

Generic Function: cameras OBJECT

Accesses the array of camera objects.

See CAMERA
See GLTF

Package

org.shirakumo.fraf.gltf

Writer

(setf cameras) (generic function)

Methods

Method: cameras (GLTF gltf)

automatically generated reader method

Source

format.lisp (file)

Generic Function: (setf cameras) NEW-VALUE OBJECT

Package

org.shirakumo.fraf.gltf

Reader

cameras (generic function)

Methods

Method: (setf cameras) NEW-VALUE (GLTF gltf)

automatically generated writer method

Source

format.lisp (file)

Generic Function: channels OBJECT

Accesses the array of animation-channels.

See ANIMATION-CHANNEL
See ANIMATION

Package

org.shirakumo.fraf.gltf

Writer

(setf channels) (generic function)

Methods

Method: channels (ANIMATION animation)

automatically generated reader method

Source

format.lisp (file)

Generic Function: (setf channels) NEW-VALUE OBJECT

Package

org.shirakumo.fraf.gltf

Reader

channels (generic function)

Methods

Method: (setf channels) NEW-VALUE (ANIMATION animation)

automatically generated writer method

Source

format.lisp (file)

Generic Function: children OBJECT

Accesses the array of child nodes.

See NODE

Package

org.shirakumo.fraf.gltf

Writer

(setf children) (generic function)

Methods

Method: children (NODE node)

automatically generated reader method

Source

format.lisp (file)

Generic Function: (setf children) NEW-VALUE OBJECT

Package

org.shirakumo.fraf.gltf

Reader

children (generic function)

Methods

Method: (setf children) NEW-VALUE (NODE node)

automatically generated writer method

Source

format.lisp (file)

Generic Function: component-type OBJECT

Returns the compound component type this accessor reads.

Barring extensions, this can be one of:
:SCALAR
:VEC2
:VEC3
:VEC4
:MAT2
:MAT3
:MAT4

See ACCESSOR

Package

org.shirakumo.fraf.gltf

Writer

(setf component-type) (generic function)

Methods

Method: component-type (ACCESSOR accessor)

automatically generated reader method

Source

accessor.lisp (file)

Generic Function: (setf component-type) NEW-VALUE OBJECT

Package

org.shirakumo.fraf.gltf

Reader

component-type (generic function)

Methods

Method: (setf component-type) NEW-VALUE (ACCESSOR accessor)

automatically generated writer method

Source

accessor.lisp (file)

Generic Function: construct-element-reader ELEMENT-TYPE COMPONENT-TYPE

Construct a reader function for the given element.

ELEMENT-TYPE can be (barring extensions) one of the following: :SCALAR
:VEC2
:VEC3
:VEC4
:MAT2
:MAT3
:MAT4

COMPONENT-TYPE can be (barring extensions) one of the following: :INT8
:UINT8
:INT16
:UINT16
:INT32
:UINT32
:INT64
:UINT64
:FLOAT
:DOUBLE

This function should return a function of one argument, a CFFI:FOREIGN-POINTER, and two return values: the read value at the pointer and a pointer to the memory region immediately following the read element.

See ACCESSOR (type)

Package

org.shirakumo.fraf.gltf

Methods

Method: construct-element-reader ELEMENT-TYPE COMPONENT-TYPE

Source

accessor.lisp (file)

Method: construct-element-reader (ELEMENT-TYPE (eql scalar)) COMPONENT-TYPE

Source

accessor.lisp (file)

Generic Function: construct-element-writer ELEMENT-TYPE COMPONENT-TYPE

Construct a reader function for the given element.

ELEMENT-TYPE can be (barring extensions) one of the following: :SCALAR
:VEC2
:VEC3
:VEC4
:MAT2
:MAT3
:MAT4

COMPONENT-TYPE can be (barring extensions) one of the following: :INT8
:UINT8
:INT16
:UINT16
:INT32
:UINT32
:INT64
:UINT64
:FLOAT
:DOUBLE

This function should return a function of two arguments: the value to write and a CFFI:FOREIGN-POINTER, and one return value: a pointer to the memory region immediately following the read element.

See ACCESSOR (type)

Package

org.shirakumo.fraf.gltf

Methods

Method: construct-element-writer ELEMENT-TYPE COMPONENT-TYPE

Source

accessor.lisp (file)

Method: construct-element-writer (ELEMENT-TYPE (eql scalar)) COMPONENT-TYPE

Source

accessor.lisp (file)

Generic Function: copyright OBJECT

Accesses a string noting the copyright information.

See ASSET

Package

org.shirakumo.fraf.gltf

Writer

(setf copyright) (generic function)

Methods

Method: copyright (ASSET asset)

automatically generated reader method

Source

format.lisp (file)

Generic Function: (setf copyright) NEW-VALUE OBJECT

Package

org.shirakumo.fraf.gltf

Reader

copyright (generic function)

Methods

Method: (setf copyright) NEW-VALUE (ASSET asset)

automatically generated writer method

Source

format.lisp (file)

Generic Function: double-sided-p OBJECT

Accesses whether the material should be double-sided or not.

See MATERIAL

Package

org.shirakumo.fraf.gltf

Writer

(setf double-sided-p) (generic function)

Methods

Method: double-sided-p (MATERIAL material)

automatically generated reader method

Source

format.lisp (file)

Generic Function: (setf double-sided-p) NEW-VALUE OBJECT

Package

org.shirakumo.fraf.gltf

Reader

double-sided-p (generic function)

Methods

Method: (setf double-sided-p) NEW-VALUE (MATERIAL material)

automatically generated writer method

Source

format.lisp (file)

Generic Function: element-reader ELEMENT-TYPE

Accesses the function used to read out values from the underlying buffer memory.

Unless manually set, this function is computed by calling CONSTRUCT-ELEMENT-READER using the accessor’s component-type and element-type.

See CONSTRUCT-ELEMENT-READER
See ACCESSOR

Package

org.shirakumo.fraf.gltf

Source

accessor.lisp (file)

Writer

(setf element-reader) (generic function)

Methods

Method: element-reader (ACCESSOR accessor)

automatically generated reader method

Method: element-reader (TYPE (eql double))

Method: element-reader (TYPE (eql float))

Method: element-reader (TYPE (eql uint64))

Method: element-reader (TYPE (eql int64))

Method: element-reader (TYPE (eql uint32))

Method: element-reader (TYPE (eql int32))

Method: element-reader (TYPE (eql uint16))

Method: element-reader (TYPE (eql int16))

Method: element-reader (TYPE (eql uint8))

Method: element-reader (TYPE (eql int8))

Method: element-reader (TYPE integer)

Generic Function: (setf element-reader) NEW-VALUE OBJECT

Package

org.shirakumo.fraf.gltf

Reader

element-reader (generic function)

Methods

Method: (setf element-reader) NEW-VALUE (ACCESSOR accessor)

automatically generated writer method

Source

accessor.lisp (file)

Generic Function: element-type OBJECT

Returns the underlying type of values read by the accessor for each compound value.

Barring extensions, this can be one of:
:INT8
:UINT8
:INT16
:UINT16
:INT32
:UINT32
:INT64
:UINT64
:FLOAT
:DOUBLE

See ACCESSOR

Package

org.shirakumo.fraf.gltf

Writer

(setf element-type) (generic function)

Methods

Method: element-type (ACCESSOR accessor)

automatically generated reader method

Source

accessor.lisp (file)

Generic Function: (setf element-type) NEW-VALUE OBJECT

Package

org.shirakumo.fraf.gltf

Reader

element-type (generic function)

Methods

Method: (setf element-type) NEW-VALUE (ACCESSOR accessor)

automatically generated writer method

Source

accessor.lisp (file)

Generic Function: element-writer ELEMENT-TYPE

Accesses the function used to write values to the underlying buffer memory.

Unless manually set, this function is computed by calling CONSTRUCT-ELEMENT-WRITER using the accessor’s component-type and element-type.

See CONSTRUCT-ELEMENT-WRITER
See ACCESSOR

Package

org.shirakumo.fraf.gltf

Source

accessor.lisp (file)

Writer

(setf element-writer) (generic function)

Methods

Method: element-writer (ACCESSOR accessor)

automatically generated reader method

Method: element-writer (TYPE (eql double))

Method: element-writer (TYPE (eql float))

Method: element-writer (TYPE (eql uint64))

Method: element-writer (TYPE (eql int64))

Method: element-writer (TYPE (eql uint32))

Method: element-writer (TYPE (eql int32))

Method: element-writer (TYPE (eql uint16))

Method: element-writer (TYPE (eql int16))

Method: element-writer (TYPE (eql uint8))

Method: element-writer (TYPE (eql int8))

Method: element-writer (TYPE integer)

Generic Function: (setf element-writer) NEW-VALUE OBJECT

Package

org.shirakumo.fraf.gltf

Reader

element-writer (generic function)

Methods

Method: (setf element-writer) NEW-VALUE (ACCESSOR accessor)

automatically generated writer method

Source

accessor.lisp (file)

Generic Function: emissive-factor OBJECT

Accesses the emission factor of the emission-map.

Should be an array of three floats.

See MATERIAL

Package

org.shirakumo.fraf.gltf

Writer

(setf emissive-factor) (generic function)

Methods

Method: emissive-factor (MATERIAL material)

automatically generated reader method

Source

format.lisp (file)

Generic Function: (setf emissive-factor) NEW-VALUE OBJECT

Package

org.shirakumo.fraf.gltf

Reader

emissive-factor (generic function)

Methods

Method: (setf emissive-factor) NEW-VALUE (MATERIAL material)

automatically generated writer method

Source

format.lisp (file)

Generic Function: emissive-texture OBJECT

Accesses the emission-map texture.

See TEXTURE-INFO
See MATERIAL

Package

org.shirakumo.fraf.gltf

Writer

(setf emissive-texture) (generic function)

Methods

Method: emissive-texture (MATERIAL material)

automatically generated reader method

Source

format.lisp (file)

Generic Function: (setf emissive-texture) NEW-VALUE OBJECT

Package

org.shirakumo.fraf.gltf

Reader

emissive-texture (generic function)

Methods

Method: (setf emissive-texture) NEW-VALUE (MATERIAL material)

automatically generated writer method

Source

format.lisp (file)

Generic Function: extensions OBJECT

Accessor to opaque extension blobs.

See GLTF-ELEMENT

Package

org.shirakumo.fraf.gltf

Writer

(setf extensions) (generic function)

Methods

Method: extensions (GLTF-ELEMENT gltf-element)

automatically generated reader method

Source

format.lisp (file)

Generic Function: (setf extensions) NEW-VALUE OBJECT

Package

org.shirakumo.fraf.gltf

Reader

extensions (generic function)

Methods

Method: (setf extensions) NEW-VALUE (GLTF-ELEMENT gltf-element)

automatically generated writer method

Source

format.lisp (file)

Generic Function: extras OBJECT

Accessor to opaque extras blobs.

See GLTF-ELEMENT

Package

org.shirakumo.fraf.gltf

Writer

(setf extras) (generic function)

Methods

Method: extras (GLTF-ELEMENT gltf-element)

automatically generated reader method

Source

format.lisp (file)

Generic Function: (setf extras) NEW-VALUE OBJECT

Package

org.shirakumo.fraf.gltf

Reader

extras (generic function)

Methods

Method: (setf extras) NEW-VALUE (GLTF-ELEMENT gltf-element)

automatically generated writer method

Source

format.lisp (file)

Generic Function: fov OBJECT

Accesses the field of view value of the camera.

See PERSPECTIVE-CAMERA

Package

org.shirakumo.fraf.gltf

Writer

(setf fov) (generic function)

Methods

Method: fov (PERSPECTIVE-CAMERA perspective-camera)

automatically generated reader method

Source

format.lisp (file)

Generic Function: (setf fov) NEW-VALUE OBJECT

Package

org.shirakumo.fraf.gltf

Reader

fov (generic function)

Methods

Method: (setf fov) NEW-VALUE (PERSPECTIVE-CAMERA perspective-camera)

automatically generated writer method

Source

format.lisp (file)

Generic Function: generator OBJECT

Accesses a string noting the software used to generate the file.

See ASSET

Package

org.shirakumo.fraf.gltf

Writer

(setf generator) (generic function)

Methods

Method: generator (ASSET asset)

automatically generated reader method

Source

format.lisp (file)

Generic Function: (setf generator) NEW-VALUE OBJECT

Package

org.shirakumo.fraf.gltf

Reader

generator (generic function)

Methods

Method: (setf generator) NEW-VALUE (ASSET asset)

automatically generated writer method

Source

format.lisp (file)

Generic Function: gltf OBJECT

Returns the base GLTF instance this element is associated with.

See GLTF-ELEMENT

Package

org.shirakumo.fraf.gltf

Methods

Method: gltf (GLTF-ELEMENT gltf-element)

automatically generated reader method

Source

format.lisp (file)

Generic Function: idx OBJECT

Returns the index of the element within its collection.

See INDEXED-ELEMENT

Package

org.shirakumo.fraf.gltf

Writer

(setf idx) (generic function)

Methods

Method: idx (INDEXED-ELEMENT indexed-element)

automatically generated reader method

Source

format.lisp (file)

Generic Function: (setf idx) NEW-VALUE OBJECT

Package

org.shirakumo.fraf.gltf

Reader

idx (generic function)

Methods

Method: (setf idx) NEW-VALUE (INDEXED-ELEMENT indexed-element)

automatically generated writer method

Source

format.lisp (file)

Generic Function: images OBJECT

Accesses the array of image objects.

See IMAGE
See GLTF

Package

org.shirakumo.fraf.gltf

Writer

(setf images) (generic function)

Methods

Method: images (GLTF gltf)

automatically generated reader method

Source

format.lisp (file)

Generic Function: (setf images) NEW-VALUE OBJECT

Package

org.shirakumo.fraf.gltf

Reader

images (generic function)

Methods

Method: (setf images) NEW-VALUE (GLTF gltf)

automatically generated writer method

Source

format.lisp (file)

Generic Function: indices OBJECT

Accesses the accessor of vertex indices.

See ACCESSOR
See MESH-PRIMITIVE

Package

org.shirakumo.fraf.gltf

Writer

(setf indices) (generic function)

Methods

Method: indices (MESH-PRIMITIVE mesh-primitive)

automatically generated reader method

Source

format.lisp (file)

Generic Function: (setf indices) NEW-VALUE OBJECT

Package

org.shirakumo.fraf.gltf

Reader

indices (generic function)

Methods

Method: (setf indices) NEW-VALUE (MESH-PRIMITIVE mesh-primitive)

automatically generated writer method

Source

format.lisp (file)

Generic Function: input OBJECT

Accesses to the accessor that provides the times of the keyframes.

See ACCESSOR
See ANIMATION-SAMPLER

Package

org.shirakumo.fraf.gltf

Writer

(setf input) (generic function)

Methods

Method: input (ANIMATION-SAMPLER animation-sampler)

automatically generated reader method

Source

format.lisp (file)

Generic Function: (setf input) NEW-VALUE OBJECT

Package

org.shirakumo.fraf.gltf

Reader

input (generic function)

Methods

Method: (setf input) NEW-VALUE (ANIMATION-SAMPLER animation-sampler)

automatically generated writer method

Source

format.lisp (file)

Generic Function: interpolation OBJECT

Accesses to the interpolation type of the animation sampler.

Can be one of the following:
:STEP
:LINEAR
:CUBICSPLINE

See ANIMATION-SAMPLER

Package

org.shirakumo.fraf.gltf

Writer

(setf interpolation) (generic function)

Methods

Method: interpolation (ANIMATION-SAMPLER animation-sampler)

automatically generated reader method

Source

format.lisp (file)

Generic Function: (setf interpolation) NEW-VALUE OBJECT

Package

org.shirakumo.fraf.gltf

Reader

interpolation (generic function)

Methods

Method: (setf interpolation) NEW-VALUE (ANIMATION-SAMPLER animation-sampler)

automatically generated writer method

Source

format.lisp (file)

Generic Function: inverse-bind-matrices OBJECT

Accesses to the accessor that contains the inverse bind matrices of the skin.

See ACCESSOR
See SKIN

Package

org.shirakumo.fraf.gltf

Writer

(setf inverse-bind-matrices) (generic function)

Methods

Method: inverse-bind-matrices (SKIN skin)

automatically generated reader method

Source

format.lisp (file)

Generic Function: (setf inverse-bind-matrices) NEW-VALUE OBJECT

Package

org.shirakumo.fraf.gltf

Reader

inverse-bind-matrices (generic function)

Methods

Method: (setf inverse-bind-matrices) NEW-VALUE (SKIN skin)

automatically generated writer method

Source

format.lisp (file)

Generic Function: joints OBJECT

Accesses the array of nodes used as joints for the skin.

See NODE
See SKIN

Package

org.shirakumo.fraf.gltf

Writer

(setf joints) (generic function)

Methods

Method: joints (SKIN skin)

automatically generated reader method

Source

format.lisp (file)

Generic Function: (setf joints) NEW-VALUE OBJECT

Package

org.shirakumo.fraf.gltf

Reader

joints (generic function)

Methods

Method: (setf joints) NEW-VALUE (SKIN skin)

automatically generated writer method

Source

format.lisp (file)

Generic Function: mag-filter OBJECT

Accesses to the magnification filter of the sampler.

Can be one of the following:
:NEAREST
:LINEAR

See SAMPLER

Package

org.shirakumo.fraf.gltf

Writer

(setf mag-filter) (generic function)

Methods

Method: mag-filter (SAMPLER sampler)

automatically generated reader method

Source

format.lisp (file)

Generic Function: (setf mag-filter) NEW-VALUE OBJECT

Package

org.shirakumo.fraf.gltf

Reader

mag-filter (generic function)

Methods

Method: (setf mag-filter) NEW-VALUE (SAMPLER sampler)

automatically generated writer method

Source

format.lisp (file)

Generic Function: material OBJECT

Accesses the material used for the mesh primitive.

See MATERIAL
See MESH-PRIMITIVE

Package

org.shirakumo.fraf.gltf

Writer

(setf material) (generic function)

Methods

Method: material (MESH-PRIMITIVE mesh-primitive)

automatically generated reader method

Source

format.lisp (file)

Generic Function: (setf material) NEW-VALUE OBJECT

Package

org.shirakumo.fraf.gltf

Reader

material (generic function)

Methods

Method: (setf material) NEW-VALUE (MESH-PRIMITIVE mesh-primitive)

automatically generated writer method

Source

format.lisp (file)

Generic Function: materials OBJECT

Accesses the array of material objects.

See MATERIAL
See GLTF

Package

org.shirakumo.fraf.gltf

Writer

(setf materials) (generic function)

Methods

Method: materials (GLTF gltf)

automatically generated reader method

Source

format.lisp (file)

Generic Function: (setf materials) NEW-VALUE OBJECT

Package

org.shirakumo.fraf.gltf

Reader

materials (generic function)

Methods

Method: (setf materials) NEW-VALUE (GLTF gltf)

automatically generated writer method

Source

format.lisp (file)

Generic Function: matrix OBJECT

Accesses the transformation matrix attached to the node.

The matrix should be a 16-element float array representing the 4x4 matrix.

See NODE

Package

org.shirakumo.fraf.gltf

Writer

(setf matrix) (generic function)

Methods

Method: matrix (NODE node)

automatically generated reader method

Source

format.lisp (file)

Generic Function: (setf matrix) NEW-VALUE OBJECT

Package

org.shirakumo.fraf.gltf

Reader

matrix (generic function)

Methods

Method: (setf matrix) NEW-VALUE (NODE node)

automatically generated writer method

Source

format.lisp (file)

Generic Function: maximum OBJECT

Returns a representation of the maximal value of any values this accessor may read.

This is typically either a single scalar value or an array of values.

See ACCESSOR

Package

org.shirakumo.fraf.gltf

Writer

(setf maximum) (generic function)

Methods

Method: maximum (ACCESSOR accessor)

automatically generated reader method

Source

accessor.lisp (file)

Generic Function: (setf maximum) NEW-VALUE OBJECT

Package

org.shirakumo.fraf.gltf

Reader

maximum (generic function)

Methods

Method: (setf maximum) NEW-VALUE (ACCESSOR accessor)

automatically generated writer method

Source

accessor.lisp (file)

Generic Function: mesh OBJECT

Accesses the mesh attached to the node.

See MESH
See NODE

Package

org.shirakumo.fraf.gltf

Writer

(setf mesh) (generic function)

Methods

Method: mesh (NODE node)

automatically generated reader method

Source

format.lisp (file)

Generic Function: (setf mesh) NEW-VALUE OBJECT

Package

org.shirakumo.fraf.gltf

Reader

mesh (generic function)

Methods

Method: (setf mesh) NEW-VALUE (NODE node)

automatically generated writer method

Source

format.lisp (file)

Generic Function: meshes OBJECT

Accesses the array of mesh objects.

See MESH
See GLTF

Package

org.shirakumo.fraf.gltf

Writer

(setf meshes) (generic function)

Methods

Method: meshes (GLTF gltf)

automatically generated reader method

Source

format.lisp (file)

Generic Function: (setf meshes) NEW-VALUE OBJECT

Package

org.shirakumo.fraf.gltf

Reader

meshes (generic function)

Methods

Method: (setf meshes) NEW-VALUE (GLTF gltf)

automatically generated writer method

Source

format.lisp (file)

Generic Function: metallic-factor OBJECT

Accesses the metalness-factor for the material.

See PBR

Package

org.shirakumo.fraf.gltf

Writer

(setf metallic-factor) (generic function)

Methods

Method: metallic-factor (PBR pbr)

automatically generated reader method

Source

format.lisp (file)

Generic Function: (setf metallic-factor) NEW-VALUE OBJECT

Package

org.shirakumo.fraf.gltf

Reader

metallic-factor (generic function)

Methods

Method: (setf metallic-factor) NEW-VALUE (PBR pbr)

automatically generated writer method

Source

format.lisp (file)

Generic Function: mime-type OBJECT

Accesses to the string mime-type of the image.

Should be either:
"image/jpeg"
"image/png"

See IMAGE

Package

org.shirakumo.fraf.gltf

Writer

(setf mime-type) (generic function)

Methods

Method: mime-type (IMAGE image)

automatically generated reader method

Source

format.lisp (file)

Generic Function: (setf mime-type) NEW-VALUE OBJECT

Package

org.shirakumo.fraf.gltf

Reader

mime-type (generic function)

Methods

Method: (setf mime-type) NEW-VALUE (IMAGE image)

automatically generated writer method

Source

format.lisp (file)

Generic Function: min-filter OBJECT

Accesses to the minification filter of the sampler.

Can be one of the following:
:NEAREST
:LINEAR
:NEAREST-MIPMAP-NEAREST :LINEAR-MIPMAP-NEAREST :NEAREST-MIPMAP-LINEAR :LINEAR-MIPMAP-LINEAR

See SAMPLER

Package

org.shirakumo.fraf.gltf

Writer

(setf min-filter) (generic function)

Methods

Method: min-filter (SAMPLER sampler)

automatically generated reader method

Source

format.lisp (file)