Bifrost SDK directory structure

The Bifrost SDK contains the header and libraries you need to create a Bifrost operator, as well as supporting files and documentation. It is located in the Bifrost installation's sdk directory.

The Bifrost SDK has the following directory structure:

    
sdk
    cmake
    docs
    examples
    include
        Amino
        Bifrost
        BifrostGraph
    lib
    

cmake directory

The cmake directory contains CMake files that are needed to build your operators and packs.

docs directory

The docs directory contains the zipped Bifrost API documentation.

include directory

The include directory contains the Bifrost, BifrostGraph, and Amino SDK header files.

include/Amino directory

The Amino directory contains the Amino runtime API header files. These are the core Amino types that are used to write C++ operators and pass data through the graph.

include/Bifrost directory

The bifrost directory contains the Bifrost runtime API header files. These APIs are built on the Amino API.

include/BifrostGraph directory

The BifrostGraph directory contains the Bifrost Graph APIs. These are used to set up graph inputs and outputs, as well as translation tables.

The Bifrost Graph APIs should not be used when implementing C++ operators.

examples directory

The examples directory contains example code. These examples demonstrate how to use the API and how to build your packs and operators.

lib directory

Windows only. The lib directory contains the .lib files for linking.