From 4e3479eea4c28e386b37d5d67232168f4512bd2d Mon Sep 17 00:00:00 2001 From: Robin Gareus Date: Mon, 27 Feb 2017 15:04:20 +0100 Subject: [PATCH] Update lua class documentation --- include/class-reference.html | 224 ++++++++++++++++++++++++++++++++--- 1 file changed, 210 insertions(+), 14 deletions(-) diff --git a/include/class-reference.html b/include/class-reference.html index 45c4103..0f42a1c 100644 --- a/include/class-reference.html +++ b/include/class-reference.html @@ -139,6 +139,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C boolactive () voiddeactivate () std::stringdisplay_name () + booldisplay_to_user () ChanCountinput_streams () ChanCountoutput_streams () Cast @@ -149,6 +150,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C PeakMeterto_meter () MonitorProcessorto_monitorprocessor () PeakMeterto_peakmeter () + PluginInsertto_plugininsert () SideChainto_sidechain () UnknownProcessorto_unknownprocessor () @@ -377,7 +379,9 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C Constructor ℂARDOUR.AudioRangeList () Methods + AudioRangeback () boolempty () + AudioRangefront () LuaIteriter () voidreverse () unsigned longsize () @@ -658,7 +662,9 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C ℂARDOUR.AudioTrackList () Methods LuaTableadd (LuaTable {AudioTrack}) + AudioTrackback () boolempty () + AudioTrackfront () LuaIteriter () voidpush_back (AudioTrack) voidreverse () @@ -754,11 +760,9 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C Constructor ℂARDOUR.BackendVector () Methods - LuaTableadd (ARDOUR::AudioBackendInfo* ) AudioBackendInfoat (unsigned long) boolempty () LuaIteriter () - voidpush_back (AudioBackendInfo) unsigned longsize () LuaTabletable () @@ -820,7 +824,9 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C ℂARDOUR.ControlList () Methods LuaTableadd (LuaTable {AutomationControl}) + AutomationControlback () boolempty () + AutomationControlfront () LuaIteriter () voidpush_back (AutomationControl) voidreverse () @@ -984,6 +990,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C boolactive () voiddeactivate () std::stringdisplay_name () + booldisplay_to_user () ChanCountinput_streams () ChanCountoutput_streams () Cast @@ -994,6 +1001,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C PeakMeterto_meter () MonitorProcessorto_monitorprocessor () PeakMeterto_peakmeter () + PluginInsertto_plugininsert () SideChainto_sidechain () UnknownProcessorto_unknownprocessor () @@ -1020,6 +1028,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + @@ -1150,6 +1159,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + @@ -1160,6 +1170,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C +
Constructor
ℂARDOUR.DeviceStatusVector ()
ℂARDOUR.DeviceStatusVector ()
Methods
LuaTableadd (LuaTable {DeviceStatus})
DeviceStatusat (unsigned long)
boolactive ()
voiddeactivate ()
std::stringdisplay_name ()
booldisplay_to_user ()
ChanCountinput_streams ()
ChanCountoutput_streams ()
Cast
PeakMeterto_meter ()
MonitorProcessorto_monitorprocessor ()
PeakMeterto_peakmeter ()
PluginInsertto_plugininsert ()
SideChainto_sidechain ()
UnknownProcessorto_unknownprocessor ()
@@ -1226,7 +1237,9 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C Constructor ℂARDOUR.LocationList () Methods + Locationback () boolempty () + Locationfront () LuaIteriter () voidreverse () unsigned longsize () @@ -1265,12 +1278,16 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C Methods ...build_filename (--lua--)

Creates a filename from a series of elements using the correct separator for filenames.

No attempt is made to force the resulting filename to be an absolute path. If the first element is a relative path, the result will be a relative path.

+ ...color_to_rgba (--lua--) +

A convenience function to expand RGBA parameters from an integer

convert a Canvas::Color (uint32_t 0xRRGGBBAA) into double RGBA values which can be passed as parameters to Cairo::Context::set_source_rgba

Example: 

 local r, g, b, a = ARDOUR.LuaAPI.color_to_rgba (0x88aa44ff)
