hal

Apr 26, 2026

Changes in this version

type ComputeState — darwin/amd64, linux/amd64, windows/amd64

+ Constants map[string]float64

+ ZeroInitializeWorkgroupMemory bool

Apr 25, 2026

Changes in this version

type Queue — darwin/amd64, linux/amd64, windows/amd64

+ SetSwapchainSuppressed func(suppressed bool)

Apr 25, 2026

Changes in this version

type SurfaceConfiguration — darwin/amd64, linux/amd64, windows/amd64

+ EnableDamagePresent bool

Apr 23, 2026

Changes in this version

+ type MaxStagingBufferSizer interface

+ MaxStagingBufferSize func() uint64

Apr 21, 2026

Changes in this version

+ var ErrInvalidMapRange = errors.New("hal: invalid buffer map range or non-mappable buffer")

+ type BufferMapping struct

+ IsCoherent bool

+ Ptr unsafe.Pointer

type Device

+ MapBuffer func(buffer Buffer, offset, size uint64) (BufferMapping, error)

+ UnmapBuffer func(buffer Buffer) error

Apr 2, 2026

Changes in this version

type CommandEncoder

+ Destroy func()

type Queue

+ SupportsCommandBufferCopies func() bool

type Texture

+ AddPendingRef func()

+ CurrentUsage func() gputypes.TextureUsage

+ DecPendingRef func()

Mar 30, 2026

Changes in this version

type Queue

+ PollCompleted func() uint64

Feb 17, 2026

Changes in this version

+ var ErrTimestampsNotSupported = errors.New("hal: timestamp queries not supported by this backend")

type CommandEncoder

+ ResolveQuerySet func(querySet QuerySet, firstQuery, queryCount uint32, destination Buffer, ...)

type Device

+ CreateQuerySet func(desc *QuerySetDescriptor) (QuerySet, error)

+ DestroyQuerySet func(querySet QuerySet)

+ type QuerySetDescriptor struct

+ Count uint32

+ Label string

+ Type QueryType

+ type QueryType uint32

+ const QueryTypeOcclusion

+ const QueryTypeTimestamp

Feb 16, 2026

Changes in this version

type Device

+ WaitIdle func() error

Feb 15, 2026

Changes in this version

+ func Logger() *slog.Logger

+ func SetLogger(l *slog.Logger)

Feb 9, 2026

Changes in this version

type Queue

+ ReadBuffer func(buffer Buffer, offset uint64, data []byte) error

Jan 31, 2026

Changes in this version

type Device

+ CreateRenderBundleEncoder func(desc *RenderBundleEncoderDescriptor) (RenderBundleEncoder, error)

+ DestroyRenderBundle func(bundle RenderBundle)

+ FreeCommandBuffer func(cmdBuffer CommandBuffer)

+ GetFenceStatus func(fence Fence) (bool, error)

+ ResetFence func(fence Fence) error

+ type RenderBundleEncoder interface

+ Draw func(vertexCount, instanceCount, firstVertex, firstInstance uint32)

+ DrawIndexed func(indexCount, instanceCount, firstIndex uint32, baseVertex int32, ...)

+ Finish func() RenderBundle

+ SetBindGroup func(index uint32, group BindGroup, offsets []uint32)

+ SetIndexBuffer func(buffer Buffer, format gputypes.IndexFormat, offset uint64)

+ SetPipeline func(pipeline RenderPipeline)

+ SetVertexBuffer func(slot uint32, buffer Buffer, offset uint64)

+ type RenderBundleEncoderDescriptor struct

+ ColorFormats []gputypes.TextureFormat

+ DepthReadOnly bool

+ DepthStencilFormat gputypes.TextureFormat

+ Label string

+ SampleCount uint32

+ StencilReadOnly bool

Jan 30, 2026

Changes in this version

+ type NativeHandle interface

+ NativeHandle func() uintptr

Jan 29, 2026

Changes in this version

+ const CompositeAlphaModeUnpremultiplied

Jan 28, 2026

Changes in this version

+ const CompositeAlphaModeAuto

+ const CompositeAlphaModePostMultiplied

+ const CompositeAlphaModePreMultiplied

Jan 28, 2026

Changes in this version

type InstanceDescriptor

