The cl-ktx2 Reference Manual

Child Components

package.lisp (file).
ktx.lisp (file).
kv.lisp (file).
gl.lisp (file).
documentation.lisp (file).

Next: Packages, Previous: Systems, Up: The cl-ktx2 Reference Manual [Contents][Index]

3 Files

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

Lisp

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

Next: cl-ktx2/package.lisp, Previous: Lisp, Up: Lisp [Contents][Index]

3.1.1 `cl-ktx2/cl-ktx2.asd`

Source: cl-ktx2.asd.
Parent Component: cl-ktx2 (system).
ASDF Systems: cl-ktx2.

Next: cl-ktx2/ktx.lisp, Previous: cl-ktx2/cl-ktx2.asd, Up: Lisp [Contents][Index]

3.1.2 `cl-ktx2/package.lisp`

Source: cl-ktx2.asd.
Parent Component: cl-ktx2 (system).
Packages: org.shirakumo.ktx2.

Next: cl-ktx2/kv.lisp, Previous: cl-ktx2/package.lisp, Up: Lisp [Contents][Index]

3.1.3 `cl-ktx2/ktx.lisp`

Dependency

package.lisp (file).

Source

Parent Component

cl-ktx2 (system).

Public Interface

data-format-descriptors (function).
decode-kv-entry-value (generic function).
depth (function).
(setf depth) (function).
describe-object (method).
descriptor-block (structure).
descriptor-block-data (reader).
(setf descriptor-block-data) (writer).
descriptor-block-size (reader).
(setf descriptor-block-size) (writer).
descriptor-block-type (function).
descriptor-block-vendor-id (function).
descriptor-block-version (reader).
(setf descriptor-block-version) (writer).
dfd-store (reader).
(setf dfd-store) (writer).
encode-kv-entry-value (generic function).
face-count (function).
(setf face-count) (function).
file (structure).
height (function).
(setf height) (function).
khronos-basic-data-format-descriptor-block (structure).
khronos-basic-data-format-descriptor-block-bytes-planes (reader).
(setf khronos-basic-data-format-descriptor-block-bytes-planes) (writer).
khronos-basic-data-format-descriptor-block-color-model (reader).
(setf khronos-basic-data-format-descriptor-block-color-model) (writer).
khronos-basic-data-format-descriptor-block-color-primaries (reader).
(setf khronos-basic-data-format-descriptor-block-color-primaries) (writer).
khronos-basic-data-format-descriptor-block-flags (reader).
(setf khronos-basic-data-format-descriptor-block-flags) (writer).
khronos-basic-data-format-descriptor-block-samples (reader).
(setf khronos-basic-data-format-descriptor-block-samples) (writer).
khronos-basic-data-format-descriptor-block-size (reader).
(setf khronos-basic-data-format-descriptor-block-size) (writer).
khronos-basic-data-format-descriptor-block-texel-block-dimensions (reader).
(setf khronos-basic-data-format-descriptor-block-texel-block-dimensions) (writer).
khronos-basic-data-format-descriptor-block-transfer-function (reader).
(setf khronos-basic-data-format-descriptor-block-transfer-function) (writer).
kv-entry (structure).
kv-entry-key (function).
kv-entry-value (function).
kvd-store (reader).
(setf kvd-store) (writer).
layer-count (function).
(setf layer-count) (function).
level (structure).
level-count (function).
(setf level-count) (function).
level-images (reader).
(setf level-images) (writer).
level-length (reader).
(setf level-length) (writer).
level-offset (reader).
(setf level-offset) (writer).
level-uncompressed-length (reader).
(setf level-uncompressed-length) (writer).
levels (reader).
(setf levels) (writer).
metadata (function).
(setf metadata) (function).
octet-size (method).
octet-size (method).
octet-size (method).
octet-size (method).
octet-size (method).
octet-size (method).
octet-size (method).
print-object (method).
print-object (method).
read-file (function).
sample-information (structure).
sample-information-bit-length (reader).
(setf sample-information-bit-length) (writer).
sample-information-bit-offset (reader).
(setf sample-information-bit-offset) (writer).
sample-information-channel-type (reader).
(setf sample-information-channel-type) (writer).
sample-information-lower (reader).
(setf sample-information-lower) (writer).
sample-information-positions (reader).
(setf sample-information-positions) (writer).
sample-information-upper (reader).
(setf sample-information-upper) (writer).
supercompression-global-data (reader).
(setf supercompression-global-data) (writer).
supercompression-scheme (function).
(setf supercompression-scheme) (function).
tell-file (function).
type-size (function).
(setf type-size) (function).
vk-format (function).
(setf vk-format) (function).
width (function).
(setf width) (function).
write-file (function).

Internals

copy-descriptor-block (function).
copy-file (function).
copy-header (function).
copy-khronos-basic-data-format-descriptor-block (function).
copy-kv-entry (function).
copy-level (function).
copy-sample-information (function).
create-file (function).
descriptor-block-id (reader).
(setf descriptor-block-id) (writer).
descriptor-block-p (function).
dfd-length (reader).
(setf dfd-length) (writer).
dfd-offset (reader).
(setf dfd-offset) (writer).
file-p (function).
header (structure).
header-depth (reader).
(setf header-depth) (writer).
header-face-count (reader).
(setf header-face-count) (writer).
header-height (reader).
(setf header-height) (writer).
header-layer-count (reader).
(setf header-layer-count) (writer).
header-level-count (reader).
(setf header-level-count) (writer).
header-p (function).
header-supercompression-scheme (reader).
(setf header-supercompression-scheme) (writer).
header-type-size (reader).
(setf header-type-size) (writer).
header-vk-format (reader).
(setf header-vk-format) (writer).
header-width (reader).
(setf header-width) (writer).
khronos-basic-data-format-descriptor-block-p (function).
kv-entry-kv (reader).
(setf kv-entry-kv) (writer).
kv-entry-p (function).
kv-entry-size (reader).
(setf kv-entry-size) (writer).
kvd-length (reader).
(setf kvd-length) (writer).
kvd-offset (reader).
(setf kvd-offset) (writer).
kw (function).
level-p (function).
make-descriptor-block (function).
make-file (function).
make-header (function).
make-khronos-basic-data-format-descriptor-block (function).
make-kv-entry (function).
make-level (function).
make-sample-information (function).
read-descriptor-block (function).
read-header (function).
read-io-foreign-pointer-descriptor-block (function).
read-io-foreign-pointer-file (function).
read-io-foreign-pointer-header (function).
read-io-foreign-pointer-khronos-basic-data-format-descriptor-block (function).
read-io-foreign-pointer-kv-entry (function).
read-io-foreign-pointer-level (function).
read-io-foreign-pointer-sample-information (function).
read-io-octet-vector-descriptor-block (function).
read-io-octet-vector-file (function).
read-io-octet-vector-header (function).
read-io-octet-vector-khronos-basic-data-format-descriptor-block (function).
read-io-octet-vector-kv-entry (function).
read-io-octet-vector-level (function).
read-io-octet-vector-sample-information (function).
read-io-stream-descriptor-block (function).
read-io-stream-file (function).
read-io-stream-header (function).
read-io-stream-khronos-basic-data-format-descriptor-block (function).
read-io-stream-kv-entry (function).
read-io-stream-level (function).
read-io-stream-sample-information (function).
read-khronos-basic-data-format-descriptor-block (function).
read-kv-entry (function).
read-level (function).
read-sample-information (function).
sample-information-p (function).
sgd-length (reader).
(setf sgd-length) (writer).
sgd-offset (reader).
(setf sgd-offset) (writer).
write-descriptor-block (function).
write-header (function).
write-io-foreign-pointer-descriptor-block (function).
write-io-foreign-pointer-file (function).
write-io-foreign-pointer-header (function).
write-io-foreign-pointer-khronos-basic-data-format-descriptor-block (function).
write-io-foreign-pointer-kv-entry (function).
write-io-foreign-pointer-level (function).
write-io-foreign-pointer-sample-information (function).
write-io-octet-vector-descriptor-block (function).
write-io-octet-vector-file (function).
write-io-octet-vector-header (function).
write-io-octet-vector-khronos-basic-data-format-descriptor-block (function).
write-io-octet-vector-kv-entry (function).
write-io-octet-vector-level (function).
write-io-octet-vector-sample-information (function).
write-io-stream-descriptor-block (function).
write-io-stream-file (function).
write-io-stream-header (function).
write-io-stream-khronos-basic-data-format-descriptor-block (function).
write-io-stream-kv-entry (function).
write-io-stream-level (function).
write-io-stream-sample-information (function).
write-khronos-basic-data-format-descriptor-block (function).
write-kv-entry (function).
write-level (function).
write-sample-information (function).

Next: cl-ktx2/gl.lisp, Previous: cl-ktx2/ktx.lisp, Up: Lisp [Contents][Index]

3.1.4 `cl-ktx2/kv.lisp`

Dependency

ktx.lisp (file).

Source

Parent Component

cl-ktx2 (system).

Public Interface

decode-kv-entry-value (method).
decode-kv-entry-value (method).
decode-kv-entry-value (method).
decode-kv-entry-value (method).
decode-kv-entry-value (method).
decode-kv-entry-value (method).
decode-kv-entry-value (method).
decode-kv-entry-value (method).
decode-kv-entry-value (method).
decode-kv-entry-value (method).
decode-kv-entry-value (method).
decode-kv-entry-value (method).
encode-kv-entry-value (method).
encode-kv-entry-value (method).
encode-kv-entry-value (method).
encode-kv-entry-value (method).
encode-kv-entry-value (method).
encode-kv-entry-value (method).
encode-kv-entry-value (method).

Next: cl-ktx2/documentation.lisp, Previous: cl-ktx2/kv.lisp, Up: Lisp [Contents][Index]

3.1.5 `cl-ktx2/gl.lisp`

Dependency

kv.lisp (file).

Source

Parent Component

cl-ktx2 (system).

Public Interface

gl-flags (function).
gl-format (function).
gl-internal-format (function).
gl-texture-target (function).
gl-type (function).

Internals

compile-gl-mappings (function).
convert-enum-name (function).
infer-gl-flags (function).
prefix-p (function).
strip-prefix (function).

Previous: cl-ktx2/gl.lisp, Up: Lisp [Contents][Index]

3.1.6 `cl-ktx2/documentation.lisp`

Dependency: gl.lisp (file).
Source: cl-ktx2.asd.
Parent Component: cl-ktx2 (system).

Next: Definitions, Previous: Files, Up: The cl-ktx2 Reference Manual [Contents][Index]

4 Packages

Packages are listed by definition order.

org.shirakumo.ktx2

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

4.1 `org.shirakumo.ktx2`

Source

package.lisp.

Use List

common-lisp.
org.shirakumo.binary-structures.types.

Public Interface

data-format-descriptors (function).
decode-kv-entry-value (generic function).
depth (function).
(setf depth) (function).
descriptor-block (structure).
descriptor-block-data (reader).
(setf descriptor-block-data) (writer).
descriptor-block-size (reader).
(setf descriptor-block-size) (writer).
descriptor-block-type (function).
descriptor-block-vendor-id (function).
descriptor-block-version (reader).
(setf descriptor-block-version) (writer).
dfd-store (reader).
(setf dfd-store) (writer).
encode-kv-entry-value (generic function).
face-count (function).
(setf face-count) (function).
file (structure).
gl-flags (function).
gl-format (function).
gl-internal-format (function).
gl-texture-target (function).
gl-type (function).
height (function).
(setf height) (function).
khronos-basic-data-format-descriptor-block (structure).
khronos-basic-data-format-descriptor-block-bytes-planes (reader).
(setf khronos-basic-data-format-descriptor-block-bytes-planes) (writer).
khronos-basic-data-format-descriptor-block-color-model (reader).
(setf khronos-basic-data-format-descriptor-block-color-model) (writer).
khronos-basic-data-format-descriptor-block-color-primaries (reader).
(setf khronos-basic-data-format-descriptor-block-color-primaries) (writer).
khronos-basic-data-format-descriptor-block-flags (reader).
(setf khronos-basic-data-format-descriptor-block-flags) (writer).
khronos-basic-data-format-descriptor-block-samples (reader).
(setf khronos-basic-data-format-descriptor-block-samples) (writer).
khronos-basic-data-format-descriptor-block-size (reader).
(setf khronos-basic-data-format-descriptor-block-size) (writer).
khronos-basic-data-format-descriptor-block-texel-block-dimensions (reader).
(setf khronos-basic-data-format-descriptor-block-texel-block-dimensions) (writer).
khronos-basic-data-format-descriptor-block-transfer-function (reader).
(setf khronos-basic-data-format-descriptor-block-transfer-function) (writer).
kv-entry (structure).
kv-entry-key (function).
kv-entry-value (function).
kvd-store (reader).
(setf kvd-store) (writer).
layer-count (function).
(setf layer-count) (function).
level (structure).
level-count (function).
(setf level-count) (function).
level-images (reader).
(setf level-images) (writer).
level-length (reader).
(setf level-length) (writer).
level-offset (reader).
(setf level-offset) (writer).
level-uncompressed-length (reader).
(setf level-uncompressed-length) (writer).
levels (reader).
(setf levels) (writer).
metadata (function).
(setf metadata) (function).
read-file (function).
sample-information (structure).
sample-information-bit-length (reader).
(setf sample-information-bit-length) (writer).
sample-information-bit-offset (reader).
(setf sample-information-bit-offset) (writer).
sample-information-channel-type (reader).
(setf sample-information-channel-type) (writer).
sample-information-lower (reader).
(setf sample-information-lower) (writer).
sample-information-positions (reader).
(setf sample-information-positions) (writer).
sample-information-upper (reader).
(setf sample-information-upper) (writer).
supercompression-global-data (reader).
(setf supercompression-global-data) (writer).
supercompression-scheme (function).
(setf supercompression-scheme) (function).
tell-file (function).
type-size (function).
(setf type-size) (function).
vk-format (function).
(setf vk-format) (function).
width (function).
(setf width) (function).
write-file (function).

Internals

compile-gl-mappings (function).
convert-enum-name (function).
copy-descriptor-block (function).
copy-file (function).
copy-header (function).
copy-khronos-basic-data-format-descriptor-block (function).
copy-kv-entry (function).
copy-level (function).
copy-sample-information (function).
create-file (function).
descriptor-block-id (reader).
(setf descriptor-block-id) (writer).
descriptor-block-p (function).
dfd-length (reader).
(setf dfd-length) (writer).
dfd-offset (reader).
(setf dfd-offset) (writer).
file-p (function).
header (structure).
header-depth (reader).
(setf header-depth) (writer).
header-face-count (reader).
(setf header-face-count) (writer).
header-height (reader).
(setf header-height) (writer).
header-layer-count (reader).
(setf header-layer-count) (writer).
header-level-count (reader).
(setf header-level-count) (writer).
header-p (function).
header-supercompression-scheme (reader).
(setf header-supercompression-scheme) (writer).
header-type-size (reader).
(setf header-type-size) (writer).
header-vk-format (reader).
(setf header-vk-format) (writer).
header-width (reader).
(setf header-width) (writer).
infer-gl-flags (function).
khronos-basic-data-format-descriptor-block-p (function).
kv-entry-kv (reader).
(setf kv-entry-kv) (writer).
kv-entry-p (function).
kv-entry-size (reader).
(setf kv-entry-size) (writer).
kvd-length (reader).
(setf kvd-length) (writer).
kvd-offset (reader).
(setf kvd-offset) (writer).
kw (function).
level-p (function).
make-descriptor-block (function).
make-file (function).
make-header (function).
make-khronos-basic-data-format-descriptor-block (function).
make-kv-entry (function).
make-level (function).
make-sample-information (function).
prefix-p (function).
read-descriptor-block (function).
read-header (function).
read-io-foreign-pointer-descriptor-block (function).
read-io-foreign-pointer-file (function).
read-io-foreign-pointer-header (function).
read-io-foreign-pointer-khronos-basic-data-format-descriptor-block (function).
read-io-foreign-pointer-kv-entry (function).
read-io-foreign-pointer-level (function).
read-io-foreign-pointer-sample-information (function).
read-io-octet-vector-descriptor-block (function).
read-io-octet-vector-file (function).
read-io-octet-vector-header (function).
read-io-octet-vector-khronos-basic-data-format-descriptor-block (function).
read-io-octet-vector-kv-entry (function).
read-io-octet-vector-level (function).
read-io-octet-vector-sample-information (function).
read-io-stream-descriptor-block (function).
read-io-stream-file (function).
read-io-stream-header (function).
read-io-stream-khronos-basic-data-format-descriptor-block (function).
read-io-stream-kv-entry (function).
read-io-stream-level (function).
read-io-stream-sample-information (function).
read-khronos-basic-data-format-descriptor-block (function).
read-kv-entry (function).
read-level (function).
read-sample-information (function).
sample-information-p (function).
sgd-length (reader).
(setf sgd-length) (writer).
sgd-offset (reader).
(setf sgd-offset) (writer).
strip-prefix (function).
write-descriptor-block (function).
write-header (function).
write-io-foreign-pointer-descriptor-block (function).
write-io-foreign-pointer-file (function).
write-io-foreign-pointer-header (function).
write-io-foreign-pointer-khronos-basic-data-format-descriptor-block (function).
write-io-foreign-pointer-kv-entry (function).
write-io-foreign-pointer-level (function).
write-io-foreign-pointer-sample-information (function).
write-io-octet-vector-descriptor-block (function).
write-io-octet-vector-file (function).
write-io-octet-vector-header (function).
write-io-octet-vector-khronos-basic-data-format-descriptor-block (function).
write-io-octet-vector-kv-entry (function).
write-io-octet-vector-level (function).
write-io-octet-vector-sample-information (function).
write-io-stream-descriptor-block (function).
write-io-stream-file (function).
write-io-stream-header (function).
write-io-stream-khronos-basic-data-format-descriptor-block (function).
write-io-stream-kv-entry (function).
write-io-stream-level (function).
write-io-stream-sample-information (function).
write-khronos-basic-data-format-descriptor-block (function).
write-kv-entry (function).
write-level (function).
write-sample-information (function).

Next: Indexes, Previous: Packages, Up: The cl-ktx2 Reference Manual [Contents][Index]

5 Definitions

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

Public Interface
Internals

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

5.1 Public Interface

Ordinary functions
Generic functions
Standalone methods
Structures

Next: Generic functions, Previous: Public Interface, Up: Public Interface [Contents][Index]

5.1.1 Ordinary functions

Function: data-format-descriptors (file) ¶

Returns the vector of DESCRIPTOR-BLOCK instances.

The descriptors are decoded to their specific type if it is known. Otherwise an opaque DESCRIPTOR-BLOCK instance is used.

See FILE (type)

Package: org.shirakumo.ktx2.
Source: ktx.lisp.

Function: depth (instance) ¶

Returns the number of pixels in depth (if 3D).

See FILE (type)

Package: org.shirakumo.ktx2.
Source: ktx.lisp.

Function: (setf depth) (instance) ¶

Package: org.shirakumo.ktx2.
Source: ktx.lisp.

Reader: descriptor-block-data (instance) ¶

Returns the octet vector holding the descriptor block’s data payload.

See DESCRIPTOR-BLOCK (type)

Package: org.shirakumo.ktx2.
Source: ktx.lisp.
Target Slot: data.

Writer: (setf descriptor-block-data) (instance) ¶

Package: org.shirakumo.ktx2.
Source: ktx.lisp.
Target Slot: data.

Reader: descriptor-block-size (instance) ¶

Returns the size of the descriptor block in octets.

See DESCRIPTOR-BLOCK (type)

Package: org.shirakumo.ktx2.
Source: ktx.lisp.
Target Slot: size.

Writer: (setf descriptor-block-size) (instance) ¶

Package: org.shirakumo.ktx2.
Source: ktx.lisp.
Target Slot: size.

Function: descriptor-block-type (block) ¶

Returns the 15-bit type ID of the descriptor block.

See DESCRIPTOR-BLOCK (type)

Package: org.shirakumo.ktx2.
Source: ktx.lisp.

Function: descriptor-block-vendor-id (block) ¶

Returns the 17-bit vendor ID of the descriptor block.

See DESCRIPTOR-BLOCK (type)

Package: org.shirakumo.ktx2.
Source: ktx.lisp.

Reader: descriptor-block-version (instance) ¶

Returns the 16-bit version of the descriptor block.

See DESCRIPTOR-BLOCK (type)

Package: org.shirakumo.ktx2.
Source: ktx.lisp.
Target Slot: version.

Writer: (setf descriptor-block-version) (instance) ¶

Package: org.shirakumo.ktx2.
Source: ktx.lisp.
Target Slot: version.

Reader: dfd-store (instance) ¶

Returns the raw data format descriptors octet vector.

See DATA-FORMAT-DESCRIPTORS
See FILE (type)

Package: org.shirakumo.ktx2.
Source: ktx.lisp.
Target Slot: dfd-store.

Writer: (setf dfd-store) (instance) ¶

Package: org.shirakumo.ktx2.
Source: ktx.lisp.
Target Slot: dfd-store.

Function: face-count (instance) ¶

Returns the number of faces (if a cubemap).

See FILE (type)

Package: org.shirakumo.ktx2.
Source: ktx.lisp.

Function: (setf face-count) (instance) ¶

Package: org.shirakumo.ktx2.
Source: ktx.lisp.

Function: gl-flags (file) ¶

Returns a plist of OpenGL flags describing the image properties.

The keys are:
:TYPE
:FORMAT
:INTERNAL-FORMAT

This uses the KTXglFormat kv-pair if provided, or derives the values from the vk-format if not.

See GL-TYPE
See GL-INTERNAL-FORMAT
See GL-FORMAT
See VK-FORMAT
See FILE (type)

Package: org.shirakumo.ktx2.
Source: gl.lisp.

Function: gl-format (file) ¶

Returns the texture pixel format.

See GL-FLAGS
See FILE (type)

Package: org.shirakumo.ktx2.
Source: gl.lisp.

Function: gl-internal-format (file) ¶

Returns the texture internal format.

See GL-FLAGS
See FILE (type)

Package: org.shirakumo.ktx2.
Source: gl.lisp.

Function: gl-texture-target (file) ¶

Returns the texture target for the image type.

Can be one of:
:TEXTURE-3D
:TEXTURE-CUBE-MAP
:TEXTURE-2D
:TEXTURE-1D
:TEXTURE-3D-ARRAY :TEXTURE-CUBE-MAP-ARRAY :TEXTURE-2D-ARRAY
:TEXTURE-1D-ARRAY

See FILE (type)

Package: org.shirakumo.ktx2.
Source: gl.lisp.

Function: gl-type (file) ¶

Returns the texture pixel type.

See GL-FLAGS
See FILE (type)

Package: org.shirakumo.ktx2.
Source: gl.lisp.

Function: height (instance) ¶

Returns the number of pixels in height (if 2D or 3D).

See FILE (type)

Package: org.shirakumo.ktx2.
Source: ktx.lisp.

Function: (setf height) (instance) ¶

Package: org.shirakumo.ktx2.
Source: ktx.lisp.

Reader: khronos-basic-data-format-descriptor-block-bytes-planes (instance) ¶

Vector describing the number of bytes the format uses per pixel plane/channel.

See KHRONOS-BASIC-DATA-FORMAT-DESCRIPTOR-BLOCK (type)

Package: org.shirakumo.ktx2.
Source: ktx.lisp.
Target Slot: bytes-planes.

Writer: (setf khronos-basic-data-format-descriptor-block-bytes-planes) (instance) ¶

Package: org.shirakumo.ktx2.
Source: ktx.lisp.
Target Slot: bytes-planes.

Reader: khronos-basic-data-format-descriptor-block-color-model (instance) ¶

Returns the color model descriptor as a keyword symbol.

See KHRONOS-BASIC-DATA-FORMAT-DESCRIPTOR-BLOCK (type)

Package: org.shirakumo.ktx2.
Source: ktx.lisp.
Target Slot: color-model.

Writer: (setf khronos-basic-data-format-descriptor-block-color-model) (instance) ¶

Package: org.shirakumo.ktx2.
Source: ktx.lisp.
Target Slot: color-model.

Reader: khronos-basic-data-format-descriptor-block-color-primaries (instance) ¶

Returns the description of the color primaries as a keyword symbol.

See KHRONOS-BASIC-DATA-FORMAT-DESCRIPTOR-BLOCK (type)

Package: org.shirakumo.ktx2.
Source: ktx.lisp.
Target Slot: color-primaries.

Writer: (setf khronos-basic-data-format-descriptor-block-color-primaries) (instance) ¶