+ cairo_ctx:set_source_rgba (ARDOUR.LuaAPI.color_to_rgba (0x11336699)

Returns 4 parameters: red, green, blue, alpha (in range 0..1)

LuaTable(float, ...)get_plugin_insert_param (PluginInsert, unsigned int, bool&)

get a plugin control parameter value

which
control port to query (starting at 0, including ports of type input and output)
ok
boolean variable contains true or false after call returned. to be checked by caller before using value.
proc
Plugin-Insert

Returns value

LuaTable(float, ...)get_processor_param (Processor, unsigned int, bool&)

get a plugin control parameter value

proc
Plugin-Processor
which
control port to set (starting at 0, including ports of type input and output))
ok
boolean variable contains true or false after call returned. to be checked by caller before using value.

Returns value

...hsla_to_rgba (--lua--)

A convenience function for colorspace HSL to RGB conversion. All ranges are 0..1

Example: 

 local r, g, b, a = ARDOUR.LuaAPI.hsla_to_rgba (hue, saturation, luminosity, alpha)

Returns 4 parameters: red, green, blue, alpha (in range 0..1)

+ longmonotonic_time () Processornew_luaproc (Session, std::string)

create a new Lua Processor (Plugin)

s
Session Handle
p
Identifier or Name of the Processor

Returns Processor object (may be nil)

NotePtrnew_noteptr (unsigned char, Beats, Beats, unsigned char, unsigned char) @@ -1863,7 +1880,9 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C ℂARDOUR.MidiTrackList () Methods LuaTableadd (LuaTable {MidiTrack}) + MidiTrackback () boolempty () + MidiTrackfront () LuaIteriter () voidpush_back (MidiTrack) voidreverse () @@ -1914,6 +1933,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C boolactive () voiddeactivate () std::stringdisplay_name () + booldisplay_to_user () ChanCountinput_streams () ChanCountoutput_streams () Cast @@ -1924,6 +1944,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C PeakMeterto_meter () MonitorProcessorto_monitorprocessor () PeakMeterto_peakmeter () + PluginInsertto_plugininsert () SideChainto_sidechain () UnknownProcessorto_unknownprocessor () @@ -2075,6 +2096,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C boolactive () voiddeactivate () std::stringdisplay_name () + booldisplay_to_user () ChanCountinput_streams () ChanCountoutput_streams () Cast @@ -2085,6 +2107,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C PeakMeterto_meter () MonitorProcessorto_monitorprocessor () PeakMeterto_peakmeter () + PluginInsertto_plugininsert () SideChainto_sidechain () UnknownProcessorto_unknownprocessor () @@ -2326,6 +2349,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C Methods boolactive () std::stringdisplay_name () + booldisplay_to_user () ChanCountinput_streams () ChanCountoutput_streams () Cast @@ -2336,6 +2360,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C PeakMeterto_meter () MonitorProcessorto_monitorprocessor () PeakMeterto_peakmeter () + PluginInsertto_plugininsert () SideChainto_sidechain () UnknownProcessorto_unknownprocessor () @@ -2385,7 +2410,9 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C Constructor ℂARDOUR.PortList () Methods + Portback () boolempty () + Portfront () LuaIteriter () voidreverse () unsigned longsize () @@ -2469,6 +2496,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + @@ -2489,6 +2517,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + @@ -2501,6 +2530,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C +
Constructor
ℂARDOUR.PresetVector ()
ℂARDOUR.PresetVector ()
Methods
LuaTableadd (LuaTable {PresetRecord})
PresetRecordat (unsigned long)
boolactive ()
voiddeactivate ()
std::stringdisplay_name ()
booldisplay_to_user ()
ChanCountinput_streams ()
boolisnil ()
ChanCountoutput_streams ()
PeakMeterto_meter ()
MonitorProcessorto_monitorprocessor ()
PeakMeterto_peakmeter ()
PluginInsertto_plugininsert ()
SideChainto_sidechain ()
UnknownProcessorto_unknownprocessor ()
@@ -2520,7 +2550,9 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C ℂARDOUR.ProcessorList () Methods LuaTableadd (LuaTable {Processor}) + Processorback () boolempty () + Processorfront () LuaIteriter () voidpush_back (Processor) voidreverse () @@ -2534,6 +2566,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + @@ -2680,7 +2713,9 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + + @@ -2866,7 +2901,9 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + + @@ -2879,7 +2916,9 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + + @@ -2911,6 +2950,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + @@ -3204,6 +3244,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + @@ -3214,6 +3255,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C +
Constructor
ℂARDOUR.ProcessorVector ()
ℂARDOUR.ProcessorVector ()
Methods
LuaTableadd (LuaTable {Processor})
Processorat (unsigned long)
Constructor
ℂARDOUR.RegionList ()
Methods
Regionback ()
boolempty ()
Regionfront ()
LuaIteriter ()
voidreverse ()
unsigned longsize ()
Constructor
ℂARDOUR.RouteGroupList ()
Methods
RouteGroupback ()
boolempty ()
RouteGroupfront ()
LuaIteriter ()
voidreverse ()
unsigned longsize ()
Constructor
ℂARDOUR.RouteList ()
Methods
Routeback ()
boolempty ()
Routefront ()
LuaIteriter ()
voidreverse ()
unsigned longsize ()

abort an open undo command This must only be called after begin_reversible_command ()

boolactively_recording ()
voidadd_command (Command)
voidadd_internal_sends (Route, Placement, RouteListPtr)
StatefulDiffCommandadd_stateful_diff_command (StatefulDestructiblePtr)

create an StatefulDiffCommand from the given object and add it to the stack.

This function must only be called after begin_reversible_command. Failing to do so may lead to a crash.

sfd
the object to diff

Returns the allocated StatefulDiffCommand (already added via add_command)

voidbegin_reversible_command (std::string)
boolactive ()
voiddeactivate ()
std::stringdisplay_name ()
booldisplay_to_user ()
ChanCountinput_streams ()
ChanCountoutput_streams ()
Cast
PeakMeterto_meter ()
MonitorProcessorto_monitorprocessor ()
PeakMeterto_peakmeter ()
PluginInsertto_plugininsert ()
SideChainto_sidechain ()
UnknownProcessorto_unknownprocessor ()
@@ -3474,6 +3516,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + @@ -3735,6 +3778,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + @@ -3745,6 +3789,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C +
Constructor
ℂARDOUR.SourceList ()
ℂARDOUR.SourceList ()
Methods
LuaTableadd (LuaTable {Source})
Sourceat (unsigned long)
boolactive ()
voiddeactivate ()
std::stringdisplay_name ()
booldisplay_to_user ()
ChanCountinput_streams ()
ChanCountoutput_streams ()
Cast
PeakMeterto_meter ()
MonitorProcessorto_monitorprocessor ()
PeakMeterto_peakmeter ()
PluginInsertto_plugininsert ()
SideChainto_sidechain ()
UnknownProcessorto_unknownprocessor ()
@@ -3763,7 +3808,9 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C Constructor ℂARDOUR.WeakAudioSourceList () Methods + AudioSourceback () boolempty () + AudioSourcefront () LuaIteriter () voidreverse () unsigned longsize () @@ -3776,7 +3823,9 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C Constructor ℂARDOUR.WeakRouteList () Methods + Routeback () boolempty () + Routefront () LuaIteriter () voidreverse () unsigned longsize () @@ -3789,7 +3838,9 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C Constructor ℂARDOUR.WeakSourceList () Methods + Sourceback () boolempty () + Sourcefront () LuaIteriter () voidreverse () unsigned longsize () @@ -3820,7 +3871,9 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C ℂArdourUI.ArdourMarkerList () Methods LuaTableadd (ArdourMarker* ) + ArdourMarkerback () boolempty () + ArdourMarkerfront () LuaIteriter () voidpush_back (ArdourMarker) voidreverse () @@ -3828,6 +3881,11 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C LuaTabletable () voidunique () +

∅ ArdourUI:AxisView

+

C‡: AxisView

+
+

AxisView defines the abstract base class for horizontal and vertical presentations of Stripables.

+

This class object is only used indirectly as return-value and function-parameter. It provides no methods by itself.

∁ ArdourUI:Editor

C‡: PublicEditor

@@ -3836,9 +3894,13 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C Methods voidaccess_action (std::string, std::string) voidadd_location_from_playhead_cursor () + TrackViewListaxis_views_from_routes (RouteListPtr) voidcenter_screen (long) + voidclear_playlist (Playlist) + voidclear_playlists (TimeAxisView) voidconsider_auditioning (Region)

Possibly start the audition of a region. If

r
is 0, or not an AudioRegion any current audition is cancelled. If we are currently auditioning
r
will start.
r
Region to consider.
r,
the audition will be cancelled. Otherwise an audition of
+ voidcopy_playlists (TimeAxisView) MouseModecurrent_mouse_mode ()

Returns The current mouse mode (gain, object, range, timefx etc.) (defined in editing_syms.h)

longcurrent_page_samples () @@ -3866,17 +3928,21 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C LuaTable(long, ...)get_nudge_distance (long, long&) longget_paste_offset (long, unsigned int, long) LuaTable(...)get_pointer_position (double&, double&) + RouteTimeAxisViewget_route_view_by_route_id (ID) Selectionget_selection () LuaTable(bool, ...)get_selection_extents (long&, long&) boolget_smart_mode () + TrackViewListget_track_views () intget_videotl_bar_height () doubleget_y_origin () ZoomFocusget_zoom_focus () voidgoto_nth_marker (int) + voidhide_track_in_display (TimeAxisView, bool) longleftmost_sample () voidmaximise_editing_space () voidmaybe_locate_with_edit_preroll (long) voidmouse_add_new_marker (long, bool) + voidnew_playlists (TimeAxisView) voidnew_region_from_selection () voidoverride_visible_track_count () longpixel_to_sample (double) @@ -3884,6 +3950,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C voidplay_with_preroll () voidredo (unsigned int)

Redo some transactions.

n
Number of transaction to redo.
+ RegionViewregionview_from_region (Region) voidremove_last_capture () voidremove_location_at_playhead_cursor () voidremove_tracks () @@ -3891,6 +3958,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C voidreset_y_origin (double) voidreset_zoom (long) voidrestore_editing_space () + RouteTimeAxisViewrtav_from_route (Route) doublesample_to_pixel (long) boolscroll_down_one_track (bool) voidscroll_tracks_down_line () @@ -3904,6 +3972,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C voidset_mouse_mode (MouseMode, bool)

Set the mouse mode (gain, object, range, timefx etc.)

m
Mouse mode (defined in editing_syms.h)
force
Perform the effects of the change even if no change is required (ie even if the current mouse mode is equal to
voidset_punch_range (long, long, std::string) + voidset_selection (SelectionList, Operation) voidset_show_measures (bool) voidset_snap_mode (SnapMode)

Set the snap mode.

m
Snap mode (defined in editing_syms.h)
@@ -3913,6 +3982,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C voidset_video_timeline_height (int) voidset_zoom_focus (ZoomFocus) boolshow_measures () + voidshow_track_in_display (TimeAxisView, bool) SnapModesnap_mode () SnapTypesnap_type () boolstationary_playhead () @@ -3937,7 +4007,9 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C ℂArdourUI.ArdourMarkerList () Methods LuaTableadd (ArdourMarker* ) + ArdourMarkerback () boolempty () + ArdourMarkerfront () LuaIteriter () voidpush_back (ArdourMarker) voidreverse () @@ -3951,13 +4023,37 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C

Class to represent list of selected regions.

- -
Methods
voidclear_all ()

Empty this RegionSelection.

longend_frame ()
unsigned longn_midi_regions ()
RegionListregionlist ()
longstart ()
+

∅ ArdourUI:RegionView

+

C‡: RegionView

+

is-a: ArdourUI:TimeAxisViewItem

+
+

Base class for items that may appear upon a TimeAxisView.

+

This class object is only used indirectly as return-value and function-parameter. It provides no methods by itself.

+

∁ ArdourUI:RouteTimeAxisView

+

C‡: RouteTimeAxisView

+

is-a: ArdourUI:RouteUI

+
+

Base class for objects with auto-disconnection. trackable must be inherited when objects shall automatically invalidate slots referring to them on destruction. A slot built from a member function of a trackable derived type installs a callback that is invoked when the trackable object is destroyed or overwritten.

add_destroy_notify_callback() and remove_destroy_notify_callback() can be used to manually install and remove callbacks when notification of the object dying is needed.

notify_callbacks() invokes and removes all previously installed callbacks and can therefore be used to disconnect from all signals.

Note that there is no virtual destructor. Don't use trackable* as pointer type for managing your data or the destructors of your derived types won't be called when deleting your objects.

 signal
+ + + +
Cast
TimeAxisViewto_timeaxisview ()
+

∅ ArdourUI:RouteUI

+

C‡: RouteUI

+

is-a: ArdourUI:Selectable

+
+

Base class for objects with auto-disconnection. trackable must be inherited when objects shall automatically invalidate slots referring to them on destruction. A slot built from a member function of a trackable derived type installs a callback that is invoked when the trackable object is destroyed or overwritten.

add_destroy_notify_callback() and remove_destroy_notify_callback() can be used to manually install and remove callbacks when notification of the object dying is needed.

notify_callbacks() invokes and removes all previously installed callbacks and can therefore be used to disconnect from all signals.

Note that there is no virtual destructor. Don't use trackable* as pointer type for managing your data or the destructors of your derived types won't be called when deleting your objects.

 signal
+

This class object is only used indirectly as return-value and function-parameter. It provides no methods by itself.

+

∅ ArdourUI:Selectable

+

C‡: Selectable

+
+

Base class for objects with auto-disconnection. trackable must be inherited when objects shall automatically invalidate slots referring to them on destruction. A slot built from a member function of a trackable derived type installs a callback that is invoked when the trackable object is destroyed or overwritten.

add_destroy_notify_callback() and remove_destroy_notify_callback() can be used to manually install and remove callbacks when notification of the object dying is needed.

notify_callbacks() invokes and removes all previously installed callbacks and can therefore be used to disconnect from all signals.

Note that there is no virtual destructor. Don't use trackable* as pointer type for managing your data or the destructors of your derived types won't be called when deleting your objects.

 signal
+

This class object is only used indirectly as return-value and function-parameter. It provides no methods by itself.

∁ ArdourUI:Selection

C‡: Selection

@@ -3975,6 +4071,35 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C ArdourUI:TimeSelectiontime ArdourUI:TrackSelectiontracks +

∁ ArdourUI:SelectionList

+

C‡: std::list<Selectable* >

+
+ + + + + + + + + + + + + +
Constructor
ℂArdourUI.SelectionList ()
Methods
Selectableback ()
boolempty ()
Selectablefront ()
LuaIteriter ()
voidpush_back (Selectable)
voidreverse ()
unsigned longsize ()
LuaTabletable ()
voidunique ()
+

∅ ArdourUI:TimeAxisView

+

C‡: TimeAxisView

+

is-a: ArdourUI:AxisView

+
+

Abstract base class for time-axis views (horizontal editor 'strips')

This class provides the basic LHS controls and display methods. This should be extended to create functional time-axis based views.

+

This class object is only used indirectly as return-value and function-parameter. It provides no methods by itself.

+

∅ ArdourUI:TimeAxisViewItem

+

C‡: TimeAxisViewItem

+

is-a: ArdourUI:Selectable

+
+

Base class for items that may appear upon a TimeAxisView.

+

This class object is only used indirectly as return-value and function-parameter. It provides no methods by itself.

∁ ArdourUI:TimeSelection

C‡: TimeSelection

is-a: ARDOUR:AudioRangeList

@@ -3990,7 +4115,9 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C Constructor ℂARDOUR.AudioRangeList () Methods + AudioRangeback () boolempty () + AudioRangefront () LuaIteriter () voidreverse () unsigned longsize () @@ -4004,15 +4131,65 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C

Inherited from ArdourUI:TrackViewList

+
Methods
boolcontains (TimeAxisView)
RouteListroutelist ()
+

Inherited from ArdourUI:TrackViewStdList

+ + + + + + + + + + + + + +
Constructor
ℂArdourUI.TrackViewStdList ()
Methods
TimeAxisViewback ()
boolempty ()
TimeAxisViewfront ()
LuaIteriter ()
voidpush_back (TimeAxisView)
voidreverse ()
unsigned longsize ()
LuaTabletable ()
voidunique ()

∁ ArdourUI:TrackViewList

C‡: TrackViewList

+

is-a: ArdourUI:TrackViewStdList

+
Methods
boolcontains (TimeAxisView)
RouteListroutelist ()
+

Inherited from ArdourUI:TrackViewStdList

+ + + + + + + + + + + + + +
Constructor
ℂArdourUI.TrackViewStdList ()
Methods
TimeAxisViewback ()
boolempty ()
TimeAxisViewfront ()
LuaIteriter ()
voidpush_back (TimeAxisView)
voidreverse ()
unsigned longsize ()
LuaTabletable ()
voidunique ()
+

∁ ArdourUI:TrackViewStdList

+

C‡: std::list<TimeAxisView* >

+
+ + + + + + + + + + + + + +
Constructor
ℂArdourUI.TrackViewStdList ()
Methods
TimeAxisViewback ()
boolempty ()
TimeAxisViewfront ()
LuaIteriter ()
voidpush_back (TimeAxisView)
voidreverse ()
unsigned longsize ()
LuaTabletable ()
voidunique ()

⋯ C:ByteArray

C‡: unsigned char*

@@ -4030,6 +4207,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + @@ -4056,6 +4234,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
Constructor
ℂC.DoubleVector ()
ℂC.DoubleVector ()
Methods
LuaTableadd (LuaTable {double})
doubleat (unsigned long)
+ @@ -4071,6 +4250,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
Constructor
ℂC.FloatArrayVector ()
ℂC.FloatArrayVector ()
Methods
LuaTableadd (LuaTable {FloatArray})
FloatArrayat (unsigned long)
+ @@ -4099,7 +4279,9 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + + @@ -4113,6 +4295,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
Constructor
ℂC.FloatVector ()
ℂC.FloatVector ()
Methods
LuaTableadd (LuaTable {float})
floatat (unsigned long)
ℂC.StringList ()
Methods
LuaTableadd (LuaTable {std::string})
std::stringback ()
boolempty ()
std::stringfront ()
LuaIteriter ()
voidpush_back (std::string)
voidreverse ()
+ @@ -4246,6 +4429,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + @@ -4392,13 +4576,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
Constructor
ℂC.StringVector ()
ℂC.StringVector ()
Methods
LuaTableadd (LuaTable {std::string})
std::stringat (unsigned long)

Queries whether the layout had to ellipsize any paragraphs.

This returns true if the ellipsization mode for layout is not Pango::ELLIPSIZE_NONE, a positive width is set on layout, and there are paragraphs exceeding that width that have to be ellipsized.

Returns true if any paragraphs had to be ellipsized, false otherwise.

boolis_wrapped ()

Queries whether the layout had to wrap any paragraphs.

This returns true if a positive width is set on layout, ellipsization mode of layout is set to Pango::ELLIPSIZE_NONE, and there are paragraphs exceeding the layout width that have to be wrapped.

Returns true if any paragraphs had to be wrapped, false otherwise.

voidlayout_cairo_path (Context)
voidset_ellipsize (EllipsizeMode)

Sets the type of ellipsization being performed for layout. Depending on the ellipsization mode ellipsize text is removed from the start, middle, or end of text so they fit within the width and height of layout set with set_width() and set_height().

If the layout contains characters such as newlines that force it to be layed out in multiple paragraphs, then whether each paragraph is ellipsized separately or the entire layout is ellipsized as a whole depends on the set height of the layout. See set_height() for details.

ellipsize
The new ellipsization mode for layout.
voidset_markup (std::string)
boolisnil ()
boolsameinstance (Sequence)
-

ℕ LuaCairo

-
- - - - -
Methods
...color_to_rgba (--lua--)

expand RGBA color to parameters

convert a Canvas::Color (uint32_t 0xRRGGBBAA) into double RGBA values which can be passed as parameters to Cairo::Context::set_source_rgba

Returns r, g, b, a

∁ LuaSignal:Set

C‡: std::bitset<47ul>

@@ -4491,6 +4668,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C + @@ -4747,6 +4925,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
Constructor
ℂPBD.IdVector ()
ℂPBD.IdVector ()
Methods
LuaTableadd (LuaTable {ID})
IDat (unsigned long)
+ @@ -4812,6 +4991,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
Constructor
ℂVamp.Plugin.FeatureList ()
ℂVamp.Plugin.FeatureList ()
Methods
LuaTableadd (LuaTable {Feature})
Featureat (unsigned long)
+ @@ -4886,6 +5066,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
Constructor
ℂVamp.Plugin.OutputList ()
ℂVamp.Plugin.OutputList ()
Methods
LuaTableadd (LuaTable {OutputDescriptor})
OutputDescriptorat (unsigned long)
+ @@ -5275,6 +5456,13 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C
  • ArdourUI.MarkerType.PunchIn
  • ArdourUI.MarkerType.PunchOut
    • +

    ∈ Selection.Operation

    +

    ∈ Editing.SnapType

    - + -
    Ardour 5.6-64-gdcce5f008  -  Fri, 17 Feb 2017 23:55:07 +0100
    +
    Ardour 5.7  -  Mon, 27 Feb 2017 15:02:46 +0100
    -- 2.37.2
    Constructor
    ℂVamp.PluginBase.ParameterList ()
    ℂVamp.PluginBase.ParameterList ()
    Methods
    LuaTableadd (LuaTable {ParameterDescriptor})
    ParameterDescriptorat (unsigned long)