+ GLBackend gputypes.GLBackend

Jan 16, 2026

Changes in this version

+ var ErrNotReady = errors.New("hal: not ready")

Jan 10, 2026

Changes in this version

+ var ErrDriverBug = errors.New("hal: driver bug detected (API spec violation)")

Dec 26, 2025

Changes in this version

+ var ErrZeroArea = errors.New("hal: surface width and height must be non-zero")

Dec 9, 2025

Changes in this version

+ var ErrBackendNotFound = errors.New("hal: backend not found")

+ var ErrDeviceLost = errors.New("hal: device lost")

+ var ErrDeviceOutOfMemory = errors.New("hal: device out of memory")

+ var ErrSurfaceLost = errors.New("hal: surface lost")

+ var ErrSurfaceOutdated = errors.New("hal: surface outdated")

+ var ErrTimeout = errors.New("hal: timeout")

+ func AvailableBackends() []types.Backend

+ func RegisterBackend(backend Backend)

+ func RegisterBackendFactory(variant types.Backend, factory BackendFactory)

+ type AcquiredSurfaceTexture struct

+ Suboptimal bool

+ Texture SurfaceTexture

+ type Adapter interface

+ Destroy func()

+ Open func(features types.Features, limits types.Limits) (OpenDevice, error)

+ SurfaceCapabilities func(surface Surface) *SurfaceCapabilities

+ TextureFormatCapabilities func(format types.TextureFormat) TextureFormatCapabilities

+ type Alignments struct

+ BufferCopyOffset uint64

+ BufferCopyPitch uint64

+ type Backend interface

+ CreateInstance func(desc *InstanceDescriptor) (Instance, error)

+ Variant func() types.Backend

+ func CreateBackend(variant types.Backend) (Backend, error)

+ func GetBackend(variant types.Backend) (Backend, bool)

+ func SelectBestBackend() (Backend, error)

+ type BackendFactory func() (Backend, error)

+ type BackendFeatures struct

+ MaxBufferSize uint64

+ MaxTextureSize uint32

+ SupportsCompute bool

+ SupportsMultiQueue bool

+ SupportsRayTracing bool

+ type BackendInfo struct

+ Features BackendFeatures

+ Limitations BackendLimitations

+ Name string

+ Variant types.Backend

+ Version string

+ func ProbeBackend(variant types.Backend) (*BackendInfo, error)

+ type BackendLimitations struct

+ LimitedFormats bool

+ NoAsyncCompute bool

+ NoBindlessResources bool

+ type BindGroup interface

+ type BindGroupDescriptor struct

+ Entries []types.BindGroupEntry

+ Label string

+ Layout BindGroupLayout

+ type BindGroupLayout interface

+ type BindGroupLayoutDescriptor struct

+ Entries []types.BindGroupLayoutEntry

+ Label string

+ type Buffer interface

+ type BufferBarrier struct

+ Buffer Buffer

+ Usage BufferUsageTransition

+ type BufferCopy struct

+ DstOffset uint64

+ Size uint64

+ SrcOffset uint64

+ type BufferDescriptor struct

+ Label string

+ MappedAtCreation bool

+ Size uint64

+ Usage types.BufferUsage

+ type BufferTextureCopy struct

+ BufferLayout ImageDataLayout

+ Size Extent3D

+ TextureBase ImageCopyTexture

+ type BufferUsageTransition struct

+ NewUsage types.BufferUsage

+ OldUsage types.BufferUsage

+ type Capabilities struct

+ AlignmentsMask Alignments

+ DownlevelCapabilities DownlevelCapabilities

+ Limits types.Limits

+ type CommandBuffer interface

+ type CommandEncoder interface

+ BeginComputePass func(desc *ComputePassDescriptor) ComputePassEncoder

+ BeginEncoding func(label string) error

+ BeginRenderPass func(desc *RenderPassDescriptor) RenderPassEncoder

+ ClearBuffer func(buffer Buffer, offset, size uint64)

+ CopyBufferToBuffer func(src, dst Buffer, regions []BufferCopy)

+ CopyBufferToTexture func(src Buffer, dst Texture, regions []BufferTextureCopy)

+ CopyTextureToBuffer func(src Texture, dst Buffer, regions []BufferTextureCopy)

+ CopyTextureToTexture func(src, dst Texture, regions []TextureCopy)

+ DiscardEncoding func()

+ EndEncoding func() (CommandBuffer, error)

+ ResetAll func(commandBuffers []CommandBuffer)

+ TransitionBuffers func(barriers []BufferBarrier)

+ TransitionTextures func(barriers []TextureBarrier)

+ type CommandEncoderDescriptor struct

+ Label string

+ type CompositeAlphaMode uint8

+ const CompositeAlphaModeInherit

+ const CompositeAlphaModeOpaque

+ const CompositeAlphaModePostmultiplied

+ const CompositeAlphaModePremultiplied

+ type ComputePassDescriptor struct

+ Label string

+ TimestampWrites *ComputePassTimestampWrites

+ type ComputePassEncoder interface

+ Dispatch func(x, y, z uint32)

+ DispatchIndirect func(buffer Buffer, offset uint64)

+ End func()

+ SetBindGroup func(index uint32, group BindGroup, offsets []uint32)

+ SetPipeline func(pipeline ComputePipeline)

+ type ComputePassTimestampWrites struct

+ BeginningOfPassWriteIndex *uint32

+ EndOfPassWriteIndex *uint32

+ QuerySet QuerySet

+ type ComputePipeline interface

+ type ComputePipelineDescriptor struct

+ Compute ComputeState

+ Label string

+ Layout PipelineLayout

+ type ComputeState struct

+ EntryPoint string

+ Module ShaderModule

+ type DepthStencilState struct

+ DepthBias int32

+ DepthBiasClamp float32

+ DepthBiasSlopeScale float32

+ DepthCompare types.CompareFunction

+ DepthWriteEnabled bool

+ Format types.TextureFormat

+ StencilBack StencilFaceState

+ StencilFront StencilFaceState

+ StencilReadMask uint32

+ StencilWriteMask uint32

+ type Device interface

+ CreateBindGroup func(desc *BindGroupDescriptor) (BindGroup, error)

+ CreateBindGroupLayout func(desc *BindGroupLayoutDescriptor) (BindGroupLayout, error)

+ CreateBuffer func(desc *BufferDescriptor) (Buffer, error)

+ CreateCommandEncoder func(desc *CommandEncoderDescriptor) (CommandEncoder, error)

+ CreateComputePipeline func(desc *ComputePipelineDescriptor) (ComputePipeline, error)

+ CreateFence func() (Fence, error)

+ CreatePipelineLayout func(desc *PipelineLayoutDescriptor) (PipelineLayout, error)

+ CreateRenderPipeline func(desc *RenderPipelineDescriptor) (RenderPipeline, error)

+ CreateSampler func(desc *SamplerDescriptor) (Sampler, error)

+ CreateShaderModule func(desc *ShaderModuleDescriptor) (ShaderModule, error)

+ CreateTexture func(desc *TextureDescriptor) (Texture, error)

+ CreateTextureView func(texture Texture, desc *TextureViewDescriptor) (TextureView, error)

+ Destroy func()

+ DestroyBindGroup func(group BindGroup)

+ DestroyBindGroupLayout func(layout BindGroupLayout)

+ DestroyBuffer func(buffer Buffer)

+ DestroyComputePipeline func(pipeline ComputePipeline)

+ DestroyFence func(fence Fence)

+ DestroyPipelineLayout func(layout PipelineLayout)

+ DestroyRenderPipeline func(pipeline RenderPipeline)

+ DestroySampler func(sampler Sampler)

+ DestroyShaderModule func(module ShaderModule)

+ DestroyTexture func(texture Texture)

+ DestroyTextureView func(view TextureView)

+ Wait func(fence Fence, value uint64, timeout time.Duration) (bool, error)

+ type DownlevelCapabilities struct

+ Flags DownlevelFlags

+ ShaderModel uint32

+ type DownlevelFlags uint32

+ const DownlevelFlagsAnisotropicFiltering

+ const DownlevelFlagsBaseVertexBaseInstance

+ const DownlevelFlagsComputeShaders

+ const DownlevelFlagsFragmentWritableStorage

+ const DownlevelFlagsIndirectFirstInstance

