API
API reference
The Haxe API of every hxn library at its released version: hxn, hxn-window, hxn-av, hxnsl, hxn-gpu and the hxn GPU drivers.
hxn
Futures, streams, signals, reactive values, atomics and callbacks: the Haxe classes every hxn library uses.
0.2.1 / 43 typeshxn-window
Native and browser windows, input, monitors, gamepads and the clipboard, with handles for GPU surfaces.
0.2.0 / 41 typeshxn-av
Audio and video with the platform's codecs: playback, frames, PCM audio, an equalizer, AAC, H.264 and MP4.
0.2.0 / 8 typeshxnsl
Shaders written in HXSL and translated at compile time to WGSL, MSL, HLSL, SPIR-V and GLSL ES.
0.2.3 / 46 typeshxn-gpu
One GPU API over every hxn GPU driver, with features and limits per device and a default backend per platform.
0.2.0 / 28 typeshxn-gpu-metal
Metal on macOS and iOS: compute and render passes, with hxnsl shaders compiled into Metal libraries.
0.3.0 / 33 typeshxn-gpu-vulkan
Vulkan on Linux, Windows, Android and macOS: compute, rendering, explicit barriers and swapchains.
0.2.0 / 29 typeshxn-gpu-d3d12
Direct3D 12 on Windows: compute, rendering, textures and swapchains, with transitions or enhanced barriers.
0.3.0 / 18 typeshxn-gpu-gles
OpenGL ES 3.0 over EGL on Android, Linux, macOS and Windows: rendering, textures and windows.
0.3.3 / 35 typeshxn-gpu-webgpu
WebGPU in the browser, on hxcpp and Ash compiled to wasm: compute, rendering and the web page's canvas.
0.3.2 / 17 typeshxn-gpu-webgl2
WebGL2 in the browser, on hxcpp and Ash compiled to wasm, for browsers without WebGPU.
Every type
Accesshxn-gpu-d3d12 · hxn.gpu.d3d12Accesshxn-gpu-vulkan · hxn.gpu.vulkanAdapterhxn-gpu-webgpu · hxn.gpu.webgpuAddressModehxn-gpu · hxn.gpuAddressModehxn-gpu-d3d12 · hxn.gpu.d3d12AddressModehxn-gpu-metal · hxn.gpu.metalAddressModehxn-gpu-vulkan · hxn.gpu.vulkanAddressModehxn-gpu-webgpu · hxn.gpu.webgpuAtomicBoolhxn · hxnAtomicInthxn · hxnAttentionhxn-window · hxn.windowAudioDatahxn-av · hxn.avAudioDataCopyToOptionshxn-av · hxn.avAudioDataInithxn-av · hxn.avAudioDecoderhxn-av · hxn.avAudioEncoderhxn-av · hxn.avAudioEqualizerhxn-av · hxn.avAudioSampleFormathxn-av · hxn.avBackendhxn-gpu · hxn.gpuBarrierSynchxn-gpu-d3d12 · hxn.gpu.d3d12BindGrouphxn-gpu · hxn.gpuBindGrouphxn-gpu-webgpu · hxn.gpu.webgpuBindGroupDescriptorhxn-gpu · hxn.gpuBindGroupEntrieshxn-gpu-webgpu · hxn.gpu.webgpuBindGroupEntryhxn-gpu · hxn.gpuBindGroupLayoutshxn-gpu-webgpu · hxn.gpu.webgpuBindingKindhxn-gpu-webgpu · hxn.gpu.webgpuBindPointhxn-gpu-vulkan · hxn.gpu.vulkanBufferhxn-gpu · hxn.gpuBufferhxn-gpu-d3d12 · hxn.gpu.d3d12Bufferhxn-gpu-gles · hxn.gpu.glesBufferhxn-gpu-metal · hxn.gpu.metalBufferhxn-gpu-vulkan · hxn.gpu.vulkanBufferhxn-gpu-webgl2 · hxn.gpu.webgl2Bufferhxn-gpu-webgpu · hxn.gpu.webgpuBufferDescriptorhxn-gpu · hxn.gpuBufferTargethxn-gpu-gles · hxn.gpu.glesBufferTargethxn-gpu-webgl2 · hxn.gpu.webgl2BufferUsagehxn-gpu · hxn.gpuBufferUsagehxn-gpu-vulkan · hxn.gpu.vulkanBufferUsagehxn-gpu-webgpu · hxn.gpu.webgpuCallbackhxn · hxnClearBitshxn-gpu-gles · hxn.gpu.glesClearBitshxn-gpu-webgl2 · hxn.gpu.webgl2ClipboardItemshxn-window · hxn.windowCodecConfigurationhxn-av · hxn.avColorhxn-gpu · hxn.gpuColorSpacehxn-av · hxn.avCommandhxn-gpu · hxn.gpuCommandBufferhxn-gpu-metal · hxn.gpu.metalCommandBufferhxn-gpu-vulkan · hxn.gpu.vulkanCommandEncoderhxn-gpu · hxn.gpuCommandEncoderhxn-gpu-webgpu · hxn.gpu.webgpuCommandListhxn-gpu-d3d12 · hxn.gpu.d3d12CommandQueuehxn-gpu-metal · hxn.gpu.metalComponentTypehxn-gpu-gles · hxn.gpu.glesComponentTypehxn-gpu-webgl2 · hxn.gpu.webgl2Computedhxn · hxnComputeEncoderhxn-gpu-metal · hxn.gpu.metalComputePasshxn-gpu · hxn.gpuComputePasshxn-gpu-webgpu · hxn.gpu.webgpuComputePipelinehxn-gpu · hxn.gpuComputePipelinehxn-gpu-metal · hxn.gpu.metalComputePipelinehxn-gpu-webgpu · hxn.gpu.webgpuComputePipelineDescriptorhxn-gpu · hxn.gpuConstanthxn-gpu-webgpu · hxn.gpu.webgpuContexthxn-gpu-gles · hxn.gpu.glesContexthxn-gpu-webgl2 · hxn.gpu.webgl2CursorGrabhxn-window · hxn.windowCursorIconhxn-window · hxn.windowCursorRangehxn-window · hxn.windowDefaultLimitshxn-gpu · hxn.gpuDescriptorHeaphxn-gpu-d3d12 · hxn.gpu.d3d12DescriptorSethxn-gpu-vulkan · hxn.gpu.vulkanDescriptorTypehxn-gpu-vulkan · hxn.gpu.vulkanDevicehxn-gpu-d3d12 · hxn.gpu.d3d12Devicehxn-gpu-metal · hxn.gpu.metalDevicehxn-gpu-vulkan · hxn.gpu.vulkanDevicehxn-gpu-webgpu · hxn.gpu.webgpuDeviceEventhxn-window · hxn.windowDeviceEventshxn-window · hxn.windowDisplayhxn-gpu-gles · hxn.gpu.glesDOMRectInithxn-av · hxn.avDrawablehxn-gpu-metal · hxn.gpu.metalEncodedAudioChunkhxn-av · hxn.avEncodedAudioChunkInithxn-av · hxn.avEncodedChunkTypehxn-av · hxn.avEncodedVideoChunkhxn-av · hxn.avEncodedVideoChunkInithxn-av · hxn.avEntryPointhxnsl · hxnslEventhxn-window · hxn.windowFactoryhxn-gpu-d3d12 · hxn.gpu.d3d12Featurehxn-gpu · hxn.gpuFeatureshxn-gpu · hxn.gpuFilePathhxn-window · hxn.windowFilterhxn-gpu · hxn.gpuFilterhxn-gpu-d3d12 · hxn.gpu.d3d12Filterhxn-gpu-gles · hxn.gpu.glesFilterhxn-gpu-metal · hxn.gpu.metalFilterhxn-gpu-vulkan · hxn.gpu.vulkanFilterhxn-gpu-webgl2 · hxn.gpu.webgl2Filterhxn-gpu-webgpu · hxn.gpu.webgpuFormathxn-gpu-d3d12 · hxn.gpu.d3d12Formathxn-gpu-vulkan · hxn.gpu.vulkanFormathxn-gpu-webgpu · hxn.gpu.webgpuFramebufferhxn-gpu-gles · hxn.gpu.glesFramebufferhxn-gpu-webgl2 · hxn.gpu.webgl2Functionhxn-gpu-metal · hxn.gpu.metalFuturehxn · hxnGamepadhxn-window · hxn.windowGamepadAxishxn-window · hxn.windowGamepadButtonhxn-window · hxn.windowGamepadEventhxn-window · hxn.windowGchxn · hxnGlslBindingshxnsl · hxnslGlslTexturehxnsl · hxnslGpuDevicehxn-gpu · hxn.gpuGpuSurfacehxn-gpu · hxn.gpuGroupLayouthxn-gpu-webgpu · hxn.gpu.webgpuHeaphxn-gpu-d3d12 · hxn.gpu.d3d12HeapKindhxn-gpu-d3d12 · hxn.gpu.d3d12HlslBindinghxnsl · hxnslHxnGpuD3d12Memoryhxn-gpu-d3d12 · hxn.gpu.d3d12HxnGpuGlesMemoryhxn-gpu-gles · hxn.gpu.glesHxnGpuMetalMemoryhxn-gpu-metal · hxn.gpu.metalHxnGpuVulkanMemoryhxn-gpu-vulkan · hxn.gpu.vulkanHxnGpuWebgl2Memoryhxn-gpu-webgl2 · hxn.gpu.webgl2HxnGpuWebgpuMemoryhxn-gpu-webgpu · hxn.gpu.webgpuHxnXaviMemoryhxn-av · hxn.avHxnXwindowMemoryhxn-window · hxn.windowImagehxn-gpu-vulkan · hxn.gpu.vulkanImageDescriptorhxn-gpu-vulkan · hxn.gpu.vulkanImageUsagehxn-gpu-vulkan · hxn.gpu.vulkanImehxn-window · hxn.windowImePurposehxn-window · hxn.windowInboxhxn · hxnIndexFormathxn-gpu · hxn.gpuInstancehxn-gpu-vulkan · hxn.gpu.vulkanInstancehxn-gpu-webgpu · hxn.gpu.webgpuKeyhxn-window · hxn.windowKeyCodehxn-window · hxn.windowKeyEventhxn-window · hxn.windowKeyLocationhxn-window · hxn.windowKeySupplementhxn-window · hxn.windowLayerhxn-gpu-metal · hxn.gpu.metalLayouthxn-gpu-d3d12 · hxn.gpu.d3d12Layouthxn-gpu-vulkan · hxn.gpu.vulkanLayoutBindinghxn-gpu-vulkan · hxn.gpu.vulkanLayoutEntryhxn-gpu-webgpu · hxn.gpu.webgpuLayoutEntryhxnsl · hxnslLibraryhxn-gpu-metal · hxn.gpu.metalLimitshxn-gpu · hxn.gpuLoadActionhxn-gpu-metal · hxn.gpu.metalLoadOphxn-gpu-vulkan · hxn.gpu.vulkanLoophxn · hxnMediaDemuxerhxn-av · hxn.avMediaMuxerhxn-av · hxn.avMediaPayloadKindhxn-av · hxn.avMediaPlayerhxn-av · hxn.avMediaQueuehxn-av · hxn.avMeterhxn · hxnModifiershxn-window · hxn.windowModifiersKeyStatehxn-window · hxn.windowMonitorhxn-window · hxn.windowMouseButtonhxn-window · hxn.windowMouseElementStatehxn-window · hxn.windowMouseScrollDeltahxn-window · hxn.windowMslEntryhxnsl · hxnslMslResourcehxnsl · hxnslNamedKeyhxn-window · hxn.windowNativeKeyhxn-window · hxn.windowNativeKeyCodehxn-window · hxn.windowNativeWindowhxn-gpu · hxn.gpuOpenOptionshxn-gpu · hxn.gpuOptionalBoolhxn-av · hxn.avOptionalByteshxn-window · hxn.windowOptionalDurationhxn-av · hxn.avOptionalFloathxn-window · hxn.windowOptionalMatrixhxn-av · hxn.avOptionalPrimarieshxn-av · hxn.avOptionalTexthxn-window · hxn.windowOptionalTransferhxn-av · hxn.avParameterKindhxn-gpu-d3d12 · hxn.gpu.d3d12PhysicalKeyhxn-window · hxn.windowPipelinehxn-gpu · hxn.gpuPipelinehxn-gpu-vulkan · hxn.gpu.vulkanPipelineLayouthxn-gpu-vulkan · hxn.gpu.vulkanPipelineLayouthxn-gpu-webgpu · hxn.gpu.webgpuPipelineStatehxn-gpu-d3d12 · hxn.gpu.d3d12PixelFormathxn-gpu-metal · hxn.gpu.metalPixelRecthxn-av · hxn.avPlaneLayouthxn-av · hxn.avPlaneLayoutshxn-av · hxn.avPlaybackStatehxn-av · hxn.avPrimitivehxn-gpu-gles · hxn.gpu.glesPrimitivehxn-gpu-metal · hxn.gpu.metalPrimitivehxn-gpu-webgl2 · hxn.gpu.webgl2Programhxn-gpu-gles · hxn.gpu.glesProgramhxn-gpu-webgl2 · hxn.gpu.webgl2RangeKindhxn-gpu-d3d12 · hxn.gpu.d3d12Reactivehxn · hxnRenderEncoderhxn-gpu-metal · hxn.gpu.metalRenderPasshxn-gpu · hxn.gpuRenderPasshxn-gpu-webgpu · hxn.gpu.webgpuRenderPipelinehxn-gpu · hxn.gpuRenderPipelinehxn-gpu-metal · hxn.gpu.metalRenderPipelinehxn-gpu-webgpu · hxn.gpu.webgpuRenderPipelineDescriptorhxn-gpu · hxn.gpuResizeDirectionhxn-window · hxn.windowResourcehxn-gpu · hxn.gpuRootParameterhxn-gpu-d3d12 · hxn.gpu.d3d12RootRangehxn-gpu-d3d12 · hxn.gpu.d3d12RootSignaturehxn-gpu-d3d12 · hxn.gpu.d3d12Samplerhxn-gpu · hxn.gpuSamplerhxn-gpu-gles · hxn.gpu.glesSamplerhxn-gpu-metal · hxn.gpu.metalSamplerhxn-gpu-vulkan · hxn.gpu.vulkanSamplerhxn-gpu-webgl2 · hxn.gpu.webgl2Samplerhxn-gpu-webgpu · hxn.gpu.webgpuSamplerDescriptorhxn-gpu · hxn.gpuSamplerDescriptorhxn-gpu-metal · hxn.gpu.metalSampleTypehxn-gpu-webgpu · hxn.gpu.webgpuScaleSizinghxn-window · hxn.windowSethxn · hxnSetLayouthxn-gpu-vulkan · hxn.gpu.vulkanSetLayoutshxn-gpu-vulkan · hxn.gpu.vulkanShaderhxn-gpu · hxn.gpuShaderhxnsl · hxnslShaderCodehxn-gpu · hxn.gpuShaderModulehxn-gpu · hxn.gpuShaderModulehxn-gpu-vulkan · hxn.gpu.vulkanShaderModulehxn-gpu-webgpu · hxn.gpu.webgpuShadershxn-gpu-d3d12 · hxn.gpu.d3d12Shadershxn-gpu-gles · hxn.gpu.glesShadershxn-gpu-metal · hxn.gpu.metalShadershxn-gpu-vulkan · hxn.gpu.vulkanShadershxn-gpu-webgl2 · hxn.gpu.webgl2Shadershxn-gpu-webgpu · hxn.gpu.webgpuShaderSourcehxn-gpu · hxn.gpuShaderStagehxn-gpu-vulkan · hxn.gpu.vulkanShaderStagehxn-gpu-webgpu · hxn.gpu.webgpuSignalhxn · hxnStagehxn-gpu-vulkan · hxn.gpu.vulkanStatehxn-gpu-d3d12 · hxn.gpu.d3d12Stephxn-gpu · hxn.gpuStorageAccesshxn-gpu-webgpu · hxn.gpu.webgpuStorageModehxn-gpu-metal · hxn.gpu.metalStreamhxn · hxnStreamReadStatushxn-av · hxn.avSurfacehxn-gpu-vulkan · hxn.gpu.vulkanSurfacehxn-gpu-webgpu · hxn.gpu.webgpuSurfaceTargethxn-gpu · hxn.gpuSurfaceTargetshxn-gpu · hxn.gpuSwapchainhxn-gpu-d3d12 · hxn.gpu.d3d12Swapchainhxn-gpu-vulkan · hxn.gpu.vulkanTexturehxn-gpu · hxn.gpuTexturehxn-gpu-d3d12 · hxn.gpu.d3d12Texturehxn-gpu-gles · hxn.gpu.glesTexturehxn-gpu-metal · hxn.gpu.metalTexturehxn-gpu-webgl2 · hxn.gpu.webgl2Texturehxn-gpu-webgpu · hxn.gpu.webgpuTextureDescriptorhxn-gpu · hxn.gpuTextureDescriptorhxn-gpu-d3d12 · hxn.gpu.d3d12TextureDescriptorhxn-gpu-metal · hxn.gpu.metalTextureFormathxn-gpu · hxn.gpuTextureFormathxn-gpu-gles · hxn.gpu.glesTextureFormathxn-gpu-webgl2 · hxn.gpu.webgl2TextureUsagehxn-gpu · hxn.gpuTextureUsagehxn-gpu-d3d12 · hxn.gpu.d3d12TextureUsagehxn-gpu-metal · hxn.gpu.metalTextureUsagehxn-gpu-webgpu · hxn.gpu.webgpuThemehxn-window · hxn.windowTopologyhxn-gpu · hxn.gpuTopologyhxn-gpu-d3d12 · hxn.gpu.d3d12Topologyhxn-gpu-vulkan · hxn.gpu.vulkanTopologyhxn-gpu-webgpu · hxn.gpu.webgpuTouchForcehxn-window · hxn.windowTouchPhasehxn-window · hxn.windowTuplehxn · hxnUnithxn · hxnUsagehxn-gpu-gles · hxn.gpu.glesUsagehxn-gpu-webgl2 · hxn.gpu.webgl2VertexArrayhxn-gpu-gles · hxn.gpu.glesVertexArrayhxn-gpu-webgl2 · hxn.gpu.webgl2VertexAttributehxn-gpu · hxn.gpuVertexAttributehxn-gpu-d3d12 · hxn.gpu.d3d12VertexAttributehxn-gpu-metal · hxn.gpu.metalVertexAttributehxn-gpu-vulkan · hxn.gpu.vulkanVertexAttributehxn-gpu-webgpu · hxn.gpu.webgpuVertexBindinghxn-gpu-vulkan · hxn.gpu.vulkanVertexBufferLayouthxn-gpu · hxn.gpuVertexFormathxn-gpu · hxn.gpuVertexFormathxn-gpu-metal · hxn.gpu.metalVertexFormathxn-gpu-webgpu · hxn.gpu.webgpuVertexLayouthxn-gpu-metal · hxn.gpu.metalVideoColorPrimarieshxn-av · hxn.avVideoColorSpaceInithxn-av · hxn.avVideoDecoderhxn-av · hxn.avVideoEncoderhxn-av · hxn.avVideoFramehxn-av · hxn.avVideoFrameBufferInithxn-av · hxn.avVideoFrameCopyToOptionshxn-av · hxn.avVideoMatrixCoefficientshxn-av · hxn.avVideoModehxn-window · hxn.windowVideoPixelFormathxn-av · hxn.avVideoTransferCharacteristicshxn-av · hxn.avViewDimensionhxn-gpu-webgpu · hxn.gpu.webgpuVisibilityhxn-gpu-d3d12 · hxn.gpu.d3d12Windowhxn-window · hxn.windowWindowAttributeshxn-window · hxn.windowWindowLevelhxn-window · hxn.windowWraphxn-gpu-gles · hxn.gpu.glesWraphxn-gpu-webgl2 · hxn.gpu.webgl2