Next: Introduction, Previous: (dir), Up: (dir) [Contents][Index]
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.
• Introduction | What cl-gltf is all about | |
• Systems | The systems documentation | |
• Files | The files documentation | |
• Packages | The packages documentation | |
• Definitions | The symbols documentation | |
• Indexes | Concepts, functions, variables and data types |
## 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
Next: Files, Previous: Introduction, Up: Top [Contents][Index]
The main system appears first, followed by any subsystem dependency.
• The cl-gltf system |
Nicolas Hafner <shinmera@tymoon.eu>
Nicolas Hafner <shinmera@tymoon.eu>
(:git "https://github.com/shirakumo/cl-gltf.git")
zlib
A library to parse the glTF file format.
1.0.0
cl-gltf.asd (file)
Files are sorted by type and then listed depth-first from the systems components trees.
• Lisp files |
Next: The cl-gltf/package․lisp file, Previous: Lisp files, Up: Lisp files [Contents][Index]
cl-gltf.asd
cl-gltf (system)
Next: The cl-gltf/element․lisp file, Previous: The cl-gltf․asd file, Up: Lisp files [Contents][Index]
cl-gltf (system)
package.lisp
Next: The cl-gltf/format․lisp file, Previous: The cl-gltf/package․lisp file, Up: Lisp files [Contents][Index]
package.lisp (file)
cl-gltf (system)
element.lisp
Next: The cl-gltf/accessor․lisp file, Previous: The cl-gltf/element․lisp file, Up: Lisp files [Contents][Index]
element.lisp (file)
cl-gltf (system)
format.lisp
Next: The cl-gltf/parser․lisp file, Previous: The cl-gltf/format․lisp file, Up: Lisp files [Contents][Index]
format.lisp (file)
cl-gltf (system)
accessor.lisp
Next: The cl-gltf/documentation․lisp file, Previous: The cl-gltf/accessor․lisp file, Up: Lisp files [Contents][Index]
accessor.lisp (file)
cl-gltf (system)
parser.lisp
Previous: The cl-gltf/parser․lisp file, Up: Lisp files [Contents][Index]
parser.lisp (file)
cl-gltf (system)
documentation.lisp
Next: Definitions, Previous: Files, Up: Top [Contents][Index]
Packages are listed by definition order.
• The org.shirakumo.fraf.gltf package |
package.lisp (file)
common-lisp
Definitions are sorted by export status, category, package, and then by lexicographic order.
• Exported definitions | ||
• Internal definitions |
Next: Internal definitions, Previous: Definitions, Up: Definitions [Contents][Index]
• Exported macros | ||
• Exported functions | ||
• Exported generic functions | ||
• Exported classes |
Next: Exported functions, Previous: Exported definitions, Up: Exported definitions [Contents][Index]
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)
parser.lisp (file)
Next: Exported generic functions, Previous: Exported macros, Up: Exported definitions [Contents][Index]
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)
parser.lisp (file)
Next: Exported classes, Previous: Exported functions, Up: Exported definitions [Contents][Index]
Accesses the array of accessor objects.
See ACCESSOR
See GLTF
(setf accessors) (generic function)
automatically generated reader method
format.lisp (file)
accessors (generic function)
automatically generated writer method
format.lisp (file)
Accesses the texture-info for the albedo channel of the material.
See TEXTURE-INFO
See PBR
(setf albedo) (generic function)
automatically generated reader method
format.lisp (file)
albedo (generic function)
automatically generated writer method
format.lisp (file)
Accesses the albedo-factor for the material.
This should be an array of four float values representing the
per-channel strength factors.
See PBR
(setf albedo-factor) (generic function)
automatically generated reader method
format.lisp (file)
albedo-factor (generic function)
automatically generated writer method
format.lisp (file)
Accesses the alpha cutoff value when the material is in mask mode.
See MATERIAL
(setf alpha-cutoff) (generic function)
automatically generated reader method
format.lisp (file)
alpha-cutoff (generic function)
automatically generated writer method
format.lisp (file)
Accesses the alpha-blending mode of the material.
Can be one of the following:
:OPAQUE
:MASK
:BLEND
See MATERIAL
(setf alpha-mode) (generic function)
automatically generated reader method
format.lisp (file)
alpha-mode (generic function)
automatically generated writer method
format.lisp (file)
Accesses the array of animation objects.
See ANIMATION
See GLTF
(setf animations) (generic function)
automatically generated reader method
format.lisp (file)
animations (generic function)
automatically generated writer method
format.lisp (file)
Accesses the view aspect ratio of the camera.
See PERSPECTIVE-CAMERA
(setf aspect-ratio) (generic function)
automatically generated reader method
format.lisp (file)
aspect-ratio (generic function)
automatically generated writer method
format.lisp (file)
Accesses the asset object.
See ASSET
See GLTF
(setf asset) (generic function)
automatically generated reader method
format.lisp (file)
asset (generic function)
automatically generated writer method
format.lisp (file)
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
(setf attributes) (generic function)
automatically generated reader method
format.lisp (file)
attributes (generic function)
automatically generated writer method
format.lisp (file)
Returns the buffer indexed into by the buffer-view.
See BUFFER
See BUFFER-VIEW
(setf buffer) (generic function)
automatically generated reader method
accessor.lisp (file)
automatically generated reader method
accessor.lisp (file)
buffer (generic function)
automatically generated writer method
accessor.lisp (file)
Returns the buffer-view this accessor indexes into.
See ACCESSOR
(setf buffer-view) (generic function)
automatically generated reader method
accessor.lisp (file)
automatically generated reader method
format.lisp (file)
buffer-view (generic function)
automatically generated writer method
accessor.lisp (file)
automatically generated writer method
format.lisp (file)
Accesses the array of buffer-view objects.
See BUFFER-VIEW
See GLTF
(setf buffer-views) (generic function)
automatically generated reader method
format.lisp (file)
buffer-views (generic function)
automatically generated writer method
format.lisp (file)
Accesses the array of buffer objects.
See GLTF
See BUFFER
(setf buffers) (generic function)
automatically generated reader method
format.lisp (file)
buffers (generic function)
automatically generated writer method
format.lisp (file)
Returns the length of the buffer in octets.
See BUFFER
See BUFFER-VIEW
(setf byte-length) (generic function)
automatically generated reader method
accessor.lisp (file)
automatically generated reader method
accessor.lisp (file)
byte-length (generic function)
automatically generated writer method
accessor.lisp (file)
automatically generated writer method
accessor.lisp (file)
Returns the offset in octets from the start of the buffer.
See ACCESSOR
See BUFFER-VIEW
(setf byte-offset) (generic function)
automatically generated reader method
accessor.lisp (file)
automatically generated reader method
accessor.lisp (file)
byte-offset (generic function)
automatically generated writer method
accessor.lisp (file)
automatically generated writer method
accessor.lisp (file)
Returns the number of bytes between valid elements in the buffer.
Note that this may be NIL.
See ACCESSOR
See BUFFER-VIEW
(setf byte-stride) (generic function)
automatically generated reader method
accessor.lisp (file)
automatically generated reader method
accessor.lisp (file)
byte-stride (generic function)
automatically generated writer method
accessor.lisp (file)
Accesses the camera attached to the node.
See CAMERA
See NODE
(setf camera) (generic function)
automatically generated reader method
format.lisp (file)
camera (generic function)
automatically generated writer method
format.lisp (file)
Accesses the array of camera objects.
See CAMERA
See GLTF
(setf cameras) (generic function)
automatically generated reader method
format.lisp (file)
cameras (generic function)
automatically generated writer method
format.lisp (file)
Accesses the array of animation-channels.
See ANIMATION-CHANNEL
See ANIMATION
(setf channels) (generic function)
automatically generated reader method
format.lisp (file)
channels (generic function)
automatically generated writer method
format.lisp (file)
Accesses the array of child nodes.
See NODE
(setf children) (generic function)
automatically generated reader method
format.lisp (file)
children (generic function)
automatically generated writer method
format.lisp (file)
Returns the compound component type this accessor reads.
Barring extensions, this can be one of:
:SCALAR
:VEC2
:VEC3
:VEC4
:MAT2
:MAT3
:MAT4
See ACCESSOR
(setf component-type) (generic function)
automatically generated reader method
accessor.lisp (file)
component-type (generic function)
automatically generated writer method
accessor.lisp (file)
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)
accessor.lisp (file)
accessor.lisp (file)
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)
accessor.lisp (file)
accessor.lisp (file)
Accesses a string noting the copyright information.
See ASSET
(setf copyright) (generic function)
automatically generated reader method
format.lisp (file)
copyright (generic function)
automatically generated writer method
format.lisp (file)
Accesses whether the material should be double-sided or not.
See MATERIAL
(setf double-sided-p) (generic function)
automatically generated reader method
format.lisp (file)
double-sided-p (generic function)
automatically generated writer method
format.lisp (file)
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
accessor.lisp (file)
(setf element-reader) (generic function)
automatically generated reader method
element-reader (generic function)
automatically generated writer method
accessor.lisp (file)
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
(setf element-type) (generic function)
automatically generated reader method
accessor.lisp (file)
element-type (generic function)
automatically generated writer method
accessor.lisp (file)
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
accessor.lisp (file)
(setf element-writer) (generic function)
automatically generated reader method
element-writer (generic function)
automatically generated writer method
accessor.lisp (file)
Accesses the emission factor of the emission-map.
Should be an array of three floats.
See MATERIAL
(setf emissive-factor) (generic function)
automatically generated reader method
format.lisp (file)
emissive-factor (generic function)
automatically generated writer method
format.lisp (file)
Accesses the emission-map texture.
See TEXTURE-INFO
See MATERIAL
(setf emissive-texture) (generic function)
automatically generated reader method
format.lisp (file)
emissive-texture (generic function)
automatically generated writer method
format.lisp (file)
Accessor to opaque extension blobs.
See GLTF-ELEMENT
(setf extensions) (generic function)
automatically generated reader method
format.lisp (file)
extensions (generic function)
automatically generated writer method
format.lisp (file)
Accessor to opaque extras blobs.
See GLTF-ELEMENT
(setf extras) (generic function)
automatically generated reader method
format.lisp (file)
extras (generic function)
automatically generated writer method
format.lisp (file)
Accesses the field of view value of the camera.
See PERSPECTIVE-CAMERA
(setf fov) (generic function)
automatically generated reader method
format.lisp (file)
fov (generic function)
automatically generated writer method
format.lisp (file)
Accesses a string noting the software used to generate the file.
See ASSET
(setf generator) (generic function)
automatically generated reader method
format.lisp (file)
generator (generic function)
automatically generated writer method
format.lisp (file)
Returns the base GLTF instance this element is associated with.
See GLTF-ELEMENT
automatically generated reader method
format.lisp (file)
Returns the index of the element within its collection.
See INDEXED-ELEMENT
(setf idx) (generic function)
automatically generated reader method
format.lisp (file)
idx (generic function)
automatically generated writer method
format.lisp (file)
Accesses the array of image objects.
See IMAGE
See GLTF
(setf images) (generic function)
automatically generated reader method
format.lisp (file)
images (generic function)
automatically generated writer method
format.lisp (file)
Accesses the accessor of vertex indices.
See ACCESSOR
See MESH-PRIMITIVE
(setf indices) (generic function)
automatically generated reader method
format.lisp (file)
indices (generic function)
automatically generated writer method
format.lisp (file)
Accesses to the accessor that provides the times of the keyframes.
See ACCESSOR
See ANIMATION-SAMPLER
(setf input) (generic function)
automatically generated reader method
format.lisp (file)
input (generic function)
automatically generated writer method
format.lisp (file)
Accesses to the interpolation type of the animation sampler.
Can be one of the following:
:STEP
:LINEAR
:CUBICSPLINE
See ANIMATION-SAMPLER
(setf interpolation) (generic function)
automatically generated reader method
format.lisp (file)
interpolation (generic function)
automatically generated writer method
format.lisp (file)
Accesses to the accessor that contains the inverse bind matrices of the skin.
See ACCESSOR
See SKIN
(setf inverse-bind-matrices) (generic function)
automatically generated reader method
format.lisp (file)
inverse-bind-matrices (generic function)
automatically generated writer method
format.lisp (file)
Accesses the array of nodes used as joints for the skin.
See NODE
See SKIN
(setf joints) (generic function)
automatically generated reader method
format.lisp (file)
joints (generic function)
automatically generated writer method
format.lisp (file)
Accesses to the magnification filter of the sampler.
Can be one of the following:
:NEAREST
:LINEAR
See SAMPLER
(setf mag-filter) (generic function)
automatically generated reader method
format.lisp (file)
mag-filter (generic function)
automatically generated writer method
format.lisp (file)
Accesses the material used for the mesh primitive.
See MATERIAL
See MESH-PRIMITIVE
(setf material) (generic function)
automatically generated reader method
format.lisp (file)
material (generic function)
automatically generated writer method
format.lisp (file)
Accesses the array of material objects.
See MATERIAL
See GLTF
(setf materials) (generic function)
automatically generated reader method
format.lisp (file)
materials (generic function)
automatically generated writer method
format.lisp (file)
Accesses the transformation matrix attached to the node.
The matrix should be a 16-element float array representing the 4x4
matrix.
See NODE
(setf matrix) (generic function)
automatically generated reader method
format.lisp (file)
matrix (generic function)
automatically generated writer method
format.lisp (file)
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
(setf maximum) (generic function)
automatically generated reader method
accessor.lisp (file)
maximum (generic function)
automatically generated writer method
accessor.lisp (file)
Accesses the mesh attached to the node.
See MESH
See NODE
(setf mesh) (generic function)
automatically generated reader method
format.lisp (file)
mesh (generic function)
automatically generated writer method
format.lisp (file)
Accesses the array of mesh objects.
See MESH
See GLTF
(setf meshes) (generic function)
automatically generated reader method
format.lisp (file)
meshes (generic function)
automatically generated writer method
format.lisp (file)
Accesses the metalness-factor for the material.
See PBR
(setf metallic-factor) (generic function)
automatically generated reader method
format.lisp (file)
metallic-factor (generic function)
automatically generated writer method
format.lisp (file)
Accesses to the string mime-type of the image.
Should be either:
"image/jpeg"
"image/png"
See IMAGE
(setf mime-type) (generic function)
automatically generated reader method
format.lisp (file)
mime-type (generic function)
automatically generated writer method
format.lisp (file)
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
(setf min-filter) (generic function)
automatically generated reader method
format.lisp (file)
min-filter (generic function)
automatically generated writer method
format.lisp (file)
Accesses a string specifying the minimum version required to parse the file successfully.
See ASSET
(setf min-version) (generic function)
automatically generated reader method
format.lisp (file)
min-version (generic function)
automatically generated writer method
format.lisp (file)
Returns a representation of the minimal value of any values this accessor may read.
This is typically either a single scalar value or an array of values.
See ACCESSOR
(setf minimum) (generic function)
automatically generated reader method
accessor.lisp (file)
minimum (generic function)
automatically generated writer method
accessor.lisp (file)
Accesses the "mode" of the vertices in the mesh.
Can be one of the following:
:POINTS
:LINES
:LINE-LOOP
:LINE-STRIP
:TRIANGLES
:TRIANGLE-STRIP
:TRIANGLE-FAN
See MESH-PRIMITIVE
(setf mode) (generic function)
automatically generated reader method
format.lisp (file)
mode (generic function)
automatically generated writer method
format.lisp (file)
Accesses the name of the element. May be NIL or a STRING.
See NAMED-ELEMENT
(setf name) (generic function)
automatically generated reader method
format.lisp (file)
name (generic function)
automatically generated writer method
format.lisp (file)
Accesses for the node that the channel animates.
See NODE
See ANIMATION-CHANNEL-TARGET
(setf node) (generic function)
automatically generated reader method
format.lisp (file)
node (generic function)
automatically generated writer method
format.lisp (file)
Accesses the array of node objects.
See NODE
See SCENE
See GLTF
(setf nodes) (generic function)
automatically generated reader method
format.lisp (file)
automatically generated reader method
format.lisp (file)
nodes (generic function)
automatically generated writer method
format.lisp (file)
automatically generated writer method
format.lisp (file)
Accesses the normal-map texture.
See TEXTURE-INFO
See MATERIAL
(setf normal-texture) (generic function)
automatically generated reader method
format.lisp (file)
normal-texture (generic function)
automatically generated writer method
format.lisp (file)
Returns whether the values in the buffer are normalized or not.
See ACCESSOR
(setf normalized) (generic function)
automatically generated reader method
accessor.lisp (file)
normalized (generic function)
automatically generated writer method
accessor.lisp (file)
Accesses the occlusion-map texture.
See TEXTURE-INFO
See MATERIAL
(setf occlusion-texture) (generic function)
automatically generated reader method
format.lisp (file)
occlusion-texture (generic function)
automatically generated writer method
format.lisp (file)
Accesses to the accessor that provides the values of the keyframes.
See ACCESSOR
See ANIMATION-SAMPLER
(setf output) (generic function)
automatically generated reader method
format.lisp (file)
output (generic function)
automatically generated writer method
format.lisp (file)
Accesses the parent of the node.
See NODE
(setf parent) (generic function)
automatically generated reader method
format.lisp (file)
parent (generic function)
automatically generated writer method
format.lisp (file)
Accesses for the property that the channel animates.
Can be one of the following:
:TRANSLATION
:ROTATION
:SCALE
:WEIGHTS
See ANIMATION-CHANNEL
(setf path) (generic function)
automatically generated reader method
format.lisp (file)
format.lisp (file)
path (generic function)
automatically generated writer method
format.lisp (file)
Accesses the PBR material descriptor.
See PBR
See MATERIAL
(setf pbr) (generic function)
automatically generated reader method
format.lisp (file)
pbr (generic function)
automatically generated writer method
format.lisp (file)
Accesses the array of mesh primitives that make up the mesh.
See MESH-PRIMITIVE
See MESH
(setf primitives) (generic function)
automatically generated reader method
format.lisp (file)
primitives (generic function)
automatically generated writer method
format.lisp (file)
Accesses the rotation quaternion attached to the node.
Expressed as a 4-element float array.
See NODE
(setf rotation) (generic function)
automatically generated reader method
format.lisp (file)
rotation (generic function)
automatically generated writer method
format.lisp (file)
Accesses the roughness-factor for the material.
See PBR
(setf roughness-factor) (generic function)
automatically generated reader method
format.lisp (file)
roughness-factor (generic function)
automatically generated writer method
format.lisp (file)
Accesses the sampler used for the texture.
See SAMPLER
See TEXTURE
(setf sampler) (generic function)
automatically generated reader method
format.lisp (file)
automatically generated reader method
format.lisp (file)
sampler (generic function)
automatically generated writer method
format.lisp (file)
automatically generated writer method
format.lisp (file)
Accesses the array of animation-samplers
See ANIMATION-SAMPLER
See ANIMATION
(setf samplers) (generic function)
automatically generated reader method
format.lisp (file)
automatically generated reader method
format.lisp (file)
samplers (generic function)
automatically generated writer method
format.lisp (file)
automatically generated writer method
format.lisp (file)
Accesses the scalar applied to each normal of the normal-map texture.
See TEXTURE-INFO
(setf scale) (generic function)
automatically generated reader method
format.lisp (file)
automatically generated reader method
format.lisp (file)
scale (generic function)
automatically generated writer method
format.lisp (file)
automatically generated writer method
format.lisp (file)
Accesses the array of scene objects.
See SCENE
See GLTF
(setf scenes) (generic function)
automatically generated reader method
format.lisp (file)
scenes (generic function)
automatically generated writer method
format.lisp (file)
Returns the number of elements this accessor may read.
See ACCESSOR
(setf size) (generic function)
automatically generated reader method
accessor.lisp (file)
size (generic function)
automatically generated writer method
accessor.lisp (file)
Accesses the node that represents the root of the skeleton for the skin.
See NODE
See SKIN
(setf skeleton) (generic function)
automatically generated reader method
format.lisp (file)
skeleton (generic function)
automatically generated writer method
format.lisp (file)
Accesses the skin attached to the node.
See SKIN
See NODE
(setf skin) (generic function)
automatically generated reader method
format.lisp (file)
skin (generic function)
automatically generated writer method
format.lisp (file)
Accesses the array of skin objects.
See SKIN
See GLTF
(setf skins) (generic function)
automatically generated reader method
format.lisp (file)
skins (generic function)
automatically generated writer method
format.lisp (file)
Accesses the source image of the texture.
See IMAGE
See TEXTURE
(setf source) (generic function)
automatically generated reader method
format.lisp (file)
source (generic function)
automatically generated writer method
format.lisp (file)
Returns a pointer to the start of the memory region represented by the buffer, view, or accessor.
See BUFFER
See BUFFER-VIEW
See ACCESSOR
automatically generated reader method
accessor.lisp (file)
automatically generated reader method
accessor.lisp (file)
automatically generated reader method
accessor.lisp (file)
Accesses the scalar for the strength of the occulsion-map texture.
See TEXTURE-INFO
(setf strength) (generic function)
automatically generated reader method
format.lisp (file)
strength (generic function)
automatically generated writer method
format.lisp (file)
Accesses for the animation-channel-target.
See ANIMATION-CHANNEL-TARGET
See ANIMATION-CHANNEL
(setf target) (generic function)
automatically generated reader method
accessor.lisp (file)
automatically generated reader method
format.lisp (file)
target (generic function)
automatically generated writer method
accessor.lisp (file)
automatically generated writer method
format.lisp (file)
Accesses the array of morph targets.
See MESH-PRIMITIVE
(setf targets) (generic function)
automatically generated reader method
format.lisp (file)
targets (generic function)
automatically generated writer method
format.lisp (file)
Accesses the index of the texture coordinates used for the texture indexing.
See TEXTURE-INFO
(setf tex-coord) (generic function)
automatically generated reader method
format.lisp (file)
tex-coord (generic function)
automatically generated writer method
format.lisp (file)
Accesses the texture the texture-info supplements.
See TEXTURE
See TEXTURE-INFO
(setf texture) (generic function)
automatically generated reader method
format.lisp (file)
texture (generic function)
automatically generated writer method
format.lisp (file)
Accesses the array of texture objects.
See TEXTURE
See GLTF
(setf textures) (generic function)
automatically generated reader method
format.lisp (file)
textures (generic function)
automatically generated writer method
format.lisp (file)
Accesses the translation of the node.
Expressed as a 3-element float array.
See NODE
(setf translation) (generic function)
automatically generated reader method
format.lisp (file)
translation (generic function)
automatically generated writer method
format.lisp (file)
Accesses the URI. May be NIL or a STRING.
See URI-ELEMENT
(setf uri) (generic function)
automatically generated reader method
format.lisp (file)
automatically generated reader method
format.lisp (file)
uri (generic function)
automatically generated writer method
format.lisp (file)
automatically generated writer method
format.lisp (file)
Accesses a string noting the version of the glTF format.
See ASSET
(setf version) (generic function)
automatically generated reader method
format.lisp (file)
version (generic function)
automatically generated writer method
format.lisp (file)
Accesses the weights of the morph target.
Expressed as a float array.
See MESH
See NODE
(setf weights) (generic function)
automatically generated reader method
format.lisp (file)
automatically generated reader method
format.lisp (file)
weights (generic function)
automatically generated writer method
format.lisp (file)
automatically generated writer method
format.lisp (file)
Accesses to the U-wrapping mode of the sampler.
Can be one of the following:
:CLAMP-TO-EDGE
:MIRRORED-REPEAT
:REPEAT
See SAMPLER
(setf wrap-s) (generic function)
automatically generated reader method
format.lisp (file)
wrap-s (generic function)
automatically generated writer method
format.lisp (file)
Accesses to the V-wrapping mode of the sampler.
Can be one of the following:
:CLAMP-TO-EDGE
:MIRRORED-REPEAT
:REPEAT
See SAMPLER
(setf wrap-t) (generic function)
automatically generated reader method
format.lisp (file)
wrap-t (generic function)
automatically generated writer method
format.lisp (file)
Accesses the horizontal magnification of the view.
See ORTHOGRAPHIC-CAMERA
(setf xmag) (generic function)
automatically generated reader method
format.lisp (file)
xmag (generic function)
automatically generated writer method
format.lisp (file)
Accesses the vertical magnification of the view.
See ORTHOGRAPHIC-CAMERA
(setf ymag) (generic function)
automatically generated reader method
format.lisp (file)
ymag (generic function)
automatically generated writer method
format.lisp (file)
Accesses the distance to the far clipping plane.
See ORTHOGRAPHIC-CAMERA
See PERSPECTIVE-CAMERA
(setf zfar) (generic function)
automatically generated reader method
format.lisp (file)
automatically generated reader method
format.lisp (file)
zfar (generic function)
automatically generated writer method
format.lisp (file)
automatically generated writer method
format.lisp (file)
Accesses the distance to the near clipping plane.
See ORTHOGRAPHIC-CAMERA
See PERSPECTIVE-CAMERA
(setf znear) (generic function)
automatically generated reader method
format.lisp (file)
automatically generated reader method
format.lisp (file)
znear (generic function)
automatically generated writer method
format.lisp (file)
automatically generated writer method
format.lisp (file)
Previous: Exported generic functions, Up: Exported definitions [Contents][Index]
Representation of an attribute accessor into a buffer.
This is a SEQUENCE and can be used as such.
See BUFFER-VIEW
See BYTE-OFFSET
See COMPONENT-TYPE
See ELEMENT-TYPE
See SIZE
See NORMALIZED
See MAXIMUM
See MINIMUM
See START
See BYTE-STRIDE
See ELEMENT-READER
See ELEMENT-WRITER
See INDEXED-ELEMENT
See NAMED-ELEMENT
accessor.lisp (file)
sparse-accessor (class)
:buffer-view
buffer-view (generic function)
(setf buffer-view) (generic function)
:byte-offset
0
byte-offset (generic function)
(setf byte-offset) (generic function)
:component-type
:float
component-type (generic function)
(setf component-type) (generic function)
:element-type
element-type (generic function)
(setf element-type) (generic function)
:size
(setf size) (generic function)
:normalized
normalized (generic function)
(setf normalized) (generic function)
:maximum
maximum (generic function)
(setf maximum) (generic function)
:minimum
minimum (generic function)
(setf minimum) (generic function)
start (generic function)
byte-stride (generic function)
:element-reader
element-reader (generic function)
(setf element-reader) (generic function)
:element-writer
element-writer (generic function)
(setf element-writer) (generic function)
Representation of an animation.
See INDEXED-ELEMENT
See NAMED-ELEMENT
See CHANNELS
See SAMPLERS
format.lisp (file)
:channels
#()
channels (generic function)
(setf channels) (generic function)
:samplers
#()
samplers (generic function)
(setf samplers) (generic function)
Representation of an animation channel.
See GLTF-ELEMENT
See SAMPLER
See TARGET
format.lisp (file)
gltf-element (class)
:sampler
sampler (generic function)
(setf sampler) (generic function)
:target
target (generic function)
(setf target) (generic function)
Representation of an animation channel target.
See GLTF-ELEMENT
See NODE
See PATH
format.lisp (file)
gltf-element (class)
:node
node (generic function)
(setf node) (generic function)
:path
path (generic function)
(setf path) (generic function)
Representation of a sampler for an animation-channel.
See GLTF-ELEMENT
See INPUT
See OUTPUT
See INTERPOLATION
format.lisp (file)
gltf-element (class)
:input
input (generic function)
(setf input) (generic function)
:output
output (generic function)
(setf output) (generic function)
:interpolation
:linear
interpolation (generic function)
(setf interpolation) (generic function)
Represents basic metadata about the GLTF file.
See GLTF-ELEMENT
See COPYRIGHT
See GENERATOR
See VERSION
See MIN-VERSION
format.lisp (file)
gltf-element (class)
:copyright
copyright (generic function)
(setf copyright) (generic function)
:generator
generator (generic function)
(setf generator) (generic function)
:version
version (generic function)
(setf version) (generic function)
:min-version
min-version (generic function)
(setf min-version) (generic function)
Representation of an octet buffer.
This is a SEQUENCE and can be used as such.
Once the buffer is no longer required, it must be CLOSEd to free up
potential resources kept by the buffer in the back.
See START
See BYTE-LENGTH
See INDEXED-ELEMENT
See URI-ELEMENT
See NAMED-ELEMENT
accessor.lisp (file)
start (generic function)
:byte-length
(setf byte-length) (generic function)
Representation of a view into a buffer.
This is a SEQUENCE and can be used as such.
See BUFFER
See START
See BYTE-OFFSET
See BYTE-LENGTH
See BYTE-STRIDE
See TARGET
See INDEXED-ELEMENT
See NAMED-ELEMENT
accessor.lisp (file)
:buffer
buffer (generic function)
(setf buffer) (generic function)
start (generic function)
:byte-offset
0
byte-offset (generic function)
(setf byte-offset) (generic function)
:byte-length
(setf byte-length) (generic function)
:byte-stride
byte-stride (generic function)
(setf byte-stride) (generic function)
:target
target (generic function)
(setf target) (generic function)
Base type for cameras.
See INDEXED-ELEMENT See NAMED-ELEMENT See ORTHOGRAPHIC-CAMERA See PERSPECTIVE-CAMERA
format.lisp (file)
Base of a GLTF file’s representation.
A GLTF instance is a collection of subobjects, which may nest and
refer to each other.
Once you are done, you **must** call CLOSE on the instance to ensure backing buffers and other associated resources are properly freed.
See PARSE
See WITH-GLTF
See GLTF-ELEMENT
See URI
See BUFFERS
See BUFFER-VIEWS
See ACCESSORS
See ASSET
See CAMERAS
See MESHES
See IMAGES
See SAMPLERS
See TEXTURES
See MATERIALS
See SKINS
See NODES
See ANIMATIONS
See SCENES
format.lisp (file)
gltf-element (class)
:uri
uri (generic function)
(setf uri) (generic function)
:buffers
#()
buffers (generic function)
(setf buffers) (generic function)
:buffer-views
#()
buffer-views (generic function)
(setf buffer-views) (generic function)
:accessors
#()
accessors (generic function)
(setf accessors) (generic function)
:asset
asset (generic function)
(setf asset) (generic function)
:cameras
#()
cameras (generic function)
(setf cameras) (generic function)
:meshes
#()
meshes (generic function)
(setf meshes) (generic function)
:images
#()
images (generic function)
(setf images) (generic function)
:samplers
#()
samplers (generic function)
(setf samplers) (generic function)
:textures
#()
textures (generic function)
(setf textures) (generic function)
:materials
#()
materials (generic function)
(setf materials) (generic function)
:skins
#()
skins (generic function)
(setf skins) (generic function)
:nodes
#()
nodes (generic function)
(setf nodes) (generic function)
:animations
#()
animations (generic function)
(setf animations) (generic function)
:scenes
#()
scenes (generic function)
(setf scenes) (generic function)
Base class for any part of a glTF representation
See EXTENSIONS
See EXTRAS
See GLTF
format.lisp (file)
standard-object (class)
:extensions
extensions (generic function)
(setf extensions) (generic function)
:extras
extras (generic function)
(setf extras) (generic function)
:gltf
gltf (generic function)
Representation of an image.
An image may either be represented by an URI to another file, an inline data-uri, or a buffer-view that provides the image data.
See INDEXED-ELEMENT
See URI-ELEMENT
See NAMED-ELEMENT
See MIME-TYPE
See BUFFER-VIEW
format.lisp (file)
:mime-type
mime-type (generic function)
(setf mime-type) (generic function)
:buffer-view
buffer-view (generic function)
(setf buffer-view) (generic function)
An element that has a base index within the gltf file’s collection.
See GLTF-ELEMENT
See IDX
format.lisp (file)
gltf-element (class)
:idx
idx (generic function)
(setf idx) (generic function)
Representation of a mesh material description.
See INDEXED-ELEMENT
See NAMED-ELEMENT
See PBR
See NORMAL-TEXTURE
See OCCLUSION-TEXTURE
See EMISSIVE-TEXTURE
See EMISSIVE-FACTOR
See ALPHA-MODE
See ALPHA-CUTOFF
See DOUBLE-SIDED-P
format.lisp (file)
:pbr
pbr (generic function)
(setf pbr) (generic function)
:normal-texture
normal-texture (generic function)
(setf normal-texture) (generic function)
:occlusion-texture
occlusion-texture (generic function)
(setf occlusion-texture) (generic function)
:emissive-texture
emissive-texture (generic function)
(setf emissive-texture) (generic function)
:emissive-factor
#(0.0 0.0 0.0)
emissive-factor (generic function)
(setf emissive-factor) (generic function)
:alpha-mode
:opaque
alpha-mode (generic function)
(setf alpha-mode) (generic function)
:alpha-cutoff
0.5
alpha-cutoff (generic function)
(setf alpha-cutoff) (generic function)
:double-sided-p
double-sided-p (generic function)
(setf double-sided-p) (generic function)
Representation of a mesh.
See INDEXED-ELEMENT
See NAMED-ELEMENT
See PRIMITIVES
See WEIGHTS
format.lisp (file)
:primitives
#()
primitives (generic function)
(setf primitives) (generic function)
:weights
weights (generic function)
(setf weights) (generic function)
Representation of a mesh primitive – a singular geometric object of a consistent material.
See GLTF-ELEMENT
See ATTRIBUTES
See INDICES
See MATERIAL
See MODE
See TARGETS
format.lisp (file)
gltf-element (class)
:attributes
#()
attributes (generic function)
(setf attributes) (generic function)
:indices
#()
indices (generic function)
(setf indices) (generic function)
:material
material (generic function)
(setf material) (generic function)
:mode
:triangles
mode (generic function)
(setf mode) (generic function)
:targets
targets (generic function)
(setf targets) (generic function)
An element with a potential name attached.
See GLTF-ELEMENT
See NAME
format.lisp (file)
gltf-element (class)
:name
name (generic function)
(setf name) (generic function)
Represents a node in the scene graph.
A node may have transformation information associated with it, as well
as several child nodes or a mesh. A node may also not have any
children or meshes, such as in the case of bones or cameras.
See CAMERA
See PARENT
See CHILDREN
See SKIN
See MESH
See MATRIX
See ROTATION
See SCALE
See TRANSLATION
See WEIGHTS
format.lisp (file)
:camera
camera (generic function)
(setf camera) (generic function)
parent (generic function)
(setf parent) (generic function)
:children
#()
children (generic function)
(setf children) (generic function)
:skin
skin (generic function)
(setf skin) (generic function)
:mesh
mesh (generic function)
(setf mesh) (generic function)
:matrix
matrix (generic function)
(setf matrix) (generic function)
:rotation
rotation (generic function)
(setf rotation) (generic function)
:scale
scale (generic function)
(setf scale) (generic function)
:translation
translation (generic function)
(setf translation) (generic function)
:weights
weights (generic function)
(setf weights) (generic function)
Representation of an orthographic projection camera.
See CAMERA
See XMAG
See YMAG
See ZFAR
See ZNEAR
format.lisp (file)
camera (class)
:xmag
xmag (generic function)
(setf xmag) (generic function)
:ymag
ymag (generic function)
(setf ymag) (generic function)
:zfar
zfar (generic function)
(setf zfar) (generic function)
:znear
znear (generic function)
(setf znear) (generic function)
Representation of the PBR attributes used for a material.
See GLTF-ELEMENT
See ALBEDO
See ALBEDO-FACTOR
See METALLIC-FACTOR
See ROUGHNESS-FACTOR
See METALLIC-ROUGHNESS
format.lisp (file)
gltf-element (class)
:albedo
albedo (generic function)
(setf albedo) (generic function)
:albedo-factor
#(1.0 1.0 1.0 1.0)
albedo-factor (generic function)
(setf albedo-factor) (generic function)
:metallic-factor
1.0
metallic-factor (generic function)
(setf metallic-factor) (generic function)
:roughness-factor
1.0
roughness-factor (generic function)
(setf roughness-factor) (generic function)
:matallic-roughness
matallic-roughness (generic function)
(setf matallic-roughness) (generic function)
Representation of a perspective projection camera.
See CAMERA
See ASPECT-RATIO
See FOV
See ZFAR
See ZNEAR
format.lisp (file)
camera (class)
:aspect-ratio
aspect-ratio (generic function)
(setf aspect-ratio) (generic function)
:fov
fov (generic function)
(setf fov) (generic function)
:zfar
zfar (generic function)
(setf zfar) (generic function)
:znear
znear (generic function)
(setf znear) (generic function)
Representation of a texture sampler.
See INDEXED-ELEMENT
See NAMED-ELEMENT
See MAG-FILTER
See MIN-FILTER
See WRAP-S
See WRAP-T
format.lisp (file)
:mag-filter
:linear
mag-filter (generic function)
(setf mag-filter) (generic function)
:min-filter
:linear
min-filter (generic function)
(setf min-filter) (generic function)
:wrap-s
:repeat
wrap-s (generic function)
(setf wrap-s) (generic function)
:wrap-t
:repeat
wrap-t (generic function)
(setf wrap-t) (generic function)
Represents a the root node of a scene.
See INDEXED-ELEMENT
See NAMED-ELEMENT
See NODES
format.lisp (file)
:nodes
#()
nodes (generic function)
(setf nodes) (generic function)
Representation of a mesh’s skinning information.
See INDEXED-ELEMENT
See NAMED-ELEMENT
See INVERSE-BIND-MATRICES
See SKELETON
See JOINTS
format.lisp (file)
:inverse-bind-matrices
inverse-bind-matrices (generic function)
(setf inverse-bind-matrices) (generic function)
:skeleton
skeleton (generic function)
(setf skeleton) (generic function)
:joints
#()
joints (generic function)
(setf joints) (generic function)
Representation of a texture.
See INDEXED-ELEMENT
See NAMED-ELEMENT
See SAMPLER
See SOURCE
format.lisp (file)
:sampler
sampler (generic function)
(setf sampler) (generic function)
:source
source (generic function)
(setf source) (generic function)
Representation of additional texture information.
See GLTF-ELEMENT
See TEXTURE
See TEX-COORD
See SCALE
See STRENGTH
format.lisp (file)
gltf-element (class)
:texture
texture (generic function)
(setf texture) (generic function)
:tex-coord
0
tex-coord (generic function)
(setf tex-coord) (generic function)
:scale
1.0
scale (generic function)
(setf scale) (generic function)
:strength
1.0
strength (generic function)
(setf strength) (generic function)
An element with a URI attached.
See GLTF-ELEMENT
See URI
See PATH
format.lisp (file)
gltf-element (class)
:uri
uri (generic function)
(setf uri) (generic function)
Previous: Exported definitions, Up: Definitions [Contents][Index]
• Internal special variables | ||
• Internal macros | ||
• Internal functions | ||
• Internal generic functions | ||
• Internal classes |
Next: Internal macros, Previous: Internal definitions, Up: Internal definitions [Contents][Index]
element.lisp (file)
Next: Internal functions, Previous: Internal special variables, Up: Internal definitions [Contents][Index]
element.lisp (file)
accessor.lisp (file)
Next: Internal generic functions, Previous: Internal macros, Up: Internal definitions [Contents][Index]
element.lisp (file)
element.lisp (file)
parser.lisp (file)
element.lisp (file)
element.lisp (file)
Next: Internal classes, Previous: Internal functions, Up: Internal definitions [Contents][Index]
accessor.lisp (file)
accessor.lisp (file)
element.lisp (file)
append (short method combination)
Options: :most-specific-first
accessor.lisp (file)
accessor.lisp (file)
accessor.lisp (file)
format.lisp (file)
format.lisp (file)
format.lisp (file)
format.lisp (file)
format.lisp (file)
format.lisp (file)
format.lisp (file)
format.lisp (file)
format.lisp (file)
format.lisp (file)
format.lisp (file)
format.lisp (file)
format.lisp (file)
format.lisp (file)
format.lisp (file)
format.lisp (file)
format.lisp (file)
format.lisp (file)
format.lisp (file)
format.lisp (file)
format.lisp (file)
format.lisp (file)
format.lisp (file)
format.lisp (file)
accessor.lisp (file)
automatically generated reader method
format.lisp (file)
automatically generated writer method
format.lisp (file)
automatically generated reader method
accessor.lisp (file)
accessor.lisp (file)
parser.lisp (file)
parser.lisp (file)
parser.lisp (file)
parser.lisp (file)
Previous: Internal generic functions, Up: Internal definitions [Contents][Index]
accessor.lisp (file)
buffer (class)
mmap (generic function)
accessor.lisp (file)
accessor (class)
accessor.lisp (file)
buffer (class)
uri-buffer (class)
:buffer
buffer (generic function)
accessor.lisp (file)
static-buffer (class)
shared-initialize (method)
Previous: Definitions, Up: Top [Contents][Index]
• Concept index | ||
• Function index | ||
• Variable index | ||
• Data type index |
Next: Function index, Previous: Indexes, Up: Indexes [Contents][Index]
Jump to: | C F L |
---|
Jump to: | C F L |
---|
Next: Variable index, Previous: Concept index, Up: Indexes [Contents][Index]
Jump to: | (
A B C D E F G I J L M N O P R S T U V W X Y Z |
---|
Jump to: | (
A B C D E F G I J L M N O P R S T U V W X Y Z |
---|
Next: Data type index, Previous: Function index, Up: Indexes [Contents][Index]
Jump to: | *
A B C D E F G I J M N O P R S T U V W X Y Z |
---|
Jump to: | *
A B C D E F G I J M N O P R S T U V W X Y Z |
---|
Previous: Variable index, Up: Indexes [Contents][Index]
Jump to: | A B C G I M N O P S T U |
---|
Jump to: | A B C G I M N O P S T U |
---|