| unsigned int | output_channels () | |||||
| std::string | output_device_name () | |||||
| unsigned int | period_size () | |||||
| bool | sameinstance (AudioBackend) | |||||
| float | sample_rate () | |||||
| int | set_buffer_size (unsigned int) | |||||
Set the buffer size to be used. The device is assumed to use a double buffering scheme, so that one buffer's worth of data can be processed by hardware while software works on the other buffer. All known suitable audio APIs support this model (though ALSA allows for alternate numbers of buffers, and CoreAudio doesn't directly expose the concept). | ||||||
| int | set_device_name (std::string) | |||||
Set the name of the device to be used | ||||||
| int | set_driver (std::string) | |||||
Returns zero if the backend can successfully use Should not be used unless the backend returns true from requires_driver_selection()
| ||||||
Returns zero if the backend can successfully use Should not be used unless the backend returns true from requires_driver_selection()
| ||||||
| int | set_input_device_name (std::string) | |||||
Set the name of the input device to be used if using separate input/output devices. use_separate_input_and_output_devices() | ||||||
| int | set_output_device_name (std::string) | |||||
| Methods | ||||||
|---|---|---|---|---|---|---|
| void | apply_gain (float, long) | |||||
| bool | check_silence (unsigned int, unsigned int&) | |||||
check buffer for silence
Returns true if all samples are zero | ||||||
check buffer for silence
Returns true if all samples are zero | ||||||
| FloatArray | data (long) | |||||
| void | read_from (FloatArray, long, long, long) | |||||
| bool | sameinstance (AudioBuffer) | |||||
| void | silence (long, long) | |||||
silence buffer
| ||||||
silence buffer
| ||||||
C‡: ARDOUR::AudioEngine
@@ -261,7 +258,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C| name | Full or short name of port |
|---|
Returns Corresponding Port or 0.
Returns Corresponding Port or 0.
| Playlist | cut (AudioRangeList&, bool) | |||||||||||
| DataType | data_type () | |||||||||||
| void | duplicate (Region, long, long, float) | |||||||||||
| ||||||||||||
| ||||||||||||
| void | duplicate_range (AudioRange&, float) | |||||||||||
| void | duplicate_until (Region, long, long, long) | |||||||||||
| ||||||||||||
| ||||||||||||
| Region | find_next_region (long, RegionPoint, int) | |||||||||||
| long | find_next_region_boundary (long, int) | |||||||||||
| void | lower_region (Region) | |||||||||||
| RegionListPtr | region_list () | |||||||||||
| RegionListPtr | regions_at (long) | |||||||||||
| RegionListPtr | regions_touched (long, long) | |||||||||||
Returns regions which have some part within this range. | ||||||||||||
Returns regions which have some part within this range. | ||||||||||||
| RegionListPtr | regions_with_end_within (Range) | |||||||||||
| RegionListPtr | regions_with_start_within (Range) | |||||||||||
| void | remove_region (Region) | |||||||||||
| Methods | ||
|---|---|---|
| bool | isnil () | |
| bool | sameinstance (AudioPort) | |
| bool | connected () | |||
Returns true if this port is connected to anything | ||||
| bool | connected_to (std::string) | |||
Returns true if this port is connected to o, otherwise false. | ||||
Returns true if this port is connected to o, otherwise false. | ||||
| int | disconnect (std::string) | |||
| int | disconnect_all () | |||
| std::string | name () | |||
Returns the maximum (linear) amplitude of the region, or a -ve number if the Progress object reports that the process was cancelled. | ||||
| double | rms (Progress) | |||
Returns the maximum (rms) signal power of the region, or a -1 if the Progress object reports that the process was cancelled. | ||||
| bool | sameinstance (AudioRegion) | |||
| float | scale_amplitude () | |||
| void | set_scale_amplitude (float) | |||
Set the region's sync point.
| absolute_pos | Session time. |
|---|
Set the region's sync point.
| Methods | ||
|---|---|---|
| bool | isnil () | |
| bool | sameinstance (AudioTrack) | |
| Methods | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Region | bounce (InterThreadInfo&) | |||||||||||
bounce track from session start to session end to new region
Returns a new audio region (or nil in case of error) | ||||||||||||
bounce track from session start to session end to new region
Returns a new audio region (or nil in case of error) | ||||||||||||
| Region | bounce_range (long, long, InterThreadInfo&, Processor, bool) | |||||||||||
Bounce the given range to a new audio region.
Returns a new audio region (or nil in case of error) | ||||||||||||
Bounce the given range to a new audio region.
Returns a new audio region (or nil in case of error) | ||||||||||||
| bool | bounceable (Processor, bool) | |||||||||||
Test if the track can be bounced with the given settings. If sends/inserts/returns are present in the signal path or the given track has no audio outputs bouncing is not possible.
Returns true if the track can be bounced, or false otherwise. | ||||||||||||
Test if the track can be bounced with the given settings. If sends/inserts/returns are present in the signal path or the given track has no audio outputs bouncing is not possible.
Returns true if the track can be bounced, or false otherwise. | ||||||||||||
| bool | can_record () | |||||||||||
| Playlist | playlist () | |||||||||||
| bool | set_name (std::string) | |||||||||||
| Methods | ||||||||||||
| bool | active () | |||||||||||
| int | add_processor_by_index (Processor, int, ProcessorStreams, bool) | |||||||||||
Add a processor to a route such that it ends up with a given index into the visible processors.
Returns 0 on success, non-0 on failure. | ||||||||||||
Add a processor to a route such that it ends up with a given index into the visible processors.
Returns 0 on success, non-0 on failure. | ||||||||||||
| bool | add_sidechain (Processor) | |||||||||||
| Amp | amp () | |||||||||||
| std::string | comment () | |||||||||||
| bool | customize_plugin_insert (Processor, unsigned int, ChanCount, ChanCount) | |||||||||||
enable custom plugin-insert configuration
Returns true if successful | ||||||||||||
enable custom plugin-insert configuration
Returns true if successful | ||||||||||||
| IO | input () | |||||||||||
| Delivery | main_outs () | |||||||||||
the signal processorat at end of the processing chain which produces output | ||||||||||||
| PeakMeter | peak_meter () | |||||||||||
************************************************************* Pure interface begins here************************************************************* | ||||||||||||
| int | remove_processor (Processor, ProcessorStreams, bool) | |||||||||||
remove plugin/processor
Returns 0 on success | ||||||||||||
remove plugin/processor
Returns 0 on success | ||||||||||||
| int | remove_processors (ProcessorList, ProcessorStreams) | |||||||||||
| bool | remove_sidechain (Processor) | |||||||||||
| int | reorder_processors (ProcessorList, ProcessorStreams) | |||||||||||
| int | replace_processor (Processor, Processor, ProcessorStreams) | |||||||||||
replace plugin/processor with another
Returns 0 on success | ||||||||||||
replace plugin/processor with another
Returns 0 on success | ||||||||||||
| bool | reset_plugin_insert (Processor) | |||||||||||
reset plugin-insert configuration to default, disable customizations. This is equivalent to calling customize_plugin_insert (proc, 0, unused)
Returns true if successful | ||||||||||||
reset plugin-insert configuration to default, disable customizations. This is equivalent to calling customize_plugin_insert (proc, 0, unused)
Returns true if successful | ||||||||||||
| void | set_active (bool, void*) | |||||||||||
| void | set_comment (std::string, void*) | |||||||||||
| void | set_meter_point (MeterPoint, bool) | |||||||||||
| Methods | ||||||||||||
| AutomationControl | automation_control (Parameter, bool) | |||||||||||
| bool | isnil () | |||||||||||
| bool | sameinstance (Automatable) | |||||||||||
C‡: boost::shared_ptr< ARDOUR::AutomatableSequence<Evoral::Beats> >, boost::weak_ptr< ARDOUR::AutomatableSequence<Evoral::Beats> >
@@ -689,7 +679,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C| Methods | ||
|---|---|---|
| bool | isnil () | |
| bool | sameinstance (AutomatableSequence) | |
| Cast | ||
| Sequence | to_sequence () | |
Get the current effective `user' value based on automation state
Get and Set `internal' value
All derived classes must implement this.
Basic derived classes will ignore
| group_override, | but more sophisticated children, notably those that proxy the value setting logic via an object that is aware of group relationships between this control and others, will find it useful. |
|---|
Get and Set `internal' value
All derived classes must implement this.
Basic derived classes will ignore
C‡: ARDOUR::ChanCount
@@ -784,10 +770,10 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C| Constructor | ||||||
|---|---|---|---|---|---|---|
| ℂ | ARDOUR.ChanCount (DataType, unsigned int) | |||||
Convenience constructor for making single-typed streams (mono, stereo, midi, etc)
| ||||||
Convenience constructor for making single-typed streams (mono, stereo, midi, etc)
| ||||||
| Methods | ||||||
| unsigned int | get (DataType) | |||||
query channel count for given type
Returns channel count for given type | ||||||
query channel count for given type
Returns channel count for given type | ||||||
| unsigned int | n_audio () | |||||
query number of audio channels Returns number of audio channels | ||||||
| unsigned int | n_midi () | |||||
| void | reset () | |||||
zero count of all data types | ||||||
| void | set (DataType, unsigned int) | |||||
set channel count for given type
| ||||||
set channel count for given type
| ||||||
C‡: ARDOUR::ChanMapping
@@ -809,12 +795,12 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to Cget buffer mapping for given data type and pin
| from | numeric source id |
|---|---|
| type | data type |
Returns mapped buffer number (or ChanMapping::Invalid)
get buffer mapping for given data type and pin
Returns mapped buffer number (or ChanMapping::Invalid)
Test if this mapping is monotonic (useful to see if inplace processing is feasible)
Returns true if the map is a strict monotonic set
set buffer mapping for given data type
| from | numeric source id |
|---|---|
| to | buffer |
| type | data type |
set buffer mapping for given data type
C‡: std::list<boost::shared_ptr<ARDOUR::AutomationControl> >
@@ -862,15 +848,15 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to Cnon-linear power-scale meter deflection
| power | signal power (dB) |
|---|
Returns deflected value
non-linear power-scale meter deflection
Returns deflected value
non-linear power-scale meter deflection
| coeff | signal value |
|---|
Returns deflected value
non-linear power-scale meter deflection
Returns deflected value
lua wrapper to memset()
matrix multiply multiply every sample of `data' with the corresponding sample at `mult'.
| data | multiplicand |
|---|---|
| mult | multiplicand |
| n_samples | number of samples in data and mmult |
matrix multiply multiply every sample of `data' with the corresponding sample at `mult'.
| Constructor | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| ℂ | ARDOUR.DSP.Biquad (double) | |||||||||
Instantiate Biquad Filter
| ||||||||||
Instantiate Biquad Filter
| ||||||||||
| Methods | ||||||||||
| void | compute (Type, double, double, double) | |||||||||
setup filter, compute coefficients
| ||||||||||
setup filter, compute coefficients
| ||||||||||
| void | configure (double, double, double, double, double) | |||||||||
setup filter, set coefficients directly | ||||||||||
| float | dB_at_freq (float) | |||||||||
filter transfer function (filter response for spectrum visualization)
Returns gain at given frequency in dB (clamped to -120..+120) | ||||||||||
filter transfer function (filter response for spectrum visualization)
Returns gain at given frequency in dB (clamped to -120..+120) | ||||||||||
| void | reset () | |||||||||
reset filter state | ||||||||||
| void | run (FloatArray, unsigned int) | |||||||||
process audio data
| ||||||||||
process audio data
| ||||||||||
C‡: ARDOUR::DSP::DspShm
@@ -903,17 +889,17 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C[re] allocate memory in host's memory space
| s | size, total number of float or integer elements to store. |
|---|
[re] allocate memory in host's memory space
atomically read integer at offset
This involves a memory barrier. This call is intended for buffers which are shared with another instance.
| off | offset in shared memory region |
|---|
Returns value at offset
atomically read integer at offset
This involves a memory barrier. This call is intended for buffers which are shared with another instance.
Returns value at offset
atomically set integer at offset
This involves a memory barrier. This call is intended for buffers which are shared with another instance.
| off | offset in shared memory region |
|---|---|
| val | value to set |
atomically set integer at offset
This involves a memory barrier. This call is intended for buffers which are shared with another instance.
clear memory (set to zero)
access memory as float array
| off | offset in shared memory region |
|---|
Returns float[]
access memory as float array
Returns float[]
access memory as integer array
| off | offset in shared memory region |
|---|
Returns int_32_t[]
access memory as integer array
Returns int_32_t[]
C‡: ARDOUR::DSP::FFTSpectrum
@@ -926,7 +912,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to Cprocess current data in buffer
query
| b | the frequency bin 0 .. window_size / 2 |
|---|---|
| norm | gain factor (set equal to for 1/f normalization) |
Returns signal power at given bin (in dBFS)
query
Returns signal power at given bin (in dBFS)
| Constructor | ||||||||
|---|---|---|---|---|---|---|---|---|
| ℂ | ARDOUR.DSP.LowPass (double, float) | |||||||
instantiate a LPF
| ||||||||
instantiate a LPF
| ||||||||
| Methods | ||||||||
| void | ctrl (FloatArray, float, unsigned int) | |||||||
filter control data This is useful for parameter smoothing.
| ||||||||
filter control data This is useful for parameter smoothing.
| ||||||||
| void | proc (FloatArray, unsigned int) | |||||||
process audio data
| ||||||||
process audio data
| ||||||||
| void | reset () | |||||||
reset filter state | ||||||||
| void | set_cutoff (float) | |||||||
update filter cut-off frequency
| ||||||||
update filter cut-off frequency
| ||||||||
C‡: ARDOUR::DataType
@@ -973,7 +959,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C| Constructor | ||||||||
|---|---|---|---|---|---|---|---|---|
| ℂ | ARDOUR.FluidSynth (float, int) | |||||||
instantiate a Synth
| ||||||||
instantiate a Synth
| ||||||||
| Methods | ||||||||
| bool | load_sf2 (std::string) | |||||||
| bool | midi_event (unsigned char*, unsigned long) | |||||||
| Methods | ||
|---|---|---|
| bool | isnil () | |
| bool | sameinstance (GainControl) | |
| void | set_automation_state (AutoState) | |||||||
| void | set_automation_style (AutoStyle) | |||||||
| void | set_value (double, GroupControlDisposition) | |||||||
Get and Set `internal' value All derived classes must implement this. Basic derived classes will ignore
| ||||||||
Get and Set `internal' value All derived classes must implement this. Basic derived classes will ignore
| ||||||||
| void | start_touch (double) | |||||||
| void | stop_touch (bool, double) | |||||||
| bool | writable () | |||||||
| Methods | ||||||||
|---|---|---|---|---|---|---|---|---|
| bool | active () | |||||||
| int | add_port (std::string, void*, DataType) | |||||||
Add a port.
| ||||||||
Add a port.
| ||||||||
| AudioPort | audio (unsigned int) | |||||||
| int | connect (Port, std::string, void*) | |||||||
| int | disconnect (Port, std::string, void*) | |||||||
| bool | physically_connected () | |||||||
| Port | port_by_name (unsigned int) | |||||||
| int | remove_port (Port, void*) | |||||||
| bool | sameinstance (IO) | |||||||
| ChanCount | natural_input_streams () | |
| ChanCount | natural_output_streams () | |
| IO | output () | |
| bool | sameinstance (IOProcessor) |
| int | move_to (long, unsigned int) | |||||||
| std::string | name () | |||||||
| int | set_end (long, bool, bool, unsigned int) | |||||||
Set end position.
| ||||||||
Set end position.
| ||||||||
| int | set_length (long, long, bool, unsigned int) | |||||||
| int | set_start (long, bool, bool, unsigned int) | |||||||
Set start position.
| ||||||||
Set start position.
| ||||||||
| long | start () | |||||||
| void | unlock () | |||||||
Look for the `marks' (either locations which are marks, or start/end points of range markers) either side of a frame. Note that if frame is exactly on a `mark', that mark will not be considered for returning as before/after.
| frame | Frame to look for. |
|---|---|
| before | Filled in with the position of the last `mark' before `frame' (or max_framepos if none exists) |
| after | Filled in with the position of the next `mark' after `frame' (or max_framepos if none exists) |
Look for the `marks' (either locations which are marks, or start/end points of range markers) either side of a frame. Note that if frame is exactly on a `mark', that mark will not be considered for returning as before/after.
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)
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
get a plugin control parameter value
Returns value
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
get a plugin control parameter value
Returns value
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)
create a new Lua Processor (Plugin)
| s | Session Handle |
|---|---|
| p | Identifier or Name of the Processor |
Returns Processor object (may be nil)
create a new Lua Processor (Plugin)
Returns Processor object (may be nil)
create a new Plugin Instance
| s | Session Handle |
|---|---|
| id | Plugin Name, ID or URI |
| type | Plugin Type |
Returns Processor or nil
create a new Plugin Instance
Returns Processor or nil
search a Plugin
| id | Plugin Name, ID or URI |
|---|---|
| type | Plugin Type |
Returns PluginInfo or nil if not found
search a Plugin
Returns PluginInfo or nil if not found
A convenience function to get a Automation Lists and ParamaterDescriptor for a given plugin control.
This is equivalent to the following lua code
function (processor, param_id) @@ -1307,13 +1289,13 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C return ac:alist(), ac:to_ctrl():list(), t[2] end
Example usage: get the third input parameter of first plugin on the given route (Ardour starts counting at zero).
local al, cl, pd = ARDOUR.LuaAPI.plugin_automation (route:nth_plugin (0), 3)
Returns 3 parameters: AutomationList, ControlList, ParamaterDescriptor
reset a processor to its default values (only works for plugins )
This is a wrapper which looks up the Processor by plugin-insert.
| proc | Plugin-Insert |
|---|
Returns true on success, false when the processor is not a plugin
reset a processor to its default values (only works for plugins )
This is a wrapper which looks up the Processor by plugin-insert.
Returns true on success, false when the processor is not a plugin
Generic conversion from audio sample count to timecode. (TimecodeType, sample-rate, sample-pos)
set a plugin control-input parameter value
This is a wrapper around set_processor_param which looks up the Processor by plugin-insert.
| which | control-input to set (starting at 0) |
|---|---|
| proc | Plugin-Insert |
| value | value to set |
Returns true on success, false on error or out-of-bounds value
set a plugin control-input parameter value
This is a wrapper around set_processor_param which looks up the Processor by plugin-insert.
Returns true on success, false on error or out-of-bounds value
set a plugin control-input parameter value
| proc | Plugin-Processor |
|---|---|
| which | control-input to set (starting at 0) |
| value | value to set |
Returns true on success, false on error or out-of-bounds value
set a plugin control-input parameter value
Returns true on success, false on error or out-of-bounds value
Generic conversion from timecode to audio sample count. (TimecodeType, sample-rate, hh, mm, ss, ff)
high-level abstraction to process a single channel of the given Readable.
If the plugin is not yet initialized, initialize() is called.
if is not nil, it is called with the immediate Vamp::Plugin::Features on every process call.
| r | readable |
|---|---|
| channel | channel to process |
| fn | lua callback function |
Returns 0 on success
high-level abstraction to process a single channel of the given Readable.
If the plugin is not yet initialized, initialize() is called.
if is not nil, it is called with the immediate Vamp::Plugin::Features on every process call.
Returns 0 on success
initialize the plugin for use with analyze().
This is equivalent to plugin():initialise (1, ssiz, bsiz) and prepares a plugin for analyze. (by preferred step and block sizes are used. if the plugin does not specify them or they're larger than 8K, both are set to 1024)
Manual initialization is only required to set plugin-parameters which depend on prior initialization of the plugin.
vamp:reset () vamp:initialize () @@ -1335,7 +1317,7 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to CStringVector list_plugins () Plugin plugin () - FeatureSet process (FloatArrayVector, RealTime) + process given array of audio-samples.
This is a lua-binding for vamp:plugin():process ()
d audio-data, the vector must match the configured channel count and hold a complete buffer for every channel as set during plugin():initialise() rt timestamp matching the provided buffer. Returns features extracted from that data (if the plugin is causal)
process given array of audio-samples.
This is a lua-binding for vamp:plugin():process ()
- d
- audio-data, the vector must match the configured channel count and hold a complete buffer for every channel as set during plugin():initialise()
- rt
- timestamp matching the provided buffer.
Returns features extracted from that data (if the plugin is causal)
void reset () call plugin():reset() and clear intialization flag
| Constructor | ||||
|---|---|---|---|---|
| ℂ | ARDOUR.LuaOSC.Address (std::string) | |||
Construct a new OSC transmitter object
| ||||
Construct a new OSC transmitter object
| ||||
| Methods | ||||
| ... | send (--lua--) | |||
Transmit an OSC message Path (string) and type (string) must always be given. The number of following args must match the type. Supported types are: 'i': integer (lua number) 'f': float (lua number) 'd': double (lua number) 'h': 64bit integer (lua number) 's': string (lua string) 'c': character (lua string) 'T': boolean (lua bool) -- this is not implicily True, a lua true/false must be given 'F': boolean (lua bool) -- this is not implicily False, a lua true/false must be given
Returns boolean true if successful, false on error. | ||||
Transmit an OSC message Path (string) and type (string) must always be given. The number of following args must match the type. Supported types are: 'i': integer (lua number) 'f': float (lua number) 'd': double (lua number) 'h': 64bit integer (lua number) 's': string (lua string) 'c': character (lua string) 'T': boolean (lua bool) -- this is not implicily True, a lua true/false must be given 'F': boolean (lua bool) -- this is not implicily False, a lua true/false must be given
Returns boolean true if successful, false on error. | ||||
C‡: boost::shared_ptr< ARDOUR::LuaProc >, boost::weak_ptr< ARDOUR::LuaProc >
@@ -1359,7 +1341,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C| Methods | ||
|---|---|---|
| bool | isnil () | |
| bool | sameinstance (LuaProc) | |
| DspShm | shmem () | |
| LuaTableRef | table () | |
Reallocate the buffer used internally to handle at least size_t units of data.
The buffer is not silent after this operation. the capacity argument passed to the constructor must have been non-zero.
Clear (eg zero, or empty) buffer
Start a new NoteDiff command.
This has no side-effects on the model or Session, the returned command can be held on to for as long as the caller wishes, or discarded without formality, until apply_command is called and ownership is taken.
| Methods | ||
|---|---|---|
| bool | isnil () | |
| bool | sameinstance (MidiPlaylist) | |
| void | set_note_mode (NoteMode) | |
| gap | from the beginning of the region to the next beginning |
|---|
| gap | from the beginning of the region to the next beginning |
|---|---|
| end | the first frame that does _not_ contain a duplicated frame |
| start | Range start. |
|---|---|
| end | Range end. |
Returns regions which have some part within this range.
Returns regions which have some part within this range.
Returns true if this port is connected to anything
| o | Port name |
|---|
Returns true if this port is connected to o, otherwise false.
Returns true if this port is connected to o, otherwise false.
Set the region's sync point.
| absolute_pos | Session time. |
|---|
Set the region's sync point.
| Methods | ||
|---|---|---|
| bool | isnil () | |
| bool | sameinstance (MidiTrack) | |
| Methods | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Region | bounce (InterThreadInfo&) | |||||||||||
bounce track from session start to session end to new region
Returns a new audio region (or nil in case of error) | ||||||||||||
bounce track from session start to session end to new region
Returns a new audio region (or nil in case of error) | ||||||||||||
| Region | bounce_range (long, long, InterThreadInfo&, Processor, bool) | |||||||||||
Bounce the given range to a new audio region.
Returns a new audio region (or nil in case of error) | ||||||||||||
Bounce the given range to a new audio region.
Returns a new audio region (or nil in case of error) | ||||||||||||
| bool | bounceable (Processor, bool) | |||||||||||
Test if the track can be bounced with the given settings. If sends/inserts/returns are present in the signal path or the given track has no audio outputs bouncing is not possible.
Returns true if the track can be bounced, or false otherwise. | ||||||||||||
Test if the track can be bounced with the given settings. If sends/inserts/returns are present in the signal path or the given track has no audio outputs bouncing is not possible.
Returns true if the track can be bounced, or false otherwise. | ||||||||||||
| bool | can_record () | |||||||||||
| Playlist | playlist () | |||||||||||
| bool | set_name (std::string) | |||||||||||
| Methods | ||||||||||||
| bool | active () | |||||||||||
| int | add_processor_by_index (Processor, int, ProcessorStreams, bool) | |||||||||||
Add a processor to a route such that it ends up with a given index into the visible processors.
Returns 0 on success, non-0 on failure. | ||||||||||||
Add a processor to a route such that it ends up with a given index into the visible processors.
Returns 0 on success, non-0 on failure. | ||||||||||||
| bool | add_sidechain (Processor) | |||||||||||
| Amp | amp () | |||||||||||
| std::string | comment () | |||||||||||
| bool | customize_plugin_insert (Processor, unsigned int, ChanCount, ChanCount) | |||||||||||
enable custom plugin-insert configuration
Returns true if successful | ||||||||||||
enable custom plugin-insert configuration
Returns true if successful | ||||||||||||
| IO | input () | |||||||||||
| Delivery | main_outs () | |||||||||||
the signal processorat at end of the processing chain which produces output | ||||||||||||
| PeakMeter | peak_meter () | |||||||||||
************************************************************* Pure interface begins here************************************************************* | ||||||||||||
| int | remove_processor (Processor, ProcessorStreams, bool) | |||||||||||
remove plugin/processor
Returns 0 on success | ||||||||||||
remove plugin/processor
Returns 0 on success | ||||||||||||
| int | remove_processors (ProcessorList, ProcessorStreams) | |||||||||||
| bool | remove_sidechain (Processor) | |||||||||||
| int | reorder_processors (ProcessorList, ProcessorStreams) | |||||||||||
| int | replace_processor (Processor, Processor, ProcessorStreams) | |||||||||||
replace plugin/processor with another
Returns 0 on success | ||||||||||||
replace plugin/processor with another
Returns 0 on success | ||||||||||||
| bool | reset_plugin_insert (Processor) | |||||||||||
reset plugin-insert configuration to default, disable customizations. This is equivalent to calling customize_plugin_insert (proc, 0, unused)
Returns true if successful | ||||||||||||
reset plugin-insert configuration to default, disable customizations. This is equivalent to calling customize_plugin_insert (proc, 0, unused)
Returns true if successful | ||||||||||||
| void | set_active (bool, void*) | |||||||||||
| void | set_comment (std::string, void*) | |||||||||||
| void | set_meter_point (MeterPoint, bool) | |||||||||||
| bool | monitor_active () | |||||||||||
| bool | mono () | |||||||||||
| Controllable | mono_control () | |||||||||||
| bool | sameinstance (MonitorProcessor) | |||||||||||
| void | set_cut (unsigned int, bool) | |||||||||||
| void | set_cut_all (bool) | |||||||||||
| void | set_dim (unsigned int, bool) | |||||||||||
| bool | isnil () | |||||||||||
| bool | muted () | |||||||||||
| bool | muted_by_self () | |||||||||||
| bool | sameinstance (MuteControl) | |||||||||||
| void | set_automation_state (AutoState) | |||
| void | set_automation_style (AutoStyle) | |||
| void | set_value (double, GroupControlDisposition) | |||
Get and Set `internal' value All derived classes must implement this. Basic derived classes will ignore
| ||||
Get and Set `internal' value All derived classes must implement this. Basic derived classes will ignore
| ||||
| void | start_touch (double) | |||
| void | stop_touch (bool, double) | |||
| bool | writable () | |||
| Methods | ||||
|---|---|---|---|---|
| bool | bypassed () | |||
| bool | isnil () | |||
| bool | sameinstance (PannerShell) | |||
| void | set_bypassed (bool) | |||
| c | Audio channel index. |
|---|---|
| yn | true to invert phase, otherwise false. |
| void | set_automation_state (AutoState) | |||||
| void | set_automation_style (AutoStyle) | |||||
| void | set_value (double, GroupControlDisposition) | |||||
Get and Set `internal' value All derived classes must implement this. Basic derived classes will ignore
| ||||||
Get and Set `internal' value All derived classes must implement this. Basic derived classes will ignore
| ||||||
| void | start_touch (double) | |||||
| void | stop_touch (bool, double) | |||||
| bool | writable () | |||||
| Playlist | cut (AudioRangeList&, bool) | |||||
| DataType | data_type () | |||||
| void | duplicate (Region, long, long, float) | |||||
| ||||||
| ||||||
| void | duplicate_range (AudioRange&, float) | |||||
| void | duplicate_until (Region, long, long, long) | |||||
| ||||||
| ||||||
| Region | find_next_region (long, RegionPoint, int) | |||||
| long | find_next_region_boundary (long, int) | |||||
| bool | isnil () | |||||
| RegionListPtr | region_list () | |||||
| RegionListPtr | regions_at (long) | |||||
| RegionListPtr | regions_touched (long, long) | |||||
Returns regions which have some part within this range. | ||||||
Returns regions which have some part within this range. | ||||||
| RegionListPtr | regions_with_end_within (Range) | |||||
| RegionListPtr | regions_with_start_within (Range) | |||||
| void | remove_region (Region) | |||||
| bool | sameinstance (Playlist) | |||||
| void | split (long) | |||||
| void | split_region (Region, MusicFrame) | |||||
| Region | top_region_at (long) | |||||
| bool | parameter_is_input (unsigned int) | |||||
| PresetRecord | preset_by_label (std::string) | |||||
| PresetRecord | preset_by_uri (std::string) | |||||
| bool | sameinstance (Plugin) | |||||
| std::string | unique_id () | |||||
| Cast | ||||||
|---|---|---|---|---|---|---|
| LuaProc | to_luaproc () | |||||
| Methods | ||
|---|---|---|
| bool | isnil () | |
| bool | sameinstance (PluginControl) | |
| void | set_automation_state (AutoState) | |||||
| void | set_automation_style (AutoStyle) | |||||
| void | set_value (double, GroupControlDisposition) | |||||
Get and Set `internal' value All derived classes must implement this. Basic derived classes will ignore
| ||||||
Get and Set `internal' value All derived classes must implement this. Basic derived classes will ignore
| ||||||
| void | start_touch (double) | |||||
| void | stop_touch (bool, double) | |||||
| bool | writable () | |||||
| PresetVector | get_presets (bool) | |||||
| bool | is_instrument () | |||||
| bool | isnil () | |||||
| bool | sameinstance (PluginInfo) | |||||
| Data Members | ||||||
|---|---|---|---|---|---|---|
| std::string | category | |||||
| std::string | creator | |||||
| ChanMapping | output_map (unsigned int) | |||||
| Plugin | plugin (unsigned int) | |||||
| bool | reset_parameters_to_default () | |||||
| bool | sameinstance (PluginInsert) | |||||
| void | set_input_map (unsigned int, ChanMapping) | |||||
| void | set_output_map (unsigned int, ChanMapping) | |||||
| bool | strict_io_configured () | |||||
| bool | connected () | |||||
Returns true if this port is connected to anything | ||||||
| bool | connected_to (std::string) | |||||
Returns true if this port is connected to o, otherwise false. | ||||||
Returns true if this port is connected to o, otherwise false. | ||||||
| int | disconnect (std::string) | |||||
| int | disconnect_all () | |||||
| bool | isnil () | |||||
Returns Port human readable name | ||||||
| bool | receives_input () | |||||
Returns true if this Port receives input, otherwise false | ||||||
| bool | sameinstance (Port) | |||||
| bool | sends_output () | |||||
Returns true if this Port sends output, otherwise false | ||||||
| Cast | ||||||
| void | get_physical_inputs (DataType, StringVector&, MidiPortFlags, MidiPortFlags) | |||||
| void | get_physical_outputs (DataType, StringVector&, MidiPortFlags, MidiPortFlags) | |||||
| Port | get_port_by_name (std::string) | |||||
Returns Corresponding Port or 0. | ||||||
Returns Corresponding Port or 0. | ||||||
| LuaTable(int, ...) | get_ports (DataType, PortList&) | |||||
| std::string | get_pretty_name_by_name (std::string) | |||||
| ChanCount | n_physical_inputs () | |||||
| bool | isnil () | |||||
| unsigned long | num_ports (DataType) | |||||
| Port | port (DataType, unsigned long) | |||||
nth port of type t, or nth port if t = NIL
| ||||||
nth port of type t, or nth port if t = NIL
| ||||||
| bool | remove (Port) | |||||
| bool | sameinstance (PortSet) | |||||
C‡: ARDOUR::PresentationInfo
@@ -2521,7 +2483,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to CC‡: boost::shared_ptr< ARDOUR::Region >, boost::weak_ptr< ARDOUR::Region >
@@ -2659,7 +2619,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to CA gui may need to create a region, then place it in an initial position determined by the user. When this takes place within one gui operation, we have to reset _last_position to prevent an implied move.
Set the region's sync point.
| absolute_pos | Session time. |
|---|
Set the region's sync point.
Add a processor to a route such that it ends up with a given index into the visible processors.
| index | Index to add the processor at, or -1 to add at the end of the list. |
|---|
Returns 0 on success, non-0 on failure.
Add a processor to a route such that it ends up with a given index into the visible processors.
Returns 0 on success, non-0 on failure.
enable custom plugin-insert configuration
| proc | Processor to customize |
|---|---|
| count | number of plugin instances to use (if zero, reset to default) |
| outs | output port customization |
| sinks | input pins for variable-I/O plugins |
Returns true if successful
enable custom plugin-insert configuration
Returns true if successful
************************************************************* Pure interface begins here*************************************************************
remove plugin/processor
| proc | processor to remove |
|---|---|
| err | error report (index where removal vailed, channel-count why it failed) may be nil |
| need_process_lock | if locking is required (set to true, unless called from RT context with lock) |
Returns 0 on success
remove plugin/processor
Returns 0 on success
replace plugin/processor with another
| old | processor to remove |
|---|---|
| sub | processor to substitute the old one with |
| err | error report (index where removal vailed, channel-count why it failed) may be nil |
Returns 0 on success
replace plugin/processor with another
Returns 0 on success
reset plugin-insert configuration to default, disable customizations.
This is equivalent to calling
customize_plugin_insert (proc, 0, unused)
| proc | Processor to reset |
|---|
Returns true if successful
reset plugin-insert configuration to default, disable customizations.
This is equivalent to calling
customize_plugin_insert (proc, 0, unused)
Returns true if successful
| Methods | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| int | add (Route) | |||||||||
Add a route to a group. Adding a route which is already in the group is allowed; nothing will happen.
| ||||||||||
Add a route to a group. Adding a route which is already in the group is allowed; nothing will happen.
| ||||||||||
| void | clear () | |||||||||
| void | destroy_subgroup () | |||||||||
| bool | empty () | |||||||||
| void | add_command (Command) | |||||||||
| void | add_internal_sends (Route, Placement, RouteListPtr) | |||||||||
| StatefulDiffCommand | add_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.
Returns the allocated StatefulDiffCommand (already added via add_command) | ||||||||||
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.
Returns the allocated StatefulDiffCommand (already added via add_command) | ||||||||||
| void | begin_reversible_command (std::string) | |||||||||
begin collecting undo information This call must always be followed by either begin_reversible_command() or commit_reversible_command()
| ||||||||||
begin collecting undo information This call must always be followed by either begin_reversible_command() or commit_reversible_command()
| ||||||||||
| void | cancel_all_solo () | |||||||||
| SessionConfiguration | cfg () | |||||||||
| void | clear_all_solo_state (RouteListPtr) | |||||||||
| void | commit_reversible_command (Command) | |||||||||
finalize an undo command and commit pending transactions This must only be called after begin_reversible_command ()
| ||||||||||
finalize an undo command and commit pending transactions This must only be called after begin_reversible_command ()
| ||||||||||
| Controllable | controllable_by_id (ID) | |||||||||
| long | current_end_frame () | |||||||||
| long | current_start_frame () | |||||||||
| ... | sample_to_timecode_lua (--lua--) | |||||||||
| double | samples_per_timecode_frame () | |||||||||
| int | save_state (std::string, bool, bool, bool) | |||||||||
save session
Returns zero on success | ||||||||||
save session
Returns zero on success | ||||||||||
| void | scripts_changed () | |||||||||
| void | set_control (AutomationControl, double, GroupControlDisposition) | |||||||||
| void | set_controls (ControlListPtr, double, GroupControlDisposition) | |||||||||
| Methods | ||||||||||
| bool | isnil () | |||||||||
| std::string | name () | |||||||||
| bool | sameinstance (SessionObject) | |||||||||
| Cast | ||||||||||
| Stateful | to_stateful () | |||||||||
| StatefulDestructible | to_statefuldestructible () | |||||||||
| Methods | ||
|---|---|---|
| bool | isnil () | |
| bool | sameinstance (SideChain) | |
| double | get_masters_value () | |
| bool | isnil () | |
| void | remove_master (AutomationControl) | |
| bool | sameinstance (SlavableAutomationControl,) | |
| bool | slaved () | |
| bool | slaved_to (AutomationControl) |
Get and Set `internal' value
All derived classes must implement this.
Basic derived classes will ignore
| group_override, | but more sophisticated children, notably those that proxy the value setting logic via an object that is aware of group relationships between this control and others, will find it useful. |
|---|
Get and Set `internal' value
All derived classes must implement this.
Basic derived classes will ignore
Get and Set `internal' value
All derived classes must implement this.
Basic derived classes will ignore
| group_override, | but more sophisticated children, notably those that proxy the value setting logic via an object that is aware of group relationships between this control and others, will find it useful. |
|---|
Get and Set `internal' value
All derived classes must implement this.
Basic derived classes will ignore
| Methods | ||
|---|---|---|
| bool | isnil () | |
| bool | sameinstance (SoloIsolateControl) | |
| bool | self_solo_isolated () | |
| bool | solo_isolated () | |
Get and Set `internal' value
All derived classes must implement this.
Basic derived classes will ignore
| group_override, | but more sophisticated children, notably those that proxy the value setting logic via an object that is aware of group relationships between this control and others, will find it useful. |
|---|
Get and Set `internal' value
All derived classes must implement this.
Basic derived classes will ignore
| Methods | ||
|---|---|---|
| bool | isnil () | |
| bool | sameinstance (SoloSafeControl) | |
| bool | solo_safe () | |
Get and Set `internal' value
All derived classes must implement this.
Basic derived classes will ignore
| group_override, | but more sophisticated children, notably those that proxy the value setting logic via an object that is aware of group relationships between this control and others, will find it useful. |
|---|
Get and Set `internal' value
All derived classes must implement this.
Basic derived classes will ignore
Tempo, the speed at which musical time progresses (BPM).
| Constructor | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ℂ | ARDOUR.Tempo (double, double) | |||||||||||
| ||||||||||||
| ℂ | ARDOUR.Tempo (double, double, double) | |||||||||||
| Methods | ||||||||||||
| double | frames_per_note_type (long) | |||||||||||
audio samples per note type. if you want an instantaneous value for this, use TempoMap::frames_per_quarter_note_at() instead.
| ||||||||||||
audio samples per note type. if you want an instantaneous value for this, use TempoMap::frames_per_quarter_note_at() instead.
| ||||||||||||
| double | frames_per_quarter_note (long) | |||||||||||
audio samples per quarter note. if you want an instantaneous value for this, use TempoMap::frames_per_quarter_note_at() instead.
| ||||||||||||
audio samples per quarter note. if you want an instantaneous value for this, use TempoMap::frames_per_quarter_note_at() instead.
| ||||||||||||
| double | note_type () | |||||||||||
| double | note_types_per_minute () | |||||||||||
| double | quarter_notes_per_minute () | |||||||||||
| Methods | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| MeterSection | add_meter (Meter, double, BBT_TIME, long, PositionLockStyle) | |||||||||||
| TempoSection | add_tempo (Tempo, double, long, Type, PositionLockStyle) | |||||||||||
| TempoSection | add_tempo (Tempo, double, long, PositionLockStyle) | |||||||||||
| BBT_TIME | bbt_at_frame (long) | |||||||||||
Returns the BBT time corresponding to the supplied frame position.
Returns the BBT time at the frame position . | ||||||||||||
Returns the BBT time corresponding to the supplied frame position.
Returns the BBT time at the frame position . | ||||||||||||
| double | exact_beat_at_frame (long, int) | |||||||||||
| double | exact_qn_at_frame (long, int) | |||||||||||
| MeterSection | meter_section_at_beat (double) | |||||||||||
| Methods | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Region | bounce (InterThreadInfo&) | |||||||||||
bounce track from session start to session end to new region
Returns a new audio region (or nil in case of error) | ||||||||||||
bounce track from session start to session end to new region
Returns a new audio region (or nil in case of error) | ||||||||||||
| Region | bounce_range (long, long, InterThreadInfo&, Processor, bool) | |||||||||||
Bounce the given range to a new audio region.
Returns a new audio region (or nil in case of error) | ||||||||||||
Bounce the given range to a new audio region.
Returns a new audio region (or nil in case of error) | ||||||||||||
| bool | bounceable (Processor, bool) | |||||||||||
Test if the track can be bounced with the given settings. If sends/inserts/returns are present in the signal path or the given track has no audio outputs bouncing is not possible.
Returns true if the track can be bounced, or false otherwise. | ||||||||||||
Test if the track can be bounced with the given settings. If sends/inserts/returns are present in the signal path or the given track has no audio outputs bouncing is not possible.
Returns true if the track can be bounced, or false otherwise. | ||||||||||||
| bool | can_record () | |||||||||||
| bool | isnil () | |||||||||||
| Playlist | playlist () | |||||||||||
| bool | sameinstance (Track) | |||||||||||
| bool | set_name (std::string) | |||||||||||
| Cast | ||||||||||||
| AudioTrack | to_audio_track () | |||||||||||
| Methods | ||||||||||||
| bool | active () | |||||||||||
| int | add_processor_by_index (Processor, int, ProcessorStreams, bool) | |||||||||||
Add a processor to a route such that it ends up with a given index into the visible processors.
Returns 0 on success, non-0 on failure. | ||||||||||||
Add a processor to a route such that it ends up with a given index into the visible processors.
Returns 0 on success, non-0 on failure. | ||||||||||||
| bool | add_sidechain (Processor) | |||||||||||
| Amp | amp () | |||||||||||
| std::string | comment () | |||||||||||
| bool | customize_plugin_insert (Processor, unsigned int, ChanCount, ChanCount) | |||||||||||
enable custom plugin-insert configuration
Returns true if successful | ||||||||||||
enable custom plugin-insert configuration
Returns true if successful | ||||||||||||
| IO | input () | |||||||||||
| Delivery | main_outs () | |||||||||||
the signal processorat at end of the processing chain which produces output | ||||||||||||
| PeakMeter | peak_meter () | |||||||||||
************************************************************* Pure interface begins here************************************************************* | ||||||||||||
| int | remove_processor (Processor, ProcessorStreams, bool) | |||||||||||
remove plugin/processor
Returns 0 on success | ||||||||||||
remove plugin/processor
Returns 0 on success | ||||||||||||
| int | remove_processors (ProcessorList, ProcessorStreams) | |||||||||||
| bool | remove_sidechain (Processor) | |||||||||||
| int | reorder_processors (ProcessorList, ProcessorStreams) | |||||||||||
| int | replace_processor (Processor, Processor, ProcessorStreams) | |||||||||||
replace plugin/processor with another
Returns 0 on success | ||||||||||||
replace plugin/processor with another
Returns 0 on success | ||||||||||||
| bool | reset_plugin_insert (Processor) | |||||||||||
reset plugin-insert configuration to default, disable customizations. This is equivalent to calling customize_plugin_insert (proc, 0, unused)
Returns true if successful | ||||||||||||
reset plugin-insert configuration to default, disable customizations. This is equivalent to calling customize_plugin_insert (proc, 0, unused)
Returns true if successful | ||||||||||||
| void | set_active (bool, void*) | |||||||||||
| void | set_comment (std::string, void*) | |||||||||||
| void | set_meter_point (MeterPoint, bool) | |||||||||||
| Methods | ||
|---|---|---|
| bool | isnil () | |
| bool | sameinstance (UnknownProcessor) | |
| void | clear_playlist (Playlist) | |||||||||
| void | clear_playlists (TimeAxisView) | |||||||||
| void | consider_auditioning (Region) | |||||||||
Possibly start the audition of a region. If
| ||||||||||
Possibly start the audition of a region. If
| ||||||||||
| void | copy_playlists (TimeAxisView) | |||||||||
| MouseMode | current_mouse_mode () | |||||||||
Returns The current mouse mode (gain, object, range, timefx etc.) (defined in editing_syms.h) | ||||||||||
| void | play_selection () | |||||||||
| void | play_with_preroll () | |||||||||
| void | redo (unsigned int) | |||||||||
Redo some transactions.
| ||||||||||
Redo some transactions.
| ||||||||||
| RegionView | regionview_from_region (Region) | |||||||||
| void | remove_last_capture () | |||||||||
| void | remove_location_at_playhead_cursor () | |||||||||
| void | select_all_tracks () | |||||||||
| void | separate_region_from_selection () | |||||||||
| void | set_follow_playhead (bool, bool) | |||||||||
Set whether the editor should follow the playhead.
| ||||||||||
Set whether the editor should follow the playhead.
| ||||||||||
| void | set_loop_range (long, long, std::string) | |||||||||
| void | set_mouse_mode (MouseMode, bool) | |||||||||
Set the mouse mode (gain, object, range, timefx etc.)
| ||||||||||
Set the mouse mode (gain, object, range, timefx etc.)
| ||||||||||
| void | set_punch_range (long, long, std::string) | |||||||||
| void | set_selection (SelectionList, Operation) | |||||||||
| void | set_show_measures (bool) | |||||||||
| void | set_snap_mode (SnapMode) | |||||||||
Set the snap mode.
| ||||||||||
Set the snap mode.
| ||||||||||
| void | set_snap_threshold (double) | |||||||||
Set the snap threshold.
| ||||||||||
Set the snap threshold.
| ||||||||||
| void | set_stationary_playhead (bool) | |||||||||
| void | set_video_timeline_height (int) | |||||||||
| void | set_zoom_focus (ZoomFocus) | |||||||||
| void | toggle_ruler_video (bool) | |||||||||
| void | toggle_xjadeo_proc (int) | |||||||||
| void | undo (unsigned int) | |||||||||
Undo some transactions.
| ||||||||||
Undo some transactions.
| ||||||||||
| double | visible_canvas_height () | |||||||||
Clear everything from the Selection
check if all selections are empty
| internal_selection | also check object internals (e.g midi notes, automation points), when false only check objects. |
|---|
Returns true if nothing is selected.
check if all selections are empty
Returns true if nothing is selected.
| xc | X position of the center of the arc |
|---|---|
| yc | Y position of the center of the arc |
| radius | the radius of the arc |
| angle1 | the start angle, in radians |
| angle2 | the end angle, in radians |
Adds a circular arc of the given radius to the current path. The arc is centered at (xc, yc), begins at angle1 and proceeds in the direction of decreasing angles to end at angle2. If angle2 is greater than angle1 it will be progressively decreased by 2*M_PI until it is greater than angle1.
See arc() for more details. This function differs only in the direction of the arc between the two angles.
| xc | X position of the center of the arc |
|---|---|
| yc | Y position of the center of the arc |
| radius | the radius of the arc |
| angle1 | the start angle, in radians |
| angle2 | the end angle, in radians |
Adds a circular arc of the given radius to the current path. The arc is centered at (xc, yc), begins at angle1 and proceeds in the direction of decreasing angles to end at angle2. If angle2 is greater than angle1 it will be progressively decreased by 2*M_PI until it is greater than angle1.
See arc() for more details. This function differs only in the direction of the arc between the two angles.
Clears the current path. After this call there will be no current point.
Adds a line segment to the path from the current point to the beginning of the current subpath, (the most recent point passed to move_to()), and closes this subpath. After this call the current point will be at the joined endpoint of the sub-path.
The behavior of close_path() is distinct from simply calling line_to() with the equivalent coordinate in the case of stroking. When a closed subpath is stroked, there are no caps on the ends of the subpath. Instead, there is a line join connecting the final and initial segments of the subpath.
If there is no current point before the call to close_path(), this function will have no effect.
Adds a cubic Bezier spline to the path from the current point to position (x3, y3) in user-space coordinates, using (x1, y1) and (x2, y2) as the control points. After this call the current point will be (x3, y3).
If there is no current point before the call to curve_to() this function will behave as if preceded by a call to move_to(x1, y1).
| x1 | the X coordinate of the first control point |
|---|---|
| y1 | the Y coordinate of the first control point |
| x2 | the X coordinate of the second control point |
| y2 | the Y coordinate of the second control point |
| x3 | the X coordinate of the end of the curve |
| y3 | the Y coordinate of the end of the curve |
Adds a cubic Bezier spline to the path from the current point to position (x3, y3) in user-space coordinates, using (x1, y1) and (x2, y2) as the control points. After this call the current point will be (x3, y3).
If there is no current point before the call to curve_to() this function will behave as if preceded by a call to move_to(x1, y1).
A drawing operator that fills the current path according to the current fill rule, (each sub-path is implicitly closed before being filled). After fill(), the current path will be cleared from the cairo context.
set_fill_rule()
fill_preserve()
A drawing operator that fills the current path according to the current fill rule, (each sub-path is implicitly closed before being filled). Unlike fill(), fill_preserve() preserves the path within the cairo Context.
set_fill_rule()
fill().
Adds a line to the path from the current point to position (x, y) in user-space coordinates. After this call the current point will be (x, y).
If there is no current point before the call to line_to() this function will behave as move_to(x, y).
| x | the X coordinate of the end of the new line |
|---|---|
| y | the Y coordinate of the end of the new line |
Adds a line to the path from the current point to position (x, y) in user-space coordinates. After this call the current point will be (x, y).
If there is no current point before the call to line_to() this function will behave as move_to(x, y).
If the current subpath is not empty, begin a new subpath. After this call the current point will be (x, y).
| x | the X coordinate of the new position |
|---|---|
| y | the Y coordinate of the new position |
If the current subpath is not empty, begin a new subpath. After this call the current point will be (x, y).
A drawing operator that paints the current source everywhere within the current clip region.
A drawing operator that paints the current source everywhere within the current clip region using a mask of constant alpha value alpha. The effect is similar to paint(), but the drawing is faded out using the alpha value.
| alpha | an alpha value, between 0 (transparent) and 1 (opaque) |
|---|
A drawing operator that paints the current source everywhere within the current clip region using a mask of constant alpha value alpha. The effect is similar to paint(), but the drawing is faded out using the alpha value.
Adds a closed-subpath rectangle of the given size to the current path at position (x, y) in user-space coordinates.
This function is logically equivalent to:
context->move_to(x, y); context->rel_line_to(width, 0); context->rel_line_to(0, height); context->rel_line_to(-width, 0); - context->close_path();
| x | the X coordinate of the top left corner of the rectangle |
|---|---|
| y | the Y coordinate to the top left corner of the rectangle |
| width | the width of the rectangle |
| height | the height of the rectangle |
Relative-coordinate version of curve_to(). All offsets are relative to the current point. Adds a cubic Bezier spline to the path from the current point to a point offset from the current point by (dx3, dy3), using points offset by (dx1, dy1) and (dx2, dy2) as the control points. After this call the current point will be offset by (dx3, dy3).
Given a current point of (x, y),
rel_curve_to(dx1, dy1, dx2, dy2, dx3, dy3)
is logically equivalent to
curve_to(x + dx1, y + dy1, x + dx2, y + dy2, x + dx3, y + dy3).
It is an error to call this function with no current point. Doing so will cause this to shutdown with a status of CAIRO_STATUS_NO_CURRENT_POINT. Cairomm will then throw an exception.
| dx1 | the X offset to the first control point |
|---|---|
| dy1 | the Y offset to the first control point |
| dx2 | the X offset to the second control point |
| dy2 | the Y offset to the second control point |
| dx3 | the X offset to the end of the curve |
| dy3 | the Y offset to the end of the curve |
Relative-coordinate version of curve_to(). All offsets are relative to the current point. Adds a cubic Bezier spline to the path from the current point to a point offset from the current point by (dx3, dy3), using points offset by (dx1, dy1) and (dx2, dy2) as the control points. After this call the current point will be offset by (dx3, dy3).
Given a current point of (x, y),
rel_curve_to(dx1, dy1, dx2, dy2, dx3, dy3)
is logically equivalent to
curve_to(x + dx1, y + dy1, x + dx2, y + dy2, x + dx3, y + dy3).
It is an error to call this function with no current point. Doing so will cause this to shutdown with a status of CAIRO_STATUS_NO_CURRENT_POINT. Cairomm will then throw an exception.
Relative-coordinate version of line_to(). Adds a line to the path from the current point to a point that is offset from the current point by (dx, dy) in user space. After this call the current point will be offset by (dx, dy).
Given a current point of (x, y),
rel_line_to(dx, dy)
is logically equivalent to
line_to(x + dx, y + dy).
It is an error to call this function with no current point. Doing so will cause this to shutdown with a status of CAIRO_STATUS_NO_CURRENT_POINT. Cairomm will then throw an exception.
| dx | the X offset to the end of the new line |
|---|---|
| dy | the Y offset to the end of the new line |
Relative-coordinate version of line_to(). Adds a line to the path from the current point to a point that is offset from the current point by (dx, dy) in user space. After this call the current point will be offset by (dx, dy).
Given a current point of (x, y),
rel_line_to(dx, dy)
is logically equivalent to
line_to(x + dx, y + dy).
It is an error to call this function with no current point. Doing so will cause this to shutdown with a status of CAIRO_STATUS_NO_CURRENT_POINT. Cairomm will then throw an exception.
If the current subpath is not empty, begin a new subpath. After this call the current point will offset by (x, y).
Given a current point of (x, y),
rel_move_to(dx, dy)
is logically equivalent to
move_to(x + dx, y + dy)
It is an error to call this function with no current point. Doing so will cause this to shutdown with a status of CAIRO_STATUS_NO_CURRENT_POINT. Cairomm will then throw an exception.
| dx | the X offset |
|---|---|
| dy | the Y offset |
If the current subpath is not empty, begin a new subpath. After this call the current point will offset by (x, y).
Given a current point of (x, y),
rel_move_to(dx, dy)
is logically equivalent to
move_to(x + dx, y + dy)
It is an error to call this function with no current point. Doing so will cause this to shutdown with a status of CAIRO_STATUS_NO_CURRENT_POINT. Cairomm will then throw an exception.
Reset the current clip region to its original, unrestricted state. That is, set the clip region to an infinitely large shape containing the target surface. Equivalently, if infinity is too hard to grasp, one can imagine the clip region being reset to the exact bounds of the target surface.
Note that code meant to be reusable should not call reset_clip() as it will cause results unexpected by higher-level code which calls clip(). Consider using save() and restore() around clip() as a more robust means of temporarily restricting the clip region.
Restores cr to the state saved by a preceding call to save() and removes that state from the stack of saved states.
save()
Modifies the current transformation matrix (CTM) by rotating the user-space axes by angle radians. The rotation of the axes takes places after any existing transformation of user space. The rotation direction for positive angles is from the positive X axis toward the positive Y axis.
| angle | angle (in radians) by which the user-space axes will be rotated |
|---|
Modifies the current transformation matrix (CTM) by rotating the user-space axes by angle radians. The rotation of the axes takes places after any existing transformation of user space. The rotation direction for positive angles is from the positive X axis toward the positive Y axis.
Makes a copy of the current state of the Context and saves it on an internal stack of saved states. When restore() is called, it will be restored to the saved state. Multiple calls to save() and restore() can be nested; each call to restore() restores the state from the matching paired save().
It isn't necessary to clear all saved states before a cairo_t is freed. Any saved states will be freed when the Context is destroyed.
restore()
Modifies the current transformation matrix (CTM) by scaling the X and Y user-space axes by sx and sy respectively. The scaling of the axes takes place after any existing transformation of user space.
| sx | scale factor for the X dimension |
|---|---|
| sy | scale factor for the Y dimension |
Modifies the current transformation matrix (CTM) by scaling the X and Y user-space axes by sx and sy respectively. The scaling of the axes takes place after any existing transformation of user space.
Sets the dash pattern to be used by stroke(). A dash pattern is specified by dashes, an array of positive values. Each value provides the user-space length of altenate "on" and "off" portions of the stroke. The offset specifies an offset into the pattern at which the stroke begins.
Each "on" segment will have caps applied as if the segment were a separate sub-path. In particular, it is valid to use an "on" length of 0.0 with Cairo::LINE_CAP_ROUND or Cairo::LINE_CAP_SQUARE in order to distributed dots or squares along a path.
Note: The length values are in user-space units as evaluated at the time of stroking. This is not necessarily the same as the user space at the time of set_dash().
If dashes is empty dashing is disabled. If the size of dashes is 1, a symmetric pattern is assumed with alternating on and off portions of the size specified by the single value in dashes.
It is invalid for any value in dashes to be negative, or for all values to be 0. If this is the case, an exception will be thrown
| dashes | an array specifying alternate lengths of on and off portions |
|---|---|
| offset | an offset into the dash pattern at which the stroke should start |
Sets the dash pattern to be used by stroke(). A dash pattern is specified by dashes, an array of positive values. Each value provides the user-space length of altenate "on" and "off" portions of the stroke. The offset specifies an offset into the pattern at which the stroke begins.
Each "on" segment will have caps applied as if the segment were a separate sub-path. In particular, it is valid to use an "on" length of 0.0 with Cairo::LINE_CAP_ROUND or Cairo::LINE_CAP_SQUARE in order to distributed dots or squares along a path.
Note: The length values are in user-space units as evaluated at the time of stroking. This is not necessarily the same as the user space at the time of set_dash().
If dashes is empty dashing is disabled. If the size of dashes is 1, a symmetric pattern is assumed with alternating on and off portions of the size specified by the single value in dashes.
It is invalid for any value in dashes to be negative, or for all values to be 0. If this is the case, an exception will be thrown
Sets the current font matrix to a scale by a factor of size, replacing any font matrix previously set with set_font_size() or set_font_matrix(). This results in a font size of size user space units. (More precisely, this matrix will result in the font's em-square being a by size square in user space.)
If text is drawn without a call to set_font_size(), (nor set_font_matrix() nor set_scaled_font()), the default font size is 10.0.
| size | the new font size, in user space units) |
|---|
Sets the current font matrix to a scale by a factor of size, replacing any font matrix previously set with set_font_size() or set_font_matrix(). This results in a font size of size user space units. (More precisely, this matrix will result in the font's em-square being a by size square in user space.)
If text is drawn without a call to set_font_size(), (nor set_font_matrix() nor set_scaled_font()), the default font size is 10.0.
Sets the current line cap style within the cairo Context. See LineCap for details about how the available line cap styles are drawn.
As with the other stroke parameters, the current line cap style is examined by stroke(), stroke_extents(), and stroke_to_path(), but does not have any effect during path construction.
The default line cap style is Cairo::LINE_CAP_BUTT.
| line_cap | a line cap style, as a LineCap |
|---|
Sets the current line cap style within the cairo Context. See LineCap for details about how the available line cap styles are drawn.
As with the other stroke parameters, the current line cap style is examined by stroke(), stroke_extents(), and stroke_to_path(), but does not have any effect during path construction.
The default line cap style is Cairo::LINE_CAP_BUTT.
Sets the current line join style within the cairo Context. See LineJoin for details about how the available line join styles are drawn.
As with the other stroke parameters, the current line join style is examined by stroke(), stroke_extents(), and stroke_to_path(), but does not have any effect during path construction.
The default line join style is Cairo::LINE_JOIN_MITER.
| line_join | a line joint style, as a LineJoin |
|---|
Sets the current line join style within the cairo Context. See LineJoin for details about how the available line join styles are drawn.
As with the other stroke parameters, the current line join style is examined by stroke(), stroke_extents(), and stroke_to_path(), but does not have any effect during path construction.
The default line join style is Cairo::LINE_JOIN_MITER.
Sets the current line width within the cairo Context. The line width specifies the diameter of a pen that is circular in user-space, (though device-space pen may be an ellipse in general due to scaling/shear/rotation of the CTM).
Note: When the description above refers to user space and CTM it refers to the user space and CTM in effect at the time of the stroking operation, not the user space and CTM in effect at the time of the call to set_line_width(). The simplest usage makes both of these spaces identical. That is, if there is no change to the CTM between a call to set_line_width() and the stroking operation, then one can just pass user-space values to set_line_width() and ignore this note.
As with the other stroke parameters, the current line cap style is examined by stroke(), stroke_extents(), and stroke_to_path(), but does not have any effect during path construction.
The default line width value is 2.0.
| width | a line width, as a user-space value |
|---|
Sets the current line width within the cairo Context. The line width specifies the diameter of a pen that is circular in user-space, (though device-space pen may be an ellipse in general due to scaling/shear/rotation of the CTM).
Note: When the description above refers to user space and CTM it refers to the user space and CTM in effect at the time of the stroking operation, not the user space and CTM in effect at the time of the call to set_line_width(). The simplest usage makes both of these spaces identical. That is, if there is no change to the CTM between a call to set_line_width() and the stroking operation, then one can just pass user-space values to set_line_width() and ignore this note.
As with the other stroke parameters, the current line cap style is examined by stroke(), stroke_extents(), and stroke_to_path(), but does not have any effect during path construction.
The default line width value is 2.0.
Sets the compositing operator to be used for all drawing operations. See Operator for details on the semantics of each available compositing operator.
| op | a compositing operator, specified as a Operator |
|---|
Sets the compositing operator to be used for all drawing operations. See Operator for details on the semantics of each available compositing operator.
Sets the source pattern within the Context to an opaque color. This opaque color will then be used for any subsequent drawing operation until a new source pattern is set.
The color components are floating point numbers in the range 0 to 1. If the values passed in are outside that range, they will be clamped.
set_source_rgba()
set_source()
| red | red component of color |
|---|---|
| green | green component of color |
| blue | blue component of color |
Sets the source pattern within the Context to an opaque color. This opaque color will then be used for any subsequent drawing operation until a new source pattern is set.
The color components are floating point numbers in the range 0 to 1. If the values passed in are outside that range, they will be clamped.
set_source_rgba()
set_source()
Sets the source pattern within the Context to a translucent color. This color will then be used for any subsequent drawing operation until a new source pattern is set.
The color and alpha components are floating point numbers in the range 0 to 1. If the values passed in are outside that range, they will be clamped.
set_source_rgb()
set_source()
| red | red component of color |
|---|---|
| green | green component of color |
| blue | blue component of color |
| alpha | alpha component of color |
Sets the source pattern within the Context to a translucent color. This color will then be used for any subsequent drawing operation until a new source pattern is set.
The color and alpha components are floating point numbers in the range 0 to 1. If the values passed in are outside that range, they will be clamped.
set_source_rgb()
set_source()
A drawing operator that generates the shape from a string of UTF-8 characters, rendered according to the current font_face, font_size (font_matrix), and font_options.
This function first computes a set of glyphs for the string of text. The first glyph is placed so that its origin is at the current point. The origin of each subsequent glyph is offset from that of the previous glyph by the advance values of the previous glyph.
After this call the current point is moved to the origin of where the next glyph would be placed in this same progression. That is, the current point will be at the origin of the final glyph offset by its advance values. This allows for easy display of a single logical string with multiple calls to show_text().
Note: The show_text() function call is part of what the cairo designers call the "toy" text API. It is convenient for short demos and simple programs, but it is not expected to be adequate for serious text-using applications. See show_glyphs() for the "real" text display API in cairo.
| utf8 | a string containing text encoded in UTF-8 |
|---|
A drawing operator that generates the shape from a string of UTF-8 characters, rendered according to the current font_face, font_size (font_matrix), and font_options.
This function first computes a set of glyphs for the string of text. The first glyph is placed so that its origin is at the current point. The origin of each subsequent glyph is offset from that of the previous glyph by the advance values of the previous glyph.
After this call the current point is moved to the origin of where the next glyph would be placed in this same progression. That is, the current point will be at the origin of the final glyph offset by its advance values. This allows for easy display of a single logical string with multiple calls to show_text().
Note: The show_text() function call is part of what the cairo designers call the "toy" text API. It is convenient for short demos and simple programs, but it is not expected to be adequate for serious text-using applications. See show_glyphs() for the "real" text display API in cairo.
A drawing operator that strokes the current Path according to the current line width, line join, line cap, and dash settings. After stroke(), the current Path will be cleared from the cairo Context.
set_line_width()
set_line_join()
set_line_cap()
set_dash()
stroke_preserve().
Note: Degenerate segments and sub-paths are treated specially and provide a useful result. These can result in two different situations:
1. Zero-length "on" segments set in set_dash(). If the cap style is Cairo::LINE_CAP_ROUND or Cairo::LINE_CAP_SQUARE then these segments will be drawn as circular dots or squares respectively. In the case of Cairo::LINE_CAP_SQUARE, the orientation of the squares is determined by the direction of the underlying path.
2. A sub-path created by move_to() followed by either a close_path() or one or more calls to line_to() to the same coordinate as the move_to(). If the cap style is Cairo::LINE_CAP_ROUND then these sub-paths will be drawn as circular dots. Note that in the case of Cairo::LINE_CAP_SQUARE a degenerate sub-path will not be drawn at all, (since the correct orientation is indeterminate).
In no case will a cap style of Cairo::LINE_CAP_BUTT cause anything to be drawn in the case of either degenerate segments or sub-paths.
A drawing operator that strokes the current Path according to the current line width, line join, line cap, and dash settings. Unlike stroke(), stroke_preserve() preserves the Path within the cairo Context.
set_line_width()
set_line_join()
set_line_cap()
set_dash()
stroke_preserve().
Modifies the current transformation matrix (CTM) by translating the user-space origin by (tx, ty). This offset is interpreted as a user-space coordinate according to the CTM in place before the new call to translate. In other words, the translation of the user-space origin takes place after any existing transformation.
| tx | amount to translate in the X direction |
|---|---|
| ty | amount to translate in the Y direction |
Modifies the current transformation matrix (CTM) by translating the user-space origin by (tx, ty). This offset is interpreted as a user-space coordinate according to the CTM in place before the new call to translate. In other words, the translation of the user-space origin takes place after any existing transformation.
This function disables a dash pattern that was set with set_dash()
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.
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. |
|---|
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.
Sets the layout text and attribute list from marked-up text (see markup format). Replaces the current text and attribute list.
| markup | Some marked-up text. |
|---|
Sets the layout text and attribute list from marked-up text (see markup format). Replaces the current text and attribute list.
Set the text of the layout.
| text | The text for the layout. |
|---|
Set the text of the layout.
Sets the width to which the lines of the Pango::Layout should wrap or ellipsized. The default value is -1: no width set.
| width | The desired width in Pango units, or -1 to indicate that no wrapping or ellipsization should be performed. |
|---|
Sets the width to which the lines of the Pango::Layout should wrap or ellipsized. The default value is -1: no width set.
Sets the wrap mode; the wrap mode only has effect if a width is set on the layout with set_width(). To turn off wrapping, set the width to -1.
| wrap | The wrap mode. |
|---|
Sets the wrap mode; the wrap mode only has effect if a width is set on the layout with set_width(). To turn off wrapping, set the width to -1.
C‡: boost::shared_ptr< Evoral::ControlList >, boost::weak_ptr< Evoral::ControlList >
@@ -4470,26 +4413,25 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C| Methods | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| void | add (double, double, bool, bool) | |||||||||
add automation events
| ||||||||||
add automation events
| ||||||||||
| void | clear (double, double) | |||||||||
remove all automation events between the given time range
| ||||||||||
remove all automation events between the given time range
| ||||||||||
| double | eval (double) | |||||||||
query value at given time (takes a read-lock, not safe while writing automation)
Returns parameter value | ||||||||||
query value at given time (takes a read-lock, not safe while writing automation)
Returns parameter value | ||||||||||
| bool | in_write_pass () | |||||||||
| InterpolationStyle | interpolation () | |||||||||
query interpolation style of the automation data Returns Interpolation Style | ||||||||||
| bool | isnil () | |||||||||
| LuaTable(double, ...) | rt_safe_eval (double, bool&) | |||||||||
realtime safe version of eval, may fail if read-lock cannot be taken
Returns parameter value | ||||||||||
| bool | sameinstance (ControlList) | |||||||||
realtime safe version of eval, may fail if read-lock cannot be taken
Returns parameter value | ||||||||||
| void | set_interpolation (InterpolationStyle) | |||||||||
set the interpolation style of the automation data
| ||||||||||
set the interpolation style of the automation data
| ||||||||||
| void | thin (double) | |||||||||
Thin the number of events in this list. The thinning factor corresponds to the area of a triangle computed between three points in the list (time-difference * value-difference). If the area is large, it indicates significant non-linearity between the points. Time is measured in samples, value is usually normalized to 0..1. During automation recording we thin the recorded points using this value. If a point is sufficiently co-linear with its neighbours (as defined by the area of the triangle formed by three of them), we will not include it in the list. The larger the value, the more points are excluded, so this effectively measures the amount of thinning to be done.
| ||||||||||
Thin the number of events in this list. The thinning factor corresponds to the area of a triangle computed between three points in the list (time-difference * value-difference). If the area is large, it indicates significant non-linearity between the points. Time is measured in samples, value is usually normalized to 0..1. During automation recording we thin the recorded points using this value. If a point is sufficiently co-linear with its neighbours (as defined by the area of the triangle formed by three of them), we will not include it in the list. The larger the value, the more points are excluded, so this effectively measures the amount of thinning to be done.
| ||||||||||
| void | truncate_end (double) | |||||||||
truncate the event list after the given time
| ||||||||||
truncate the event list after the given time
| ||||||||||
| void | truncate_start (double) | |||||||||
truncate the event list to the given time
| ||||||||||
truncate the event list to the given time
| ||||||||||
C‡: boost::shared_ptr< Evoral::ControlSet >, boost::weak_ptr< Evoral::ControlSet >
@@ -4497,7 +4439,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C| Methods | ||
|---|---|---|
| bool | isnil () | |
| bool | sameinstance (ControlSet) | |
C‡: Evoral::Event<long>
@@ -4524,7 +4465,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C| Methods | ||
|---|---|---|
| bool | isnil () | |
| bool | sameinstance (Sequence) | |
C‡: std::bitset<47ul>
@@ -4642,7 +4581,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C| Methods | ||
|---|---|---|
| bool | isnil () | |
| bool | sameinstance (StatefulDestructible) | |
| ID | id () | |
| bool | isnil () | |
| OwnedPropertyList | properties () | |
| bool | sameinstance (Stateful) |
C‡: XMLNode
@@ -5739,6 +5675,6 @@ Pointer Classes cannot be created in lua scripts. It always requires a call to C