batch

Nov 4, 2026

Changes in this version

+ var ErrUnbounded = errors.New("batch: the host cannot bound the WGSL's loops; module refused")

+ var ErrUnparsable = errors.New("batch: the host cannot parse the WGSL, so it cannot bound its loops")

+ func RequiredLimits(ad *webgpu.Adapter) map[string]uint64 — js/wasm

+ type Analysis struct

+ Groups []uint32

+ Rewritten bool

+ Text string

+ type Guard struct — js/wasm

+ func NewGuard(dev *webgpu.Device, lb LoopBudget) (*Guard, error)

+ func (g *Guard) CheckLayout(bgls []*webgpu.BindGroupLayout) error

+ func (g *Guard) Close()

+ func (g *Guard) Finish(enc *webgpu.CommandEncoder) (*webgpu.CommandBuffer, error)

+ func (g *Guard) NoteLayout(pl *webgpu.PipelineLayout, bgls []*webgpu.BindGroupLayout)

+ func (g *Guard) Pass(enc *webgpu.CommandEncoder, pe *webgpu.ComputePassEncoder) *PassGuard

+ func (g *Guard) Pipeline(d webgpu.ComputePipelineDescriptor) (*webgpu.ComputePipeline, error)

+ func (g *Guard) PipelineAsync(ctx context.Context, d webgpu.ComputePipelineDescriptor) (*webgpu.ComputePipeline, error)

+ func (g *Guard) Shader(d webgpu.ShaderModuleDescriptor) (*webgpu.ShaderModule, error)

+ func (g *Guard) ShaderNoWait(d webgpu.ShaderModuleDescriptor) (*webgpu.ShaderModule, error)

+ func (g *Guard) Stats() (modules, rewritten, refused int, spent time.Duration)

+ func (g *Guard) Submit(q *webgpu.Queue, cbs ...*webgpu.CommandBuffer) error

+ func (g *Guard) SubmitNoWait(q *webgpu.Queue, cbs ...*webgpu.CommandBuffer) (func() error, error)

type LoopBudget

+ SmallLoop uint32

+ func (lb LoopBudget) Analyze(code string) (Analysis, error)

+ type PassGuard struct — js/wasm

+ func (p *PassGuard) DispatchWorkgroups(x, y, z uint32)

+ func (p *PassGuard) DispatchWorkgroupsIndirect(b *webgpu.Buffer, offset uint64)

+ func (p *PassGuard) End() error

+ func (p *PassGuard) SetBindGroup(index uint32, bg *webgpu.BindGroup, offsets ...uint32) error

+ func (p *PassGuard) SetPipeline(pl *webgpu.ComputePipeline)

Nov 4, 2026

Changes in this version

+ var ErrReserved = errors.New("batch: the guest uses the bind group reserved by the host")

+ var ErrTruncated = errors.New("batch: a shader exceeded its loop budget and was truncated")

type DeviceBackend — js/wasm

+ func (b *DeviceBackend) LoopBudgetStats() (modules, instrumented, fallbacks int, spent time.Duration)

+ func (b *DeviceBackend) SetLoopBudget(lb LoopBudget) error

+ type LoopBudget struct

+ Group uint32

+ IndirectInvocations uint64

+ MaxIterations uint32

+ MinIterations uint32

+ Work uint64

+ WorkgroupInvocations uint32

+ func (lb LoopBudget) Instrument(code string) (string, bool, error)

+ func (lb LoopBudget) Iterations(inv uint64) uint32

+ func (lb LoopBudget) Validate() error

Nov 3, 2026

Changes in this version

type Config

+ MaxDispatchInvocations uint64

+ MaxStreamInvocations uint64

+ WorkgroupInvocations uint32

type Context

+ func (c *Context) PeakDispatchInvocations() uint64

+ func (c *Context) PeakInvocations() uint64

Nov 3, 2026

Changes in this version

+ var ErrInvalid = errors.New("batch: the GPU refused the object")

Nov 3, 2026

Changes in this version

type Config

+ MaxWorkgroups uint32

Nov 3, 2026

Changes in this version

+ const DefaultMaxRead

+ var ErrLost = errors.New("batch: context lost")

+ var ErrRead = errors.New("batch: read-back refused")

+ var ErrRefused = errors.New("batch: message refused")

+ type Backend interface

+ Close func()

+ Create func(kind uint32, desc []byte) (id uint32, err error)

+ Destroy func(id uint32)

+ Replay func(words []uint32, data []byte) error

+ type Config struct

+ MaxObjects uint32

+ MaxRead uint32

+ type Context struct

+ func New(be Backend, cfg Config) *Context

+ func (c *Context) Close()

+ func (c *Context) Create(id, kind uint32, desc []byte) error

+ func (c *Context) Destroy(ids ...uint32) error

+ func (c *Context) Live() int

+ func (c *Context) Lookup(id uint32) (uint32, bool)

+ func (c *Context) Lost() error

+ func (c *Context) Stream(words []uint32, data []byte, window []byte) error

+ type DeviceBackend struct — js/wasm

+ func NewDeviceBackend(dev *webgpu.Device) *DeviceBackend

+ func (b *DeviceBackend) Close()

+ func (b *DeviceBackend) Create(kind uint32, desc []byte) (uint32, error)

+ func (b *DeviceBackend) Destroy(id uint32)

+ func (b *DeviceBackend) Objects() []any

+ func (b *DeviceBackend) Read(id uint32, offset uint64, dst []byte) error

+ func (b *DeviceBackend) Replay(words []uint32, data []byte) error

+ type Reader interface

+ Read func(id uint32, offset uint64, dst []byte) error