hal/vulkan/native.lisp
in-package#:luv.vulkan
The three ordinary Vulkan call shapes used so far.
defmacrodefine-enumerator
let`
count
gensym"COUNT"
capacity
gensym"CAPACITY"
items
gensym"ITEMS"
result
gensym"RESULT"
index
gensym"INDEX"
defun,name,lambda-list
cffi:with-foreign-object
,count:uint32
setf
cffi:mem-ref,count:uint32
0with-vulkan-results
,operation:success:incomplete
,
firstcall
,@restcall
,countcffi:null-pointer
loopfor,capacity=
cffi:mem-ref,count:uint32
whenzerop,capacity
returnnildocffi:with-foreign-object
,items',element,capacity
let
,result
with-vulkan-results
,operation:success:incomplete
,
firstcall
,@restcall
,count,itemsunless
eq,result:incomplete
return-from,name
loopfor,indexbelow
cffi:mem-ref,count:uint32
collect,defmacrodefine-creator
let`
output
gensym"OUTPUT"
defun,name,lambda-list
cffi:with-foreign-object
,output',element
,defunextension-property-name
propertiesindex
let
property
cffi:foreign-string-to-lisp
define-enumeratorenumerate-instance-extension-names
vk:enumerate-instance-extension-properties
:elementcffi:null-pointer
:structextension-properties
:extractorextension-property-name:operation:enumerate-instance-extension-propertiesdefine-enumeratorenumerate-device-extension-names
physical-device
vk:enumerate-device-extension-propertiesphysical-device
:elementcffi:null-pointer
:structextension-properties
:extractorextension-property-name:operation:enumerate-device-extension-propertiesdefine-enumeratorenumerate-physical-devices
instance
vk:enumerate-physical-devicesinstance
:element:pointerdefine-creatorcreate-descriptor-set-layout-handle
devicecreate-info
vk:create-descriptor-set-layoutdevicecreate-info
:checkedt:operation:create-descriptor-set-layoutcffi:null-pointer
define-creatorcreate-pipeline-layout-handle
devicecreate-info
:checkedt:operation:create-pipeline-layoutdefine-creatorcreate-compute-pipeline-handle
devicecreate-info
vk:create-compute-pipelinesdevice
:checkedt:operation:create-compute-pipelinecffi:null-pointer
1create-infocffi:null-pointer
define-creatorcreate-graphics-pipeline-handle
devicecreate-info
vk:create-graphics-pipelinesdevice
:checkedt:operation:create-graphics-pipelinecffi:null-pointer
1create-infocffi:null-pointer
define-creatorcreate-render-pass-handle
devicecreate-info
vk:create-render-passdevicecreate-info
:checkedt:operation:create-render-passcffi:null-pointer
define-creatorcreate-descriptor-pool-handle
devicecreate-info
vk:create-descriptor-pooldevicecreate-info
:checkedt:operation:create-descriptor-poolcffi:null-pointer
define-creatorallocate-descriptor-set-handle
deviceallocate-info
vk:allocate-descriptor-setsdeviceallocate-info
:checkedt:operation:allocate-descriptor-setdefine-creatorallocate-command-buffer-handle
deviceallocate-info
vk:allocate-command-buffersdeviceallocate-info
:checkedt:operation:allocate-command-bufferdefine-creatorcreate-swapchain-handle
devicecreate-info
vk:create-swapchain-khrdevicecreate-info
:checkedt:operation:create-swapchaincffi:null-pointer
Public, Lisp-shaped operations.
defstructimage-memory-requirements
size0:type
unsigned-byte64
alignment0:type
unsigned-byte64
memory-type-bits0:type
unsigned-byte32
defstructbuffer-memory-requirements
size0:type
unsigned-byte64
alignment0:type
unsigned-byte64
memory-type-bits0:type
unsigned-byte32
defstructpresentation-capabilities
min-image-count0:type
unsigned-byte32
max-image-count0:type
current-extentmin-image-extentmax-image-extentcurrent-transformunsigned-byte32
composite-alphanil:typelist
usagenil:typelist
defstructpresentation-timing-capabilities
supported-pnil:typeboolean
absolute-time-pnil:typeboolean
relative-time-pnil:typeboolean
stagesnil:typelist
present-id-2-pnil:typeboolean
defstructswapchain-timing-properties
refresh-duration0:type
unsigned-byte64
refresh-interval0:type
unsigned-byte64
defunmake-version
majorminorpatch
logior
ashmajor22
ashminor12
patchdefuncreate-instance
&keyflagsenabled-extension-names
application-name"luv"
:application-versionapplication-version-value
engine-name"luv"
:engine-versionengine-version-value
Luv assumes modern Vulkan. Timeline semaphores and synchronization2 are mandatory core features at this version.
:api-versionapi-version-value
with-translated-values
application-name-pointerapplication-name:string
engine-name-pointerengine-name:string
extension-namesenabled-extension-namesstring-list
with-vk
application-infoapplication-info:p-application-nameapplication-name-pointer:application-versionapplication-version-value:p-engine-nameengine-name-pointer:engine-versionengine-version-value:api-versionapi-version-value
with-vk
create-infoinstance-create-info:flagsflags:p-application-infoapplication-info:enabled-layer-count0:pp-enabled-layer-names
cffi:null-pointer
:enabled-extension-countlengthenabled-extension-names
:pp-enabled-extension-namesextension-namescreate-instance-handlecreate-info
defstruct
debug-message
severitytypesid-nameid-numbertext:constructor%make-debug-message
defstruct
debug-messenger
instancehandleuser-data:constructor%make-debug-messenger
destroyed-pnil
defvar*debug-messenger-callbacks*
make-hash-table:test#'eql
"Callbacks keyed by the address passed through VkDebugUtils user data."defunnullable-foreign-string
pointer
unless
cffi:null-pointer-ppointer
cffi:foreign-string-to-lisppointer
cffi:defcallbackdispatch-debug-utils-message:uint32
severitydebug-utils-message-severity-flags
typesdebug-utils-message-type-flags
callback-data:pointer
user-data:pointer
Never unwind through a Vulkan driver. Callback failures are reported and Vulkan is always told not to abort the call which produced the message.
handler-case
0let
callback
whencallback
cffi:with-foreign-slots
p-message-id-namemessage-id-numberp-message
callback-datafuncallcallback
%make-debug-message:severityseverity:typestypes:id-name
nullable-foreign-stringp-message-id-name
:id-numbermessage-id-number:textnullable-foreign-stringp-message
serious-condition
condition
ignore-errors
format*error-output*"~&Vulkan debug callback failed: ~A~%"condition
defuninstance-procedure
instancename
let
procedure
vk:get-instance-proc-addrinstancename
when
procedurecffi:null-pointer-pprocedure
error"Vulkan instance procedure ~A is unavailable."name
defuninstall-debug-messenger
instancecallback&key
severities'
:warning:error
types'
:general:validation:performance
Install callback for instance and return an owned DEBUG-MESSENGER.
callback receives one DEBUG-MESSAGE. VK_EXT_debug_utils must have been
enabled when instance was created. Keep the returned messenger alive and
destroy it before destroying instance.
let
user-data
cffi:foreign-alloc:uint8
handlenil
completed-pnil
setfcallback
unwind-protect
with-vk
create-infodebug-utils-messenger-create-info-ext:flags0:message-severityseverities:message-typetypes:pfn-user-callback
cffi:callbackdispatch-debug-utils-message
:p-user-datauser-datacffi:with-foreign-object
output:pointer
setf
cffi:mem-refoutput:pointer
cffi:null-pointer
with-vulkan-results
:create-debug-utils-messenger-ext
vk:create-debug-utils-messenger-extinstancecreate-info
cffi:null-pointer
outputsetfhandle
cffi:mem-refoutput:pointer
completed-pt%make-debug-messenger:instanceinstance:handlehandle:user-datauser-data
unlesscompleted-p
cffi:foreign-freeuser-data
defundestroy-debug-messenger
messenger
Destroy messenger and release its Lisp callback. Safe to call twice.
unless
debug-messenger-destroyed-pmessenger
unwind-protect
vk:destroy-debug-utils-messenger-ext
debug-messenger-instancemessenger
debug-messenger-handlemessenger
cffi:null-pointer
cffi:foreign-free
debug-messenger-user-datamessenger
setf
debug-messenger-destroyed-pmessenger
tvalues
defunphysical-device-queue-families
physical-device
cffi:with-foreign-object
count:uint32
setf
cffi:mem-refcount:uint32
0vk:get-physical-device-queue-family-propertiesphysical-devicecount
cffi:null-pointer
let
capacity
cffi:mem-refcount:uint32
if
zeropcapacity
nilcffi:with-foreign-object
properties'
:structqueue-family-properties
capacityvk:get-physical-device-queue-family-propertiesphysical-devicecountproperties
loopforindexbelowforproperty=collect
cffi:with-foreign-slots
queue-flagsqueue-count
property:structqueue-family-properties
make-queue-family:flagsqueue-flags:countqueue-count
defunphysical-device-shader-int64-p
physical-device
Whether physical-device exposes Vulkan's core shaderInt64 feature.
cffi:with-foreign-object
features'
:structphysical-device-features
vk:get-physical-device-featuresphysical-devicefeatures
not
zerop
defunphysical-device-mesh-shader-p
physical-device
Whether physical-device offers VK_EXT_mesh_shader's task and mesh stages.
defunphysical-device-presentation-features
physical-device&keypresent-timing-ppresent-id-2-p
Return the optional presentation feature bits exposed by physical-device.
The values are PRESENT-TIMING, PRESENT-AT-ABSOLUTE-TIME,
PRESENT-AT-RELATIVE-TIME, and present-id-2. A feature whose extension was not
advertised is never placed in the query chain and is returned as NIL.
if
with-vk
id-featuresphysical-device-present-id-2-features-khr:present-id-20
with-vk
timing-featuresphysical-device-present-timing-features-ext:p-next
ifpresent-id-2-pid-features
:present-timing0:present-at-absolute-time0:present-at-relative-time0cffi:null-pointer
with-vk
featuresphysical-device-features-2:p-next
cond
present-timing-ptiming-features
present-id-2-pid-features
t
cffi:null-pointer
vk:get-physical-device-features2physical-devicefeatures
valuesnilnilnilnil
defuncreate-device
physical-devicefamily-index&keyenabled-extension-namesadditional-family-indices
unless
physical-device-shader-int64-pphysical-device
error"The Vulkan physical device lacks luv's required shaderInt64 feature."
let
present-timing-p
present-id-2-p
multiple-value-bind
present-timing-feature-ppresent-at-absolute-time-ppresent-at-relative-time-ppresent-id-2-feature-p
physical-device-presentation-featuresphysical-device:present-timing-ppresent-timing-p:present-id-2-ppresent-id-2-p
with-translated-values
extension-namesenabled-extension-namesstring-list
let*
families
remove-duplicates
consfamily-indexadditional-family-indices
queue-count
lengthfamilies
cffi:with-foreign-object
queue-priority:float
setf
cffi:mem-refqueue-priority:float
1.0cffi:with-foreign-object
queue-infos'
:structdevice-queue-create-info
queue-countloopforfamilyinfamiliesforindexfrom0do
fill-vk'device-queue-create-info:flags0:queue-family-indexfamily:queue-count1:p-queue-prioritiesqueue-priority
with-vk
featuresphysical-device-features:shader-int641
with-vk
timeline-featuresphysical-device-timeline-semaphore-features:timeline-semaphore1
with-vk
synchronization-featuresphysical-device-synchronization-2-features:p-nexttimeline-features:synchronization-21
Asking for VK_EXT_mesh_shader admits its commands; the two stages themselves are features, and a pipeline whose module declares MeshShadingEXT is invalid without them.
with-vk
mesh-featuresphysical-device-mesh-shader-features-ext:p-nextsynchronization-features:task-shader1:mesh-shader1:multiview-mesh-shader0:primitive-fragment-shading-rate-mesh-shader0:mesh-shader-queries0
let
base-features
ifmesh-featuressynchronization-features
with-vk
id-featuresphysical-device-present-id-2-features-khr:p-nextbase-features:present-id-2
ifpresent-id-2-feature-p10
with-vk
timing-featuresphysical-device-present-timing-features-ext:p-next
ifpresent-id-2-pid-featuresbase-features
:present-timingifpresent-timing-feature-p10
:present-at-absolute-timeifpresent-at-absolute-time-p10
:present-at-relative-timeifpresent-at-relative-time-p10
with-vk
create-infodevice-create-info:p-next
cond
:flags0:queue-create-info-countqueue-count:p-queue-create-infosqueue-infos:enabled-layer-count0:pp-enabled-layer-namespresent-timing-ptiming-features
present-id-2-pid-features
tbase-features
cffi:null-pointer
:enabled-extension-countlengthenabled-extension-names
:pp-enabled-extension-namesextension-names:p-enabled-featuresfeaturesdefunget-device-queue
devicequeue-family-index&optional
queue-index0
defunphysical-device-memory-types
physical-device
cffi:with-foreign-object
properties'
vk:get-physical-device-memory-propertiesphysical-deviceproperties
let
count
types
loopforindexbelowcountformemory-type=collect
cffi:with-foreign-slots
property-flagsheap-index
memory-type:structmemory-type
make-physical-memory-type:flagsproperty-flags:heap-indexheap-index
defuncreate-image
with-vk
create-infoimage-create-info:flags0:image-typetype:formatformat:mip-levelsmip-levels:array-layersarray-layers:samplessamples:tilingtiling:usageusage:sharing-modesharing-mode:queue-family-index-count0:p-queue-family-indices
cffi:null-pointer
:initial-layoutinitial-layoutdefunget-image-memory-requirements
deviceimage
cffi:with-foreign-object
requirements'
:structmemory-requirements
cffi:with-foreign-slots
sizealignmentmemory-type-bits
requirements:structmemory-requirements
make-image-memory-requirements:sizesize:alignmentalignment:memory-type-bitsmemory-type-bits
defuncreate-buffer
with-vk
create-infobuffer-create-info:flags0:sizesize:usageusage:sharing-mode:exclusive:queue-family-index-count0:p-queue-family-indices
cffi:null-pointer
defunget-buffer-memory-requirements
devicebuffer
cffi:with-foreign-object
requirements'
:structmemory-requirements
cffi:with-foreign-slots
sizealignmentmemory-type-bits
requirements:structmemory-requirements
make-buffer-memory-requirements:sizesize:alignmentalignment:memory-type-bitsmemory-type-bits
defunallocate-memory
devicesizememory-type-index
with-vk
allocate-infomemory-allocate-info:allocation-sizesize:memory-type-indexmemory-type-index
defunbind-buffer-memory
devicebuffermemory&optional
offset0
with-vulkan-results
:bind-buffer-memory
values
defunmap-memory
devicememorysize&optional
offset0
defuncreate-image-view
deviceimageformat&key
view-type:2d
aspect:color
with-vk
create-infoimage-view-create-info:flags0:imageimage:view-typeview-type:formatformat
defuncreate-shader-module
devicewords
with-foreign-array
code:uint32words
with-vk
create-infoshader-module-create-info:flags0:code-size:p-codecode
defundestroy-shader-module
deviceshader-module
values
defuncreate-storage-image-descriptor-set-layout
device&key
binding0
with-vk
layout-bindingdescriptor-set-layout-binding:bindingbinding:descriptor-type:storage-image:descriptor-count1:stage-flags'
:compute
:p-immutable-samplerscffi:null-pointer
with-vk
create-infodescriptor-set-layout-create-info:flags0:binding-count1:p-bindingslayout-binding
defuncreate-uniform-buffer-descriptor-set-layout
device&key
binding0
stages'
:vertex
with-vk
layout-bindingdescriptor-set-layout-binding:bindingbinding:descriptor-type:uniform-buffer:descriptor-count1:stage-flagsstages:p-immutable-samplers
cffi:null-pointer
with-vk
create-infodescriptor-set-layout-create-info:flags0:binding-count1:p-bindingslayout-binding
defuntexture-sampler-uniform-descriptor-type
ecasetype
:texture:sampled-image
:sampler:sampler
:uniform-buffer:uniform-buffer
:storage-buffer:storage-buffer
defuntexture-sampler-uniform-descriptor-stages
entry
A mesh pipeline has no vertex stage, and a resource it reads from the task or mesh stage must say so: a descriptor visible only to :VERTEX is not visible to the stages that replaced it.
or
getfentry:stages
ecase
getfentry:type
:texture:sampler:uniform-buffer:storage-buffer
':vertex:fragment
defuncreate-texture-sampler-uniform-descriptor-set-layout
deviceentries
let
count
lengthentries
cffi:with-foreign-object
bindings'count
loopforentryinentriesforindexfrom0do
fill-vk'descriptor-set-layout-binding:binding
getfentry:binding
:descriptor-typetexture-sampler-uniform-descriptor-type
:descriptor-count1:stage-flags:p-immutable-samplersgetfentry:type
cffi:null-pointer
with-vk
create-infodescriptor-set-layout-create-info:flags0:binding-countcount:p-bindingsbindings
defundestroy-descriptor-set-layout
devicelayout
values
defuncreate-pipeline-layout
deviceset-layouts
with-foreign-array
layouts:pointerset-layouts
with-vk
create-infopipeline-layout-create-info:flags0:set-layout-count
lengthset-layouts
:p-set-layoutslayouts:push-constant-range-count0:p-push-constant-rangescffi:null-pointer
defundestroy-pipeline-layout
devicelayout
values
defuncreate-compute-pipeline
cffi:with-foreign-string
entry-point-pointerentry-point
with-vk
create-infocompute-pipeline-create-info:flags0:layoutlayout:base-pipeline-handle
cffi:null-pointer
:base-pipeline-index-1fill-vk'pipeline-shader-stage-create-info:flags0:stage'
:compute
:moduleshader-module:p-nameentry-point-pointer:p-specialization-infocffi:null-pointer
defuncreate-sampler
device&key
mag-filter:linear
min-filter:linear
mipmap-mode:nearest
address-mode-u:clamp-to-edge
address-mode-v:clamp-to-edge
address-mode-w:clamp-to-edge
comparewith-vk
create-infosampler-create-info:flags0:mag-filtermag-filter:min-filtermin-filter:mipmap-modemipmap-mode:address-mode-uaddress-mode-u:address-mode-vaddress-mode-v:address-mode-waddress-mode-w:mip-lod-bias0.0:anisotropy-enable0:max-anisotropy1.0:compare-enable
ifcompare10
:compare-op:min-lod0.0:max-lod0.0:border-color:float-transparent-black:unnormalized-coordinates0defunvulkan-attachment-store-op
store-op
ecasestore-op
:store:store
:discard:dont-care
defuncreate-color-render-pass
deviceformats&keydepth-format
depth-store-op:discard
Create a pass whose color attachments have formats in location order.
let*
cffi:with-foreign-object
attachments'
:structattachment-description
attachment-countloopforformatacrossformatsforindexfrom0do
fill-vk'attachment-description:flags0:formatformat:samples:1:load-op:clear:store-op:store:stencil-load-op:dont-care:stencil-store-op:dont-care:initial-layout:color-attachment-optimal:final-layout:color-attachment-optimal
whendepth-format
fill-vk'attachment-description:flags0:formatdepth-format:samples:1:load-op:clear:store-op
vulkan-attachment-store-opdepth-store-op
:stencil-load-op:dont-care:stencil-store-op:dont-care:initial-layout:depth-stencil-attachment-optimal:final-layout:depth-stencil-attachment-optimalcffi:with-foreign-object
color-references'
:structattachment-reference
color-countdotimes
indexcolor-count
labels
create-with-depth-reference
depth-reference
with-vk
subpasssubpass-description:flags0:pipeline-bind-point:graphics:input-attachment-count0:p-input-attachments
cffi:null-pointer
:color-attachment-countcolor-count:p-color-attachmentscolor-references:p-resolve-attachmentscffi:null-pointer
:p-depth-stencil-attachmentdepth-reference:preserve-attachment-count0:p-preserve-attachmentscffi:null-pointer
with-vk
create-inforender-pass-create-info:flags0:attachment-countattachment-count:p-attachmentsattachments:subpass-count1:p-subpassessubpass:dependency-count0:p-dependencies
cffi:null-pointer
ifdepth-format
with-vk
depth-referenceattachment-reference:attachmentcolor-count:layout:depth-stencil-attachment-optimal
create-with-depth-referencedepth-reference
create-with-depth-reference
cffi:null-pointer
defuncreate-depth-render-pass
devicedepth-format&key
depth-store-op:store
cffi:with-foreign-object
attachments'
:structattachment-description
1fill-vkattachments'attachment-description:flags0:formatdepth-format:samples:1:load-op:clear:store-op
vulkan-attachment-store-opdepth-store-op
:stencil-load-op:dont-care:stencil-store-op:dont-care:initial-layout:depth-stencil-attachment-optimal:final-layout:depth-stencil-attachment-optimalwith-vk
depth-referenceattachment-reference:attachment0:layout:depth-stencil-attachment-optimal
with-vk
subpasssubpass-description:flags0:pipeline-bind-point:graphics:input-attachment-count0:p-input-attachments
cffi:null-pointer
:color-attachment-count0:p-color-attachmentscffi:null-pointer
:p-resolve-attachmentscffi:null-pointer
:p-depth-stencil-attachmentdepth-reference:preserve-attachment-count0:p-preserve-attachmentscffi:null-pointer
with-vk
create-inforender-pass-create-info:flags0:attachment-count1:p-attachmentsattachments:subpass-count1:p-subpassessubpass:dependency-count0:p-dependencies
cffi:null-pointer
defundestroy-render-pass
devicerender-pass
values
defuncreate-framebuffer
let*
image-views
cond
nullimage-views
nillistpimage-views
image-viewsvectorpimage-views
coerceimage-views'list
t
listimage-views
attachment-vector
when
zerop
lengthattachment-vector
error"A framebuffer needs at least one attachment."
with-foreign-array
attachments:pointerattachment-vector
with-vk
create-infoframebuffer-create-info:flags0:render-passrender-pass:attachment-count
lengthattachment-vector
:p-attachmentsattachments:widthwidth:heightheight:layers1defundestroy-framebuffer
deviceframebuffer
values
defuncall-with-vertex-input-descriptions
vertex-buffersfunction
if
nullvertex-buffers
let
attribute-count
cffi:with-foreign-object
bindings'
lengthvertex-buffers
cffi:with-foreign-object
attributes'attribute-count
loopwithattribute-index=0forbufferinvertex-buffersfordefault-bindingfrom0forbinding=do
dolist
attribute
getfbuffer:attributes
fill-vk'vertex-input-attribute-description:location
getfattribute:shader-location
:bindingbinding:formatgetfattribute:format
:offsetgetfattribute:offset
incfattribute-index
defuncall-with-depth-stencil-state
ifdepth-compare
with-vk
statepipeline-depth-stencil-state-create-info:flags0:depth-test-enable1:depth-write-enable
ifdepth-write-enabled10
:depth-compare-opdepth-compare:depth-bounds-test-enable0:stencil-test-enable0:min-depth-bounds0.0:max-depth-bounds1.0defuncall-with-color-blend-attachments
blendsfunction
Call function with one Vulkan blend attachment per fragment target.
if
nullblends
cffi:with-foreign-object
attachments'
lengthblends
loopforblendinblendsforindexfrom0do
fill-vk'pipeline-color-blend-attachment-state:blend-enable
ifblend10
:src-color-blend-factor:one:dst-color-blend-factorifblend:one-minus-src-alpha:zero
:color-blend-op:add:src-alpha-blend-factor:one:dst-alpha-blend-factorifblend:one-minus-src-alpha:zero
:alpha-blend-op:add:color-write-mask':r:g:b:a
defuncreate-graphics-pipeline
devicevertex-modulefragment-modulelayoutrender-pass&key
vertex-entry-point"main"
fragment-entry-point"main"
topology:triangle-strip
vertex-buffersdepth-comparedepth-write-enabledblendsblendlabels
create-with-shader-names
vertex-namefragment-name
let
stage-count
iffragment-module21
cffi:with-foreign-object
stages'stage-count
fill-vk'pipeline-shader-stage-create-info:flags0:stage'
:vertex
:modulevertex-module:p-namevertex-name:p-specialization-infocffi:null-pointer
whenfragment-module
fill-vk'pipeline-shader-stage-create-info:flags0:stage'
:fragment
:modulefragment-module:p-namefragment-name:p-specialization-infocffi:null-pointer
call-with-vertex-input-descriptionsvertex-buffers
lambda
binding-countbindingsattribute-countattributes
with-vk
vertex-inputpipeline-vertex-input-state-create-info:flags0:vertex-binding-description-countbinding-count:p-vertex-binding-descriptionsbindings:vertex-attribute-description-countattribute-count:p-vertex-attribute-descriptionsattributes
with-vk
input-assemblypipeline-input-assembly-state-create-info:flags0:topologytopology:primitive-restart-enable0
with-vk
viewport-statepipeline-viewport-state-create-info:flags0:viewport-count1:p-viewports
cffi:null-pointer
:scissor-count1:p-scissorscffi:null-pointer
with-vk
rasterizationpipeline-rasterization-state-create-info:flags0:depth-clamp-enable0:rasterizer-discard-enable0:polygon-mode:fill:cull-modenil:front-face:counter-clockwise:depth-bias-enable0:depth-bias-constant-factor0.0:depth-bias-clamp0.0:depth-bias-slope-factor0.0:line-width1.0
with-vk
multisamplepipeline-multisample-state-create-info:flags0:rasterization-samples:1:sample-shading-enable0:min-sample-shading0.0:p-sample-mask
cffi:null-pointer
:alpha-to-coverage-enable0:alpha-to-one-enable0labels
create-with-blend
attachment-countattachments
with-vk
blendpipeline-color-blend-state-create-info:flags0:logic-op-enable0:logic-op:copy:attachment-countattachment-count:p-attachmentsattachments
with-foreign-array
dynamic-statesdynamic-state
:viewport:scissor
with-vk
dynamicpipeline-dynamic-state-create-info:flags0:dynamic-state-count2:p-dynamic-statesdynamic-states
call-with-depth-stencil-statedepth-comparedepth-write-enabled
lambda
depth-state
with-vk
create-infographics-pipeline-create-info:flags0:stage-countstage-count:p-stagesstages:p-vertex-input-statevertex-input:p-input-assembly-stateinput-assembly:p-tessellation-state
cffi:null-pointer
:p-viewport-stateviewport-state:p-rasterization-staterasterization:p-multisample-statemultisample:p-depth-stencil-statedepth-state:p-color-blend-stateblend:p-dynamic-statedynamic:layoutlayout:render-passrender-pass:subpass0:base-pipeline-handlecffi:null-pointer
:base-pipeline-index-1cffi:with-foreign-string
vertex-namevertex-entry-point
iffragment-module
cffi:with-foreign-string
fragment-namefragment-entry-point
create-with-shader-namesvertex-namefragment-name
create-with-shader-namesvertex-name
cffi:null-pointer
defundevice-procedure
devicename
let
procedure
vk:get-device-proc-addrdevicename
when
procedurecffi:null-pointer-pprocedure
error"Vulkan device procedure ~A is unavailable."name
defuncreate-mesh-graphics-pipeline
devicemesh-modulefragment-modulelayoutrender-pass&keytask-module
task-entry-point"main"
mesh-entry-point"main"
fragment-entry-point"main"
depth-comparedepth-write-enabledblendsblendLink a task, mesh, and fragment stage into one VK_EXT_mesh_shader pipeline.
A mesh pipeline draws no vertices, so it carries neither a vertex input nor an input assembly state; the mesh stage's own OpExecutionMode names its output topology.
labels
create-with-shader-names
task-namemesh-namefragment-name
let*
stage-count
cffi:with-foreign-object
stages'stage-count
let
index-1
flet
stage
bitmodulename
fill-vk'pipeline-shader-stage-create-info:flags0:stage
listbit
:modulemodule:p-namename:p-specialization-infocffi:null-pointer
whentask-module
stage:task-exttask-moduletask-name
stage:mesh-extmesh-modulemesh-name
whenfragment-module
stage:fragmentfragment-modulefragment-name
with-vk
viewport-statepipeline-viewport-state-create-info:flags0:viewport-count1:p-viewports
cffi:null-pointer
:scissor-count1:p-scissorscffi:null-pointer
with-vk
rasterizationpipeline-rasterization-state-create-info:flags0:depth-clamp-enable0:rasterizer-discard-enable0:polygon-mode:fill:cull-modenil:front-face:counter-clockwise:depth-bias-enable0:depth-bias-constant-factor0.0:depth-bias-clamp0.0:depth-bias-slope-factor0.0:line-width1.0
with-vk
multisamplepipeline-multisample-state-create-info:flags0:rasterization-samples:1:sample-shading-enable0:min-sample-shading0.0:p-sample-mask
cffi:null-pointer
:alpha-to-coverage-enable0:alpha-to-one-enable0labels
create-with-blend
attachment-countattachments
with-vk
blend-statepipeline-color-blend-state-create-info:flags0:logic-op-enable0:logic-op:copy:attachment-countattachment-count:p-attachmentsattachments
with-foreign-array
dynamic-statesdynamic-state
:viewport:scissor
with-vk
dynamicpipeline-dynamic-state-create-info:flags0:dynamic-state-count2:p-dynamic-statesdynamic-states
call-with-depth-stencil-statedepth-comparedepth-write-enabled
lambda
depth-state
with-vk
create-infographics-pipeline-create-info:flags0:stage-countstage-count:p-stagesstages:p-vertex-input-state
cffi:null-pointer
:p-input-assembly-statecffi:null-pointer
:p-tessellation-statecffi:null-pointer
:p-viewport-stateviewport-state:p-rasterization-staterasterization:p-multisample-statemultisample:p-depth-stencil-statedepth-state:p-color-blend-stateblend-state:p-dynamic-statedynamic:layoutlayout:render-passrender-pass:subpass0:base-pipeline-handlecffi:null-pointer
:base-pipeline-index-1defuncmd-draw-mesh-tasks
devicecommand-bufferxyz
Dispatch X by Y by Z task (or mesh) workgroups into command-buffer.
cffi:foreign-funcall-pointer:pointercommand-buffer:uint32x:uint32y:uint32z:void
values
defuncreate-storage-image-descriptor-pool
device&key
max-sets1
with-vk
pool-sizedescriptor-pool-size:type:storage-image:descriptor-countmax-sets
with-vk
create-infodescriptor-pool-create-info:flags0:max-setsmax-sets:pool-size-count1:p-pool-sizespool-size
defuncreate-uniform-buffer-descriptor-pool
device&key
max-sets1
with-vk
pool-sizedescriptor-pool-size:type:uniform-buffer:descriptor-countmax-sets
with-vk
create-infodescriptor-pool-create-info:flags0:max-setsmax-sets:pool-size-count1:p-pool-sizespool-size
defuntexture-sampler-uniform-pool-counts
entries
values
count:textureentries:key
lambda
entry
getfentry:type
count:samplerentries:key
lambda
entry
getfentry:type
count:uniform-bufferentries:key
lambda
entry
getfentry:type
count:storage-bufferentries:key
lambda
entry
getfentry:type
defuncreate-texture-sampler-uniform-descriptor-pool
deviceentries&key
max-sets1
multiple-value-bind
texture-countsampler-countuniform-countstorage-count
let
sizes
append
when
plusptexture-count
list
list:sampled-imagetexture-count
when
pluspsampler-count
list
list:samplersampler-count
when
pluspuniform-count
list
list:uniform-bufferuniform-count
when
pluspstorage-count
list
list:storage-bufferstorage-count
cffi:with-foreign-object
pool-sizes'
:structdescriptor-pool-size
lengthsizes
with-vk
create-infodescriptor-pool-create-info:flags0:max-setsmax-sets:pool-size-count
lengthsizes
:p-pool-sizespool-sizesdefunallocate-descriptor-set
with-foreign-array
with-vk
allocate-infodescriptor-set-allocate-info:descriptor-poolpool:descriptor-set-count1:p-set-layoutslayouts
defunupdate-storage-image-descriptor
devicedescriptor-setimage-view&key
binding0
with-vk
image-infodescriptor-image-info:sampler
cffi:null-pointer
:image-viewimage-view:image-layout:generalwith-vk
writewrite-descriptor-set:dst-setdescriptor-set:dst-bindingbinding:dst-array-element0:descriptor-count1:descriptor-type:storage-image:p-image-infoimage-info:p-buffer-info
cffi:null-pointer
:p-texel-buffer-viewcffi:null-pointer
vk:update-descriptor-setsdevice1write0
cffi:null-pointer
values
defunupdate-uniform-buffer-descriptor
devicedescriptor-setbufferbuffer-size&key
binding0
with-vk
buffer-infodescriptor-buffer-info:bufferbuffer:offset0:rangebuffer-size
with-vk
writewrite-descriptor-set:dst-setdescriptor-set:dst-bindingbinding:dst-array-element0:descriptor-count1:descriptor-type:uniform-buffer:p-image-info
cffi:null-pointer
:p-buffer-infobuffer-info:p-texel-buffer-viewcffi:null-pointer
vk:update-descriptor-setsdevice1write0
cffi:null-pointer
values
defunupdate-texture-sampler-uniform-descriptors
devicedescriptor-setentries
let
image-count
count-if
lambda
entriesentry
member
getfentry:type
':texture:sampler
buffer-count
count-if
lambda
entriesentry
member
getfentry:type
':uniform-buffer:storage-buffer
write-count
lengthentries
cffi:with-foreign-object
image-infos'
:structdescriptor-image-info
cffi:with-foreign-object
buffer-infos'
:structdescriptor-buffer-info
cffi:with-foreign-object
writes'
:structwrite-descriptor-set
write-countloopwithimage-index=0withbuffer-index=0forentryinentriesforwrite-indexfrom0fortype=
getfentry:type
forwrite=doecasetype
:texture
let
image-info
fill-vkimage-info'descriptor-image-info:sampler
cffi:null-pointer
:image-viewgetfentry:image-view
:image-layout:shader-read-only-optimalfill-vkwrite'write-descriptor-set:dst-setdescriptor-set:dst-binding
getfentry:binding
:dst-array-element0:descriptor-count1:descriptor-type:sampled-image:p-image-infoimage-info:p-buffer-infocffi:null-pointer
:p-texel-buffer-viewcffi:null-pointer
incfimage-index
:sampler
let
image-info
fill-vkimage-info'descriptor-image-info:sampler
getfentry:sampler
:image-viewcffi:null-pointer
:image-layout:undefinedfill-vkwrite'write-descriptor-set:dst-setdescriptor-set:dst-binding
getfentry:binding
:dst-array-element0:descriptor-count1:descriptor-type:sampler:p-image-infoimage-info:p-buffer-infocffi:null-pointer
:p-texel-buffer-viewcffi:null-pointer
incfimage-index
:uniform-buffer:storage-buffer
let
buffer-info
fill-vkwrite'write-descriptor-set:dst-setdescriptor-set:dst-binding
getfentry:binding
:dst-array-element0:descriptor-count1:descriptor-typetype:p-image-infocffi:null-pointer
:p-buffer-infobuffer-info:p-texel-buffer-viewcffi:null-pointer
incfbuffer-index
vk:update-descriptor-setsdevicewrite-countwrites0
cffi:null-pointer
values
defuncreate-command-pool
devicequeue-family-index&keyflags
with-vk
create-infocommand-pool-create-info:flagsflags:queue-family-indexqueue-family-index
defundestroy-command-pool
devicecommand-pool
values
defunallocate-command-buffer
devicecommand-pool&key
level:primary
with-vk
allocate-infocommand-buffer-allocate-info:command-poolcommand-pool:levellevel:command-buffer-count1
defunbegin-command-buffer
command-buffer&keyflags
with-vk
command-bufferbegin-infocommand-buffer-begin-info:flagsflags:p-inheritance-info
cffi:null-pointer
with-vulkan-results
:begin-command-buffer
defunend-command-buffer
command-buffer
with-vulkan-results
command-buffer:end-command-buffer
vk:end-command-buffercommand-buffer
defunfill-image-subresource-range
rangeaspect
fill-vkrange'image-subresource-range:aspect-mask
listaspect
:base-mip-level0:level-count1:base-array-layer0:layer-count1defunfill-color-subresource-range
range
defuncmd-transition-image
command-bufferimageold-layoutnew-layoutsrc-accessdst-accesssrc-stagedst-stage&key
aspect:color
with-vk
barrierimage-memory-barrier:src-access-masksrc-access:dst-access-maskdst-access:old-layoutold-layout:new-layoutnew-layout:src-queue-family-index+queue-family-ignored+:dst-queue-family-index+queue-family-ignored+:imageimage
vk:cmd-pipeline-barriercommand-buffersrc-stagedst-stagenil0
cffi:null-pointer
0cffi:null-pointer
1barriervalues
defuncmd-clear-color-image
with-vk
cffi:with-foreign-object
foreign-color'
:unionclear-color-value
let
components
loopforcomponentacrosscolorforindexfrom0below4do
setf
cffi:mem-arefcomponents:floatindex
componentvalues
defunfill-color-subresource-layers
layers
defuncmd-copy-image
with-vk
regionimage-copy
dolist
slot'
src-subresourcedst-subresource
dolist
slot'
src-offsetdst-offset
values
defuncmd-copy-buffer-to-image
with-vk
regionbuffer-image-copy:buffer-offsetbuffer-offset:buffer-row-lengthbuffer-row-length:buffer-image-heightbuffer-image-height
values
defuncmd-copy-image-to-buffer
with-vk
regionbuffer-image-copy:buffer-offset0:buffer-row-length0:buffer-image-height0
values
defuncmd-bind-compute-pipeline
command-bufferpipeline
vk:cmd-bind-pipelinecommand-buffer:computepipeline
values
defuncmd-bind-graphics-pipeline
command-bufferpipeline
vk:cmd-bind-pipelinecommand-buffer:graphicspipeline
values
defuncmd-bind-compute-descriptor-set
command-bufferpipeline-layoutdescriptor-set
with-foreign-array
sets:pointer
vectordescriptor-set
vk:cmd-bind-descriptor-setscommand-buffer:computepipeline-layout01sets0
cffi:null-pointer
values
defuncmd-bind-graphics-descriptor-set
command-bufferpipeline-layoutdescriptor-set
with-foreign-array
sets:pointer
vectordescriptor-set
vk:cmd-bind-descriptor-setscommand-buffer:graphicspipeline-layout01sets0
cffi:null-pointer
values
defuncmd-bind-vertex-buffer
command-bufferbindingbuffer&optional
offset0
with-foreign-array
buffers:pointer
vectorbuffer
with-foreign-array
offsets:uint64
vectoroffset
vk:cmd-bind-vertex-bufferscommand-bufferbinding1buffersoffsets
values
defuncmd-begin-color-render-pass
let*
cffi:with-foreign-object
clears'
:unionclear-value
clear-countloopforclear-colorinclear-colorsforattachment-indexfrom0forcolor=forcomponents=do
loopforcomponentacrossclear-colorforcomponent-indexbelow4do
setf
cffi:mem-arefcomponents:floatcomponent-index
componentwhendepth-clear-value
fill-vk'clear-depth-stencil-value:depth
coercedepth-clear-value'single-float
:stencil0with-vk
begin-inforender-pass-begin-info:render-passrender-pass:framebufferframebuffer:clear-value-countclear-count:p-clear-valuesclears
let
area
vk:cmd-begin-render-passcommand-bufferbegin-info:inline
values
defuncmd-begin-depth-render-pass
cffi:with-foreign-object
clears'
:unionclear-value
1with-vk
begin-inforender-pass-begin-info:render-passrender-pass:framebufferframebuffer:clear-value-count1:p-clear-valuesclears
let
area
vk:cmd-begin-render-passcommand-bufferbegin-info:inline
values
defuncmd-draw
command-buffervertex-count&optional
instance-count1
first-vertex0
first-instance0
values
defuncmd-bind-index-buffer
command-bufferbufferoffsetindex-type
values
defuncmd-draw-indexed
command-bufferindex-count&optional
instance-count1
first-index0
vertex-offset0
first-instance0
values
defunfill-semaphore-submit-infos
pointerentries
Fill pointer, an array of VkSemaphoreSubmitInfo, from entries.
Each entry is a list (SEMAPHORE STAGES &optional VALUE). STAGES is a PIPELINE-STAGE-FLAGS-2 keyword list. VALUE is meaningful only when SEMAPHORE is a timeline semaphore.
loopforindexbelow
pointerlengthentries
forentry=eltentriesindex
dodestructuring-bind
semaphorestages&optional
entryvalue0
defunsubmit-command-buffers
queuebuffers&key
wait-semaphores
signal-semaphores
Submit buffers through vkQueueSubmit2.
wait-semaphores and signal-semaphores are sequences of semaphore submit
entries as understood by fill-semaphore-submit-infos.
let
cffi:with-foreign-objects
buffer-infos'
:structcommand-buffer-submit-info
wait-infos'
:structsemaphore-submit-info
signal-infos'
:structsemaphore-submit-info
loopforindexbelowbuffer-countdo
with-vk
submitsubmit-info-2:flags0:wait-semaphore-info-countwait-count:p-wait-semaphore-infoswait-infos:command-buffer-info-countbuffer-count:p-command-buffer-infosbuffer-infos:signal-semaphore-info-countsignal-count:p-signal-semaphore-infossignal-infos
with-vulkan-results
:queue-submit-2
values
defunsubmit-command-buffer
queuecommand-buffer
defunsurface-supported-p
physical-devicequeue-family-indexsurface
cffi:with-foreign-object
supported:uint32
setf
cffi:mem-refsupported:uint32
0with-vulkan-results
:get-physical-device-surface-support
vk:get-physical-device-surface-support-khrphysical-devicequeue-family-indexsurfacesupported
not
zerop
cffi:mem-refsupported:uint32
defunget-surface-capabilities
physical-devicesurface
cffi:with-foreign-object
capabilities'
:structsurface-capabilities
with-vulkan-results
:get-physical-device-surface-capabilities
vk:get-physical-device-surface-capabilities-khrphysical-devicesurfacecapabilities
cffi:with-foreign-slots
min-image-countmax-image-countcurrent-transformsupported-composite-alphasupported-usage-flags
capabilities:structsurface-capabilities
make-presentation-capabilities:min-image-countmin-image-count:max-image-countmax-image-count:current-extent:min-image-extent:max-image-extent:current-transformcurrent-transform:composite-alphasupported-composite-alpha:usagesupported-usage-flags
defunget-presentation-timing-surface-capabilities
physical-devicesurface
Return timing and present-id capabilities for this particular surface.
with-vk
present-idsurface-capabilities-present-id-2:present-id-2-supported0
with-vk
timingpresent-timing-surface-capabilities:p-nextpresent-id:present-timing-supported0:present-at-absolute-time-supported0:present-at-relative-time-supported0:present-stage-queriesnil
with-vk
capabilitiessurface-capabilities-2:p-nexttiming
with-vk
surface-infophysical-device-surface-info-2:surfacesurface
with-vulkan-results
:get-physical-device-surface-capabilities-2
vk:get-physical-device-surface-capabilities2khrphysical-devicesurface-infocapabilities
cffi:with-foreign-slots
present-timing-supportedpresent-at-absolute-time-supportedpresent-at-relative-time-supportedpresent-stage-queries
timingdefunextract-surface-format
formatsindex
let
format
cffi:with-foreign-slots
formatcolor-space
format:structsurface-format
make-presentation-format:formatformat:color-spacecolor-space
define-enumeratorget-surface-formats
physical-devicesurface
vk:get-physical-device-surface-formats-khrphysical-devicesurface
:element:structsurface-format
:extractorextract-surface-formatdefine-enumeratorget-surface-present-modes
physical-devicesurface
vk:get-physical-device-surface-present-modes-khrphysical-devicesurface
:elementpresent-modedefine-enumeratorget-swapchain-images
deviceswapchain
vk:get-swapchain-images-khrdeviceswapchain
:element:pointerdefuncreate-swapchain
devicesurfaceformatcolor-spaceextent&keymin-image-count
usage'
:transfer-dst
pre-transform:identity
composite-alpha:opaque
present-mode:fifo-khr
old-swapchainpresent-timing-pwith-vk
create-infoswapchain-create-info:flags
ifpresent-timing-p'
:surfacesurface:min-image-countmin-image-count:image-formatformat:image-color-spacecolor-space:image-array-layers1:image-usageusage:image-sharing-mode:exclusive:queue-family-index-count0:p-queue-family-indices:present-id-2-khr:present-timing-ext
nilcffi:null-pointer
:pre-transformpre-transform:composite-alphacomposite-alpha:present-modepresent-mode:clipped1:old-swapchaindefunset-swapchain-present-timing-queue-size
deviceswapchainsize
with-vulkan-results
size:set-swapchain-present-timing-queue-size
vk:set-swapchain-present-timing-queue-size-extdeviceswapchainsize
defunget-swapchain-timing-properties
deviceswapchain
Return current swapchain timing properties, or NIL while they are warming.
with-vk
propertiesswapchain-timing-properties:refresh-duration0:refresh-interval0
cffi:with-foreign-object
counter:uint64
setf
cffi:mem-refcounter:uint64
0let
result
with-vulkan-results
:get-swapchain-timing-properties:success:not-ready
vk:get-swapchain-timing-properties-extdeviceswapchainpropertiescounter
when
eqresult:success
cffi:with-foreign-slots
refresh-durationrefresh-interval
properties:structswapchain-timing-properties
values
make-swapchain-timing-properties:refresh-durationrefresh-duration:refresh-intervalrefresh-interval
cffi:mem-refcounter:uint64
defunget-swapchain-time-domains
deviceswapchain
Return (TIME-DOMAIN . ID) pairs, or NIL while they are warming.
labels
query
propertiescounter
with-vulkan-results
:get-swapchain-time-domain-properties:success:incomplete:not-ready
vk:get-swapchain-time-domain-properties-extdeviceswapchainpropertiescounter
with-vk
propertiesswapchain-time-domain-properties:time-domain-count0:p-time-domains
cffi:null-pointer
:p-time-domain-idscffi:null-pointer
cffi:with-foreign-object
counter:uint64
setf
cffi:mem-refcounter:uint64
0defunmap-past-presentation-timings
Call function for each complete timing as ID, STAGE, TIME, DOMAIN, DOMAIN-ID.
with-vk
infopast-presentation-timing-info:flagsnil:swapchainswapchain
with-vk
propertiespast-presentation-timing-properties:timing-properties-counter0:time-domains-counter0:presentation-timing-count0:p-presentation-timings
cffi:null-pointer
with-vulkan-results
:get-past-presentation-timing
vk:get-past-presentation-timing-extdeviceinfoproperties
let
count
cffi:foreign-slot-valueproperties''presentation-timing-count
when
pluspcount
cffi:with-foreign-object
timings'
:structpast-presentation-timing
countcffi:with-foreign-object
stages'
:structpresent-stage-time
countdotimes
indexcount
fill-vk'past-presentation-timing:present-id0:target-time0:present-stage-count1:p-present-stages:time-domain:device:time-domain-id0:report-complete0
setf
cffi:foreign-slot-valueproperties''presentation-timing-count
counttimingswith-vulkan-results
:get-past-presentation-timing:success:incomplete
vk:get-past-presentation-timing-extdeviceinfoproperties
dotimes
index
cffi:foreign-slot-valueproperties''presentation-timing-count
let
timing
cffi:with-foreign-slots
present-idpresent-stage-countp-present-stagestime-domaintime-domain-idreport-complete
timing:structpast-presentation-timing
when
cffi:with-foreign-slots
stagetime
p-present-stages:structpresent-stage-time
values
defuncreate-semaphore
device
with-vk
create-infosemaphore-create-info:flags0
defuncreate-timeline-semaphore
device&key
initial-value0
Create a timeline semaphore whose 64-bit counter starts at initial-value.
with-vk
type-infosemaphore-type-create-info:semaphore-type:timeline:initial-valueinitial-value
with-vk
create-infosemaphore-create-info:p-nexttype-info:flags0
defunsemaphore-counter-value
devicesemaphore
Return the current 64-bit counter of a timeline semaphore.
cffi:with-foreign-object
value:uint64
with-vulkan-results
:get-semaphore-counter-value
vk:get-semaphore-counter-valuedevicesemaphorevalue
cffi:mem-refvalue:uint64
defunwait-semaphore-value
devicesemaphorevalue&key
timeout#xffffffffffffffff
Block until timeline semaphore's counter reaches at least value.
with-foreign-array
semaphores:pointer
vectorsemaphore
cffi:with-foreign-object
values:uint64
setf
cffi:mem-refvalues:uint64
valuewith-vk
wait-infosemaphore-wait-info:flags0:semaphore-count1:p-semaphoressemaphores:p-valuesvalues
with-vulkan-results
:wait-semaphores
vk:wait-semaphoresdevicewait-infotimeout
values
defunacquire-next-image
deviceswapchainsemaphore&key
timeout#xffffffffffffffff
cffi:with-foreign-object
index:uint32
let
result
An out-of-date swapchain is an ordinary answer rather than a failure: the window changed size and the caller is expected to rebuild. Report it as the second value instead of signalling.
with-vulkan-results
:acquire-next-image:success:suboptimal-khr:error-out-of-date-khr
vk:acquire-next-image-khrdeviceswapchaintimeoutsemaphore
cffi:null-pointer
indexvalues
cffi:mem-refindex:uint32
resultdefunpresent
queueswapchainimage-index&key
wait-semaphores
present-idpresent-stagetime-domain-idtarget-timetarget-time-domain-present-stagewith-foreign-array
waits:pointerwait-semaphores
with-foreign-array
swapchains:pointer
vectorswapchain
with-foreign-array
indices:uint32
vectorimage-index
cffi:with-foreign-object
present-ids:uint64
setf
cffi:mem-refpresent-ids:uint64
with-vk
timingpresent-timing-info:flags
iftarget-time'
:target-time:time-domain-id:present-stage-queries:present-at-nearest-refresh-cycle
nilifpresent-stage
:target-time-domain-present-stagelistpresent-stage
niliftarget-time-domain-present-stage
listtarget-time-domain-present-stage
nilwith-vk
timingspresent-timings-info:swapchain-count1:p-timing-infostiming
with-vk
idpresent-id-2:p-next
ifpresent-stagetimings
:swapchain-count1:p-present-idspresent-idscffi:null-pointer
with-vk
present-infopresent-info:p-next
ifpresent-idid
:wait-semaphore-countcffi:null-pointer
lengthwait-semaphores
:p-wait-semaphoreswaits:swapchain-count1:p-swapchainsswapchains:p-image-indicesindices:p-resultscffi:null-pointer
with-vulkan-results
:present:success:suboptimal-khr:error-out-of-date-khr:error-present-timing-queue-full-ext
defmacro define-enumerator
(name lambda-list call &key element extractor
(operation (intern (symbol-name name) :keyword)))defclass element
A block-level piece of an Org document.
defmacro with-vulkan-results
((operation &rest accepted-results) &body body)define-arithmetic-operator =
Test whether two compatible scalars are equal.
defun clear-foreign-object
(pointer type &optional (count 1))defmacro define-creator
(name lambda-list call &key (element :pointer) checked
(operation (intern (symbol-name name) :keyword)))defun extension-property-name
(properties index)defun create-instance
(&key
(application-name "luv")
((:application-version application-version-value)
(make-version 0 0 1))
(engine-name "luv")
((:engine-version engine-version-value) (make-version 0 0 1))
;; Luv assumes modern Vulkan. Timeline semaphores and
;; synchronization2 are mandatory core features at this version.
((:api-version api-version-value) (make-version 1 4 0))
flags
enabled-extension-names)defun create-device
(physical-device family-index &key enabled-extension-names
additional-family-indices)defun get-device-queue
(device queue-family-index &optional (queue-index 0))defun create-image
(device &key type format width height (depth 1) usage
(mip-levels 1) (array-layers 1) (samples :1)
(tiling :optimal) (sharing-mode :exclusive)
(initial-layout :undefined))defun create-buffer
(device size usage)defun allocate-memory
(device size memory-type-index)defun create-image-view
(device image format &key (view-type :2d) (aspect :color))defun create-shader-module
(device words)defun create-pipeline-layout
(device set-layouts)defun create-sampler
(device &key (mag-filter :linear) (min-filter :linear)
(mipmap-mode :nearest)
(address-mode-u :clamp-to-edge)
(address-mode-v :clamp-to-edge)
(address-mode-w :clamp-to-edge)
compare)defun create-framebuffer
(device render-pass image-views width height &key depth-view)defun create-command-pool
(device queue-family-index &key flags)defun create-semaphore
(device)defun usage
(&optional (stream *standard-output*))defun make-version
(major minor patch)defmacro with-translated-values
(bindings &body body)defmacro with-vk
((variable type &rest fields) &body body)defun destroy-instance
(instance)defun nullable-foreign-string
(pointer)defun instance-procedure
(instance name)defun install-debug-messenger
(instance callback
&key
(severities '(:warning :error))
(types '(:general :validation :performance)))Install CALLBACK for INSTANCE and return an owned DEBUG-MESSENGER. CALLBACK receives one DEBUG-MESSAGE. VK_EXT_debug_utils must have been enabled when INSTANCE was created. Keep the returned messenger alive and destroy it before destroying INSTANCE.
define-arithmetic-operator or
Logical disjunction of tests and raw truth values.
defun destroy-debug-messenger
(messenger)defun physical-device-queue-families
(physical-device)define-arithmetic-operator min
The minimum of compatible quantities.
defun physical-device-shader-int64-p
(physical-device)define-arithmetic-operator not
Logical negation of one test or raw truth value.
defun physical-device-mesh-shader-p
(physical-device)define-arithmetic-operator and
Logical conjunction of tests and raw truth values.
defparameter +mesh-shader-extension-name+
VK_EXT_mesh_shader
defun physical-device-presentation-features
(physical-device &key present-timing-p present-id-2-p)Return the optional presentation feature bits exposed by PHYSICAL-DEVICE. The values are PRESENT-TIMING, PRESENT-AT-ABSOLUTE-TIME, PRESENT-AT-RELATIVE-TIME, and PRESENT-ID-2. A feature whose extension was not advertised is never placed in the query chain and is returned as NIL.
defparameter +present-timing-extension-name+
VK_EXT_present_timing
defparameter +present-id-2-extension-name+
VK_KHR_present_id2
defun fill-vk
(pointer type &rest fields)defun destroy-device
(device)defun device-wait-idle
(device)defun physical-device-memory-types
(physical-device)define-style type
Headings, paragraphs, figures and their IDs, mentions, marks.
defun destroy-image
(device image)defun get-image-memory-requirements
(device image)defun destroy-buffer
(device buffer)defun get-buffer-memory-requirements
(device buffer)defun free-memory
(device memory)defun bind-image-memory
(device image memory &optional (offset 0))defun bind-buffer-memory
(device buffer memory &optional (offset 0))defun map-memory
(device memory size &optional (offset 0))defun unmap-memory
(device memory)defun fill-image-subresource-range
(range aspect)defun destroy-image-view
(device view)defmacro with-foreign-array
((pointer type values) &body body)define-arithmetic-operator *
Multiplication and scalar scaling.
defun destroy-shader-module
(device shader-module)defun shader-module
(specification)defun create-storage-image-descriptor-set-layout
(device &key (binding 0))defun create-uniform-buffer-descriptor-set-layout
(device &key (binding 0) (stages '(:vertex)))defun create-texture-sampler-uniform-descriptor-set-layout
(device entries)defun destroy-descriptor-set-layout
(device layout)defclass layout
How the children of a list are arranged.
define-style layouts
Layouts: binding grids, clauses, loop rows. The selectors are the roles dexp.lisp assigns.
defun destroy-pipeline-layout
(device layout)defun create-compute-pipeline
(device shader-module layout &key (entry-point "main"))defun destroy-sampler
(device sampler)defun vulkan-attachment-store-op
(store-op)defun create-color-render-pass
(device formats &key depth-format (depth-store-op :discard))define-arithmetic-operator +
Addition over compatible quantities.
defun create-depth-render-pass
(device depth-format &key (depth-store-op :store))defun destroy-render-pass
(device render-pass)defun destroy-framebuffer
(device framebuffer)defun call-with-vertex-input-descriptions
(vertex-buffers function)defun call-with-depth-stencil-state
(depth-compare depth-write-enabled function)defun call-with-color-blend-attachments
(blends function)defun create-graphics-pipeline
(device vertex-module fragment-module layout render-pass
&key (vertex-entry-point "main") (fragment-entry-point "main")
(topology :triangle-strip) vertex-buffers
depth-compare depth-write-enabled blends blend)defun device-procedure
(device name)defun create-mesh-graphics-pipeline
(device mesh-module fragment-module layout render-pass
&key task-module (task-entry-point "main") (mesh-entry-point "main")
(fragment-entry-point "main")
depth-compare depth-write-enabled blends blend)Link a task, mesh, and fragment stage into one VK_EXT_mesh_shader pipeline. A mesh pipeline draws no vertices, so it carries neither a vertex input nor an input assembly state; the mesh stage's own OpExecutionMode names its output topology.
defun cmd-draw-mesh-tasks
(device command-buffer x y z)defun destroy-pipeline
(device pipeline)defun create-storage-image-descriptor-pool
(device &key (max-sets 1))defun create-uniform-buffer-descriptor-pool
(device &key (max-sets 1))defun create-texture-sampler-uniform-descriptor-pool
(device entries &key (max-sets 1))defun destroy-descriptor-pool
(device pool)defun allocate-descriptor-set
(device pool layout)defun update-storage-image-descriptor
(device descriptor-set image-view &key (binding 0))defun update-uniform-buffer-descriptor
(device descriptor-set buffer buffer-size &key (binding 0))defun update-texture-sampler-uniform-descriptors
(device descriptor-set entries)define-arithmetic-operator max
The maximum of compatible quantities.
defun destroy-command-pool
(device command-pool)defun allocate-command-buffer
(device command-pool &key (level :primary))defun begin-command-buffer
(command-buffer &key flags)defun end-command-buffer
(command-buffer)defun cmd-transition-image
(command-buffer image old-layout new-layout
src-access dst-access src-stage dst-stage &key (aspect :color))defun cmd-clear-color-image
(command-buffer image layout color)defun cmd-copy-image
(command-buffer source source-layout destination destination-layout
width height &optional (depth 1))defun cmd-copy-buffer-to-image
(command-buffer buffer image layout width height
&key (buffer-offset 0) (buffer-row-length 0)
(buffer-image-height 0) (x 0) (y 0) (depth 1))defun cmd-copy-image-to-buffer
(command-buffer image layout buffer width height &optional (depth 1))defun cmd-bind-compute-pipeline
(command-buffer pipeline)defun cmd-bind-graphics-pipeline
(command-buffer pipeline)defun cmd-bind-compute-descriptor-set
(command-buffer pipeline-layout descriptor-set)defun cmd-bind-graphics-descriptor-set
(command-buffer pipeline-layout descriptor-set)defun cmd-bind-vertex-buffer
(command-buffer binding buffer &optional (offset 0))defun cmd-dispatch
(command-buffer x y &optional (z 1))defun cmd-begin-color-render-pass
(command-buffer render-pass framebuffer width height clear-colors
&key depth-clear-value)defun cmd-begin-depth-render-pass
(command-buffer render-pass framebuffer width height depth-clear-value)defun cmd-set-viewport-and-scissor
(command-buffer width height)defun cmd-set-scissor
(command-buffer x y width height)defun cmd-end-render-pass
(command-buffer)defun cmd-draw
(command-buffer vertex-count &optional (instance-count 1)
(first-vertex 0) (first-instance 0))defun cmd-bind-index-buffer
(command-buffer buffer offset index-type)defun cmd-draw-indexed
(command-buffer index-count &optional (instance-count 1)
(first-index 0) (vertex-offset 0)
(first-instance 0))defun fill-semaphore-submit-infos
(pointer entries)Fill POINTER, an array of VkSemaphoreSubmitInfo, from ENTRIES. Each entry is a list (SEMAPHORE STAGES &optional VALUE). STAGES is a PIPELINE-STAGE-FLAGS-2 keyword list. VALUE is meaningful only when SEMAPHORE is a timeline semaphore.
defun submit-command-buffers
(queue buffers &key (wait-semaphores #()) (signal-semaphores #()))Submit BUFFERS through vkQueueSubmit2. WAIT-SEMAPHORES and SIGNAL-SEMAPHORES are sequences of semaphore submit entries as understood by FILL-SEMAPHORE-SUBMIT-INFOS.
defgeneric submit
(queue work)Schedule some command buffers on the QUEUE. Submission is asynchronous: returning does not mean the GPU has finished the work, only that the implementation retains everything the work depends on until it completes. Use SUBMITTED-WORK-DONE to wait.
defun submit-command-buffer
(queue command-buffer)defun queue-wait-idle
(queue)defun surface-supported-p
(physical-device queue-family-index surface)defun read-extent-2d
(pointer)defun get-surface-capabilities
(physical-device surface)defun get-presentation-timing-surface-capabilities
(physical-device surface)defun extract-surface-format
(formats index)defun create-swapchain
(device surface format color-space extent
&key min-image-count (usage '(:transfer-dst))
(pre-transform :identity) (composite-alpha :opaque)
(present-mode :fifo-khr) old-swapchain present-timing-p)defun set-swapchain-present-timing-queue-size
(device swapchain size)defun get-swapchain-timing-properties
(device swapchain)defun get-swapchain-time-domains
(device swapchain)define-command ids
(&optional (count "12"))Print COUNT fresh figure IDs that no page uses (default 12); never six hex digits, which the reader takes for a colour.
defun map-past-presentation-timings
(device swapchain function)defun destroy-swapchain
(device swapchain)defun create-timeline-semaphore
(device &key (initial-value 0))defun destroy-semaphore
(device semaphore)defun semaphore-counter-value
(device semaphore)defun wait-semaphore-value
(device semaphore value &key (timeout #xffffffffffffffff))defun acquire-next-image
(device swapchain semaphore &key (timeout #xffffffffffffffff))defun present
(queue swapchain image-index
&key (wait-semaphores #()) present-id present-stage time-domain-id
target-time target-time-domain-present-stage)
Lisp-shaped Vulkan operations built on the owned ABI.
The raw `vk:` entry points and structs stay in defs.lisp; this file gives the GPU and canvas backends the small, direct `lvk:` vocabulary they use.