Axoverlay Library
axoverlay_settings Struct Reference

#include <axoverlay.h>

Collaboration diagram for axoverlay_settings:

Data Fields

axoverlay_render_function render_callback
 
axoverlay_adjustment_function adjustment_callback
 
axoverlay_stream_select_function select_callback
 
enum axoverlay_backend_type backend
 

Detailed Description

This struct contains callback that lets the developer customize the behaviour of the library.

Field Documentation

◆ adjustment_callback

axoverlay_adjustment_function axoverlay_settings::adjustment_callback

A function that is called prior to rendering each time an overlay is rendered on a stream. Use it to make adjustments to it's size and position. Nullable.

◆ backend

enum axoverlay_backend_type axoverlay_settings::backend

A variable used to select the desired backend to be used by axoverlay.

◆ render_callback

axoverlay_render_function axoverlay_settings::render_callback

A function called when an overlay needs to be drawn. It can be called manually via axoverlay_redraw() but is also called from the system, for example when a new stream appears. Not nullable.

◆ select_callback

axoverlay_stream_select_function axoverlay_settings::select_callback

A function each time a new stream is detected. Use it to decide if overlays should be rendered to this stream or not. Nullable.


The documentation for this struct was generated from the following file: