API Reference

May 21, 2025 · View on GitHub

Here you will find documentation generated from the oneAPI Construction Kit's source code.

cl module
- compiler module
- extension module
cargo module
vecz module
builtins module
- abacus
- libimg
mux module
- compiler::utils
host mux target
tracer module
{ref}genindex

`cl` module

.. doxygengroup:: cl
    :members:

`compiler` module

The OpenCL C frontend compiler and a set of LLVM passes to transform the generated LLVM IR before hand off to mux are contained in the compiler module.

.. doxygengroup:: cl_compiler
    :members:

`extension` module

.. doxygengroup:: cl_extension
    :members:

`cargo` module

.. doxygengroup:: cargo
    :members:

`vecz` module

.. doxygengroup:: vecz
    :members:

`builtins` module

.. doxygengroup:: builtins
    :members:

`abacus`

`abacus cast`

.. doxygengroup:: abacus_cast

`abacus common`

.. doxygengroup:: abacus_common

`abacus config`

.. doxygengroup:: abacus_config

`abacus geometric`

.. doxygengroup:: abacus_geometric

`abacus integer`

.. doxygengroup:: abacus_integer

`abacus math`

.. doxygengroup:: abacus_math

`abacus memory`

.. doxygengroup:: abacus_memory

`abacus misc`

.. doxygengroup:: abacus_misc

`abacus relational`

.. doxygengroup:: abacus_relational

`abacus type traits`

.. doxygengroup:: abacus_type_traits

`libimg`

.. doxygengroup:: libimg

`mux` module

.. doxygengroup:: mux
    :members:

A set of C++ utilities are provides along side mux, whilst it is not required to make use of them they prove useful when implementing and maintaining an implementation of the API for a specific device.

.. doxygengroup:: utils
    :members:

`host` mux target

.. doxygengroup:: host
    :members:

`tracer` module

.. doxygengroup:: tracer
    :members: