Generator and Registry
dxtr edited this page 2026-10-18 17:10:33 +02:00

Page revisions

7 Commits

Author SHA1 Message Date
e25957fff1 Follow cl-vk cb47a8c: the types of the enums' keywords
The pages on structs, the generator and the packages say that each enum's
keywords are a type of cl-vk/structs, named as the structs are, VkFormat's
being vk-format.
2026-10-18 17:10:33 +02:00
d606a5aa30 Follow cl-vk 9b22588: the types functions declare
The API reference describes the types object and extent, the ranges of
version, and what raw-handle and adopt-surface refuse.  Errors and the
generator's page say that SBCL checks the declared types on entry, and
warns when it compiles a call with a constant of the wrong type.
2026-10-18 16:42:17 +02:00
67dc8e6486 Follow cl-vk 5fec5e9: the error for a model without a required part
The registry model section says what a constructor called without a
part every registry has signals.
2026-10-18 16:23:26 +02:00
9bfd5530f8 Describe cl-vk's conditions for misuse and its escape hatches
Misuse is a type-error where check-type can say what is wrong, and a
vk-error with a message otherwise; the struct macros' expansion-time
errors are vk-errors too.  instance-commands, device-commands and
swapchain-images are escape hatches that refuse destroyed objects, and
swapchain-images has an entry of its own.  device-queue takes :family
and :index.  with-structs takes a foreign pointer for a field that
points to untyped memory.  The generator no longer has *platforms*.
2026-10-18 15:22:05 +02:00
482c8dbb72 Follow cl-vk 75e5e17: run on SBCL only
The requirements name SBCL alone, the platform page describes cl-vk/sys
as what cl-vk takes from SBCL, and the test commands and the generator's
reason for laying out its output by hand no longer mention CCL.  The
allocation claims drop their "on SBCL".
2026-10-17 04:55:06 +02:00
da8c2545c3 cl-vk calls Vulkan through cl-ffi, not cffi
Follows cl-vk cae101e: the raw layer's structs, types and the loader's
library are cl-ffi's, the examples use cl-ffi's operators, and getting
started lists cl-ffi in the qlfile beside cl-vk.
2026-10-15 11:23:58 +02:00
b27a52160f Add the reference pages and the sidebar; document enum keyword rules
Add API Reference, Errors, Lifetimes and Threads, Raw FFI Layer,
Generator and Registry, and Platforms and Testing.  State the full rules
for enum keywords, including the prefix word kept before a digit
(:type-2d), and use :type-2d in the image view recipe.
2026-10-11 20:33:41 +02:00