Package: org.shirakumo.ktx2.
Source: ktx.lisp.
Target Slot: color-primaries.

Reader: khronos-basic-data-format-descriptor-block-flags (instance) ¶

Returns the colour flags as a bitmask.

The bits are as follows:
0: premultiplied-alpha

See KHRONOS-BASIC-DATA-FORMAT-DESCRIPTOR-BLOCK (type)

Package: org.shirakumo.ktx2.
Source: ktx.lisp.
Target Slot: flags.

Writer: (setf khronos-basic-data-format-descriptor-block-flags) (instance) ¶

Package: org.shirakumo.ktx2.
Source: ktx.lisp.
Target Slot: flags.

Reader: khronos-basic-data-format-descriptor-block-samples (instance) ¶

Returns a vector of SAMPLE-INFORMATION instances.

See KHRONOS-BASIC-DATA-FORMAT-DESCRIPTOR-BLOCK (type)

Package: org.shirakumo.ktx2.
Source: ktx.lisp.
Target Slot: samples.

Writer: (setf khronos-basic-data-format-descriptor-block-samples) (instance) ¶

Package: org.shirakumo.ktx2.
Source: ktx.lisp.
Target Slot: samples.

Reader: khronos-basic-data-format-descriptor-block-size (instance) ¶

Writer: (setf khronos-basic-data-format-descriptor-block-size) (instance) ¶

Package: org.shirakumo.ktx2.
Source: ktx.lisp.
Target Slot: size.

Reader: khronos-basic-data-format-descriptor-block-texel-block-dimensions (instance) ¶

Vector describing the range of coordinates covered by each texel block in that dimension.

See KHRONOS-BASIC-DATA-FORMAT-DESCRIPTOR-BLOCK (type)

Package: org.shirakumo.ktx2.
Source: ktx.lisp.
Target Slot: texel-block-dimensions.

Writer: (setf khronos-basic-data-format-descriptor-block-texel-block-dimensions) (instance) ¶

Package: org.shirakumo.ktx2.
Source: ktx.lisp.
Target Slot: texel-block-dimensions.

Reader: khronos-basic-data-format-descriptor-block-transfer-function (instance) ¶

Returns the description of the color transfer function as a keyword symbol.

See KHRONOS-BASIC-DATA-FORMAT-DESCRIPTOR-BLOCK (type)

Package: org.shirakumo.ktx2.
Source: ktx.lisp.
Target Slot: transfer-function.

Writer: (setf khronos-basic-data-format-descriptor-block-transfer-function) (instance) ¶

Package: org.shirakumo.ktx2.
Source: ktx.lisp.
Target Slot: transfer-function.

Function: kv-entry-key (kv-entry) ¶

Returns the key of the entry as a string.

See KV-ENTRY (type)

Package: org.shirakumo.ktx2.
Source: ktx.lisp.

Function: kv-entry-value (kv-entry) ¶

Accesses the value of the entry.

The value is decoded/encoded if the key is known. If it is not known, the value is an octet-vector.

Known keys are:
KTXcubemapIncomplete
KTXorientation
KTXglFormat
KTXdxgiFormat__
KTXmetalPixelFormat
KTXswizzle
KTXwriter
KTXwriterScParams
KTXanimData

See KV-ENTRY (type)
See DECODE-KV-ENTRY-VALUE
See ENCODE-KV-ENTRY-VALUE

Package: org.shirakumo.ktx2.
Source: ktx.lisp.

Reader: kvd-store (instance) ¶

Returns the raw key-value store octet vector.

See METADATA
See FILE (type)

Package: org.shirakumo.ktx2.
Source: ktx.lisp.
Target Slot: kvd-store.

Writer: (setf kvd-store) (instance) ¶

Package: org.shirakumo.ktx2.
Source: ktx.lisp.
Target Slot: kvd-store.

Function: layer-count (instance) ¶

Returns the number of image layers (if an array).

See FILE (type)

Package: org.shirakumo.ktx2.
Source: ktx.lisp.

Function: (setf layer-count) (instance) ¶

Package: org.shirakumo.ktx2.
Source: ktx.lisp.

Function: level-count (instance) ¶

Returns the number of mipmap levels.

See FILE (type)

Package: org.shirakumo.ktx2.
Source: ktx.lisp.

Function: (setf level-count) (instance) ¶

Package: org.shirakumo.ktx2.
Source: ktx.lisp.

Reader: level-images (instance) ¶

Returns the vector of octet-vectors that make up the mipmap level images.

See FILE (type)

Package: org.shirakumo.ktx2.
Source: ktx.lisp.
Target Slot: level-images.

Writer: (setf level-images) (instance) ¶

Package: org.shirakumo.ktx2.
Source: ktx.lisp.
Target Slot: level-images.

Reader: level-length (instance) ¶

Returns the number of octets of the mipmap level.

This should typically not be necessary to access directly.

See LEVEL (type)

Package: org.shirakumo.ktx2.
Source: ktx.lisp.
Target Slot: length.

Writer: (setf level-length) (instance) ¶

Package: org.shirakumo.ktx2.
Source: ktx.lisp.
Target Slot: length.

Reader: level-offset (instance) ¶

Returns the number of octets since the start of the file at which the mipmap level starts.

This should typically not be necessary to access directly.

See LEVEL (type)

Package: org.shirakumo.ktx2.
Source: ktx.lisp.
Target Slot: offset.

Writer: (setf level-offset) (instance) ¶

Package: org.shirakumo.ktx2.
Source: ktx.lisp.
Target Slot: offset.

Reader: level-uncompressed-length (instance) ¶

Returns the number of octets of the mipmap level when uncompressed.

See LEVEL (type)

Package: org.shirakumo.ktx2.
Source: ktx.lisp.
Target Slot: uncompressed-length.

Writer: (setf level-uncompressed-length) (instance) ¶

Package: org.shirakumo.ktx2.
Source: ktx.lisp.
Target Slot: uncompressed-length.

Reader: levels (instance) ¶

Returns the vector of mipmap level descriptors.

See FILE (type)

Package: org.shirakumo.ktx2.
Source: ktx.lisp.
Target Slot: levels.

Writer: (setf levels) (instance) ¶

Package: org.shirakumo.ktx2.
Source: ktx.lisp.
Target Slot: levels.

Function: metadata (file) ¶

Returns a hash table with the key-value pairs.

The keys are keyword symbols naming the key item.

See KV-ENTRY-VALUE
See FILE (type)

Package: org.shirakumo.ktx2.
Source: ktx.lisp.

Function: (setf metadata) (file) ¶

Package: org.shirakumo.ktx2.
Source: ktx.lisp.

Function: read-file (storage &rest args) ¶

Attempts to parse a KTX2 file from the given storage backend.

By default at the very least an octet-stream, a filename, or an octet-vector and its size are supported as storage backends. Please see the documentation of binary-structures for more information.

If successful returns a FILE instance.
If the file fails to parse (most likely because the file is malformed) an error is signalled.

See FILE (type)
See TELL-FILE

Package: org.shirakumo.ktx2.
Source: ktx.lisp.

Reader: sample-information-bit-length (instance) ¶

Returns the number of consecutive bits from the concatenated bit stream that contribute to the sample.

See SAMPLE-INFORMATION (type)

Package: org.shirakumo.ktx2.
Source: ktx.lisp.
Target Slot: bit-length.

Writer: (setf sample-information-bit-length) (instance) ¶

Package: org.shirakumo.ktx2.
Source: ktx.lisp.
Target Slot: bit-length.

Reader: sample-information-bit-offset (instance) ¶

Returns the offset of the least significant bit of this sample from the least significant bit of the least significant byte of the concatenated bit stream for the format.

See SAMPLE-INFORMATION (type)

Package: org.shirakumo.ktx2.
Source: ktx.lisp.
Target Slot: bit-offset.

Writer: (setf sample-information-bit-offset) (instance) ¶

Package: org.shirakumo.ktx2.
Source: ktx.lisp.
Target Slot: bit-offset.

Reader: sample-information-channel-type (instance) ¶

Returns a bitfield flag representing the following information:

The bits are as follows:
0-3: 4-bit integer numbering the channel being described 4: linear
5: exponent
6: signed
7: float

See SAMPLE-INFORMATION (type)

Package: org.shirakumo.ktx2.
Source: ktx.lisp.
Target Slot: channel-type.

Writer: (setf sample-information-channel-type) (instance) ¶

Package: org.shirakumo.ktx2.
Source: ktx.lisp.
Target Slot: channel-type.

Reader: sample-information-lower (instance) ¶

Returns the lower sample reference value.

See SAMPLE-INFORMATION (type)

Package: org.shirakumo.ktx2.
Source: ktx.lisp.
Target Slot: lower.

Writer: (setf sample-information-lower) (instance) ¶

Package: org.shirakumo.ktx2.
Source: ktx.lisp.
Target Slot: lower.

Reader: sample-information-positions (instance) ¶

Returns a vector describing the position of the sample within the texel block’s 4D space.

See SAMPLE-INFORMATION (type)

Package: org.shirakumo.ktx2.
Source: ktx.lisp.
Target Slot: positions.

Writer: (setf sample-information-positions) (instance) ¶

Package: org.shirakumo.ktx2.
Source: ktx.lisp.
Target Slot: positions.

Reader: sample-information-upper (instance) ¶

Returns the upper sample reference value.

See SAMPLE-INFORMATION (type)

Package: org.shirakumo.ktx2.
Source: ktx.lisp.
Target Slot: upper.

Writer: (setf sample-information-upper) (instance) ¶

Package: org.shirakumo.ktx2.
Source: ktx.lisp.
Target Slot: upper.

Reader: supercompression-global-data (instance) ¶

Returns the raw supercompression global data octet vector.

See SUPERCOMPRESSION-SCHEME
See FILE (type)

Package: org.shirakumo.ktx2.
Source: ktx.lisp.
Target Slot: supercompression-global-data.

Writer: (setf supercompression-global-data) (instance) ¶

Package: org.shirakumo.ktx2.
Source: ktx.lisp.
Target Slot: supercompression-global-data.

Function: supercompression-scheme (instance) ¶

Returns the supercompression scheme used, if any.

See FILE (type)

Package: org.shirakumo.ktx2.
Source: ktx.lisp.

Function: (setf supercompression-scheme) (instance) ¶

Package: org.shirakumo.ktx2.
Source: ktx.lisp.

Function: tell-file (storage &rest args) ¶

Attempts to parse a KTX2 file from the given storage backend.

Only the header of the file is parsed with the format, type-size, width, height, depth, layer-count, face-count, level-count, and supercompression-scheme fields. The returned FILE instance thus only has those fields set to valid values.

Use this to as quickly as possible scan the file ahead of a full loading sequence.

See FILE (type)
See READ-FILE

Package: org.shirakumo.ktx2.
Source: ktx.lisp.

Function: type-size (instance) ¶

Returns the number of octets per pixel.

See FILE (type)

Package: org.shirakumo.ktx2.
Source: ktx.lisp.

Function: (setf type-size) (instance) ¶

Package: org.shirakumo.ktx2.
Source: ktx.lisp.

Function: vk-format (instance) ¶

Returns the vk_Format type representing the pixel encoding of the image data.

See FILE (type)
See GL-TYPE
See GL-INTERNAL-FORMAT
See GL-FORMAT

Package: org.shirakumo.ktx2.
Source: ktx.lisp.

Function: (setf vk-format) (instance) ¶

Package: org.shirakumo.ktx2.
Source: ktx.lisp.

Function: width (instance) ¶

Returns the number of pixels in width.

See FILE (type)

Package: org.shirakumo.ktx2.
Source: ktx.lisp.

Function: (setf width) (instance) ¶

Package: org.shirakumo.ktx2.
Source: ktx.lisp.

Function: write-file (value storage &rest args) ¶

Writes the given KTX2 file to the given storage backend.

By default at the very least an octet-stream, a filename, or an octet-vector and its size are supported as storage backends. Please see the documentation of binary-structures for more information.

If the file fails to serialize (most likely because the file is malformed) an error is signalled.

See FILE (type)

Package: org.shirakumo.ktx2.
Source: ktx.lisp.

Next: Standalone methods, Previous: Ordinary functions, Up: Public Interface [Contents][Index]

5.1.2 Generic functions

Generic Function: decode-kv-entry-value (key octets) ¶

Decodes the value from the octet vector based on its key.

The key must be given by a keyword symbol.

The user may add methods to this function to decode additional keys.

See KV-ENTRY-VALUE
See ENCODE-KV-ENTRY-VALUE

Package

Source

Methods

Method: decode-kv-entry-value ((key (eql :ktxanimdata)) octets) ¶

Source: kv.lisp.

Method: decode-kv-entry-value ((key (eql :ktxastcdecodemode)) octets) ¶

Source: kv.lisp.

Method: decode-kv-entry-value ((key (eql :ktxwriterscparams)) octets) ¶

Source: kv.lisp.

Method: decode-kv-entry-value ((key (eql :ktxwriter)) octets) ¶

Source: kv.lisp.

Method: decode-kv-entry-value ((key (eql :ktxswizzle)) (fields list)) ¶

Source: kv.lisp.

Method: decode-kv-entry-value ((key (eql :ktxswizzle)) octets) ¶

Source: kv.lisp.

Method: decode-kv-entry-value ((key (eql :ktxmetalpixelformat)) (format integer)) ¶

Source: kv.lisp.

Method: decode-kv-entry-value ((key (eql :ktxdxgiformat__)) octets) ¶

Source: kv.lisp.

Method: decode-kv-entry-value ((key (eql :ktxglformat)) octets) ¶

Source: kv.lisp.

Method: decode-kv-entry-value ((key (eql :ktxorientation)) octets) ¶

Source: kv.lisp.

Method: decode-kv-entry-value ((key (eql :ktxcubemapincomplete)) octets) ¶

Source: kv.lisp.

Method: decode-kv-entry-value (key (octets vector)) ¶

Source: kv.lisp.

Generic Function: encode-kv-entry-value (key value) ¶

Encodes the value to an octet vector based on its key.

The key must be given by a keyword symbol.

The user may add methods to this function to encode additional keys.

See KV-ENTRY-VALUE
See DECODE-KV-ENTRY-VALUE

Package

Source

Methods

Method: encode-kv-entry-value ((key (eql :ktxanimdata)) (data list)) ¶

Source: kv.lisp.

Method: encode-kv-entry-value ((key (eql :ktxdxgiformat__)) (format integer)) ¶

Source: kv.lisp.

Method: encode-kv-entry-value ((key (eql :ktxglformat)) (value list)) ¶

Source: kv.lisp.

Method: encode-kv-entry-value ((key (eql :ktxorientation)) (direction list)) ¶

Source: kv.lisp.

Method: encode-kv-entry-value ((key (eql :ktxcubemapincomplete)) (faces list)) ¶

Source: kv.lisp.

Method: encode-kv-entry-value (key (value string)) ¶

Source: kv.lisp.

Method: encode-kv-entry-value (key (octets vector)) ¶

Source: kv.lisp.

Next: Structures, Previous: Generic functions, Up: Public Interface [Contents][Index]

5.1.3 Standalone methods

Method: describe-object :after ((file file) stream) ¶

Source: ktx.lisp.

Method: octet-size ((value kv-entry)) ¶

Package: org.shirakumo.binary-structures.
Source: ktx.lisp.

Method: octet-size ((value descriptor-block)) ¶

Package: org.shirakumo.binary-structures.
Source: ktx.lisp.

Method: octet-size ((value sample-information)) ¶

Package: org.shirakumo.binary-structures.
Source: ktx.lisp.

Method: octet-size ((value khronos-basic-data-format-descriptor-block)) ¶

Package: org.shirakumo.binary-structures.
Source: ktx.lisp.

Method: octet-size ((value level)) ¶

Package: org.shirakumo.binary-structures.
Source: ktx.lisp.

Method: octet-size ((value file)) ¶

Package: org.shirakumo.binary-structures.
Source: ktx.lisp.

Method: octet-size ((value header)) ¶

Package: org.shirakumo.binary-structures.
Source: ktx.lisp.

Method: print-object ((entry kv-entry) stream) ¶

Source: ktx.lisp.

Method: print-object ((file file) stream) ¶

Source: ktx.lisp.

Previous: Standalone methods, Up: Public Interface [Contents][Index]

5.1.4 Structures

Structure: descriptor-block ¶

An opaque descriptor for the image data layout.