+ const DownlevelFlagsReadOnlyDepthStencil

+ type ExposedAdapter struct

+ Adapter Adapter

+ Capabilities Capabilities

+ Features types.Features

+ Info types.AdapterInfo

+ type Extent3D struct

+ DepthOrArrayLayers uint32

+ Height uint32

+ Width uint32

+ type Fence interface

+ type FragmentState struct

+ EntryPoint string

+ Module ShaderModule

+ Targets []types.ColorTargetState

+ type ImageCopyTexture struct

+ Aspect types.TextureAspect

+ MipLevel uint32

+ Origin Origin3D

+ Texture Texture

+ type ImageDataLayout struct

+ BytesPerRow uint32

+ Offset uint64

+ RowsPerImage uint32

+ type Instance interface

+ CreateSurface func(displayHandle, windowHandle uintptr) (Surface, error)

+ Destroy func()

+ EnumerateAdapters func(surfaceHint Surface) []ExposedAdapter

+ type InstanceDescriptor struct

+ Backends types.Backends

+ Dx12ShaderCompiler types.Dx12ShaderCompiler

+ Flags types.InstanceFlags

+ GlBackend types.GlBackend

+ type OpenDevice struct

+ Device Device

+ Queue Queue

+ type Origin3D struct

+ X uint32

+ Y uint32

+ Z uint32

+ type PipelineLayout interface

+ type PipelineLayoutDescriptor struct

+ BindGroupLayouts []BindGroupLayout

+ Label string

+ PushConstantRanges []PushConstantRange

+ type PresentMode uint8

+ const PresentModeFifo

+ const PresentModeFifoRelaxed

+ const PresentModeImmediate

+ const PresentModeMailbox

+ type PushConstantRange struct

+ Range Range

+ Stages types.ShaderStages

+ type QuerySet interface

+ type Queue interface

+ GetTimestampPeriod func() float32

+ Present func(surface Surface, texture SurfaceTexture) error

+ Submit func(commandBuffers []CommandBuffer, fence Fence, fenceValue uint64) error

+ WriteBuffer func(buffer Buffer, offset uint64, data []byte)

+ WriteTexture func(dst *ImageCopyTexture, data []byte, layout *ImageDataLayout, size *Extent3D)

+ type Range struct

+ End uint32

+ Start uint32

+ type RenderBundle interface

+ type RenderPassColorAttachment struct

+ ClearValue types.Color

+ LoadOp types.LoadOp

+ ResolveTarget TextureView

+ StoreOp types.StoreOp

+ View TextureView

+ type RenderPassDepthStencilAttachment struct

+ DepthClearValue float32

+ DepthLoadOp types.LoadOp

+ DepthReadOnly bool

+ DepthStoreOp types.StoreOp

+ StencilClearValue uint32

+ StencilLoadOp types.LoadOp

+ StencilReadOnly bool

+ StencilStoreOp types.StoreOp

+ View TextureView

+ type RenderPassDescriptor struct

+ ColorAttachments []RenderPassColorAttachment

+ DepthStencilAttachment *RenderPassDepthStencilAttachment

+ Label string

+ TimestampWrites *RenderPassTimestampWrites

+ type RenderPassEncoder interface

+ Draw func(vertexCount, instanceCount, firstVertex, firstInstance uint32)

+ DrawIndexed func(indexCount, instanceCount, firstIndex uint32, baseVertex int32, ...)

+ DrawIndexedIndirect func(buffer Buffer, offset uint64)

+ DrawIndirect func(buffer Buffer, offset uint64)

+ End func()

+ ExecuteBundle func(bundle RenderBundle)

+ SetBindGroup func(index uint32, group BindGroup, offsets []uint32)

+ SetBlendConstant func(color *types.Color)

+ SetIndexBuffer func(buffer Buffer, format types.IndexFormat, offset uint64)

+ SetPipeline func(pipeline RenderPipeline)

+ SetScissorRect func(x, y, width, height uint32)

+ SetStencilReference func(reference uint32)

+ SetVertexBuffer func(slot uint32, buffer Buffer, offset uint64)

+ SetViewport func(x, y, width, height, minDepth, maxDepth float32)

+ type RenderPassTimestampWrites struct

+ BeginningOfPassWriteIndex *uint32

+ EndOfPassWriteIndex *uint32

+ QuerySet QuerySet

+ type RenderPipeline interface

+ type RenderPipelineDescriptor struct

+ DepthStencil *DepthStencilState

+ Fragment *FragmentState

+ Label string

+ Layout PipelineLayout

+ Multisample types.MultisampleState

+ Primitive types.PrimitiveState

+ Vertex VertexState

+ type Resource interface

+ Destroy func()

+ type Sampler interface

+ type SamplerDescriptor struct

+ AddressModeU types.AddressMode

+ AddressModeV types.AddressMode

+ AddressModeW types.AddressMode

+ Anisotropy uint16

+ Compare types.CompareFunction

+ Label string

+ LodMaxClamp float32

+ LodMinClamp float32

+ MagFilter types.FilterMode

+ MinFilter types.FilterMode

+ MipmapFilter types.FilterMode

+ type ShaderModule interface

+ type ShaderModuleDescriptor struct

+ Label string

+ Source ShaderSource

+ type ShaderSource struct

+ SPIRV []uint32

+ WGSL string

+ type StencilFaceState struct

+ Compare types.CompareFunction

+ DepthFailOp StencilOperation

+ FailOp StencilOperation

+ PassOp StencilOperation

+ type StencilOperation uint8

+ const StencilOperationDecrementClamp

+ const StencilOperationDecrementWrap

+ const StencilOperationIncrementClamp

+ const StencilOperationIncrementWrap

+ const StencilOperationInvert

+ const StencilOperationKeep

+ const StencilOperationReplace

+ const StencilOperationZero

+ type Surface interface

+ AcquireTexture func(fence Fence) (*AcquiredSurfaceTexture, error)

+ Configure func(device Device, config *SurfaceConfiguration) error

+ DiscardTexture func(texture SurfaceTexture)

+ Unconfigure func(device Device)

+ type SurfaceCapabilities struct

+ AlphaModes []CompositeAlphaMode

+ Formats []types.TextureFormat

+ PresentModes []PresentMode

+ type SurfaceConfiguration struct

+ AlphaMode CompositeAlphaMode

+ Format types.TextureFormat

+ Height uint32

+ PresentMode PresentMode

+ Usage types.TextureUsage

+ Width uint32

+ type SurfaceTexture interface

+ type Texture interface

+ type TextureBarrier struct

+ Range TextureRange

+ Texture Texture

+ Usage TextureUsageTransition

+ type TextureCopy struct

+ DstBase ImageCopyTexture

+ Size Extent3D

+ SrcBase ImageCopyTexture

+ type TextureDescriptor struct

+ Dimension types.TextureDimension

+ Format types.TextureFormat

+ Label string

+ MipLevelCount uint32

+ SampleCount uint32

+ Size Extent3D

+ Usage types.TextureUsage

+ ViewFormats []types.TextureFormat

+ type TextureFormatCapabilities struct

+ Flags TextureFormatCapabilityFlags

+ type TextureFormatCapabilityFlags uint32

+ const TextureFormatCapabilityBlendable

+ const TextureFormatCapabilityMultisample

+ const TextureFormatCapabilityMultisampleResolve

+ const TextureFormatCapabilityRenderAttachment

+ const TextureFormatCapabilitySampled

+ const TextureFormatCapabilityStorage

+ const TextureFormatCapabilityStorageReadWrite

+ type TextureRange struct

+ ArrayLayerCount uint32

+ Aspect types.TextureAspect

+ BaseArrayLayer uint32

+ BaseMipLevel uint32

+ MipLevelCount uint32

+ type TextureUsageTransition struct

+ NewUsage types.TextureUsage

+ OldUsage types.TextureUsage

+ type TextureView interface

+ type TextureViewDescriptor struct

+ ArrayLayerCount uint32

+ Aspect types.TextureAspect

+ BaseArrayLayer uint32

+ BaseMipLevel uint32

+ Dimension types.TextureViewDimension

+ Format types.TextureFormat

+ Label string

+ MipLevelCount uint32

+ type VertexState struct

+ Buffers []types.VertexBufferLayout

+ EntryPoint string

+ Module ShaderModule