Axoverlay Library
axoverlay_overlay_data Struct Reference

#include <axoverlay.h>

Data Fields

enum axoverlay_anchor_point anchor_point
 
enum axoverlay_position_type postype
 
gfloat x
 
gfloat y
 
gint width
 
gint height
 
gint z_priority
 
enum axoverlay_colorspace colorspace
 
gboolean scale_to_stream
 

Detailed Description

This struct contains data used to create a new overlay.

Field Documentation

◆ anchor_point

enum axoverlay_anchor_point axoverlay_overlay_data::anchor_point

The anchor point for the overlay. The default is AXOVERLAY_ANCHOR_TOP_LEFT.

◆ colorspace

enum axoverlay_colorspace axoverlay_overlay_data::colorspace

The colorspace must be set to one of the constants in overlay_colorspace. Note that when using the palette colorspaces only the alpha channel has any effect (when rendering with cairo). The palette colors needs to be set manually by invoking dbus. The default is ARGB32.

◆ height

gint axoverlay_overlay_data::height

The height of the overlay. It should be set to the size that the overlay should have on a stream of max resolution. Unless scale_to_stream is set to FALSE the size will later be scaled to the actual stream resolution.

◆ postype

enum axoverlay_position_type axoverlay_overlay_data::postype

The postion type. This parameter controls how the x and y parameters are interpreted. See documentation of position_type for details.

◆ scale_to_stream

gboolean axoverlay_overlay_data::scale_to_stream

If this parameter is set to TRUE the size of the overlay will be scaled to match the resolution of the stream. If it is set to FALSE the developer is responsible for handling this in the adjustment_callback. The default is TRUE.

◆ width

gint axoverlay_overlay_data::width

The width of the overlay. It should be set to the size that the overlay should have on a stream of max resolution. Unless scale_to_stream is set to FALSE the size will later be scaled to the actual stream resolution.

◆ x

gfloat axoverlay_overlay_data::x

The x coordinate for the position of the top-left corner of the overlay.

◆ y

gfloat axoverlay_overlay_data::y

The y coordinats for the position of the top-left corner of the overlay.

◆ z_priority

gint axoverlay_overlay_data::z_priority

The z priority of the overlay. An overlay with higher priority will be placed in front of an overlay with lower priority in case they overlay. The default is 0.


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