Contents

setBuffer(_:offset:index:)

Binds a buffer to the buffer argument table, allowing compute kernels to access its data on the GPU.

Declaration

func setBuffer(_ buffer: (any MTLBuffer)?, offset: Int, index: Int)

Parameters

  • buffer:

    The Mtlbuffer instance to bind to the argument table.

  • offset:

    The number of bytes to skip in the buffer before the first element of data.

  • index:

    The index the buffer binds to in the argument table.

Mentioned in

Discussion

For buffers binding to an argument using the device address space, align the offset to the data type’s size. The maximum size for an offset is 16 bytes.

For buffers in the constant address space, the minimum alignment depends on the hardware running your app. See the Metal feature set tables (PDF) for information on each Apple GPU family.

Rebinding an already bound buffer causes a Metal error.

See Also

Binding buffers