'provides live line graph values' interface More...

#include <giface.h>

Inheritance diagram for calf_plugins::line_graph_iface:

Public Member Functions
virtual bool	get_graph (int index, int subindex, int phase, float data, int points, cairo_iface context, int *mode=0) const
virtual bool	get_moving (int index, int subindex, int &direction, float *data, int x, int y, int &offset, uint32_t &color) const
virtual bool	get_dot (int index, int subindex, int phase, float &x, float &y, int &size, cairo_iface *context) const
virtual bool	get_gridline (int index, int subindex, int phase, float &pos, bool &vertical, std::string &legend, cairo_iface *context) const
virtual bool	get_layers (int index, int generation, unsigned int &layers) const
virtual std::string	get_crosshair_label (int x, int y, int sx, int sy, float q, int dB, int name, int note, int cents) const
virtual	~line_graph_iface ()
	Standard destructor to make compiler happy.

Detailed Description

'provides live line graph values' interface

Constructor & Destructor Documentation

◆ ~line_graph_iface()

virtual calf_plugins::line_graph_iface::~line_graph_iface ( )

inlinevirtual

Standard destructor to make compiler happy.

Member Function Documentation

◆ get_crosshair_label()

virtual std::string calf_plugins::line_graph_iface::get_crosshair_label	(	int	x,
		int	y,
		int	sx,
		int	sy,
		float	q,
		int	dB,
		int	name,
		int	note,
		int	cents ) const

inlinevirtual

Return a label for the crosshairs they are enabled

Parameters

x	Position of the mouse pointer in x direction
y	Position of the mouse pointer in y direction
sx	Horizontal size of the widget in pixels
sy	Vertical size of the widget in pixels

Reimplemented in calf_plugins::equalizerNband_audio_module< BaseClass, has_lphp >, calf_plugins::equalizerNband_audio_module< equalizer12band_metadata, true >, calf_plugins::equalizerNband_audio_module< equalizer5band_metadata, false >, calf_plugins::equalizerNband_audio_module< equalizer8band_metadata, true >, and calf_plugins::frequency_response_line_graph.

◆ get_dot()

virtual bool calf_plugins::line_graph_iface::get_dot	(	int	index,
		int	subindex,
		int	phase,
		float &	x,
		float &	y,
		int &	size,
		cairo_iface *	context ) const

inlinevirtual

Obtain subindex'th dot of parameter 'index'

Parameters

index	parameter/dot number (usually tied to particular plugin control port)
subindex	dot number (there may be multiple dots graphs for one parameter)
phase	0 if in cache phase or 1 if in realtime phase

Reimplemented in calf_plugins::compressor_audio_module, calf_plugins::gate_audio_module, calf_plugins::monocompressor_audio_module, calf_plugins::multibandcompressor_audio_module, calf_plugins::multibandgate_audio_module, calf_plugins::multichorus_audio_module, calf_plugins::pulsator_audio_module, calf_plugins::ringmodulator_audio_module, calf_plugins::sidechaincompressor_audio_module, calf_plugins::sidechaingate_audio_module, and calf_plugins::tapesimulator_audio_module.

◆ get_graph()

virtual bool calf_plugins::line_graph_iface::get_graph	(	int	index,
		int	subindex,
		int	phase,
		float *	data,
		int	points,
		cairo_iface *	context,
		int *	mode = 0 ) const

inlinevirtual

Obtain subindex'th graph of parameter 'index'

Parameters

index	parameter/graph number (usually tied to particular plugin control port)
subindex	graph number (there may be multiple overlaid graphs for one parameter, eg. for monosynth 2x12dB filters)
phase	0 if in cache phase or 1 if in realtime phase
data	buffer for normalized output values
points	number of points to fill
context	cairo context to adjust (for multicolour graphs etc.)

Return values

true	graph data was returned; subindex+1 graph may or may not be available
false	graph data was not returned; subindex+1 graph does not exist either

◆ get_gridline()

virtual bool calf_plugins::line_graph_iface::get_gridline	(	int	index,
		int	subindex,
		int	phase,
		float &	pos,
		bool &	vertical,
		std::string &	legend,
		cairo_iface *	context ) const

inlinevirtual

Obtain subindex'th dot of parameter 'index'

Parameters

index	parameter/dot number (usually tied to particular plugin control port)
subindex	dot number (there may be multiple dots graphs for one parameter)
phase	0 if in cache phase or 1 if in realtime phase

◆ get_layers()

virtual bool calf_plugins::line_graph_iface::get_layers	(	int	index,
		int	generation,
		unsigned int &	layers ) const

inlinevirtual

Return which layers need to be redrawn in the next GTK drawing cycle

Parameters

index	Parameter/graph identifier (usually tied to particular plugin control port)
generation	The overall amount of drawing cycles since the last full refresh of all surfaces
layers	Bitmask defining the layers to be redrawn (see layers_flags above)

Return values

true	there's at least one layer to be redrawn; false nothing to draw in this cycle

◆ get_moving()

virtual bool calf_plugins::line_graph_iface::get_moving	(	int	index,
		int	subindex,
		int &	direction,
		float *	data,
		int	x,
		int	y,
		int &	offset,
		uint32_t &	color ) const

inlinevirtual

Obtain subindex'th moving surface of parameter 'index'

Parameters

index	parameter/dot number (usually tied to particular plugin control port)
subindex	mvoing line number (there may be multiple graphs for one parameter)
direction	0 if horizontal or 1 if vertical movement
data	buffer for normalized output values
x	number of points direction to fill in x
y	number of points direction to fill in y

Reimplemented in calf_plugins::analyzer_audio_module.

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

/home/runner/work/lmms-fork/lmms-fork/plugins/LadspaEffect/calf/veal/src/calf/giface.h

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ~line_graph_iface()

Member Function Documentation

◆ get_crosshair_label()

◆ get_dot()

◆ get_graph()

◆ get_gridline()

◆ get_layers()

◆ get_moving()