Add a background

Background is an optional ArFrame attribute to display any image behind pipeline visualization.

Background

Load and display ArFrame background

ArFrame.background can be enabled with a dedicated JSON entry.

Here is an extract from the JSON ArFrame configuration file where a background picture is loaded and displayed:

{
    "argaze.ArFeatures.ArFrame": {
        "name": "My FullHD screen",
        "size": [1920, 1080],
        ...
        "background": "./bosch.png",
        ...
        "image_parameters": {
            ...
            "background_weight": 1
        }
    }
}

Note

As explained in visualization chapter, the resulting image is accessible with ArFrame.image method.

Now, let's understand the meaning of each JSON entry.

background

The path to an image file on disk.

background_weight

The weight of background overlay in ArFrame.image between 0 and 1.