See DESCRIPTOR-BLOCK-VENDOR-ID
See DESCRIPTOR-BLOCK-TYPE
See DESCRIPTOR-BLOCK-VERSION
See DESCRIPTOR-BLOCK-SIZE
See DESCRIPTOR-BLOCK-DATA
See DATA-FORMAT-DESCRIPTORS

Package

Source

Direct superclasses

io-structure-object.

Direct methods

Direct slots

Slot: id ¶

Type: (unsigned-byte 32)
Initform: 0
Readers: descriptor-block-id.
Writers: (setf descriptor-block-id).

Slot: version ¶

Type: (unsigned-byte 16)
Initform: 0
Readers: descriptor-block-version.
Writers: (setf descriptor-block-version).

Slot: size ¶

Type: (unsigned-byte 16)
Initform: 0
Readers: descriptor-block-size.
Writers: (setf descriptor-block-size).

Slot: data ¶

Type: (array (unsigned-byte 8) (*))
Initform: (make-array 0 :element-type (quote (unsigned-byte 8)))
Readers: descriptor-block-data.
Writers: (setf descriptor-block-data).

Structure: file ¶

Representation of a KTX2 file.

See VK-FORMAT
See TYPE-SIZE
See WIDTH
See HEIGHT
See DEPTH
See LAYER-COUNT
See FACE-COUNT
See LEVEL-COUNT
See SUPERCOMPRESSION-SCHEME See LEVELS
See DFD-STORE
See KVD-STORE
See SUPERCOMPRESSION-GLOBAL-DATA See LEVEL-IMAGES
See METADATA
See DATA-FORMAT-DESCRIPTORS See GL-FLAGS
See GL-TEXTURE-TARGET
See GL-TYPE
See GL-INTERNAL-FORMAT
See GL-FORMAT
See READ-FILE
See WRITE-FILE
See TELL-FILE

Package

Source

Direct superclasses

header.

Direct methods

describe-object.
octet-size.
print-object.

Direct slots

Slot: dfd-offset ¶

Type: (unsigned-byte 32)
Initform: 0
Readers: dfd-offset.
Writers: (setf dfd-offset).

Slot: dfd-length ¶

Type: (unsigned-byte 32)
Initform: 0
Readers: dfd-length.
Writers: (setf dfd-length).

Slot: kvd-offset ¶

Type: (unsigned-byte 32)
Initform: 0
Readers: kvd-offset.
Writers: (setf kvd-offset).

Slot: kvd-length ¶

Type: (unsigned-byte 32)
Initform: 0
Readers: kvd-length.
Writers: (setf kvd-length).

Slot: sgd-offset ¶

Type: (unsigned-byte 64)
Initform: 0
Readers: sgd-offset.
Writers: (setf sgd-offset).

Slot: sgd-length ¶

Type: (unsigned-byte 64)
Initform: 0
Readers: sgd-length.
Writers: (setf sgd-length).

Slot: levels ¶

Type: (array org.shirakumo.ktx2:level (*))
Initform: (make-array 0 :element-type (quote org.shirakumo.ktx2:level))
Readers: levels.
Writers: (setf levels).

Slot: dfd-store ¶

Type: (array (unsigned-byte 8) (*))
Initform: (make-array 0 :element-type (quote (unsigned-byte 8)))
Readers: dfd-store.
Writers: (setf dfd-store).

Slot: kvd-store ¶

Type: (array (unsigned-byte 8) (*))
Initform: (make-array 0 :element-type (quote (unsigned-byte 8)))
Readers: kvd-store.
Writers: (setf kvd-store).

Slot: supercompression-global-data ¶

Type: (array (unsigned-byte 8) (*))
Initform: (make-array 0 :element-type (quote (unsigned-byte 8)))
Readers: supercompression-global-data.
Writers: (setf supercompression-global-data).

Slot: level-images ¶

Type: (array (array (unsigned-byte 8) (*)) (*))
Initform: (make-array 0 :element-type (quote (array (unsigned-byte 8) (*))))
Readers: level-images.
Writers: (setf level-images).

Structure: khronos-basic-data-format-descriptor-block ¶

Describes the storage format of the image file.

See DESCRIPTOR-BLOCK (type)
See KHRONOS-BASIC-DATA-FORMAT-DESCRIPTOR-BLOCK-COLOR-MODEL
See KHRONOS-BASIC-DATA-FORMAT-DESCRIPTOR-BLOCK-COLOR-PRIMARIES See KHRONOS-BASIC-DATA-FORMAT-DESCRIPTOR-BLOCK-TRANSFER-FUNCTION See KHRONOS-BASIC-DATA-FORMAT-DESCRIPTOR-BLOCK-FLAGS
See KHRONOS-BASIC-DATA-FORMAT-DESCRIPTOR-BLOCK-TEXEL-BLOCK-DIMENSIONS See KHRONOS-BASIC-DATA-FORMAT-DESCRIPTOR-BLOCK-BYTES-PLANES
See KHRONOS-BASIC-DATA-FORMAT-DESCRIPTOR-BLOCK-SAMPLES

Package

Source

Direct superclasses

io-structure-object.

Direct methods

Direct slots

Slot: size ¶

Type: (unsigned-byte 16)
Initform: 0
Readers: khronos-basic-data-format-descriptor-block-size.
Writers: (setf khronos-basic-data-format-descriptor-block-size).

Slot: color-model ¶

Readers: khronos-basic-data-format-descriptor-block-color-model.
Writers: (setf khronos-basic-data-format-descriptor-block-color-model).

Slot: color-primaries ¶

Readers: khronos-basic-data-format-descriptor-block-color-primaries.
Writers: (setf khronos-basic-data-format-descriptor-block-color-primaries).

Slot: transfer-function ¶

Readers: khronos-basic-data-format-descriptor-block-transfer-function.
Writers: (setf khronos-basic-data-format-descriptor-block-transfer-function).

Slot: flags ¶

Type: (unsigned-byte 8)
Initform: 0
Readers: khronos-basic-data-format-descriptor-block-flags.
Writers: (setf khronos-basic-data-format-descriptor-block-flags).

Slot: texel-block-dimensions ¶

Type: (simple-array (unsigned-byte 8) (4))
Initform: (make-array 4 :element-type (quote (unsigned-byte 8)))
Readers: khronos-basic-data-format-descriptor-block-texel-block-dimensions.
Writers: (setf khronos-basic-data-format-descriptor-block-texel-block-dimensions).

Slot: bytes-planes ¶

Type: (simple-array (unsigned-byte 8) (8))
Initform: (make-array 8 :element-type (quote (unsigned-byte 8)))
Readers: khronos-basic-data-format-descriptor-block-bytes-planes.
Writers: (setf khronos-basic-data-format-descriptor-block-bytes-planes).

Slot: samples ¶

Type: (array org.shirakumo.ktx2:sample-information (*))
Initform: (make-array 0 :element-type (quote org.shirakumo.ktx2:sample-information))
Readers: khronos-basic-data-format-descriptor-block-samples.
Writers: (setf khronos-basic-data-format-descriptor-block-samples).

Structure: kv-entry ¶

Representation of a key/value pair.

See KV-ENTRY-KEY
See KV-ENTRY-VALUE
See METADATA
See KVD-STORE

Package

Source

Direct superclasses

io-structure-object.

Direct methods

octet-size.
print-object.

Direct slots

Slot: size ¶

Type: (unsigned-byte 32)
Initform: 0
Readers: kv-entry-size.
Writers: (setf kv-entry-size).

Slot: kv ¶

Type: (array (unsigned-byte 8) (*))
Initform: (make-array 0 :element-type (quote (unsigned-byte 8)))
Readers: kv-entry-kv.
Writers: (setf kv-entry-kv).

Structure: level ¶

Representation of the information about a mipmap level.

See LEVEL-OFFSET
See LEVEL-LENGTH
See LEVEL-UNCOMPRESSED-LENGTH
See LEVEL-IMAGES

Package

Source

Direct superclasses

io-structure-object.

Direct methods

Direct slots

Slot: offset ¶

Type: (unsigned-byte 64)
Initform: 0
Readers: level-offset.
Writers: (setf level-offset).

Slot: length ¶

Package: common-lisp.
Type: (unsigned-byte 64)
Initform: 0
Readers: level-length.
Writers: (setf level-length).

Slot: uncompressed-length ¶

Type: (unsigned-byte 64)
Initform: 0
Readers: level-uncompressed-length.
Writers: (setf level-uncompressed-length).

Structure: sample-information ¶

Description of a sample in a Khronos basic data format descriptor.

See SAMPLE-INFORMATION-BIT-OFFSET
See SAMPLE-INFORMATION-BIT-LENGTH
See SAMPLE-INFORMATION-CHANNEL-TYPE
See SAMPLE-INFORMATION-POSITIONS
See SAMPLE-INFORMATION-LOWER
See SAMPLE-INFORMATION-UPPER

Package

Source

Direct superclasses

io-structure-object.

Direct methods

Direct slots

Slot: bit-offset ¶

Type: (unsigned-byte 16)
Initform: 0
Readers: sample-information-bit-offset.
Writers: (setf sample-information-bit-offset).

Slot: bit-length ¶

Type: (unsigned-byte 8)
Initform: 0
Readers: sample-information-bit-length.
Writers: (setf sample-information-bit-length).

Slot: channel-type ¶

Type: (unsigned-byte 8)
Initform: 0
Readers: sample-information-channel-type.
Writers: (setf sample-information-channel-type).

Slot: positions ¶

Type: (simple-array (unsigned-byte 8) (4))
Initform: (make-array 4 :element-type (quote (unsigned-byte 8)))
Readers: sample-information-positions.
Writers: (setf sample-information-positions).

Slot: lower ¶

Type: (unsigned-byte 32)
Initform: 0
Readers: sample-information-lower.
Writers: (setf sample-information-lower).

Slot: upper ¶

Type: (unsigned-byte 32)
Initform: 0
Readers: sample-information-upper.
Writers: (setf sample-information-upper).

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

5.2 Internals

Ordinary functions
Structures

Next: Structures, Previous: Internals, Up: Internals [Contents][Index]

5.2.1 Ordinary functions

Function: compile-gl-mappings (formats) ¶

Package: org.shirakumo.ktx2.
Source: gl.lisp.

Function: convert-enum-name (name) ¶

Package: org.shirakumo.ktx2.
Source: gl.lisp.

Function: copy-descriptor-block (instance) ¶

Package: org.shirakumo.ktx2.
Source: ktx.lisp.

Function: copy-file (instance) ¶

Package: org.shirakumo.ktx2.
Source: ktx.lisp.

Function: copy-header (instance) ¶

Package: org.shirakumo.ktx2.
Source: ktx.lisp.

Function: copy-khronos-basic-data-format-descriptor-block (instance) ¶

Package: org.shirakumo.ktx2.
Source: ktx.lisp.

Function: copy-kv-entry (instance) ¶

Package: org.shirakumo.ktx2.
Source: ktx.lisp.

Function: copy-level (instance) ¶

Package: org.shirakumo.ktx2.
Source: ktx.lisp.

Function: copy-sample-information (instance) ¶

Package: org.shirakumo.ktx2.
Source: ktx.lisp.

Function: create-file () ¶

Package: org.shirakumo.ktx2.
Source: ktx.lisp.

Reader: descriptor-block-id (instance) ¶

Writer: (setf descriptor-block-id) (instance) ¶

Package: org.shirakumo.ktx2.
Source: ktx.lisp.
Target Slot: id.

Function: descriptor-block-p (object) ¶

Package: org.shirakumo.ktx2.
Source: ktx.lisp.

Reader: dfd-length (instance) ¶

Writer: (setf dfd-length) (instance) ¶

Package: org.shirakumo.ktx2.
Source: ktx.lisp.
Target Slot: dfd-length.

Reader: dfd-offset (instance) ¶

Writer: (setf dfd-offset) (instance) ¶

Package: org.shirakumo.ktx2.
Source: ktx.lisp.
Target Slot: dfd-offset.

Function: file-p (object) ¶

Package: org.shirakumo.ktx2.
Source: ktx.lisp.

Reader: header-depth (instance) ¶

Writer: (setf header-depth) (instance) ¶

Package: org.shirakumo.ktx2.
Source: ktx.lisp.
Target Slot: depth.

Reader: header-face-count (instance) ¶

Writer: (setf header-face-count) (instance) ¶

Package: org.shirakumo.ktx2.
Source: ktx.lisp.
Target Slot: face-count.

Reader: header-height (instance) ¶

Writer: (setf header-height) (instance) ¶

Package: org.shirakumo.ktx2.
Source: ktx.lisp.
Target Slot: height.

Reader: header-layer-count (instance) ¶

Writer: (setf header-layer-count) (instance) ¶

Package: org.shirakumo.ktx2.
Source: ktx.lisp.
Target Slot: layer-count.

Reader: header-level-count (instance) ¶

Writer: (setf header-level-count) (instance) ¶

Package: org.shirakumo.ktx2.
Source: ktx.lisp.
Target Slot: level-count.

Function: header-p (object) ¶

Package: org.shirakumo.ktx2.
Source: ktx.lisp.

Reader: header-supercompression-scheme (instance) ¶

Writer: (setf header-supercompression-scheme) (instance) ¶

Package: org.shirakumo.ktx2.
Source: ktx.lisp.
Target Slot: supercompression-scheme.

Reader: header-type-size (instance) ¶

Writer: (setf header-type-size) (instance) ¶

Package: org.shirakumo.ktx2.
Source: ktx.lisp.
Target Slot: type-size.

Reader: header-vk-format (instance) ¶

Writer: (setf header-vk-format) (instance) ¶

Package: org.shirakumo.ktx2.
Source: ktx.lisp.
Target Slot: vk-format.

Reader: header-width (instance) ¶

Writer: (setf header-width) (instance) ¶

Package: org.shirakumo.ktx2.
Source: ktx.lisp.
Target Slot: width.

Function: infer-gl-flags (format) ¶

Package: org.shirakumo.ktx2.
Source: gl.lisp.

Function: khronos-basic-data-format-descriptor-block-p (object) ¶

Package: org.shirakumo.ktx2.
Source: ktx.lisp.

Reader: kv-entry-kv (instance) ¶

Writer: (setf kv-entry-kv) (instance) ¶

Package: org.shirakumo.ktx2.
Source: ktx.lisp.
Target Slot: kv.

Function: kv-entry-p (object) ¶

Package: org.shirakumo.ktx2.
Source: ktx.lisp.

Reader: kv-entry-size (instance) ¶

Writer: (setf kv-entry-size) (instance) ¶

Package: org.shirakumo.ktx2.
Source: ktx.lisp.
Target Slot: size.

Reader: kvd-length (instance) ¶

Writer: (setf kvd-length) (instance) ¶

Package: org.shirakumo.ktx2.
Source: ktx.lisp.
Target Slot: kvd-length.

Reader: kvd-offset (instance) ¶

Writer: (setf kvd-offset) (instance) ¶

Package: org.shirakumo.ktx2.
Source: ktx.lisp.
Target Slot: kvd-offset.

Function: kw (string) ¶

Package: org.shirakumo.ktx2.
Source: ktx.lisp.

Function: level-p (object) ¶

Package: org.shirakumo.ktx2.
Source: ktx.lisp.

Function: make-descriptor-block (&key id version size data) ¶

Package: org.shirakumo.ktx2.
Source: ktx.lisp.

Function: make-file (&key vk-format type-size width height depth layer-count face-count level-count supercompression-scheme dfd-offset dfd-length kvd-offset kvd-length sgd-offset sgd-length levels dfd-store kvd-store supercompression-global-data level-images) ¶

Package: org.shirakumo.ktx2.
Source: ktx.lisp.

Function: make-header (&key vk-format type-size width height depth layer-count face-count level-count supercompression-scheme) ¶

Package: org.shirakumo.ktx2.
Source: ktx.lisp.

Function: make-khronos-basic-data-format-descriptor-block (&key size color-model color-primaries transfer-function flags texel-block-dimensions bytes-planes samples) ¶

Package: org.shirakumo.ktx2.
Source: ktx.lisp.

Function: make-kv-entry (&key size kv) ¶

Package: org.shirakumo.ktx2.
Source: ktx.lisp.

Function: make-level (&key offset length uncompressed-length) ¶

Package: org.shirakumo.ktx2.
Source: ktx.lisp.

Function: make-sample-information (&key bit-offset bit-length channel-type positions lower upper) ¶

Package: org.shirakumo.ktx2.
Source: ktx.lisp.

Function: prefix-p (prefix string) ¶

Package: org.shirakumo.ktx2.
Source: gl.lisp.

Function: read-descriptor-block (storage &rest args) ¶

Package: org.shirakumo.ktx2.
Source: ktx.lisp.

Function: read-header (storage &rest args) ¶

Package: org.shirakumo.ktx2.
Source: ktx.lisp.

Function: read-io-foreign-pointer-descriptor-block (pointer size) ¶

Package: org.shirakumo.ktx2.
Source: ktx.lisp.

Function: read-io-foreign-pointer-file (pointer size) ¶

Package: org.shirakumo.ktx2.
Source: ktx.lisp.

Function: read-io-foreign-pointer-header (pointer size) ¶

Package: org.shirakumo.ktx2.
Source: ktx.lisp.

Function: read-io-foreign-pointer-khronos-basic-data-format-descriptor-block (pointer size) ¶

Package: org.shirakumo.ktx2.
Source: ktx.lisp.

Function: read-io-foreign-pointer-kv-entry (pointer size) ¶

Package: org.shirakumo.ktx2.
Source: ktx.lisp.

Function: read-io-foreign-pointer-level (pointer size) ¶

Package: org.shirakumo.ktx2.
Source: ktx.lisp.

Function: read-io-foreign-pointer-sample-information (pointer size) ¶

Package: org.shirakumo.ktx2.
Source: ktx.lisp.

Function: read-io-octet-vector-descriptor-block (vector start end) ¶

Package: org.shirakumo.ktx2.
Source: ktx.lisp.

Function: read-io-octet-vector-file (vector start end) ¶

Package: org.shirakumo.ktx2.
Source: ktx.lisp.

Function: read-io-octet-vector-header (vector start end) ¶

Package: org.shirakumo.ktx2.
Source: ktx.lisp.

Function: read-io-octet-vector-khronos-basic-data-format-descriptor-block (vector start end) ¶

Package: org.shirakumo.ktx2.
Source: ktx.lisp.

Function: read-io-octet-vector-kv-entry (vector start end) ¶

Package: org.shirakumo.ktx2.
Source: ktx.lisp.

Function: read-io-octet-vector-level (vector start end) ¶

Package: org.shirakumo.ktx2.
Source: ktx.lisp.

Function: read-io-octet-vector-sample-information (vector start end) ¶

Package: org.shirakumo.ktx2.
Source: ktx.lisp.

Function: read-io-stream-descriptor-block (stream) ¶

Package: org.shirakumo.ktx2.
Source: ktx.lisp.

Function: read-io-stream-file (stream) ¶

Package: org.shirakumo.ktx2.
Source: ktx.lisp.

Function: read-io-stream-header (stream) ¶

Package: org.shirakumo.ktx2.
Source: ktx.lisp.

Function: read-io-stream-khronos-basic-data-format-descriptor-block (stream) ¶

Package: org.shirakumo.ktx2.
Source: ktx.lisp.

Function: read-io-stream-kv-entry (stream) ¶

Package: org.shirakumo.ktx2.
Source: ktx.lisp.

Function: read-io-stream-level (stream) ¶

Package: org.shirakumo.ktx2.
Source: ktx.lisp.

Function: read-io-stream-sample-information (stream) ¶

Package: org.shirakumo.ktx2.
Source: ktx.lisp.

Function: read-khronos-basic-data-format-descriptor-block (storage &rest args) ¶

Package: org.shirakumo.ktx2.
Source: ktx.lisp.

Function: read-kv-entry (storage &rest args) ¶

Package: org.shirakumo.ktx2.
Source: ktx.lisp.

Function: read-level (storage &rest args) ¶

Package: org.shirakumo.ktx2.
Source: ktx.lisp.

Function: read-sample-information (storage &rest args) ¶

Package: org.shirakumo.ktx2.
Source: ktx.lisp.

Function: sample-information-p (object) ¶

Package: org.shirakumo.ktx2.
Source: ktx.lisp.

Reader: sgd-length (instance) ¶

Writer: (setf sgd-length) (instance) ¶

Package: org.shirakumo.ktx2.
Source: ktx.lisp.
Target Slot: sgd-length.

Reader: sgd-offset (instance) ¶

Writer: (setf sgd-offset) (instance) ¶

Package: org.shirakumo.ktx2.
Source: ktx.lisp.
Target Slot: sgd-offset.

Function: strip-prefix (prefix string) ¶

Package: org.shirakumo.ktx2.
Source: gl.lisp.

Function: write-descriptor-block (value storage &rest args) ¶

Package: org.shirakumo.ktx2.
Source: ktx.lisp.

Function: write-header (value storage &rest args) ¶

Package: org.shirakumo.ktx2.
Source: ktx.lisp.

Function: write-io-foreign-pointer-descriptor-block (value pointer size) ¶

Package: org.shirakumo.ktx2.
Source: ktx.lisp.

Function: write-io-foreign-pointer-file (value pointer size) ¶

Package: org.shirakumo.ktx2.
Source: ktx.lisp.

Function: write-io-foreign-pointer-header (value pointer size) ¶

Package: org.shirakumo.ktx2.
Source: ktx.lisp.

Function: write-io-foreign-pointer-khronos-basic-data-format-descriptor-block (value pointer size) ¶

Package: org.shirakumo.ktx2.
Source: ktx.lisp.

Function: write-io-foreign-pointer-kv-entry (value pointer size) ¶

Package: org.shirakumo.ktx2.
Source: ktx.lisp.

Function: write-io-foreign-pointer-level (value pointer size) ¶

Package: org.shirakumo.ktx2.
Source: ktx.lisp.

Function: write-io-foreign-pointer-sample-information (value pointer size) ¶

Package: org.shirakumo.ktx2.
Source: ktx.lisp.

Function: write-io-octet-vector-descriptor-block (value vector start end) ¶

Package: org.shirakumo.ktx2.
Source: ktx.lisp.

Function: write-io-octet-vector-file (value vector start end) ¶

Package: org.shirakumo.ktx2.
Source: ktx.lisp.

Function: write-io-octet-vector-header (value vector start end) ¶

Package: org.shirakumo.ktx2.
Source: ktx.lisp.

Function: write-io-octet-vector-khronos-basic-data-format-descriptor-block (value vector start end) ¶

Package: org.shirakumo.ktx2.
Source: ktx.lisp.

Function: write-io-octet-vector-kv-entry (value vector start end) ¶

Package: org.shirakumo.ktx2.
Source: ktx.lisp.

Function: write-io-octet-vector-level (value vector start end) ¶

Package: org.shirakumo.ktx2.
Source: ktx.lisp.

Function: write-io-octet-vector-sample-information (value vector start end) ¶

Package: org.shirakumo.ktx2.
Source: ktx.lisp.

Function: write-io-stream-descriptor-block (value stream) ¶

Package: org.shirakumo.ktx2.
Source: ktx.lisp.

Function: write-io-stream-file (value stream) ¶

Package: org.shirakumo.ktx2.
Source: ktx.lisp.

Function: write-io-stream-header (value stream) ¶

Package: org.shirakumo.ktx2.
Source: ktx.lisp.

Function: write-io-stream-khronos-basic-data-format-descriptor-block (value stream) ¶

Package: org.shirakumo.ktx2.
Source: ktx.lisp.

Function: write-io-stream-kv-entry (value stream) ¶

Package: org.shirakumo.ktx2.
Source: ktx.lisp.

Function: write-io-stream-level (value stream) ¶

Package: org.shirakumo.ktx2.
Source: ktx.lisp.

Function: write-io-stream-sample-information (value stream) ¶

Package: org.shirakumo.ktx2.
Source: ktx.lisp.

Function: write-khronos-basic-data-format-descriptor-block (value storage &rest args) ¶

Package: org.shirakumo.ktx2.
Source: ktx.lisp.

Function: write-kv-entry (value storage &rest args) ¶

Package: org.shirakumo.ktx2.
Source: ktx.lisp.

Function: write-level (value storage &rest args) ¶

Package: org.shirakumo.ktx2.
Source: ktx.lisp.

Function: write-sample-information (value storage &rest args) ¶

Package: org.shirakumo.ktx2.
Source: ktx.lisp.

Previous: Ordinary functions, Up: Internals [Contents][Index]

5.2.2 Structures

Structure: header ¶

Package

Source

Direct superclasses

io-structure-object.

Direct subclasses

file.

Direct methods