From d11a5e3ea960ed073327dadd06a25d4cae81746c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Eduard=20M=C3=BCller?= Date: Wed, 23 Sep 2026 16:35:44 +0200 Subject: [PATCH 01/12] remove auto-generated API files from git --- .gitignore | 3 + docs/API/builtins/any.md | 3 - docs/API/builtins/boolean.md | 3 - docs/API/builtins/function.md | 3 - docs/API/builtins/integer.md | 3 - docs/API/builtins/lightuserdata.md | 3 - docs/API/builtins/nil.md | 3 - docs/API/builtins/number.md | 3 - docs/API/builtins/self.md | 7 - docs/API/builtins/string.md | 3 - docs/API/builtins/table.md | 3 - docs/API/builtins/unknown.md | 3 - docs/API/builtins/userdata.md | 3 - docs/API/modules/debug.md | 14 - docs/API/modules/global.md | 102 - docs/API/modules/io.md | 70 - docs/API/modules/math.md | 47 - docs/API/modules/os.md | 66 - docs/API/modules/table.md | 78 - docs/API/renoise/renoise.Application.md | 399 - docs/API/renoise/renoise.ApplicationTheme.md | 264 - docs/API/renoise/renoise.ApplicationWindow.md | 224 - docs/API/renoise/renoise.AudioDevice.md | 82 - docs/API/renoise/renoise.DeviceParameter.md | 84 - docs/API/renoise/renoise.Dialog.md | 27 - .../renoise/renoise.Document.DocumentList.md | 126 - .../renoise/renoise.Document.DocumentNode.md | 113 - .../renoise/renoise.Document.Observable.md | 52 - .../renoise.Document.ObservableBang.md | 53 - .../renoise.Document.ObservableBoolean.md | 66 - .../renoise.Document.ObservableBooleanList.md | 84 - .../renoise.Document.ObservableList.md | 56 - .../renoise.Document.ObservableNumber.md | 66 - .../renoise.Document.ObservableNumberList.md | 83 - .../renoise.Document.ObservableString.md | 66 - .../renoise.Document.ObservableStringList.md | 83 - .../renoise/renoise.Document.Serializable.md | 17 - docs/API/renoise/renoise.Document.md | 169 - docs/API/renoise/renoise.EffectColumn.md | 39 - docs/API/renoise/renoise.GroupTrack.md | 243 - docs/API/renoise/renoise.Instrument.md | 296 - docs/API/renoise/renoise.InstrumentDevice.md | 57 - docs/API/renoise/renoise.InstrumentMacro.md | 46 - .../renoise/renoise.InstrumentMacroMapping.md | 46 - .../renoise.InstrumentMidiInputProperties.md | 40 - .../renoise.InstrumentMidiOutputProperties.md | 81 - docs/API/renoise/renoise.InstrumentPhrase.md | 262 - .../renoise.InstrumentPhraseMapping.md | 60 - .../renoise/renoise.InstrumentPhraseScript.md | 113 - .../renoise/renoise.InstrumentPluginDevice.md | 56 - .../renoise.InstrumentPluginProperties.md | 128 - .../renoise.InstrumentTriggerOptions.md | 105 - docs/API/renoise/renoise.Midi.MidiDevice.md | 28 - .../renoise/renoise.Midi.MidiInputDevice.md | 28 - .../renoise/renoise.Midi.MidiOutputDevice.md | 33 - docs/API/renoise/renoise.Midi.md | 90 - docs/API/renoise/renoise.NoteColumn.md | 81 - docs/API/renoise/renoise.Osc.Bundle.md | 19 - docs/API/renoise/renoise.Osc.Message.md | 92 - docs/API/renoise/renoise.Osc.md | 101 - docs/API/renoise/renoise.Pattern.md | 109 - docs/API/renoise/renoise.PatternIterator.md | 99 - docs/API/renoise/renoise.PatternLine.md | 51 - docs/API/renoise/renoise.PatternSequencer.md | 118 - docs/API/renoise/renoise.PatternTrack.md | 89 - .../renoise/renoise.PatternTrackAutomation.md | 121 - docs/API/renoise/renoise.SQLite.md | 491 - docs/API/renoise/renoise.Sample.md | 234 - .../renoise.SampleAhdrsModulationDevice.md | 111 - docs/API/renoise/renoise.SampleBuffer.md | 170 - docs/API/renoise/renoise.SampleDeviceChain.md | 90 - .../renoise.SampleEnvelopeModulationDevice.md | 222 - .../renoise.SampleFaderModulationDevice.md | 127 - ...noise.SampleKeyTrackingModulationDevice.md | 102 - .../renoise.SampleLfoModulationDevice.md | 122 - docs/API/renoise/renoise.SampleMapping.md | 58 - .../renoise/renoise.SampleModulationDevice.md | 118 - .../renoise/renoise.SampleModulationSet.md | 255 - .../renoise.SampleOperandModulationDevice.md | 99 - .../renoise.SampleStepperModulationDevice.md | 178 - ....SampleVelocityTrackingModulationDevice.md | 118 - .../renoise.ScriptingTool.MidiMessage.md | 32 - docs/API/renoise/renoise.ScriptingTool.md | 409 - docs/API/renoise/renoise.Socket.SocketBase.md | 33 - .../renoise/renoise.Socket.SocketClient.md | 114 - .../renoise/renoise.Socket.SocketServer.md | 128 - docs/API/renoise/renoise.Socket.md | 42 - docs/API/renoise/renoise.Song.md | 610 -- docs/API/renoise/renoise.SongPos.md | 16 - docs/API/renoise/renoise.Track.md | 255 - docs/API/renoise/renoise.Transport.md | 343 - docs/API/renoise/renoise.ViewBuilder.md | 8429 ----------------- docs/API/renoise/renoise.Views.Aligner.md | 204 - docs/API/renoise/renoise.Views.Bitmap.md | 450 - docs/API/renoise/renoise.Views.Button.md | 603 -- .../renoise/renoise.Views.Canvas.Context.md | 698 -- docs/API/renoise/renoise.Views.Canvas.md | 187 - docs/API/renoise/renoise.Views.CheckBox.md | 199 - docs/API/renoise/renoise.Views.Chooser.md | 204 - docs/API/renoise/renoise.Views.Control.md | 177 - docs/API/renoise/renoise.Views.MiniSlider.md | 241 - .../renoise/renoise.Views.MultiLineText.md | 227 - .../renoise.Views.MultiLineTextField.md | 261 - docs/API/renoise/renoise.Views.Popup.md | 206 - docs/API/renoise/renoise.Views.Rack.md | 204 - .../renoise/renoise.Views.RotaryEncoder.md | 246 - docs/API/renoise/renoise.Views.ScrollBar.md | 261 - docs/API/renoise/renoise.Views.Slider.md | 256 - docs/API/renoise/renoise.Views.Stack.md | 179 - docs/API/renoise/renoise.Views.Switch.md | 204 - docs/API/renoise/renoise.Views.Text.md | 427 - docs/API/renoise/renoise.Views.TextField.md | 213 - docs/API/renoise/renoise.Views.TextLink.md | 467 - docs/API/renoise/renoise.Views.Value.md | 198 - docs/API/renoise/renoise.Views.ValueBox.md | 228 - docs/API/renoise/renoise.Views.ValueField.md | 231 - docs/API/renoise/renoise.Views.View.md | 147 - docs/API/renoise/renoise.Views.XYPad.md | 251 - docs/API/renoise/renoise.Views.md | 6 - 119 files changed, 3 insertions(+), 25243 deletions(-) delete mode 100644 docs/API/builtins/any.md delete mode 100644 docs/API/builtins/boolean.md delete mode 100644 docs/API/builtins/function.md delete mode 100644 docs/API/builtins/integer.md delete mode 100644 docs/API/builtins/lightuserdata.md delete mode 100644 docs/API/builtins/nil.md delete mode 100644 docs/API/builtins/number.md delete mode 100644 docs/API/builtins/self.md delete mode 100644 docs/API/builtins/string.md delete mode 100644 docs/API/builtins/table.md delete mode 100644 docs/API/builtins/unknown.md delete mode 100644 docs/API/builtins/userdata.md delete mode 100644 docs/API/modules/debug.md delete mode 100644 docs/API/modules/global.md delete mode 100644 docs/API/modules/io.md delete mode 100644 docs/API/modules/math.md delete mode 100644 docs/API/modules/os.md delete mode 100644 docs/API/modules/table.md delete mode 100644 docs/API/renoise/renoise.Application.md delete mode 100644 docs/API/renoise/renoise.ApplicationTheme.md delete mode 100644 docs/API/renoise/renoise.ApplicationWindow.md delete mode 100644 docs/API/renoise/renoise.AudioDevice.md delete mode 100644 docs/API/renoise/renoise.DeviceParameter.md delete mode 100644 docs/API/renoise/renoise.Dialog.md delete mode 100644 docs/API/renoise/renoise.Document.DocumentList.md delete mode 100644 docs/API/renoise/renoise.Document.DocumentNode.md delete mode 100644 docs/API/renoise/renoise.Document.Observable.md delete mode 100644 docs/API/renoise/renoise.Document.ObservableBang.md delete mode 100644 docs/API/renoise/renoise.Document.ObservableBoolean.md delete mode 100644 docs/API/renoise/renoise.Document.ObservableBooleanList.md delete mode 100644 docs/API/renoise/renoise.Document.ObservableList.md delete mode 100644 docs/API/renoise/renoise.Document.ObservableNumber.md delete mode 100644 docs/API/renoise/renoise.Document.ObservableNumberList.md delete mode 100644 docs/API/renoise/renoise.Document.ObservableString.md delete mode 100644 docs/API/renoise/renoise.Document.ObservableStringList.md delete mode 100644 docs/API/renoise/renoise.Document.Serializable.md delete mode 100644 docs/API/renoise/renoise.Document.md delete mode 100644 docs/API/renoise/renoise.EffectColumn.md delete mode 100644 docs/API/renoise/renoise.GroupTrack.md delete mode 100644 docs/API/renoise/renoise.Instrument.md delete mode 100644 docs/API/renoise/renoise.InstrumentDevice.md delete mode 100644 docs/API/renoise/renoise.InstrumentMacro.md delete mode 100644 docs/API/renoise/renoise.InstrumentMacroMapping.md delete mode 100644 docs/API/renoise/renoise.InstrumentMidiInputProperties.md delete mode 100644 docs/API/renoise/renoise.InstrumentMidiOutputProperties.md delete mode 100644 docs/API/renoise/renoise.InstrumentPhrase.md delete mode 100644 docs/API/renoise/renoise.InstrumentPhraseMapping.md delete mode 100644 docs/API/renoise/renoise.InstrumentPhraseScript.md delete mode 100644 docs/API/renoise/renoise.InstrumentPluginDevice.md delete mode 100644 docs/API/renoise/renoise.InstrumentPluginProperties.md delete mode 100644 docs/API/renoise/renoise.InstrumentTriggerOptions.md delete mode 100644 docs/API/renoise/renoise.Midi.MidiDevice.md delete mode 100644 docs/API/renoise/renoise.Midi.MidiInputDevice.md delete mode 100644 docs/API/renoise/renoise.Midi.MidiOutputDevice.md delete mode 100644 docs/API/renoise/renoise.Midi.md delete mode 100644 docs/API/renoise/renoise.NoteColumn.md delete mode 100644 docs/API/renoise/renoise.Osc.Bundle.md delete mode 100644 docs/API/renoise/renoise.Osc.Message.md delete mode 100644 docs/API/renoise/renoise.Osc.md delete mode 100644 docs/API/renoise/renoise.Pattern.md delete mode 100644 docs/API/renoise/renoise.PatternIterator.md delete mode 100644 docs/API/renoise/renoise.PatternLine.md delete mode 100644 docs/API/renoise/renoise.PatternSequencer.md delete mode 100644 docs/API/renoise/renoise.PatternTrack.md delete mode 100644 docs/API/renoise/renoise.PatternTrackAutomation.md delete mode 100644 docs/API/renoise/renoise.SQLite.md delete mode 100644 docs/API/renoise/renoise.Sample.md delete mode 100644 docs/API/renoise/renoise.SampleAhdrsModulationDevice.md delete mode 100644 docs/API/renoise/renoise.SampleBuffer.md delete mode 100644 docs/API/renoise/renoise.SampleDeviceChain.md delete mode 100644 docs/API/renoise/renoise.SampleEnvelopeModulationDevice.md delete mode 100644 docs/API/renoise/renoise.SampleFaderModulationDevice.md delete mode 100644 docs/API/renoise/renoise.SampleKeyTrackingModulationDevice.md delete mode 100644 docs/API/renoise/renoise.SampleLfoModulationDevice.md delete mode 100644 docs/API/renoise/renoise.SampleMapping.md delete mode 100644 docs/API/renoise/renoise.SampleModulationDevice.md delete mode 100644 docs/API/renoise/renoise.SampleModulationSet.md delete mode 100644 docs/API/renoise/renoise.SampleOperandModulationDevice.md delete mode 100644 docs/API/renoise/renoise.SampleStepperModulationDevice.md delete mode 100644 docs/API/renoise/renoise.SampleVelocityTrackingModulationDevice.md delete mode 100644 docs/API/renoise/renoise.ScriptingTool.MidiMessage.md delete mode 100644 docs/API/renoise/renoise.ScriptingTool.md delete mode 100644 docs/API/renoise/renoise.Socket.SocketBase.md delete mode 100644 docs/API/renoise/renoise.Socket.SocketClient.md delete mode 100644 docs/API/renoise/renoise.Socket.SocketServer.md delete mode 100644 docs/API/renoise/renoise.Socket.md delete mode 100644 docs/API/renoise/renoise.Song.md delete mode 100644 docs/API/renoise/renoise.SongPos.md delete mode 100644 docs/API/renoise/renoise.Track.md delete mode 100644 docs/API/renoise/renoise.Transport.md delete mode 100644 docs/API/renoise/renoise.ViewBuilder.md delete mode 100644 docs/API/renoise/renoise.Views.Aligner.md delete mode 100644 docs/API/renoise/renoise.Views.Bitmap.md delete mode 100644 docs/API/renoise/renoise.Views.Button.md delete mode 100644 docs/API/renoise/renoise.Views.Canvas.Context.md delete mode 100644 docs/API/renoise/renoise.Views.Canvas.md delete mode 100644 docs/API/renoise/renoise.Views.CheckBox.md delete mode 100644 docs/API/renoise/renoise.Views.Chooser.md delete mode 100644 docs/API/renoise/renoise.Views.Control.md delete mode 100644 docs/API/renoise/renoise.Views.MiniSlider.md delete mode 100644 docs/API/renoise/renoise.Views.MultiLineText.md delete mode 100644 docs/API/renoise/renoise.Views.MultiLineTextField.md delete mode 100644 docs/API/renoise/renoise.Views.Popup.md delete mode 100644 docs/API/renoise/renoise.Views.Rack.md delete mode 100644 docs/API/renoise/renoise.Views.RotaryEncoder.md delete mode 100644 docs/API/renoise/renoise.Views.ScrollBar.md delete mode 100644 docs/API/renoise/renoise.Views.Slider.md delete mode 100644 docs/API/renoise/renoise.Views.Stack.md delete mode 100644 docs/API/renoise/renoise.Views.Switch.md delete mode 100644 docs/API/renoise/renoise.Views.Text.md delete mode 100644 docs/API/renoise/renoise.Views.TextField.md delete mode 100644 docs/API/renoise/renoise.Views.TextLink.md delete mode 100644 docs/API/renoise/renoise.Views.Value.md delete mode 100644 docs/API/renoise/renoise.Views.ValueBox.md delete mode 100644 docs/API/renoise/renoise.Views.ValueField.md delete mode 100644 docs/API/renoise/renoise.Views.View.md delete mode 100644 docs/API/renoise/renoise.Views.XYPad.md delete mode 100644 docs/API/renoise/renoise.Views.md diff --git a/.gitignore b/.gitignore index 195e70a..5d410e4 100644 --- a/.gitignore +++ b/.gitignore @@ -1,6 +1,9 @@ Cargo.lock /book/ /dist/ +/docs/API/builtins +/docs/API/renoise +/docs/API/modules /generate/Cargo.lock /generate/target/ /generate/lua-language-server/ diff --git a/docs/API/builtins/any.md b/docs/API/builtins/any.md deleted file mode 100644 index f6a94ca..0000000 --- a/docs/API/builtins/any.md +++ /dev/null @@ -1,3 +0,0 @@ -# any -> A type for a dynamic argument, it can be anything at run-time. - diff --git a/docs/API/builtins/boolean.md b/docs/API/builtins/boolean.md deleted file mode 100644 index e605939..0000000 --- a/docs/API/builtins/boolean.md +++ /dev/null @@ -1,3 +0,0 @@ -# boolean -> A built-in type representing a boolean (true or false) value, [see details](https://www.lua.org/pil/2.2.html) - diff --git a/docs/API/builtins/function.md b/docs/API/builtins/function.md deleted file mode 100644 index a4477e7..0000000 --- a/docs/API/builtins/function.md +++ /dev/null @@ -1,3 +0,0 @@ -# function -> A built-in type representing functions, [see details](https://www.lua.org/pil/2.6.html) - diff --git a/docs/API/builtins/integer.md b/docs/API/builtins/integer.md deleted file mode 100644 index eaaf75f..0000000 --- a/docs/API/builtins/integer.md +++ /dev/null @@ -1,3 +0,0 @@ -# integer -> A helper type that represents whole numbers, a subset of [number](number.md) - diff --git a/docs/API/builtins/lightuserdata.md b/docs/API/builtins/lightuserdata.md deleted file mode 100644 index fdad973..0000000 --- a/docs/API/builtins/lightuserdata.md +++ /dev/null @@ -1,3 +0,0 @@ -# lightuserdata -> A built-in type representing a pointer, [see details](https://www.lua.org/pil/28.5.html) - diff --git a/docs/API/builtins/nil.md b/docs/API/builtins/nil.md deleted file mode 100644 index b049ac3..0000000 --- a/docs/API/builtins/nil.md +++ /dev/null @@ -1,3 +0,0 @@ -# nil -> A built-in type representing a non-existant value, [see details](https://www.lua.org/pil/2.1.html). When you see `?` at the end of types, it means they can be nil. - diff --git a/docs/API/builtins/number.md b/docs/API/builtins/number.md deleted file mode 100644 index b8e5372..0000000 --- a/docs/API/builtins/number.md +++ /dev/null @@ -1,3 +0,0 @@ -# number -> A built-in type representing floating point numbers, [see details](https://www.lua.org/pil/2.3.html) - diff --git a/docs/API/builtins/self.md b/docs/API/builtins/self.md deleted file mode 100644 index b92eae3..0000000 --- a/docs/API/builtins/self.md +++ /dev/null @@ -1,7 +0,0 @@ -# self -> A type that represents an instance that you call a function on. When you see a function signature starting with this type, you should use `:` to call the function on the instance, this way you can omit this first argument. -> ```lua -> local object = SomeClass() -> object:do_something(123) -> ``` - diff --git a/docs/API/builtins/string.md b/docs/API/builtins/string.md deleted file mode 100644 index 8a1e86c..0000000 --- a/docs/API/builtins/string.md +++ /dev/null @@ -1,3 +0,0 @@ -# string -> A built-in type representing a string of characters, [see details](https://www.lua.org/pil/2.4.html) - diff --git a/docs/API/builtins/table.md b/docs/API/builtins/table.md deleted file mode 100644 index 7c08819..0000000 --- a/docs/API/builtins/table.md +++ /dev/null @@ -1,3 +0,0 @@ -# table -> A built-in type representing associative arrays, [see details](https://www.lua.org/pil/2.5.html) - diff --git a/docs/API/builtins/unknown.md b/docs/API/builtins/unknown.md deleted file mode 100644 index 4942b1d..0000000 --- a/docs/API/builtins/unknown.md +++ /dev/null @@ -1,3 +0,0 @@ -# unknown -> A dummy type for something that cannot be inferred before run-time. - diff --git a/docs/API/builtins/userdata.md b/docs/API/builtins/userdata.md deleted file mode 100644 index 89920de..0000000 --- a/docs/API/builtins/userdata.md +++ /dev/null @@ -1,3 +0,0 @@ -# userdata -> A built-in type representing array values, [see details](https://www.lua.org/pil/28.1.html). - diff --git a/docs/API/modules/debug.md b/docs/API/modules/debug.md deleted file mode 100644 index 45d7f84..0000000 --- a/docs/API/modules/debug.md +++ /dev/null @@ -1,14 +0,0 @@ -# debug - - - - ---- -## Functions -### `start()` -> Shortcut to remdebug.session.start(), which starts a debug session: -> launches the debugger controller and breaks script execution. See -> "Debugging.md" in the documentation root folder for more info. -### `stop()` -> Shortcut to remdebug.session.stop: stops a running debug session - diff --git a/docs/API/modules/global.md b/docs/API/modules/global.md deleted file mode 100644 index f399dbe..0000000 --- a/docs/API/modules/global.md +++ /dev/null @@ -1,102 +0,0 @@ -# Global - - - - ---- -## Functions -### tostring(pattern_line : [`renoise.PatternLine`](../../API/renoise/renoise.PatternLine.md)) -`->`[`string`](../../API/builtins/string.md) - -> Receives a value of any type and converts it to a string in a human-readable format. -> -> If the metatable of `v` has a `__tostring` field, then `tostring` calls the corresponding value with `v` as argument, and uses the result of the call as its result. Otherwise, if the metatable of `v` has a `__name` field with a string value, `tostring` may use that string in its final result. -> -> For complete control of how numbers are converted, use [string.format](http://www.lua.org/manual/5.4/manual.html#pdf-string.format). -> -> -> [View documents](http://www.lua.org/manual/5.4/manual.html#pdf-tostring) -### ripairs(table : ) -`->`fun(table: [], i?: integer):integer, , , i : [`integer`](../../API/builtins/integer.md) - -> An iterator like ipairs, but in reverse order. -> #### examples: -> ```lua -> t = {"a", "b", "c"} -> for k,v in ripairs(t) do print(k, v) end -> "3 c, 2 b, 1 a" -> ``` -### objinfo(object : [`userdata`](../../API/builtins/userdata.md)) -`->`[`string`](../../API/builtins/string.md)[] - -> Return a string which lists properties and methods of class objects. -### oprint(object : [`userdata`](../../API/builtins/userdata.md)) -> Dumps properties and methods of class objects (like renoise.app()). -### rprint(value : [`any`](../../API/builtins/any.md)) -> Recursively dumps a table and all its members to the std out (console). -> This works for standard Lua types and class objects as well. -### class(name : [`string`](../../API/builtins/string.md)) -`->`[`function`](../../API/builtins/function.md) - -> Luabind "class" registration. Registers a global class object and returns a -> closure to optionally set the base class. -> -> See also [Luabind class](https://luabind.sourceforge.net/docs.html#class_lua) -> -> #### examples -> ```lua -> ---@class Animal -> -- Construct a new animal with the given name. -> ---@overload fun(string): Animal -> Animal = {} -> class 'Animal' -> ---@param name string -> function Animal:__init(name) -> self.name = name -> self.can_fly = nil -> end -> function Animal:show() -> return ("I am a %s (%s) and I %s fly"):format(self.name, type(self), -> (self.can_fly and "can fly" or "can not fly")) -> end -> -> -- Mammal class (inherits Animal functions and members) -> ---@class Mammal : Animal -> -- Construct a new mamal with the given name. -> ---@overload fun(string): Mammal -> Mammal = {} -> class 'Mammal' (Animal) -> ---@param name string -> function Mammal:__init(name) -> Animal.__init(self, name) -> self.can_fly = false -> end -> -> -- show() function and base member are available for Mammal too -> local mamal = Mammal("Cow") -> mamal:show() -> ``` -### type(value : [`any`](../../API/builtins/any.md)) -`->`[`string`](../../API/builtins/string.md) - -> Returns the type of its only argument, coded as a string. The possible results of this function are `"nil"` (a string, not the value `nil`), `"number"`, `"string"`, `"boolean"`, `"table"`, `"function"`, `"thread"`, and `"userdata"`. -> -> -> [View documents](http://www.lua.org/manual/5.4/manual.html#pdf-type) -> -> -> ```lua -> type: -> | "nil" -> | "number" -> | "string" -> | "boolean" -> | "table" -> | "function" -> | "thread" -> | "userdata" -> ``` -### rawequal(obj1 : [`any`](../../API/builtins/any.md), obj2 : [`any`](../../API/builtins/any.md)) -> Checks whether v1 is equal to v2, without invoking the `__eq` metamethod. -> -> [View documents](http://www.lua.org/manual/5.4/manual.html#pdf-rawequal) - diff --git a/docs/API/modules/io.md b/docs/API/modules/io.md deleted file mode 100644 index 071b649..0000000 --- a/docs/API/modules/io.md +++ /dev/null @@ -1,70 +0,0 @@ -# io - - - - ---- -## Functions -### exists(filename : [`string`](../../API/builtins/string.md)) -`->`[`boolean`](../../API/builtins/boolean.md) - -> Returns true when a file, folder or link at the given path and name exists -### stat(filename : [`string`](../../API/builtins/string.md)) -`->`result : [`Stat`](#stat)[`?`](../../API/builtins/nil.md), error : [`string`](../../API/builtins/string.md)[`?`](../../API/builtins/nil.md), error_code : [`integer`](../../API/builtins/integer.md)[`?`](../../API/builtins/nil.md) - -> Returns a table with status info about the file, folder or link at the given -> path and name, else nil the error and the error code is returned. -### chmod(filename : [`string`](../../API/builtins/string.md), mode : [`integer`](../../API/builtins/integer.md)) -`->`result : [`boolean`](../../API/builtins/boolean.md), error : [`string`](../../API/builtins/string.md)[`?`](../../API/builtins/nil.md), error_code : [`integer`](../../API/builtins/integer.md)[`?`](../../API/builtins/nil.md) - -> Change permissions of a file, folder or link. mode is a unix permission -> styled octal number (like 755 - WITHOUT a leading octal 0). Executable, -> group and others flags are ignored on windows and won't fire errors - - - ---- -## Structs -# Stat -> return value for io.stat - ---- -## Properties -### dev : [`integer`](../../API/builtins/integer.md) -> device number of filesystem - -### ino : [`integer`](../../API/builtins/integer.md) -> inode number - -### mode : [`integer`](../../API/builtins/integer.md) -> unix styled file permissions - -### type : `"file"` | `"directory"` | `"link"` | `"socket"` | `"named pipe"` | `"char device"` | `"block device"` -### nlink : [`integer`](../../API/builtins/integer.md) -> number of (hard) links to the file - -### uid : [`integer`](../../API/builtins/integer.md) -> numeric user ID of file's owner - -### gid : [`integer`](../../API/builtins/integer.md) -> numeric group ID of file's owner - -### rdev : [`integer`](../../API/builtins/integer.md) -> the device identifier (special files only) - -### size : [`integer`](../../API/builtins/integer.md) -> total size of file, in bytes - -### atime : [`integer`](../../API/builtins/integer.md) -> last access time in seconds since the epoch - -### mtime : [`integer`](../../API/builtins/integer.md) -> last modify time in seconds since the epoch - -### ctime : [`integer`](../../API/builtins/integer.md) -> inode change time (NOT creation time!) in seconds - - - - - diff --git a/docs/API/modules/math.md b/docs/API/modules/math.md deleted file mode 100644 index 41cf154..0000000 --- a/docs/API/modules/math.md +++ /dev/null @@ -1,47 +0,0 @@ -# math - - - - ---- -## Functions -### lin2db(n : [`number`](../../API/builtins/number.md)) -`->`[`number`](../../API/builtins/number.md) - -> Converts a linear value to a db value. db values will be clipped to -> math.infdb. -> #### examples: -> ```lua -> print(math.lin2db(1.0)) --> 0 -> print(math.lin2db(0.0)) --> -200 (math.infdb) -> ``` -### db2lin(n : [`number`](../../API/builtins/number.md)) -`->`[`number`](../../API/builtins/number.md) - -> Converts a dB value to a linear value. -> #### examples: -> ```lua -> print(math.db2lin(math.infdb)) --> 0 -> print(math.db2lin(6.0)) --> 1.9952623149689 -> ``` -### db2fader(min_dB : [`number`](../../API/builtins/number.md), max_dB : [`number`](../../API/builtins/number.md), dB_to_convert : [`number`](../../API/builtins/number.md)) -`->`[`number`](../../API/builtins/number.md) - -> Converts a dB value to a normalized linear fader value between 0-1 within -> the given dB range. -> #### examples: -> ```lua -> print(math.db2fader(-96, 0, 1)) --> 0 -> print(math.db2fader(-48, 6, 0)) --> 0.73879611492157 -> ``` -### fader2db(min_dB : [`number`](../../API/builtins/number.md), max_dB : [`number`](../../API/builtins/number.md), fader_value : [`number`](../../API/builtins/number.md)) -`->`[`number`](../../API/builtins/number.md) - -> Converts a normalized linear mixer fader value to a db value within -> the given dB range. -> #### examples: -> ```lua -> print(math.fader2db(-96, 0, 1)) --> 0 -> print(math.fader2db(-96, 0, 0)) --> -96 -> ``` - diff --git a/docs/API/modules/os.md b/docs/API/modules/os.md deleted file mode 100644 index ea70f37..0000000 --- a/docs/API/modules/os.md +++ /dev/null @@ -1,66 +0,0 @@ -# os - - - - ---- -## Functions -### `platform()` -`->``"LINUX"` | `"MACINTOSH"` | `"WINDOWS"` - -> Returns the platform the script is running on: -> -> ```lua -> return #1: -> | "WINDOWS" -> | "MACINTOSH" -> | "LINUX" -> ``` -### `currentdir()` -`->`path : [`string`](../../API/builtins/string.md) - -> Returns the current working dir. Will always be the scripts directory -> when executing a script from a file -### dirnames(path : [`any`](../../API/builtins/any.md)) -`->`paths : [`string`](../../API/builtins/string.md)[] - -> Returns a list of directory names (names, not full paths) for the given -> parent directory. Passed directory must be valid, or an error will be thrown. -### filenames(path : [`string`](../../API/builtins/string.md), file_extensions : [`string`](../../API/builtins/string.md)[][`?`](../../API/builtins/nil.md)) -`->`paths : [`string`](../../API/builtins/string.md)[] - -> Returns a list file names (names, not full paths) for the given -> parent directory. Second optional argument is a list of file extensions that -> should be searched for, like {"*.wav", "*.txt"}. By default all files are -> matched. The passed directory must be valid, or an error will be thrown. -### mkdir(path : [`string`](../../API/builtins/string.md)) -`->`[`boolean`](../../API/builtins/boolean.md)[`?`](../../API/builtins/nil.md), [`string`](../../API/builtins/string.md)[`?`](../../API/builtins/nil.md) - -> Creates a new directory. mkdir can only create one new sub directory at the -> same time. If you need to create more than one sub dir, call mkdir multiple -> times. Returns true if the operation was successful; in case of error, it -> returns nil plus an error string. -### move(src : [`string`](../../API/builtins/string.md), dest : [`string`](../../API/builtins/string.md)) -`->`[`boolean`](../../API/builtins/boolean.md)[`?`](../../API/builtins/nil.md), [`string`](../../API/builtins/string.md)[`?`](../../API/builtins/nil.md) - -> Moves a file or a directory from path 'src' to 'dest'. Unlike 'os.rename' -> this also supports moving a file from one file system to another one. Returns -> true if the operation was successful; in case of error, it returns nil plus -> an error string. -### tmpname(extension : [`string`](../../API/builtins/string.md)[`?`](../../API/builtins/nil.md)) -`->`[`string`](../../API/builtins/string.md) - -> Returns a string with a file name that can be used for a temporary file. -> -> [View documents](http://www.lua.org/manual/5.4/manual.html#pdf-os.tmpname) -### `clock()` -`->`[`number`](../../API/builtins/number.md) - -> Returns an approximation of the amount in seconds of CPU time used by the program. -> -> [View documents](http://www.lua.org/manual/5.4/manual.html#pdf-os.clock) -### `exit()` -> Calls the ISO C function `exit` to terminate the host program. -> -> [View documents](http://www.lua.org/manual/5.4/manual.html#pdf-os.exit) - diff --git a/docs/API/modules/table.md b/docs/API/modules/table.md deleted file mode 100644 index 264e8e8..0000000 --- a/docs/API/modules/table.md +++ /dev/null @@ -1,78 +0,0 @@ -# table - - - - ---- -## Functions -### create(t : [`table`](../../API/builtins/table.md)[`?`](../../API/builtins/nil.md)) -`->`[`table`](../../API/builtins/table.md) | tablelib - -> Create a new, or convert an exiting table to an object that uses the global -> 'table.XXX' functions as methods, just like strings in Lua do. -> #### examples: -> ```lua -> t = table.create(); t:insert("a"); rprint(t) -> [1] = a; -> t = table.create{1,2,3}; print(t:concat("|")); -> "1|2|3"; -> ``` -### is_empty(t : [`table`](../../API/builtins/table.md)) -`->`[`boolean`](../../API/builtins/boolean.md) - -> Returns true when the table is empty, else false and will also work -> for non indexed tables -> #### examples: -> ```lua -> t = {}; print(table.is_empty(t)); -> true; -> t = {66}; print(table.is_empty(t)); -> false; -> t = {["a"] = 1}; print(table.is_empty(t)); -> false; -### count(t : [`table`](../../API/builtins/table.md)) -> Count the number of items of a table, also works for non index -> based tables (using pairs). -> #### examples: -> ```lua -> t = {["a"]=1, ["b"]=1}; print(table.count(t)) --> 2 -> ``` -### find(t : [`table`](../../API/builtins/table.md), value : [`any`](../../API/builtins/any.md), start_index : [`integer`](../../API/builtins/integer.md)[`?`](../../API/builtins/nil.md)) -`->`key_or_nil : [`string`](../../API/builtins/string.md) | [`number`](../../API/builtins/number.md)[`?`](../../API/builtins/nil.md) - -> Find first match of *value* in the given table, starting from element -> number *start_index*.
-> Returns the first *key* that matches the value or nil -> #### examples: -> ```lua -> t = {"a", "b"}; table.find(t, "a") --> 1 -> t = {a=1, b=2}; table.find(t, 2) --> "b" -> t = {"a", "b", "a"}; table.find(t, "a", 2) --> "3" -> t = {"a", "b"}; table.find(t, "c") --> nil -> ``` -### keys(t : [`table`](../../API/builtins/table.md)) -`->`[`table`](../../API/builtins/table.md) - -> Return an indexed table of all keys that are used in the table. -> #### examples: -> ```lua -> t = {a="aa", b="bb"}; rprint(table.keys(t)); --> "a", "b" -> t = {"a", "b"}; rprint(table.keys(t)); --> 1, 2 -> ``` -### values(t : [`table`](../../API/builtins/table.md)) -`->`[`table`](../../API/builtins/table.md) - -> Return an indexed table of all values that are used in the table -> #### examples: -> ```lua -> t = {a="aa", b="bb"}; rprint(table.values(t)); --> "aa", "bb" -> t = {"a", "b"}; rprint(table.values(t)); --> "a", "b" -> ``` -### copy(t : [`table`](../../API/builtins/table.md)) -`->`[`table`](../../API/builtins/table.md) - -> Copy the metatable and all first level elements of the given table into a -> new table. Use table.rcopy to do a recursive copy of all elements -### rcopy(t : [`table`](../../API/builtins/table.md)) -`->`[`table`](../../API/builtins/table.md) - -> Deeply copy the metatable and all elements of the given table recursively -> into a new table - create a clone with unique references. -### clear(t : [`table`](../../API/builtins/table.md)) -> Recursively clears and removes all table elements. - diff --git a/docs/API/renoise/renoise.Application.md b/docs/API/renoise/renoise.Application.md deleted file mode 100644 index d7db8cc..0000000 --- a/docs/API/renoise/renoise.Application.md +++ /dev/null @@ -1,399 +0,0 @@ -# renoise.Application -> The Renoise application. - - - - ---- -## Properties -### log_filename : [`string`](../../API/builtins/string.md) -> **READ-ONLY** Access to the application's full log filename and path. Will -> already be opened for writing, but you nevertheless should be able to read -> from it. - -### current_song : [`renoise.Song`](../../API/renoise/renoise.Song.md) -> **READ-ONLY** Get the apps main document, the song. -> The global "renoise.song()" function is, in fact, a shortcut to this property. - -### recently_loaded_song_files : [`string`](../../API/builtins/string.md)[] -> **READ-ONLY** List of recently loaded song files. - -### recently_saved_song_files : [`string`](../../API/builtins/string.md)[] -> **READ-ONLY** List of recently saved song files. - -### installed_tools : table<[`string`](../../API/builtins/string.md), [`string`](../../API/builtins/string.md)> -> **READ-ONLY** Returns information about all currently installed tools. - -### installed_tools_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Fired when the list of installed tools changed. - -### audio_plugin_effects_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Fired when the list of available audio plugin effects changed, for example -> when scanning for new plugins in the preferences. -> Use the component's `available_plugins` or `available_devices` properties -> to access currently available devices which are supported by the component -> such as the track device chains. - -### audio_plugin_instruments_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Fired when the list of available audio plugin instruments changed, for example -> when scanning for new plugins in the preferences. - -### key_modifier_states : table<[`string`](../../API/builtins/string.md), [`string`](../../API/builtins/string.md)> -> **Deprecated.** **READ-ONLY** Use `key_modifier_flags` instead - -### key_modifier_flags : [`ModifierFlags`](#ModifierFlags) -> **READ-ONLY** Access keyboard modifier states. - -### window : [`renoise.ApplicationWindow`](../../API/renoise/renoise.ApplicationWindow.md) -> **READ-ONLY** Access to the application's window. - -### theme : [`renoise.ApplicationTheme`](../../API/renoise/renoise.ApplicationTheme.md) -> **READ-ONLY** Access to the application's color theme. - -### theme_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Fired, when *any* theme color changed. e.g. when a new theme got loaded -> or when theme colors got edited in the theme preferences. - -### active_clipboard_index : `1` | `2` | `3` | `4` -> Range: (1 - 4) Get or set globally used clipboard "slots" in the application. - - - ---- -## Functions -### show_message([*self*](../../API/builtins/self.md), message : [`string`](../../API/builtins/string.md)) -> Shows an info message dialog to the user. -### show_error([*self*](../../API/builtins/self.md), message : [`string`](../../API/builtins/string.md)) -> Shows an error dialog to the user. -### show_warning([*self*](../../API/builtins/self.md), message : [`string`](../../API/builtins/string.md)) -> Shows a warning dialog to the user. -### show_status([*self*](../../API/builtins/self.md), message : [`string`](../../API/builtins/string.md)) -> Shows a message in Renoise's status bar to the user. -### show_prompt([*self*](../../API/builtins/self.md), title : [`string`](../../API/builtins/string.md), message : [`string`](../../API/builtins/string.md), button_labels : [`string`](../../API/builtins/string.md)[][`?`](../../API/builtins/nil.md)) -`->`label : [`string`](../../API/builtins/string.md) - -> Opens a modal dialog with a title, text and custom button labels. -> Returns the pressed button label or an empty string when canceled. -### show_custom_prompt([*self*](../../API/builtins/self.md), title : [`string`](../../API/builtins/string.md), content_view : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md), button_labels : [`string`](../../API/builtins/string.md)[], key_handler : [`KeyHandler`](#KeyHandler)[`?`](../../API/builtins/nil.md), key_handler_options : [`KeyHandlerOptions`](#keyhandleroptions)[`?`](../../API/builtins/nil.md), focus_handler : [`FocusHandler`](#FocusHandler)[`?`](../../API/builtins/nil.md)) -`->`label : [`string`](../../API/builtins/string.md) - -> Opens a modal dialog with a title, custom content and custom button labels. -> See: `renoise.ViewBuilder` for more info about custom views. -### show_custom_dialog([*self*](../../API/builtins/self.md), title : [`DialogTitle`](#DialogTitle), content_view : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md), key_handler : [`KeyHandler`](#KeyHandler)[`?`](../../API/builtins/nil.md), key_handler_options : [`KeyHandlerOptions`](#keyhandleroptions)[`?`](../../API/builtins/nil.md), focus_handler : [`FocusHandler`](#FocusHandler)[`?`](../../API/builtins/nil.md)) -`->`[`renoise.Dialog`](../../API/renoise/renoise.Dialog.md) - -> Shows a non modal dialog (a floating tool window) with custom content. -> When no key_handler is provided, the Escape key is used to close the dialog. -> See: `renoise.ViewBuilder` for more info about custom views. -### show_menu([*self*](../../API/builtins/self.md), dialog : [`renoise.Dialog`](../../API/renoise/renoise.Dialog.md), menu_entries : [`DialogMenuEntry`](#dialogmenuentry)[], below_view : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)[`?`](../../API/builtins/nil.md)) -> Shows a custom context menu on top of the given dialog. -> -> When specifying a view, the menu will be shown below the given view instance. -> The view instance must be part of the dialog that shows the menu and must be visible. -> By default the menu will be shown at the current mouse cursor position. -### prompt_for_path([*self*](../../API/builtins/self.md), title : [`DialogTitle`](#DialogTitle)) -`->`path : [`string`](../../API/builtins/string.md) - -> Opens a modal dialog to query an existing directory from the user. -### prompt_for_filename_to_read([*self*](../../API/builtins/self.md), file_extensions : [`string`](../../API/builtins/string.md)[], title : [`DialogTitle`](#DialogTitle)) -`->`path : [`string`](../../API/builtins/string.md) - -> Opens a modal dialog to query a filename and path to read from a file. -### prompt_for_multiple_filenames_to_read([*self*](../../API/builtins/self.md), file_extensions : [`string`](../../API/builtins/string.md)[], title : [`DialogTitle`](#DialogTitle)) -`->`paths : [`string`](../../API/builtins/string.md)[] - -> Same as 'prompt_for_filename_to_read' but allows the user to select -> more than one file. -### prompt_for_filename_to_write([*self*](../../API/builtins/self.md), file_extension : [`string`](../../API/builtins/string.md), title : [`DialogTitle`](#DialogTitle)) -`->`path : [`string`](../../API/builtins/string.md) - -> Open a modal dialog to get a filename and path for writing. -> When an existing file is selected, the dialog will ask whether or not to -> overwrite it, so you don't have to take care of this on your own. -### open_url([*self*](../../API/builtins/self.md), url : [`string`](../../API/builtins/string.md)) -> Opens the default internet browser with the given URL. The URL can also be -> a file that browsers can open (like xml, html files...). -### open_path([*self*](../../API/builtins/self.md), file_path : [`string`](../../API/builtins/string.md)) -> Opens the default file browser (explorer, finder...) with the given path. -### install_tool([*self*](../../API/builtins/self.md), file_path : [`string`](../../API/builtins/string.md)) -> Install order update a tool. Any errors are shown to the user -> during installation. Installing an already existing tool will upgrade -> the tool without confirmation. Upgraded tools will automatically be -> re-enabled, if necessary. -### uninstall_tool([*self*](../../API/builtins/self.md), file_path : [`string`](../../API/builtins/string.md)) -> Uninstall an existing tool. Any errors are shown to the user -> during uninstallation. -### new_song([*self*](../../API/builtins/self.md)) -> Create a new song document (will ask the user to save changes if needed). -> The song is not created immediately, but soon after the call was made and -> the user did not aborted the operation. In order to continue execution -> with the new song, attach a notifier to 'renoise.app().new_document_observable' -> See: `renoise.ScriptingTool` for more info. -### new_song_no_template([*self*](../../API/builtins/self.md)) -> Create a new song document, avoiding template XRNS songs (when present) to be loaded. -> The song is not created immediately, but soon after the call was made and -> the user did not aborted the operation. In order to continue execution -> with the new song, attach a notifier to 'renoise.app().new_document_observable' -> See: `renoise.ScriptingTool` for more info. -### load_song([*self*](../../API/builtins/self.md), filename : [`string`](../../API/builtins/string.md)) -> Load a new song document from the given filename (will ask to save -> changes if needed, any errors are shown to the user). -> Just like new_song(), the song is not loaded immediately, but soon after -> the call was made. See 'renoise.app():new_song()' for details. -### load_track_device_chain([*self*](../../API/builtins/self.md), filename : [`string`](../../API/builtins/string.md)) -`->`success : [`boolean`](../../API/builtins/boolean.md) - -> Load a track device chains into the currently selected track. -> Any errors during the export are shown to the user. -### load_track_device_preset([*self*](../../API/builtins/self.md), filename : [`string`](../../API/builtins/string.md)) -`->`success : [`boolean`](../../API/builtins/boolean.md) - -> Load a track device devices into the currently selected track. -> When no device is selected a new device will be created. -> Any errors during the export are shown to the user. -### load_instrument([*self*](../../API/builtins/self.md), filename : [`string`](../../API/builtins/string.md)) -`->`success : [`boolean`](../../API/builtins/boolean.md) - -> Load an instrument into the currently selected instrument. -> Any errors during the export are shown to the user. -### load_instrument_multi_sample([*self*](../../API/builtins/self.md), filename : [`string`](../../API/builtins/string.md)) -`->`success : [`boolean`](../../API/builtins/boolean.md) - -> Load an instrument multi sample into the currently selected instrument. -> Any errors during the export are shown to the user. -### load_instrument_device_chain([*self*](../../API/builtins/self.md), filename : [`string`](../../API/builtins/string.md)) -`->`success : [`boolean`](../../API/builtins/boolean.md) - -> Load an instrument device chain into the currently selected instrument's -> device chain. When no device chain is selected, a new one will be created. -> Any errors during the export are shown to the user. -### load_instrument_device_preset([*self*](../../API/builtins/self.md), filename : [`string`](../../API/builtins/string.md)) -`->`success : [`boolean`](../../API/builtins/boolean.md) - -> Load an instrument device into the currently selected instrument's device -> chain's device. When no device is selected, a new one will be created. -> Any errors during the export are shown to the user. -### load_instrument_modulation_set([*self*](../../API/builtins/self.md), filename : [`string`](../../API/builtins/string.md)) -`->`success : [`boolean`](../../API/builtins/boolean.md) - -> Load an instrument modulation chain into the currently selected instrument's -> modulation chain. When no device is selected, a new one will be created. -> Any errors during the export are shown to the user. -### load_instrument_phrase([*self*](../../API/builtins/self.md), filename : [`string`](../../API/builtins/string.md)) -`->`success : [`boolean`](../../API/builtins/boolean.md) - -> Load an instrument phrase into the currently selected instrument's -> phrases. When no phrase is selected, a new one will be created. -> Any errors during the export are shown to the user. -### load_instrument_sample([*self*](../../API/builtins/self.md), filename : [`string`](../../API/builtins/string.md)) -`->`success : [`boolean`](../../API/builtins/boolean.md) - -> Load an instrument sample into the currently selected instrument's -> sample lists. When no sample is selected, a new one will be created. -> Any errors during the export are shown to the user. -### load_theme([*self*](../../API/builtins/self.md), filename : [`string`](../../API/builtins/string.md)) -`->`success : [`boolean`](../../API/builtins/boolean.md) - -> Load a new theme file and apply it. -> Any errors during the export are shown to the user. -### save_song([*self*](../../API/builtins/self.md)) -> Quicksave or save the current song under a new name. Any errors -> during the export are shown to the user. -### save_song_as([*self*](../../API/builtins/self.md), filename : [`string`](../../API/builtins/string.md)) -> Save the current song under a new name. Any errors -> during the export are shown to the user. -### save_track_device_chain([*self*](../../API/builtins/self.md), filename : [`string`](../../API/builtins/string.md)) -`->`success : [`boolean`](../../API/builtins/boolean.md) - -> Save a currently selected track device chain to a file with the given name. -> When no device chain is selected an error is raised. returns success. -### save_instrument([*self*](../../API/builtins/self.md), filename : [`string`](../../API/builtins/string.md)) -`->`success : [`boolean`](../../API/builtins/boolean.md) - -> Save a currently selected instrument to a file with the given name. -> When no instruemnt is selected an error is raised. returns success. -### save_instrument_multi_sample([*self*](../../API/builtins/self.md), filename : [`string`](../../API/builtins/string.md)) -`->`success : [`boolean`](../../API/builtins/boolean.md) - -> Save a currently selected instrument multi sample file to a file with the given name. -> When no instrument is selected an error is raised. returns success. -### save_instrument_device_chain([*self*](../../API/builtins/self.md), filename : [`string`](../../API/builtins/string.md)) -`->`success : [`boolean`](../../API/builtins/boolean.md) - -> Save a currently selected instrument's device chain to a file with the given name. -> When no chain is selected an error is raised. returns success. -### save_instrument_modulation_set([*self*](../../API/builtins/self.md), filename : [`string`](../../API/builtins/string.md)) -`->`success : [`boolean`](../../API/builtins/boolean.md) - -> Save a currently selected instrument's modulation set to a file with the given name. -> When no modulation is selected an error is raised. returns success. -### save_instrument_phrase([*self*](../../API/builtins/self.md), filename : [`string`](../../API/builtins/string.md)) -`->`success : [`boolean`](../../API/builtins/boolean.md) - -> Save a currently selected instrument's phrase to a file with the given name. -> When no phrase is selected an error is raised. returns success. -### save_instrument_sample([*self*](../../API/builtins/self.md), filename : [`string`](../../API/builtins/string.md)) -`->`success : [`boolean`](../../API/builtins/boolean.md) - -> Save a currently selected instrument's sample to a file with the given name. -> When no sample is selected an error is raised. returns success. -### save_theme([*self*](../../API/builtins/self.md), filename : [`string`](../../API/builtins/string.md)) -`->`success : [`boolean`](../../API/builtins/boolean.md) - -> Save a current theme to a file with the given name. returns success. - - - ---- -## Structs -# DialogMenuEntry -> Defines a custom menu entry, shown in custom dialog windows. -> -> Separating entries: -> To divide entries into groups prepend one or more dashes to the name: -> ```md -> ---First Group Item -> Regular item -> ``` -> -> To create sub menus, define entries with a common path, using a colon as separator: -> ```md -> Main Menu Item -> Sub Menu:Sub Menu Item 1 -> Sub Menu:Sub Menu Item 2 -> ``` -> -> To insert a script menu entry into an existing context menu, see `ToolMenuEntry`. - ---- -## Properties -### name : [`string`](../../API/builtins/string.md) -> Name and optional path of the menu entry - -### invoke : fun() -> A function that is called as soon as the entry is clicked - -### active : [`boolean`](../../API/builtins/boolean.md)[`?`](../../API/builtins/nil.md) -> Default: true. When false, the action will not be invoked and will be "greyed out". - -### selected : [`boolean`](../../API/builtins/boolean.md)[`?`](../../API/builtins/nil.md) -> Default: false. When true, the entry will be marked as "this is a selected option" - - - - -# KeyEvent - ---- -## Properties -### name : [`string`](../../API/builtins/string.md) -> name of the key, like 'esc' or 'a' - -### modifiers : [`ModifierStates`](#ModifierStates) -> **Deprecated.** Use `modifier_flags` instead -> **READ-ONLY** the held down modifiers as a string - -### modifier_flags : [`ModifierFlags`](#ModifierFlags) -> **READ-ONLY** the held down modifiers as flags - -### character : [`string`](../../API/builtins/string.md)[`?`](../../API/builtins/nil.md) -> possible character representation of the key - -### note : [`integer`](../../API/builtins/integer.md)[`?`](../../API/builtins/nil.md) -> virtual keyboard piano key value (starting from 0) - -### state : `"pressed"` | `"released"` -> only present if `send_key_release` was set to true - -### repeated : [`boolean`](../../API/builtins/boolean.md)[`?`](../../API/builtins/nil.md) -> only present if `send_key_repeat` was set to true - - - - - ---- -## Aliases -### ModifierFlags -{ alt : [`boolean`](../../API/builtins/boolean.md), control : [`boolean`](../../API/builtins/boolean.md), meta : [`boolean`](../../API/builtins/boolean.md), shift : [`boolean`](../../API/builtins/boolean.md) } -> The currently pressed/release key's modifiers as platform independent flags. -> On macOS "control" is their "Command" key and the "meta" keyboard is the "Control" key. -> On Windows the "meta" key is the "Windows" key and on Linux the "Super" key. - -### ModifierStates -[`string`](../../API/builtins/string.md) -> **Deprecated.** Use `ModifierFlags` instead. -> -> The modifier keys will be provided as a string. -> Possible keys are dependent on the platform -> * Windows : "shift", "alt", "control", "winkey" -> * Linux : "shift", "alt", "control", "meta" -> * Mac : "shift", "option", "control", "command". -> If multiple modifiers are held down, the string will be formatted as -> " + " -> Their order will correspond to the following precedence -> `shift + alt/option + control + winkey/meta/command` -> If no modifier is pressed, this will be an empty string. - - - -# KeyHandlerOptions - ---- -## Properties -### send_key_repeat : [`boolean`](../../API/builtins/boolean.md)[`?`](../../API/builtins/nil.md) -> Default: true - -### send_key_release : [`boolean`](../../API/builtins/boolean.md)[`?`](../../API/builtins/nil.md) -> Default: false - - - - - - - ---- -## Aliases -### DialogTitle -[`string`](../../API/builtins/string.md) -> The title that shows up at the title-bar of the dialog. - -### FocusHandler -(dialogs : [`renoise.Dialog`](../../API/renoise/renoise.Dialog.md), focused : [`boolean`](../../API/builtins/boolean.md)) `->` [`KeyEvent`](#keyevent)[`?`](../../API/builtins/nil.md) -> Optional focus change notifier for a custom dialog. -> Will be called when the dialog gains of loses key focus. You maybe want to initialize -> your dloag's (modifier) keyboard states here. - -### KeyHandler -(dialog : [`renoise.Dialog`](../../API/renoise/renoise.Dialog.md), key_event : [`KeyEvent`](#keyevent)) `->` [`KeyEvent`](#keyevent)[`?`](../../API/builtins/nil.md) -> Optional keyhandler to process key events on a custom dialog. -> When returning the passed key from the key-handler function, the -> key will be passed back to Renoise's key event chain, in order to allow -> processing global Renoise key-bindings from your dialog. This will not work -> for modal dialogs. This also only applies to global shortcuts in Renoise, -> because your dialog will steal the focus from all other Renoise views such as -> the Pattern Editor, etc. - -### ModifierFlags -{ alt : [`boolean`](../../API/builtins/boolean.md), control : [`boolean`](../../API/builtins/boolean.md), meta : [`boolean`](../../API/builtins/boolean.md), shift : [`boolean`](../../API/builtins/boolean.md) } -> The currently pressed/release key's modifiers as platform independent flags. -> On macOS "control" is their "Command" key and the "meta" keyboard is the "Control" key. -> On Windows the "meta" key is the "Windows" key and on Linux the "Super" key. - -### ModifierStates -[`string`](../../API/builtins/string.md) -> **Deprecated.** Use `ModifierFlags` instead. -> -> The modifier keys will be provided as a string. -> Possible keys are dependent on the platform -> * Windows : "shift", "alt", "control", "winkey" -> * Linux : "shift", "alt", "control", "meta" -> * Mac : "shift", "option", "control", "command". -> If multiple modifiers are held down, the string will be formatted as -> " + " -> Their order will correspond to the following precedence -> `shift + alt/option + control + winkey/meta/command` -> If no modifier is pressed, this will be an empty string. - - diff --git a/docs/API/renoise/renoise.ApplicationTheme.md b/docs/API/renoise/renoise.ApplicationTheme.md deleted file mode 100644 index 260b723..0000000 --- a/docs/API/renoise/renoise.ApplicationTheme.md +++ /dev/null @@ -1,264 +0,0 @@ -# renoise.ApplicationTheme -> Application's theme colors and other general color theme properties. -> -> Note: All properties and functions of the app theme are **read-only**, so the -> theme can't be modified here. Use the app's `renoise.Application:load_theme` -> function to load and apply new themes instead. -> -> Accessing colors and theme properties can be useful in custom viewbuilder -> widgets. - - - - ---- -## Properties -### colors : { [ThemeColor]: RGBColor } -> **READ-ONLY** Get all theme colors in a flat list of RGBColors. -> Color table keys are string identifiers as used in the theme XML file, -> but in lower case. -> -> Note that if you only need to access a single color from the theme, -> use `renoise.app().theme.color(color_name)` instead. -> -> To get notified of color changes, use `renoise.app().theme_observable` - -### knob_shade : [`number`](../../API/builtins/number.md) -> **READ-ONLY** Get theme's knob shade setting. Range: (1 - 2) - -### knob_shade_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### body_shade : [`number`](../../API/builtins/number.md) -> **READ-ONLY** Get theme's body shade setting. Range: (1 - 2) - -### body_shade_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### contrast : [`number`](../../API/builtins/number.md) -> **READ-ONLY** Get theme's contrast setting. Range: (-0.5 - 0.5) - -### contrast_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### texture_set : [`string`](../../API/builtins/string.md) -> **READ-ONLY** Get theme's texture set name - -### texture_set_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - - - ---- -## Functions -### color([*self*](../../API/builtins/self.md), color_name : [`ThemeColor`](#ThemeColor)) -`->`[`RGBColor`](#RGBColor) - -> Get a single color from the theme using a color identifier as used -> in the theme XML file - but in lower case. -> -> e.g. to access the button background color from the theme, use -> `renoise.app().theme.color("button_back")` -> -> To get notified of color changes, use `renoise.app().theme_observable` -> -> ```lua -> -- The application theme's colors -> color_name: -> | "main_back" -> | "main_font" -> | "alternate_main_back" -> | "alternate_main_font" -> | "body_back" -> | "body_font" -> | "strong_body_font" -> | "button_back" -> | "button_font" -> | "button_highlight_font" -> | "selected_button_back" -> | "selected_button_font" -> | "selection_back" -> | "selection_font" -> | "standby_selection_back" -> | "standby_selection_font" -> | "midi_mapping_back" -> | "midi_mapping_font" -> | "tooltip_back" -> | "tooltip_font" -> | "valuebox_back" -> | "valuebox_font" -> | "valuebox_font_icons" -> | "scrollbar" -> | "slider" -> | "folder" -> | "pattern_default_back" -> | "pattern_default_font" -> | "pattern_default_font_volume" -> | "pattern_default_font_panning" -> | "pattern_default_font_pitch" -> | "pattern_default_font_delay" -> | "pattern_default_font_global" -> | "pattern_default_font_other" -> | "pattern_default_font_dspfx" -> | "pattern_default_font_unused" -> | "pattern_highlighted_back" -> | "pattern_highlighted_font" -> | "pattern_highlighted_font_volume" -> | "pattern_highlighted_font_panning" -> | "pattern_highlighted_font_pitch" -> | "pattern_highlighted_font_delay" -> | "pattern_highlighted_font_global" -> | "pattern_highlighted_font_other" -> | "pattern_highlighted_font_dspfx" -> | "pattern_highlighted_font_unused" -> | "pattern_playposition_back" -> | "pattern_playposition_font" -> | "pattern_centerbar_back" -> | "pattern_centerbar_font" -> | "pattern_centerbar_back_standby" -> | "pattern_centerbar_font_standby" -> | "pattern_selection" -> | "pattern_standby_selection" -> | "pattern_mute_state" -> | "automation_grid" -> | "automation_line_edge" -> | "automation_line_fill" -> | "automation_point" -> | "automation_marker_play" -> | "automation_marker_single" -> | "automation_marker_pair" -> | "automation_marker_diamond" -> | "vumeter_meter" -> | "vumeter_meter_low" -> | "vumeter_meter_middle" -> | "vumeter_meter_high" -> | "vumeter_peak" -> | "vumeter_back_normal" -> | "vumeter_back_clipped" -> | "default_color_01" -> | "default_color_02" -> | "default_color_03" -> | "default_color_04" -> | "default_color_05" -> | "default_color_06" -> | "default_color_07" -> | "default_color_08" -> | "default_color_09" -> | "default_color_10" -> | "default_color_11" -> | "default_color_12" -> | "default_color_13" -> | "default_color_14" -> | "default_color_15" -> | "default_color_16" -> ``` - - - ---- -## Aliases -### RGBColor -{ 1 : [`integer`](../../API/builtins/integer.md), 2 : [`integer`](../../API/builtins/integer.md), 3 : [`integer`](../../API/builtins/integer.md) } -> A table of 3 bytes (ranging from 0 to 255) -> representing the red, green and blue channels of a color. -> {0xFF, 0xFF, 0xFF} is white -> {165, 73, 35} is the red from the Renoise logo - -### ThemeColor -`"alternate_main_back"` | `"alternate_main_font"` | `"automation_grid"` | `"automation_line_edge"` | `"automation_line_fill"` | `"automation_marker_diamond"` | `"automation_marker_pair"` | `"automation_marker_play"` | `"automation_marker_single"` | `"automation_point"` | `"body_back"` | `"body_font"` | `"button_back"` | `"button_font"` | `"button_highlight_font"` | `"default_color_01"` | `"default_color_02"` | `"default_color_03"` | `"default_color_04"` | `"default_color_05"` | `"default_color_06"` | `"default_color_07"` | `"default_color_08"` | `"default_color_09"` | `"default_color_10"` | `"default_color_11"` | `"default_color_12"` | `"default_color_13"` | `"default_color_14"` | `"default_color_15"` | `"default_color_16"` | `"folder"` | `"main_back"` | `"main_font"` | `"midi_mapping_back"` | `"midi_mapping_font"` | `"pattern_centerbar_back"` | `"pattern_centerbar_back_standby"` | `"pattern_centerbar_font"` | `"pattern_centerbar_font_standby"` | `"pattern_default_back"` | `"pattern_default_font"` | `"pattern_default_font_delay"` | `"pattern_default_font_dspfx"` | `"pattern_default_font_global"` | `"pattern_default_font_other"` | `"pattern_default_font_panning"` | `"pattern_default_font_pitch"` | `"pattern_default_font_unused"` | `"pattern_default_font_volume"` | `"pattern_highlighted_back"` | `"pattern_highlighted_font"` | `"pattern_highlighted_font_delay"` | `"pattern_highlighted_font_dspfx"` | `"pattern_highlighted_font_global"` | `"pattern_highlighted_font_other"` | `"pattern_highlighted_font_panning"` | `"pattern_highlighted_font_pitch"` | `"pattern_highlighted_font_unused"` | `"pattern_highlighted_font_volume"` | `"pattern_mute_state"` | `"pattern_playposition_back"` | `"pattern_playposition_font"` | `"pattern_selection"` | `"pattern_standby_selection"` | `"scrollbar"` | `"selected_button_back"` | `"selected_button_font"` | `"selection_back"` | `"selection_font"` | `"slider"` | `"standby_selection_back"` | `"standby_selection_font"` | `"strong_body_font"` | `"tooltip_back"` | `"tooltip_font"` | `"valuebox_back"` | `"valuebox_font"` | `"valuebox_font_icons"` | `"vumeter_back_clipped"` | `"vumeter_back_normal"` | `"vumeter_meter"` | `"vumeter_meter_high"` | `"vumeter_meter_low"` | `"vumeter_meter_middle"` | `"vumeter_peak"` -> ```lua -> -- The application theme's colors -> ThemeColor: -> | "main_back" -> | "main_font" -> | "alternate_main_back" -> | "alternate_main_font" -> | "body_back" -> | "body_font" -> | "strong_body_font" -> | "button_back" -> | "button_font" -> | "button_highlight_font" -> | "selected_button_back" -> | "selected_button_font" -> | "selection_back" -> | "selection_font" -> | "standby_selection_back" -> | "standby_selection_font" -> | "midi_mapping_back" -> | "midi_mapping_font" -> | "tooltip_back" -> | "tooltip_font" -> | "valuebox_back" -> | "valuebox_font" -> | "valuebox_font_icons" -> | "scrollbar" -> | "slider" -> | "folder" -> | "pattern_default_back" -> | "pattern_default_font" -> | "pattern_default_font_volume" -> | "pattern_default_font_panning" -> | "pattern_default_font_pitch" -> | "pattern_default_font_delay" -> | "pattern_default_font_global" -> | "pattern_default_font_other" -> | "pattern_default_font_dspfx" -> | "pattern_default_font_unused" -> | "pattern_highlighted_back" -> | "pattern_highlighted_font" -> | "pattern_highlighted_font_volume" -> | "pattern_highlighted_font_panning" -> | "pattern_highlighted_font_pitch" -> | "pattern_highlighted_font_delay" -> | "pattern_highlighted_font_global" -> | "pattern_highlighted_font_other" -> | "pattern_highlighted_font_dspfx" -> | "pattern_highlighted_font_unused" -> | "pattern_playposition_back" -> | "pattern_playposition_font" -> | "pattern_centerbar_back" -> | "pattern_centerbar_font" -> | "pattern_centerbar_back_standby" -> | "pattern_centerbar_font_standby" -> | "pattern_selection" -> | "pattern_standby_selection" -> | "pattern_mute_state" -> | "automation_grid" -> | "automation_line_edge" -> | "automation_line_fill" -> | "automation_point" -> | "automation_marker_play" -> | "automation_marker_single" -> | "automation_marker_pair" -> | "automation_marker_diamond" -> | "vumeter_meter" -> | "vumeter_meter_low" -> | "vumeter_meter_middle" -> | "vumeter_meter_high" -> | "vumeter_peak" -> | "vumeter_back_normal" -> | "vumeter_back_clipped" -> | "default_color_01" -> | "default_color_02" -> | "default_color_03" -> | "default_color_04" -> | "default_color_05" -> | "default_color_06" -> | "default_color_07" -> | "default_color_08" -> | "default_color_09" -> | "default_color_10" -> | "default_color_11" -> | "default_color_12" -> | "default_color_13" -> | "default_color_14" -> | "default_color_15" -> | "default_color_16" -> ``` - - diff --git a/docs/API/renoise/renoise.ApplicationWindow.md b/docs/API/renoise/renoise.ApplicationWindow.md deleted file mode 100644 index 21482fe..0000000 --- a/docs/API/renoise/renoise.ApplicationWindow.md +++ /dev/null @@ -1,224 +0,0 @@ -# renoise.ApplicationWindow -> Application window and general UI properties of the Renoise app. - - - -## Constants -### UpperFrame -> ```lua -> { -> UPPER_FRAME_TRACK_SCOPES: integer = 1, -> UPPER_FRAME_MASTER_SPECTRUM: integer = 2, -> } -> ``` -### MiddleFrame -> ```lua -> { -> MIDDLE_FRAME_PATTERN_EDITOR: integer = 1, -> MIDDLE_FRAME_MIXER: integer = 2, -> MIDDLE_FRAME_INSTRUMENT_PHRASE_EDITOR: integer = 3, -> MIDDLE_FRAME_INSTRUMENT_SAMPLE_KEYZONES: integer = 4, -> MIDDLE_FRAME_INSTRUMENT_SAMPLE_EDITOR: integer = 5, -> MIDDLE_FRAME_INSTRUMENT_SAMPLE_MODULATION: integer = 6, -> MIDDLE_FRAME_INSTRUMENT_SAMPLE_EFFECTS: integer = 7, -> MIDDLE_FRAME_INSTRUMENT_PLUGIN_EDITOR: integer = 8, -> MIDDLE_FRAME_INSTRUMENT_MIDI_EDITOR: integer = 9, -> } -> ``` -### LowerFrame -> ```lua -> { -> LOWER_FRAME_TRACK_DSPS: integer = 1, -> LOWER_FRAME_TRACK_AUTOMATION: integer = 2, -> } -> ``` -### DiskBrowserCategory -> ```lua -> { -> DISK_BROWSER_CATEGORY_SONGS: integer = 1, -> DISK_BROWSER_CATEGORY_INSTRUMENTS: integer = 2, -> DISK_BROWSER_CATEGORY_SAMPLES: integer = 3, -> DISK_BROWSER_CATEGORY_OTHER: integer = 4, -> } -> ``` -### InstrumentBoxSlotSize -> ```lua -> { -> INSTRUMENT_BOX_SLOT_SIZE_SMALL: integer = 1, -> INSTRUMENT_BOX_SLOT_SIZE_MEDIUM: integer = 2, -> INSTRUMENT_BOX_SLOT_SIZE_LARGE: integer = 3, -> } -> ``` -### MixerFader -> ```lua -> { -> MIXER_FADER_TYPE_24DB: integer = 1, -> MIXER_FADER_TYPE_48DB: integer = 2, -> MIXER_FADER_TYPE_96DB: integer = 3, -> MIXER_FADER_TYPE_LINEAR: integer = 4, -> } -> ``` - - ---- -## Properties -### fullscreen : [`boolean`](../../API/builtins/boolean.md) -> Get/set if the application is running fullscreen. - -### is_maximized : [`boolean`](../../API/builtins/boolean.md) -> **READ-ONLY**. Window status flag. - -### is_minimized : [`boolean`](../../API/builtins/boolean.md) -> **READ-ONLY**. Window status flag. - -### lock_keyboard_focus : [`boolean`](../../API/builtins/boolean.md) -> When true, the middle frame views (like the pattern editor) will -> stay focused unless alt or middle mouse is clicked. - -### sample_record_dialog_is_visible : [`boolean`](../../API/builtins/boolean.md) -> Dialog for recording new samples, floating above the main window. - -### disk_browser_is_visible : [`boolean`](../../API/builtins/boolean.md) -> Diskbrowser Panel. - -### disk_browser_is_visible_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### disk_browser_category : [`renoise.ApplicationWindow.DiskBrowserCategory`](renoise.ApplicationWindow.md#DiskBrowserCategory) -### disk_browser_category_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### instrument_box_is_visible : [`boolean`](../../API/builtins/boolean.md) -> InstrumentBox - -### instrument_box_is_visible_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### instrument_box_slot_size : [`renoise.ApplicationWindow.InstrumentBoxSlotSize`](renoise.ApplicationWindow.md#InstrumentBoxSlotSize) -> InstrumentBox slot size - -### instrument_box_slot_size_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### instrument_editor_is_detached : [`boolean`](../../API/builtins/boolean.md) -> Instrument Editor detaching. - -### instrument_editor_is_detached_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### instrument_properties_is_visible : [`boolean`](../../API/builtins/boolean.md) -> InstrumentProperties (below InstrumentBox) - -### instrument_properties_is_visible_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### instrument_properties_show_volume_transpose : [`boolean`](../../API/builtins/boolean.md) -### instrument_properties_show_trigger_options : [`boolean`](../../API/builtins/boolean.md) -### instrument_properties_show_scale_options : [`boolean`](../../API/builtins/boolean.md) -### instrument_properties_show_plugin : [`boolean`](../../API/builtins/boolean.md) -### instrument_properties_show_plugin_program : [`boolean`](../../API/builtins/boolean.md) -### instrument_properties_show_midi : [`boolean`](../../API/builtins/boolean.md) -### instrument_properties_show_midi_program : [`boolean`](../../API/builtins/boolean.md) -### instrument_properties_show_macros : [`boolean`](../../API/builtins/boolean.md) -### instrument_properties_show_phrases : [`boolean`](../../API/builtins/boolean.md) -### sample_properties_is_visible : [`boolean`](../../API/builtins/boolean.md) -> SampleProperties (below SampleNavigator) - -### sample_properties_is_visible_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### mixer_view_is_detached : [`boolean`](../../API/builtins/boolean.md) -> Mixer View detaching. - -### mixer_view_is_detached_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### upper_frame_is_visible : [`boolean`](../../API/builtins/boolean.md) -> Frame with the scopes/master spectrum... - -### upper_frame_is_visible_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### active_upper_frame : [`renoise.ApplicationWindow.UpperFrame`](renoise.ApplicationWindow.md#UpperFrame) -### active_upper_frame_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### active_middle_frame : [`renoise.ApplicationWindow.MiddleFrame`](renoise.ApplicationWindow.md#MiddleFrame) -> Frame with the pattern editor, mixer... - -### active_middle_frame_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### lower_frame_is_visible : [`boolean`](../../API/builtins/boolean.md) -> Frame with the DSP chain view, automation, etc. - -### lower_frame_is_visible_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### active_lower_frame : [`renoise.ApplicationWindow.LowerFrame`](renoise.ApplicationWindow.md#LowerFrame) -### active_lower_frame_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### right_frame_is_visible : [`boolean`](../../API/builtins/boolean.md) -> Frame with Disk Browser and Instrument Box. - -### right_frame_is_visible_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### pattern_matrix_is_visible : [`boolean`](../../API/builtins/boolean.md) -> Pattern matrix, visible in pattern editor and mixer only... - -### pattern_matrix_is_visible_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### pattern_advanced_edit_is_visible : [`boolean`](../../API/builtins/boolean.md) -> Pattern advanced edit, visible in pattern editor only... - -### pattern_advanced_edit_is_visible_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### mixer_view_post_fx : [`boolean`](../../API/builtins/boolean.md) -> Mixer views Pre/Post volume setting. - -### mixer_view_post_fx_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### mixer_fader_type : [`renoise.ApplicationWindow.MixerFader`](renoise.ApplicationWindow.md#MixerFader) -> Mixer fader type setting. - -### mixer_fader_type_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - - - ---- -## Functions -### maximize([*self*](../../API/builtins/self.md)) -> Expand the window over the entire screen, without hiding menu bars, -> docks and so on. -### minimize([*self*](../../API/builtins/self.md)) -> Minimize the window to the dock or taskbar, depending on the OS. -### restore([*self*](../../API/builtins/self.md)) -> "un-maximize" or "un-minimize" the window, or just bring it to front. -### select_preset([*self*](../../API/builtins/self.md), preset_index : [`integer`](../../API/builtins/integer.md)) -> Select/activate one of the global view presets, to memorize/restore -> the user interface layout. - diff --git a/docs/API/renoise/renoise.AudioDevice.md b/docs/API/renoise/renoise.AudioDevice.md deleted file mode 100644 index 3aa4ef9..0000000 --- a/docs/API/renoise/renoise.AudioDevice.md +++ /dev/null @@ -1,82 +0,0 @@ -# renoise.AudioDevice -> Audio DSP device in tracks or sample device chains. - - - - ---- -## Properties -### name : [`string`](../../API/builtins/string.md) -> **READ-ONLY** - -### short_name : [`string`](../../API/builtins/string.md) -> **READ-ONLY** - -### display_name : [`string`](../../API/builtins/string.md) -> Configurable device display name. When empty `name` is displayed. - -### display_name_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### is_active : [`boolean`](../../API/builtins/boolean.md) -> !active = bypassed - -### is_active_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### is_maximized : [`boolean`](../../API/builtins/boolean.md) -> Maximize state in DSP chain. - -### is_maximized_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### active_preset : [`integer`](../../API/builtins/integer.md) -> 0 when none is active or available - -### active_preset_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### active_preset_data : [`string`](../../API/builtins/string.md) -> raw serialized data in XML format of the active preset - -### presets : [`string`](../../API/builtins/string.md)[] -> **READ-ONLY** preset names - -### is_active_parameter : [`renoise.DeviceParameter`](../../API/renoise/renoise.DeviceParameter.md) -> **READ-ONLY** - -### parameters : [`renoise.DeviceParameter`](../../API/renoise/renoise.DeviceParameter.md)[] -> **READ-ONLY** - -### external_editor_available : [`boolean`](../../API/builtins/boolean.md) -> **READ-ONLY** Returns whether or not the device provides its own custom GUI -> (only available for some plugin devices) - -### external_editor_visible : [`boolean`](../../API/builtins/boolean.md) -> true to show the editor, false to close it - -### device_path : [`string`](../../API/builtins/string.md) -> **READ-ONLY** Returns a string that uniquely identifies the device, from -> `available_devices`. The string can be passed into: -> `renoise.song().tracks[]:insert_device_at()` - - - ---- -## Functions -### preset([*self*](../../API/builtins/self.md), index : [`integer`](../../API/builtins/integer.md)) -`->`preset_name : [`string`](../../API/builtins/string.md) - -> Access to a single preset name by index. Use properties 'presets' to iterate -> over all presets and to query the presets count. -> comment -### parameter([*self*](../../API/builtins/self.md), index : [`integer`](../../API/builtins/integer.md)) -`->`[`renoise.DeviceParameter`](../../API/renoise/renoise.DeviceParameter.md) - -> Access to a single parameter by index. Use properties 'parameters' to iterate -> over all parameters and to query the parameter count. - diff --git a/docs/API/renoise/renoise.DeviceParameter.md b/docs/API/renoise/renoise.DeviceParameter.md deleted file mode 100644 index 12390e8..0000000 --- a/docs/API/renoise/renoise.DeviceParameter.md +++ /dev/null @@ -1,84 +0,0 @@ -# renoise.DeviceParameter -> A single parameter within an audio DSP effect (renoise.AudioDevice) - - - -## Constants -### Polarity -> ```lua -> { -> POLARITY_UNIPOLAR: integer = 1, -> POLARITY_BIPOLAR: integer = 2, -> } -> ``` - - ---- -## Properties -### name : [`string`](../../API/builtins/string.md) -> **READ-ONLY** - -### name_observable : [`renoise.Document.ObservableString`](../../API/renoise/renoise.Document.ObservableString.md) -### polarity : [`renoise.DeviceParameter.Polarity`](renoise.DeviceParameter.md#Polarity) -> **READ-ONLY** - -### value_min : [`number`](../../API/builtins/number.md) -> **READ-ONLY** - -### value_max : [`number`](../../API/builtins/number.md) -> **READ-ONLY** - -### value_quantum : [`number`](../../API/builtins/number.md) -> **READ-ONLY** - -### value_default : [`number`](../../API/builtins/number.md) -> **READ-ONLY** - -### time_quantum : [`number`](../../API/builtins/number.md) -> **READ-ONLY** - -### is_automatable : [`boolean`](../../API/builtins/boolean.md) -> **READ-ONLY** - -### is_automated : [`boolean`](../../API/builtins/boolean.md) -> **READ-ONLY** Is automated. Not valid for parameters of instrument devices. - -### is_automated_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### is_midi_mapped : [`boolean`](../../API/builtins/boolean.md) -> **READ-ONLY** Parameter has a custom MIDI mapping in the current song. - -### is_midi_mapped_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### show_in_mixer : [`boolean`](../../API/builtins/boolean.md) -> Show in mixer. Not valid for parameters of instrument devices. - -### show_in_mixer_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### value : [`number`](../../API/builtins/number.md) -> value in Range: (value_min - value_max) - -### value_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### value_string : [`string`](../../API/builtins/string.md) -### value_string_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - - - ---- -## Functions -### record_value([*self*](../../API/builtins/self.md), value : [`number`](../../API/builtins/number.md)) -> Set a new value and write automation when the MIDI mapping -> "record to automation" option is set. Only works for parameters -> of track devices, not for instrument devices. - diff --git a/docs/API/renoise/renoise.Dialog.md b/docs/API/renoise/renoise.Dialog.md deleted file mode 100644 index 0050f05..0000000 --- a/docs/API/renoise/renoise.Dialog.md +++ /dev/null @@ -1,27 +0,0 @@ -# renoise.Dialog -> A custom dialog created via the scripting API. Dialogs can be created -> via `renoise.app():show_custom_dialog`. -> -> See `create custom views` on top of the renoise.ViewBuilder docs on how to -> create views for the dialog. - - - - ---- -## Properties -### visible : [`boolean`](../../API/builtins/boolean.md) -> **READ-ONLY** Check if a dialog is alive and visible. - -### focused : [`boolean`](../../API/builtins/boolean.md) -> **READ-ONLY** Check if a dialog is visible and is the key window. - - - ---- -## Functions -### show([*self*](../../API/builtins/self.md)) -> Bring an already visible dialog to front and make it the key window. -### close([*self*](../../API/builtins/self.md)) -> Close a visible dialog. - diff --git a/docs/API/renoise/renoise.Document.DocumentList.md b/docs/API/renoise/renoise.Document.DocumentList.md deleted file mode 100644 index 231cb9f..0000000 --- a/docs/API/renoise/renoise.Document.DocumentList.md +++ /dev/null @@ -1,126 +0,0 @@ -# renoise.Document.DocumentList -> A document list is a document sub component which may contain other document -> nodes in an observable list. -> -> ### example: -> ```lua -> -- our goal here is to have a document that contains a list of documents -> -- which can loaded as preferences for our tool -> -- -> -- define a class model for our complex type for document items in the list -> -- so that Renoise knows how to load it later our entries will have -> renoise.Document.create("Entry") { -> name = renoise.Document.ObservableString(), -> path = renoise.Document.ObservableString(), -> } -> -> -- create new entry instances with the given data -> function create_entry(name, path) -> local entry = renoise.Document.instantiate("Entry") -> entry.name.value = name -> entry.path.value = path -> return entry -> end -> -> -- define a class model for our preferences which is using a list of entries -> renoise.Document.create("MyPreferences") { -> list = renoise.Document.DocumentList() -> } -> -> -- assign a fresh instance of our main document as preferences -> local preferences = renoise.Document.instantiate("MyPreferences") -> renoise.tool().preferences = preferences -> -> -- insert elements into the list using :insert(index, element) -> -- we call our helper to create an instance of Entry -> preferences.list:insert(1, create_entry("some name", "some/path")) -> -> -- access entries by using :property(index) -> print(preferences.list:property(1).name) -> -> -- get the size of the list (you can use :size() as well) -> print(#preferences.list) -> -> -- loop over the list to print all entries -> for i = 1, #preferences.list do -> local entry = preferences.list:property(i) -> print(i) -> print(entry.name) -> print(entry.path) -> end -> -> -- try reloading your tool to see the list get bigger -> ``` - - - - ---- -## Functions -### size([*self*](../../API/builtins/self.md)) -`->`[`integer`](../../API/builtins/integer.md) - -> Returns the number of entries of the list. -### property([*self*](../../API/builtins/self.md), index : [`integer`](../../API/builtins/integer.md)) -`->`[`renoise.Document.DocumentNode`](../../API/renoise/renoise.Document.DocumentNode.md)[`?`](../../API/builtins/nil.md) - -> List item access by index. returns nil for non existing items. -### find([*self*](../../API/builtins/self.md), start_pos : [`integer`](../../API/builtins/integer.md), value : [`renoise.Document.DocumentNode`](../../API/renoise/renoise.Document.DocumentNode.md)) -`->`[`integer`](../../API/builtins/integer.md)[`?`](../../API/builtins/nil.md) - -> Find a value in the list by comparing the list values with the passed -> value. The first successful match is returned. When no match is found, nil -> is returned. -### insert([*self*](../../API/builtins/self.md), pos : [`integer`](../../API/builtins/integer.md), value : [`renoise.Document.DocumentNode`](../../API/renoise/renoise.Document.DocumentNode.md)) -`->`[`renoise.Document.DocumentNode`](../../API/renoise/renoise.Document.DocumentNode.md) - -> Insert a new item to the end of the list when no position is specified, or -> at the specified position. Returns the newly created and inserted Observable. -### remove([*self*](../../API/builtins/self.md), pos : [`integer`](../../API/builtins/integer.md)) -> Removes an item (or the last one if no index is specified) from the list. -### swap([*self*](../../API/builtins/self.md), pos1 : [`integer`](../../API/builtins/integer.md), pos2 : [`integer`](../../API/builtins/integer.md)) -> Swaps the positions of two items without adding/removing the items. -> -> With a series of swaps you can move the item from/to any position. -### has_notifier([*self*](../../API/builtins/self.md), notifier : [`ListNotifierFunction`](#ListNotifierFunction)) -> Checks if the given function, method was already registered as notifier. -### add_notifier([*self*](../../API/builtins/self.md), notifier : [`ListNotifierFunction`](#ListNotifierFunction)) -> Register a function or method as a notifier, which will be called as soon as -> the document lists layout changed. The passed notifier can either be a function -> or a table with a function and some context (an "object") -> method. -### remove_notifier([*self*](../../API/builtins/self.md), notifier : [`ListNotifierFunction`](#ListNotifierFunction) | [`ListNotifierMemberContext`](#ListNotifierMemberContext)) -> Unregister a previously registered list notifier. When only passing an object, -> all notifier functions that match the given object will be removed. -> This will not fire errors when no methods for the given object are attached. -> Trying to unregister a function or method which wasn't registered, will resolve -> into an error. - - - ---- -## Aliases -### ListElementAdded -{ index : [`integer`](../../API/builtins/integer.md), type : `"insert"` } - - -### ListElementChange -[`ListElementAdded`](#ListElementAdded) | [`ListElementRemoved`](#ListElementRemoved) | [`ListElementsSwapped`](#ListElementsSwapped) - - -### ListElementRemoved -{ index : [`integer`](../../API/builtins/integer.md), type : `"remove"` } - - -### ListElementsSwapped -{ index1 : [`integer`](../../API/builtins/integer.md), index2 : [`integer`](../../API/builtins/integer.md), type : `"swap"` } - - -### ListNotifierFunction -(change : [`ListElementChange`](#ListElementChange)) - - -### ListNotifierMemberContext -[`table`](../../API/builtins/table.md) | [`userdata`](../../API/builtins/userdata.md) - - - diff --git a/docs/API/renoise/renoise.Document.DocumentNode.md b/docs/API/renoise/renoise.Document.DocumentNode.md deleted file mode 100644 index 86bfbae..0000000 --- a/docs/API/renoise/renoise.Document.DocumentNode.md +++ /dev/null @@ -1,113 +0,0 @@ -# renoise.Document.DocumentNode -> A document node is a sub component in a document which contains other -> documents or observables. - - - - ---- -## Functions -### __init([*self*](../../API/builtins/self.md)) -> Base constructor, only necessary to be called in your custom class constructor, -> when inheriting from renoise.Document.DocumentNode. -### has_property([*self*](../../API/builtins/self.md), property_name : [`string`](../../API/builtins/string.md)) -`->`[`boolean`](../../API/builtins/boolean.md) - -> Check if the given property exists. -### property([*self*](../../API/builtins/self.md), property_name : [`string`](../../API/builtins/string.md)) -`->`[`DocumentMember`](#DocumentMember)[`?`](../../API/builtins/nil.md) - -> Access a property by name. Returns the property, or nil when there is no -> such property. -### add_property([*self*](../../API/builtins/self.md), name : [`string`](../../API/builtins/string.md), value : [`renoise.Document.DocumentNode`](../../API/renoise/renoise.Document.DocumentNode.md)) -`->`[`renoise.Document.DocumentNode`](../../API/renoise/renoise.Document.DocumentNode.md) - -> Add a new property. Name must be unique: overwriting already existing -> properties with the same name is not allowed and will fire an error. -> If you want to replace a property, remove it first, then add it again. -### add_properties([*self*](../../API/builtins/self.md), properties : [`ObservableProperties`](#ObservableProperties)) -> Add a batch of properties in one go, similar to renoise.Document.create. -### remove_property([*self*](../../API/builtins/self.md), value : [`DocumentMember`](#DocumentMember)) -> Remove a previously added property. Property must exist. -> -> In order to remove a value by it's key, use -> `my_document:remove_property(my_document["some_member"])` -### save_as([*self*](../../API/builtins/self.md), file_name : [`string`](../../API/builtins/string.md)) -`->`success : [`boolean`](../../API/builtins/boolean.md), error : [`string`](../../API/builtins/string.md)[`?`](../../API/builtins/nil.md) - -> Save the whole document tree to an XML file. Overwrites all contents of the -> file when it already exists. -### load_from([*self*](../../API/builtins/self.md), file_name : [`string`](../../API/builtins/string.md)) -`->`success : [`boolean`](../../API/builtins/boolean.md), error : [`string`](../../API/builtins/string.md)[`?`](../../API/builtins/nil.md) - -> Load the document tree from an XML file. This will NOT create new properties, -> except for list items, but will only assign existing property values in the -> document node with existing property values from the XML. -> This means: nodes that only exist in the XML will silently be ignored. -> Nodes that only exist in the document, will not be altered in any way. -> The loaded document's type must match the document type that saved the XML -> data. -> A document's type is specified in the renoise.Document.create() function -> as "model_name". For classes which inherit from renoise.Document.DocumentNode -> it's the class name. -### to_string([*self*](../../API/builtins/self.md)) -`->`[`string`](../../API/builtins/string.md) - -> Serialize the whole document tree to a XML string. -### from_string([*self*](../../API/builtins/self.md), string : [`string`](../../API/builtins/string.md)) -`->`success : [`boolean`](../../API/builtins/boolean.md), error : [`string`](../../API/builtins/string.md)[`?`](../../API/builtins/nil.md) - -> Parse document tree from the given string data. -> See renoise.Document.DocumentNode:load_from for details about how properties -> are parsed and errors are handled. - - - ---- -## Aliases -### DocumentMember -[`renoise.Document.DocumentList`](../../API/renoise/renoise.Document.DocumentList.md) | [`renoise.Document.DocumentNode`](../../API/renoise/renoise.Document.DocumentNode.md) | [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) | [`renoise.Document.ObservableList`](../../API/renoise/renoise.Document.ObservableList.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### ListElementAdded -{ index : [`integer`](../../API/builtins/integer.md), type : `"insert"` } - - -### ListElementChange -[`ListElementAdded`](#ListElementAdded) | [`ListElementRemoved`](#ListElementRemoved) | [`ListElementsSwapped`](#ListElementsSwapped) - - -### ListElementRemoved -{ index : [`integer`](../../API/builtins/integer.md), type : `"remove"` } - - -### ListElementsSwapped -{ index1 : [`integer`](../../API/builtins/integer.md), index2 : [`integer`](../../API/builtins/integer.md), type : `"swap"` } - - -### ListNotifierFunction -(change : [`ListElementChange`](#ListElementChange)) - - -### ListNotifierMemberContext -[`table`](../../API/builtins/table.md) | [`userdata`](../../API/builtins/userdata.md) - - -### NotifierFunction -fun() - - -### NotifierMemberContext -[`table`](../../API/builtins/table.md) | [`userdata`](../../API/builtins/userdata.md) - - -### ObservableProperties -table<[`string`](../../API/builtins/string.md), [`ObservableTypes`](#ObservableTypes) | [`renoise.Document.DocumentList`](../../API/renoise/renoise.Document.DocumentList.md) | [`renoise.Document.DocumentNode`](../../API/renoise/renoise.Document.DocumentNode.md)> - - -### ObservableTypes -[`boolean`](../../API/builtins/boolean.md) | [`string`](../../API/builtins/string.md) | [`number`](../../API/builtins/number.md) | [`boolean`](../../API/builtins/boolean.md)[] | [`number`](../../API/builtins/number.md)[] | [`string`](../../API/builtins/string.md)[] - - - diff --git a/docs/API/renoise/renoise.Document.Observable.md b/docs/API/renoise/renoise.Document.Observable.md deleted file mode 100644 index 45070e5..0000000 --- a/docs/API/renoise/renoise.Document.Observable.md +++ /dev/null @@ -1,52 +0,0 @@ -# renoise.Document.Observable -> Track changes to document properties or general states by attaching listener -> functions to it. - - - - ---- -## Functions -### has_notifier([*self*](../../API/builtins/self.md), notifier : [`NotifierFunction`](#NotifierFunction)) -`->`[`boolean`](../../API/builtins/boolean.md) - -> Checks if the given function, method was already registered as notifier. -### add_notifier([*self*](../../API/builtins/self.md), notifier : [`NotifierFunction`](#NotifierFunction)) -> Register a function or method as a notifier, which will be called as soon as -> the observable's value changed. The passed notifier can either be a function -> or a table with a function and some context (an "object") -> method. -> #### examples: -> ```lua -> renoise.song().transport.bpm_observable:add_notifier(function() -> print("BPM changed") -> end) -> -> local my_context = { bpm_changes = 0, something_else = "bla" } -> renoise.song().transport.bpm_observable:add_notifier({ -> my_context, -> function(context) -> context.bpm_changes = context.bpm_changes + 1; -> print(("#BPM changes: %s"):format(context.bpm_changes)); -> end -> }) -> ``` -### remove_notifier([*self*](../../API/builtins/self.md), notifier : [`NotifierFunction`](#NotifierFunction) | [`NotifierMemberContext`](#NotifierMemberContext)) -> Unregister a previously registered notifier. When only passing an object, -> all notifier functions that match the given object will be removed. -> This will not fire errors when no methods for the given object are attached. -> Trying to unregister a function or method which wasn't registered, will resolve -> into an error. - - - ---- -## Aliases -### NotifierFunction -fun() - - -### NotifierMemberContext -[`table`](../../API/builtins/table.md) | [`userdata`](../../API/builtins/userdata.md) - - - diff --git a/docs/API/renoise/renoise.Document.ObservableBang.md b/docs/API/renoise/renoise.Document.ObservableBang.md deleted file mode 100644 index 38b662e..0000000 --- a/docs/API/renoise/renoise.Document.ObservableBang.md +++ /dev/null @@ -1,53 +0,0 @@ -# renoise.Document.ObservableBang -> Observable without a value which sends out notifications when "banging" it. - - - - ---- -## Functions -### has_notifier([*self*](../../API/builtins/self.md), notifier : [`NotifierFunction`](#NotifierFunction)) -`->`[`boolean`](../../API/builtins/boolean.md) - -> Checks if the given function, method was already registered as notifier. -### add_notifier([*self*](../../API/builtins/self.md), notifier : [`NotifierFunction`](#NotifierFunction)) -> Register a function or method as a notifier, which will be called as soon as -> the observable's value changed. The passed notifier can either be a function -> or a table with a function and some context (an "object") -> method. -> #### examples: -> ```lua -> renoise.song().transport.bpm_observable:add_notifier(function() -> print("BPM changed") -> end) -> -> local my_context = { bpm_changes = 0, something_else = "bla" } -> renoise.song().transport.bpm_observable:add_notifier({ -> my_context, -> function(context) -> context.bpm_changes = context.bpm_changes + 1; -> print(("#BPM changes: %s"):format(context.bpm_changes)); -> end -> }) -> ``` -### remove_notifier([*self*](../../API/builtins/self.md), notifier : [`NotifierFunction`](#NotifierFunction) | [`NotifierMemberContext`](#NotifierMemberContext)) -> Unregister a previously registered notifier. When only passing an object, -> all notifier functions that match the given object will be removed. -> This will not fire errors when no methods for the given object are attached. -> Trying to unregister a function or method which wasn't registered, will resolve -> into an error. -### bang([*self*](../../API/builtins/self.md)) -> fire a notification, calling all registered notifiers. - - - ---- -## Aliases -### NotifierFunction -fun() - - -### NotifierMemberContext -[`table`](../../API/builtins/table.md) | [`userdata`](../../API/builtins/userdata.md) - - - diff --git a/docs/API/renoise/renoise.Document.ObservableBoolean.md b/docs/API/renoise/renoise.Document.ObservableBoolean.md deleted file mode 100644 index da70a0b..0000000 --- a/docs/API/renoise/renoise.Document.ObservableBoolean.md +++ /dev/null @@ -1,66 +0,0 @@ -# renoise.Document.ObservableBoolean - - - - ---- -## Properties -### value : [`boolean`](../../API/builtins/boolean.md) -> Read/write access to the value of an observable. - - - ---- -## Functions -### has_notifier([*self*](../../API/builtins/self.md), notifier : [`NotifierFunction`](#NotifierFunction)) -`->`[`boolean`](../../API/builtins/boolean.md) - -> Checks if the given function, method was already registered as notifier. -### add_notifier([*self*](../../API/builtins/self.md), notifier : [`NotifierFunction`](#NotifierFunction)) -> Register a function or method as a notifier, which will be called as soon as -> the observable's value changed. The passed notifier can either be a function -> or a table with a function and some context (an "object") -> method. -> #### examples: -> ```lua -> renoise.song().transport.bpm_observable:add_notifier(function() -> print("BPM changed") -> end) -> -> local my_context = { bpm_changes = 0, something_else = "bla" } -> renoise.song().transport.bpm_observable:add_notifier({ -> my_context, -> function(context) -> context.bpm_changes = context.bpm_changes + 1; -> print(("#BPM changes: %s"):format(context.bpm_changes)); -> end -> }) -> ``` -### remove_notifier([*self*](../../API/builtins/self.md), notifier : [`NotifierFunction`](#NotifierFunction) | [`NotifierMemberContext`](#NotifierMemberContext)) -> Unregister a previously registered notifier. When only passing an object, -> all notifier functions that match the given object will be removed. -> This will not fire errors when no methods for the given object are attached. -> Trying to unregister a function or method which wasn't registered, will resolve -> into an error. -### to_string([*self*](../../API/builtins/self.md)) -`->`[`string`](../../API/builtins/string.md) - -> Serialize an object to a string. -### from_string([*self*](../../API/builtins/self.md), string : [`any`](../../API/builtins/any.md)) -`->`[`string`](../../API/builtins/string.md) - -> Assign the object's value from a string - when possible. Errors are -> silently ignored. - - - ---- -## Aliases -### NotifierFunction -fun() - - -### NotifierMemberContext -[`table`](../../API/builtins/table.md) | [`userdata`](../../API/builtins/userdata.md) - - - diff --git a/docs/API/renoise/renoise.Document.ObservableBooleanList.md b/docs/API/renoise/renoise.Document.ObservableBooleanList.md deleted file mode 100644 index 2e1e1b9..0000000 --- a/docs/API/renoise/renoise.Document.ObservableBooleanList.md +++ /dev/null @@ -1,84 +0,0 @@ -# renoise.Document.ObservableBooleanList -> A observable list of boolean values. - - - - ---- -## Functions -### to_string([*self*](../../API/builtins/self.md)) -`->`[`string`](../../API/builtins/string.md) - -> Serialize an object to a string. -### from_string([*self*](../../API/builtins/self.md), string : [`any`](../../API/builtins/any.md)) -`->`[`string`](../../API/builtins/string.md) - -> Assign the object's value from a string - when possible. Errors are -> silently ignored. -### size([*self*](../../API/builtins/self.md)) -`->`[`integer`](../../API/builtins/integer.md) - -> Returns the number of entries of the list. -### has_notifier([*self*](../../API/builtins/self.md), notifier : [`ListNotifierFunction`](#ListNotifierFunction)) -> Checks if the given function, method was already registered as notifier. -### add_notifier([*self*](../../API/builtins/self.md), notifier : [`ListNotifierFunction`](#ListNotifierFunction)) -> Register a function or method as a notifier, which will be called as soon as -> the observable lists layout changed. The passed notifier can either be a function -> or a table with a function and some context (an "object") -> method. -### remove_notifier([*self*](../../API/builtins/self.md), notifier : [`ListNotifierFunction`](#ListNotifierFunction) | [`ListNotifierMemberContext`](#ListNotifierMemberContext)) -> Unregister a previously registered list notifier. When only passing an object, -> all notifier functions that match the given object will be removed. -> This will not fire errors when no methods for the given object are attached. -> Trying to unregister a function or method which wasn't registered, will resolve -> into an error. -### property([*self*](../../API/builtins/self.md), index : [`integer`](../../API/builtins/integer.md)) -`->`[`renoise.Document.ObservableBoolean`](../../API/renoise/renoise.Document.ObservableBoolean.md)[`?`](../../API/builtins/nil.md) - -> List item access by index. returns nil for non existing items. -### find([*self*](../../API/builtins/self.md), start_pos : [`integer`](../../API/builtins/integer.md), value : [`boolean`](../../API/builtins/boolean.md)) -`->`[`integer`](../../API/builtins/integer.md)[`?`](../../API/builtins/nil.md) - -> Find a value in the list by comparing the list values with the passed -> value. The first successful match is returned. When no match is found, nil -> is returned. -### insert([*self*](../../API/builtins/self.md), pos : [`integer`](../../API/builtins/integer.md), value : [`boolean`](../../API/builtins/boolean.md)) -`->`[`renoise.Document.ObservableBoolean`](../../API/renoise/renoise.Document.ObservableBoolean.md) - -> Insert a new item to the end of the list when no position is specified, or -> at the specified position. Returns the newly created and inserted Observable. -### remove([*self*](../../API/builtins/self.md), pos : [`integer`](../../API/builtins/integer.md)) -> Removes an item (or the last one if no index is specified) from the list. -### swap([*self*](../../API/builtins/self.md), pos1 : [`integer`](../../API/builtins/integer.md), pos2 : [`integer`](../../API/builtins/integer.md)) -> Swaps the positions of two items without adding/removing the items. -> -> With a series of swaps you can move the item from/to any position. - - - ---- -## Aliases -### ListElementAdded -{ index : [`integer`](../../API/builtins/integer.md), type : `"insert"` } - - -### ListElementChange -[`ListElementAdded`](#ListElementAdded) | [`ListElementRemoved`](#ListElementRemoved) | [`ListElementsSwapped`](#ListElementsSwapped) - - -### ListElementRemoved -{ index : [`integer`](../../API/builtins/integer.md), type : `"remove"` } - - -### ListElementsSwapped -{ index1 : [`integer`](../../API/builtins/integer.md), index2 : [`integer`](../../API/builtins/integer.md), type : `"swap"` } - - -### ListNotifierFunction -(change : [`ListElementChange`](#ListElementChange)) - - -### ListNotifierMemberContext -[`table`](../../API/builtins/table.md) | [`userdata`](../../API/builtins/userdata.md) - - - diff --git a/docs/API/renoise/renoise.Document.ObservableList.md b/docs/API/renoise/renoise.Document.ObservableList.md deleted file mode 100644 index 7f54e22..0000000 --- a/docs/API/renoise/renoise.Document.ObservableList.md +++ /dev/null @@ -1,56 +0,0 @@ -# renoise.Document.ObservableList -> Track changes to document lists by attaching listener functions to it. -> NB: Notifiers will not broadcast changes made to list items, but only changes -> to the lists **layout** (items got added, removed, swapped). - - - - ---- -## Functions -### size([*self*](../../API/builtins/self.md)) -`->`[`integer`](../../API/builtins/integer.md) - -> Returns the number of entries of the list. -### has_notifier([*self*](../../API/builtins/self.md), notifier : [`ListNotifierFunction`](#ListNotifierFunction)) -> Checks if the given function, method was already registered as notifier. -### add_notifier([*self*](../../API/builtins/self.md), notifier : [`ListNotifierFunction`](#ListNotifierFunction)) -> Register a function or method as a notifier, which will be called as soon as -> the observable lists layout changed. The passed notifier can either be a function -> or a table with a function and some context (an "object") -> method. -### remove_notifier([*self*](../../API/builtins/self.md), notifier : [`ListNotifierFunction`](#ListNotifierFunction) | [`ListNotifierMemberContext`](#ListNotifierMemberContext)) -> Unregister a previously registered list notifier. When only passing an object, -> all notifier functions that match the given object will be removed. -> This will not fire errors when no methods for the given object are attached. -> Trying to unregister a function or method which wasn't registered, will resolve -> into an error. - - - ---- -## Aliases -### ListElementAdded -{ index : [`integer`](../../API/builtins/integer.md), type : `"insert"` } - - -### ListElementChange -[`ListElementAdded`](#ListElementAdded) | [`ListElementRemoved`](#ListElementRemoved) | [`ListElementsSwapped`](#ListElementsSwapped) - - -### ListElementRemoved -{ index : [`integer`](../../API/builtins/integer.md), type : `"remove"` } - - -### ListElementsSwapped -{ index1 : [`integer`](../../API/builtins/integer.md), index2 : [`integer`](../../API/builtins/integer.md), type : `"swap"` } - - -### ListNotifierFunction -(change : [`ListElementChange`](#ListElementChange)) - - -### ListNotifierMemberContext -[`table`](../../API/builtins/table.md) | [`userdata`](../../API/builtins/userdata.md) - - - diff --git a/docs/API/renoise/renoise.Document.ObservableNumber.md b/docs/API/renoise/renoise.Document.ObservableNumber.md deleted file mode 100644 index 995ab37..0000000 --- a/docs/API/renoise/renoise.Document.ObservableNumber.md +++ /dev/null @@ -1,66 +0,0 @@ -# renoise.Document.ObservableNumber - - - - ---- -## Properties -### value : [`number`](../../API/builtins/number.md) -> Read/write access to the value of an Observable. - - - ---- -## Functions -### has_notifier([*self*](../../API/builtins/self.md), notifier : [`NotifierFunction`](#NotifierFunction)) -`->`[`boolean`](../../API/builtins/boolean.md) - -> Checks if the given function, method was already registered as notifier. -### add_notifier([*self*](../../API/builtins/self.md), notifier : [`NotifierFunction`](#NotifierFunction)) -> Register a function or method as a notifier, which will be called as soon as -> the observable's value changed. The passed notifier can either be a function -> or a table with a function and some context (an "object") -> method. -> #### examples: -> ```lua -> renoise.song().transport.bpm_observable:add_notifier(function() -> print("BPM changed") -> end) -> -> local my_context = { bpm_changes = 0, something_else = "bla" } -> renoise.song().transport.bpm_observable:add_notifier({ -> my_context, -> function(context) -> context.bpm_changes = context.bpm_changes + 1; -> print(("#BPM changes: %s"):format(context.bpm_changes)); -> end -> }) -> ``` -### remove_notifier([*self*](../../API/builtins/self.md), notifier : [`NotifierFunction`](#NotifierFunction) | [`NotifierMemberContext`](#NotifierMemberContext)) -> Unregister a previously registered notifier. When only passing an object, -> all notifier functions that match the given object will be removed. -> This will not fire errors when no methods for the given object are attached. -> Trying to unregister a function or method which wasn't registered, will resolve -> into an error. -### to_string([*self*](../../API/builtins/self.md)) -`->`[`string`](../../API/builtins/string.md) - -> Serialize an object to a string. -### from_string([*self*](../../API/builtins/self.md), string : [`any`](../../API/builtins/any.md)) -`->`[`string`](../../API/builtins/string.md) - -> Assign the object's value from a string - when possible. Errors are -> silently ignored. - - - ---- -## Aliases -### NotifierFunction -fun() - - -### NotifierMemberContext -[`table`](../../API/builtins/table.md) | [`userdata`](../../API/builtins/userdata.md) - - - diff --git a/docs/API/renoise/renoise.Document.ObservableNumberList.md b/docs/API/renoise/renoise.Document.ObservableNumberList.md deleted file mode 100644 index b701430..0000000 --- a/docs/API/renoise/renoise.Document.ObservableNumberList.md +++ /dev/null @@ -1,83 +0,0 @@ -# renoise.Document.ObservableNumberList -> A observable list of number values. - - - - ---- -## Functions -### to_string([*self*](../../API/builtins/self.md)) -`->`[`string`](../../API/builtins/string.md) - -> Serialize an object to a string. -### from_string([*self*](../../API/builtins/self.md), string : [`any`](../../API/builtins/any.md)) -`->`[`string`](../../API/builtins/string.md) - -> Assign the object's value from a string - when possible. Errors are -> silently ignored. -### size([*self*](../../API/builtins/self.md)) -`->`[`integer`](../../API/builtins/integer.md) - -> Returns the number of entries of the list. -### has_notifier([*self*](../../API/builtins/self.md), notifier : [`ListNotifierFunction`](#ListNotifierFunction)) -> Checks if the given function, method was already registered as notifier. -### add_notifier([*self*](../../API/builtins/self.md), notifier : [`ListNotifierFunction`](#ListNotifierFunction)) -> Register a function or method as a notifier, which will be called as soon as -> the observable lists layout changed. The passed notifier can either be a function -> or a table with a function and some context (an "object") -> method. -### remove_notifier([*self*](../../API/builtins/self.md), notifier : [`ListNotifierFunction`](#ListNotifierFunction) | [`ListNotifierMemberContext`](#ListNotifierMemberContext)) -> Unregister a previously registered list notifier. When only passing an object, -> all notifier functions that match the given object will be removed. -> This will not fire errors when no methods for the given object are attached. -> Trying to unregister a function or method which wasn't registered, will resolve -> into an error. -### property([*self*](../../API/builtins/self.md), index : [`integer`](../../API/builtins/integer.md)) -`->`[`renoise.Document.ObservableNumber`](../../API/renoise/renoise.Document.ObservableNumber.md)[`?`](../../API/builtins/nil.md) - -> List item access by index. returns nil for non existing items. -### find([*self*](../../API/builtins/self.md), start_pos : [`integer`](../../API/builtins/integer.md), value : [`number`](../../API/builtins/number.md)) -`->`[`integer`](../../API/builtins/integer.md)[`?`](../../API/builtins/nil.md) - -> Find a value in the list by comparing the list values with the passed -> value. The first successful match is returned. When no match is found, nil -> is returned. -### insert([*self*](../../API/builtins/self.md), pos : [`integer`](../../API/builtins/integer.md), value : [`number`](../../API/builtins/number.md)) -`->`[`renoise.Document.ObservableNumber`](../../API/renoise/renoise.Document.ObservableNumber.md) - -> Insert a new item to the end of the list when no position is specified, or -> at the specified position. Returns the newly created and inserted Observable. -### remove([*self*](../../API/builtins/self.md), pos : [`integer`](../../API/builtins/integer.md)) -> Removes an item (or the last one if no index is specified) from the list. -### swap([*self*](../../API/builtins/self.md), pos1 : [`integer`](../../API/builtins/integer.md), pos2 : [`integer`](../../API/builtins/integer.md)) -> Swaps the positions of two items without adding/removing the items. -> With a series of swaps you can move the item from/to any position. - - - ---- -## Aliases -### ListElementAdded -{ index : [`integer`](../../API/builtins/integer.md), type : `"insert"` } - - -### ListElementChange -[`ListElementAdded`](#ListElementAdded) | [`ListElementRemoved`](#ListElementRemoved) | [`ListElementsSwapped`](#ListElementsSwapped) - - -### ListElementRemoved -{ index : [`integer`](../../API/builtins/integer.md), type : `"remove"` } - - -### ListElementsSwapped -{ index1 : [`integer`](../../API/builtins/integer.md), index2 : [`integer`](../../API/builtins/integer.md), type : `"swap"` } - - -### ListNotifierFunction -(change : [`ListElementChange`](#ListElementChange)) - - -### ListNotifierMemberContext -[`table`](../../API/builtins/table.md) | [`userdata`](../../API/builtins/userdata.md) - - - diff --git a/docs/API/renoise/renoise.Document.ObservableString.md b/docs/API/renoise/renoise.Document.ObservableString.md deleted file mode 100644 index a40cf37..0000000 --- a/docs/API/renoise/renoise.Document.ObservableString.md +++ /dev/null @@ -1,66 +0,0 @@ -# renoise.Document.ObservableString - - - - ---- -## Properties -### value : [`string`](../../API/builtins/string.md) -> Read/write access to the value of an Observable. - - - ---- -## Functions -### has_notifier([*self*](../../API/builtins/self.md), notifier : [`NotifierFunction`](#NotifierFunction)) -`->`[`boolean`](../../API/builtins/boolean.md) - -> Checks if the given function, method was already registered as notifier. -### add_notifier([*self*](../../API/builtins/self.md), notifier : [`NotifierFunction`](#NotifierFunction)) -> Register a function or method as a notifier, which will be called as soon as -> the observable's value changed. The passed notifier can either be a function -> or a table with a function and some context (an "object") -> method. -> #### examples: -> ```lua -> renoise.song().transport.bpm_observable:add_notifier(function() -> print("BPM changed") -> end) -> -> local my_context = { bpm_changes = 0, something_else = "bla" } -> renoise.song().transport.bpm_observable:add_notifier({ -> my_context, -> function(context) -> context.bpm_changes = context.bpm_changes + 1; -> print(("#BPM changes: %s"):format(context.bpm_changes)); -> end -> }) -> ``` -### remove_notifier([*self*](../../API/builtins/self.md), notifier : [`NotifierFunction`](#NotifierFunction) | [`NotifierMemberContext`](#NotifierMemberContext)) -> Unregister a previously registered notifier. When only passing an object, -> all notifier functions that match the given object will be removed. -> This will not fire errors when no methods for the given object are attached. -> Trying to unregister a function or method which wasn't registered, will resolve -> into an error. -### to_string([*self*](../../API/builtins/self.md)) -`->`[`string`](../../API/builtins/string.md) - -> Serialize an object to a string. -### from_string([*self*](../../API/builtins/self.md), string : [`any`](../../API/builtins/any.md)) -`->`[`string`](../../API/builtins/string.md) - -> Assign the object's value from a string - when possible. Errors are -> silently ignored. - - - ---- -## Aliases -### NotifierFunction -fun() - - -### NotifierMemberContext -[`table`](../../API/builtins/table.md) | [`userdata`](../../API/builtins/userdata.md) - - - diff --git a/docs/API/renoise/renoise.Document.ObservableStringList.md b/docs/API/renoise/renoise.Document.ObservableStringList.md deleted file mode 100644 index 0fac90c..0000000 --- a/docs/API/renoise/renoise.Document.ObservableStringList.md +++ /dev/null @@ -1,83 +0,0 @@ -# renoise.Document.ObservableStringList -> A observable list of string values. - - - - ---- -## Functions -### to_string([*self*](../../API/builtins/self.md)) -`->`[`string`](../../API/builtins/string.md) - -> Serialize an object to a string. -### from_string([*self*](../../API/builtins/self.md), string : [`any`](../../API/builtins/any.md)) -`->`[`string`](../../API/builtins/string.md) - -> Assign the object's value from a string - when possible. Errors are -> silently ignored. -### size([*self*](../../API/builtins/self.md)) -`->`[`integer`](../../API/builtins/integer.md) - -> Returns the number of entries of the list. -### has_notifier([*self*](../../API/builtins/self.md), notifier : [`ListNotifierFunction`](#ListNotifierFunction)) -> Checks if the given function, method was already registered as notifier. -### add_notifier([*self*](../../API/builtins/self.md), notifier : [`ListNotifierFunction`](#ListNotifierFunction)) -> Register a function or method as a notifier, which will be called as soon as -> the observable lists layout changed. The passed notifier can either be a function -> or a table with a function and some context (an "object") -> method. -### remove_notifier([*self*](../../API/builtins/self.md), notifier : [`ListNotifierFunction`](#ListNotifierFunction) | [`ListNotifierMemberContext`](#ListNotifierMemberContext)) -> Unregister a previously registered list notifier. When only passing an object, -> all notifier functions that match the given object will be removed. -> This will not fire errors when no methods for the given object are attached. -> Trying to unregister a function or method which wasn't registered, will resolve -> into an error. -### property([*self*](../../API/builtins/self.md), index : [`integer`](../../API/builtins/integer.md)) -`->`[`renoise.Document.ObservableString`](../../API/renoise/renoise.Document.ObservableString.md)[`?`](../../API/builtins/nil.md) - -> List item access by index. returns nil for non existing items. -### find([*self*](../../API/builtins/self.md), start_pos : [`integer`](../../API/builtins/integer.md), value : [`number`](../../API/builtins/number.md)) -`->`[`integer`](../../API/builtins/integer.md)[`?`](../../API/builtins/nil.md) - -> Find a value in the list by comparing the list values with the passed -> value. The first successful match is returned. When no match is found, nil -> is returned. -### insert([*self*](../../API/builtins/self.md), pos : [`integer`](../../API/builtins/integer.md), value : [`number`](../../API/builtins/number.md)) -`->`[`renoise.Document.ObservableString`](../../API/renoise/renoise.Document.ObservableString.md) - -> Insert a new item to the end of the list when no position is specified, or -> at the specified position. Returns the newly created and inserted Observable. -### remove([*self*](../../API/builtins/self.md), pos : [`integer`](../../API/builtins/integer.md)) -> Removes an item (or the last one if no index is specified) from the list. -### swap([*self*](../../API/builtins/self.md), pos1 : [`integer`](../../API/builtins/integer.md), pos2 : [`integer`](../../API/builtins/integer.md)) -> Swaps the positions of two items without adding/removing the items. -> With a series of swaps you can move the item from/to any position. - - - ---- -## Aliases -### ListElementAdded -{ index : [`integer`](../../API/builtins/integer.md), type : `"insert"` } - - -### ListElementChange -[`ListElementAdded`](#ListElementAdded) | [`ListElementRemoved`](#ListElementRemoved) | [`ListElementsSwapped`](#ListElementsSwapped) - - -### ListElementRemoved -{ index : [`integer`](../../API/builtins/integer.md), type : `"remove"` } - - -### ListElementsSwapped -{ index1 : [`integer`](../../API/builtins/integer.md), index2 : [`integer`](../../API/builtins/integer.md), type : `"swap"` } - - -### ListNotifierFunction -(change : [`ListElementChange`](#ListElementChange)) - - -### ListNotifierMemberContext -[`table`](../../API/builtins/table.md) | [`userdata`](../../API/builtins/userdata.md) - - - diff --git a/docs/API/renoise/renoise.Document.Serializable.md b/docs/API/renoise/renoise.Document.Serializable.md deleted file mode 100644 index 7f65344..0000000 --- a/docs/API/renoise/renoise.Document.Serializable.md +++ /dev/null @@ -1,17 +0,0 @@ -# renoise.Document.Serializable - - - - ---- -## Functions -### to_string([*self*](../../API/builtins/self.md)) -`->`[`string`](../../API/builtins/string.md) - -> Serialize an object to a string. -### from_string([*self*](../../API/builtins/self.md), string : [`any`](../../API/builtins/any.md)) -`->`[`string`](../../API/builtins/string.md) - -> Assign the object's value from a string - when possible. Errors are -> silently ignored. - diff --git a/docs/API/renoise/renoise.Document.md b/docs/API/renoise/renoise.Document.md deleted file mode 100644 index ce573f3..0000000 --- a/docs/API/renoise/renoise.Document.md +++ /dev/null @@ -1,169 +0,0 @@ -# renoise.Document -> renoise.Document classes are wrappers for Renoise's internal document -> classes. -> -> **Please note**: the Lua wrappers are not really "the Lua way" of solving and -> expressing things. e.g: there's no support for mixed types in lists, tuples -> at the moment. -> -> Documents can be serialized from/to XML, just like Renoise's internal -> document and are observable. -> -> An empty document (node) object can be created via -> ```renoise.Document.create("MyDoc"){}``` -> -> Such document objects can then be extended with the document's -> `add_property` function. Existing properties can also be removed again with the -> `remove_property` function. -> -> #### examples: -> ```lua -> -- Creates an empty document, using "MyDoc" as the model name (a type name) -> local my_document = renoise.Document.create("MyDoc"){ } -> -- adds a number to the document with the initial value 1 -> my_document:add_property("value1", 1) -> -- adds a string -> my_document:add_property("value2", "bla") -> -- create another document and adds it -> local node = renoise.Document.create("MySubDoc"){ } -> node:add_property("another_value", 1) -> -- add another already existing node -> my_document:add_property("nested_node", node) -> -- removes a previously added node -> my_document:remove_property(node) -> -- access properties -> local value1 = my_document.value1 -> value1 = my_document:property("value1") -> ``` -> As an alternative to `renoise.Document.create`, you can also inherit from -> renoise.Document.DocumentNode in order to create your own document classes. -> This is especially recommended when dealing with more complex docs, because -> you can also use additional methods to deal with your properties, the data. -> -> #### examples: -> ```lua -> class "MyDocument" (renoise.Document.DocumentNode) -> function MyDocument:__init() -> -- important! call super first -> renoise.Document.DocumentNode.__init(self) -> -- add properties to construct the document model -> self:add_property("age", 1) -> self:add_property("name", renoise.Document.ObservableString("value")) -> -- other doc renoise.Document.DocumentNode object -> self:add_property("sub_node", MySubNode()) -> -- list of renoise.Document.DocumentNode objects -> self:add_property("doc_list", renoise.Document.DocumentList()) -> -- or the create() way: -> self:add_properties { -> something = "else" -> } -> end -> ``` -> Instantiating such custom document objects can then be done by simply -> calling the constructor: -> ```lua -> my_document = MyDocument() -> -- do something with my_document, load/save, add/remove more properties -> ``` - - - - ---- -## Functions -### create(model_name : [`string`](../../API/builtins/string.md)) -`->`(properties : [`ObservableProperties`](#ObservableProperties)) `->` [`renoise.Document.DocumentNode`](../../API/renoise/renoise.Document.DocumentNode.md) - -> Create an empty DocumentNode or a DocumentNode that is modeled after the -> passed key value table. "model_name" will be used to identify the documents -> type when loading/saving. It also allows you to instantiate new document -> objects (see renoise.Document.instantiate). -> -> #### examples: -> ```lua -> my_document = renoise.Document.create("MyDoc") { -> age = 1, -> name = "bla", -- implicitly specify a property type -> is_valid = renoise.Document.ObservableBoolean(false), -- or explicitly -> age_list = {1, 2, 3}, -> another_list = renoise.Document.ObservableNumberList(), -> sub_node = { -> sub_value1 = 2, -> sub_value2 = "bla2" -> } -> } -> ``` -> This will create a document node which is !modeled! after the the passed table. -> The table is not used internally by the document after construction, and will -> only be referenced to construct new instances. Also note that you need to assign -> values for all passed table properties in order to automatically determine it's -> type, or specify the types explicitly -> renoise.Document.ObservableXXX(). -> -> The passed name ("MyDoc" in the example above) is used to identify the document -> when loading/saving it (loading a XML file which was saved with a different -> model will fail) and to generally specify the "type". -> -> Additionally, once "create" is called, you can use the specified model name to -> create new instances. -> -> #### examples: -> ```lua -> -- create a new instance of "MyDoc" -> my_other_document = renoise.Document.instantiate("MyDoc") -> ``` -### instantiate(model_name : [`string`](../../API/builtins/string.md)) -`->`[`renoise.Document.DocumentNode`](../../API/renoise/renoise.Document.DocumentNode.md) - -> Create a new instance of the given document model. Given `model_name` must -> have been registered with `renoise.Document.create` before. - - - ---- -## Aliases -### DocumentMember -[`renoise.Document.DocumentList`](../../API/renoise/renoise.Document.DocumentList.md) | [`renoise.Document.DocumentNode`](../../API/renoise/renoise.Document.DocumentNode.md) | [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) | [`renoise.Document.ObservableList`](../../API/renoise/renoise.Document.ObservableList.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### ListElementAdded -{ index : [`integer`](../../API/builtins/integer.md), type : `"insert"` } - - -### ListElementChange -[`ListElementAdded`](#ListElementAdded) | [`ListElementRemoved`](#ListElementRemoved) | [`ListElementsSwapped`](#ListElementsSwapped) - - -### ListElementRemoved -{ index : [`integer`](../../API/builtins/integer.md), type : `"remove"` } - - -### ListElementsSwapped -{ index1 : [`integer`](../../API/builtins/integer.md), index2 : [`integer`](../../API/builtins/integer.md), type : `"swap"` } - - -### ListNotifierFunction -(change : [`ListElementChange`](#ListElementChange)) - - -### ListNotifierMemberContext -[`table`](../../API/builtins/table.md) | [`userdata`](../../API/builtins/userdata.md) - - -### NotifierFunction -fun() - - -### NotifierMemberContext -[`table`](../../API/builtins/table.md) | [`userdata`](../../API/builtins/userdata.md) - - -### ObservableProperties -table<[`string`](../../API/builtins/string.md), [`ObservableTypes`](#ObservableTypes) | [`renoise.Document.DocumentList`](../../API/renoise/renoise.Document.DocumentList.md) | [`renoise.Document.DocumentNode`](../../API/renoise/renoise.Document.DocumentNode.md)> - - -### ObservableTypes -[`boolean`](../../API/builtins/boolean.md) | [`string`](../../API/builtins/string.md) | [`number`](../../API/builtins/number.md) | [`boolean`](../../API/builtins/boolean.md)[] | [`number`](../../API/builtins/number.md)[] | [`string`](../../API/builtins/string.md)[] - - - diff --git a/docs/API/renoise/renoise.EffectColumn.md b/docs/API/renoise/renoise.EffectColumn.md deleted file mode 100644 index 3cbdeda..0000000 --- a/docs/API/renoise/renoise.EffectColumn.md +++ /dev/null @@ -1,39 +0,0 @@ -# renoise.EffectColumn -> A single effect column in a pattern line. -> -> Access effect column properties either by values (numbers) or by strings. -> The string representation uses exactly the same notation as you see -> them in Renoise's pattern or phrase editor. - - - - ---- -## Properties -### is_empty : [`boolean`](../../API/builtins/boolean.md) -> **READ-ONLY** True, when all effect column properties are empty. - -### is_selected : [`boolean`](../../API/builtins/boolean.md) -> **READ-ONLY** True, when this column is selected in the pattern or phrase editor. - -### number_value : [`integer`](../../API/builtins/integer.md) -> 0-65535 in the form 0x0000xxyy where xx=effect char 1 and yy=effect char 2 - -### number_string : [`string`](../../API/builtins/string.md) -> Range: ('00' - 'ZZ') - -### amount_value : [`integer`](../../API/builtins/integer.md) -> Range: (0 - 255) - -### amount_string : [`string`](../../API/builtins/string.md) -> Range: ('00' - 'FF') - - - ---- -## Functions -### clear([*self*](../../API/builtins/self.md)) -> Clear the effect column. -### copy_from([*self*](../../API/builtins/self.md), other : [`renoise.EffectColumn`](../../API/renoise/renoise.EffectColumn.md)) -> Copy the column's content from another column. - diff --git a/docs/API/renoise/renoise.GroupTrack.md b/docs/API/renoise/renoise.GroupTrack.md deleted file mode 100644 index 82f89fe..0000000 --- a/docs/API/renoise/renoise.GroupTrack.md +++ /dev/null @@ -1,243 +0,0 @@ -# renoise.GroupTrack -> Group track component of a Renoise song. - - - - ---- -## Properties -### type : [`renoise.Track.TrackType`](renoise.Track.md#TrackType) -> **READ-ONLY** - -### name : [`string`](../../API/builtins/string.md) -> Name, as visible in track headers - -### name_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### color : [`RGBColor`](#RGBColor) -> A table of 3 bytes (ranging from 0 to 255) -> representing the red, green and blue channels of a color. -> {0xFF, 0xFF, 0xFF} is white -> {165, 73, 35} is the red from the Renoise logo - -### color_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### color_blend : [`integer`](../../API/builtins/integer.md) -> Range: (0 - 100) Color blend in percent - -### color_blend_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### mute_state : [`renoise.Track.MuteState`](renoise.Track.md#MuteState) -> Mute and solo states. Not available for the master track. - -### mute_state_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### solo_state : [`boolean`](../../API/builtins/boolean.md) -### solo_state_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### prefx_volume : [`renoise.DeviceParameter`](../../API/renoise/renoise.DeviceParameter.md) -> **READ-ONLY** - -### prefx_panning : [`renoise.DeviceParameter`](../../API/renoise/renoise.DeviceParameter.md) -> **READ-ONLY** - -### prefx_width : [`renoise.DeviceParameter`](../../API/renoise/renoise.DeviceParameter.md) -> **READ-ONLY** - -### postfx_volume : [`renoise.DeviceParameter`](../../API/renoise/renoise.DeviceParameter.md) -> **READ-ONLY** - -### postfx_panning : [`renoise.DeviceParameter`](../../API/renoise/renoise.DeviceParameter.md) -> **READ-ONLY** - -### collapsed : [`boolean`](../../API/builtins/boolean.md) -> Collapsed/expanded visual appearance. - -### collapsed_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### group_parent : [`renoise.GroupTrack`](../../API/renoise/renoise.GroupTrack.md) -> **READ-ONLY** - -### available_output_routings : [`string`](../../API/builtins/string.md)[] -> **READ-ONLY** - -### output_routing : [`string`](../../API/builtins/string.md) -> One of `available_output_routings` - -### output_routing_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### output_delay : [`number`](../../API/builtins/number.md) -> Range: (-100.0-100.0) in ms - -### output_delay_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### max_effect_columns : [`integer`](../../API/builtins/integer.md) -> **READ-ONLY** 8 OR 0 depending on the track type - -### min_effect_columns : [`integer`](../../API/builtins/integer.md) -> **READ-ONLY** 1 OR 0 depending on the track type - -### max_note_columns : [`integer`](../../API/builtins/integer.md) -> **READ-ONLY** 12 OR 0 depending on the track type - -### min_note_columns : [`integer`](../../API/builtins/integer.md) -> **READ-ONLY** 1 OR 0 depending on the track type - -### visible_effect_columns : [`integer`](../../API/builtins/integer.md) -> 1-8 OR 0-8, depending on the track type - -### visible_effect_columns_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### visible_note_columns : [`integer`](../../API/builtins/integer.md) -> 0 OR 1-12, depending on the track type - -### visible_note_columns_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### volume_column_visible : [`boolean`](../../API/builtins/boolean.md) -### volume_column_visible_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### panning_column_visible : [`boolean`](../../API/builtins/boolean.md) -### panning_column_visible_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### delay_column_visible : [`boolean`](../../API/builtins/boolean.md) -### delay_column_visible_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### sample_effects_column_visible : [`boolean`](../../API/builtins/boolean.md) -### sample_effects_column_visible_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### available_devices : [`string`](../../API/builtins/string.md)[] -> **READ-ONLY** FX devices this track can handle. - -### available_device_infos : [`AudioDeviceInfo`](#audiodeviceinfo)[] -> **READ-ONLY** Array of tables containing information about the devices. - -### devices : [`renoise.AudioDevice`](../../API/renoise/renoise.AudioDevice.md)[] -> **READ-ONLY** List of audio DSP FX. - -### devices_observable : [`renoise.Document.ObservableList`](../../API/renoise/renoise.Document.ObservableList.md) -> Track changes to document lists by attaching listener functions to it. -> NB: Notifiers will not broadcast changes made to list items, but only changes -> to the lists **layout** (items got added, removed, swapped). - -### members : [`renoise.Track`](../../API/renoise/renoise.Track.md)[] -> **READ-ONLY** All member tracks of this group, including subgroups and -> their tracks. - -### group_collapsed : [`boolean`](../../API/builtins/boolean.md) -> Collapsed/expanded visual appearance of whole group. - - - ---- -## Functions -### insert_device_at([*self*](../../API/builtins/self.md), device_path : [`string`](../../API/builtins/string.md), device_index : [`integer`](../../API/builtins/integer.md)) -`->`[`renoise.AudioDevice`](../../API/renoise/renoise.AudioDevice.md) - -> Insert a new device at the given position. `device_path` must be one of -> `renoise.Track.available_devices`. -### delete_device_at([*self*](../../API/builtins/self.md), device_index : [`any`](../../API/builtins/any.md)) -> Delete an existing device in a track. The mixer device at index 1 can not -> be deleted from any track. -### swap_devices_at([*self*](../../API/builtins/self.md), device_index1 : [`integer`](../../API/builtins/integer.md), device_index2 : [`integer`](../../API/builtins/integer.md)) -> Swap the positions of two devices in the device chain. The mixer device at -> index 1 can not be swapped or moved. -### device([*self*](../../API/builtins/self.md), device_index : [`integer`](../../API/builtins/integer.md)) -`->`[`renoise.AudioDevice`](../../API/renoise/renoise.AudioDevice.md) - -> Access to a single device by index. Use property `devices` to iterate -> over all devices and to query the device count. -### mute([*self*](../../API/builtins/self.md)) -> Uses default mute state from the prefs. Not for the master track. -### unmute([*self*](../../API/builtins/self.md)) -### solo([*self*](../../API/builtins/self.md)) -### column_is_muted([*self*](../../API/builtins/self.md), column_index : [`integer`](../../API/builtins/integer.md)) -`->`[`boolean`](../../API/builtins/boolean.md) - -> Note column mutes. Only valid within (1-track.max_note_columns) -### column_is_muted_observable([*self*](../../API/builtins/self.md), column_index : [`integer`](../../API/builtins/integer.md)) -`->`[`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) - -### set_column_is_muted([*self*](../../API/builtins/self.md), column_index : [`integer`](../../API/builtins/integer.md), muted : [`boolean`](../../API/builtins/boolean.md)) -### column_name([*self*](../../API/builtins/self.md), column_index : [`integer`](../../API/builtins/integer.md)) -`->`[`string`](../../API/builtins/string.md) - -> Note column names. Only valid within (1-track.max_note_columns) -### column_name_observable([*self*](../../API/builtins/self.md), column_index : [`integer`](../../API/builtins/integer.md)) -`->`[`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) - -### set_column_name([*self*](../../API/builtins/self.md), column_index : [`integer`](../../API/builtins/integer.md), name : [`string`](../../API/builtins/string.md)) -### swap_note_columns_at([*self*](../../API/builtins/self.md), column_index1 : [`integer`](../../API/builtins/integer.md), column_index2 : [`integer`](../../API/builtins/integer.md)) -> Swap the positions of two note or effect columns within a track. -### swap_effect_columns_at([*self*](../../API/builtins/self.md), column_index1 : [`integer`](../../API/builtins/integer.md), column_index2 : [`integer`](../../API/builtins/integer.md)) - - - ---- -## Structs -# AudioDeviceInfo -> Audio device info - ---- -## Properties -### path : [`string`](../../API/builtins/string.md) -> The device's path used by `renoise.Track:insert_device_at` - -### name : [`string`](../../API/builtins/string.md) -> The device's name - -### short_name : [`string`](../../API/builtins/string.md) -> The device's name as displayed in shortened lists - -### favorite_name : [`string`](../../API/builtins/string.md) -> The device's name as displayed in favorites - -### is_favorite : [`boolean`](../../API/builtins/boolean.md) -> true if the device is a favorite - -### is_bridged : [`boolean`](../../API/builtins/boolean.md) -> true if the device is a bridged plugin - - - - - - - ---- -## Aliases -### RGBColor -{ 1 : [`integer`](../../API/builtins/integer.md), 2 : [`integer`](../../API/builtins/integer.md), 3 : [`integer`](../../API/builtins/integer.md) } -> A table of 3 bytes (ranging from 0 to 255) -> representing the red, green and blue channels of a color. -> {0xFF, 0xFF, 0xFF} is white -> {165, 73, 35} is the red from the Renoise logo - - diff --git a/docs/API/renoise/renoise.Instrument.md b/docs/API/renoise/renoise.Instrument.md deleted file mode 100644 index d4b2eb7..0000000 --- a/docs/API/renoise/renoise.Instrument.md +++ /dev/null @@ -1,296 +0,0 @@ -# renoise.Instrument - - - -## Constants -### Tab -> ```lua -> { -> TAB_SAMPLES: integer = 1, -> TAB_PLUGIN: integer = 2, -> TAB_EXT_MIDI: integer = 3, -> } -> ``` -### PhrasePlaybackMode -> ```lua -> { -> PHRASES_OFF: integer = 1, -> PHRASES_PLAY_SELECTIVE: integer = 2, -> PHRASES_PLAY_KEYMAP: integer = 3, -> } -> ``` -### Layer -> ```lua -> { -> LAYER_NOTE_DISABLED: integer = 0, -> LAYER_NOTE_ON: integer = 1, -> LAYER_NOTE_OFF: integer = 2, -> } -> ``` -### OverlapMode -> ```lua -> { -> OVERLAP_MODE_ALL: integer = 0, -> OVERLAP_MODE_CYCLED: integer = 1, -> OVERLAP_MODE_RANDOM: integer = 2, -> } -> ``` -### NUMBER_OF_MACROS : [`integer`](../../API/builtins/integer.md) -### MAX_NUMBER_OF_PHRASES : [`integer`](../../API/builtins/integer.md) - ---- -## Properties -### active_tab : [`renoise.Instrument.Tab`](renoise.Instrument.md#Tab) -> Currently active tab in the instrument GUI (samples, plugin or MIDI). - -### active_tab_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### name : [`string`](../../API/builtins/string.md) -> Instrument's name. - -### name_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### comments : [`string`](../../API/builtins/string.md)[] -> Instrument's comment list. See renoise.song().comments for more info on -> how to get notified on changes and how to change it. - -### comments_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### comments_assignment_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Notifier which is called as soon as any paragraph in the comments change. - -### show_comments_after_loading : [`boolean`](../../API/builtins/boolean.md) -> Set this to true to show the comments dialog after loading a song - -### show_comments_after_loading_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### macros_visible : [`boolean`](../../API/builtins/boolean.md) -> Macro parameter pane visibility in the GUI. - -### macros_visible_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### macros : [`renoise.InstrumentMacro`](../../API/renoise/renoise.InstrumentMacro.md)[] -> **READ-ONLY** Macro parameters. Array with size Instrument.NUMBER_OF_MACROS. - -### pitchbend_macro : [`renoise.InstrumentMacro`](../../API/renoise/renoise.InstrumentMacro.md) -> Access the MIDI pitch-bend macro - -### modulation_wheel_macro : [`renoise.InstrumentMacro`](../../API/renoise/renoise.InstrumentMacro.md) -> Access the MIDI modulation-wheel macro - -### channel_pressure_macro : [`renoise.InstrumentMacro`](../../API/renoise/renoise.InstrumentMacro.md) -> Access the MIDI channel pressure macro - -### volume : [`number`](../../API/builtins/number.md) -> Range: (0 - math.db2lin(6)) - -### volume_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### transpose : [`integer`](../../API/builtins/integer.md) -> Range: (-120 - 120). Global relative pitch in semi tones. -> Applied to all samples, MIDI and plugins in the instrument. - -### transpose_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### trigger_options : [`renoise.InstrumentTriggerOptions`](../../API/renoise/renoise.InstrumentTriggerOptions.md) -> Global trigger options (quantization and scaling options). - -### sample_mapping_overlap_mode : [`renoise.Instrument.OverlapMode`](renoise.Instrument.md#OverlapMode) -> Sample mapping's overlap trigger mode. - -### sample_mapping_overlap_mode_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### phrase_editor_visible : [`boolean`](../../API/builtins/boolean.md) -> Phrase editor pane visibility in the GUI. - -### phrase_editor_visible_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### phrase_playback_mode : [`renoise.Instrument.PhrasePlaybackMode`](renoise.Instrument.md#PhrasePlaybackMode) -> Phrase playback. - -### phrase_playback_mode_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### phrase_program : [`integer`](../../API/builtins/integer.md) -> Phrase playback program: 0 = Off, 1-126 = specific phrase, 127 = keymap. - -### phrase_program_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### phrases : [`renoise.InstrumentPhrase`](../../API/renoise/renoise.InstrumentPhrase.md)[] -> **READ-ONLY** Phrases. - -### phrases_observable : [`renoise.Document.ObservableList`](../../API/renoise/renoise.Document.ObservableList.md) -> Track changes to document lists by attaching listener functions to it. -> NB: Notifiers will not broadcast changes made to list items, but only changes -> to the lists **layout** (items got added, removed, swapped). - -### phrase_mappings : [`renoise.InstrumentPhraseMapping`](../../API/renoise/renoise.InstrumentPhraseMapping.md)[] -> **READ-ONLY** Phrase mappings. - -### phrase_mappings_observable : [`renoise.Document.ObservableList`](../../API/renoise/renoise.Document.ObservableList.md) -> Track changes to document lists by attaching listener functions to it. -> NB: Notifiers will not broadcast changes made to list items, but only changes -> to the lists **layout** (items got added, removed, swapped). - -### samples : [`renoise.Sample`](../../API/renoise/renoise.Sample.md)[] -> **READ-ONLY** Samples slots. - -### samples_observable : [`renoise.Document.ObservableList`](../../API/renoise/renoise.Document.ObservableList.md) -> Track changes to document lists by attaching listener functions to it. -> NB: Notifiers will not broadcast changes made to list items, but only changes -> to the lists **layout** (items got added, removed, swapped). - -### sample_mappings : [`renoise.SampleMapping`](../../API/renoise/renoise.SampleMapping.md)[] -> **READ-ONLY** -> Sample mappings (key/velocity to sample slot mappings). -> sample_mappings[LAYER_NOTE_ON/OFF][]. Sample mappings also can -> be accessed via ---@field samples[].sample_mapping - -### sample_mappings_observable : [`renoise.Document.ObservableList`](../../API/renoise/renoise.Document.ObservableList.md) -> Track changes to document lists by attaching listener functions to it. -> NB: Notifiers will not broadcast changes made to list items, but only changes -> to the lists **layout** (items got added, removed, swapped). - -### sample_modulation_sets : [`renoise.SampleModulationSet`](../../API/renoise/renoise.SampleModulationSet.md)[] -> **READ-ONLY** Sample modulation sets. - -### sample_modulation_sets_observable : [`renoise.Document.ObservableList`](../../API/renoise/renoise.Document.ObservableList.md) -> Track changes to document lists by attaching listener functions to it. -> NB: Notifiers will not broadcast changes made to list items, but only changes -> to the lists **layout** (items got added, removed, swapped). - -### sample_device_chains : [`renoise.SampleDeviceChain`](../../API/renoise/renoise.SampleDeviceChain.md)[] -> **READ-ONLY** Sample device chains. - -### sample_device_chains_observable : [`renoise.Document.ObservableList`](../../API/renoise/renoise.Document.ObservableList.md) -> Track changes to document lists by attaching listener functions to it. -> NB: Notifiers will not broadcast changes made to list items, but only changes -> to the lists **layout** (items got added, removed, swapped). - -### midi_input_properties : [`renoise.InstrumentMidiInputProperties`](../../API/renoise/renoise.InstrumentMidiInputProperties.md) -> **READ-ONLY** MIDI input properties. - -### midi_output_properties : [`renoise.InstrumentMidiOutputProperties`](../../API/renoise/renoise.InstrumentMidiOutputProperties.md) -> **READ-ONLY** MIDI output properties. - -### plugin_properties : [`renoise.InstrumentPluginProperties`](../../API/renoise/renoise.InstrumentPluginProperties.md) -> **READ-ONLY** Plugin properties. - - - ---- -## Functions -### clear([*self*](../../API/builtins/self.md)) -> Reset, clear all settings and all samples. -### copy_from([*self*](../../API/builtins/self.md), instrument : [`renoise.Instrument`](../../API/renoise/renoise.Instrument.md)) -> Copy all settings from the other instrument, including all samples. -### macro([*self*](../../API/builtins/self.md), index : [`integer`](../../API/builtins/integer.md)) -`->`instrument_macro : [`renoise.InstrumentMacro`](../../API/renoise/renoise.InstrumentMacro.md) - -> Range: (1 - renoise.Instrument.NUMBER_OF_MACROS) -> Access a single macro by index. -> See also property `macros`. -### insert_phrase_at([*self*](../../API/builtins/self.md), index : [`integer`](../../API/builtins/integer.md)) -`->`new_phrase : [`renoise.InstrumentPhrase`](../../API/renoise/renoise.InstrumentPhrase.md) - -> Insert a new phrase behind the given phrase index (1 for the first one). -### delete_phrase_at([*self*](../../API/builtins/self.md), index : [`integer`](../../API/builtins/integer.md)) -> Delete a new phrase at the given phrase index. -### phrase([*self*](../../API/builtins/self.md), index : [`integer`](../../API/builtins/integer.md)) -`->`[`renoise.InstrumentPhrase`](../../API/renoise/renoise.InstrumentPhrase.md) - -> Access a single phrase by index. Use properties 'phrases' to iterate -> over all phrases and to query the phrase count. -### can_insert_phrase_mapping_at([*self*](../../API/builtins/self.md), index : [`integer`](../../API/builtins/integer.md)) -`->`[`boolean`](../../API/builtins/boolean.md) - -> Returns true if a new phrase mapping can be inserted at the given -> phrase mapping index (see See renoise.song().instruments[].phrase_mappings). -> Passed phrase must exist and must not have a mapping yet. -> Phrase note mappings may not overlap and are sorted by note, so there -> can be max 119 phrases per instrument when each phrase is mapped to -> a single key only. To make up room for new phrases, access phrases by -> index, adjust their note_range, then call 'insert_phrase_mapping_at' again. -### insert_phrase_mapping_at([*self*](../../API/builtins/self.md), index : [`integer`](../../API/builtins/integer.md), phrase : [`renoise.InstrumentPhrase`](../../API/renoise/renoise.InstrumentPhrase.md)) -`->`new_mapping : [`renoise.InstrumentPhraseMapping`](../../API/renoise/renoise.InstrumentPhraseMapping.md) - -> Insert a new phrase mapping behind the given phrase mapping index. -> The new phrase mapping will by default use the entire free (note) range -> between the previous and next phrase (if any). To adjust the note range -> of the new phrase change its 'new_phrase_mapping.note_range' property. -### delete_phrase_mapping_at([*self*](../../API/builtins/self.md), index : [`integer`](../../API/builtins/integer.md)) -> Delete a new phrase mapping at the given phrase mapping index. -### phrase_mapping([*self*](../../API/builtins/self.md), index : [`integer`](../../API/builtins/integer.md)) -`->`[`renoise.InstrumentPhraseMapping`](../../API/renoise/renoise.InstrumentPhraseMapping.md) - -> Access to a phrase note mapping by index. Use property 'phrase_mappings' to -> iterate over all phrase mappings and to query the phrase (mapping) count. -### insert_sample_at([*self*](../../API/builtins/self.md), index : [`integer`](../../API/builtins/integer.md)) -`->`new_sample : [`renoise.Sample`](../../API/renoise/renoise.Sample.md) - -> Insert a new empty sample. returns the new renoise.Sample object. -> Every newly inserted sample has a default mapping, which covers the -> entire key and velocity range, or it gets added as drum kit mapping -> when the instrument used a drum-kit mapping before the sample got added. -### delete_sample_at([*self*](../../API/builtins/self.md), index : [`integer`](../../API/builtins/integer.md)) -> Delete an existing sample. -### swap_samples_at([*self*](../../API/builtins/self.md), index1 : [`integer`](../../API/builtins/integer.md), index2 : [`integer`](../../API/builtins/integer.md)) -> Swap positions of two samples. -### sample([*self*](../../API/builtins/self.md), index : [`integer`](../../API/builtins/integer.md)) -`->`[`renoise.Sample`](../../API/renoise/renoise.Sample.md) - -> Access to a single sample by index. Use properties 'samples' to iterate -> over all samples and to query the sample count. -### sample_mapping([*self*](../../API/builtins/self.md), layer : [`renoise.Instrument.Layer`](renoise.Instrument.md#Layer), index : [`integer`](../../API/builtins/integer.md)) -`->`[`renoise.SampleMapping`](../../API/renoise/renoise.SampleMapping.md) - -> Access to a sample mapping by index. Use property 'sample_mappings' to -> iterate over all sample mappings and to query the sample (mapping) count. -### insert_sample_modulation_set_at([*self*](../../API/builtins/self.md), index : [`integer`](../../API/builtins/integer.md)) -`->`new_sample_modulation_set : [`renoise.SampleModulationSet`](../../API/renoise/renoise.SampleModulationSet.md) - -> Insert a new modulation set at the given index -### delete_sample_modulation_set_at([*self*](../../API/builtins/self.md), index : [`integer`](../../API/builtins/integer.md)) -> Delete an existing modulation set at the given index. -### swap_sample_modulation_sets_at([*self*](../../API/builtins/self.md), index1 : [`any`](../../API/builtins/any.md), index2 : [`any`](../../API/builtins/any.md)) -> Swap positions of two modulation sets. -### sample_modulation_set([*self*](../../API/builtins/self.md), index : [`integer`](../../API/builtins/integer.md)) -`->`[`renoise.SampleModulationSet`](../../API/renoise/renoise.SampleModulationSet.md) - -> Access to a single sample modulation set by index. Use property -> 'sample_modulation_sets' to iterate over all sets and to query the set count. -### insert_sample_device_chain_at([*self*](../../API/builtins/self.md), index : [`integer`](../../API/builtins/integer.md)) -`->`new_sample_device_chain : [`renoise.SampleDeviceChain`](../../API/renoise/renoise.SampleDeviceChain.md) - -> Insert a new sample device chain at the given index. -### delete_sample_device_chain_at([*self*](../../API/builtins/self.md), index : [`integer`](../../API/builtins/integer.md)) -> Delete an existing sample device chain at the given index. -### swap_sample_device_chains_at([*self*](../../API/builtins/self.md), index1 : [`integer`](../../API/builtins/integer.md), index2 : [`integer`](../../API/builtins/integer.md)) -> Swap positions of two sample device chains. -### sample_device_chain([*self*](../../API/builtins/self.md), index : [`integer`](../../API/builtins/integer.md)) -`->`[`renoise.SampleDeviceChain`](../../API/renoise/renoise.SampleDeviceChain.md) - -> Access to a single device chain by index. Use property 'sample_device_chains' -> to iterate over all chains and to query the chain count. - diff --git a/docs/API/renoise/renoise.InstrumentDevice.md b/docs/API/renoise/renoise.InstrumentDevice.md deleted file mode 100644 index 0f23606..0000000 --- a/docs/API/renoise/renoise.InstrumentDevice.md +++ /dev/null @@ -1,57 +0,0 @@ -# renoise.InstrumentDevice -> **Deprecated.** Use `renoise.InstrumentPluginDevice` instead. - - - - ---- -## Properties -### name : [`string`](../../API/builtins/string.md) -> **READ-ONLY** Device name. - -### short_name : [`string`](../../API/builtins/string.md) -> **READ-ONLY** - -### presets : [`string`](../../API/builtins/string.md)[] -> **READ-ONLY** - -### active_preset : [`integer`](../../API/builtins/integer.md) -> Preset handling. 0 when when none is active (or available) - -### active_preset_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### active_preset_data : [`string`](../../API/builtins/string.md) -> raw XML data of the active preset - -### parameters : [`renoise.DeviceParameter`](../../API/renoise/renoise.DeviceParameter.md)[] -> **READ-ONLY** - -### external_editor_available : [`boolean`](../../API/builtins/boolean.md) -> **READ-ONLY** Returns whether or not the plugin provides its own custom GUI. - -### external_editor_visible : [`boolean`](../../API/builtins/boolean.md) -> When the plugin has no custom GUI, Renoise will create a dummy editor for it which -> lists the plugin parameters. -> set to true to show the editor, false to close it - -### device_path : [`string`](../../API/builtins/string.md) -> **READ-ONLY** Returns a string that uniquely identifies the plugin -> The string can be passed into: renoise.InstrumentPluginProperties:load_plugin() - - - ---- -## Functions -### preset([*self*](../../API/builtins/self.md), index : [`integer`](../../API/builtins/integer.md)) -`->`[`string`](../../API/builtins/string.md) - -> Access to a single preset name by index. Use properties 'presets' to iterate -> over all presets and to query the presets count. -### parameter([*self*](../../API/builtins/self.md), index : [`integer`](../../API/builtins/integer.md)) -`->`[`renoise.DeviceParameter`](../../API/renoise/renoise.DeviceParameter.md) - -> Access to a single parameter by index. Use properties 'parameters' to iterate -> over all parameters and to query the parameter count. - diff --git a/docs/API/renoise/renoise.InstrumentMacro.md b/docs/API/renoise/renoise.InstrumentMacro.md deleted file mode 100644 index 00ab7a2..0000000 --- a/docs/API/renoise/renoise.InstrumentMacro.md +++ /dev/null @@ -1,46 +0,0 @@ -# renoise.InstrumentMacro - - - - ---- -## Properties -### name : [`string`](../../API/builtins/string.md) -> Macro name as visible in the GUI when mappings are presents. - -### name_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### value : [`number`](../../API/builtins/number.md) -> Range: (0 - 1) - -### value_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### value_string : [`string`](../../API/builtins/string.md) -> Range: (0 - 100) - -### value_string_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### mappings : [`renoise.InstrumentMacroMapping`](../../API/renoise/renoise.InstrumentMacroMapping.md)[] -> **READ-ONLY** Macro mappings, target parameters - -### mappings_observable : [`renoise.Document.ObservableList`](../../API/renoise/renoise.Document.ObservableList.md) -> Track changes to document lists by attaching listener functions to it. -> NB: Notifiers will not broadcast changes made to list items, but only changes -> to the lists **layout** (items got added, removed, swapped). - - - ---- -## Functions -### mapping([*self*](../../API/builtins/self.md), index : [`integer`](../../API/builtins/integer.md)) -`->`[`renoise.InstrumentMacroMapping`](../../API/renoise/renoise.InstrumentMacroMapping.md) - -> Access to a single attached parameter mapping by index. Use property -> 'mappings' to query mapping count. - diff --git a/docs/API/renoise/renoise.InstrumentMacroMapping.md b/docs/API/renoise/renoise.InstrumentMacroMapping.md deleted file mode 100644 index ebf7825..0000000 --- a/docs/API/renoise/renoise.InstrumentMacroMapping.md +++ /dev/null @@ -1,46 +0,0 @@ -# renoise.InstrumentMacroMapping - - - -## Constants -### Scaling -> ```lua -> { -> SCALING_LOG_FAST: integer = 1, -> SCALING_LOG_SLOW: integer = 2, -> SCALING_LINEAR: integer = 3, -> SCALING_EXP_SLOW: integer = 4, -> SCALING_EXP_FAST: integer = 5, -> } -> ``` - - ---- -## Properties -### parameter : [`renoise.DeviceParameter`](../../API/renoise/renoise.DeviceParameter.md) -> **READ-ONLY** Linked parameter. -> Can be a sample FX- or modulation parameter. Never nil. - -### parameter_min : [`number`](../../API/builtins/number.md) -> Range: (0 - 1) - -### parameter_min_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### parameter_max : [`number`](../../API/builtins/number.md) -> Range: (0 - 1) - -### parameter_max_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### parameter_scaling : [`renoise.InstrumentMacroMapping.Scaling`](renoise.InstrumentMacroMapping.md#Scaling) -> Scaling which gets applied within the min/max range to set the dest value. - -### parameter_scaling_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - - - diff --git a/docs/API/renoise/renoise.InstrumentMidiInputProperties.md b/docs/API/renoise/renoise.InstrumentMidiInputProperties.md deleted file mode 100644 index 6f48517..0000000 --- a/docs/API/renoise/renoise.InstrumentMidiInputProperties.md +++ /dev/null @@ -1,40 +0,0 @@ -# renoise.InstrumentMidiInputProperties - - - - ---- -## Properties -### device_name : [`string`](../../API/builtins/string.md) -> When setting new devices, device names must be one of -> `renoise.Midi.available_input_devices()` or "Renoise OSC Device". -> To close a device and disconnect it from the instrument, assign -> an empty string. - -### device_name_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### channel : [`integer`](../../API/builtins/integer.md) -> Range: (1 - 16) 0 = Omni - -### channel_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### note_range : [`integer`](../../API/builtins/integer.md)[] -> Table of two numbers in range (0-119) where C-4 is 48 - -### note_range_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### assigned_track : [`integer`](../../API/builtins/integer.md) -> Range: (1 - song.sequencer_track_count) 0 = Current track - -### assigned_track_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - - - diff --git a/docs/API/renoise/renoise.InstrumentMidiOutputProperties.md b/docs/API/renoise/renoise.InstrumentMidiOutputProperties.md deleted file mode 100644 index 2b6e6c7..0000000 --- a/docs/API/renoise/renoise.InstrumentMidiOutputProperties.md +++ /dev/null @@ -1,81 +0,0 @@ -# renoise.InstrumentMidiOutputProperties - - - -## Constants -### Type -> ```lua -> { -> TYPE_EXTERNAL: integer = 1, -> TYPE_LINE_IN_RET: integer = 2, -> TYPE_INTERNAL: integer = 3, -> } -> ``` - - ---- -## Properties -### instrument_type : [`renoise.InstrumentMidiOutputProperties.Type`](renoise.InstrumentMidiOutputProperties.md#Type) -> Note: ReWire device always start with "ReWire: " in the device_name and -> will always ignore the instrument_type and channel properties. MIDI -> channels are not configurable for ReWire MIDI, and instrument_type will -> always be "TYPE_INTERNAL" for ReWire devices. - -### instrument_type_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### device_name : [`string`](../../API/builtins/string.md) -> When setting new devices, device names must be one of: -> renoise.Midi.available_output_devices. -> Devices are automatically opened when needed. To close a device, set its name -> to "", e.g. an empty string. - -### device_name_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### channel : [`integer`](../../API/builtins/integer.md) -> Range: (1 - 16) - -### channel_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### transpose : [`integer`](../../API/builtins/integer.md) -> Range: (-120 - 120) - -### transpose_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### program : [`integer`](../../API/builtins/integer.md) -> Range: (1 - 128) 0 = OFF - -### program_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### bank : [`integer`](../../API/builtins/integer.md) -> Range: (1 - 65536) 0 = OFF - -### bank_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### delay : [`integer`](../../API/builtins/integer.md) -> Range: (0 - 100) - -### delay_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### duration : [`integer`](../../API/builtins/integer.md) -> Range: (1 - 8000) 8000 = INF - -### duration_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - - - diff --git a/docs/API/renoise/renoise.InstrumentPhrase.md b/docs/API/renoise/renoise.InstrumentPhrase.md deleted file mode 100644 index eafa831..0000000 --- a/docs/API/renoise/renoise.InstrumentPhrase.md +++ /dev/null @@ -1,262 +0,0 @@ -# renoise.InstrumentPhrase -> General remarks: Phrases do use renoise.PatternLine objects just like the -> pattern tracks do. When the instrument column is enabled and used, -> not instruments, but samples are addressed/triggered in phrases. - - - -## Constants -### KeyTrackingMode -> ```lua -> { -> KEY_TRACKING_NONE: integer = 1, -> KEY_TRACKING_TRANSPOSE: integer = 2, -> KEY_TRACKING_OFFSET: integer = 3, -> } -> ``` -### PlaybackMode -> ```lua -> { -> PLAY_PATTERN: integer = 1, -> PLAY_SCRIPT: integer = 2, -> } -> ``` -### MAX_NUMBER_OF_LINES : [`integer`](../../API/builtins/integer.md) -> Maximum number of lines that can be present in a phrase. - -### MIN_NUMBER_OF_NOTE_COLUMNS : [`integer`](../../API/builtins/integer.md) -> Min/Maximum number of note columns that can be present in a phrase. - -### MAX_NUMBER_OF_NOTE_COLUMNS : [`integer`](../../API/builtins/integer.md) -### MIN_NUMBER_OF_EFFECT_COLUMNS : [`integer`](../../API/builtins/integer.md) -> Min/Maximum number of effect columns that can be present in a phrase. - -### MAX_NUMBER_OF_EFFECT_COLUMNS : [`integer`](../../API/builtins/integer.md) - ---- -## Properties -### name : [`string`](../../API/builtins/string.md) -> Name of the phrase as visible in the phrase editor and piano mappings. - -### name_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### mapping : [`renoise.InstrumentPhraseMapping`](../../API/renoise/renoise.InstrumentPhraseMapping.md) -> (Key)Mapping properties of the phrase or nil when no mapping is present. - -### playback_mode : [`renoise.InstrumentPhrase.PlaybackMode`](renoise.InstrumentPhrase.md#PlaybackMode) -> playback mode - -### playback_mode_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### script : [`renoise.InstrumentPhraseScript`](../../API/renoise/renoise.InstrumentPhraseScript.md) -> **READ-ONLY** Phrase script properties. Only used when `playback_mode` is -> set to `renoise.InstrumentPhrase.PLAY_SCRIPT` - -### is_empty : [`boolean`](../../API/builtins/boolean.md) -> **READ-ONLY** -> Quickly check if a phrase has some non empty pattern lines. - -### is_empty_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### number_of_lines : [`integer`](../../API/builtins/integer.md) -> Default: 16, Range: (1 - renoise.InstrumentPhrase.MAX_NUMBER_OF_LINES) -> Number of lines the phrase currently has. - -### number_of_lines_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### lines : [`renoise.PatternLine`](../../API/renoise/renoise.PatternLine.md)[] -> **READ-ONLY** Get all lines in a range [1, number_of_lines_in_pattern] - -### visible_note_columns : [`integer`](../../API/builtins/integer.md) -> Range: (MIN_NUMBER_OF_NOTE_COLUMNS - MAX_NUMBER_OF_NOTE_COLUMNS) -> How many note columns are visible in the phrase. - -### visible_note_columns_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### visible_effect_columns : [`integer`](../../API/builtins/integer.md) -> Range: (MIN_NUMBER_OF_EFFECT_COLUMNS - MAX_NUMBER_OF_EFFECT_COLUMNS) -> How many effect columns are visible in the phrase. - -### visible_effect_columns_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### key_tracking : [`renoise.InstrumentPhrase.KeyTrackingMode`](renoise.InstrumentPhrase.md#KeyTrackingMode) -> Phrase's key-tracking mode. - -### key_tracking_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### base_note : [`integer`](../../API/builtins/integer.md) -> Range: (0 - 119) where C-4 is 48 -> Phrase's base-note. Only relevant when key_tracking is set to transpose. - -### base_note_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### looping : [`boolean`](../../API/builtins/boolean.md) -> Loop mode. The phrase plays as one-shot when disabled. - -### looping_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### loop_start : [`integer`](../../API/builtins/integer.md) -> Range: (1 - number_of_lines) -> Loop start. Playback will start from the beginning before entering loop - -### loop_start_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### loop_end : [`integer`](../../API/builtins/integer.md) -> Range: (loop_start - number_of_lines) -> Loop end. Needs to be > loop_start and <= number_of_lines - -### loop_end_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### autoseek : [`boolean`](../../API/builtins/boolean.md) -> Phrase autoseek settings - -### autoseek_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### lpb : [`integer`](../../API/builtins/integer.md) -> Range: (1 - 256) -> Phrase local lines per beat setting. New phrases get initialized with -> the song's current LPB setting. TPL can not be configured in phrases. - -### lpb_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### shuffle : [`number`](../../API/builtins/number.md) -> Range: (0 - 1) -> Shuffle groove amount for a phrase. -> 0.0 = no shuffle (off), 1.0 = full shuffle - -### shuffle_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### instrument_column_visible : [`boolean`](../../API/builtins/boolean.md) -> Column visibility. - -### instrument_column_visible_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### volume_column_visible : [`boolean`](../../API/builtins/boolean.md) -### volume_column_visible_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### panning_column_visible : [`boolean`](../../API/builtins/boolean.md) -### panning_column_visible_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### delay_column_visible : [`boolean`](../../API/builtins/boolean.md) -### delay_column_visible_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### sample_effects_column_visible : [`boolean`](../../API/builtins/boolean.md) -### sample_effects_column_visible_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - - - ---- -## Functions -### clear([*self*](../../API/builtins/self.md)) -> Deletes all lines. -### copy_from([*self*](../../API/builtins/self.md), phrase : [`renoise.InstrumentPhrase`](../../API/renoise/renoise.InstrumentPhrase.md)) -> Copy contents from another phrase. -### line([*self*](../../API/builtins/self.md), index : [`integer`](../../API/builtins/integer.md)) -`->`[`renoise.PatternLine`](../../API/renoise/renoise.PatternLine.md) - -> Range: (1 - renoise.InstrumentPhrase.MAX_NUMBER_OF_LINES) -> Access to a single line by index. Line must be in Range: (1 - MAX_NUMBER_OF_LINES). -> This is a !lot! more efficient than calling the property: lines[index] to -> randomly access lines. -### lines_in_range([*self*](../../API/builtins/self.md), index_from : [`integer`](../../API/builtins/integer.md), index_to : [`integer`](../../API/builtins/integer.md)) -`->`[`renoise.PatternLine`](../../API/renoise/renoise.PatternLine.md)[] - -> Get a specific line range -### has_line_notifier([*self*](../../API/builtins/self.md), func : [`PhraseLineChangeCallbackWithContext`](#PhraseLineChangeCallbackWithContext), obj : [`table`](../../API/builtins/table.md) | [`userdata`](../../API/builtins/userdata.md)) -`->`[`boolean`](../../API/builtins/boolean.md) - -> Check/add/remove notifier functions or methods, which are called by -> Renoise as soon as any of the phrases's lines have changed. -> See: `renoise.Pattern.has_line_notifier` for more details. -### add_line_notifier([*self*](../../API/builtins/self.md), func : [`PhraseLineChangeCallbackWithContext`](#PhraseLineChangeCallbackWithContext), obj : [`table`](../../API/builtins/table.md) | [`userdata`](../../API/builtins/userdata.md)) -### remove_line_notifier([*self*](../../API/builtins/self.md), func : [`PhraseLineChangeCallbackWithContext`](#PhraseLineChangeCallbackWithContext), obj : [`table`](../../API/builtins/table.md) | [`userdata`](../../API/builtins/userdata.md)) -### has_line_edited_notifier([*self*](../../API/builtins/self.md), func : [`PhraseLineChangeCallbackWithContext`](#PhraseLineChangeCallbackWithContext), obj : [`table`](../../API/builtins/table.md) | [`userdata`](../../API/builtins/userdata.md)) -`->`[`boolean`](../../API/builtins/boolean.md) - -> Same as line_notifier above, but the notifier only fires when the user -> added, changed or deleted a line with the computer keyboard. -> See: ~renoise.Pattern.has_line_editoed_notifier~ for more details. -### add_line_edited_notifier([*self*](../../API/builtins/self.md), func : [`PhraseLineChangeCallbackWithContext`](#PhraseLineChangeCallbackWithContext), obj : [`table`](../../API/builtins/table.md) | [`userdata`](../../API/builtins/userdata.md)) -### remove_line_edited_notifier([*self*](../../API/builtins/self.md), func : [`PhraseLineChangeCallbackWithContext`](#PhraseLineChangeCallbackWithContext), obj : [`table`](../../API/builtins/table.md) | [`userdata`](../../API/builtins/userdata.md)) -### column_is_muted([*self*](../../API/builtins/self.md), column : [`integer`](../../API/builtins/integer.md)) -`->`[`boolean`](../../API/builtins/boolean.md) - -> Note column mute states. -### column_is_muted_observable([*self*](../../API/builtins/self.md), column : [`integer`](../../API/builtins/integer.md)) -`->`[`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) - -### set_column_is_muted([*self*](../../API/builtins/self.md), column : [`integer`](../../API/builtins/integer.md), muted : [`boolean`](../../API/builtins/boolean.md)) -### column_name([*self*](../../API/builtins/self.md), column : [`integer`](../../API/builtins/integer.md)) -`->`[`string`](../../API/builtins/string.md) - -> Note column names. -### column_name_observable([*self*](../../API/builtins/self.md), column : [`integer`](../../API/builtins/integer.md)) -`->`[`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) - -### set_column_name([*self*](../../API/builtins/self.md), column : [`integer`](../../API/builtins/integer.md), name : [`string`](../../API/builtins/string.md)) -### swap_note_columns_at([*self*](../../API/builtins/self.md), index1 : [`integer`](../../API/builtins/integer.md), index2 : [`integer`](../../API/builtins/integer.md)) -> Swap the positions of two note columns within a phrase. -### swap_effect_columns_at([*self*](../../API/builtins/self.md), index1 : [`integer`](../../API/builtins/integer.md), index2 : [`integer`](../../API/builtins/integer.md)) -> Swap the positions of two effect columns within a phrase. - - - ---- -## Structs -# PhraseLinePosition -> Line iterator position. - ---- -## Properties -### line : [`integer`](../../API/builtins/integer.md) - - - - - - ---- -## Aliases -### PhraseLineChangeCallbackWithContext -(obj : [`table`](../../API/builtins/table.md) | [`userdata`](../../API/builtins/userdata.md), pos : [`PhraseLinePosition`](#phraselineposition)) - - - diff --git a/docs/API/renoise/renoise.InstrumentPhraseMapping.md b/docs/API/renoise/renoise.InstrumentPhraseMapping.md deleted file mode 100644 index 0df58b7..0000000 --- a/docs/API/renoise/renoise.InstrumentPhraseMapping.md +++ /dev/null @@ -1,60 +0,0 @@ -# renoise.InstrumentPhraseMapping - - - -## Constants -### KeyTrackingMode -> ```lua -> { -> KEY_TRACKING_NONE: integer = 1, -> KEY_TRACKING_TRANSPOSE: integer = 2, -> KEY_TRACKING_OFFSET: integer = 3, -> } -> ``` - - ---- -## Properties -### phrase : [`renoise.InstrumentPhrase`](../../API/renoise/renoise.InstrumentPhrase.md) -> Linked phrase. - -### key_tracking : [`renoise.InstrumentPhraseMapping.KeyTrackingMode`](renoise.InstrumentPhraseMapping.md#KeyTrackingMode) -> Phrase's key-tracking mode. - -### key_tracking_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### base_note : [`integer`](../../API/builtins/integer.md) -> Range: (0 - 119) where C-4 is 48 - -### base_note_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### note_range : [`integer`](../../API/builtins/integer.md)[] -> Range: (0 - 119) where C-4 is 48 - -### note_range_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### looping : [`boolean`](../../API/builtins/boolean.md) -> Loop mode. The phrase plays as one-shot when disabled. - -### looping_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### loop_start : [`integer`](../../API/builtins/integer.md) -### loop_start_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### loop_end : [`integer`](../../API/builtins/integer.md) -### loop_end_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - - - diff --git a/docs/API/renoise/renoise.InstrumentPhraseScript.md b/docs/API/renoise/renoise.InstrumentPhraseScript.md deleted file mode 100644 index f8bcc87..0000000 --- a/docs/API/renoise/renoise.InstrumentPhraseScript.md +++ /dev/null @@ -1,113 +0,0 @@ -# renoise.InstrumentPhraseScript - - - - ---- -## Properties -### editor_visible : [`boolean`](../../API/builtins/boolean.md) -> When false, a preview of the script is shown instead of a text editor. - -### editor_visible_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> fired, when the editor visibility changed. - -### parameters : [`renoise.DeviceParameter`](../../API/renoise/renoise.DeviceParameter.md)[] -> **READ-ONLY** List of script input parameters, if any. - -### parameters_observable : [`renoise.Document.ObservableList`](../../API/renoise/renoise.Document.ObservableList.md) -> fired, when the input parameter set changed. - -### paragraphs : [`string`](../../API/builtins/string.md)[] -> Script content. When changing paragraphs, changes are visible in the -> script editor, but are not applied for playback until they get committed. -> See also @function `commit` and @field `committed_observable`. - -### paragraphs_observable : [`renoise.Document.DocumentList`](../../API/renoise/renoise.Document.DocumentList.md) -> Notifier which is called when a paragraph got added or removed. - -### paragraphs_assignment_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Notifier which is called when existing paragraph content changed. - -### compile_error : [`string`](../../API/builtins/string.md) -> **READ-ONLY** When not empty, the script failed to compile. -> This error text is also visible to the user in the script preview. - -### compile_error_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### runtime_error : [`string`](../../API/builtins/string.md) -> **READ-ONLY** When not empty, script compiled successfully, but caused an -> error while running. This error text is also visible to the user in the -> script editor. - -### runtime_error_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### pending_changes : [`integer`](../../API/builtins/integer.md) -> **READ-ONLY** Number of changes since the last commit() or auto-commit call, -> that have been applied to the parapgraphs. -> Note: `auto-commit` only is applied for scripts which are currently edited. - -### pending_changes_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### committed_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Fired when script paragraph changes got committed: Either by an explicit -> `commit` call or via `auto-commit` in the editor when the script currently is -> edited. Script compile errors will be set or cleared *after* the observable -> fires as the commit & compilation happens asynchroniously in the player engine. - - - ---- -## Functions -### parameter([*self*](../../API/builtins/self.md), index : [`integer`](../../API/builtins/integer.md)) -`->`[`renoise.DeviceParameter`](../../API/renoise/renoise.DeviceParameter.md) - -> Access to a single input parameter by index. Use properties 'parameters' -> to iterate over all parameters and to query the parameter count. -### commit([*self*](../../API/builtins/self.md)) -> Commit paragraph changes for playback. -### render_to_pattern([*self*](../../API/builtins/self.md), options : [`RenderScriptOptions`](#renderscriptoptions), rendering_done_callback : [`RenderingDoneCallback`](#RenderingDoneCallback)) -> Render script content with the given options to the phrase pattern. -> Only committed content will be rendered, so make sure to commit changes first. -> Parameter `rendering_done_callback` is called with the results: -> * `error`: nil when the rendering succeeded, otherwise a string describing the error -> * `rendered_events`: number of successfully rendered raw events (not pattern lines) or 0 -> * `skipped_events`: number of skipped raw events, in case the pattern couldn't fit all events, or 0 -### render_to_clipboard([*self*](../../API/builtins/self.md), options : [`RenderScriptOptions`](#renderscriptoptions), rendering_done_callback : [`RenderingDoneCallback`](#RenderingDoneCallback)) -> Same as `render_to_pattern`, but rendering into a temporary phrase object in the clipboard, -> which can then be pasted by the user somewhere. - - - ---- -## Structs -# RenderScriptOptions -> Options for the render functions. All undefined properties will fall back to the -> user preferences values from the script preview - ---- -## Properties -### lpb : [`number`](../../API/builtins/number.md)[`?`](../../API/builtins/nil.md) -> Lines per beat of the target phrase. - -### max_events : [`number`](../../API/builtins/number.md)[`?`](../../API/builtins/nil.md) -> Maximum events (not pattern lines) that will be rendered - - - - - - - ---- -## Aliases -### RenderingDoneCallback -(error : [`string`](../../API/builtins/string.md)[`?`](../../API/builtins/nil.md), rendered_events : [`integer`](../../API/builtins/integer.md), skipped_events : [`integer`](../../API/builtins/integer.md)) - - - diff --git a/docs/API/renoise/renoise.InstrumentPluginDevice.md b/docs/API/renoise/renoise.InstrumentPluginDevice.md deleted file mode 100644 index 22c9bfb..0000000 --- a/docs/API/renoise/renoise.InstrumentPluginDevice.md +++ /dev/null @@ -1,56 +0,0 @@ -# renoise.InstrumentPluginDevice - - - - ---- -## Properties -### name : [`string`](../../API/builtins/string.md) -> **READ-ONLY** Device name. - -### short_name : [`string`](../../API/builtins/string.md) -> **READ-ONLY** - -### presets : [`string`](../../API/builtins/string.md)[] -> **READ-ONLY** - -### active_preset : [`integer`](../../API/builtins/integer.md) -> Preset handling. 0 when when none is active (or available) - -### active_preset_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### active_preset_data : [`string`](../../API/builtins/string.md) -> raw XML data of the active preset - -### parameters : [`renoise.DeviceParameter`](../../API/renoise/renoise.DeviceParameter.md)[] -> **READ-ONLY** - -### external_editor_available : [`boolean`](../../API/builtins/boolean.md) -> **READ-ONLY** Returns whether or not the plugin provides its own custom GUI. - -### external_editor_visible : [`boolean`](../../API/builtins/boolean.md) -> When the plugin has no custom GUI, Renoise will create a dummy editor for it which -> lists the plugin parameters. -> set to true to show the editor, false to close it - -### device_path : [`string`](../../API/builtins/string.md) -> **READ-ONLY** Returns a string that uniquely identifies the plugin -> The string can be passed into: renoise.InstrumentPluginProperties:load_plugin() - - - ---- -## Functions -### preset([*self*](../../API/builtins/self.md), index : [`integer`](../../API/builtins/integer.md)) -`->`[`string`](../../API/builtins/string.md) - -> Access to a single preset name by index. Use properties 'presets' to iterate -> over all presets and to query the presets count. -### parameter([*self*](../../API/builtins/self.md), index : [`integer`](../../API/builtins/integer.md)) -`->`[`renoise.DeviceParameter`](../../API/renoise/renoise.DeviceParameter.md) - -> Access to a single parameter by index. Use properties 'parameters' to iterate -> over all parameters and to query the parameter count. - diff --git a/docs/API/renoise/renoise.InstrumentPluginProperties.md b/docs/API/renoise/renoise.InstrumentPluginProperties.md deleted file mode 100644 index 1a9e873..0000000 --- a/docs/API/renoise/renoise.InstrumentPluginProperties.md +++ /dev/null @@ -1,128 +0,0 @@ -# renoise.InstrumentPluginProperties - - - - ---- -## Properties -### available_plugins : [`string`](../../API/builtins/string.md)[] -> **READ-ONLY** List of all currently available plugins. This is a list of -> unique plugin names which also contains the plugin's type (VST/AU/DSSI/...), -> not including the vendor names as visible in Renoise's GUI. So its an -> identifier, and not the name as visible in the GUI. When no plugin is loaded, -> the identifier is an empty string. - -### available_plugin_infos : [`PluginInfo`](#plugininfo)[] -> **READ-ONLY** Returns a list of tables containing more information about the plugins. - -### plugin_loaded : [`boolean`](../../API/builtins/boolean.md) -> **READ-ONLY** Returns true when a plugin is present; loaded successfully. - -### plugin_device : [`renoise.AudioDevice`](../../API/renoise/renoise.AudioDevice.md) | [`renoise.InstrumentPluginDevice`](../../API/renoise/renoise.InstrumentPluginDevice.md) -> Valid object for successfully loaded plugins, otherwise nil. Alias plugin -> instruments of FX will return the resolved device, will link to the device -> the alias points to. -> The observable is fired when the device changes: when a plugin gets loaded or -> unloaded or a plugin alias is assigned or unassigned. - -### plugin_device_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### alias_instrument_index : [`integer`](../../API/builtins/integer.md) -> 0 when no alias instrument is set - -### alias_instrument_index_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### alias_fx_track_index : [`integer`](../../API/builtins/integer.md) -> **READ-ONLY** 0 when no alias FX is set - -### alias_fx_track_index_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### alias_fx_device_index : [`integer`](../../API/builtins/integer.md) -> **READ-ONLY** 0 when no alias FX is set - -### alias_fx_device_index_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### midi_output_routing_index : [`integer`](../../API/builtins/integer.md) -> 0 when no routing is set - -### midi_output_routing_index_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### channel : [`integer`](../../API/builtins/integer.md) -> Range: (1 - 16) - -### channel_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### transpose : [`integer`](../../API/builtins/integer.md) -> Range: (-120 - 120) - -### transpose_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### volume : [`number`](../../API/builtins/number.md) -> Range: (0.0 - 4.0) linear gain - -### volume_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### auto_suspend : [`boolean`](../../API/builtins/boolean.md) -> Valid for loaded and unloaded plugins. - -### auto_suspend_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - - - ---- -## Functions -### load_plugin([*self*](../../API/builtins/self.md), plugin_path : [`string`](../../API/builtins/string.md)) -`->`success : [`boolean`](../../API/builtins/boolean.md) - -> Load an existing, new, non aliased plugin. Pass an empty string to unload -> an already assigned plugin. plugin_path must be one of the available plugins -> See: `renoise.InstrumentPluginProperties.available_plugins` - - - ---- -## Structs -# PluginInfo - ---- -## Properties -### path : [`string`](../../API/builtins/string.md) -> The plugin's path used by load_plugin() - -### name : [`string`](../../API/builtins/string.md) -> The plugin's name - -### short_name : [`string`](../../API/builtins/string.md) -> The plugin's name as displayed in shortened lists - -### favorite_name : [`string`](../../API/builtins/string.md) -> The plugin's name as displayed in favorites - -### is_favorite : [`string`](../../API/builtins/string.md) -> true if the plugin is a favorite - -### is_bridged : [`string`](../../API/builtins/string.md) -> true if the plugin is a bridged plugin - - - - - diff --git a/docs/API/renoise/renoise.InstrumentTriggerOptions.md b/docs/API/renoise/renoise.InstrumentTriggerOptions.md deleted file mode 100644 index 6314159..0000000 --- a/docs/API/renoise/renoise.InstrumentTriggerOptions.md +++ /dev/null @@ -1,105 +0,0 @@ -# renoise.InstrumentTriggerOptions - - - -## Constants -### QuantizeMode -> ```lua -> { -> QUANTIZE_NONE: integer = 1, -> QUANTIZE_LINE: integer = 2, -> QUANTIZE_BEAT: integer = 3, -> QUANTIZE_BAR: integer = 4, -> } -> ``` - - ---- -## Properties -### available_scale_modes : [`string`](../../API/builtins/string.md)[] -> **READ-ONLY** List of all available scale modes. - -### scale_mode : [`string`](../../API/builtins/string.md) -> one of 'available_scales'] - -### scale_mode_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### scale_key : [`integer`](../../API/builtins/integer.md) -> Scale-key to use when transposing (1=C, 2=C#, 3=D, ...) - -### scale_key_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### mts_esp_tuning : [`boolean`](../../API/builtins/boolean.md) -> When true, act as MTS ESP client. Disables custom tunings. - -### mts_esp_tuning_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### tuning : [`number`](../../API/builtins/number.md)[] -> Array of custom pitch values relative to 1/1, used as custom tuning values for -> instrument sample playback. The root key is assumed to be middle C (48 in Renoise), -> The scale will be repeated, so only one octave of values should be defined. An -> octave may contain more or less than 12 notes. -> -> When set mts_esp_tuning is disabled. Set an empty table to disable custom tuning -> using default 12-TET tuning instead. -> -> Use property `tuning_name` to give your custom tuning a name. -> -> #### examples: -> ```lua -> -- Andreas Werckmeister's temperament III (the most famous one, 1681) -> local well_tempered_tuning = { -> 256/243, 1.117403, 32/27, 1.252827, 4/3, 1024/729, -> 1.494927, 128/81, 1.670436, 16/9, 1.879241, 2/1 -> } -> instrument.tuning = well_tempered_tuning -> ``` - -### tuning_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### tuning_name : [`string`](../../API/builtins/string.md) -> Name, as displayed in the UI for a custom tuning or a tuning loaded from a file. - -### tuning_name_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### quantize : [`renoise.InstrumentTriggerOptions.QuantizeMode`](renoise.InstrumentTriggerOptions.md#QuantizeMode) -> Trigger quantization mode. - -### quantize_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### monophonic : [`boolean`](../../API/builtins/boolean.md) -> Mono/Poly mode. - -### monophonic_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### monophonic_glide : [`integer`](../../API/builtins/integer.md) -> Glide amount when monophonic. 0 == off, 255 = instant - -### monophonic_glide_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - - - ---- -## Functions -### load_tuning([*self*](../../API/builtins/self.md), filename : [`string`](../../API/builtins/string.md)) -`->`success : [`boolean`](../../API/builtins/boolean.md) - -> Load and apply a scala tuning file as custom tuning. Disables `mts_esp_tuning`. -> Any errors during the export are shown to the user. - diff --git a/docs/API/renoise/renoise.Midi.MidiDevice.md b/docs/API/renoise/renoise.Midi.MidiDevice.md deleted file mode 100644 index 6144390..0000000 --- a/docs/API/renoise/renoise.Midi.MidiDevice.md +++ /dev/null @@ -1,28 +0,0 @@ -# renoise.Midi.MidiDevice -> Baseclass of renoise.Midi.MidiIn/OutDevice with common properties for MIDI -> input and output devices. - - - - ---- -## Properties -### is_open : [`boolean`](../../API/builtins/boolean.md) -> Returns true while the device is open (ready to send or receive messages). -> Your device refs will never be auto-closed, "is_open" will only be false if -> you explicitly call "midi_device:close()" to release a device. - -### name : [`string`](../../API/builtins/string.md) -> The name of a device. This is the name you create a device with via -> `renoise.Midi.create_input_device` or `renoise.Midi.create_output_device`. - - - ---- -## Functions -### close([*self*](../../API/builtins/self.md)) -> Close a running MIDI device. When no other client is using a device, Renoise -> will also shut off the device driver so that, for example, Windows OS other -> applications can use the device again. This is automatically done when -> scripts are closed or your device objects are garbage collected. - diff --git a/docs/API/renoise/renoise.Midi.MidiInputDevice.md b/docs/API/renoise/renoise.Midi.MidiInputDevice.md deleted file mode 100644 index 2a3695e..0000000 --- a/docs/API/renoise/renoise.Midi.MidiInputDevice.md +++ /dev/null @@ -1,28 +0,0 @@ -# renoise.Midi.MidiInputDevice -> Midi device interface for receiving MIDI messages. -> Instances are created via `renoise.Midi.create_input_device` - - - - ---- -## Properties -### is_open : [`boolean`](../../API/builtins/boolean.md) -> Returns true while the device is open (ready to send or receive messages). -> Your device refs will never be auto-closed, "is_open" will only be false if -> you explicitly call "midi_device:close()" to release a device. - -### name : [`string`](../../API/builtins/string.md) -> The name of a device. This is the name you create a device with via -> `renoise.Midi.create_input_device` or `renoise.Midi.create_output_device`. - - - ---- -## Functions -### close([*self*](../../API/builtins/self.md)) -> Close a running MIDI device. When no other client is using a device, Renoise -> will also shut off the device driver so that, for example, Windows OS other -> applications can use the device again. This is automatically done when -> scripts are closed or your device objects are garbage collected. - diff --git a/docs/API/renoise/renoise.Midi.MidiOutputDevice.md b/docs/API/renoise/renoise.Midi.MidiOutputDevice.md deleted file mode 100644 index c6577e3..0000000 --- a/docs/API/renoise/renoise.Midi.MidiOutputDevice.md +++ /dev/null @@ -1,33 +0,0 @@ -# renoise.Midi.MidiOutputDevice -> Midi device interface for sending MIDI messages. -> Instances are created via `renoise.Midi.create_output_device` - - - - ---- -## Properties -### is_open : [`boolean`](../../API/builtins/boolean.md) -> Returns true while the device is open (ready to send or receive messages). -> Your device refs will never be auto-closed, "is_open" will only be false if -> you explicitly call "midi_device:close()" to release a device. - -### name : [`string`](../../API/builtins/string.md) -> The name of a device. This is the name you create a device with via -> `renoise.Midi.create_input_device` or `renoise.Midi.create_output_device`. - - - ---- -## Functions -### close([*self*](../../API/builtins/self.md)) -> Close a running MIDI device. When no other client is using a device, Renoise -> will also shut off the device driver so that, for example, Windows OS other -> applications can use the device again. This is automatically done when -> scripts are closed or your device objects are garbage collected. -### send([*self*](../../API/builtins/self.md), message : [`integer`](../../API/builtins/integer.md)[]) -> Send raw 1-3 byte MIDI messages or sysex messages. Message is expected -> to be an array of numbers. It must not be empty and can only contain -> numbers >= 0 and <= 0xFF (bytes). Sysex messages must be sent in one block, -> and must start with 0xF0, and end with 0xF7. - diff --git a/docs/API/renoise/renoise.Midi.md b/docs/API/renoise/renoise.Midi.md deleted file mode 100644 index c96c776..0000000 --- a/docs/API/renoise/renoise.Midi.md +++ /dev/null @@ -1,90 +0,0 @@ -# renoise.Midi -> Raw MIDI IO support for scripts in Renoise; the ability to send and receive -> MIDI data. - - - - ---- -## Functions -### `available_input_devices()` -`->`[`string`](../../API/builtins/string.md)[] - -> Return a list of strings with currently available MIDI input devices. -> This list can change when devices are hot-plugged. -> See `renoise.Midi.devices_changed_observable` -### `available_output_devices()` -`->`[`string`](../../API/builtins/string.md)[] - -> Return a list of strings with currently available MIDI output devices. -> This list can change when devices are hot-plugged. -> See `renoise.Midi.devices_changed_observable` -### `devices_changed_observable()` -`->`[`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) - -> Fire notifications as soon as new devices become active or a previously -> added device gets removed/unplugged. -> This will only happen on Linux and OSX with real devices. On Windows this -> may happen when using ReWire slaves. ReWire adds virtual MIDI devices to -> Renoise. -> Already opened references to devices which are no longer available will -> do nothing: you can use them as before and they will not fire any errors. -> The messages will simply go into the void... -### create_input_device(device_name : [`string`](../../API/builtins/string.md), callback : [`MidiMessageFunction`](#MidiMessageFunction) | [`MidiMessageMethod1`](#MidiMessageMethod1) | [`MidiMessageMethod2`](#MidiMessageMethod2)[`?`](../../API/builtins/nil.md), sysex_callback : [`MidiMessageFunction`](#MidiMessageFunction) | [`MidiMessageMethod1`](#MidiMessageMethod1) | [`MidiMessageMethod2`](#MidiMessageMethod2)[`?`](../../API/builtins/nil.md)) -`->`[`renoise.Midi.MidiInputDevice`](../../API/renoise/renoise.Midi.MidiInputDevice.md) - -> Listen to incoming MIDI data: opens access to a MIDI input device by -> specifying a device name. -> Name must be one of `renoise.Midi.available_input_devices()`. -> -> One or both callbacks should be valid, and should either point to a function -> with one parameter `function (message: number[]) end`, or a table with an object -> and class `{context, function(context, message: number[]) end}` -> a method. -> -> All MIDI messages except active sensing will be forwarded to the callbacks. -> When Renoise is already listening to this device, your callback *and* Renoise -> (or even other scripts) will handle the message. -> -> Messages are received until the device reference is manually closed (see -> renoise.Midi.MidiDevice:close()) or until the MidiInputDevice object gets garbage -> collected. -### create_output_device(device_name : [`string`](../../API/builtins/string.md)) -`->`[`renoise.Midi.MidiOutputDevice`](../../API/renoise/renoise.Midi.MidiOutputDevice.md) - -> Open access to a MIDI device by specifying the device name. -> Name must be one of `renoise.Midi.available_input_devices()`. -> All other device names will fire an error. -> -> The real device driver gets automatically closed when the MidiOutputDevice -> object gets garbage collected or when the device is explicitly closed -> via midi_device:close() and nothing else references it. - - - ---- -## Aliases -### MidiMessage -[`integer`](../../API/builtins/integer.md)[] - - -### MidiMessageFunction -(message : [`MidiMessage`](#MidiMessage)) - - -### MidiMessageMemberContext -[`table`](../../API/builtins/table.md) | [`userdata`](../../API/builtins/userdata.md) - - -### MidiMessageMemberFunction -(self : [`MidiMessageMemberContext`](#MidiMessageMemberContext), message : [`MidiMessage`](#MidiMessage)) - - -### MidiMessageMethod1 -{ 1 : [`MidiMessageMemberContext`](#MidiMessageMemberContext), 2 : [`MidiMessageMemberFunction`](#MidiMessageMemberFunction) } - - -### MidiMessageMethod2 -{ 1 : [`MidiMessageMemberFunction`](#MidiMessageMemberFunction), 2 : [`MidiMessageMemberContext`](#MidiMessageMemberContext) } - - - diff --git a/docs/API/renoise/renoise.NoteColumn.md b/docs/API/renoise/renoise.NoteColumn.md deleted file mode 100644 index b073242..0000000 --- a/docs/API/renoise/renoise.NoteColumn.md +++ /dev/null @@ -1,81 +0,0 @@ -# renoise.NoteColumn -> A single note column in a pattern line. -> -> General remarks: instrument columns are available for lines in phrases -> but are ignored. See renoise.InstrumentPhrase for detail. -> -> Access note column properties either by values (numbers) or by strings. -> The string representation uses exactly the same notation as you see -> them in Renoise's pattern or phrase editor. - - - - ---- -## Properties -### is_empty : [`boolean`](../../API/builtins/boolean.md) -> **READ-ONLY** True, when all note column properties are empty. - -### is_selected : [`boolean`](../../API/builtins/boolean.md) -> **READ-ONLY** True, when this column is selected in the pattern or phrase -> editors current pattern. - -### note_value : [`integer`](../../API/builtins/integer.md) -> Range: (0-119) or 120=Off or 121=Empty - -### note_string : [`string`](../../API/builtins/string.md) -> Range: (\'C-0\'-\'G-9\') or \'OFF\' or \'---\' - -### instrument_value : [`integer`](../../API/builtins/integer.md) -> Range: (0-254), 255==Empty - -### instrument_string : [`string`](../../API/builtins/string.md) -> Range: (\'00\'-\'FE\') or \'..\' - -### volume_value : [`integer`](../../API/builtins/integer.md) -> Range: (0-127) or 255==Empty when column value is <= 0x80 or is 0xFF, -> i.e. to specify a volume value. -> -> Range: (0-65535) in the form 0x0000xxyy where xx=effect char 1 and yy=effect char 2, -> when column value is > 0x80, i.e. to specify an effect. - -### volume_string : [`string`](../../API/builtins/string.md) -> Range(\'00\'-\'ZF\') or \'..\' - -### panning_value : [`integer`](../../API/builtins/integer.md) -> Range: (0-127) or 255==Empty when column value is <= 0x80 or is 0xFF, -> i.e. to specify a pan value. -> -> Range: (0-65535) in the form 0x0000xxyy where xx=effect char 1 and yy=effect char 2, -> when column value is > 0x80, i.e. to specify an effect. - -### panning_string : [`string`](../../API/builtins/string.md) -> Range: (\'00'-\'ZF\') or \'..\' - -### delay_value : [`integer`](../../API/builtins/integer.md) -> Range: (0-255) - -### delay_string : [`string`](../../API/builtins/string.md) -> Range: (\'00'-\'FF\') or \'..\' - -### effect_number_value : [`integer`](../../API/builtins/integer.md) -> Range: (0-65535) in the form 0x0000xxyy where xx=effect char 1 and yy=effect char 2 - -### effect_number_string : [`string`](../../API/builtins/string.md) -> Range: (\'00\'-\'ZZ\') - -### effect_amount_value : [`integer`](../../API/builtins/integer.md) -> Range: (0-255) - -### effect_amount_string : [`string`](../../API/builtins/string.md) -> Range: (\'00\' - \'FF\') - - - ---- -## Functions -### clear([*self*](../../API/builtins/self.md)) -> Clear the note column. -### copy_from([*self*](../../API/builtins/self.md), other : [`renoise.NoteColumn`](../../API/renoise/renoise.NoteColumn.md)) -> Copy the column's content from another column. - diff --git a/docs/API/renoise/renoise.Osc.Bundle.md b/docs/API/renoise/renoise.Osc.Bundle.md deleted file mode 100644 index c6abb98..0000000 --- a/docs/API/renoise/renoise.Osc.Bundle.md +++ /dev/null @@ -1,19 +0,0 @@ -# renoise.Osc.Bundle - - - - ---- -## Properties -### timetag : [`number`](../../API/builtins/number.md) -> **READ-ONLY** Time value of the bundle. - -### elements : [`renoise.Osc.Bundle`](../../API/renoise/renoise.Osc.Bundle.md) | [`renoise.Osc.Message`](../../API/renoise/renoise.Osc.Message.md)[] -> **READ-ONLY** Access to the bundle elements (table of messages or bundles) - -### binary_data : [`string`](../../API/builtins/string.md) -> **READ-ONLY** Raw binary representation of the bundle, as needed when e.g. -> sending the message over the network through sockets. - - - diff --git a/docs/API/renoise/renoise.Osc.Message.md b/docs/API/renoise/renoise.Osc.Message.md deleted file mode 100644 index 1188fcf..0000000 --- a/docs/API/renoise/renoise.Osc.Message.md +++ /dev/null @@ -1,92 +0,0 @@ -# renoise.Osc.Message - - - - ---- -## Properties -### pattern : [`string`](../../API/builtins/string.md) -> **READ-ONLY** The message pattern (e.g. "/renoise/transport/start") - -### arguments : [`OscValue`](#oscvalue)[] -> **READ-ONLY** Table of `{tag="X", value=SomeValue}` that represents the -> message arguments. See `renoise.Osc.Message.create` for more info. - -### binary_data : [`string`](../../API/builtins/string.md) -> **READ-ONLY** Raw binary representation of the message, as needed when e.g. -> sending the message over the network through sockets. - - - - - ---- -## Structs -# OscValue -> `tag` is a standard OSC type tag. `value` is the arguments value expressed -> by a Lua type. The value must be convertible to the specified tag, which -> means, you cannot for example specify an "i" (integer) as type and then pass -> a string as the value. Use a number value instead. Not all tags require a -> value, like the T,F boolean tags. Then a `value` field should not be -> specified. For more info, see: http://opensoundcontrol.org/spec-1_0 - ---- -## Properties -### tag : [`OscTag`](#OscTag) -### value : [`boolean`](../../API/builtins/boolean.md) | [`string`](../../API/builtins/string.md) | [`number`](../../API/builtins/number.md) - - - - ---- -## Aliases -### OscTag -`"F"` | `"I"` | `"N"` | `"S"` | `"T"` | `"b"` | `"c"` | `"d"` | `"f"` | `"h"` | `"i"` | `"m"` | `"r"` | `"s"` | `"t"` -> ```lua -> OscTag: -> | "i" -- int32 -> | "f" -- float32 -> | "s" -- OSC-string -> | "b" -- OSC-blob (raw string) -> | "h" -- 64 bit big-endian two's complement integer -> | "t" -- OSC-timetag -> | "d" -- 64 bit ("double") IEEE 754 floating point number -> | "S" -- Alternate type represented as an OSC-string -> | "c" -- An ascii character, sent as 32 bits -> | "r" -- 32 bit RGBA color -> | "m" -- 4 byte MIDI message. Bytes from MSB to LSB are: port id, status byte, data1, data2 -> | "T" -- True. No value needs to be specified. -> | "F" -- False. No value needs to be specified. -> | "N" -- Nil. No value needs to be specified. -> | "I" -- Infinitum. No value needs to be specified. -> ``` - - - - - - ---- -## Aliases -### OscTag -`"F"` | `"I"` | `"N"` | `"S"` | `"T"` | `"b"` | `"c"` | `"d"` | `"f"` | `"h"` | `"i"` | `"m"` | `"r"` | `"s"` | `"t"` -> ```lua -> OscTag: -> | "i" -- int32 -> | "f" -- float32 -> | "s" -- OSC-string -> | "b" -- OSC-blob (raw string) -> | "h" -- 64 bit big-endian two's complement integer -> | "t" -- OSC-timetag -> | "d" -- 64 bit ("double") IEEE 754 floating point number -> | "S" -- Alternate type represented as an OSC-string -> | "c" -- An ascii character, sent as 32 bits -> | "r" -- 32 bit RGBA color -> | "m" -- 4 byte MIDI message. Bytes from MSB to LSB are: port id, status byte, data1, data2 -> | "T" -- True. No value needs to be specified. -> | "F" -- False. No value needs to be specified. -> | "N" -- Nil. No value needs to be specified. -> | "I" -- Infinitum. No value needs to be specified. -> ``` - - diff --git a/docs/API/renoise/renoise.Osc.md b/docs/API/renoise/renoise.Osc.md deleted file mode 100644 index 7765385..0000000 --- a/docs/API/renoise/renoise.Osc.md +++ /dev/null @@ -1,101 +0,0 @@ -# renoise.Osc -> OSC (Open Sound Control) support for Lua scripts in Renoise. - - - - ---- -## Functions -### from_binary_data(binary_data : [`string`](../../API/builtins/string.md)) -`->`[`renoise.Osc.Bundle`](../../API/renoise/renoise.Osc.Bundle.md) | [`renoise.Osc.Message`](../../API/renoise/renoise.Osc.Message.md)[`?`](../../API/builtins/nil.md), [`string`](../../API/builtins/string.md)[`?`](../../API/builtins/nil.md) - -> De-packetizing raw (socket) data to OSC messages or bundles: -> Converts the binary data to an OSC message or bundle. If the data does not -> look like an OSC message, or the message contains errors, nil is returned -> as first argument and the second return value will contain the error. -> If de-packetizing was successful, either a renoise.Osc.Bundle or Message -> object is returned. Bundles may contain multiple messages or nested bundles. -### Message(pattern : [`string`](../../API/builtins/string.md), arguments : [`OscValue`](#oscvalue)[][`?`](../../API/builtins/nil.md)) -`->`[`renoise.Osc.Message`](../../API/renoise/renoise.Osc.Message.md) - -> Create a new OSC message with the given pattern and optional arguments. -### Bundle(time : [`integer`](../../API/builtins/integer.md), arguments : [`renoise.Osc.Message`](../../API/renoise/renoise.Osc.Message.md) | [`renoise.Osc.Message`](../../API/renoise/renoise.Osc.Message.md)[]) -`->`[`renoise.Osc.Bundle`](../../API/renoise/renoise.Osc.Bundle.md) - -> Create a new bundle by specifying a time-tag and one or more messages. -> If you do not know what to do with the time-tag, use `os.clock()`, -> which simply means "now". Messages must be renoise.Osc.Message objects. -> Nested bundles (bundles in bundles) are right now not supported. - - - ---- -## Structs -# OscValue -> `tag` is a standard OSC type tag. `value` is the arguments value expressed -> by a Lua type. The value must be convertible to the specified tag, which -> means, you cannot for example specify an "i" (integer) as type and then pass -> a string as the value. Use a number value instead. Not all tags require a -> value, like the T,F boolean tags. Then a `value` field should not be -> specified. For more info, see: http://opensoundcontrol.org/spec-1_0 - ---- -## Properties -### tag : [`OscTag`](#OscTag) -### value : [`boolean`](../../API/builtins/boolean.md) | [`string`](../../API/builtins/string.md) | [`number`](../../API/builtins/number.md) - - - - ---- -## Aliases -### OscTag -`"F"` | `"I"` | `"N"` | `"S"` | `"T"` | `"b"` | `"c"` | `"d"` | `"f"` | `"h"` | `"i"` | `"m"` | `"r"` | `"s"` | `"t"` -> ```lua -> OscTag: -> | "i" -- int32 -> | "f" -- float32 -> | "s" -- OSC-string -> | "b" -- OSC-blob (raw string) -> | "h" -- 64 bit big-endian two's complement integer -> | "t" -- OSC-timetag -> | "d" -- 64 bit ("double") IEEE 754 floating point number -> | "S" -- Alternate type represented as an OSC-string -> | "c" -- An ascii character, sent as 32 bits -> | "r" -- 32 bit RGBA color -> | "m" -- 4 byte MIDI message. Bytes from MSB to LSB are: port id, status byte, data1, data2 -> | "T" -- True. No value needs to be specified. -> | "F" -- False. No value needs to be specified. -> | "N" -- Nil. No value needs to be specified. -> | "I" -- Infinitum. No value needs to be specified. -> ``` - - - - - - ---- -## Aliases -### OscTag -`"F"` | `"I"` | `"N"` | `"S"` | `"T"` | `"b"` | `"c"` | `"d"` | `"f"` | `"h"` | `"i"` | `"m"` | `"r"` | `"s"` | `"t"` -> ```lua -> OscTag: -> | "i" -- int32 -> | "f" -- float32 -> | "s" -- OSC-string -> | "b" -- OSC-blob (raw string) -> | "h" -- 64 bit big-endian two's complement integer -> | "t" -- OSC-timetag -> | "d" -- 64 bit ("double") IEEE 754 floating point number -> | "S" -- Alternate type represented as an OSC-string -> | "c" -- An ascii character, sent as 32 bits -> | "r" -- 32 bit RGBA color -> | "m" -- 4 byte MIDI message. Bytes from MSB to LSB are: port id, status byte, data1, data2 -> | "T" -- True. No value needs to be specified. -> | "F" -- False. No value needs to be specified. -> | "N" -- Nil. No value needs to be specified. -> | "I" -- Infinitum. No value needs to be specified. -> ``` - - diff --git a/docs/API/renoise/renoise.Pattern.md b/docs/API/renoise/renoise.Pattern.md deleted file mode 100644 index 02c6a42..0000000 --- a/docs/API/renoise/renoise.Pattern.md +++ /dev/null @@ -1,109 +0,0 @@ -# renoise.Pattern - - - -## Constants - -### MAX_NUMBER_OF_LINES : [`integer`](../../API/builtins/integer.md) -> Maximum number of lines that can be present in a pattern. - - ---- -## Properties -### is_empty : [`boolean`](../../API/builtins/boolean.md) -> Quickly check if any track in a pattern has some non empty pattern lines. -> This does not look at track automation. - -### name : [`string`](../../API/builtins/string.md) -> Name of the pattern, as visible in the pattern sequencer. - -### name_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### number_of_lines : [`integer`](../../API/builtins/integer.md) -> Number of lines the pattern currently has. 64 by default. Max is -> renoise.Pattern.MAX_NUMBER_OF_LINES, min is 1. - -### number_of_lines_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### tracks : [`renoise.PatternTrack`](../../API/renoise/renoise.PatternTrack.md)[] -> **READ-ONLY** Access to the pattern tracks. Each pattern has -> #renoise.song().tracks amount of tracks. - - - ---- -## Functions -### clear([*self*](../../API/builtins/self.md)) -> Deletes all lines & automation. -### copy_from([*self*](../../API/builtins/self.md), other : [`renoise.Pattern`](../../API/renoise/renoise.Pattern.md)) -> Copy contents from other patterns, including automation, when possible. -### track([*self*](../../API/builtins/self.md), index : [`integer`](../../API/builtins/integer.md)) -`->`[`renoise.PatternTrack`](../../API/renoise/renoise.PatternTrack.md) - -> Access to a single pattern track by index. Use properties 'tracks' to -> iterate over all tracks and to query the track count. -### has_line_notifier([*self*](../../API/builtins/self.md), func : [`PatternLineChangeCallbackWithContext`](#PatternLineChangeCallbackWithContext), obj : [`table`](../../API/builtins/table.md) | [`userdata`](../../API/builtins/userdata.md)) -`->`[`boolean`](../../API/builtins/boolean.md) - -> Check/add/remove notifier functions or methods, which are called by Renoise -> as soon as any of the pattern's lines have changed. -> The notifiers are called as soon as a new line is added, an existing line -> is cleared, or existing lines are somehow changed (notes, effects, anything) -> -> A single argument is passed to the notifier function: "pos", a table with the -> fields "pattern", "track" and "line", which defines where the change has -> happened. -> -> #### examples: -> ```lua -> function my_pattern_line_notifier(pos) -> -- check pos.pattern, pos.track, pos.line (all are indices) -> end -> ``` -> Please be gentle with these notifiers, don't do too much stuff in there. -> Ideally just set a flag like "pattern_dirty" which then gets picked up by -> an app_idle notifier: The danger here is that line change notifiers can -> be called hundreds of times when, for example, simply clearing a pattern. -> -> If you are only interested in changes that are made to the currently edited -> pattern, dynamically attach and detach to the selected pattern's line -> notifiers by listening to "renoise.song().selected_pattern_observable". -### add_line_notifier([*self*](../../API/builtins/self.md), func : [`PatternLineChangeCallbackWithContext`](#PatternLineChangeCallbackWithContext), obj : [`table`](../../API/builtins/table.md) | [`userdata`](../../API/builtins/userdata.md)) -### remove_line_notifier([*self*](../../API/builtins/self.md), func : [`PatternLineChangeCallbackWithContext`](#PatternLineChangeCallbackWithContext), obj : [`table`](../../API/builtins/table.md) | [`userdata`](../../API/builtins/userdata.md)) -### has_line_edited_notifier([*self*](../../API/builtins/self.md), func : [`PatternLineChangeCallbackWithContext`](#PatternLineChangeCallbackWithContext), obj : [`table`](../../API/builtins/table.md) | [`userdata`](../../API/builtins/userdata.md)) -`->`[`boolean`](../../API/builtins/boolean.md) - -> Same as `line_notifier`, but the notifier only fires when the user -> added, changed or deleted a line with the computer or MIDI keyboard. -### add_line_edited_notifier([*self*](../../API/builtins/self.md), func : [`PatternLineChangeCallbackWithContext`](#PatternLineChangeCallbackWithContext), obj : [`table`](../../API/builtins/table.md) | [`userdata`](../../API/builtins/userdata.md)) -### remove_line_edited_notifier([*self*](../../API/builtins/self.md), func : [`PatternLineChangeCallbackWithContext`](#PatternLineChangeCallbackWithContext), obj : [`table`](../../API/builtins/table.md) | [`userdata`](../../API/builtins/userdata.md)) - - - ---- -## Structs -# PatternLinePosition -> Line iterator position. - ---- -## Properties -### pattern : [`integer`](../../API/builtins/integer.md) -### track : [`integer`](../../API/builtins/integer.md) -### line : [`integer`](../../API/builtins/integer.md) - - - - - - ---- -## Aliases -### PatternLineChangeCallbackWithContext -(obj : [`table`](../../API/builtins/table.md) | [`userdata`](../../API/builtins/userdata.md), pos : [`PatternLinePosition`](#patternlineposition)) - - - diff --git a/docs/API/renoise/renoise.PatternIterator.md b/docs/API/renoise/renoise.PatternIterator.md deleted file mode 100644 index 4f72769..0000000 --- a/docs/API/renoise/renoise.PatternIterator.md +++ /dev/null @@ -1,99 +0,0 @@ -# renoise.PatternIterator -> Lua pairs/ipairs alike iterator functions to walk through all lines or columns -> in the entire song, track or a single pattern. -> -> General remarks: Iterators can only be use in "for" loops like you would use -> "pairs" in Lua. -> -> #### examples: -> ```lua -> for pos,line in renoise.song().pattern_iterator:lines_in_song() do [...] end -> ``` -> The returned `pos` is a table with "pattern", "track", "line" fields, and an -> additional "column" field for the note/effect columns. -> -> The `visible_only` flag controls if all content should be traversed, or only -> the currently used patterns, columns, and so on. Patterns are traversed in the -> order they are referenced in the pattern sequence, but each pattern is accessed -> only once. - - - - ---- -## Functions -### lines_in_song([*self*](../../API/builtins/self.md), visible_only : [`boolean`](../../API/builtins/boolean.md)[`?`](../../API/builtins/nil.md)) -`->`(context : [`unknown`](../../API/builtins/unknown.md)) `->` [`PatternLinePosition`](#patternlineposition), [`renoise.PatternLine`](../../API/renoise/renoise.PatternLine.md), line : [`renoise.PatternLine`](../../API/renoise/renoise.PatternLine.md), pos : [`PatternLinePosition`](#patternlineposition) - -> Iterate over all pattern lines in the song. -### note_columns_in_song([*self*](../../API/builtins/self.md), visible_only : [`boolean`](../../API/builtins/boolean.md)[`?`](../../API/builtins/nil.md)) -`->`(context : [`unknown`](../../API/builtins/unknown.md)) `->` [`PatternColumnPosition`](#patterncolumnposition), [`renoise.NoteColumn`](../../API/renoise/renoise.NoteColumn.md), column : [`renoise.NoteColumn`](../../API/renoise/renoise.NoteColumn.md), pos : [`PatternColumnPosition`](#patterncolumnposition) - -> Iterate over all note columns in the song. -### effect_columns_in_song([*self*](../../API/builtins/self.md), visible_only : [`boolean`](../../API/builtins/boolean.md)[`?`](../../API/builtins/nil.md)) -`->`(context : [`unknown`](../../API/builtins/unknown.md)) `->` [`PatternColumnPosition`](#patterncolumnposition), [`renoise.EffectColumn`](../../API/renoise/renoise.EffectColumn.md), column : [`renoise.EffectColumn`](../../API/renoise/renoise.EffectColumn.md), pos : [`PatternColumnPosition`](#patterncolumnposition) - -> Iterate over all effect columns in the song. -### lines_in_pattern([*self*](../../API/builtins/self.md), pattern_index : [`integer`](../../API/builtins/integer.md)) -`->`(context : [`unknown`](../../API/builtins/unknown.md)) `->` [`PatternLinePosition`](#patternlineposition), [`renoise.PatternLine`](../../API/renoise/renoise.PatternLine.md), line : [`renoise.PatternLine`](../../API/renoise/renoise.PatternLine.md), pos : [`PatternLinePosition`](#patternlineposition) - -> Iterate over all lines in the given pattern only. -### note_columns_in_pattern([*self*](../../API/builtins/self.md), pattern_index : [`integer`](../../API/builtins/integer.md), visible_only : [`boolean`](../../API/builtins/boolean.md)[`?`](../../API/builtins/nil.md)) -`->`(context : [`unknown`](../../API/builtins/unknown.md)) `->` [`PatternColumnPosition`](#patterncolumnposition), [`renoise.NoteColumn`](../../API/renoise/renoise.NoteColumn.md), column : [`renoise.NoteColumn`](../../API/renoise/renoise.NoteColumn.md), pos : [`PatternColumnPosition`](#patterncolumnposition) - -> Iterate over all note columns in the specified pattern. -### effect_columns_in_pattern([*self*](../../API/builtins/self.md), pattern_index : [`integer`](../../API/builtins/integer.md), visible_only : [`boolean`](../../API/builtins/boolean.md)[`?`](../../API/builtins/nil.md)) -`->`(context : [`unknown`](../../API/builtins/unknown.md)) `->` [`PatternColumnPosition`](#patterncolumnposition), [`renoise.EffectColumn`](../../API/renoise/renoise.EffectColumn.md), column : [`renoise.EffectColumn`](../../API/renoise/renoise.EffectColumn.md), pos : [`PatternColumnPosition`](#patterncolumnposition) - -> Iterate over all note columns in the specified pattern. -### lines_in_track([*self*](../../API/builtins/self.md), track_index : [`integer`](../../API/builtins/integer.md), visible_only : [`boolean`](../../API/builtins/boolean.md)[`?`](../../API/builtins/nil.md)) -`->`(context : [`unknown`](../../API/builtins/unknown.md)) `->` [`PatternLinePosition`](#patternlineposition), [`renoise.PatternLine`](../../API/renoise/renoise.PatternLine.md), line : [`renoise.PatternLine`](../../API/renoise/renoise.PatternLine.md), pos : [`PatternLinePosition`](#patternlineposition) - -> Iterate over all lines in the given track only. -### note_columns_in_track([*self*](../../API/builtins/self.md), track_index : [`integer`](../../API/builtins/integer.md), visible_only : [`boolean`](../../API/builtins/boolean.md)[`?`](../../API/builtins/nil.md)) -`->`(context : [`unknown`](../../API/builtins/unknown.md)) `->` [`PatternColumnPosition`](#patterncolumnposition), [`renoise.NoteColumn`](../../API/renoise/renoise.NoteColumn.md), column : [`renoise.NoteColumn`](../../API/renoise/renoise.NoteColumn.md), pos : [`PatternColumnPosition`](#patterncolumnposition) - -> Iterate over all note/effect columns in the specified track. -### effect_columns_in_track([*self*](../../API/builtins/self.md), track_index : [`integer`](../../API/builtins/integer.md), visible_only : [`boolean`](../../API/builtins/boolean.md)[`?`](../../API/builtins/nil.md)) -`->`(context : [`unknown`](../../API/builtins/unknown.md)) `->` [`PatternColumnPosition`](#patterncolumnposition), [`renoise.EffectColumn`](../../API/renoise/renoise.EffectColumn.md), column : [`renoise.EffectColumn`](../../API/renoise/renoise.EffectColumn.md), pos : [`PatternColumnPosition`](#patterncolumnposition) - -### lines_in_pattern_track([*self*](../../API/builtins/self.md), pattern_index : [`integer`](../../API/builtins/integer.md), track_index : [`integer`](../../API/builtins/integer.md)) -`->`(context : [`unknown`](../../API/builtins/unknown.md)) `->` [`PatternLinePosition`](#patternlineposition), [`renoise.PatternLine`](../../API/renoise/renoise.PatternLine.md), line : [`renoise.PatternLine`](../../API/renoise/renoise.PatternLine.md), pos : [`PatternLinePosition`](#patternlineposition) - -> Iterate over all lines in the given pattern, track only. -### note_columns_in_pattern_track([*self*](../../API/builtins/self.md), pattern_index : [`integer`](../../API/builtins/integer.md), track_index : [`integer`](../../API/builtins/integer.md), visible_only : [`boolean`](../../API/builtins/boolean.md)[`?`](../../API/builtins/nil.md)) -`->`(context : [`unknown`](../../API/builtins/unknown.md)) `->` [`PatternColumnPosition`](#patterncolumnposition), [`renoise.NoteColumn`](../../API/renoise/renoise.NoteColumn.md), column : [`renoise.NoteColumn`](../../API/renoise/renoise.NoteColumn.md), pos : [`PatternColumnPosition`](#patterncolumnposition) - -> Iterate over all note/effect columns in the specified pattern track. -### effect_columns_in_pattern_track([*self*](../../API/builtins/self.md), pattern_index : [`integer`](../../API/builtins/integer.md), track_index : [`integer`](../../API/builtins/integer.md), visible_only : [`boolean`](../../API/builtins/boolean.md)[`?`](../../API/builtins/nil.md)) -`->`(context : [`unknown`](../../API/builtins/unknown.md)) `->` [`PatternColumnPosition`](#patterncolumnposition), [`renoise.EffectColumn`](../../API/renoise/renoise.EffectColumn.md), column : [`renoise.EffectColumn`](../../API/renoise/renoise.EffectColumn.md), pos : [`PatternColumnPosition`](#patterncolumnposition) - - - - ---- -## Structs -# PatternColumnPosition -> Note/Effect column iterator position. - ---- -## Properties -### pattern : [`integer`](../../API/builtins/integer.md) -### track : [`integer`](../../API/builtins/integer.md) -### line : [`integer`](../../API/builtins/integer.md) -### column : [`integer`](../../API/builtins/integer.md) - - - -# PatternLinePosition -> Line iterator position. - ---- -## Properties -### pattern : [`integer`](../../API/builtins/integer.md) -### track : [`integer`](../../API/builtins/integer.md) -### line : [`integer`](../../API/builtins/integer.md) - - - - diff --git a/docs/API/renoise/renoise.PatternLine.md b/docs/API/renoise/renoise.PatternLine.md deleted file mode 100644 index 886377d..0000000 --- a/docs/API/renoise/renoise.PatternLine.md +++ /dev/null @@ -1,51 +0,0 @@ -# renoise.PatternLine - - - -## Constants - -### EMPTY_NOTE : [`integer`](../../API/builtins/integer.md) -### NOTE_OFF : [`integer`](../../API/builtins/integer.md) -### EMPTY_INSTRUMENT : [`integer`](../../API/builtins/integer.md) -### EMPTY_VOLUME : [`integer`](../../API/builtins/integer.md) -### EMPTY_PANNING : [`integer`](../../API/builtins/integer.md) -### EMPTY_DELAY : [`integer`](../../API/builtins/integer.md) -### EMPTY_EFFECT_NUMBER : [`integer`](../../API/builtins/integer.md) -### EMPTY_EFFECT_AMOUNT : [`integer`](../../API/builtins/integer.md) - ---- -## Properties -### is_empty : [`boolean`](../../API/builtins/boolean.md) -> **READ-ONLY** - -### note_columns : [`renoise.NoteColumn`](../../API/renoise/renoise.NoteColumn.md)[] -> **READ-ONLY** - -### effect_columns : [`renoise.EffectColumn`](../../API/renoise/renoise.EffectColumn.md)[] -> **READ-ONLY** - - - ---- -## Functions -### clear([*self*](../../API/builtins/self.md)) -> Clear all note and effect columns. -### copy_from([*self*](../../API/builtins/self.md), other : [`renoise.PatternLine`](../../API/renoise/renoise.PatternLine.md)) -> Copy contents from other_line, trashing column content. -### note_column([*self*](../../API/builtins/self.md), index : [`integer`](../../API/builtins/integer.md)) -`->`[`renoise.NoteColumn`](../../API/renoise/renoise.NoteColumn.md) - -> Access to a single note column by index. Use properties 'note_columns' -> to iterate over all note columns and to query the note_column count. -> This is a !lot! more efficient than calling the property: -> note_columns[index] to randomly access columns. When iterating over all -> columns, use pairs(note_columns). -### effect_column([*self*](../../API/builtins/self.md), index : [`integer`](../../API/builtins/integer.md)) -`->`[`renoise.EffectColumn`](../../API/renoise/renoise.EffectColumn.md) - -> Access to a single effect column by index. Use properties 'effect_columns' -> to iterate over all effect columns and to query the effect_column count. -> This is a !lot! more efficient than calling the property: -> effect_columns[index] to randomly access columns. When iterating over all -> columns, use pairs(effect_columns). - diff --git a/docs/API/renoise/renoise.PatternSequencer.md b/docs/API/renoise/renoise.PatternSequencer.md deleted file mode 100644 index 3ee5f73..0000000 --- a/docs/API/renoise/renoise.PatternSequencer.md +++ /dev/null @@ -1,118 +0,0 @@ -# renoise.PatternSequencer -> Pattern sequencer component of the Renoise song. - - - - ---- -## Properties -### keep_sequence_sorted : [`boolean`](../../API/builtins/boolean.md) -> When true, the sequence will be auto sorted. - -### keep_sequence_sorted_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### selection_range : [`integer`](../../API/builtins/integer.md)[] -> Access to the selected slots in the sequencer. When no selection is present -> `{0, 0}` is returned, else Range: (1 - #sequencer.pattern_sequence) - -### selection_range_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### pattern_sequence : [`integer`](../../API/builtins/integer.md)[] -> Pattern order list: Notifiers will only be fired when sequence positions are -> added, removed or their order changed. To get notified of pattern assignment -> changes use the property `pattern_assignments_observable`. -> Use `set_pattern` to change a single pattern in the sequence. - -### pattern_sequence_observable : [`renoise.Document.ObservableList`](../../API/renoise/renoise.Document.ObservableList.md) -> Track changes to document lists by attaching listener functions to it. -> NB: Notifiers will not broadcast changes made to list items, but only changes -> to the lists **layout** (items got added, removed, swapped). - -### pattern_assignments_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Attach notifiers that will be called as soon as any pattern assignment -> at any sequence position changes. - -### pattern_slot_mutes_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Attach notifiers that will be fired as soon as any slot muting property -> in any track/sequence slot changes. - - - ---- -## Functions -### insert_sequence_at([*self*](../../API/builtins/self.md), sequence_index : [`integer`](../../API/builtins/integer.md), pattern_index : [`integer`](../../API/builtins/integer.md)) -> Insert the specified pattern at the given position in the sequence. -### insert_new_pattern_at([*self*](../../API/builtins/self.md), sequence_index : [`integer`](../../API/builtins/integer.md)) -`->`new_pattern_index : [`integer`](../../API/builtins/integer.md) - -> Insert an empty, unreferenced pattern at the given position. -### delete_sequence_at([*self*](../../API/builtins/self.md), sequence_index : [`any`](../../API/builtins/any.md)) -> Delete an existing position in the sequence. Renoise needs at least one -> sequence in the song for playback. Completely removing all sequence positions -> is not allowed. -### pattern([*self*](../../API/builtins/self.md), sequence_index : [`integer`](../../API/builtins/integer.md)) -`->`pattern_index : [`integer`](../../API/builtins/integer.md) - -> Access to a single sequence by index (the pattern number). Use property -> `pattern_sequence` to iterate over the whole sequence and to query the -> sequence count. -### set_pattern([*self*](../../API/builtins/self.md), sequence_index : [`integer`](../../API/builtins/integer.md), pattern_index : [`integer`](../../API/builtins/integer.md)) -> Change a single assigned pattern for the given sequence index. Use `pattern_sequence` -> to iterate or change the whole sequence and to query the sequence count. -### clone_range([*self*](../../API/builtins/self.md), from_sequence_index : [`integer`](../../API/builtins/integer.md), to_sequence_index : [`integer`](../../API/builtins/integer.md)) -> Clone a sequence range, appending it right after to_sequence_index. -> Slot muting is copied as well. -### make_range_unique([*self*](../../API/builtins/self.md), from_sequence_index : [`integer`](../../API/builtins/integer.md), to_sequence_index : [`integer`](../../API/builtins/integer.md)) -> Make patterns in the given sequence pos range unique, if needed. -### sort([*self*](../../API/builtins/self.md)) -> Sort patterns in the sequence in ascending order, keeping the old pattern -> data in place. This will only change the visual order of patterns, but -> not change the song's structure. -### sequence_is_start_of_section([*self*](../../API/builtins/self.md), sequence_index : [`integer`](../../API/builtins/integer.md)) -`->`[`boolean`](../../API/builtins/boolean.md), [`boolean`](../../API/builtins/boolean.md) - -> Access to pattern sequence sections. When the `is_start_of_section flag` is -> set for a sequence pos, a section ranges from this pos to the next pos -> which starts a section, or till the end of the song when there are no others. -### set_sequence_is_start_of_section([*self*](../../API/builtins/self.md), sequence_index : [`integer`](../../API/builtins/integer.md), is_section : [`boolean`](../../API/builtins/boolean.md)) -### sequence_is_start_of_section_observable([*self*](../../API/builtins/self.md), sequence_index : [`integer`](../../API/builtins/integer.md)) -`->`[`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) - -### sequence_section_name([*self*](../../API/builtins/self.md), sequence_index : [`integer`](../../API/builtins/integer.md)) -`->`[`string`](../../API/builtins/string.md) - -> Access to a pattern sequence section's name. Section names are only visible -> for a sequence pos which starts the section (see `sequence_is_start_of_section`). -### set_sequence_section_name([*self*](../../API/builtins/self.md), sequence_index : [`integer`](../../API/builtins/integer.md), name : [`string`](../../API/builtins/string.md)) -### sequence_section_name_observable([*self*](../../API/builtins/self.md), sequence_index : [`integer`](../../API/builtins/integer.md)) -`->`[`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) - -### sequence_is_part_of_section([*self*](../../API/builtins/self.md), sequence_index : [`integer`](../../API/builtins/integer.md)) -`->`[`boolean`](../../API/builtins/boolean.md) - -> Returns true if the given sequence pos is part of a section, else false. -### sequence_is_end_of_section([*self*](../../API/builtins/self.md), sequence_index : [`integer`](../../API/builtins/integer.md)) -`->`[`boolean`](../../API/builtins/boolean.md) - -> Returns true if the given sequence pos is the end of a section, else false -### sequence_sections_changed_observable([*self*](../../API/builtins/self.md)) -`->`[`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) - -> Observable, which is fired, whenever the section layout in the sequence -> changed in any way, i.e. new sections got added, existing ones got deleted -### track_sequence_slot_is_muted([*self*](../../API/builtins/self.md), track_index : [`integer`](../../API/builtins/integer.md), sequence_index : [`integer`](../../API/builtins/integer.md)) -`->`[`boolean`](../../API/builtins/boolean.md) - -> Access to sequencer slot mute states. Mute slots are memorized in the -> sequencer and not in the patterns. -### set_track_sequence_slot_is_muted([*self*](../../API/builtins/self.md), track_index : [`integer`](../../API/builtins/integer.md), sequence_index : [`integer`](../../API/builtins/integer.md), muted : [`any`](../../API/builtins/any.md)) -### track_sequence_slot_is_selected([*self*](../../API/builtins/self.md), track_index : [`integer`](../../API/builtins/integer.md), sequence_index : [`integer`](../../API/builtins/integer.md)) -`->`[`boolean`](../../API/builtins/boolean.md) - -> Access to sequencer slot selection states. -### set_track_sequence_slot_is_selected([*self*](../../API/builtins/self.md), track_index : [`integer`](../../API/builtins/integer.md), sequence_index : [`integer`](../../API/builtins/integer.md), selected : [`any`](../../API/builtins/any.md)) - diff --git a/docs/API/renoise/renoise.PatternTrack.md b/docs/API/renoise/renoise.PatternTrack.md deleted file mode 100644 index 60e67b0..0000000 --- a/docs/API/renoise/renoise.PatternTrack.md +++ /dev/null @@ -1,89 +0,0 @@ -# renoise.PatternTrack - - - - ---- -## Properties -### is_alias : [`boolean`](../../API/builtins/boolean.md) -> **READ-ONLY** - -### alias_pattern_index : [`integer`](../../API/builtins/integer.md) -> index or 0 when no alias is present - -### alias_pattern_index_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### color : [`RGBColor`](#RGBColor)[`?`](../../API/builtins/nil.md) -> slot color of the pattern in the matrix, nil when no slot color is set - -### color_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### is_empty : [`boolean`](../../API/builtins/boolean.md) -> Returns true when all the track lines are empty. Does not look at automation. - -### is_empty_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### lines : [`renoise.PatternLine`](../../API/renoise/renoise.PatternLine.md)[] -> **READ-ONLY** Get all lines in range [1, number_of_lines_in_pattern]. -> Use `renoise.Pattern:add/remove_line_notifier` for change notifications. - -### automation : [`renoise.PatternTrackAutomation`](../../API/renoise/renoise.PatternTrackAutomation.md)[] -> Automation. - -### automation_observable : [`renoise.Document.ObservableList`](../../API/renoise/renoise.Document.ObservableList.md) -> Track changes to document lists by attaching listener functions to it. -> NB: Notifiers will not broadcast changes made to list items, but only changes -> to the lists **layout** (items got added, removed, swapped). - - - ---- -## Functions -### clear([*self*](../../API/builtins/self.md)) -> Deletes all lines & automation. -### copy_from([*self*](../../API/builtins/self.md), other : [`renoise.PatternTrack`](../../API/renoise/renoise.PatternTrack.md)) -> Copy contents from other pattern tracks, including automation when possible. -### line([*self*](../../API/builtins/self.md), index : [`integer`](../../API/builtins/integer.md)) -`->`[`renoise.PatternLine`](../../API/renoise/renoise.PatternLine.md) - -> Access to a single line by index. Line must be in Range: (1 - MAX_NUMBER_OF_LINES). -> This is a !lot! more efficient than calling the property: lines[index] to -> randomly access lines. -### lines_in_range([*self*](../../API/builtins/self.md), index_from : [`integer`](../../API/builtins/integer.md), index_to : [`integer`](../../API/builtins/integer.md)) -`->`[`renoise.PatternLine`](../../API/renoise/renoise.PatternLine.md)[] - -> Get a specific line range. Index must be Range: (1 - Pattern.MAX_NUMBER_OF_LINES) -### find_automation([*self*](../../API/builtins/self.md), parameter : [`renoise.DeviceParameter`](../../API/renoise/renoise.DeviceParameter.md)) -`->`[`renoise.PatternTrackAutomation`](../../API/renoise/renoise.PatternTrackAutomation.md)[`?`](../../API/builtins/nil.md) - -> Returns the automation for the given device parameter or nil when there is -> none. -### create_automation([*self*](../../API/builtins/self.md), parameter : [`renoise.DeviceParameter`](../../API/renoise/renoise.DeviceParameter.md)) -`->`[`renoise.PatternTrackAutomation`](../../API/renoise/renoise.PatternTrackAutomation.md) - -> Creates a new automation for the given device parameter. -> Fires an error when an automation for the given parameter already exists. -> Returns the newly created automation. Passed parameter must be automatable, -> which can be tested with 'parameter.is_automatable'. -### delete_automation([*self*](../../API/builtins/self.md), parameter : [`renoise.DeviceParameter`](../../API/renoise/renoise.DeviceParameter.md)) -> Remove an existing automation the given device parameter. Automation -> must exist. - - - ---- -## Aliases -### RGBColor -{ 1 : [`integer`](../../API/builtins/integer.md), 2 : [`integer`](../../API/builtins/integer.md), 3 : [`integer`](../../API/builtins/integer.md) } -> A table of 3 bytes (ranging from 0 to 255) -> representing the red, green and blue channels of a color. -> {0xFF, 0xFF, 0xFF} is white -> {165, 73, 35} is the red from the Renoise logo - - diff --git a/docs/API/renoise/renoise.PatternTrackAutomation.md b/docs/API/renoise/renoise.PatternTrackAutomation.md deleted file mode 100644 index 703ae19..0000000 --- a/docs/API/renoise/renoise.PatternTrackAutomation.md +++ /dev/null @@ -1,121 +0,0 @@ -# renoise.PatternTrackAutomation -> Graphical automation of a device parameter within a pattern track. -> -> General remarks: Automation "time" is specified in lines + optional 1/256 -> line fraction for the sub line grid. The sub line grid has 256 units per -> line. All times are internally quantized to this sub line grid. -> For example a time of 1.5 means: line 1 with a note column delay of 128 - - - -## Constants -### Playmode -> ```lua -> { -> PLAYMODE_POINTS: integer = 1, -> PLAYMODE_LINES: integer = 2, -> PLAYMODE_CURVES: integer = 3, -> } -> ``` - - ---- -## Properties -### dest_device : [`renoise.AudioDevice`](../../API/renoise/renoise.AudioDevice.md) -> Destination device. Can in some rare circumstances be nil, i.e. when -> a device or track is about to be deleted. - -### dest_parameter : [`renoise.DeviceParameter`](../../API/renoise/renoise.DeviceParameter.md) -> Destination device's parameter. Can in some rare circumstances be nil, -> i.e. when a device or track is about to be deleted. - -### playmode : [`renoise.PatternTrackAutomation.Playmode`](renoise.PatternTrackAutomation.md#Playmode) -> play-mode (interpolation mode). - -### playmode_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### length : [`integer`](../../API/builtins/integer.md) -> Range: (1 - NUM_LINES_IN_PATTERN) - -### selection_start : [`integer`](../../API/builtins/integer.md) -> Range: (1 - automation.length + 1) - -### selection_start_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### selection_end : [`integer`](../../API/builtins/integer.md) -> Range: (1 - automation.length + 1) - -### selection_end_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### selection_range : [`integer`](../../API/builtins/integer.md)[] -> Get or set selection range. when setting an empty table, the existing -> selection, if any, will be cleared. -> array of two numbers [] OR Range: (1 - automation.length + 1) - -### selection_range_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### points : [`EnvelopePoint`](#envelopepoint)[] -> Get all points of the automation. When setting a new list of points, -> items may be unsorted by time, but there may not be multiple points -> for the same time. Returns a copy of the list, so changing -> `points[1].value` will not do anything. Instead, change them via -> `points = { modified_points }`. - -### points_observable : [`renoise.Document.ObservableList`](../../API/renoise/renoise.Document.ObservableList.md) -> Track changes to document lists by attaching listener functions to it. -> NB: Notifiers will not broadcast changes made to list items, but only changes -> to the lists **layout** (items got added, removed, swapped). - - - ---- -## Functions -### clear([*self*](../../API/builtins/self.md)) -> Removes all points from the automation. Will not delete the automation -> from tracks[]:automation, instead the resulting automation will not do -> anything at all. -### clear_range([*self*](../../API/builtins/self.md), from_time : [`integer`](../../API/builtins/integer.md), to_time : [`integer`](../../API/builtins/integer.md)) -> Remove all existing points in the given [from, to) time range from the -> automation. -### copy_from([*self*](../../API/builtins/self.md), other : [`renoise.PatternTrackAutomation`](../../API/renoise/renoise.PatternTrackAutomation.md)) -> Copy all points and playback settings from another track automation. -### has_point_at([*self*](../../API/builtins/self.md), time : [`integer`](../../API/builtins/integer.md)) -`->`[`boolean`](../../API/builtins/boolean.md) - -> Test if a point exists at the given time -### add_point_at([*self*](../../API/builtins/self.md), time : [`integer`](../../API/builtins/integer.md), value : [`number`](../../API/builtins/number.md), scaling : [`number`](../../API/builtins/number.md)[`?`](../../API/builtins/nil.md)) -> Insert a new point, or change an existing one, if a point in -> time already exists. -### remove_point_at([*self*](../../API/builtins/self.md), time : [`integer`](../../API/builtins/integer.md)) -> Removes a point at the given time. Point must exist. - - - ---- -## Structs -# EnvelopePoint -> Single point within a pattern track automation envelope. - ---- -## Properties -### time : [`integer`](../../API/builtins/integer.md) -> Automation point's time in pattern lines in Range: (1 - NUM_LINES_IN_PATTERN). - -### value : [`number`](../../API/builtins/number.md) -> Automation point value in Range: (0 - 1.0) - -### scaling : [`number`](../../API/builtins/number.md) -> Automation point scaling. Used in 'lines' playback mode only - 0.0 is linear. - - - - - diff --git a/docs/API/renoise/renoise.SQLite.md b/docs/API/renoise/renoise.SQLite.md deleted file mode 100644 index 69ec13e..0000000 --- a/docs/API/renoise/renoise.SQLite.md +++ /dev/null @@ -1,491 +0,0 @@ -# renoise.SQLite - - - -## Constants -### Status -> ```lua -> { -> OK: integer = 0, -> ERROR: integer = 1, -> INTERNAL: integer = 2, -> PERM: integer = 3, -> ABORT: integer = 4, -> BUSY: integer = 5, -> LOCKED: integer = 6, -> NOMEM: integer = 7, -> READONLY: integer = 8, -> INTERRUPT: integer = 9, -> IOERR: integer = 10, -> CORRUPT: integer = 11, -> NOTFOUND: integer = 12, -> FULL: integer = 13, -> CANTOPEN: integer = 14, -> MISMATCH: integer = 20, -> MISUSE: integer = 21, -> NOLFS: integer = 22, -> FORMAT: integer = 24, -> RANGE: integer = 25, -> NOTADB: integer = 26, -> ROW: integer = 100, -> DONE: integer = 101, -> } -> ``` - - ---- -## Functions -### open(filename : [`string`](../../API/builtins/string.md)[`?`](../../API/builtins/nil.md), flags : [`SQLiteOpenFlags`](#SQLiteOpenFlags) | [`SQLiteOpenModes`](#SQLiteOpenModes)[`?`](../../API/builtins/nil.md)) -`->`[`SQLiteDatabase`](#sqlitedatabase)[`?`](../../API/builtins/nil.md), [`renoise.SQLite.Status`](renoise.SQLite.md#Status)[`?`](../../API/builtins/nil.md), [`string`](../../API/builtins/string.md)[`?`](../../API/builtins/nil.md) - -> Opens (or creates if it does not exist) a SQLite database either in memory -> or from the given file path. -> -> ### Examples: -> -> ```lua -> -- open an existing db in read-only mode. -> local db, status, error = renoise.SQLite.open('MyDatabase.sqlite', 'ro') -> if db then -> -- do some database calls... -> db:close() -> else -> -- handle error -> end -> -> -- open an in-memory db in read-write-create mode. -> local db, status, error = renoise.SQLite.open() -> if db then -> -- do some database calls... -> db:close() -> else -> -- handle error -> end -> ``` -> -> -> ```lua -> -- Configure database open mode. -> -- Default: "rwc" (read-write-create). -> -- Raw open mode flags from SQLite. -> -- See https://sqlite.org/c3ref/open.html#urifilenamesinsqlite3open -> flags: -> | "ro" -> | "rw" -> | "rwc" -> ``` - - - ---- -## Structs -# SQLiteDatabase - ---- -## Properties -### is_open : [`boolean`](../../API/builtins/boolean.md) -> **READ-ONLY** Whether or not the database is open. - -### is_closed : [`boolean`](../../API/builtins/boolean.md) -> **READ-ONLY** Whether or not the database is closed. - -### error_code : [`renoise.SQLite.Status`](renoise.SQLite.md#Status) -> **READ-ONLY** The most recent error code. - -### error_message : [`string`](../../API/builtins/string.md) -> **READ-ONLY** The most recent error message. - -### changes : [`integer`](../../API/builtins/integer.md) -> **READ-ONLY** Number of database rows that were changed, inserted, or deleted by -> the most recent SQL statement. -> Only changes that are directly specified by INSERT, UPDATE, or DELETE statements -> are counted. -> Auxiliary changes caused by triggers are not counted. Use `db.total_changes` -> to find the total number of changes. - -### total_changes : [`integer`](../../API/builtins/integer.md) -> **READ-ONLY** The number of database rows that have been modified by INSERT, -> UPDATE or DELETE statements since the database was opened. -> This includes UPDATE, INSERT and DELETE statements executed as part of -> trigger programs. All changes are counted as soon as the statement that -> produces them is completed by calling either `stmt:reset()` or `stmt:finalize()`. - -### last_insert_rowid : [`integer`](../../API/builtins/integer.md) -> **READ-ONLY** Gets the rowid of the most recent INSERT into the database. -> If no inserts have ever occurred, 0 is returned. -> (Each row in an SQLite table has a unique 64-bit signed integer -> key called the 'rowid'. This id is always available as an undeclared -> column named ROWID, OID, or _ROWID_. -> If the table has a column of type INTEGER PRIMARY KEY then that column -> is another alias for the rowid.) -> -> If an INSERT occurs within a trigger, then the rowid of the inserted -> row is returned as long as the trigger is running. Once the trigger terminates, -> the value returned reverts to the last value inserted before the trigger fired. - - - ---- -## Functions -### close([*self*](../../API/builtins/self.md)) -`->`[`renoise.SQLite.Status`](renoise.SQLite.md#Status) - -> Closes a database. All SQL statements prepared using `db:prepare()` should -> have been finalized before this function is called. -> -> The function returns `renoise.SQLlite.Status.OK` on success or else a error code. -### prepare([*self*](../../API/builtins/self.md), sql : [`string`](../../API/builtins/string.md)) -`->`[`SQLiteStatement`](#sqlitestatement)[`?`](../../API/builtins/nil.md), [`renoise.SQLite.Status`](renoise.SQLite.md#Status), [`string`](../../API/builtins/string.md)[`?`](../../API/builtins/nil.md) - -> Compiles the SQL statement in string sql into an internal representation -> and returns this as userdata. The returned object should be used for all -> further method calls in connection with this specific SQL statement. -> -> The function returns the statement object and `renoise.SQLlite.Status.OK` -> on success or else nil, an error code and the error message. -> -> ### Examples: -> -> ```lua -> local statement, code, error = db:prepare("SELECT * from my_table") -> if statement then -> -- bind, step or do some queries -> else -> -- handle error -> end -> ``` -> See: `SQLiteStatement` -### finalize([*self*](../../API/builtins/self.md), temp_only : [`boolean`](../../API/builtins/boolean.md)[`?`](../../API/builtins/nil.md)) -> Finalizes all statements that have not been explicitly finalized. -### execute([*self*](../../API/builtins/self.md), sql : [`string`](../../API/builtins/string.md), fun : fun(data: any, cols: integer, values: table, names: table)?, data : [`any`](../../API/builtins/any.md)) -`->`[`renoise.SQLite.Status`](renoise.SQLite.md#Status), [`string`](../../API/builtins/string.md)[`?`](../../API/builtins/nil.md) - -> Compiles and executes the SQL statement(s) given in string sql. -> The statements are simply executed one after the other and not stored. -> -> The function returns `renoise.SQLlite.Status.OK` on success or else an -> error code and the error message. -> -> If one or more of the SQL statements are queries, then the callback -> function specified in `fun` is invoked once for each row of the query -> result (if `fun` is `nil`, no callback is invoked). -> -> The callback receives four arguments: -> `data` (the third parameter of the `db:exec()` call), -> the number of columns in the row, a table with the column values -> and another table with the column names. -> -> The callback function should return `0`. If the callback returns -> a non-zero value then the query is aborted, all subsequent SQL statements -> are skipped and `db:exec()` returns `sqlite.ABORT`. -> -> ### Example: -> -> ```lua -> sql = [[ -> CREATE TABLE numbers(num1,num2,str); -> INSERT INTO numbers VALUES(1,11,"ABC"); -> INSERT INTO numbers VALUES(2,22,"DEF"); -> INSERT INTO numbers VALUES(3,33,"UVW"); -> INSERT INTO numbers VALUES(4,44,"XYZ"); -> SELECT * FROM numbers; -> ]] -> function show_row(udata,cols,values,names) -> assert(udata=='test_udata') -> print('exec:') -> for i=1,cols do print('',names[i],values[i]) end -> return 0 -> end -> db:execute(sql,show_row,'test_udata') -> ``` -### interrupt([*self*](../../API/builtins/self.md)) -> Causes any pending database operation to abort and return at the next opportunity. -### busy_handler([*self*](../../API/builtins/self.md), fun : (udata : [`any`](../../API/builtins/any.md), retries : [`integer`](../../API/builtins/integer.md)) `->` [`boolean`](../../API/builtins/boolean.md)[`?`](../../API/builtins/nil.md), data : [`any`](../../API/builtins/any.md)) -> Sets or removes a busy handler for a SQLiteDatabase. -> `fun` is either a Lua function that implements the busy handler or `nil` -> to remove a previously set handler. This function returns nothing. -> The handler function is called with two parameters: `data` and the number -> of (re-)tries for a pending transaction. -> It should return `nil`, `false` or `0` if the transaction is to be aborted. -> All other values will result in another attempt to perform the transaction. -> -> (See the SQLite documentation for important hints about writing busy handlers.) -### busy_timeout([*self*](../../API/builtins/self.md), t : [`integer`](../../API/builtins/integer.md)) -> Sets a busy handler that waits for `t` milliseconds if a transaction cannot -> proceed. Calling this function will remove any busy handler set by `db:busy_handler()`; -> calling it with an argument less than or equal to 0 will turn off all busy handlers. -### nrows([*self*](../../API/builtins/self.md), sql : [`string`](../../API/builtins/string.md)) -`->`() `->` table<[`string`](../../API/builtins/string.md), [`SQLiteValue`](#SQLiteValue)>[`?`](../../API/builtins/nil.md) - -> Creates an iterator that returns the successive rows selected -> by the SQL statement given in string sql. -> -> Each call to the iterator returns a table in which the named fields correspond -> to the columns in the database. -### rows([*self*](../../API/builtins/self.md), sql : [`string`](../../API/builtins/string.md)) -`->`() `->` [`any`](../../API/builtins/any.md)[] - -> Creates an iterator that returns the successive rows selected by the SQL -> statement given in string `sql`. Each call to the iterator returns a table -> in which the numerical indices 1 to n correspond to the selected columns -> 1 to n in the database. -> -> ### Example: -> -> ```lua -> for a in db:rows('SELECT * FROM table') do -> for _,v in ipairs(a) do print(v) end -> end -> ``` -### urows([*self*](../../API/builtins/self.md), sql : [`string`](../../API/builtins/string.md)) -`->`() `->` [`SQLiteValue`](#SQLiteValue)[`?`](../../API/builtins/nil.md) - -> Creates an iterator that returns the successive rows selected by the SQL -> statement given in string sql. Each call to the iterator returns the values -> that correspond to the columns in the currently selected row. -> -> ### Example: -> -> ```lua -> for num1,num2 in db:urows('SELECT * FROM table') do -> print(num1,num2) -> end -> ``` - - - ---- -## Aliases -### SQLiteValue -[`string`](../../API/builtins/string.md) | [`integer`](../../API/builtins/integer.md) - - - - -# SQLiteStatement -> Precompiled SQLite statements, as created with `db:prepare()`. - ---- -## Properties -### is_open : [`boolean`](../../API/builtins/boolean.md) -> **READ-ONLY** Whether or not the statement hasn't been finalized. - -### is_closed : [`boolean`](../../API/builtins/boolean.md) -> **READ-ONLY** Whether or not the statement has been finalized. - -### columns : [`integer`](../../API/builtins/integer.md) -> **READ-ONLY** Number of columns in the result set returned by the statement, -> or 0 if the statement does not return data (for example an UPDATE). - -### last_insert_rowid : [`integer`](../../API/builtins/integer.md) -> **READ-ONLY** rowid of the most recent INSERT into the database corresponding -> to this statement. - -### named_types : table<[`string`](../../API/builtins/string.md), [`string`](../../API/builtins/string.md)> -> **READ-ONLY** A table with the names and types of all columns in the current -> result set of the statement. - -### named_values : table<[`string`](../../API/builtins/string.md), [`SQLiteValue`](#SQLiteValue)> -> **READ-ONLY** A table with names and values of all columns in the current -> result row of a query. - -### names : [`string`](../../API/builtins/string.md)[] -> **READ-ONLY** A list of the names of all columns in the result set returned -> by the statement. - -### values : [`SQLiteValue`](#SQLiteValue)[] -> **READ-ONLY** A list of the values of all columns in the result set -> returned by the statement. - -### types : [`string`](../../API/builtins/string.md)[] -> **READ-ONLY** A list of the types of all columns in the result set returned -> by the statement. - -### unames : [`string`](../../API/builtins/string.md)[] -> **READ-ONLY** A list of the names of all columns in the result set returned -> by the statement. - -### utypes : [`string`](../../API/builtins/string.md)[] -> **READ-ONLY** A list of the types of all columns in the result set returned -> by the statement. - -### uvalues : [`SQLiteValue`](#SQLiteValue)[] -> **READ-ONLY** A list of the values of all columns in the current result -> row of a query. - - - ---- -## Functions -### name([*self*](../../API/builtins/self.md), n : [`integer`](../../API/builtins/integer.md)) -`->`[`string`](../../API/builtins/string.md) - -> The name of column `n` in the result set of the statement. -> (The left-most column is number 0.) -### value([*self*](../../API/builtins/self.md), n : [`integer`](../../API/builtins/integer.md)) -`->`[`SQLiteValue`](#SQLiteValue) - -> The value of column `n` in the result set of the statement. -> (The left-most column is number 0.) -### type([*self*](../../API/builtins/self.md), n : [`integer`](../../API/builtins/integer.md)) -`->`[`string`](../../API/builtins/string.md) - -> The type of column `n` in the result set of the statement. -> (The left-most column is number 0.) -### finalize([*self*](../../API/builtins/self.md)) -`->`[`renoise.SQLite.Status`](renoise.SQLite.md#Status) - -> Frees a prepared statement. -> -> If the statement was executed successfully, or not executed at all, -> then `renoise.SQLlite.Status.OK` is returned. If execution of the statement -> failed then an error code is returned. -### reset([*self*](../../API/builtins/self.md)) -> Resets the statement so that it is ready to be re-executed. -> Any statement variables that had values bound to them using -> the `stmt:bind*()` functions retain their values. -### step([*self*](../../API/builtins/self.md)) -`->`[`renoise.SQLite.Status`](renoise.SQLite.md#Status) - -> Evaluates the (next iteration of the) prepared statement. -> It will return one of the following values: -> - `renoise.SQLite.Status.BUSY`: the engine was unable to acquire the locks needed. -> If the statement is a COMMIT or occurs outside of an explicit transaction, -> then you can retry the statement. If the statement is not a COMMIT and -> occurs within a explicit transaction then you should rollback the transaction -> before continuing. -> - `renoise.SQLite.Status.DONE`: the statement has finished executing successfully. -> `stmt:step()` should not be called again on this statement without first -> calling `stmt:reset()` to reset the virtual machine back to the initial state. -> - `renoise.SQLite.Status.ROW`: this is returned each time a new row of data is ready. -> The values may be accessed using the column access functions. -> `stmt:step()` can be called again to retrieve the next row of data. -> - `renoise.SQLite.Status.ERROR`: a run-time error (e.g. a constraint violation) occurred. -> `stmt:step()` should not be called again. More information may be found by -> calling `db:error_message()`. A more specific error code can be obtained by calling -> `stmt:reset()`. -> - `renoise.SQLite.Status.MISUSE`: the function was called inappropriately. -> Perhaps because the statement has already been finalized or a previous call to -> `stmt:step()` has returned `sqlite.ERROR` or `sqlite.DONE`. -### bind_parameter_count([*self*](../../API/builtins/self.md)) -`->`[`integer`](../../API/builtins/integer.md) - -> Gets the largest statement parameter index in prepared statement stmt. -> When the statement parameters are of the forms ":AAA" or "?", then they -> are assigned sequentially increasing numbers beginning with one, so the -> value returned is the number of parameters. -> However if the same statement parameter name is used multiple times, -> each occurrence is given the same number, so the value returned is the -> number of unique statement parameter names. -> -> If statement parameters of the form "?NNN" are used (where NNN is an -> integer) then there might be gaps in the numbering and the value returned -> by this interface is the index of the statement parameter with the largest -> index value. -### bind_parameter_name([*self*](../../API/builtins/self.md), n : [`any`](../../API/builtins/any.md)) -`->`[`string`](../../API/builtins/string.md)[`?`](../../API/builtins/nil.md), [`renoise.SQLite.Status`](renoise.SQLite.md#Status) - -> Gets the name of the `n`-th parameter in prepared statement stmt. -> Statement parameters of the form ":AAA" or "@AAA" or "$VVV" have -> a name which is the string ":AAA" or "@AAA" or "$VVV". -> In other words, the initial ":" or "$" or "@" is included as part of the name. -> Parameters of the form "?" or "?NNN" have no name. -> The first bound parameter has an index of 1. If the value `n` is out of -> range or if the `n`-th parameter is nameless, then nil is returned. -> -> The function returns `renoise.SQLlite.Status.OK` on success or else a numerical error code. -> See: `renoise.SQLite.Status` -### bind([*self*](../../API/builtins/self.md), n : [`integer`](../../API/builtins/integer.md), value : [`boolean`](../../API/builtins/boolean.md) | [`string`](../../API/builtins/string.md) | [`number`](../../API/builtins/number.md)[`?`](../../API/builtins/nil.md)) -`->`[`renoise.SQLite.Status`](renoise.SQLite.md#Status) - -> Binds `value` to statement parameter `n`. If `value` is a string, it is -> bound as text, otherwise if it is a number it is bound as a double. -> If it is a boolean, it is bound as 0 or 1. -> If `value` is nil, any previous binding is removed. -> -> The function returns `renoise.SQLlite.Status.OK` on success or else a error code. -### bind_blob([*self*](../../API/builtins/self.md), n : [`integer`](../../API/builtins/integer.md), blob : [`string`](../../API/builtins/string.md)) -`->`[`renoise.SQLite.Status`](renoise.SQLite.md#Status) - -> Binds string `blob` (which can be a binary string) as a blob to -> statement parameter `n`. -> -> The function returns `renoise.SQLlite.Status.OK` on success or else a error code. -### bind_names([*self*](../../API/builtins/self.md), nametable : table) -`->`[`renoise.SQLite.Status`](renoise.SQLite.md#Status) - -> Binds the values in `nametable` to statement parameters. -> -> If the statement parameters are named (i.e., of the form ":AAA" or "$AAA") -> then this function looks for appropriately named fields in nametable; -> if the statement parameters are not named, it looks for numerical fields 1 -> to the number of statement parameters. -> -> The function returns `renoise.SQLlite.Status.OK` on success or else a error code. -### bind_values([*self*](../../API/builtins/self.md), ...[`boolean`](../../API/builtins/boolean.md) | [`string`](../../API/builtins/string.md) | [`number`](../../API/builtins/number.md)) -`->`[`renoise.SQLite.Status`](renoise.SQLite.md#Status) - -> Binds the given values to statement parameters. -> -> The function returns `renoise.SQLlite.Status.OK` on success or else a error code. -> See: `renoise.SQLite.Status` -### nrows([*self*](../../API/builtins/self.md)) -`->`() `->` table<[`string`](../../API/builtins/string.md), [`string`](../../API/builtins/string.md) | [`integer`](../../API/builtins/integer.md)>[`?`](../../API/builtins/nil.md) - -> Creates an iterator over the names and values of the result -> set of the statement. Each iteration returns a table with the names -> and values for the current row. -> -> This is the prepared statement equivalent of `db:nrows()`. -> See: `SQLiteDatabase.nrows` -### rows([*self*](../../API/builtins/self.md)) -`->`() `->` [`any`](../../API/builtins/any.md)[] - -> Creates an iterator over the values of the result set of the statement. -> Each iteration returns an array with the values for the current row. -> This is the prepared statement equivalent of `db:rows()`. -> See: `SQLiteDatabase.rows` -### urows([*self*](../../API/builtins/self.md)) -`->`() `->` [`string`](../../API/builtins/string.md) | [`number`](../../API/builtins/number.md)[`?`](../../API/builtins/nil.md) - -> Creates an iterator over the values of the result set of the statement. -> Each iteration returns the values for the current row. -> This is the prepared statement equivalent of `db:urows()`. -> See: `SQLiteDatabase.urows` - - - ---- -## Aliases -### SQLiteValue -[`string`](../../API/builtins/string.md) | [`integer`](../../API/builtins/integer.md) - - - - - - - ---- -## Aliases -### SQLiteOpenFlags -[`integer`](../../API/builtins/integer.md) -> Raw open mode flags from SQLite. -> See https://sqlite.org/c3ref/open.html#urifilenamesinsqlite3open - -### SQLiteOpenModes -`"ro"` | `"rw"` | `"rwc"` -> ```lua -> -- Configure database open mode. -> -- Default: "rwc" (read-write-create). -> SQLiteOpenModes: -> | "ro" -> | "rw" -> | "rwc" -> ``` - -### SQLiteValue -[`string`](../../API/builtins/string.md) | [`integer`](../../API/builtins/integer.md) - - - diff --git a/docs/API/renoise/renoise.Sample.md b/docs/API/renoise/renoise.Sample.md deleted file mode 100644 index 9d7de89..0000000 --- a/docs/API/renoise/renoise.Sample.md +++ /dev/null @@ -1,234 +0,0 @@ -# renoise.Sample - - - -## Constants -### InterpolationMode -> ```lua -> { -> INTERPOLATE_NONE: integer = 1, -> INTERPOLATE_LINEAR: integer = 2, -> INTERPOLATE_CUBIC: integer = 3, -> INTERPOLATE_SINC: integer = 4, -> } -> ``` -### LoopMode -> ```lua -> { -> LOOP_MODE_OFF: integer = 1, -> LOOP_MODE_FORWARD: integer = 2, -> LOOP_MODE_REVERSE: integer = 3, -> LOOP_MODE_PING_PONG: integer = 4, -> } -> ``` -### BeatSyncMode -> ```lua -> { -> BEAT_SYNC_REPITCH: integer = 1, -> BEAT_SYNC_PERCUSSION: integer = 2, -> BEAT_SYNC_TEXTURE: integer = 3, -> } -> ``` -### NewNoteActionMode -> ```lua -> { -> NEW_NOTE_ACTION_NOTE_CUT: integer = 1, -> NEW_NOTE_ACTION_NOTE_OFF: integer = 2, -> NEW_NOTE_ACTION_SUSTAIN: integer = 3, -> } -> ``` - - ---- -## Properties -### is_slice_alias : [`boolean`](../../API/builtins/boolean.md) -> **READ-ONLY** True, when the sample slot is an alias to a sliced master sample. -> Such sample slots are read-only and automatically managed with the master samples -> slice list. - -### slice_markers : [`integer`](../../API/builtins/integer.md)[] -> Read/write access to the slice marker list of a sample. When new markers are -> set or existing ones unset, existing 0S effects or notes to existing slices -> will NOT be remapped (unlike its done with the insert/remove/move_slice_marker -> functions). See function insert_slice_marker for info about marker limitations -> and preconditions. - -### slice_markers_observable : [`renoise.Document.ObservableList`](../../API/renoise/renoise.Document.ObservableList.md) -> Track changes to document lists by attaching listener functions to it. -> NB: Notifiers will not broadcast changes made to list items, but only changes -> to the lists **layout** (items got added, removed, swapped). - -### name : [`string`](../../API/builtins/string.md) -> Name. - -### name_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### panning : [`number`](../../API/builtins/number.md) -> Range: (0.0 - 1.0) - -### panning_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### volume : [`number`](../../API/builtins/number.md) -> Range: (0.0 - 4.0) - -### volume_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### transpose : [`integer`](../../API/builtins/integer.md) -> Range: (-120 - 120) - -### transpose_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### fine_tune : [`integer`](../../API/builtins/integer.md) -> Range: (-127 - 127) - -### fine_tune_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### beat_sync_enabled : [`boolean`](../../API/builtins/boolean.md) -> Beat sync. - -### beat_sync_enabled_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### beat_sync_lines : [`integer`](../../API/builtins/integer.md) -> Range: (1 - 512) - -### beat_sync_lines_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### beat_sync_mode : [`renoise.Sample.BeatSyncMode`](renoise.Sample.md#BeatSyncMode) -### beat_sync_mode_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### interpolation_mode : [`renoise.Sample.InterpolationMode`](renoise.Sample.md#InterpolationMode) -> Interpolation, new note action, oneshot, mute_group, autoseek, autofade. - -### interpolation_mode_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### oversample_enabled : [`boolean`](../../API/builtins/boolean.md) -### oversample_enabled_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### new_note_action : [`renoise.Sample.NewNoteActionMode`](renoise.Sample.md#NewNoteActionMode) -### new_note_action_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### oneshot : [`boolean`](../../API/builtins/boolean.md) -### oneshot_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### mute_group : [`integer`](../../API/builtins/integer.md) -> Range: (0 - 15) where 0 means no group - -### mute_group_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### autoseek : [`boolean`](../../API/builtins/boolean.md) -### autoseek_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### autofade : [`boolean`](../../API/builtins/boolean.md) -### autofade_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### loop_mode : [`renoise.Sample.LoopMode`](renoise.Sample.md#LoopMode) -> Loops. - -### loop_mode_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### loop_release : [`boolean`](../../API/builtins/boolean.md) -### loop_release_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### loop_start : [`integer`](../../API/builtins/integer.md) -> Range: (1 - num_sample_frames) - -### loop_start_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### loop_end : [`integer`](../../API/builtins/integer.md) -> Range: (1 - num_sample_frames) - -### loop_end_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### modulation_set_index : [`integer`](../../API/builtins/integer.md) -> The linked modulation set. 0 when disable, else a valid index for the -> renoise.Instrument.sample_modulation_sets table - -### modulation_set_index_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### device_chain_index : [`integer`](../../API/builtins/integer.md) -> The linked instrument device chain. 0 when disable, else a valid index for the -> renoise.Instrument.sample_device_chain table - -### device_chain_index_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### sample_buffer : [`renoise.SampleBuffer`](../../API/renoise/renoise.SampleBuffer.md) -> **READ-ONLY** - -### sample_buffer_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### sample_mapping : [`renoise.SampleMapping`](../../API/renoise/renoise.SampleMapping.md) -> **READ-ONLY** Keyboard Note/velocity mapping - - - ---- -## Functions -### clear([*self*](../../API/builtins/self.md)) -> Reset, clear all sample settings and sample data. -### copy_from([*self*](../../API/builtins/self.md), sample : [`renoise.Sample`](../../API/renoise/renoise.Sample.md)) -> Copy all settings, including sample data from another sample. -### insert_slice_marker([*self*](../../API/builtins/self.md), marker_sample_pos : [`integer`](../../API/builtins/integer.md)) -> Insert a new slice marker at the given sample position. Only samples in -> the first sample slot may use slices. Creating slices will automatically -> create sample aliases in the following slots: read-only sample slots that -> play the sample slice and are mapped to notes. Sliced sample lists can not -> be modified manually then. To update such aliases, modify the slice marker -> list instead. -> Existing 0S effects or notes will be updated to ensure that the old slices -> are played back just as before. -### delete_slice_marker([*self*](../../API/builtins/self.md), marker_sample_pos : [`integer`](../../API/builtins/integer.md)) -> Delete an existing slice marker. marker_sample_pos must point to an existing -> marker. See also property 'samples[].slice_markers'. Existing 0S effects or -> notes will be updated to ensure that the old slices are played back just as -> before. -### move_slice_marker([*self*](../../API/builtins/self.md), old_marker_pos : [`integer`](../../API/builtins/integer.md), new_marker_pos : [`integer`](../../API/builtins/integer.md)) -> Change the sample position of an existing slice marker. see also property -> 'samples[].slice_markers'. -> When moving a marker behind or before an existing other marker, existing 0S -> effects or notes will automatically be updated to ensure that the old slices -> are played back just as before. - diff --git a/docs/API/renoise/renoise.SampleAhdrsModulationDevice.md b/docs/API/renoise/renoise.SampleAhdrsModulationDevice.md deleted file mode 100644 index d479a9c..0000000 --- a/docs/API/renoise/renoise.SampleAhdrsModulationDevice.md +++ /dev/null @@ -1,111 +0,0 @@ -# renoise.SampleAhdrsModulationDevice - - - - ---- -## Properties -### name : [`string`](../../API/builtins/string.md) -> **READ-ONLY** Fixed name of the device. - -### short_name : [`string`](../../API/builtins/string.md) -> **READ-ONLY** - -### display_name : [`string`](../../API/builtins/string.md) -> Configurable device display name. - -### display_name_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### enabled : [`boolean`](../../API/builtins/boolean.md) -> **Deprecated.** Use `is_active` instead. - -### enabled_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### is_active : [`boolean`](../../API/builtins/boolean.md) -> not active = bypassed - -### is_active_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### is_maximized : [`boolean`](../../API/builtins/boolean.md) -> Maximize state in modulation chain. - -### is_maximized_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### target : [`renoise.SampleModulationDevice.TargetType`](renoise.SampleModulationDevice.md#TargetType) -> **READ-ONLY** Where the modulation gets applied (Volume, -> Pan, Pitch, Cutoff, Resonance). - -### operator : [`renoise.SampleModulationDevice.OperatorType`](renoise.SampleModulationDevice.md#OperatorType) -> Modulation operator: how the device applies. - -### operator_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### bipolar : [`boolean`](../../API/builtins/boolean.md) -> Modulation polarity: -> when bipolar, the device applies it's values in a -1 to 1 range, -> when unipolar in a 0 to 1 range. - -### bipolar_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### tempo_sync_switching_allowed : [`boolean`](../../API/builtins/boolean.md) -> **READ-ONLY** When true, the device has one of more time parameters, -> which can be switched to operate in synced or unsynced mode. -> see also field tempo_synced. - -### tempo_synced : [`boolean`](../../API/builtins/boolean.md) -> When true and the device supports sync switching the device operates -> in wall-clock (ms) instead of beat times. -> see also property 'tempo_sync_switching_allowed' - -### tempo_synced_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### is_active_parameter : [`renoise.DeviceParameter`](../../API/renoise/renoise.DeviceParameter.md) -> **READ-ONLY** Generic access to all parameters of this device. - -### parameters : [`renoise.DeviceParameter`](../../API/renoise/renoise.DeviceParameter.md)[] -> **READ-ONLY** - -### attack : [`renoise.DeviceParameter`](../../API/renoise/renoise.DeviceParameter.md) -> with range (0-1) - -### hold : [`renoise.DeviceParameter`](../../API/renoise/renoise.DeviceParameter.md) -> with range (0-1) - -### duration : [`renoise.DeviceParameter`](../../API/renoise/renoise.DeviceParameter.md) -> with range (0-1) - -### sustain : [`renoise.DeviceParameter`](../../API/renoise/renoise.DeviceParameter.md) -> with range (0-1) - -### release : [`renoise.DeviceParameter`](../../API/renoise/renoise.DeviceParameter.md) -> with range (0-1) - - - ---- -## Functions -### init([*self*](../../API/builtins/self.md)) -> Reset the device to its default state. -### copy_from([*self*](../../API/builtins/self.md), other_device : [`renoise.SampleModulationDevice`](../../API/renoise/renoise.SampleModulationDevice.md)) -> Copy a device's state from another device. 'other_device' must be of the -> same type. -### parameter([*self*](../../API/builtins/self.md), index : [`integer`](../../API/builtins/integer.md)) -`->`[`renoise.DeviceParameter`](../../API/renoise/renoise.DeviceParameter.md) - -> Access to a single parameter by index. Use properties 'parameters' to iterate -> over all parameters and to query the parameter count. - diff --git a/docs/API/renoise/renoise.SampleBuffer.md b/docs/API/renoise/renoise.SampleBuffer.md deleted file mode 100644 index e11eb1f..0000000 --- a/docs/API/renoise/renoise.SampleBuffer.md +++ /dev/null @@ -1,170 +0,0 @@ -# renoise.SampleBuffer -> NOTE: All properties are invalid when no sample data is present, -> 'has_sample_data' returns false: - - - -## Constants -### Channel -> ```lua -> { -> CHANNEL_LEFT: integer = 1, -> CHANNEL_RIGHT: integer = 2, -> CHANNEL_LEFT_AND_RIGHT: integer = 3, -> } -> ``` - - ---- -## Properties -### has_sample_data : [`boolean`](../../API/builtins/boolean.md) -> **READ-ONLY** Check this before accessing properties - -### read_only : [`boolean`](../../API/builtins/boolean.md) -> **READ-ONLY** True, when the sample buffer can only be read, but not be -> modified. true for sample aliases of sliced samples. To modify such sample -> buffers, modify the sliced master sample buffer instead. - -### sample_rate : [`integer`](../../API/builtins/integer.md) -> **READ-ONLY** The current sample rate in Hz, like 44100. - -### bit_depth : [`integer`](../../API/builtins/integer.md) -> **READ-ONLY** The current bit depth, like 32, 16, 8. - -### number_of_channels : [`integer`](../../API/builtins/integer.md) -> **READ-ONLY** The integer of sample channels (1 or 2) - -### number_of_frames : [`integer`](../../API/builtins/integer.md) -> **READ-ONLY** The sample frame count (integer of samples per channel) - -### display_start : [`integer`](../../API/builtins/integer.md) -> Range: (1 - number_of_frames) - -### display_start_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### display_length : [`integer`](../../API/builtins/integer.md) -> Range: (1 - number_of_frames) - -### display_length_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### display_range : [`integer`](../../API/builtins/integer.md)[] -> Range: (1 - number_of_frames) - -### display_range_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### vertical_zoom_factor : [`number`](../../API/builtins/number.md) -> Range(0.0-1.0) - -### vertical_zoom_factor_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### selection_start : [`integer`](../../API/builtins/integer.md) -> Range: (1 - number_of_frames) - -### selection_start_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### selection_end : [`integer`](../../API/builtins/integer.md) -> Range: (1 - number_of_frames) - -### selection_end_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### selection_range : [`integer`](../../API/builtins/integer.md)[] -> Range: (1 - number_of_frames) - -### selection_range_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### selected_channel : [`renoise.SampleBuffer.Channel`](renoise.SampleBuffer.md#Channel) -> The selected channel. - -### selected_channel_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - - - ---- -## Functions -### create_sample_data([*self*](../../API/builtins/self.md), sample_rate : [`integer`](../../API/builtins/integer.md), bit_depth : [`integer`](../../API/builtins/integer.md), num_channels : [`integer`](../../API/builtins/integer.md), num_frames : [`integer`](../../API/builtins/integer.md)) -`->`success : [`boolean`](../../API/builtins/boolean.md) - -> Create new sample data with the given rate, bit-depth, channel and frame -> count. Will trash existing sample data. Initial buffer is all zero. -> Will only return false when memory allocation fails (you're running out -> of memory). All other errors are fired as usual. -### delete_sample_data([*self*](../../API/builtins/self.md)) -> Delete existing sample data. -### sample_data([*self*](../../API/builtins/self.md), channel_index : [`integer`](../../API/builtins/integer.md), frame_index : [`integer`](../../API/builtins/integer.md)) -`->`values : [`number`](../../API/builtins/number.md)[] - -> Read access to samples in a sample data buffer. -### set_sample_data([*self*](../../API/builtins/self.md), channel_index : [`integer`](../../API/builtins/integer.md), frame_index : [`integer`](../../API/builtins/integer.md), sample_value : [`integer`](../../API/builtins/integer.md)) -> Write access to samples in a sample data buffer. New samples values must be -> within [-1, 1] and will be clipped automatically. Sample buffers may be -> read-only (see property 'read_only'). Attempts to write on such buffers -> will result into errors. -> IMPORTANT: before modifying buffers, call 'prepare_sample_data_changes'. -> When you are done, call 'finalize_sample_data_changes' to generate undo/redo -> data for your changes and update sample overview caches! -### prepare_sample_data_changes([*self*](../../API/builtins/self.md), undo_redo_enabled : [`boolean`](../../API/builtins/boolean.md)[`?`](../../API/builtins/nil.md)) -> To be called once **before** sample data gets manipulated via `set_sample_data`. -> This will prepare undo/redo data for the whole sample and does other internal -> housekeeping. Every *prepare_sample_data_changes* call must be paired with a -> *finalize_sample_data_changes* call. -> -> When param `undo_redo_enabled` is false, no undo/redo data is generated for the -> following changes. When undefined or true, the global "Enable Undo/Redo in Sample -> Editor" option is applied. -> -> See also 'finalize_sample_data_changes'. -### finalize_sample_data_changes([*self*](../../API/builtins/self.md)) -> To be called once *after* the sample data got manipulated via `set_sample_data`. -> This will create undo/redo data for the whole samples, and also updates the -> sample view caches for the sample. -> The reason this isn't automatically invoked is to avoid performance overhead when -> changing sample data 'sample by sample'. -> -> Don't forget to call this after any data changes, or changes may not be visible -> in the GUI and can not be un/redone! -### load_from([*self*](../../API/builtins/self.md), filename : [`string`](../../API/builtins/string.md)) -`->`success : [`boolean`](../../API/builtins/boolean.md) - -> Load sample data from a file. Files can be any audio format Renoise supports. -> Possible errors are shown to the user, otherwise success is returned. -### save_as([*self*](../../API/builtins/self.md), filename : [`string`](../../API/builtins/string.md), format : [`SampleBuffer.ExportType`](#SampleBuffer.ExportType)) -`->`success : [`boolean`](../../API/builtins/boolean.md) - -> Export sample data to a file. Possible errors are shown to the user, -> otherwise success is returned. -> -> ```lua -> format: -> | "wav" -> | "flac" -> ``` - - - ---- -## Aliases -### SampleBuffer.ExportType -`"flac"` | `"wav"` -> ```lua -> SampleBuffer.ExportType: -> | "wav" -> | "flac" -> ``` - - diff --git a/docs/API/renoise/renoise.SampleDeviceChain.md b/docs/API/renoise/renoise.SampleDeviceChain.md deleted file mode 100644 index e7ed208..0000000 --- a/docs/API/renoise/renoise.SampleDeviceChain.md +++ /dev/null @@ -1,90 +0,0 @@ -# renoise.SampleDeviceChain - - - - ---- -## Properties -### name : [`string`](../../API/builtins/string.md) -> Name of the audio effect chain. - -### name_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### available_devices : [`string`](../../API/builtins/string.md)[] -> **READ-ONLY** Allowed, available devices for 'insert_device_at'. - -### available_device_infos : [`AudioDeviceInfo`](#audiodeviceinfo)[] -> **READ-ONLY** Returns a list of tables containing more information about -> the devices. - -### devices : [`renoise.AudioDevice`](../../API/renoise/renoise.AudioDevice.md)[] -> **READ-ONLY** Device access. - -### devices_observable : [`renoise.Document.ObservableList`](../../API/renoise/renoise.Document.ObservableList.md) -> Track changes to document lists by attaching listener functions to it. -> NB: Notifiers will not broadcast changes made to list items, but only changes -> to the lists **layout** (items got added, removed, swapped). - -### available_output_routings : [`string`](../../API/builtins/string.md)[] -> **READ-ONLY** Output routing. - -### output_routing : [`string`](../../API/builtins/string.md) -> One of 'available_output_routings' - -### output_routing_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - - - ---- -## Functions -### insert_device_at([*self*](../../API/builtins/self.md), device_path : [`string`](../../API/builtins/string.md), index : [`integer`](../../API/builtins/integer.md)) -`->`new_device : [`renoise.AudioDevice`](../../API/renoise/renoise.AudioDevice.md) - -> Insert a new device at the given position. "device_path" must be an available device -> See: `renoise.SampleDeviceChain.available_devices` -### delete_device_at([*self*](../../API/builtins/self.md), index : [`integer`](../../API/builtins/integer.md)) -> Delete an existing device from a chain. The mixer device at index 1 can not -> be deleted. -### swap_devices_at([*self*](../../API/builtins/self.md), index1 : [`integer`](../../API/builtins/integer.md), index2 : [`integer`](../../API/builtins/integer.md)) -> Swap the positions of two devices in the device chain. The mixer device at -> index 1 can not be swapped or moved. -### device([*self*](../../API/builtins/self.md), index : [`integer`](../../API/builtins/integer.md)) -`->`[`renoise.AudioDevice`](../../API/renoise/renoise.AudioDevice.md) - -> Access to a single device in the chain. - - - ---- -## Structs -# AudioDeviceInfo -> Audio device info - ---- -## Properties -### path : [`string`](../../API/builtins/string.md) -> The device's path used by `renoise.Track:insert_device_at` - -### name : [`string`](../../API/builtins/string.md) -> The device's name - -### short_name : [`string`](../../API/builtins/string.md) -> The device's name as displayed in shortened lists - -### favorite_name : [`string`](../../API/builtins/string.md) -> The device's name as displayed in favorites - -### is_favorite : [`boolean`](../../API/builtins/boolean.md) -> true if the device is a favorite - -### is_bridged : [`boolean`](../../API/builtins/boolean.md) -> true if the device is a bridged plugin - - - - - diff --git a/docs/API/renoise/renoise.SampleEnvelopeModulationDevice.md b/docs/API/renoise/renoise.SampleEnvelopeModulationDevice.md deleted file mode 100644 index c349e69..0000000 --- a/docs/API/renoise/renoise.SampleEnvelopeModulationDevice.md +++ /dev/null @@ -1,222 +0,0 @@ -# renoise.SampleEnvelopeModulationDevice - - - -## Constants -### PlayMode -> ```lua -> { -> PLAYMODE_POINTS: integer = 1, -> PLAYMODE_LINES: integer = 2, -> PLAYMODE_CURVES: integer = 3, -> } -> ``` -### LoopMode -> ```lua -> { -> LOOP_MODE_OFF: integer = 1, -> LOOP_MODE_FORWARD: integer = 2, -> LOOP_MODE_REVERSE: integer = 3, -> LOOP_MODE_PING_PONG: integer = 4, -> } -> ``` -### MIN_NUMBER_OF_POINTS : [`integer`](../../API/builtins/integer.md) -### MAX_NUMBER_OF_POINTS : [`integer`](../../API/builtins/integer.md) - ---- -## Properties -### name : [`string`](../../API/builtins/string.md) -> **READ-ONLY** Fixed name of the device. - -### short_name : [`string`](../../API/builtins/string.md) -> **READ-ONLY** - -### display_name : [`string`](../../API/builtins/string.md) -> Configurable device display name. - -### display_name_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### enabled : [`boolean`](../../API/builtins/boolean.md) -> **Deprecated.** Use `is_active` instead. - -### enabled_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### is_active : [`boolean`](../../API/builtins/boolean.md) -> not active = bypassed - -### is_active_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### is_maximized : [`boolean`](../../API/builtins/boolean.md) -> Maximize state in modulation chain. - -### is_maximized_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### target : [`renoise.SampleModulationDevice.TargetType`](renoise.SampleModulationDevice.md#TargetType) -> **READ-ONLY** Where the modulation gets applied (Volume, -> Pan, Pitch, Cutoff, Resonance). - -### operator : [`renoise.SampleModulationDevice.OperatorType`](renoise.SampleModulationDevice.md#OperatorType) -> Modulation operator: how the device applies. - -### operator_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### bipolar : [`boolean`](../../API/builtins/boolean.md) -> Modulation polarity: -> when bipolar, the device applies it's values in a -1 to 1 range, -> when unipolar in a 0 to 1 range. - -### bipolar_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### tempo_sync_switching_allowed : [`boolean`](../../API/builtins/boolean.md) -> **READ-ONLY** When true, the device has one of more time parameters, -> which can be switched to operate in synced or unsynced mode. -> see also field tempo_synced. - -### tempo_synced : [`boolean`](../../API/builtins/boolean.md) -> When true and the device supports sync switching the device operates -> in wall-clock (ms) instead of beat times. -> see also property 'tempo_sync_switching_allowed' - -### tempo_synced_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### is_active_parameter : [`renoise.DeviceParameter`](../../API/renoise/renoise.DeviceParameter.md) -> **READ-ONLY** Generic access to all parameters of this device. - -### parameters : [`renoise.DeviceParameter`](../../API/renoise/renoise.DeviceParameter.md)[] -> **READ-ONLY** - -### external_editor_visible : [`boolean`](../../API/builtins/boolean.md) -> External editor visibility. -> set to true to show the editor, false to close it - -### play_mode : [`renoise.SampleEnvelopeModulationDevice.PlayMode`](renoise.SampleEnvelopeModulationDevice.md#PlayMode) -> Play mode (interpolation mode). - -### play_mode_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### length : [`integer`](../../API/builtins/integer.md) -> Range: (6 - 1000) - -### length_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### loop_mode : [`renoise.SampleEnvelopeModulationDevice.LoopMode`](renoise.SampleEnvelopeModulationDevice.md#LoopMode) -> Loop. - -### loop_mode_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### loop_start : [`integer`](../../API/builtins/integer.md) -> Range: (1 - envelope.length) - -### loop_start_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### loop_end : [`integer`](../../API/builtins/integer.md) -> Range: (1 - envelope.length) - -### loop_end_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### sustain_enabled : [`boolean`](../../API/builtins/boolean.md) -> Sustain. - -### sustain_enabled_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### sustain_position : [`integer`](../../API/builtins/integer.md) -> Range: (1 - envelope.length) - -### sustain_position_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### fade_amount : [`integer`](../../API/builtins/integer.md) -> Range: (0 - 4095) - -### fade_amount_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### points : [`SampleEnvelopeModulationDevice.Point`](#sampleenvelopemodulationdevice.point)[] -> Get all points of the envelope. When setting a new list of points, -> items may be unsorted by time, but there may not be multiple points -> for the same time. Returns a copy of the list, so changing -> `points[1].value` will not do anything. Instead, change them via -> `points = { something }` instead. - -### points_observable : [`renoise.Document.ObservableList`](../../API/renoise/renoise.Document.ObservableList.md) -> Track changes to document lists by attaching listener functions to it. -> NB: Notifiers will not broadcast changes made to list items, but only changes -> to the lists **layout** (items got added, removed, swapped). - - - ---- -## Functions -### parameter([*self*](../../API/builtins/self.md), index : [`integer`](../../API/builtins/integer.md)) -`->`[`renoise.DeviceParameter`](../../API/renoise/renoise.DeviceParameter.md) - -> Access to a single parameter by index. Use properties 'parameters' to iterate -> over all parameters and to query the parameter count. -### init([*self*](../../API/builtins/self.md)) -> Reset the envelope back to its default initial state. -### copy_from([*self*](../../API/builtins/self.md), other_device : [`renoise.SampleEnvelopeModulationDevice`](../../API/renoise/renoise.SampleEnvelopeModulationDevice.md)) -> Copy all properties from another SampleEnvelopeModulation object. -### clear_points([*self*](../../API/builtins/self.md)) -> Remove all points from the envelope. -### clear_points_in_range([*self*](../../API/builtins/self.md), from_time : [`integer`](../../API/builtins/integer.md), to_time : [`integer`](../../API/builtins/integer.md)) -> Remove points in the given [from, to) time range from the envelope. -### copy_points_from([*self*](../../API/builtins/self.md), other_device : [`renoise.SampleEnvelopeModulationDevice`](../../API/renoise/renoise.SampleEnvelopeModulationDevice.md)) -> Copy all points from another SampleEnvelopeModulation object. -### has_point_at([*self*](../../API/builtins/self.md), time : [`integer`](../../API/builtins/integer.md)) -`->`[`boolean`](../../API/builtins/boolean.md) - -> Test if a point exists at the given time. -### add_point_at([*self*](../../API/builtins/self.md), time : [`integer`](../../API/builtins/integer.md), value : [`number`](../../API/builtins/number.md), scaling : [`number`](../../API/builtins/number.md)[`?`](../../API/builtins/nil.md)) -> Add a new point value (or replace any existing value) at time. -### remove_point_at([*self*](../../API/builtins/self.md), time : [`integer`](../../API/builtins/integer.md)) -> Removes a point at the given time. Point must exist. - - - ---- -## Structs -# SampleEnvelopeModulationDevice.Point - ---- -## Properties -### time : [`integer`](../../API/builtins/integer.md) -> Range: (1 - envelope.length) - -### value : [`number`](../../API/builtins/number.md) -> Range: (0.0 - 1.0) - -### scaling : [`number`](../../API/builtins/number.md) -> Range: (-1.0 - 1.0) - - - - - diff --git a/docs/API/renoise/renoise.SampleFaderModulationDevice.md b/docs/API/renoise/renoise.SampleFaderModulationDevice.md deleted file mode 100644 index d9d792c..0000000 --- a/docs/API/renoise/renoise.SampleFaderModulationDevice.md +++ /dev/null @@ -1,127 +0,0 @@ -# renoise.SampleFaderModulationDevice - - - -## Constants -### ScalingType -> ```lua -> { -> SCALING_LOG_FAST: integer = 1, -> SCALING_LOG_SLOW: integer = 2, -> SCALING_LINEAR: integer = 3, -> SCALING_EXP_SLOW: integer = 4, -> SCALING_EXP_FAST: integer = 5, -> } -> ``` - - ---- -## Properties -### name : [`string`](../../API/builtins/string.md) -> **READ-ONLY** Fixed name of the device. - -### short_name : [`string`](../../API/builtins/string.md) -> **READ-ONLY** - -### display_name : [`string`](../../API/builtins/string.md) -> Configurable device display name. - -### display_name_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### enabled : [`boolean`](../../API/builtins/boolean.md) -> **Deprecated.** Use `is_active` instead. - -### enabled_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### is_active : [`boolean`](../../API/builtins/boolean.md) -> not active = bypassed - -### is_active_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### is_maximized : [`boolean`](../../API/builtins/boolean.md) -> Maximize state in modulation chain. - -### is_maximized_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### target : [`renoise.SampleModulationDevice.TargetType`](renoise.SampleModulationDevice.md#TargetType) -> **READ-ONLY** Where the modulation gets applied (Volume, -> Pan, Pitch, Cutoff, Resonance). - -### operator : [`renoise.SampleModulationDevice.OperatorType`](renoise.SampleModulationDevice.md#OperatorType) -> Modulation operator: how the device applies. - -### operator_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### bipolar : [`boolean`](../../API/builtins/boolean.md) -> Modulation polarity: -> when bipolar, the device applies it's values in a -1 to 1 range, -> when unipolar in a 0 to 1 range. - -### bipolar_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### tempo_sync_switching_allowed : [`boolean`](../../API/builtins/boolean.md) -> **READ-ONLY** When true, the device has one of more time parameters, -> which can be switched to operate in synced or unsynced mode. -> see also field tempo_synced. - -### tempo_synced : [`boolean`](../../API/builtins/boolean.md) -> When true and the device supports sync switching the device operates -> in wall-clock (ms) instead of beat times. -> see also property 'tempo_sync_switching_allowed' - -### tempo_synced_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### is_active_parameter : [`renoise.DeviceParameter`](../../API/renoise/renoise.DeviceParameter.md) -> **READ-ONLY** Generic access to all parameters of this device. - -### parameters : [`renoise.DeviceParameter`](../../API/renoise/renoise.DeviceParameter.md)[] -> **READ-ONLY** - -### scaling : [`renoise.SampleFaderModulationDevice.ScalingType`](renoise.SampleFaderModulationDevice.md#ScalingType) -> Scaling mode. - -### scaling_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### from : [`renoise.DeviceParameter`](../../API/renoise/renoise.DeviceParameter.md) -> Start value. - -### to : [`renoise.DeviceParameter`](../../API/renoise/renoise.DeviceParameter.md) -> Target value. - -### duration : [`renoise.DeviceParameter`](../../API/renoise/renoise.DeviceParameter.md) -> Duration. - -### delay : [`renoise.DeviceParameter`](../../API/renoise/renoise.DeviceParameter.md) -> Delay. - - - ---- -## Functions -### init([*self*](../../API/builtins/self.md)) -> Reset the device to its default state. -### copy_from([*self*](../../API/builtins/self.md), other_device : [`renoise.SampleModulationDevice`](../../API/renoise/renoise.SampleModulationDevice.md)) -> Copy a device's state from another device. 'other_device' must be of the -> same type. -### parameter([*self*](../../API/builtins/self.md), index : [`integer`](../../API/builtins/integer.md)) -`->`[`renoise.DeviceParameter`](../../API/renoise/renoise.DeviceParameter.md) - -> Access to a single parameter by index. Use properties 'parameters' to iterate -> over all parameters and to query the parameter count. - diff --git a/docs/API/renoise/renoise.SampleKeyTrackingModulationDevice.md b/docs/API/renoise/renoise.SampleKeyTrackingModulationDevice.md deleted file mode 100644 index 8d661f0..0000000 --- a/docs/API/renoise/renoise.SampleKeyTrackingModulationDevice.md +++ /dev/null @@ -1,102 +0,0 @@ -# renoise.SampleKeyTrackingModulationDevice - - - - ---- -## Properties -### name : [`string`](../../API/builtins/string.md) -> **READ-ONLY** Fixed name of the device. - -### short_name : [`string`](../../API/builtins/string.md) -> **READ-ONLY** - -### display_name : [`string`](../../API/builtins/string.md) -> Configurable device display name. - -### display_name_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### enabled : [`boolean`](../../API/builtins/boolean.md) -> **Deprecated.** Use `is_active` instead. - -### enabled_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### is_active : [`boolean`](../../API/builtins/boolean.md) -> not active = bypassed - -### is_active_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### is_maximized : [`boolean`](../../API/builtins/boolean.md) -> Maximize state in modulation chain. - -### is_maximized_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### target : [`renoise.SampleModulationDevice.TargetType`](renoise.SampleModulationDevice.md#TargetType) -> **READ-ONLY** Where the modulation gets applied (Volume, -> Pan, Pitch, Cutoff, Resonance). - -### operator : [`renoise.SampleModulationDevice.OperatorType`](renoise.SampleModulationDevice.md#OperatorType) -> Modulation operator: how the device applies. - -### operator_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### bipolar : [`boolean`](../../API/builtins/boolean.md) -> Modulation polarity: -> when bipolar, the device applies it's values in a -1 to 1 range, -> when unipolar in a 0 to 1 range. - -### bipolar_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### tempo_sync_switching_allowed : [`boolean`](../../API/builtins/boolean.md) -> **READ-ONLY** When true, the device has one of more time parameters, -> which can be switched to operate in synced or unsynced mode. -> see also field tempo_synced. - -### tempo_synced : [`boolean`](../../API/builtins/boolean.md) -> When true and the device supports sync switching the device operates -> in wall-clock (ms) instead of beat times. -> see also property 'tempo_sync_switching_allowed' - -### tempo_synced_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### is_active_parameter : [`renoise.DeviceParameter`](../../API/renoise/renoise.DeviceParameter.md) -> **READ-ONLY** Generic access to all parameters of this device. - -### parameters : [`renoise.DeviceParameter`](../../API/renoise/renoise.DeviceParameter.md)[] -> **READ-ONLY** - -### min : [`renoise.DeviceParameter`](../../API/renoise/renoise.DeviceParameter.md) -> with range (0-119) - -### max : [`renoise.DeviceParameter`](../../API/renoise/renoise.DeviceParameter.md) -> with range (0-119) - - - ---- -## Functions -### init([*self*](../../API/builtins/self.md)) -> Reset the device to its default state. -### copy_from([*self*](../../API/builtins/self.md), other_device : [`renoise.SampleModulationDevice`](../../API/renoise/renoise.SampleModulationDevice.md)) -> Copy a device's state from another device. 'other_device' must be of the -> same type. -### parameter([*self*](../../API/builtins/self.md), index : [`integer`](../../API/builtins/integer.md)) -`->`[`renoise.DeviceParameter`](../../API/renoise/renoise.DeviceParameter.md) - -> Access to a single parameter by index. Use properties 'parameters' to iterate -> over all parameters and to query the parameter count. - diff --git a/docs/API/renoise/renoise.SampleLfoModulationDevice.md b/docs/API/renoise/renoise.SampleLfoModulationDevice.md deleted file mode 100644 index 1614298..0000000 --- a/docs/API/renoise/renoise.SampleLfoModulationDevice.md +++ /dev/null @@ -1,122 +0,0 @@ -# renoise.SampleLfoModulationDevice - - - -## Constants -### Mode -> ```lua -> { -> MODE_SIN: integer = 1, -> MODE_SAW: integer = 2, -> MODE_PULSE: integer = 3, -> MODE_RANDOM: integer = 4, -> } -> ``` - - ---- -## Properties -### name : [`string`](../../API/builtins/string.md) -> **READ-ONLY** Fixed name of the device. - -### short_name : [`string`](../../API/builtins/string.md) -> **READ-ONLY** - -### display_name : [`string`](../../API/builtins/string.md) -> Configurable device display name. - -### display_name_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### enabled : [`boolean`](../../API/builtins/boolean.md) -> **Deprecated.** Use `is_active` instead. - -### enabled_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### is_active : [`boolean`](../../API/builtins/boolean.md) -> not active = bypassed - -### is_active_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### is_maximized : [`boolean`](../../API/builtins/boolean.md) -> Maximize state in modulation chain. - -### is_maximized_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### target : [`renoise.SampleModulationDevice.TargetType`](renoise.SampleModulationDevice.md#TargetType) -> **READ-ONLY** Where the modulation gets applied (Volume, -> Pan, Pitch, Cutoff, Resonance). - -### operator : [`renoise.SampleModulationDevice.OperatorType`](renoise.SampleModulationDevice.md#OperatorType) -> Modulation operator: how the device applies. - -### operator_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### bipolar : [`boolean`](../../API/builtins/boolean.md) -> Modulation polarity: -> when bipolar, the device applies it's values in a -1 to 1 range, -> when unipolar in a 0 to 1 range. - -### bipolar_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### tempo_sync_switching_allowed : [`boolean`](../../API/builtins/boolean.md) -> **READ-ONLY** When true, the device has one of more time parameters, -> which can be switched to operate in synced or unsynced mode. -> see also field tempo_synced. - -### tempo_synced : [`boolean`](../../API/builtins/boolean.md) -> When true and the device supports sync switching the device operates -> in wall-clock (ms) instead of beat times. -> see also property 'tempo_sync_switching_allowed' - -### tempo_synced_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### is_active_parameter : [`renoise.DeviceParameter`](../../API/renoise/renoise.DeviceParameter.md) -> **READ-ONLY** Generic access to all parameters of this device. - -### parameters : [`renoise.DeviceParameter`](../../API/renoise/renoise.DeviceParameter.md)[] -> **READ-ONLY** - -### mode : [`renoise.SampleLfoModulationDevice.Mode`](renoise.SampleLfoModulationDevice.md#Mode) -> LFO mode. - -### phase : [`renoise.DeviceParameter`](../../API/renoise/renoise.DeviceParameter.md) -> with range (0-360) - -### frequency : [`renoise.DeviceParameter`](../../API/renoise/renoise.DeviceParameter.md) -> with range (0-1) - -### amount : [`renoise.DeviceParameter`](../../API/renoise/renoise.DeviceParameter.md) -> with range (0-1) - -### delay : [`renoise.DeviceParameter`](../../API/renoise/renoise.DeviceParameter.md) -> Delay. - - - ---- -## Functions -### init([*self*](../../API/builtins/self.md)) -> Reset the device to its default state. -### copy_from([*self*](../../API/builtins/self.md), other_device : [`renoise.SampleModulationDevice`](../../API/renoise/renoise.SampleModulationDevice.md)) -> Copy a device's state from another device. 'other_device' must be of the -> same type. -### parameter([*self*](../../API/builtins/self.md), index : [`integer`](../../API/builtins/integer.md)) -`->`[`renoise.DeviceParameter`](../../API/renoise/renoise.DeviceParameter.md) - -> Access to a single parameter by index. Use properties 'parameters' to iterate -> over all parameters and to query the parameter count. - diff --git a/docs/API/renoise/renoise.SampleMapping.md b/docs/API/renoise/renoise.SampleMapping.md deleted file mode 100644 index e3beba6..0000000 --- a/docs/API/renoise/renoise.SampleMapping.md +++ /dev/null @@ -1,58 +0,0 @@ -# renoise.SampleMapping -> General remarks: Sample mappings of sliced samples are read-only: can not be -> modified. See `sample_mappings[].read_only` - - - - ---- -## Properties -### read_only : [`boolean`](../../API/builtins/boolean.md) -> **READ-ONLY** True for sliced instruments. No sample mapping properties are -> allowed to be modified, but can be read. - -### sample : [`renoise.Sample`](../../API/renoise/renoise.Sample.md) -> Linked sample. - -### layer : [`renoise.Instrument.Layer`](renoise.Instrument.md#Layer) -> Mapping's layer (triggered via Note-Ons or Note-Offs?). - -### layer_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### map_velocity_to_volume : [`boolean`](../../API/builtins/boolean.md) -> Mappings velocity->volume and key->pitch options. - -### map_velocity_to_volume_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### map_key_to_pitch : [`boolean`](../../API/builtins/boolean.md) -### map_key_to_pitch_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### base_note : [`integer`](../../API/builtins/integer.md) -> Range: (0-119, c-4=48)] - -### base_note_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### note_range : [`integer`](../../API/builtins/integer.md)[] -> Range: (0 - 119) where C-4 is 48 - -### note_range_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### velocity_range : [`integer`](../../API/builtins/integer.md)[] -> Range: (0 - 127) - -### velocity_range_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - - - diff --git a/docs/API/renoise/renoise.SampleModulationDevice.md b/docs/API/renoise/renoise.SampleModulationDevice.md deleted file mode 100644 index 92bc801..0000000 --- a/docs/API/renoise/renoise.SampleModulationDevice.md +++ /dev/null @@ -1,118 +0,0 @@ -# renoise.SampleModulationDevice - - - -## Constants -### TargetType -> ```lua -> { -> TARGET_VOLUME: integer = 1, -> TARGET_PANNING: integer = 2, -> TARGET_PITCH: integer = 3, -> TARGET_CUTOFF: integer = 4, -> TARGET_RESONANCE: integer = 5, -> TARGET_DRIVE: integer = 6, -> } -> ``` -### OperatorType -> ```lua -> { -> OPERATOR_ADD: integer = 1, -> OPERATOR_SUB: integer = 2, -> OPERATOR_MUL: integer = 3, -> OPERATOR_DIV: integer = 4, -> } -> ``` - - ---- -## Properties -### name : [`string`](../../API/builtins/string.md) -> **READ-ONLY** Fixed name of the device. - -### short_name : [`string`](../../API/builtins/string.md) -> **READ-ONLY** - -### display_name : [`string`](../../API/builtins/string.md) -> Configurable device display name. - -### display_name_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### enabled : [`boolean`](../../API/builtins/boolean.md) -> **Deprecated.** Use `is_active` instead. - -### enabled_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### is_active : [`boolean`](../../API/builtins/boolean.md) -> not active = bypassed - -### is_active_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### is_maximized : [`boolean`](../../API/builtins/boolean.md) -> Maximize state in modulation chain. - -### is_maximized_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### target : [`renoise.SampleModulationDevice.TargetType`](renoise.SampleModulationDevice.md#TargetType) -> **READ-ONLY** Where the modulation gets applied (Volume, -> Pan, Pitch, Cutoff, Resonance). - -### operator : [`renoise.SampleModulationDevice.OperatorType`](renoise.SampleModulationDevice.md#OperatorType) -> Modulation operator: how the device applies. - -### operator_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### bipolar : [`boolean`](../../API/builtins/boolean.md) -> Modulation polarity: -> when bipolar, the device applies it's values in a -1 to 1 range, -> when unipolar in a 0 to 1 range. - -### bipolar_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### tempo_sync_switching_allowed : [`boolean`](../../API/builtins/boolean.md) -> **READ-ONLY** When true, the device has one of more time parameters, -> which can be switched to operate in synced or unsynced mode. -> see also field tempo_synced. - -### tempo_synced : [`boolean`](../../API/builtins/boolean.md) -> When true and the device supports sync switching the device operates -> in wall-clock (ms) instead of beat times. -> see also property 'tempo_sync_switching_allowed' - -### tempo_synced_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### is_active_parameter : [`renoise.DeviceParameter`](../../API/renoise/renoise.DeviceParameter.md) -> **READ-ONLY** Generic access to all parameters of this device. - -### parameters : [`renoise.DeviceParameter`](../../API/renoise/renoise.DeviceParameter.md)[] -> **READ-ONLY** - - - ---- -## Functions -### init([*self*](../../API/builtins/self.md)) -> Reset the device to its default state. -### copy_from([*self*](../../API/builtins/self.md), other_device : [`renoise.SampleModulationDevice`](../../API/renoise/renoise.SampleModulationDevice.md)) -> Copy a device's state from another device. 'other_device' must be of the -> same type. -### parameter([*self*](../../API/builtins/self.md), index : [`integer`](../../API/builtins/integer.md)) -`->`[`renoise.DeviceParameter`](../../API/renoise/renoise.DeviceParameter.md) - -> Access to a single parameter by index. Use properties 'parameters' to iterate -> over all parameters and to query the parameter count. - diff --git a/docs/API/renoise/renoise.SampleModulationSet.md b/docs/API/renoise/renoise.SampleModulationSet.md deleted file mode 100644 index a1834a3..0000000 --- a/docs/API/renoise/renoise.SampleModulationSet.md +++ /dev/null @@ -1,255 +0,0 @@ -# renoise.SampleModulationSet - - - - ---- -## Properties -### name : [`string`](../../API/builtins/string.md) -> Name of the modulation set. - -### name_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### volume_input : [`renoise.DeviceParameter`](../../API/renoise/renoise.DeviceParameter.md) -> Input value for the volume domain - -### panning_input : [`renoise.DeviceParameter`](../../API/renoise/renoise.DeviceParameter.md) -> Input value for the panning domain - -### pitch_input : [`renoise.DeviceParameter`](../../API/renoise/renoise.DeviceParameter.md) -> Input value for the pitch domain - -### cutoff_input : [`renoise.DeviceParameter`](../../API/renoise/renoise.DeviceParameter.md) -> Input value for the cutoff domain - -### resonance_input : [`renoise.DeviceParameter`](../../API/renoise/renoise.DeviceParameter.md) -> Input value for the resonance domain - -### drive_input : [`renoise.DeviceParameter`](../../API/renoise/renoise.DeviceParameter.md) -> Input value for the drive domain - -### pitch_range : [`integer`](../../API/builtins/integer.md) -> Range: (1 - 96) - -### pitch_range_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### available_devices : [`string`](../../API/builtins/string.md)[] -> **READ-ONLY** All available devices, to be used in 'insert_device_at'. - -### devices : [`renoise.SampleModulationDevice`](../../API/renoise/renoise.SampleModulationDevice.md)[] -> **READ-ONLY** Device list access. - -### devices_observable : [`renoise.Document.ObservableList`](../../API/renoise/renoise.Document.ObservableList.md) -> Track changes to document lists by attaching listener functions to it. -> NB: Notifiers will not broadcast changes made to list items, but only changes -> to the lists **layout** (items got added, removed, swapped). - -### filter_version : `1` | `2` | `3` -> **READ-ONLY** Filter version, 3 is the latest. - -### filter_version_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### available_filter_types : [`FilterTypes`](#FilterTypes)[] -> **READ-ONLY** List of available filter types depending on the filter_version. - -### filter_type : [`FilterTypes`](#FilterTypes) -> The type of the filter selected for the modulation set. -> Songs made with previous versions of Renoise may use old filter types. - -### filter_type_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - - - ---- -## Functions -### init([*self*](../../API/builtins/self.md)) -> Reset all chain back to default initial state. Removing all devices too. -### copy_from([*self*](../../API/builtins/self.md), other_set : [`renoise.SampleModulationSet`](../../API/renoise/renoise.SampleModulationSet.md)) -> Copy all devices from another SampleModulationSet object. -### insert_device_at([*self*](../../API/builtins/self.md), device_path : [`string`](../../API/builtins/string.md), target_type : [`renoise.SampleModulationDevice.TargetType`](renoise.SampleModulationDevice.md#TargetType), index : [`integer`](../../API/builtins/integer.md)) -`->`new_sample_modulation_device : [`renoise.SampleModulationDevice`](../../API/renoise/renoise.SampleModulationDevice.md) - -> Insert a new device at the given position. "device_path" must be one of -> renoise.song().instruments[].sample_modulation_sets[].available_devices. -### delete_device_at([*self*](../../API/builtins/self.md), index : [`integer`](../../API/builtins/integer.md)) -> Delete a device at the given index. -### device([*self*](../../API/builtins/self.md), index : [`integer`](../../API/builtins/integer.md)) -`->`[`renoise.SampleModulationDevice`](../../API/renoise/renoise.SampleModulationDevice.md) - -> Access a single device by index. -### upgrade_filter_version([*self*](../../API/builtins/self.md)) -> Upgrade filter to the latest version. Tries to find a somewhat matching -> filter in the new version, but things quite likely won't sound the same. - - - ---- -## Aliases -### FilterTypes -[`FilterTypes1`](#FilterTypes1) | [`FilterTypes2`](#FilterTypes2) | [`FilterTypes3`](#FilterTypes3) -> ```lua -> -- Available filter types when filter_version = 3 -> -- Available filter types when filter_version = 3 -> -- Available filter types when filter_version = 2 -> -- Available filter types when filter_version = 1 -> FilterTypes: -> | "None" -> | "LP Clean" -> | "LP K35" -> | "LP Moog" -> | "LP Diode" -> | "HP Clean" -> | "HP K35" -> | "HP Moog" -> | "BP Clean" -> | "BP K35" -> | "BP Moog" -> | "BandPass" -> | "BandStop" -> | "Vowel" -> | "Comb" -> | "Decimator" -> | "Dist Shape" -> | "Dist Fold" -> | "AM Sine" -> | "AM Triangle" -> | "AM Saw" -> | "AM Pulse" -> | "None" -> | "LP 2x2 Pole" -> | "LP 2 Pole" -> | "LP Biquad" -> | "LP Moog" -> | "LP Single" -> | "HP 2x2 Pole" -> | "HP 2 Pole" -> | "HP Moog" -> | "Band Reject" -> | "Band Pass" -> | "EQ -15 dB" -> | "EQ -6 dB" -> | "EQ +6 dB" -> | "EQ +15 dB" -> | "EQ Peaking" -> | "Dist. Low" -> | "Dist. Mid" -> | "Dist. High" -> | "Dist." -> | "RingMod" -> | "None" -> | "LP -12 dB" -> | "LP -24 dB" -> | "LP -48 dB" -> | "Moog LP" -> | "Single Pole" -> | "HP -12 dB" -> | "HP -24 dB" -> | "Moog HP" -> | "Band Reject" -> | "Band Pass" -> | "EQ -15 dB" -> | "EQ -6 dB" -> | "EQ +6 dB" -> | "EQ +15 dB" -> | "Peaking EQ" -> | "Dist. Low" -> | "Dist. Mid" -> | "Dist. High" -> | "Dist." -> | "AMod" -> ``` - -### FilterTypes1 -`"AMod"` | `"Band Pass"` | `"Band Reject"` | `"Dist. High"` | `"Dist. Low"` | `"Dist. Mid"` | `"Dist."` | `"EQ +15 dB"` | `"EQ +6 dB"` | `"EQ -15 dB"` | `"EQ -6 dB"` | `"HP -12 dB"` | `"HP -24 dB"` | `"LP -12 dB"` | `"LP -24 dB"` | `"LP -48 dB"` | `"Moog HP"` | `"Moog LP"` | `"None"` | `"Peaking EQ"` | `"Single Pole"` -> ```lua -> -- Available filter types when filter_version = 1 -> FilterTypes1: -> | "None" -> | "LP -12 dB" -> | "LP -24 dB" -> | "LP -48 dB" -> | "Moog LP" -> | "Single Pole" -> | "HP -12 dB" -> | "HP -24 dB" -> | "Moog HP" -> | "Band Reject" -> | "Band Pass" -> | "EQ -15 dB" -> | "EQ -6 dB" -> | "EQ +6 dB" -> | "EQ +15 dB" -> | "Peaking EQ" -> | "Dist. Low" -> | "Dist. Mid" -> | "Dist. High" -> | "Dist." -> | "AMod" -> ``` - -### FilterTypes2 -`"Band Pass"` | `"Band Reject"` | `"Dist. High"` | `"Dist. Low"` | `"Dist. Mid"` | `"Dist."` | `"EQ +15 dB"` | `"EQ +6 dB"` | `"EQ -15 dB"` | `"EQ -6 dB"` | `"EQ Peaking"` | `"HP 2 Pole"` | `"HP 2x2 Pole"` | `"HP Moog"` | `"LP 2 Pole"` | `"LP 2x2 Pole"` | `"LP Biquad"` | `"LP Moog"` | `"LP Single"` | `"None"` | `"RingMod"` -> ```lua -> -- Available filter types when filter_version = 2 -> FilterTypes2: -> | "None" -> | "LP 2x2 Pole" -> | "LP 2 Pole" -> | "LP Biquad" -> | "LP Moog" -> | "LP Single" -> | "HP 2x2 Pole" -> | "HP 2 Pole" -> | "HP Moog" -> | "Band Reject" -> | "Band Pass" -> | "EQ -15 dB" -> | "EQ -6 dB" -> | "EQ +6 dB" -> | "EQ +15 dB" -> | "EQ Peaking" -> | "Dist. Low" -> | "Dist. Mid" -> | "Dist. High" -> | "Dist." -> | "RingMod" -> ``` - -### FilterTypes3 -`"AM Pulse"` | `"AM Saw"` | `"AM Sine"` | `"AM Triangle"` | `"BP Clean"` | `"BP K35"` | `"BP Moog"` | `"BandPass"` | `"BandStop"` | `"Comb"` | `"Decimator"` | `"Dist Fold"` | `"Dist Shape"` | `"HP Clean"` | `"HP K35"` | `"HP Moog"` | `"LP Clean"` | `"LP Diode"` | `"LP K35"` | `"LP Moog"` | `"None"` | `"Vowel"` -> ```lua -> -- Available filter types when filter_version = 3 -> FilterTypes3: -> | "None" -> | "LP Clean" -> | "LP K35" -> | "LP Moog" -> | "LP Diode" -> | "HP Clean" -> | "HP K35" -> | "HP Moog" -> | "BP Clean" -> | "BP K35" -> | "BP Moog" -> | "BandPass" -> | "BandStop" -> | "Vowel" -> | "Comb" -> | "Decimator" -> | "Dist Shape" -> | "Dist Fold" -> | "AM Sine" -> | "AM Triangle" -> | "AM Saw" -> | "AM Pulse" -> ``` - - diff --git a/docs/API/renoise/renoise.SampleOperandModulationDevice.md b/docs/API/renoise/renoise.SampleOperandModulationDevice.md deleted file mode 100644 index f9da73c..0000000 --- a/docs/API/renoise/renoise.SampleOperandModulationDevice.md +++ /dev/null @@ -1,99 +0,0 @@ -# renoise.SampleOperandModulationDevice - - - - ---- -## Properties -### name : [`string`](../../API/builtins/string.md) -> **READ-ONLY** Fixed name of the device. - -### short_name : [`string`](../../API/builtins/string.md) -> **READ-ONLY** - -### display_name : [`string`](../../API/builtins/string.md) -> Configurable device display name. - -### display_name_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### enabled : [`boolean`](../../API/builtins/boolean.md) -> **Deprecated.** Use `is_active` instead. - -### enabled_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### is_active : [`boolean`](../../API/builtins/boolean.md) -> not active = bypassed - -### is_active_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### is_maximized : [`boolean`](../../API/builtins/boolean.md) -> Maximize state in modulation chain. - -### is_maximized_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### target : [`renoise.SampleModulationDevice.TargetType`](renoise.SampleModulationDevice.md#TargetType) -> **READ-ONLY** Where the modulation gets applied (Volume, -> Pan, Pitch, Cutoff, Resonance). - -### operator : [`renoise.SampleModulationDevice.OperatorType`](renoise.SampleModulationDevice.md#OperatorType) -> Modulation operator: how the device applies. - -### operator_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### bipolar : [`boolean`](../../API/builtins/boolean.md) -> Modulation polarity: -> when bipolar, the device applies it's values in a -1 to 1 range, -> when unipolar in a 0 to 1 range. - -### bipolar_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### tempo_sync_switching_allowed : [`boolean`](../../API/builtins/boolean.md) -> **READ-ONLY** When true, the device has one of more time parameters, -> which can be switched to operate in synced or unsynced mode. -> see also field tempo_synced. - -### tempo_synced : [`boolean`](../../API/builtins/boolean.md) -> When true and the device supports sync switching the device operates -> in wall-clock (ms) instead of beat times. -> see also property 'tempo_sync_switching_allowed' - -### tempo_synced_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### is_active_parameter : [`renoise.DeviceParameter`](../../API/renoise/renoise.DeviceParameter.md) -> **READ-ONLY** Generic access to all parameters of this device. - -### parameters : [`renoise.DeviceParameter`](../../API/renoise/renoise.DeviceParameter.md)[] -> **READ-ONLY** - -### value : [`renoise.DeviceParameter`](../../API/renoise/renoise.DeviceParameter.md) -> Operand value. - - - ---- -## Functions -### init([*self*](../../API/builtins/self.md)) -> Reset the device to its default state. -### copy_from([*self*](../../API/builtins/self.md), other_device : [`renoise.SampleModulationDevice`](../../API/renoise/renoise.SampleModulationDevice.md)) -> Copy a device's state from another device. 'other_device' must be of the -> same type. -### parameter([*self*](../../API/builtins/self.md), index : [`integer`](../../API/builtins/integer.md)) -`->`[`renoise.DeviceParameter`](../../API/renoise/renoise.DeviceParameter.md) - -> Access to a single parameter by index. Use properties 'parameters' to iterate -> over all parameters and to query the parameter count. - diff --git a/docs/API/renoise/renoise.SampleStepperModulationDevice.md b/docs/API/renoise/renoise.SampleStepperModulationDevice.md deleted file mode 100644 index dfdfa4b..0000000 --- a/docs/API/renoise/renoise.SampleStepperModulationDevice.md +++ /dev/null @@ -1,178 +0,0 @@ -# renoise.SampleStepperModulationDevice - - - -## Constants -### PlayMode -> ```lua -> { -> PLAYMODE_POINTS: integer = 1, -> PLAYMODE_LINES: integer = 2, -> PLAYMODE_CURVES: integer = 3, -> } -> ``` -### MIN_NUMBER_OF_POINTS : [`integer`](../../API/builtins/integer.md) -### MAX_NUMBER_OF_POINTS : [`integer`](../../API/builtins/integer.md) - ---- -## Properties -### name : [`string`](../../API/builtins/string.md) -> **READ-ONLY** Fixed name of the device. - -### short_name : [`string`](../../API/builtins/string.md) -> **READ-ONLY** - -### display_name : [`string`](../../API/builtins/string.md) -> Configurable device display name. - -### display_name_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### enabled : [`boolean`](../../API/builtins/boolean.md) -> **Deprecated.** Use `is_active` instead. - -### enabled_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### is_active : [`boolean`](../../API/builtins/boolean.md) -> not active = bypassed - -### is_active_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### is_maximized : [`boolean`](../../API/builtins/boolean.md) -> Maximize state in modulation chain. - -### is_maximized_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### target : [`renoise.SampleModulationDevice.TargetType`](renoise.SampleModulationDevice.md#TargetType) -> **READ-ONLY** Where the modulation gets applied (Volume, -> Pan, Pitch, Cutoff, Resonance). - -### operator : [`renoise.SampleModulationDevice.OperatorType`](renoise.SampleModulationDevice.md#OperatorType) -> Modulation operator: how the device applies. - -### operator_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### bipolar : [`boolean`](../../API/builtins/boolean.md) -> Modulation polarity: -> when bipolar, the device applies it's values in a -1 to 1 range, -> when unipolar in a 0 to 1 range. - -### bipolar_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### tempo_sync_switching_allowed : [`boolean`](../../API/builtins/boolean.md) -> **READ-ONLY** When true, the device has one of more time parameters, -> which can be switched to operate in synced or unsynced mode. -> see also field tempo_synced. - -### tempo_synced : [`boolean`](../../API/builtins/boolean.md) -> When true and the device supports sync switching the device operates -> in wall-clock (ms) instead of beat times. -> see also property 'tempo_sync_switching_allowed' - -### tempo_synced_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### is_active_parameter : [`renoise.DeviceParameter`](../../API/renoise/renoise.DeviceParameter.md) -> **READ-ONLY** Generic access to all parameters of this device. - -### parameters : [`renoise.DeviceParameter`](../../API/renoise/renoise.DeviceParameter.md)[] -> **READ-ONLY** - -### external_editor_visible : [`boolean`](../../API/builtins/boolean.md) -> External editor visibility. -> set to true to show the editor, false to close it - -### play_mode : [`renoise.SampleStepperModulationDevice.PlayMode`](renoise.SampleStepperModulationDevice.md#PlayMode) -> Play mode (interpolation mode). - -### play_mode_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### play_step : [`integer`](../../API/builtins/integer.md) -> Range: (-1 - 16) - -### play_step_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### length : [`integer`](../../API/builtins/integer.md) -> Range: (1 - 256) - -### length_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### points : [`SampleStepperModulationDevice.Point`](#samplesteppermodulationdevice.point)[] -> Get all points of the envelope. When setting a new list of points, -> items may be unsorted by time, but there may not be multiple points -> for the same time. Returns a copy of the list, so changing -> `points[1].value` will not do anything. Instead, change them via -> `points = { something }`. - -### points_observable : [`renoise.Document.ObservableList`](../../API/renoise/renoise.Document.ObservableList.md) -> Track changes to document lists by attaching listener functions to it. -> NB: Notifiers will not broadcast changes made to list items, but only changes -> to the lists **layout** (items got added, removed, swapped). - - - ---- -## Functions -### parameter([*self*](../../API/builtins/self.md), index : [`integer`](../../API/builtins/integer.md)) -`->`[`renoise.DeviceParameter`](../../API/renoise/renoise.DeviceParameter.md) - -> Access to a single parameter by index. Use properties 'parameters' to iterate -> over all parameters and to query the parameter count. -### init([*self*](../../API/builtins/self.md)) -> Reset the envelope back to its default initial state. -### copy_from([*self*](../../API/builtins/self.md), other_device : [`renoise.SampleStepperModulationDevice`](../../API/renoise/renoise.SampleStepperModulationDevice.md)) -> Copy all properties from another SampleStepperModulation object. -### clear_points([*self*](../../API/builtins/self.md)) -> Remove all points from the envelope. -### clear_points_in_range([*self*](../../API/builtins/self.md), from_time : [`integer`](../../API/builtins/integer.md), to_time : [`integer`](../../API/builtins/integer.md)) -> Remove points in the given [from, to) time range from the envelope. -### copy_points_from([*self*](../../API/builtins/self.md), other_device : [`renoise.SampleStepperModulationDevice`](../../API/renoise/renoise.SampleStepperModulationDevice.md)) -> Copy all points from another SampleStepperModulation object. -### has_point_at([*self*](../../API/builtins/self.md), time : [`integer`](../../API/builtins/integer.md)) -`->`[`boolean`](../../API/builtins/boolean.md) - -> Test if a point exists at the given time. -### add_point_at([*self*](../../API/builtins/self.md), time : [`integer`](../../API/builtins/integer.md), value : [`number`](../../API/builtins/number.md), scaling : [`number`](../../API/builtins/number.md)[`?`](../../API/builtins/nil.md)) -> Add a new point value (or replace any existing value) at time. -### remove_point_at([*self*](../../API/builtins/self.md), time : [`integer`](../../API/builtins/integer.md)) -> Removes a point at the given time. Point must exist. - - - ---- -## Structs -# SampleStepperModulationDevice.Point - ---- -## Properties -### time : [`integer`](../../API/builtins/integer.md) -> Range: (1 - envelope.length) - -### value : [`number`](../../API/builtins/number.md) -> Range: (0.0 - 1.0) - -### scaling : [`number`](../../API/builtins/number.md) -> Range: (-1.0 - 1.0) - - - - - diff --git a/docs/API/renoise/renoise.SampleVelocityTrackingModulationDevice.md b/docs/API/renoise/renoise.SampleVelocityTrackingModulationDevice.md deleted file mode 100644 index a0801e3..0000000 --- a/docs/API/renoise/renoise.SampleVelocityTrackingModulationDevice.md +++ /dev/null @@ -1,118 +0,0 @@ -# renoise.SampleVelocityTrackingModulationDevice - - - -## Constants -### Mode -> ```lua -> { -> MODE_CLAMP: integer = 1, -> MODE_SCALE: integer = 2, -> } -> ``` - - ---- -## Properties -### name : [`string`](../../API/builtins/string.md) -> **READ-ONLY** Fixed name of the device. - -### short_name : [`string`](../../API/builtins/string.md) -> **READ-ONLY** - -### display_name : [`string`](../../API/builtins/string.md) -> Configurable device display name. - -### display_name_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### enabled : [`boolean`](../../API/builtins/boolean.md) -> **Deprecated.** Use `is_active` instead. - -### enabled_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### is_active : [`boolean`](../../API/builtins/boolean.md) -> not active = bypassed - -### is_active_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### is_maximized : [`boolean`](../../API/builtins/boolean.md) -> Maximize state in modulation chain. - -### is_maximized_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### target : [`renoise.SampleModulationDevice.TargetType`](renoise.SampleModulationDevice.md#TargetType) -> **READ-ONLY** Where the modulation gets applied (Volume, -> Pan, Pitch, Cutoff, Resonance). - -### operator : [`renoise.SampleModulationDevice.OperatorType`](renoise.SampleModulationDevice.md#OperatorType) -> Modulation operator: how the device applies. - -### operator_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### bipolar : [`boolean`](../../API/builtins/boolean.md) -> Modulation polarity: -> when bipolar, the device applies it's values in a -1 to 1 range, -> when unipolar in a 0 to 1 range. - -### bipolar_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### tempo_sync_switching_allowed : [`boolean`](../../API/builtins/boolean.md) -> **READ-ONLY** When true, the device has one of more time parameters, -> which can be switched to operate in synced or unsynced mode. -> see also field tempo_synced. - -### tempo_synced : [`boolean`](../../API/builtins/boolean.md) -> When true and the device supports sync switching the device operates -> in wall-clock (ms) instead of beat times. -> see also property 'tempo_sync_switching_allowed' - -### tempo_synced_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### is_active_parameter : [`renoise.DeviceParameter`](../../API/renoise/renoise.DeviceParameter.md) -> **READ-ONLY** Generic access to all parameters of this device. - -### parameters : [`renoise.DeviceParameter`](../../API/renoise/renoise.DeviceParameter.md)[] -> **READ-ONLY** - -### mode : [`renoise.SampleVelocityTrackingModulationDevice.Mode`](renoise.SampleVelocityTrackingModulationDevice.md#Mode) -> Mode. - -### mode_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### min : [`renoise.DeviceParameter`](../../API/renoise/renoise.DeviceParameter.md) -> with range (0-127) - -### max : [`renoise.DeviceParameter`](../../API/renoise/renoise.DeviceParameter.md) -> with range (0-127) - - - ---- -## Functions -### init([*self*](../../API/builtins/self.md)) -> Reset the device to its default state. -### copy_from([*self*](../../API/builtins/self.md), other_device : [`renoise.SampleModulationDevice`](../../API/renoise/renoise.SampleModulationDevice.md)) -> Copy a device's state from another device. 'other_device' must be of the -> same type. -### parameter([*self*](../../API/builtins/self.md), index : [`integer`](../../API/builtins/integer.md)) -`->`[`renoise.DeviceParameter`](../../API/renoise/renoise.DeviceParameter.md) - -> Access to a single parameter by index. Use properties 'parameters' to iterate -> over all parameters and to query the parameter count. - diff --git a/docs/API/renoise/renoise.ScriptingTool.MidiMessage.md b/docs/API/renoise/renoise.ScriptingTool.MidiMessage.md deleted file mode 100644 index 8f6afae..0000000 --- a/docs/API/renoise/renoise.ScriptingTool.MidiMessage.md +++ /dev/null @@ -1,32 +0,0 @@ -# renoise.ScriptingTool.MidiMessage -> MIDI message as passed to the `invoke` callback in tool midi_mappings. - - - - ---- -## Properties -### int_value : [`integer`](../../API/builtins/integer.md)[`?`](../../API/builtins/nil.md) -> Range: (0S - 127) for abs values, Range: (-63 - 63) for relative values -> valid when `is_rel_value()` or `is_abs_value()` returns true, else undefined - -### boolean_value : [`boolean`](../../API/builtins/boolean.md)[`?`](../../API/builtins/nil.md) -> valid [true OR false] when `is_switch()` returns true, else undefined - - - ---- -## Functions -### is_trigger([*self*](../../API/builtins/self.md)) -> returns if action should be invoked -### is_switch([*self*](../../API/builtins/self.md)) -> check if the boolean_value property is valid -### is_rel_value([*self*](../../API/builtins/self.md)) -`->`[`boolean`](../../API/builtins/boolean.md) - -> check if the int_value property is valid -### is_abs_value([*self*](../../API/builtins/self.md)) -`->`[`boolean`](../../API/builtins/boolean.md) - -> check if the int_value property is valid - diff --git a/docs/API/renoise/renoise.ScriptingTool.md b/docs/API/renoise/renoise.ScriptingTool.md deleted file mode 100644 index a9c5714..0000000 --- a/docs/API/renoise/renoise.ScriptingTool.md +++ /dev/null @@ -1,409 +0,0 @@ -# renoise.ScriptingTool -> The scripting tool interface allows your tool to interact with Renoise by -> injecting or creating menu entries and keybindings into Renoise; or by -> attaching it to some common tool related notifiers. - - - - ---- -## Properties -### bundle_path : [`string`](../../API/builtins/string.md) -> **READ_ONLY** Full absolute path and name to your tool's bundle directory. - -### tool_finished_loading_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Invoked when the tool finished loading/initializing and no errors happened. -> When the tool has preferences, they are loaded here as well when the -> notification fires, but 'renoise.song()' may not yet be available. -> -> See also 'renoise.tool().app_new_document_observable'. - -### tool_will_unload_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Invoked right before a tool gets unloaded: either because it got disabled, -> reloaded or the application exists. You can cleanup resources or connections -> to other devices here if necessary. - -### app_became_active_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Invoked as soon as the application becomes the foreground window. -> For example, when you ATL-TAB to it, or activate it with the mouse -> from another app to Renoise. - -### app_resigned_active_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Invoked as soon as the application looses focus and another app -> becomes the foreground window. - -### app_idle_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Invoked periodically in the background, more often when the work load -> is low, less often when Renoise's work load is high. -> The exact interval is undefined and can not be relied on, but will be -> around 10 times per sec. -> You can do stuff in the background without blocking the application here. -> Be gentle and don't do CPU heavy stuff please! - -### app_release_document_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Invoked each time before a new document gets created or loaded: this is the -> last time renoise.song() still points to the old song before a new one arrives. -> You can explicitly release notifiers to the old document here, or do your own -> housekeeping. Also called right before the application exits. - -### app_new_document_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Invoked each time a new document (song) is created or loaded. In other words: -> each time the result of renoise.song() is changed. Also called when the script -> gets reloaded (only happens with the auto_reload debugging tools), in order -> to connect the new script instance to the already running document. - -### app_will_save_document_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Invoked just before the application document (song) is saved. -> This is the last chance to make any changes that should be part of -> the saved song. You could for example write your tool data to -> `renoise.song().tool_data` here. - -### app_saved_document_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Invoked each time the app's document (song) is successfully saved. -> renoise.song().file_name will point to the filename that it was saved to. - -### preferences : [`renoise.Document.DocumentNode`](../../API/renoise/renoise.Document.DocumentNode.md) -> Get or set an optional renoise.Document.DocumentNode object, which will be -> used as set of persistent "options" or preferences for your tool. -> By default nil. When set, the assigned document object will automatically be -> loaded and saved by Renoise, to retain the tools state. -> The preference XML file is saved/loaded within the tool bundle as -> "com.example.your_tool.xrnx/preferences.xml". -> -> #### examples: -> ```lua -> -- create a document via "Document.create" -> my_options = renoise.Document.create("ScriptingToolPreferences") { -> some_option = true, -> some_value = "string_value" -> } -> -> -- or create a document by inheriting from renoise.Document.DocumentNode -> class "ExampleToolPreferences"(renoise.Document.DocumentNode) -> function ExampleToolPreferences:__init() -> renoise.Document.DocumentNode.__init(self) -> self:add_property("some_option", true) -> self:add_property("some_value", "string_value") -> end -> -> my_options = ExampleToolPreferences() -> -- values can be accessed (read, written) via -> my_options.some_option.value = false -> -- also notifiers can be added to listen to changes to the values -> -- done by you, or after new values got loaded or a view changed the value: -> my_options.some_option:add_notifier(function() end) -> -> -- and assign it: -> renoise.tool().preferences = my_options -> -- 'my_options' will be loaded/saved automatically with the tool now -> ``` - - - ---- -## Functions -### has_menu_entry([*self*](../../API/builtins/self.md), entry_name : [`string`](../../API/builtins/string.md)) -`->`[`boolean`](../../API/builtins/boolean.md) - -> Returns true if the given entry already exists, otherwise false. -### add_menu_entry([*self*](../../API/builtins/self.md), entry : [`ToolMenuEntry`](#toolmenuentry)) -> Add a new menu entry. -### remove_menu_entry([*self*](../../API/builtins/self.md), entry_name : [`string`](../../API/builtins/string.md)) -> Remove a previously added menu entry by specifying its full name. -### has_keybinding([*self*](../../API/builtins/self.md), keybinding_name : [`string`](../../API/builtins/string.md)) -`->`[`boolean`](../../API/builtins/boolean.md) - -> Returns true when the given keybinging already exists, otherwise false. -### add_keybinding([*self*](../../API/builtins/self.md), keybinding : [`ToolKeybindingEntry`](#toolkeybindingentry)) -> Register key bindings somewhere in Renoise's existing set of bindings. -### remove_keybinding([*self*](../../API/builtins/self.md), keybinding_name : [`string`](../../API/builtins/string.md)) -> Remove a previously added key binding by specifying its name and path. -### has_midi_mapping([*self*](../../API/builtins/self.md), midi_mapping_name : [`string`](../../API/builtins/string.md)) -`->`[`boolean`](../../API/builtins/boolean.md) - -> Returns true when the given mapping already exists, otherwise false. -### add_midi_mapping([*self*](../../API/builtins/self.md), midi_mapping : [`ToolMidiMappingEntry`](#toolmidimappingentry)) -> Add a new midi_mapping entry. -### remove_midi_mapping([*self*](../../API/builtins/self.md), midi_mapping_name : [`string`](../../API/builtins/string.md)) -> Remove a previously added midi mapping by specifying its name. -### has_file_import_hook([*self*](../../API/builtins/self.md), category : [`FileHookCategory`](#FileHookCategory), extensions_table : [`string`](../../API/builtins/string.md)[]) -`->`[`boolean`](../../API/builtins/boolean.md) - -> Returns true when the given hook already exists, otherwise false. -> -> ```lua -> category: -> | "song" -> | "instrument" -> | "effect chain" -> | "effect preset" -> | "modulation set" -> | "phrase" -> | "sample" -> | "theme" -> ``` -### add_file_import_hook([*self*](../../API/builtins/self.md), file_import_hook : [`ToolFileImportHook`](#toolfileimporthook)) -> Add a new file import hook as described above. -### remove_file_import_hook([*self*](../../API/builtins/self.md), category : [`FileHookCategory`](#FileHookCategory), extensions_table : [`string`](../../API/builtins/string.md)[]) -> Remove a previously added file import hook by specifying its category -> and extension(s) -> -> ```lua -> category: -> | "song" -> | "instrument" -> | "effect chain" -> | "effect preset" -> | "modulation set" -> | "phrase" -> | "sample" -> | "theme" -> ``` -### has_timer([*self*](../../API/builtins/self.md), timer : [`TimerFunction`](#TimerFunction)) -`->`[`boolean`](../../API/builtins/boolean.md) - -> Returns true when the given function or method was registered as a timer. -### add_timer([*self*](../../API/builtins/self.md), timer : [`TimerFunction`](#TimerFunction), interval_in_ms : [`number`](../../API/builtins/number.md)) -> Register a timer function or table with a function and context (a method) -> that periodically gets called by the `app_idle_observable` for your tool. -> -> Modal dialogs will avoid that timers are called. To create a one-shot timer, -> simply call remove_timer at the end of your timer function. -> -> `interval_in_ms` must be > 0. The exact interval your function is called -> will vary a bit, depending on workload; e.g. when enough CPU time is available -> the rounding error will be around +/- 5 ms. -### remove_timer([*self*](../../API/builtins/self.md), timer : [`TimerFunction`](#TimerFunction)) -> Remove a previously registered timer. - - - ---- -## Structs -# ToolFileImportHook -> Add support for new filetypes in Renoise. Registered file types will show up -> in Renoise's disk browser and can also be loaded by drag and dropping the -> files onto the Renoise window. When adding hooks for files which Renoise -> already supports, your tool's import functions will override the internal -> import functions. -> -> Always load the file into the currently selected component, like -> 'renoise.song().selected_track','selected_instrument','selected_sample'. -> -> Preloading/prehearing sample files is not supported via tools. - ---- -## Properties -### category : [`FileHookCategory`](#FileHookCategory) -> In which disk browser category the file type shows up. -> One of - -### extensions : [`string`](../../API/builtins/string.md)[] -> A list of strings, file extensions, that will invoke your hook, like for -> example {"txt", "s_wave"} - -### invoke : (file_name : [`string`](../../API/builtins/string.md)) `->` [`boolean`](../../API/builtins/boolean.md) -> function that is called to do the import. return true when the import -> succeeded, else false. - - - - - ---- -## Aliases -### FileHookCategory -`"effect chain"` | `"effect preset"` | `"instrument"` | `"modulation set"` | `"phrase"` | `"sample"` | `"song"` | `"theme"` -> ```lua -> FileHookCategory: -> | "song" -> | "instrument" -> | "effect chain" -> | "effect preset" -> | "modulation set" -> | "phrase" -> | "sample" -> | "theme" -> ``` - - - -# ToolKeybindingEntry -> Register tool key bindings somewhere in Renoise's existing set of bindings. -> -> Please note: there's no way to define default keyboard shortcuts for your -> entries. Users manually have to bind them in the keyboard prefs pane. -> As soon as they do, they'll get saved just like any other key binding in -> Renoise. - ---- -## Properties -### name : [`string`](../../API/builtins/string.md) -> The scope, name and category of the key binding use the form: -> `$scope:$topic_name:$binding_name`: -> -> `$scope` is where the shortcut will be applied, just like those -> in the categories list for the keyboard assignment preference pane. -> Your key binding will only fire, when the scope is currently focused, -> except it's the global scope one. -> Using an unavailable scope will not fire an error, instead it will render -> the binding useless. It will be listed and mappable, but never be invoked. -> -> `$topic_name` is useful when grouping entries in the key assignment pane. -> Use "tool" if you can't come up with something meaningful. -> -> `$binding_name` is the name of the binding. -> -> -Currently available scopes are: -> ```lua -> + "Global" -> + "Automation" -> + "Disk Browser" -> + "DSPs Chain" -> + "Instrument Box" -> + "Mixer" -> + "Pattern Editor" -> + "Pattern Matrix" -> + "Pattern Sequencer" -> + "Sample Editor" -> + "Sample FX Mixer" -> + "Sample Keyzones" -> + "Sample Modulation Matrix" -> ``` - -### invoke : (repeated : [`boolean`](../../API/builtins/boolean.md)) -> A function that is called as soon as the mapped key is pressed. -> The callback parameter "repeated", indicates if its a virtual key repeat. - - - - -# ToolMenuEntry -> Defines a menu entry somewhere in Renoise's existing context menus or the -> global app menu. Insertion can be done during script initialization, but -> can also be done dynamically later on. -> -> You can place your entries in any context menu or any window menu in Renoise. -> To do so, use one of the specified categories in its name: -> ```lua -> + "Window Menu" -- Renoise icon menu in the window caption on Windows/Linux -> + "Main Menu:XXX" (with XXX = ":File", ":Edit", ":View", ":Tools" or ":Help") -- Main menu -> + "Scripting Menu:XXX" (with XXX = ":File" or ":Tools") -- Scripting Editor & Terminal -> + "Disk Browser Directories" -> + "Disk Browser Files" -> + "Instrument Box" -> + "Pattern Sequencer" -> + "Pattern Editor" -> + "Pattern Matrix" -> + "Pattern Matrix Header" -> + "Phrase Editor" -> + "Phrase Mappings" -> + "Phrase Grid" -> + "Phrase Script Editor" -> + "Sample Navigator" -> + "Sample Editor" -> + "Sample Editor Ruler" -> + "Sample Editor Slice Markers" -> + "Sample List" -> + "Sample Mappings" -> + "Sample FX Mixer" -> + "Sample Modulation Matrix" -> + "Mixer" -> + "Master Spectrum" -> + "Track Automation" -> + "Track Automation List" -> + "DSP Chain" -> + "DSP Chain List" -> + "DSP Device" -> + "DSP Device Header" -> + "DSP Device Automation" -> + "Modulation Set" -> + "Modulation Set List" -> + "Tool Browser" -> + "Script File Browser" -> + "Script File Tabs" -> + "Script Editor" -> ``` -> Separating entries: -> To divide entries into groups (separate entries with a line), prepend one or -> more dashes to the name, like "--- Main Menu:Tools:My Tool Group Starts Here" - ---- -## Properties -### name : [`string`](../../API/builtins/string.md) -> Name and 'path' of the entry as shown in the global menus or context menus -> to the user. - -### invoke : fun() -> A function that is called as soon as the entry is clicked - -### active : () `->` [`boolean`](../../API/builtins/boolean.md) -> A function that should return true or false. When returning false, the action -> will not be invoked and will be "greyed out" in menus. This function is always -> called before "invoke", and every time prior to a menu becoming visible. - -### selected : () `->` [`boolean`](../../API/builtins/boolean.md) -> A function that should return true or false. When returning true, the entry -> will be marked as "this is a selected option" - - - - -# ToolMidiMappingEntry -> Extend Renoise's default MIDI mapping set, or add custom MIDI mappings -> for your tool. -> -> A tool's MIDI mapping can be used just like the regular mappings in -> Renoise: Either by manually looking its up the mapping in the MIDI mapping -> list, then binding it to a MIDI message, or when your tool has a custom GUI, -> specifying the mapping via a control's `control.midi_mapping` property. -> Such controls will then get highlighted as soon as the MIDI mapping dialog is -> opened. Then, users simply click on the highlighted control to map MIDI -> messages. - ---- -## Properties -### name : [`string`](../../API/builtins/string.md) -> The group, name of the midi mapping; as visible to the user. -> -> The scope, name and category of the midi mapping use the form: -> `$topic_name:$optional_sub_topic_name:$name`: -> -> `$topic_name` and `$optional_sub_topic_name` will create new groups in -> the list of MIDI mappings, as seen in Renoise's MIDI mapping dialog. -> If you can't come up with a meaningful string, use your tool's name -> as topic name. -> -> Existing global mappings from Renoise can be overridden. In this case the -> original mappings are no longer called, only your tool's mapping. - -### invoke : (message : [`renoise.ScriptingTool.MidiMessage`](../../API/renoise/renoise.ScriptingTool.MidiMessage.md)) -> A function that is called to handle a bound MIDI message. - - - - - - - ---- -## Aliases -### FileHookCategory -`"effect chain"` | `"effect preset"` | `"instrument"` | `"modulation set"` | `"phrase"` | `"sample"` | `"song"` | `"theme"` -> ```lua -> FileHookCategory: -> | "song" -> | "instrument" -> | "effect chain" -> | "effect preset" -> | "modulation set" -> | "phrase" -> | "sample" -> | "theme" -> ``` - -### TimerFunction -fun() - - - diff --git a/docs/API/renoise/renoise.Socket.SocketBase.md b/docs/API/renoise/renoise.Socket.SocketBase.md deleted file mode 100644 index f5ef0b2..0000000 --- a/docs/API/renoise/renoise.Socket.SocketBase.md +++ /dev/null @@ -1,33 +0,0 @@ -# renoise.Socket.SocketBase -> SocketBase is the base class for socket clients and servers. All -> SocketBase properties and functions are available for servers and clients. - - - - ---- -## Properties -### is_open : [`boolean`](../../API/builtins/boolean.md) -> **READ-ONLY** Returns true when the socket object is valid and connected. -> Sockets can manually be closed (see socket:close()). Client sockets can also -> actively be closed/refused by the server. In this case the client:receive() -> calls will fail and return an error. - -### local_address : [`string`](../../API/builtins/string.md) -> **READ-ONLY** The socket's resolved local address (for example "127.0.0.1" -> when a socket is bound to "localhost") - -### local_port : [`integer`](../../API/builtins/integer.md) -> **READ-ONLY** The socket's local port number, as specified when instantiated. - - - ---- -## Functions -### close([*self*](../../API/builtins/self.md)) -> Closes the socket connection and releases all resources. This will make -> the socket useless, so any properties, calls to the socket will result in -> errors. Can be useful to explicitly release a connection without waiting for -> the dead object to be garbage collected, or if you want to actively refuse a -> connection. - diff --git a/docs/API/renoise/renoise.Socket.SocketClient.md b/docs/API/renoise/renoise.Socket.SocketClient.md deleted file mode 100644 index ff12705..0000000 --- a/docs/API/renoise/renoise.Socket.SocketClient.md +++ /dev/null @@ -1,114 +0,0 @@ -# renoise.Socket.SocketClient -> A SocketClient can connect to other socket servers and send and receive data -> from them on request. Connections to a server can not change, they are -> specified when constructing a client. You can not reconnect a client; create -> a new client instance instead. -> -> Socket clients in Renoise do block with timeouts to receive messages, and -> assume that you only expect a response from a server after having sent -> something to it (i.e.: GET HTTP). -> To constantly poll a connection to a server, for example in idle timers, -> specify a timeout of 0 in "receive(message, 0)". This will only check if there -> are any pending messages from the server and read them. If there are no pending -> messages it will not block or timeout. - - - - ---- -## Properties -### is_open : [`boolean`](../../API/builtins/boolean.md) -> **READ-ONLY** Returns true when the socket object is valid and connected. -> Sockets can manually be closed (see socket:close()). Client sockets can also -> actively be closed/refused by the server. In this case the client:receive() -> calls will fail and return an error. - -### local_address : [`string`](../../API/builtins/string.md) -> **READ-ONLY** The socket's resolved local address (for example "127.0.0.1" -> when a socket is bound to "localhost") - -### local_port : [`integer`](../../API/builtins/integer.md) -> **READ-ONLY** The socket's local port number, as specified when instantiated. - -### peer_address : [`string`](../../API/builtins/string.md) -> **READ-ONLY** Address of the socket's peer, the socket address this client -> is connected to. - -### peer_port : [`integer`](../../API/builtins/integer.md) -> **READ-ONLY** Port of the socket's peer, the socket this client is -> connected to. - - - ---- -## Functions -### close([*self*](../../API/builtins/self.md)) -> Closes the socket connection and releases all resources. This will make -> the socket useless, so any properties, calls to the socket will result in -> errors. Can be useful to explicitly release a connection without waiting for -> the dead object to be garbage collected, or if you want to actively refuse a -> connection. -### send([*self*](../../API/builtins/self.md), message : [`string`](../../API/builtins/string.md)) -`->`success : [`boolean`](../../API/builtins/boolean.md), error : [`string`](../../API/builtins/string.md)[`?`](../../API/builtins/nil.md) - -> Send a message string (or OSC messages or bundles) to the connected server. -> When sending fails, "success" return value will be false and "error_message" -> is set, describing the error in a human readable format. -> NB: when using TCP instead of UDP as protocol for OSC messages, !no! SLIP -> encoding and no size prefixing of the passed OSC data will be done here. -> So, when necessary, do this manually by your own please. -### receive([*self*](../../API/builtins/self.md), mode : [`SocketReceiveMode`](#SocketReceiveMode), timeout_ms : [`number`](../../API/builtins/number.md)) -`->`success : [`boolean`](../../API/builtins/boolean.md)[`?`](../../API/builtins/nil.md), error : [`string`](../../API/builtins/string.md)[`?`](../../API/builtins/nil.md) - -> Receive a message string from the the connected server with the given -> timeout in milliseconds. Mode can be one of "*line", "*all" or a number > 0, -> like Lua's io.read. \param timeout can be 0, which is useful for -> receive("*all"). This will only check and read pending data from the -> sockets queue. -> -> + mode "*line": Will receive new data from the server or flush pending data -> that makes up a "line": a string that ends with a newline. remaining data -> is kept buffered for upcoming receive calls and any kind of newlines -> are supported. The returned line will not contain the newline characters. -> -> + mode "*all": Reads all pending data from the peer socket and also flushes -> internal buffers from previous receive line/byte calls (when present). -> This will NOT read the entire requested content, but only the current -> buffer that is queued for the local socket from the peer. To read an -> entire HTTP page or file you may have to call receive("*all") multiple -> times until you got all you expect to get. -> -> + mode "number > 0": Tries reading \param NumberOfBytes of data from the -> peer. Note that the timeout may be applied more than once, if more than -> one socket read is needed to receive the requested block. -> -> When receiving fails or times-out, the returned message will be nil and -> error_message is set. The error message is "timeout" on timeouts, -> "disconnected" when the server actively refused/disconnected your client. -> Any other errors are system dependent, and should only be used for display -> purposes. -> -> Once you get an error from receive, and this error is not a "timeout", the -> socket will already be closed and thus must be recreated in order to retry -> communication with the server. Any attempt to use a closed socket will -> fire a runtime error. -> -> ```lua -> mode: -> | "*line" -> | "*all" -> ``` - - - ---- -## Aliases -### SocketReceiveMode -[`integer`](../../API/builtins/integer.md) | `"*all"` | `"*line"` -> ```lua -> SocketReceiveMode: -> | "*line" -> | "*all" -> ``` - - diff --git a/docs/API/renoise/renoise.Socket.SocketServer.md b/docs/API/renoise/renoise.Socket.SocketServer.md deleted file mode 100644 index 214e07d..0000000 --- a/docs/API/renoise/renoise.Socket.SocketServer.md +++ /dev/null @@ -1,128 +0,0 @@ -# renoise.Socket.SocketServer -> A SocketServer handles one or more clients in the background, interacts -> only with callbacks from connected clients. This background polling can be -> start and stop on request. -> -> The socket server interface in Renoise is asynchronous (callback based), which -> means server calls never block or wait, but are served in the background. -> As soon a connection is established or messages arrive, a set of specified -> callbacks are invoked to respond to messages. - - - - ---- -## Properties -### is_open : [`boolean`](../../API/builtins/boolean.md) -> **READ-ONLY** Returns true when the socket object is valid and connected. -> Sockets can manually be closed (see socket:close()). Client sockets can also -> actively be closed/refused by the server. In this case the client:receive() -> calls will fail and return an error. - -### local_address : [`string`](../../API/builtins/string.md) -> **READ-ONLY** The socket's resolved local address (for example "127.0.0.1" -> when a socket is bound to "localhost") - -### local_port : [`integer`](../../API/builtins/integer.md) -> **READ-ONLY** The socket's local port number, as specified when instantiated. - -### is_running : [`boolean`](../../API/builtins/boolean.md) -> **READ-ONLY** true while the server is running, else false. - - - ---- -## Functions -### close([*self*](../../API/builtins/self.md)) -> Closes the socket connection and releases all resources. This will make -> the socket useless, so any properties, calls to the socket will result in -> errors. Can be useful to explicitly release a connection without waiting for -> the dead object to be garbage collected, or if you want to actively refuse a -> connection. -### run([*self*](../../API/builtins/self.md), notifier_table : [`SocketNotifierClass`](#socketnotifierclass) | [`SocketNotifierTable`](#socketnotifiertable)) -> Start running the server by specifying a class or table which defines the -> callback functions for the server. -### stop([*self*](../../API/builtins/self.md)) -> Stop a running server. -### wait([*self*](../../API/builtins/self.md), timeout : [`number`](../../API/builtins/number.md)) -> Suspends the calling thread by the given timeout, and calls the server's -> callback methods as soon as something has happened in the server while -> waiting. Should be avoided whenever possible. - - - ---- -## Structs -# SocketNotifierClass -> Custom notifier class for `renoise.Socket.SocketServer:run`. -> Note: You must pass an instance of a class, like server_socket:run(MyNotifier()) -> -> All callback properties are optional. So you can, for example, skip specifying -> "socket_accepted" if you have no use for this. -> -> #### examples: -> ```lua -> class "MyNotifier" -> function MyNotifier:__init() -> -- could pass a server ref or something else here, or simply do nothing -> end -> function MyNotifier:socket_error(error_message) -> -- do something with the error message -> end -> function MyNotifier:socket_accepted(socket) -> -- FOR TCP CONNECTIONS ONLY: do something with socket -> end -> function MyNotifier:socket_message(socket, message) -> -- do something with socket and message -> end -> ``` - ---- -## Properties -### socket_error : (self : [`SocketNotifierClass`](#socketnotifierclass), error_message : [`string`](../../API/builtins/string.md))[`?`](../../API/builtins/nil.md) -### socket_accepted : (self : [`SocketNotifierClass`](#socketnotifierclass), socket : [`renoise.Socket.SocketClient`](../../API/renoise/renoise.Socket.SocketClient.md))[`?`](../../API/builtins/nil.md) -### socket_message : (self : [`SocketNotifierClass`](#socketnotifierclass), socket : [`renoise.Socket.SocketClient`](../../API/renoise/renoise.Socket.SocketClient.md), message : [`string`](../../API/builtins/string.md))[`?`](../../API/builtins/nil.md) - - - -# SocketNotifierTable -> Notifier table for `renoise.Socket.SocketServer:run`. -> -> All callback properties are optional. So you can, for example, skip specifying -> "socket_accepted" if you have no use for this. -> -> #### examples: -> ```lua -> { -> socket_error = function(error_message) -> -- do something with the error message -> end, -> socket_accepted = function(client) -> -- FOR TCP CONNECTIONS ONLY: do something with client -> end, -> socket_message = function(client, message) -> -- do something with client and message -> end -> } -> ``` - ---- -## Properties -### socket_error : (error_message : [`string`](../../API/builtins/string.md))[`?`](../../API/builtins/nil.md) -> An error happened in the servers background thread. - -### socket_accepted : (client : [`renoise.Socket.SocketClient`](../../API/renoise/renoise.Socket.SocketClient.md))[`?`](../../API/builtins/nil.md) -> FOR TCP CONNECTIONS ONLY: called as soon as a new client -> connected to your server. The passed socket is a ready to use socket -> object, representing a connection to the new socket. - -### socket_message : (client : [`renoise.Socket.SocketClient`](../../API/renoise/renoise.Socket.SocketClient.md), message : [`string`](../../API/builtins/string.md))[`?`](../../API/builtins/nil.md) -> A message was received from a client: The passed socket is a ready -> to use connection for TCP connections. For UDP, a "dummy" socket is -> passed, which can only be used to query the peer address and port -> -> socket.port and socket.address - - - - - diff --git a/docs/API/renoise/renoise.Socket.md b/docs/API/renoise/renoise.Socket.md deleted file mode 100644 index 1c3a959..0000000 --- a/docs/API/renoise/renoise.Socket.md +++ /dev/null @@ -1,42 +0,0 @@ -# renoise.Socket -> Interfaces for built-in socket support for Lua scripts in Renoise. -> -> Right now UDP and TCP protocols are supported. The class interfaces for UDP -> and TCP sockets behave exactly the same. That is, they don't depend on the -> protocol, so both are easily interchangeable when needed. - - - -## Constants -### Protocol -> ```lua -> { -> PROTOCOL_TCP: integer = 1, -> PROTOCOL_UDP: integer = 2, -> } -> ``` - - ---- -## Functions -### create_server(server_address : [`string`](../../API/builtins/string.md), server_port : [`integer`](../../API/builtins/integer.md), protocol : [`renoise.Socket.Protocol`](renoise.Socket.md#Protocol)[`?`](../../API/builtins/nil.md)) -`->`[`renoise.Socket.SocketServer`](../../API/renoise/renoise.Socket.SocketServer.md)[`?`](../../API/builtins/nil.md), [`string`](../../API/builtins/string.md)[`?`](../../API/builtins/nil.md) - -> Creates a connected UPD or TCP server object. Use "localhost" to use your -> system's default network address. Protocol can be `renoise.Socket.PROTOCOL_TCP` -> or `renoise.Socket.PROTOCOL_UDP` (by default TCP). -> When instantiation and connection succeed, a valid server object is -> returned, otherwise "error" is set and the server object is nil. -> Using the create function with no server_address allows you to create a -> server which allows connections to any address (for example localhost -> and some IP) -### create_client(server_address : [`string`](../../API/builtins/string.md), server_port : [`integer`](../../API/builtins/integer.md), protocol : [`renoise.Socket.Protocol`](renoise.Socket.md#Protocol)[`?`](../../API/builtins/nil.md), timeout : [`integer`](../../API/builtins/integer.md)[`?`](../../API/builtins/nil.md)) -`->`client : [`renoise.Socket.SocketClient`](../../API/renoise/renoise.Socket.SocketClient.md)[`?`](../../API/builtins/nil.md), error : [`string`](../../API/builtins/string.md)[`?`](../../API/builtins/nil.md) - -> Create a connected UPD or TCP client. -> `protocol` can be `renoise.Socket.PROTOCOL_TCP` or -> `renoise.Socket.PROTOCOL_UDP` (by default TCP). -> `timeout` is the time in ms to wait until the connection is established -> (1000 ms by default). When instantiation and connection succeed, a valid client -> object is returned, otherwise "error" is set and the client object is nil - diff --git a/docs/API/renoise/renoise.Song.md b/docs/API/renoise/renoise.Song.md deleted file mode 100644 index e6f9214..0000000 --- a/docs/API/renoise/renoise.Song.md +++ /dev/null @@ -1,610 +0,0 @@ -# renoise.Song -> Renoise's main document - the song. - - - -## Constants -### SubColumnType -> ```lua -> { -> SUB_COLUMN_NOTE: integer = 1, -> SUB_COLUMN_INSTRUMENT: integer = 2, -> SUB_COLUMN_VOLUME: integer = 3, -> SUB_COLUMN_PANNING: integer = 4, -> SUB_COLUMN_DELAY: integer = 5, -> SUB_COLUMN_SAMPLE_EFFECT_NUMBER: integer = 6, -> SUB_COLUMN_SAMPLE_EFFECT_AMOUNT: integer = 7, -> SUB_COLUMN_EFFECT_NUMBER: integer = 8, -> SUB_COLUMN_EFFECT_AMOUNT: integer = 9, -> } -> ``` -### MAX_NUMBER_OF_INSTRUMENTS : [`integer`](../../API/builtins/integer.md) - ---- -## Properties -### file_name : [`string`](../../API/builtins/string.md) -> **READ-ONLY** When the song is loaded from or saved to a file, the absolute -> path and name to the XRNS file, otherwise an empty string. - -### artist : [`string`](../../API/builtins/string.md) -> Song Comments - -### artist_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### name : [`string`](../../API/builtins/string.md) -### name_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### comments : [`string`](../../API/builtins/string.md)[] -> Note: All property tables of basic types in the API are temporary copies. -> In other words `comments = { "Hello", "World" }` will work, -> `comments[1] = "Hello"; renoise.song().comments[2] = "World"` -> will *not* work. - -### comments_observable : [`renoise.Document.ObservableList`](../../API/renoise/renoise.Document.ObservableList.md) -> Track changes to document lists by attaching listener functions to it. -> NB: Notifiers will not broadcast changes made to list items, but only changes -> to the lists **layout** (items got added, removed, swapped). - -### comments_assignment_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> **READ-ONLY** Notifier is called as soon as any paragraph in the comments change. - -### show_comments_after_loading : [`boolean`](../../API/builtins/boolean.md) -> Set this to true to show the comments dialog after loading a song - -### show_comments_after_loading_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### tool_data : [`string`](../../API/builtins/string.md)[`?`](../../API/builtins/nil.md) -> Inject/fetch custom XRNX scripting tool data into the song. Can only be called -> from scripts that are running in Renoise scripting tool bundles; attempts to -> access the data from e.g. the scripting terminal will result in an error. -> Returns nil when no data is present. -> -> Each tool gets it's own data slot in the song, which is resolved by the tool's -> bundle id, so this data is unique for every tool and persistent across tools -> with the same bundle id (but possibly different versions). -> If you want to store renoise.Document data in here, you can use the -> renoise.Document's 'to_string' and 'from_string' functions to serialize the data. -> Alternatively, write your own serializers for your custom data. - -### rendering : [`boolean`](../../API/builtins/boolean.md) -> **READ-ONLY** True while rendering is in progress. - -### rendering_progress : [`number`](../../API/builtins/number.md) -> Range: (0.0 - 1.0) - -### transport : [`renoise.Transport`](../../API/renoise/renoise.Transport.md) -> **READ-ONLY** - -### sequencer : [`renoise.PatternSequencer`](../../API/renoise/renoise.PatternSequencer.md) -> **READ-ONLY** - -### pattern_iterator : [`renoise.PatternIterator`](../../API/renoise/renoise.PatternIterator.md) -> **READ-ONLY** - -### sequencer_track_count : [`integer`](../../API/builtins/integer.md) -> **READ-ONLY** number of normal playback tracks (non-master or sends) in song. - -### send_track_count : [`integer`](../../API/builtins/integer.md) -> -**READ-ONLY** number of send tracks in song. - -### instruments : [`renoise.Instrument`](../../API/renoise/renoise.Instrument.md)[] -> **READ-ONLY** Instrument arrays - -### instruments_observable : [`renoise.Document.ObservableList`](../../API/renoise/renoise.Document.ObservableList.md) -> Track changes to document lists by attaching listener functions to it. -> NB: Notifiers will not broadcast changes made to list items, but only changes -> to the lists **layout** (items got added, removed, swapped). - -### patterns : [`renoise.Pattern`](../../API/renoise/renoise.Pattern.md)[] -> **READ-ONLY** Pattern arrays - -### patterns_observable : [`renoise.Document.ObservableList`](../../API/renoise/renoise.Document.ObservableList.md) -> Track changes to document lists by attaching listener functions to it. -> NB: Notifiers will not broadcast changes made to list items, but only changes -> to the lists **layout** (items got added, removed, swapped). - -### tracks : [`renoise.Track`](../../API/renoise/renoise.Track.md)[] -> **READ-ONLY** Track array - -### tracks_observable : [`renoise.Document.ObservableList`](../../API/renoise/renoise.Document.ObservableList.md) -> Track changes to document lists by attaching listener functions to it. -> NB: Notifiers will not broadcast changes made to list items, but only changes -> to the lists **layout** (items got added, removed, swapped). - -### selected_instrument : [`renoise.Instrument`](../../API/renoise/renoise.Instrument.md) -> **READ-ONLY** Selected in the instrument box. - -### selected_instrument_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### selected_instrument_index : [`integer`](../../API/builtins/integer.md) -> **READ-ONLY** Selected instrument index in the instrument box. - -### selected_instrument_index_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### selected_phrase : [`renoise.InstrumentPhrase`](../../API/renoise/renoise.InstrumentPhrase.md) -> **READ-ONLY** Selected phrase the instrument's phrase map piano view. - -### selected_phrase_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### selected_phrase_index : [`integer`](../../API/builtins/integer.md) -> **READ-ONLY** Selected phrase index the instrument's phrase map piano view. - -### selected_sample : [`renoise.Sample`](../../API/renoise/renoise.Sample.md) -> **READ-ONLY** Selected in the instrument's sample list. -> Only nil when no samples are present in the selected instrument. - -### selected_sample_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### selected_sample_index : [`integer`](../../API/builtins/integer.md) -> **READ-ONLY** Selected sample index in the instrument's sample list. -> Only 0 when no samples are present in the selected instrument. - -### selected_sample_modulation_set : [`renoise.SampleModulationSet`](../../API/renoise/renoise.SampleModulationSet.md) -> **READ-ONLY** Selected in the instrument's modulation view. - -### selected_sample_modulation_set_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### selected_sample_modulation_set_index : [`integer`](../../API/builtins/integer.md) -> **READ-ONLY** Selected modulation set index in the instrument's modulation view. - -### selected_sample_device_chain : [`renoise.SampleDeviceChain`](../../API/renoise/renoise.SampleDeviceChain.md) -> **READ-ONLY** Selected in the instrument's effects view. - -### selected_sample_device_chain_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### selected_sample_device_chain_index : [`integer`](../../API/builtins/integer.md) -> **READ-ONLY** Selected chain index in the instrument's effects view. - -### selected_sample_device : [`renoise.AudioDevice`](../../API/renoise/renoise.AudioDevice.md) -> **READ-ONLY** Selected in the sample effect mixer. - -### selected_sample_device_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### selected_sample_device_index : [`integer`](../../API/builtins/integer.md) -> **READ-ONLY** Selected device index in the sample effect mixer. - -### selected_track : [`renoise.Track`](../../API/renoise/renoise.Track.md) -> **READ-ONLY** Selected in the pattern editor or mixer. - -### selected_track_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### selected_track_index : [`integer`](../../API/builtins/integer.md) -> **READ-ONLY** Selected track index in the pattern editor or mixer. - -### selected_track_index_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### selected_track_device : [`renoise.AudioDevice`](../../API/renoise/renoise.AudioDevice.md) -> **READ-ONLY** Selected in the track DSP chain editor. - -### selected_track_device_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### selected_track_device_index : [`integer`](../../API/builtins/integer.md) -> **READ-ONLY** Selected device index in the track DSP chain editor. - -### selected_device : [`renoise.AudioDevice`](../../API/renoise/renoise.AudioDevice.md) -> **Deprecated.** **READ-ONLY** Use 'selected_track_device' instead. - -### selected_device_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> **Deprecated.** Use 'selected_track_device_observable' instead. - -### selected_device_index : [`integer`](../../API/builtins/integer.md) -> **Deprecated.** **READ-ONLY** Use 'selected_track_device_index' instead. - -### selected_parameter : [`renoise.DeviceParameter`](../../API/renoise/renoise.DeviceParameter.md) -> **Deprecated.** **READ-ONLY** Use 'selected_automation_parameter' instead. - -### selected_parameter_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### selected_automation_parameter : [`renoise.DeviceParameter`](../../API/renoise/renoise.DeviceParameter.md) -> Selected parameter in the automation editor. -> When setting a new parameter, parameter must be automateable and -> must be one of the currently selected track device chain. - -### selected_automation_parameter_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### selected_automation_device : [`renoise.AudioDevice`](../../API/renoise/renoise.AudioDevice.md) -> **READ-ONLY** Parent device of 'selected_automation_parameter'. - -### selected_automation_device_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### selected_pattern : [`renoise.Pattern`](../../API/renoise/renoise.Pattern.md) -> **READ-ONLY** The currently edited pattern. - -### selected_pattern_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### selected_pattern_index : [`integer`](../../API/builtins/integer.md) -> **READ-ONLY** The currently edited pattern index. - -### selected_pattern_index_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### selected_pattern_track : [`renoise.PatternTrack`](../../API/renoise/renoise.PatternTrack.md) -> **READ-ONLY** The currently edited pattern track object. -> and selected_track_observable for notifications. - -### selected_pattern_track_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### selected_sequence_index : [`integer`](../../API/builtins/integer.md) -> The currently edited sequence position. - -### selected_sequence_index_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### selected_line : [`renoise.PatternLine`](../../API/renoise/renoise.PatternLine.md) -> **READ-ONLY** The currently edited line in the edited pattern. - -### selected_line_index : [`integer`](../../API/builtins/integer.md) -### selected_note_column : [`renoise.NoteColumn`](../../API/renoise/renoise.NoteColumn.md) -> **READ-ONLY** The currently edited column in the selected line in the edited -> sequence/pattern. Nil when an effect column is selected. - -### selected_note_column_index : [`integer`](../../API/builtins/integer.md) -### selected_effect_column : [`renoise.EffectColumn`](../../API/renoise/renoise.EffectColumn.md) -> **READ-ONLY** The currently edited column in the selected line in the edited -> sequence/pattern. Nil when a note column is selected. - -### selected_effect_column_index : [`integer`](../../API/builtins/integer.md) -### selected_sub_column_type : [`renoise.Song.SubColumnType`](renoise.Song.md#SubColumnType) -> **READ-ONLY** The currently edited sub column type within the selected -> note/effect column. - -### selection_in_pattern : [`PatternSelection`](#patternselection)[`?`](../../API/builtins/nil.md) -> Read/write access to the selection in the pattern editor. -> -> Line indexes are valid from 1 to patterns[].number_of_lines -> Track indexes are valid from 1 to #tracks -> Column indexes are valid from 1 to -> (tracks[].visible_note_columns + tracks[].visible_effect_columns) -> -> When setting the selection, all members are optional. Combining them in -> various different ways will affect how specific the selection is. When -> `selection_in_pattern` returns nil or is set to nil, no selection is present. -> -> #### examples: -> ```lua -> renoise.song().selection_in_pattern = {} -> --> clear -> renoise.song().selection_in_pattern = { start_line = 1, end_line = 4 } -> --> select line 1 to 4, first to last track -> renoise.song().selection_in_pattern = -> { start_line = 1, start_track = 1, end_line = 4, end_track = 1 } -> --> select line 1 to 4, in the first track only -> ``` - -### selected_phrase_line : [`renoise.PatternLine`](../../API/renoise/renoise.PatternLine.md) -> **READ-ONLY** The currently edited line in the currently edited phrase. -> Nil when no phrase is selected. - -### selected_phrase_line_index : [`integer`](../../API/builtins/integer.md) -> The currently edited line index in the currently edited phrase. -> 0 when no phrase is selected. - -### selected_phrase_note_column : [`renoise.NoteColumn`](../../API/renoise/renoise.NoteColumn.md) -> **READ-ONLY** The currently edited column in the selected line in the currently -> edited phrase. Nil when no phrase is selected or when an effect column is selected. - -### selected_phrase_note_column_index : [`integer`](../../API/builtins/integer.md) -> The currently edited column index in the selected line in the currently edited -> phrase. 0 when no phrase is selected or when an effect column is selected. - -### selected_phrase_effect_column : [`renoise.EffectColumn`](../../API/renoise/renoise.EffectColumn.md) -> **READ-ONLY** The currently edited column in the selected line in the currently -> edited phrase. Nil when no phrase is selected or when a note column is selected. - -### selected_phrase_effect_column_index : [`integer`](../../API/builtins/integer.md) -> The currently edited effect column index in the selected line in the currently -> edited phrase. 0 when no phrase is selected or when a note column is selected. - -### selected_phrase_sub_column_type : [`renoise.Song.SubColumnType`](renoise.Song.md#SubColumnType) -> **READ-ONLY** The currently edited sub column type within the selected -> note/effect column in the current phrase. 0 when no phrase is selected. - -### selection_in_phrase : [`PhraseSelection`](#phraseselection)[`?`](../../API/builtins/nil.md) -> Same as `selection_in_pattern` but for the currently selected phrase (if any). - - - ---- -## Functions -### is_undo_redoing([*self*](../../API/builtins/self.md)) -> True while an undo/redo action is invoked. This may be useful to check in notifiers, -> to figure out if the document currently changes because of an undo/redo operation. -### can_undo([*self*](../../API/builtins/self.md)) -`->`[`boolean`](../../API/builtins/boolean.md) - -> Test if something in the song can be undone. -### undo([*self*](../../API/builtins/self.md)) -> Undo the last performed action. Will do nothing if nothing can be undone. -### can_redo([*self*](../../API/builtins/self.md)) -`->`[`boolean`](../../API/builtins/boolean.md) - -> Test if something in the song can be redone. -### redo([*self*](../../API/builtins/self.md)) -> Redo a previously undo action. Will do nothing if nothing can be redone. -### describe_undo([*self*](../../API/builtins/self.md), description : [`string`](../../API/builtins/string.md)) -> When modifying the song, Renoise will automatically add descriptions for -> undo/redo by looking at what first changed (a track was inserted, a pattern -> line changed, and so on). When the song is changed from an action in a menu -> entry callback, the menu entry's label will automatically be used for the -> undo description. -> If those auto-generated names do not work for you, or you want to use -> something more descriptive, you can, **before changing anything in the song**, -> give your changes a custom undo description (like: "Generate Synth Sample") -### describe_batch_undo([*self*](../../API/builtins/self.md), description : [`string`](../../API/builtins/string.md), timeout_ms : [`number`](../../API/builtins/number.md)[`?`](../../API/builtins/nil.md)) -> Same as `describe_undo`, but additionally this tries to merge the following -> changes to the document with the last one, if the description matches the last -> description and the given timeout was not reached since the last describe_batch_undo -> call. -> -> Calls to `describe_undo` from other tools, or from Renoise internally, will cancel -> batches and split the undo action. -> -> Batches can be useful to combine multiple changes in the document into a single -> udo/redo step, when the changes happen asynchroniously, for example a process -> sliced action (via Lua coroutines). -### insert_track_at([*self*](../../API/builtins/self.md), index : [`integer`](../../API/builtins/integer.md)) -`->`[`renoise.Track`](../../API/renoise/renoise.Track.md) - -> Insert a new track at the given index. Inserting a track behind or at the -> Master Track's index will create a Send Track. Otherwise, a regular track is -> created. -### delete_track_at([*self*](../../API/builtins/self.md), index : [`integer`](../../API/builtins/integer.md)) -> Delete an existing track. The Master track can not be deleted, but all Sends -> can. Renoise needs at least one regular track to work, thus trying to -> delete all regular tracks will fire an error. -### swap_tracks_at([*self*](../../API/builtins/self.md), index1 : [`integer`](../../API/builtins/integer.md), index2 : [`integer`](../../API/builtins/integer.md)) -> Swap the positions of two tracks. A Send can only be swapped with a Send -> track and a regular track can only be swapped with another regular track. -> The Master can not be swapped at all. -### track([*self*](../../API/builtins/self.md), index : [`integer`](../../API/builtins/integer.md)) -`->`[`renoise.Track`](../../API/renoise/renoise.Track.md) - -> Access to a single track by index. Use properties 'tracks' to iterate over -> all tracks and to query the track count. -### select_previous_track([*self*](../../API/builtins/self.md)) -> Set the selected track to prev relative to the current track. Takes -> care of skipping over hidden tracks and wrapping around at the edges. -### select_next_track([*self*](../../API/builtins/self.md)) -> Set the selected track to next relative to the current track. Takes -> care of skipping over hidden tracks and wrapping around at the edges. -### insert_group_at([*self*](../../API/builtins/self.md), index : [`integer`](../../API/builtins/integer.md)) -`->`[`renoise.GroupTrack`](../../API/renoise/renoise.GroupTrack.md) - -> Insert a new group track at the given index. Group tracks can only be -> inserted before the Master track. -### add_track_to_group([*self*](../../API/builtins/self.md), track_index : [`integer`](../../API/builtins/integer.md), group_index : [`integer`](../../API/builtins/integer.md)) -> Add track at track_index to group at group_index by first moving it to the -> right spot to the left of the group track, and then adding it. If group_index -> is not a group track, a new group track will be created and both tracks -> will be added to it. -### remove_track_from_group([*self*](../../API/builtins/self.md), track_index : [`integer`](../../API/builtins/integer.md)) -> Removes track from its immediate parent group and places it outside it to -> the left. Can only be called for tracks that are actually part of a group. -### delete_group_at([*self*](../../API/builtins/self.md), group_index : [`integer`](../../API/builtins/integer.md)) -> Delete the group with the given index and all its member tracks. -> Index must be that of a group or a track that is a member of a group. -### insert_instrument_at([*self*](../../API/builtins/self.md), index : [`integer`](../../API/builtins/integer.md)) -`->`[`renoise.Instrument`](../../API/renoise/renoise.Instrument.md) - -> Insert a new instrument at the given index. This will remap all existing -> notes in all patterns, if needed, and also update all other instrument links -> in the song. Can't have more than MAX_NUMBER_OF_INSTRUMENTS in a song. -### delete_instrument_at([*self*](../../API/builtins/self.md), index : [`integer`](../../API/builtins/integer.md)) -> Delete an existing instrument at the given index. Renoise needs at least one -> instrument, thus trying to completely remove all instruments is not allowed. -> This will remap all existing notes in all patterns and update all other -> instrument links in the song. -### swap_instruments_at([*self*](../../API/builtins/self.md), index1 : [`integer`](../../API/builtins/integer.md), index2 : [`integer`](../../API/builtins/integer.md)) -> Swap the position of two instruments. Will remap all existing notes in all -> patterns and update all other instrument links in the song. -### instrument([*self*](../../API/builtins/self.md), index : [`integer`](../../API/builtins/integer.md)) -`->`[`renoise.Instrument`](../../API/renoise/renoise.Instrument.md) - -> Access to a single instrument by index. Use properties 'instruments' to iterate -> over all instruments and to query the instrument count. -### capture_instrument_from_pattern([*self*](../../API/builtins/self.md)) -> Captures the current instrument (selects the instrument) from the current -> note column at the current cursor pos. Changes the selected instrument -> accordingly, but does not return the result. When no instrument is present at -> the current cursor pos, nothing will be done. -### capture_nearest_instrument_from_pattern([*self*](../../API/builtins/self.md)) -> Tries to captures the nearest instrument from the current pattern track, -> starting to look at the cursor pos, then advancing until an instrument is -> found. Changes the selected instrument accordingly, but does not return -> the result. When no instruments (notes) are present in the current pattern -> track, nothing will be done. -### pattern([*self*](../../API/builtins/self.md), index : [`integer`](../../API/builtins/integer.md)) -`->`[`renoise.Pattern`](../../API/renoise/renoise.Pattern.md) - -> Access to a single pattern by index. Use properties 'patterns' to iterate -> over all patterns and to query the pattern count. -### render([*self*](../../API/builtins/self.md), options : [`RenderOptions`](#renderoptions), filename : [`string`](../../API/builtins/string.md), rendering_done_callback : fun()) -`->`success : [`boolean`](../../API/builtins/boolean.md), error : [`string`](../../API/builtins/string.md) - -> Start rendering a section of the song or the whole song to a WAV file. -> -> Rendering job will be done in the background and the call will return -> back immediately, but the Renoise GUI will be blocked during rendering. The -> passed `rendering_done_callback` function is called as soon as rendering is -> done, e.g. successfully completed. -> -> While rendering, the rendering status can be polled with the `song().rendering` -> and `song().rendering_progress` properties, for example, in idle notifier -> loops. If starting the rendering process fails (because of file IO errors for -> example), the render function will return false and the error message is set -> as the second return value. On success, only a single `true` value is -> returned. -> -> To render only specific tracks or columns, mute the undesired tracks/columns -> before starting to render. -> -> Parameter `file_name` must point to a valid, maybe already existing file. If it -> already exists, the file will be silently overwritten. The renderer will -> automatically add a ".wav" extension to the file_name, if missing. -> -> Parameter `rendering_done_callback` is ONLY called when rendering has succeeded. -> You can do something with the file you've passed to the renderer here, like -> for example loading the file into a sample buffer. -### cancel_rendering([*self*](../../API/builtins/self.md)) -> When rendering (see rendering, renoise.song().rendering_progress), -> the current render process is canceled. Otherwise, nothing is done. -### trigger_pattern_line([*self*](../../API/builtins/self.md), line_index : [`integer`](../../API/builtins/integer.md)) -> Trigger the given pattern line index in the current pattern for preview purposes. -> This works similar to the Renoise `PlayCurrentLine` keyboard shortcut, but does now -> advance the playback position. -> -> If you want to preview a single track's note only, mute other tracks before -> triggering the pattern line. To stop the preview, invoke `stop` from the transport. -> -> Transport playback must be stopped for this to work. If it's not, an error is -> thrown. -> -> This is evaluated from the GUI thread, not a real-time thread, so timing will -> be a little bit wonky. Don't try to use this as a custom sequencer! -### trigger_instrument_note_on([*self*](../../API/builtins/self.md), instrument_index : [`integer`](../../API/builtins/integer.md), track_index : [`integer`](../../API/builtins/integer.md), note : [`integer`](../../API/builtins/integer.md) | [`integer`](../../API/builtins/integer.md)[][`?`](../../API/builtins/nil.md), volume : [`number`](../../API/builtins/number.md)[`?`](../../API/builtins/nil.md)) -> Trigger instrument playback with the specified note or a table of notes (a chord) -> and volume for preview purposes on the given track index. -> -> Send tracks can not play notes. When specifying a send track, notes will play on -> the master track instead. -> -> This is evaluated from the GUI thread, not a real-time thread, so timing will -> be a little bit wonky. Only use this to **preview instruments** from tools and -> not as a sequencer. -### trigger_instrument_note_off([*self*](../../API/builtins/self.md), instrument_index : [`integer`](../../API/builtins/integer.md), track_index : [`integer`](../../API/builtins/integer.md), note : [`integer`](../../API/builtins/integer.md) | [`integer`](../../API/builtins/integer.md)[][`?`](../../API/builtins/nil.md)) -> Stop instrument playback which previously got started via `trigger_instrument_note_on`. -### trigger_sample_note_on([*self*](../../API/builtins/self.md), instrument_index : [`integer`](../../API/builtins/integer.md), sample_index : [`integer`](../../API/builtins/integer.md), track_index : [`integer`](../../API/builtins/integer.md), note : [`integer`](../../API/builtins/integer.md)[`?`](../../API/builtins/nil.md), volume : [`number`](../../API/builtins/number.md)[`?`](../../API/builtins/nil.md), use_selection : [`boolean`](../../API/builtins/boolean.md)[`?`](../../API/builtins/nil.md)) -> Trigger a sample with the specified note and volume for preview purposes on the -> given track. This directly triggers the sample, bypassing the instrument's keyzone. -> -> Only use this to **preview samples** from tools and not as a sequencer. -> See also `trigger_instrument_note_on`. -### trigger_sample_note_off([*self*](../../API/builtins/self.md), instrument_index : [`integer`](../../API/builtins/integer.md), sample_index : [`integer`](../../API/builtins/integer.md), track_index : [`integer`](../../API/builtins/integer.md), note : [`integer`](../../API/builtins/integer.md)[`?`](../../API/builtins/nil.md)) -> Stops sample playback that previously got triggered via `trigger_sample_note_on`. -### load_midi_mappings([*self*](../../API/builtins/self.md), filename : [`string`](../../API/builtins/string.md)) -`->`success : [`boolean`](../../API/builtins/boolean.md), error : [`string`](../../API/builtins/string.md) - -> Load all global MIDI mappings in the song into a XRNM file. -> Returns true when loading/saving succeeded, else false and the error message. -### save_midi_mappings([*self*](../../API/builtins/self.md), filename : [`string`](../../API/builtins/string.md)) -`->`success : [`boolean`](../../API/builtins/boolean.md), error : [`string`](../../API/builtins/string.md) - -> Save all global MIDI mappings in the song into a XRNM file. -> Returns true when loading/saving succeeded, else false and the error message. -### clear_midi_mappings([*self*](../../API/builtins/self.md)) -> clear all MIDI mappings in the song - - - ---- -## Structs -# PatternSelection -> Selection range in the current pattern - ---- -## Properties -### start_line : [`integer`](../../API/builtins/integer.md)[`?`](../../API/builtins/nil.md) -> Start pattern line index - -### start_track : [`integer`](../../API/builtins/integer.md)[`?`](../../API/builtins/nil.md) -> Start track index - -### start_column : [`integer`](../../API/builtins/integer.md)[`?`](../../API/builtins/nil.md) -> Start column index within start_track - -### end_line : [`integer`](../../API/builtins/integer.md)[`?`](../../API/builtins/nil.md) -> End pattern line index - -### end_track : [`integer`](../../API/builtins/integer.md)[`?`](../../API/builtins/nil.md) -> End track index - -### end_column : [`integer`](../../API/builtins/integer.md)[`?`](../../API/builtins/nil.md) -> End column index within end_track - - - - -# PhraseSelection -> Selection range in the current phrase - ---- -## Properties -### start_line : [`integer`](../../API/builtins/integer.md)[`?`](../../API/builtins/nil.md) -> Start pattern line index - -### start_column : [`integer`](../../API/builtins/integer.md)[`?`](../../API/builtins/nil.md) -> Start column index within start_track - -### end_line : [`integer`](../../API/builtins/integer.md)[`?`](../../API/builtins/nil.md) -> End pattern line index - -### end_column : [`integer`](../../API/builtins/integer.md)[`?`](../../API/builtins/nil.md) -> End column index within end_track - - - - -# RenderOptions - ---- -## Properties -### start_pos : [`renoise.SongPos`](../../API/renoise/renoise.SongPos.md) -> by default the song start. - -### end_pos : [`renoise.SongPos`](../../API/renoise/renoise.SongPos.md) -> by default the song end. - -### sample_rate : `192000` | `22050` | `44100` | `48000` | `88200` | `96000` -> by default the players current rate. - -### bit_depth : `16` | `24` | `32` -> by default 32. - -### interpolation : `"default"` | `"precise"` -> by default "default". - -### priority : `"high"` | `"low"` | `"realtime"` -> by default "high". - - - - - diff --git a/docs/API/renoise/renoise.SongPos.md b/docs/API/renoise/renoise.SongPos.md deleted file mode 100644 index f349d93..0000000 --- a/docs/API/renoise/renoise.SongPos.md +++ /dev/null @@ -1,16 +0,0 @@ -# renoise.SongPos -> Helper class used in Transport and Song, representing a position in the song. - - - - ---- -## Properties -### sequence : [`integer`](../../API/builtins/integer.md) -> Position in the pattern sequence. - -### line : [`integer`](../../API/builtins/integer.md) -> Position in the pattern at the given pattern sequence. - - - diff --git a/docs/API/renoise/renoise.Track.md b/docs/API/renoise/renoise.Track.md deleted file mode 100644 index 6b0718e..0000000 --- a/docs/API/renoise/renoise.Track.md +++ /dev/null @@ -1,255 +0,0 @@ -# renoise.Track -> Track component of a Renoise song. - - - -## Constants -### TrackType -> ```lua -> { -> TRACK_TYPE_SEQUENCER: integer = 1, -> TRACK_TYPE_MASTER: integer = 2, -> TRACK_TYPE_SEND: integer = 3, -> TRACK_TYPE_GROUP: integer = 4, -> } -> ``` -### MuteState -> ```lua -> { -> MUTE_STATE_ACTIVE: integer = 1, -> MUTE_STATE_OFF: integer = 2, -> MUTE_STATE_MUTED: integer = 3, -> } -> ``` - - ---- -## Properties -### type : [`renoise.Track.TrackType`](renoise.Track.md#TrackType) -> **READ-ONLY** - -### name : [`string`](../../API/builtins/string.md) -> Name, as visible in track headers - -### name_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### color : [`RGBColor`](#RGBColor) -> A table of 3 bytes (ranging from 0 to 255) -> representing the red, green and blue channels of a color. -> {0xFF, 0xFF, 0xFF} is white -> {165, 73, 35} is the red from the Renoise logo - -### color_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### color_blend : [`integer`](../../API/builtins/integer.md) -> Range: (0 - 100) Color blend in percent - -### color_blend_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### mute_state : [`renoise.Track.MuteState`](renoise.Track.md#MuteState) -> Mute and solo states. Not available for the master track. - -### mute_state_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### solo_state : [`boolean`](../../API/builtins/boolean.md) -### solo_state_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### prefx_volume : [`renoise.DeviceParameter`](../../API/renoise/renoise.DeviceParameter.md) -> **READ-ONLY** - -### prefx_panning : [`renoise.DeviceParameter`](../../API/renoise/renoise.DeviceParameter.md) -> **READ-ONLY** - -### prefx_width : [`renoise.DeviceParameter`](../../API/renoise/renoise.DeviceParameter.md) -> **READ-ONLY** - -### postfx_volume : [`renoise.DeviceParameter`](../../API/renoise/renoise.DeviceParameter.md) -> **READ-ONLY** - -### postfx_panning : [`renoise.DeviceParameter`](../../API/renoise/renoise.DeviceParameter.md) -> **READ-ONLY** - -### collapsed : [`boolean`](../../API/builtins/boolean.md) -> Collapsed/expanded visual appearance. - -### collapsed_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### group_parent : [`renoise.GroupTrack`](../../API/renoise/renoise.GroupTrack.md) -> **READ-ONLY** - -### available_output_routings : [`string`](../../API/builtins/string.md)[] -> **READ-ONLY** - -### output_routing : [`string`](../../API/builtins/string.md) -> One of `available_output_routings` - -### output_routing_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### output_delay : [`number`](../../API/builtins/number.md) -> Range: (-100.0-100.0) in ms - -### output_delay_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### max_effect_columns : [`integer`](../../API/builtins/integer.md) -> **READ-ONLY** 8 OR 0 depending on the track type - -### min_effect_columns : [`integer`](../../API/builtins/integer.md) -> **READ-ONLY** 1 OR 0 depending on the track type - -### max_note_columns : [`integer`](../../API/builtins/integer.md) -> **READ-ONLY** 12 OR 0 depending on the track type - -### min_note_columns : [`integer`](../../API/builtins/integer.md) -> **READ-ONLY** 1 OR 0 depending on the track type - -### visible_effect_columns : [`integer`](../../API/builtins/integer.md) -> 1-8 OR 0-8, depending on the track type - -### visible_effect_columns_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### visible_note_columns : [`integer`](../../API/builtins/integer.md) -> 0 OR 1-12, depending on the track type - -### visible_note_columns_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### volume_column_visible : [`boolean`](../../API/builtins/boolean.md) -### volume_column_visible_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### panning_column_visible : [`boolean`](../../API/builtins/boolean.md) -### panning_column_visible_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### delay_column_visible : [`boolean`](../../API/builtins/boolean.md) -### delay_column_visible_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### sample_effects_column_visible : [`boolean`](../../API/builtins/boolean.md) -### sample_effects_column_visible_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### available_devices : [`string`](../../API/builtins/string.md)[] -> **READ-ONLY** FX devices this track can handle. - -### available_device_infos : [`AudioDeviceInfo`](#audiodeviceinfo)[] -> **READ-ONLY** Array of tables containing information about the devices. - -### devices : [`renoise.AudioDevice`](../../API/renoise/renoise.AudioDevice.md)[] -> **READ-ONLY** List of audio DSP FX. - -### devices_observable : [`renoise.Document.ObservableList`](../../API/renoise/renoise.Document.ObservableList.md) -> Track changes to document lists by attaching listener functions to it. -> NB: Notifiers will not broadcast changes made to list items, but only changes -> to the lists **layout** (items got added, removed, swapped). - - - ---- -## Functions -### insert_device_at([*self*](../../API/builtins/self.md), device_path : [`string`](../../API/builtins/string.md), device_index : [`integer`](../../API/builtins/integer.md)) -`->`[`renoise.AudioDevice`](../../API/renoise/renoise.AudioDevice.md) - -> Insert a new device at the given position. `device_path` must be one of -> `renoise.Track.available_devices`. -### delete_device_at([*self*](../../API/builtins/self.md), device_index : [`any`](../../API/builtins/any.md)) -> Delete an existing device in a track. The mixer device at index 1 can not -> be deleted from any track. -### swap_devices_at([*self*](../../API/builtins/self.md), device_index1 : [`integer`](../../API/builtins/integer.md), device_index2 : [`integer`](../../API/builtins/integer.md)) -> Swap the positions of two devices in the device chain. The mixer device at -> index 1 can not be swapped or moved. -### device([*self*](../../API/builtins/self.md), device_index : [`integer`](../../API/builtins/integer.md)) -`->`[`renoise.AudioDevice`](../../API/renoise/renoise.AudioDevice.md) - -> Access to a single device by index. Use property `devices` to iterate -> over all devices and to query the device count. -### mute([*self*](../../API/builtins/self.md)) -> Uses default mute state from the prefs. Not for the master track. -### unmute([*self*](../../API/builtins/self.md)) -### solo([*self*](../../API/builtins/self.md)) -### column_is_muted([*self*](../../API/builtins/self.md), column_index : [`integer`](../../API/builtins/integer.md)) -`->`[`boolean`](../../API/builtins/boolean.md) - -> Note column mutes. Only valid within (1-track.max_note_columns) -### column_is_muted_observable([*self*](../../API/builtins/self.md), column_index : [`integer`](../../API/builtins/integer.md)) -`->`[`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) - -### set_column_is_muted([*self*](../../API/builtins/self.md), column_index : [`integer`](../../API/builtins/integer.md), muted : [`boolean`](../../API/builtins/boolean.md)) -### column_name([*self*](../../API/builtins/self.md), column_index : [`integer`](../../API/builtins/integer.md)) -`->`[`string`](../../API/builtins/string.md) - -> Note column names. Only valid within (1-track.max_note_columns) -### column_name_observable([*self*](../../API/builtins/self.md), column_index : [`integer`](../../API/builtins/integer.md)) -`->`[`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) - -### set_column_name([*self*](../../API/builtins/self.md), column_index : [`integer`](../../API/builtins/integer.md), name : [`string`](../../API/builtins/string.md)) -### swap_note_columns_at([*self*](../../API/builtins/self.md), column_index1 : [`integer`](../../API/builtins/integer.md), column_index2 : [`integer`](../../API/builtins/integer.md)) -> Swap the positions of two note or effect columns within a track. -### swap_effect_columns_at([*self*](../../API/builtins/self.md), column_index1 : [`integer`](../../API/builtins/integer.md), column_index2 : [`integer`](../../API/builtins/integer.md)) - - - ---- -## Structs -# AudioDeviceInfo -> Audio device info - ---- -## Properties -### path : [`string`](../../API/builtins/string.md) -> The device's path used by `renoise.Track:insert_device_at` - -### name : [`string`](../../API/builtins/string.md) -> The device's name - -### short_name : [`string`](../../API/builtins/string.md) -> The device's name as displayed in shortened lists - -### favorite_name : [`string`](../../API/builtins/string.md) -> The device's name as displayed in favorites - -### is_favorite : [`boolean`](../../API/builtins/boolean.md) -> true if the device is a favorite - -### is_bridged : [`boolean`](../../API/builtins/boolean.md) -> true if the device is a bridged plugin - - - - - - - ---- -## Aliases -### RGBColor -{ 1 : [`integer`](../../API/builtins/integer.md), 2 : [`integer`](../../API/builtins/integer.md), 3 : [`integer`](../../API/builtins/integer.md) } -> A table of 3 bytes (ranging from 0 to 255) -> representing the red, green and blue channels of a color. -> {0xFF, 0xFF, 0xFF} is white -> {165, 73, 35} is the red from the Renoise logo - - diff --git a/docs/API/renoise/renoise.Transport.md b/docs/API/renoise/renoise.Transport.md deleted file mode 100644 index eeaedc2..0000000 --- a/docs/API/renoise/renoise.Transport.md +++ /dev/null @@ -1,343 +0,0 @@ -# renoise.Transport -> Transport component of the Renoise song. - - - -## Constants -### PlayMode -> ```lua -> { -> PLAYMODE_RESTART_PATTERN: integer = 1, -> PLAYMODE_CONTINUE_PATTERN: integer = 2, -> } -> ``` -### RecordParameterMode -> ```lua -> { -> RECORD_PARAMETER_MODE_PATTERN: integer = 1, -> RECORD_PARAMETER_MODE_AUTOMATION: integer = 2, -> } -> ``` -### TimingModel -> ```lua -> { -> TIMING_MODEL_SPEED: integer = 1, -> TIMING_MODEL_LPB: integer = 2, -> } -> ``` -### SyncMode -> ```lua -> { -> SYNC_MODE_INTERNAL: integer = 1, -> SYNC_MODE_MIDI_CLOCK: integer = 2, -> SYNC_MODE_ABLETON_LINK: integer = 3, -> SYNC_MODE_JACK: integer = 4, -> } -> ``` - - ---- -## Properties -### playing : [`boolean`](../../API/builtins/boolean.md) -> Playing - -### playing_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### sync_mode : [`renoise.Transport.SyncMode`](renoise.Transport.md#SyncMode) -> Transport sync mode. -> Note: `SYNC_MODE_JACK` only is available on Linux. Trying to enable it on -> other platforms will fire an error. - -### sync_mode_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### timing_model : [`renoise.Transport.TimingModel`](renoise.Transport.md#TimingModel) -> *READ-ONLY* Old school speed or new LPB timing used? -> With `TIMING_MODEL_SPEED`, tpl is used as speed factor. The lpb property -> is unused then. With `TIMING_MODEL_LPB`, tpl is used as event rate for effects -> only and lpb defines relationship between pattern lines and beats. - -### bpm : [`number`](../../API/builtins/number.md) -> Range: (32 - 999) Beats per Minute - -### bpm_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### lpb : [`integer`](../../API/builtins/integer.md) -> Range: (1 - 256) Lines per Beat - -### lpb_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### tpl : [`integer`](../../API/builtins/integer.md) -> Range: (1 - 16) Ticks per Line - -### tpl_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### playback_pos : [`renoise.SongPos`](../../API/renoise/renoise.SongPos.md) -> Playback position - -### playback_pos_beats : [`number`](../../API/builtins/number.md) -> Range: (0 - song_end_beats) Song position in beats - -### edit_pos : [`renoise.SongPos`](../../API/renoise/renoise.SongPos.md) -> Edit position - -### edit_pos_beats : [`number`](../../API/builtins/number.md) -> Range: (0 - song_end_beats) Song position in beats - -### song_length : [`renoise.SongPos`](../../API/renoise/renoise.SongPos.md) -> **READ-ONLY** - -### song_length_beats : [`number`](../../API/builtins/number.md) -> **READ-ONLY** - -### loop_start : [`renoise.SongPos`](../../API/renoise/renoise.SongPos.md) -> **READ-ONLY** - -### loop_end : [`renoise.SongPos`](../../API/renoise/renoise.SongPos.md) -> **READ-ONLY** - -### loop_range : [`renoise.SongPos`](../../API/renoise/renoise.SongPos.md)[] -> {loop start, loop end} - -### loop_start_beats : [`number`](../../API/builtins/number.md) -> **READ-ONLY** Range: (0 - song_end_beats) - -### loop_end_beats : [`number`](../../API/builtins/number.md) -> **READ-ONLY** Range: (0 - song_end_beats) - -### loop_range_beats : [`number`](../../API/builtins/number.md)[] -> {loop start beats, loop end beats} - -### loop_sequence_start : [`integer`](../../API/builtins/integer.md) -> **READ-ONLY** 0 or Range: (1 - sequence length) - -### loop_sequence_end : [`integer`](../../API/builtins/integer.md) -> **READ-ONLY** 0 or Range: (1 - sequence length) - -### loop_sequence_range : [`integer`](../../API/builtins/integer.md)[] -> {} or Range(sequence start, sequence end) - -### loop_pattern : [`boolean`](../../API/builtins/boolean.md) -> Pattern Loop On/Off - -### loop_pattern_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### loop_block_enabled : [`boolean`](../../API/builtins/boolean.md) -> Block Loop On/Off - -### loop_block_enabled_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### loop_block_range_coeff : [`integer`](../../API/builtins/integer.md) -> Range: (2 - 16) - -### loop_block_range_coeff_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### loop_block_start_pos : [`renoise.SongPos`](../../API/renoise/renoise.SongPos.md) -> Start of block loop - -### edit_mode : [`boolean`](../../API/builtins/boolean.md) -> Pattern edit/record mode On/Off - -### edit_mode_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### edit_step : [`integer`](../../API/builtins/integer.md) -> Range: (0 - 64) - -### edit_step_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### octave : [`integer`](../../API/builtins/integer.md) -> Range: (0 - 8) - -### octave_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### octave_enabled : [`boolean`](../../API/builtins/boolean.md) -> Enabled for MIDI keyboards - -### octave_enabled_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### metronome_enabled : [`boolean`](../../API/builtins/boolean.md) -> Metronome playback On/Off - -### metronome_enabled_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### metronome_beats_per_bar : [`integer`](../../API/builtins/integer.md) -> Range: (1 - 16) or 0 = guess from pattern length - -### metronome_beats_per_bar_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### metronome_lines_per_beat : [`integer`](../../API/builtins/integer.md) -> Range: (1 - 256) or 0 = songs current LPB - -### metronome_lines_per_beat_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### metronome_precount_enabled : [`boolean`](../../API/builtins/boolean.md) -> Metronome precount playback On/Off - -### metronome_precount_enabled_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### metronome_precount_bars : [`integer`](../../API/builtins/integer.md) -> Range: (1 - 4) - -### metronome_precount_bars_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### metronome_volume : [`number`](../../API/builtins/number.md) -> Range: (0 - math.db2lin(6)) - -### metronome_volume_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### record_quantize_enabled : [`boolean`](../../API/builtins/boolean.md) -> Record note quantization On/Off - -### record_quantize_enabled_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### record_quantize_lines : [`integer`](../../API/builtins/integer.md) -> Range: (1 - 32) - -### record_quantize_lines_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### record_parameter_mode : [`renoise.Transport.RecordParameterMode`](renoise.Transport.md#RecordParameterMode) -> Record parameter - -### record_parameter_mode_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### follow_player : [`boolean`](../../API/builtins/boolean.md) -> Follow, wrapped pattern, single track modes - -### follow_player_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### wrapped_pattern_edit : [`boolean`](../../API/builtins/boolean.md) -### wrapped_pattern_edit_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### single_track_edit_mode : [`boolean`](../../API/builtins/boolean.md) -### single_track_edit_mode_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### groove_enabled : [`boolean`](../../API/builtins/boolean.md) -> Groove (aka Shuffle) - -### groove_enabled_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### groove_amounts : [`number`](../../API/builtins/number.md)[] -> table with 4 numbers in Range: (0 - 1) - -### groove_assignment_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Will be called as soon as any groove value changed. - -### track_headroom : [`number`](../../API/builtins/number.md) -> Global Track Headroom -> To convert to dB: `dB = math.lin2db(renoise.Transport.track_headroom)` -> To convert from dB: `renoise.Transport.track_headroom = math.db2lin(dB)` -> Range: (math.db2lin(-12) - math.db2lin(0)) - -### track_headroom_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### keyboard_velocity_enabled : [`boolean`](../../API/builtins/boolean.md) -> Computer Keyboard Velocity. - -### keyboard_velocity_enabled_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### keyboard_velocity : [`integer`](../../API/builtins/integer.md) -> Will return the default value of 127 when keyboard_velocity_enabled == false. -> Range: (0 - 127) - -### keyboard_velocity_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - -### sample_recording : [`boolean`](../../API/builtins/boolean.md) -> *READ-ONLY* true when sample sample dialog is visible and recording started. - -### sample_recording_sync_enabled : [`boolean`](../../API/builtins/boolean.md) -> Sample recording pattern quantization On/Off. - -### sample_recording_sync_enabled_observable : [`renoise.Document.Observable`](../../API/renoise/renoise.Document.Observable.md) -> Track changes to document properties or general states by attaching listener -> functions to it. - - - ---- -## Functions -### panic([*self*](../../API/builtins/self.md)) -> Panic. -### start([*self*](../../API/builtins/self.md), mode : [`renoise.Transport.PlayMode`](renoise.Transport.md#PlayMode)) -> Start playing in song or pattern mode. -### start_at([*self*](../../API/builtins/self.md), line : [`integer`](../../API/builtins/integer.md)) -> Start playing the currently edited pattern at the given line offset -### start_at([*self*](../../API/builtins/self.md), song_pos : [`renoise.SongPos`](../../API/renoise/renoise.SongPos.md)) -> Start playing a the given renoise.SongPos (sequence pos and line) -### stop([*self*](../../API/builtins/self.md)) -> Stop playing. When already stopped this just stops all playing notes. -### trigger_sequence([*self*](../../API/builtins/self.md), sequence_pos : [`integer`](../../API/builtins/integer.md)) -> Immediately start playing at the given sequence position. -### add_scheduled_sequence([*self*](../../API/builtins/self.md), sequence_pos : [`integer`](../../API/builtins/integer.md)) -> Append the sequence to the scheduled sequence list. Scheduled playback -> positions will apply as soon as the currently playing pattern play to end. -### set_scheduled_sequence([*self*](../../API/builtins/self.md), sequence_pos : [`integer`](../../API/builtins/integer.md)) -> Replace the scheduled sequence list with the given sequence. -### loop_block_move_forwards([*self*](../../API/builtins/self.md)) -> Move the block loop one segment forwards, when possible. -### loop_block_move_backwards([*self*](../../API/builtins/self.md)) -> Move the block loop one segment backwards, when possible. -### start_sample_recording([*self*](../../API/builtins/self.md)) -> Start a new sample recording when the sample dialog is visible. -### stop_sample_recording([*self*](../../API/builtins/self.md)) -> Stop sample recording when the sample dialog is visible and running -### start_stop_sample_recording([*self*](../../API/builtins/self.md)) -> **Deprecated.** Use `start_sample_recording` or `stop_sample_recording` instead. -### cancel_sample_recording([*self*](../../API/builtins/self.md)) -> Cancel a currently running sample recording when the sample dialog -> is visible, otherwise do nothing. - diff --git a/docs/API/renoise/renoise.ViewBuilder.md b/docs/API/renoise/renoise.ViewBuilder.md deleted file mode 100644 index cba703c..0000000 --- a/docs/API/renoise/renoise.ViewBuilder.md +++ /dev/null @@ -1,8429 +0,0 @@ -# renoise.ViewBuilder -> Class which is used to construct new views. All view properties can optionally -> be in-lined in a passed construction table: -> ```lua -> local vb = renoise.ViewBuilder() -- create a new ViewBuilder -> vb:button { text = "ButtonText" } -- is the same as -> my_button = vb:button(); my_button.text = "ButtonText" -> ``` -> Besides the listed class properties, you can also specify the following -> "extra" properties in the passed table: -> -> * id = "SomeString": Can be use to resolve the view later on, e.g. -> `vb.views.SomeString` or `vb.views["SomeString"]` -> -> * Nested child views: Add child views to the currently specified view. -> -> #### examples: -> ```lua -> -- creates a column view with `margin = 1` and adds two text views to the column. -> vb:column { -> margin = 1, -> views = { -> vb:text { -> text = "Text1" -> }, -> vb:text { -> text = "Text1" -> } -> } -> } -> ``` - - - -## Constants - -### DEFAULT_CONTROL_MARGIN : [`integer`](../../API/builtins/integer.md) -> The default margin for all control views - -### DEFAULT_CONTROL_SPACING : [`integer`](../../API/builtins/integer.md) -> The default spacing for all control views - -### DEFAULT_CONTROL_HEIGHT : [`integer`](../../API/builtins/integer.md) -> The default height for control views - -### DEFAULT_MINI_CONTROL_HEIGHT : [`integer`](../../API/builtins/integer.md) -> The default height for mini-sliders - -### DEFAULT_DIALOG_MARGIN : [`integer`](../../API/builtins/integer.md) -> The default margin for dialogs - -### DEFAULT_DIALOG_SPACING : [`integer`](../../API/builtins/integer.md) -> The default spacing for dialogs - -### DEFAULT_DIALOG_BUTTON_HEIGHT : [`integer`](../../API/builtins/integer.md) -> The default height for buttons - - ---- -## Properties -### views : table<[`string`](../../API/builtins/string.md), [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)> -> Table of views, which got registered via the "id" property -> View id is the table key, the table's value is the view's object. -> -> #### examples: -> ```lua -> vb:text { id="my_view", text="some_text"} -> vb.views.my_view.visible = false -> --or -> vb.views["my_view"].visible = false -> ``` - - - ---- -## Functions -### column([*self*](../../API/builtins/self.md), properties : [`RackViewProperties`](#rackviewproperties)) -> You can add nested child views when constructing a column or row -> by including them in the constructor table in the views property. -> -> #### examples: -> ```lua -> vb:column { -> margin = 1, -> views = { -> vb:text { -> text = "Text1" -> }, -> vb:text { -> text = "Text2" -> } -> } -> } -> ``` -### row([*self*](../../API/builtins/self.md), properties : [`RackViewProperties`](#rackviewproperties)) -> You can add nested child views when constructing a column or row -> by including them in the constructor table in the views property. -> -> #### examples: -> ```lua -> vb:column { -> margin = 1, -> views = { -> vb:text { -> text = "Text1" -> }, -> vb:text { -> text = "Text2" -> } -> } -> } -> ``` -### horizontal_aligner([*self*](../../API/builtins/self.md), properties : [`AlignerViewProperties`](#alignerviewproperties)) -> You can add nested child views when constructing aligners by including them -> in the constructor table. -> -> #### examples: -> ```lua -> vb:horizontal_aligner { -> mode = "center", -> views = { -> vb:text { -> text = "Text1" -> }, -> vb:text { -> text = "Text2" -> } -> } -> } -> ``` -### vertical_aligner([*self*](../../API/builtins/self.md), properties : [`AlignerViewProperties`](#alignerviewproperties)) -> You can add nested child views when constructing aligners by including them -> in the constructor table. -> -> #### examples: -> ```lua -> vb:horizontal_aligner { -> mode = "center", -> views = { -> vb:text { -> text = "Text1" -> }, -> vb:text { -> text = "Text2" -> } -> } -> } -> ``` -### stack([*self*](../../API/builtins/self.md), properties : [`StackViewProperties`](#stackviewproperties)[`?`](../../API/builtins/nil.md)) -`->`[`renoise.Views.Stack`](../../API/renoise/renoise.Views.Stack.md) - -> You can add nested child views when constructing stacks by including them -> in the constructor table. Use the view property `origin` to position them -> in the stack. -> -> ```lua -> --Stack multiple views -> vb:stack { -> views = { -> vb:text { -> origin = { 10, 10 }, -> text = "Text1" -> }, -> vb:text { -> origin = { 100, 20 }, -> text = "Text 2" -> } -> } -> } -> ``` -> See: `renoise.Views.Stack` -### space([*self*](../../API/builtins/self.md), properties : [`ViewProperties`](#viewproperties)) -> You can create an empty space in layouts with a space. -> -> #### examples: -> ```lua -> --Empty space in layouts -> vb:row { -> views = { -> vb:button { -> text = "Some Button" -> }, -> vb:space { -- extra spacing between buttons -> width = 8 -> }, -> vb:button { -> text = "Another Button" -> }, -> } -> } -> ``` -### canvas([*self*](../../API/builtins/self.md), properties : [`CanvasViewProperties`](#canvasviewproperties)[`?`](../../API/builtins/nil.md)) -`->`[`renoise.Views.Canvas`](../../API/renoise/renoise.Views.Canvas.md) - -> See: `renoise.Views.Canvas` -### text([*self*](../../API/builtins/self.md), properties : [`TextViewProperties`](#textviewproperties)[`?`](../../API/builtins/nil.md)) -`->`[`renoise.Views.Text`](../../API/renoise/renoise.Views.Text.md) - -> See: `renoise.Views.Text` -### multiline_text([*self*](../../API/builtins/self.md), properties : [`MultilineTextViewProperties`](#multilinetextviewproperties)[`?`](../../API/builtins/nil.md)) -`->`[`renoise.Views.MultiLineText`](../../API/renoise/renoise.Views.MultiLineText.md) - -> See: `renoise.Views.MultiLineText` -### textfield([*self*](../../API/builtins/self.md), properties : [`TextFieldProperties`](#textfieldproperties)[`?`](../../API/builtins/nil.md)) -`->`[`renoise.Views.TextField`](../../API/renoise/renoise.Views.TextField.md) - -> See: `renoise.Views.TextField` -### multiline_textfield([*self*](../../API/builtins/self.md), properties : [`MultilineTextFieldProperties`](#multilinetextfieldproperties)[`?`](../../API/builtins/nil.md)) -`->`[`renoise.Views.MultiLineTextField`](../../API/renoise/renoise.Views.MultiLineTextField.md) - -> See: `renoise.Views.MultiLineTextField` -### link([*self*](../../API/builtins/self.md), properties : [`TextLinkViewProperties`](#textlinkviewproperties)[`?`](../../API/builtins/nil.md)) -`->`[`renoise.Views.TextLink`](../../API/renoise/renoise.Views.TextLink.md) - -> See: `renoise.Views.TextLink` -### bitmap([*self*](../../API/builtins/self.md), properties : [`BitmapViewProperties`](#bitmapviewproperties)[`?`](../../API/builtins/nil.md)) -`->`[`renoise.Views.Bitmap`](../../API/renoise/renoise.Views.Bitmap.md) - -> See: `renoise.Views.Bitmap` -### button([*self*](../../API/builtins/self.md), properties : [`ButtonProperties`](#buttonproperties)[`?`](../../API/builtins/nil.md)) -`->`[`renoise.Views.Button`](../../API/renoise/renoise.Views.Button.md) - -> See: `renoise.Views.Button` -### checkbox([*self*](../../API/builtins/self.md), properties : [`CheckBoxProperties`](#checkboxproperties)[`?`](../../API/builtins/nil.md)) -`->`[`renoise.Views.CheckBox`](../../API/renoise/renoise.Views.CheckBox.md) - -> See: `renoise.Views.CheckBox` -### switch([*self*](../../API/builtins/self.md), properties : [`ButtonSwitchProperties`](#buttonswitchproperties)[`?`](../../API/builtins/nil.md)) -`->`[`renoise.Views.Switch`](../../API/renoise/renoise.Views.Switch.md) - -> See: `renoise.Views.Switch` -### popup([*self*](../../API/builtins/self.md), properties : [`PopUpMenuProperties`](#popupmenuproperties)[`?`](../../API/builtins/nil.md)) -`->`[`renoise.Views.Popup`](../../API/renoise/renoise.Views.Popup.md) - -> See: `renoise.Views.Popup` -### chooser([*self*](../../API/builtins/self.md), properties : [`ChooserProperties`](#chooserproperties)[`?`](../../API/builtins/nil.md)) -`->`[`renoise.Views.Chooser`](../../API/renoise/renoise.Views.Chooser.md) - -> See: `renoise.Views.Chooser` -### valuebox([*self*](../../API/builtins/self.md), properties : [`ValueBoxProperties`](#valueboxproperties)[`?`](../../API/builtins/nil.md)) -`->`[`renoise.Views.ValueBox`](../../API/renoise/renoise.Views.ValueBox.md) - -> See: `renoise.Views.ValueBox` -### value([*self*](../../API/builtins/self.md), properties : [`ValueViewProperties`](#valueviewproperties)[`?`](../../API/builtins/nil.md)) -`->`[`renoise.Views.Value`](../../API/renoise/renoise.Views.Value.md) - -> See: `renoise.Views.Value` -### valuefield([*self*](../../API/builtins/self.md), properties : [`ValueFieldProperties`](#valuefieldproperties)[`?`](../../API/builtins/nil.md)) -`->`[`renoise.Views.ValueField`](../../API/renoise/renoise.Views.ValueField.md) - -> See: `renoise.Views.ValueField` -### scrollbar([*self*](../../API/builtins/self.md), properties : [`ScrollBarProperties`](#scrollbarproperties)[`?`](../../API/builtins/nil.md)) -`->`[`renoise.Views.ScrollBar`](../../API/renoise/renoise.Views.ScrollBar.md) - -> See: `renoise.Views.ScrollBar` -### slider([*self*](../../API/builtins/self.md), properties : [`SliderProperties`](#sliderproperties)[`?`](../../API/builtins/nil.md)) -`->`[`renoise.Views.Slider`](../../API/renoise/renoise.Views.Slider.md) - -> See: `renoise.Views.Slider` -### minislider([*self*](../../API/builtins/self.md), properties : [`MiniSliderProperties`](#minisliderproperties)[`?`](../../API/builtins/nil.md)) -`->`[`renoise.Views.MiniSlider`](../../API/renoise/renoise.Views.MiniSlider.md) - -> See: `renoise.Views.MiniSlider` -### rotary([*self*](../../API/builtins/self.md), properties : [`RotaryEncoderProperties`](#rotaryencoderproperties)[`?`](../../API/builtins/nil.md)) -`->`[`renoise.Views.RotaryEncoder`](../../API/renoise/renoise.Views.RotaryEncoder.md) - -> See: `renoise.Views.RotaryEncoder` -### xypad([*self*](../../API/builtins/self.md), properties : [`XYPadProperties`](#xypadproperties)[`?`](../../API/builtins/nil.md)) -`->`[`renoise.Views.XYPad`](../../API/renoise/renoise.Views.XYPad.md) - -> See: `renoise.Views.XYPad` - - - ---- -## Structs -# AlignerViewProperties - ---- -## Properties -### margin : [`RackMargin`](#RackMargin)[`?`](../../API/builtins/nil.md) -> Set the "borders" of a rack (left, right, top and bottom inclusively) -> * Default: 0 (no borders) - -### spacing : [`RackSpacing`](#RackSpacing)[`?`](../../API/builtins/nil.md) -> Set the amount stacked child views are separated by (horizontally in -> rows, vertically in columns). -> * Default: 0 (no spacing) - -### mode : [`AlignerMode`](#AlignerMode)[`?`](../../API/builtins/nil.md) -> * Default: "left" (for horizontal_aligner) "top" (for vertical_aligner) - -### background : [`ViewBackgroundStyle`](#ViewBackgroundStyle)[`?`](../../API/builtins/nil.md) -> Setup a background style for the view. - -### mouse_handler : [`MouseHandler`](#MouseHandler)[`?`](../../API/builtins/nil.md) -> Optional mouse event handler for a view. return nil when the event got handled -> to stop propagating the event. return the event instance, as passed, to pass it -> to the next view in the view hirarchy. - -### mouse_events : [`MouseEventTypes`](#MouseEventTypes)[`?`](../../API/builtins/nil.md) -> The mouse event types that should be passed to your `mouse_handler` function. -> By default: `{ "down", "up", "double" }` -> Avoid adding event types that you don't use, especially "move" events as they do -> create quite some overhead. Also note that when enabling "drag", sub view controls -> can no longer handle drag events, even when you pass back the event in the handler, -> so only enable it when you want to completely override mouse drag behavior of -> *all* your content views. - -### views : [`AlignerChildViews`](#AlignerChildViews)[`?`](../../API/builtins/nil.md) -> The aligner view's initial child views. -> Views can later on also be added and removed dynamically after construction via -> `aligner:add_view(child)` and `aligner:remove_view(child)` - -### id : [`ViewId`](#ViewId)[`?`](../../API/builtins/nil.md) -> Unique identifier to resolve the view later on in the viewbuilder, -> e.g. `vb.views.SomeString` or `vb.views["Some String"]` -> View ids must be unique within a single view builder instance. - -### visible : [`ViewVisibility`](#ViewVisibility)[`?`](../../API/builtins/nil.md) -> Set visible to false to hide a view (make it invisible without removing -> it). Please note that view.visible will also return false when any of its -> parents are invisible (when its implicitly invisible). -> * Default: true - -### origin : [`ViewOrigin`](#ViewOrigin)[`?`](../../API/builtins/nil.md) -> The position of a view within its parent view. -> Only the `stack` layouts allows to freely position child views. Other -> layout views will automatically set the origin, but the origin -> then still can be read in for example mouse handlers. - -### width : [`ViewDimension`](#ViewDimension)[`?`](../../API/builtins/nil.md) -> **Deprecated.** Use property `size` instead. - -### height : [`ViewDimension`](#ViewDimension)[`?`](../../API/builtins/nil.md) -> **Deprecated.** Use property `size` instead. - -### size : [`ViewSize`](#ViewSize)[`?`](../../API/builtins/nil.md) -> The dimensions of a view has to be larger than 0. -> For nested views you can also specify relative size, for example -> `vb:text { size = { width = "80%", height = 20}}`. -> The percentage values are relative to the view's parent size and will -> automatically update when the parent view's size changes. - -### tooltip : [`ViewTooltip`](#ViewTooltip)[`?`](../../API/builtins/nil.md) -> A ViewTooltip text that should be shown for this view on mouse hover. -> * Default: "" (no tip will be shown) - -### cursor : [`ViewCursorShape`](#ViewCursorShape)[`?`](../../API/builtins/nil.md) -> The cursor cursor for this view which apears on mouse hover. -> Using a "none" shape will use use underlying view's cursor or the default cursor. - - - - - ---- -## Aliases -### AlignerChildViews -[`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)[] -> The aligner view's initial child views. -> Views can later on also be added and removed dynamically after construction via -> `aligner:add_view(child)` and `aligner:remove_view(child)` - -### AlignerMode -`"bottom"` | `"center"` | `"distribute"` | `"justify"` | `"left"` | `"right"` | `"top"` -> ```lua -> -- * Default: "left" (for horizontal_aligner) "top" (for vertical_aligner) -> AlignerMode: -> | "left" -- align from left to right (for horizontal_aligner only) -> | "right" -- align from right to left (for horizontal_aligner only) -> | "top" -- align from top to bottom (for vertical_aligner only) -> | "bottom" -- align from bottom to top (for vertical_aligner only) -> | "center" -- center all views -> | "justify" -- keep outer views at the borders, distribute the rest -> | "distribute" -- equally distributes views over the aligners width/height -> ``` - -### MouseEventButton -`"left"` | `"middle"` | `"right"` -> ```lua -> -- Mouse button of a `MouseEvent` of type "up"|"down"|"double"|"drag". -> MouseEventButton: -> | "left" -> | "right" -> | "middle" -> ``` - -### MouseEventType -`"double"` | `"down"` | `"drag"` | `"enter"` | `"exit"` | `"move"` | `"up"` | `"wheel"` -> ```lua -> -- Event type of a `MouseEvent`. -> MouseEventType: -> | "enter" -> | "exit" -> | "move" -> | "down" -> | "up" -> | "double" -> | "drag" -> | "wheel" -> ``` - -### MouseEventTypes -[`MouseEventType`](#MouseEventType)[] -> The mouse event types that should be passed to your `mouse_handler` function. -> By default: `{ "down", "up", "double" }` -> Avoid adding event types that you don't use, especially "move" events as they do -> create quite some overhead. Also note that when enabling "drag", sub view controls -> can no longer handle drag events, even when you pass back the event in the handler, -> so only enable it when you want to completely override mouse drag behavior of -> *all* your content views. - -### MouseEventWheelDirection -`"down"` | `"left"` | `"right"` | `"up"` -> ```lua -> -- Mouse wheel direction in a `MouseEvent` of type "wheel". -> MouseEventWheelDirection: -> | "up" -> | "down" -> | "left" -> | "right" -> ``` - -### MouseHandler -[`MouseHandlerNotifierFunction`](#MouseHandlerNotifierFunction) | [`MouseHandlerNotifierMethod1`](#MouseHandlerNotifierMethod1) | [`MouseHandlerNotifierMethod2`](#MouseHandlerNotifierMethod2) -> Optional mouse event handler for a view. return nil when the event got handled -> to stop propagating the event. return the event instance, as passed, to pass it -> to the next view in the view hirarchy. - -### MouseHandlerNotifierFunction -(event : [`MouseEvent`](#mouseevent)) `->` [`MouseEvent`](#mouseevent)[`?`](../../API/builtins/nil.md) - - -### MouseHandlerNotifierMemberFunction -(self : [`NotifierMemberContext`](#NotifierMemberContext), event : [`MouseEvent`](#mouseevent)) `->` [`MouseEvent`](#mouseevent)[`?`](../../API/builtins/nil.md) - - -### MouseHandlerNotifierMethod1 -{ 1 : [`NotifierMemberContext`](#NotifierMemberContext), 2 : [`MouseHandlerNotifierMemberFunction`](#MouseHandlerNotifierMemberFunction) } - - -### MouseHandlerNotifierMethod2 -{ 1 : [`MouseHandlerNotifierMemberFunction`](#MouseHandlerNotifierMemberFunction), 2 : [`NotifierMemberContext`](#NotifierMemberContext) } - - -### NotifierMemberContext -[`table`](../../API/builtins/table.md) | [`userdata`](../../API/builtins/userdata.md) - - -### RackMargin -[`integer`](../../API/builtins/integer.md) -> Set the "borders" of a rack (left, right, top and bottom inclusively) -> * Default: 0 (no borders) - -### RackSpacing -[`integer`](../../API/builtins/integer.md) -> Set the amount stacked child views are separated by (horizontally in -> rows, vertically in columns). -> * Default: 0 (no spacing) - -### ViewBackgroundStyle -`"body"` | `"border"` | `"group"` | `"invisible"` | `"panel"` | `"plain"` -> ```lua -> -- Setup a background style for the view. -> ViewBackgroundStyle: -> | "invisible" -- no background (Default) -> | "plain" -- undecorated, single coloured background -> | "border" -- same as plain, but with a bold nested border -> | "body" -- main "background" style, as used in dialog backgrounds -> | "panel" -- alternative "background" style, beveled -> | "group" -- background for "nested" groups within body -> ``` - -### ViewCursorShape -`"busy"` | `"change_value"` | `"crosshair"` | `"default"` | `"drag"` | `"drop"` | `"edit_text"` | `"empty"` | `"erase"` | `"extend_bottom"` | `"extend_bottom_alias"` | `"extend_left"` | `"extend_left_alias"` | `"extend_right"` | `"extend_right_alias"` | `"extend_top"` | `"extend_top_alias"` | `"marker"` | `"move"` | `"nodrop"` | `"none"` | `"pencil"` | `"play"` | `"resize_edge_diagonal_left"` | `"resize_edge_diagonal_right"` | `"resize_edge_horizontal"` | `"resize_edge_vertical"` | `"resize_horizontal"` | `"resize_vertical"` | `"zoom"` | `"zoom_horizontal"` | `"zoom_vertical"` -> ```lua -> -- The cursor cursor for this view which apears on mouse hover. -> -- Using a "none" shape will use use underlying view's cursor or the default cursor. -> ViewCursorShape: -> | "none" -> | "empty" -> | "default" -> | "change_value" -> | "edit_text" -> | "pencil" -> | "marker" -> | "crosshair" -> | "move" -> | "erase" -> | "play" -> | "drag" -> | "drop" -> | "nodrop" -> | "busy" -> | "resize_vertical" -> | "resize_horizontal" -> | "resize_edge_vertical" -> | "resize_edge_horizontal" -> | "resize_edge_diagonal_left" -> | "resize_edge_diagonal_right" -> | "extend_left" -> | "extend_right" -> | "extend_top" -> | "extend_bottom" -> | "extend_left_alias" -> | "extend_right_alias" -> | "extend_top_alias" -> | "extend_bottom_alias" -> | "zoom_vertical" -> | "zoom_horizontal" -> | "zoom" -> ``` - -### ViewDimension -[`string`](../../API/builtins/string.md) | [`integer`](../../API/builtins/integer.md) -> The dimensions of a view has to be larger than 0. -> For nested views you can also specify relative size -> for example `vb:text { width = "80%"}`. The percentage values are -> relative to the view's parent size and will automatically update on size changes. - -### ViewId -[`string`](../../API/builtins/string.md) -> Unique identifier to resolve the view later on in the viewbuilder, -> e.g. `vb.views.SomeString` or `vb.views["Some String"]` -> View ids must be unique within a single view builder instance. - -### ViewOrigin -{ 1 : [`ViewPosition`](#ViewPosition), 2 : [`ViewPosition`](#ViewPosition) } | { x : [`ViewPosition`](#ViewPosition), y : [`ViewPosition`](#ViewPosition) } -> The position of a view within its parent view. -> Only the `stack` layouts allows to freely position child views. Other -> layout views will automatically set the origin, but the origin -> then still can be read in for example mouse handlers. - -### ViewPosition -[`integer`](../../API/builtins/integer.md) -> Horizontal (x) or Vertical (y) position of a view within its parent view. - -### ViewSize -{ 1 : [`ViewDimension`](#ViewDimension), 2 : [`ViewDimension`](#ViewDimension) } | { height : [`ViewDimension`](#ViewDimension), width : [`ViewDimension`](#ViewDimension) } -> The dimensions of a view has to be larger than 0. -> For nested views you can also specify relative size, for example -> `vb:text { size = { width = "80%", height = 20}}`. -> The percentage values are relative to the view's parent size and will -> automatically update when the parent view's size changes. - -### ViewTooltip -[`string`](../../API/builtins/string.md) -> A ViewTooltip text that should be shown for this view on mouse hover. -> * Default: "" (no tip will be shown) - -### ViewVisibility -[`boolean`](../../API/builtins/boolean.md) -> Set visible to false to hide a view (make it invisible without removing -> it). Please note that view.visible will also return false when any of its -> parents are invisible (when its implicitly invisible). -> * Default: true - - - -# BitmapViewProperties - ---- -## Properties -### mode : [`BitmapMode`](#BitmapMode)[`?`](../../API/builtins/nil.md) -> Setup how the bitmap should be drawn, recolored. Available modes are: - -### color : [`BitmapColor`](#BitmapColor)[`?`](../../API/builtins/nil.md) -> When set, the bitmap will be drawn in the specified color and `mode` is set -> to `custom_color`. Set `mode` to something else than `custom_color` or the -> `color` to `{0, 0, 0}` to enable a `plain` display mode. - -### bitmap : [`BitmapPath`](#BitmapPath)[`?`](../../API/builtins/nil.md) -> Supported bitmap file formats are *.bmp, *.png or *.tif (no transparency). - -### notifier : [`ButtonNotifier`](#ButtonNotifier)[`?`](../../API/builtins/nil.md) -> A click notifier - -### active : [`ControlActive`](#ControlActive)[`?`](../../API/builtins/nil.md) -> Instead of making a control invisible, you can also make it inactive. -> Deactivated controls will still be shown, and will still show their -> currently assigned values, but will not allow changes. Most controls will -> display as "grayed out" to visualize the deactivated state. - -### midi_mapping : [`ControlMidiMappingString`](#ControlMidiMappingString)[`?`](../../API/builtins/nil.md) -> When set, the control will be highlighted when Renoise's MIDI mapping dialog -> is open. When clicked, it selects the specified string as a MIDI mapping -> target action. This target acton can either be one of the globally available -> mappings in Renoise, or those that were created by the tool itself. -> Target strings are not verified. When they point to nothing, the mapped MIDI -> message will do nothing and no error is fired. - -### id : [`ViewId`](#ViewId)[`?`](../../API/builtins/nil.md) -> Unique identifier to resolve the view later on in the viewbuilder, -> e.g. `vb.views.SomeString` or `vb.views["Some String"]` -> View ids must be unique within a single view builder instance. - -### visible : [`ViewVisibility`](#ViewVisibility)[`?`](../../API/builtins/nil.md) -> Set visible to false to hide a view (make it invisible without removing -> it). Please note that view.visible will also return false when any of its -> parents are invisible (when its implicitly invisible). -> * Default: true - -### origin : [`ViewOrigin`](#ViewOrigin)[`?`](../../API/builtins/nil.md) -> The position of a view within its parent view. -> Only the `stack` layouts allows to freely position child views. Other -> layout views will automatically set the origin, but the origin -> then still can be read in for example mouse handlers. - -### width : [`ViewDimension`](#ViewDimension)[`?`](../../API/builtins/nil.md) -> **Deprecated.** Use property `size` instead. - -### height : [`ViewDimension`](#ViewDimension)[`?`](../../API/builtins/nil.md) -> **Deprecated.** Use property `size` instead. - -### size : [`ViewSize`](#ViewSize)[`?`](../../API/builtins/nil.md) -> The dimensions of a view has to be larger than 0. -> For nested views you can also specify relative size, for example -> `vb:text { size = { width = "80%", height = 20}}`. -> The percentage values are relative to the view's parent size and will -> automatically update when the parent view's size changes. - -### tooltip : [`ViewTooltip`](#ViewTooltip)[`?`](../../API/builtins/nil.md) -> A ViewTooltip text that should be shown for this view on mouse hover. -> * Default: "" (no tip will be shown) - -### cursor : [`ViewCursorShape`](#ViewCursorShape)[`?`](../../API/builtins/nil.md) -> The cursor cursor for this view which apears on mouse hover. -> Using a "none" shape will use use underlying view's cursor or the default cursor. - - - - - ---- -## Aliases -### BitmapColor -[`RGBColor`](#RGBColor) | [`ThemeColor`](#ThemeColor) -> ```lua -> -- When set, the bitmap will be drawn in the specified color and `mode` is set -> -- to `custom_color`. Set `mode` to something else than `custom_color` or the -> -- `color` to `{0, 0, 0}` to enable a `plain` display mode. -> -- A table of 3 bytes (ranging from 0 to 255) -> -- representing the red, green and blue channels of a color. -> -- {0xFF, 0xFF, 0xFF} is white -> -- {165, 73, 35} is the red from the Renoise logo -> -- The application theme's colors -> BitmapColor: -> | "main_back" -> | "main_font" -> | "alternate_main_back" -> | "alternate_main_font" -> | "body_back" -> | "body_font" -> | "strong_body_font" -> | "button_back" -> | "button_font" -> | "button_highlight_font" -> | "selected_button_back" -> | "selected_button_font" -> | "selection_back" -> | "selection_font" -> | "standby_selection_back" -> | "standby_selection_font" -> | "midi_mapping_back" -> | "midi_mapping_font" -> | "tooltip_back" -> | "tooltip_font" -> | "valuebox_back" -> | "valuebox_font" -> | "valuebox_font_icons" -> | "scrollbar" -> | "slider" -> | "folder" -> | "pattern_default_back" -> | "pattern_default_font" -> | "pattern_default_font_volume" -> | "pattern_default_font_panning" -> | "pattern_default_font_pitch" -> | "pattern_default_font_delay" -> | "pattern_default_font_global" -> | "pattern_default_font_other" -> | "pattern_default_font_dspfx" -> | "pattern_default_font_unused" -> | "pattern_highlighted_back" -> | "pattern_highlighted_font" -> | "pattern_highlighted_font_volume" -> | "pattern_highlighted_font_panning" -> | "pattern_highlighted_font_pitch" -> | "pattern_highlighted_font_delay" -> | "pattern_highlighted_font_global" -> | "pattern_highlighted_font_other" -> | "pattern_highlighted_font_dspfx" -> | "pattern_highlighted_font_unused" -> | "pattern_playposition_back" -> | "pattern_playposition_font" -> | "pattern_centerbar_back" -> | "pattern_centerbar_font" -> | "pattern_centerbar_back_standby" -> | "pattern_centerbar_font_standby" -> | "pattern_selection" -> | "pattern_standby_selection" -> | "pattern_mute_state" -> | "automation_grid" -> | "automation_line_edge" -> | "automation_line_fill" -> | "automation_point" -> | "automation_marker_play" -> | "automation_marker_single" -> | "automation_marker_pair" -> | "automation_marker_diamond" -> | "vumeter_meter" -> | "vumeter_meter_low" -> | "vumeter_meter_middle" -> | "vumeter_meter_high" -> | "vumeter_peak" -> | "vumeter_back_normal" -> | "vumeter_back_clipped" -> | "default_color_01" -> | "default_color_02" -> | "default_color_03" -> | "default_color_04" -> | "default_color_05" -> | "default_color_06" -> | "default_color_07" -> | "default_color_08" -> | "default_color_09" -> | "default_color_10" -> | "default_color_11" -> | "default_color_12" -> | "default_color_13" -> | "default_color_14" -> | "default_color_15" -> | "default_color_16" -> ``` - -### BitmapImagePath -[`string`](../../API/builtins/string.md) -> You can load an image from your tool's directory, -> or use one from Renoise's built-in icons. -> * For the built-in icons, use "Icons/ArrowRight.bmp" -> * For custom images, use a path relative to your tool's root folder. -> -> For example "Images/MyBitmap.bmp" will load the image from -> "com.me.MyTool.xrnx/Images/MyBitmap.bmp". -> If your custom path matches a built-in icon's (like "Icons/ArrowRight.bmp"), -> your image will be loaded instead of the one from Renoise. -> -> If you want to support high DPI UI scaling with your bitmaps like the -> built-in Icons, include high resolution versions with their filenames ending -> with "@4x" -> The following rules will be used when loading bitmaps -> * When UI scaling is 100%, only the base bitmaps are used. -> * When UI scaling is 125%, the base bitmaps are used, except if there is a -> ` BitmapName@x1.25.bmp` variant. -> * For all other UI scaling > 125% the "@4x" variants are used and -> downscaled as needed, except when there is an exact match for the current -> UI scaling factor (e.g. `BitmapName@1.5x.bmp` for 150%) - -### BitmapMode -`"body_color"` | `"button_color"` | `"custom_color"` | `"main_color"` | `"plain"` | `"transparent"` -> ```lua -> -- Setup how the bitmap should be drawn, recolored. Available modes are: -> BitmapMode: -> | "plain" -- bitmap is drawn as is, no recoloring is done (Default) -> | "transparent" -- same as plain, but black pixels will be fully transparent -> | "button_color" -- recolor the bitmap, using the theme's button color -> | "body_color" -- same as 'button_back' but with body text/back color -> | "main_color" -- same as 'button_back' but with main text/back colors -> | "custom_color" -- Recolor the bitmap using a custom color set by the `color' -> ``` - -### BitmapPath -[`BitmapImagePath`](#BitmapImagePath) -> Supported bitmap file formats are *.bmp, *.png or *.tif (no transparency). - -### ButtonNotifier -[`NotifierFunction`](#NotifierFunction) | [`NotifierMethod1`](#NotifierMethod1) | [`NotifierMethod2`](#NotifierMethod2) -> A click notifier - -### ControlActive -[`boolean`](../../API/builtins/boolean.md) -> Instead of making a control invisible, you can also make it inactive. -> Deactivated controls will still be shown, and will still show their -> currently assigned values, but will not allow changes. Most controls will -> display as "grayed out" to visualize the deactivated state. - -### ControlMidiMappingString -[`string`](../../API/builtins/string.md) -> When set, the control will be highlighted when Renoise's MIDI mapping dialog -> is open. When clicked, it selects the specified string as a MIDI mapping -> target action. This target acton can either be one of the globally available -> mappings in Renoise, or those that were created by the tool itself. -> Target strings are not verified. When they point to nothing, the mapped MIDI -> message will do nothing and no error is fired. - -### NotifierFunction -fun() - - -### NotifierMemberContext -[`table`](../../API/builtins/table.md) | [`userdata`](../../API/builtins/userdata.md) - - -### NotifierMemberFunction -(self : [`NotifierMemberContext`](#NotifierMemberContext)) - - -### NotifierMethod1 -{ 1 : [`NotifierMemberContext`](#NotifierMemberContext), 2 : [`NotifierMemberFunction`](#NotifierMemberFunction) } - - -### NotifierMethod2 -{ 1 : [`NotifierMemberFunction`](#NotifierMemberFunction), 2 : [`NotifierMemberContext`](#NotifierMemberContext) } - - -### RGBColor -{ 1 : [`integer`](../../API/builtins/integer.md), 2 : [`integer`](../../API/builtins/integer.md), 3 : [`integer`](../../API/builtins/integer.md) } -> A table of 3 bytes (ranging from 0 to 255) -> representing the red, green and blue channels of a color. -> {0xFF, 0xFF, 0xFF} is white -> {165, 73, 35} is the red from the Renoise logo - -### ThemeColor -`"alternate_main_back"` | `"alternate_main_font"` | `"automation_grid"` | `"automation_line_edge"` | `"automation_line_fill"` | `"automation_marker_diamond"` | `"automation_marker_pair"` | `"automation_marker_play"` | `"automation_marker_single"` | `"automation_point"` | `"body_back"` | `"body_font"` | `"button_back"` | `"button_font"` | `"button_highlight_font"` | `"default_color_01"` | `"default_color_02"` | `"default_color_03"` | `"default_color_04"` | `"default_color_05"` | `"default_color_06"` | `"default_color_07"` | `"default_color_08"` | `"default_color_09"` | `"default_color_10"` | `"default_color_11"` | `"default_color_12"` | `"default_color_13"` | `"default_color_14"` | `"default_color_15"` | `"default_color_16"` | `"folder"` | `"main_back"` | `"main_font"` | `"midi_mapping_back"` | `"midi_mapping_font"` | `"pattern_centerbar_back"` | `"pattern_centerbar_back_standby"` | `"pattern_centerbar_font"` | `"pattern_centerbar_font_standby"` | `"pattern_default_back"` | `"pattern_default_font"` | `"pattern_default_font_delay"` | `"pattern_default_font_dspfx"` | `"pattern_default_font_global"` | `"pattern_default_font_other"` | `"pattern_default_font_panning"` | `"pattern_default_font_pitch"` | `"pattern_default_font_unused"` | `"pattern_default_font_volume"` | `"pattern_highlighted_back"` | `"pattern_highlighted_font"` | `"pattern_highlighted_font_delay"` | `"pattern_highlighted_font_dspfx"` | `"pattern_highlighted_font_global"` | `"pattern_highlighted_font_other"` | `"pattern_highlighted_font_panning"` | `"pattern_highlighted_font_pitch"` | `"pattern_highlighted_font_unused"` | `"pattern_highlighted_font_volume"` | `"pattern_mute_state"` | `"pattern_playposition_back"` | `"pattern_playposition_font"` | `"pattern_selection"` | `"pattern_standby_selection"` | `"scrollbar"` | `"selected_button_back"` | `"selected_button_font"` | `"selection_back"` | `"selection_font"` | `"slider"` | `"standby_selection_back"` | `"standby_selection_font"` | `"strong_body_font"` | `"tooltip_back"` | `"tooltip_font"` | `"valuebox_back"` | `"valuebox_font"` | `"valuebox_font_icons"` | `"vumeter_back_clipped"` | `"vumeter_back_normal"` | `"vumeter_meter"` | `"vumeter_meter_high"` | `"vumeter_meter_low"` | `"vumeter_meter_middle"` | `"vumeter_peak"` -> ```lua -> -- The application theme's colors -> ThemeColor: -> | "main_back" -> | "main_font" -> | "alternate_main_back" -> | "alternate_main_font" -> | "body_back" -> | "body_font" -> | "strong_body_font" -> | "button_back" -> | "button_font" -> | "button_highlight_font" -> | "selected_button_back" -> | "selected_button_font" -> | "selection_back" -> | "selection_font" -> | "standby_selection_back" -> | "standby_selection_font" -> | "midi_mapping_back" -> | "midi_mapping_font" -> | "tooltip_back" -> | "tooltip_font" -> | "valuebox_back" -> | "valuebox_font" -> | "valuebox_font_icons" -> | "scrollbar" -> | "slider" -> | "folder" -> | "pattern_default_back" -> | "pattern_default_font" -> | "pattern_default_font_volume" -> | "pattern_default_font_panning" -> | "pattern_default_font_pitch" -> | "pattern_default_font_delay" -> | "pattern_default_font_global" -> | "pattern_default_font_other" -> | "pattern_default_font_dspfx" -> | "pattern_default_font_unused" -> | "pattern_highlighted_back" -> | "pattern_highlighted_font" -> | "pattern_highlighted_font_volume" -> | "pattern_highlighted_font_panning" -> | "pattern_highlighted_font_pitch" -> | "pattern_highlighted_font_delay" -> | "pattern_highlighted_font_global" -> | "pattern_highlighted_font_other" -> | "pattern_highlighted_font_dspfx" -> | "pattern_highlighted_font_unused" -> | "pattern_playposition_back" -> | "pattern_playposition_font" -> | "pattern_centerbar_back" -> | "pattern_centerbar_font" -> | "pattern_centerbar_back_standby" -> | "pattern_centerbar_font_standby" -> | "pattern_selection" -> | "pattern_standby_selection" -> | "pattern_mute_state" -> | "automation_grid" -> | "automation_line_edge" -> | "automation_line_fill" -> | "automation_point" -> | "automation_marker_play" -> | "automation_marker_single" -> | "automation_marker_pair" -> | "automation_marker_diamond" -> | "vumeter_meter" -> | "vumeter_meter_low" -> | "vumeter_meter_middle" -> | "vumeter_meter_high" -> | "vumeter_peak" -> | "vumeter_back_normal" -> | "vumeter_back_clipped" -> | "default_color_01" -> | "default_color_02" -> | "default_color_03" -> | "default_color_04" -> | "default_color_05" -> | "default_color_06" -> | "default_color_07" -> | "default_color_08" -> | "default_color_09" -> | "default_color_10" -> | "default_color_11" -> | "default_color_12" -> | "default_color_13" -> | "default_color_14" -> | "default_color_15" -> | "default_color_16" -> ``` - -### ViewCursorShape -`"busy"` | `"change_value"` | `"crosshair"` | `"default"` | `"drag"` | `"drop"` | `"edit_text"` | `"empty"` | `"erase"` | `"extend_bottom"` | `"extend_bottom_alias"` | `"extend_left"` | `"extend_left_alias"` | `"extend_right"` | `"extend_right_alias"` | `"extend_top"` | `"extend_top_alias"` | `"marker"` | `"move"` | `"nodrop"` | `"none"` | `"pencil"` | `"play"` | `"resize_edge_diagonal_left"` | `"resize_edge_diagonal_right"` | `"resize_edge_horizontal"` | `"resize_edge_vertical"` | `"resize_horizontal"` | `"resize_vertical"` | `"zoom"` | `"zoom_horizontal"` | `"zoom_vertical"` -> ```lua -> -- The cursor cursor for this view which apears on mouse hover. -> -- Using a "none" shape will use use underlying view's cursor or the default cursor. -> ViewCursorShape: -> | "none" -> | "empty" -> | "default" -> | "change_value" -> | "edit_text" -> | "pencil" -> | "marker" -> | "crosshair" -> | "move" -> | "erase" -> | "play" -> | "drag" -> | "drop" -> | "nodrop" -> | "busy" -> | "resize_vertical" -> | "resize_horizontal" -> | "resize_edge_vertical" -> | "resize_edge_horizontal" -> | "resize_edge_diagonal_left" -> | "resize_edge_diagonal_right" -> | "extend_left" -> | "extend_right" -> | "extend_top" -> | "extend_bottom" -> | "extend_left_alias" -> | "extend_right_alias" -> | "extend_top_alias" -> | "extend_bottom_alias" -> | "zoom_vertical" -> | "zoom_horizontal" -> | "zoom" -> ``` - -### ViewDimension -[`string`](../../API/builtins/string.md) | [`integer`](../../API/builtins/integer.md) -> The dimensions of a view has to be larger than 0. -> For nested views you can also specify relative size -> for example `vb:text { width = "80%"}`. The percentage values are -> relative to the view's parent size and will automatically update on size changes. - -### ViewId -[`string`](../../API/builtins/string.md) -> Unique identifier to resolve the view later on in the viewbuilder, -> e.g. `vb.views.SomeString` or `vb.views["Some String"]` -> View ids must be unique within a single view builder instance. - -### ViewOrigin -{ 1 : [`ViewPosition`](#ViewPosition), 2 : [`ViewPosition`](#ViewPosition) } | { x : [`ViewPosition`](#ViewPosition), y : [`ViewPosition`](#ViewPosition) } -> The position of a view within its parent view. -> Only the `stack` layouts allows to freely position child views. Other -> layout views will automatically set the origin, but the origin -> then still can be read in for example mouse handlers. - -### ViewPosition -[`integer`](../../API/builtins/integer.md) -> Horizontal (x) or Vertical (y) position of a view within its parent view. - -### ViewSize -{ 1 : [`ViewDimension`](#ViewDimension), 2 : [`ViewDimension`](#ViewDimension) } | { height : [`ViewDimension`](#ViewDimension), width : [`ViewDimension`](#ViewDimension) } -> The dimensions of a view has to be larger than 0. -> For nested views you can also specify relative size, for example -> `vb:text { size = { width = "80%", height = 20}}`. -> The percentage values are relative to the view's parent size and will -> automatically update when the parent view's size changes. - -### ViewTooltip -[`string`](../../API/builtins/string.md) -> A ViewTooltip text that should be shown for this view on mouse hover. -> * Default: "" (no tip will be shown) - -### ViewVisibility -[`boolean`](../../API/builtins/boolean.md) -> Set visible to false to hide a view (make it invisible without removing -> it). Please note that view.visible will also return false when any of its -> parents are invisible (when its implicitly invisible). -> * Default: true - - - -# ButtonProperties - ---- -## Properties -### text : [`ButtonLabel`](#ButtonLabel)[`?`](../../API/builtins/nil.md) -> The text label of the button -> * Default: "" - -### bitmap : [`ButtonBitmapPath`](#ButtonBitmapPath)[`?`](../../API/builtins/nil.md) -> If set, existing text is removed and the loaded image is displayed instead. -> Supported bitmap file formats are ".bmp", ".png" and ".tiff". -> Colors in bitmaps will be overridden by the button's theme color, using black -> as the transparent color for BMPs and TIFFS, and the alpha channel for PNGs. -> All other colors are mapped to the theme color according to their grey value, -> so plain white is the target theme color, and all other colors blend into the -> button's background color of the theme. - -### align : [`ButtonAlignment`](#ButtonAlignment)[`?`](../../API/builtins/nil.md) -> Setup the buttons text's or bitmap's alignment within the button. - -### font : [`TextFontStyle`](#TextFontStyle)[`?`](../../API/builtins/nil.md) -> The style that the text should be displayed with. - -### color : [`ButtonColor`](#ButtonColor)[`?`](../../API/builtins/nil.md) -> When set, the unpressed button's background will be drawn in the specified color. -> A text color is automatically selected unless explicitly set, to make sure its -> always visible. -> Set color {0,0,0} to enable the theme colors for the button again. - -### secondary_color : [`ButtonColor`](#ButtonColor)[`?`](../../API/builtins/nil.md) -> When set, the unpressed button's background will be drawn in the specified color. -> A text color is automatically selected unless explicitly set, to make sure its -> always visible. -> Set color {0,0,0} to enable the theme colors for the button again. - -### style : [`ButtonStyle`](#ButtonStyle)[`?`](../../API/builtins/nil.md) -> Get/set the style a button should be displayed with. - -### notifier : [`ButtonNotifier`](#ButtonNotifier)[`?`](../../API/builtins/nil.md) -> A click notifier - -### pressed : [`ButtonNotifier`](#ButtonNotifier)[`?`](../../API/builtins/nil.md) -> A click notifier - -### released : [`ButtonNotifier`](#ButtonNotifier)[`?`](../../API/builtins/nil.md) -> A click notifier - -### active : [`ControlActive`](#ControlActive)[`?`](../../API/builtins/nil.md) -> Instead of making a control invisible, you can also make it inactive. -> Deactivated controls will still be shown, and will still show their -> currently assigned values, but will not allow changes. Most controls will -> display as "grayed out" to visualize the deactivated state. - -### midi_mapping : [`ControlMidiMappingString`](#ControlMidiMappingString)[`?`](../../API/builtins/nil.md) -> When set, the control will be highlighted when Renoise's MIDI mapping dialog -> is open. When clicked, it selects the specified string as a MIDI mapping -> target action. This target acton can either be one of the globally available -> mappings in Renoise, or those that were created by the tool itself. -> Target strings are not verified. When they point to nothing, the mapped MIDI -> message will do nothing and no error is fired. - -### id : [`ViewId`](#ViewId)[`?`](../../API/builtins/nil.md) -> Unique identifier to resolve the view later on in the viewbuilder, -> e.g. `vb.views.SomeString` or `vb.views["Some String"]` -> View ids must be unique within a single view builder instance. - -### visible : [`ViewVisibility`](#ViewVisibility)[`?`](../../API/builtins/nil.md) -> Set visible to false to hide a view (make it invisible without removing -> it). Please note that view.visible will also return false when any of its -> parents are invisible (when its implicitly invisible). -> * Default: true - -### origin : [`ViewOrigin`](#ViewOrigin)[`?`](../../API/builtins/nil.md) -> The position of a view within its parent view. -> Only the `stack` layouts allows to freely position child views. Other -> layout views will automatically set the origin, but the origin -> then still can be read in for example mouse handlers. - -### width : [`ViewDimension`](#ViewDimension)[`?`](../../API/builtins/nil.md) -> **Deprecated.** Use property `size` instead. - -### height : [`ViewDimension`](#ViewDimension)[`?`](../../API/builtins/nil.md) -> **Deprecated.** Use property `size` instead. - -### size : [`ViewSize`](#ViewSize)[`?`](../../API/builtins/nil.md) -> The dimensions of a view has to be larger than 0. -> For nested views you can also specify relative size, for example -> `vb:text { size = { width = "80%", height = 20}}`. -> The percentage values are relative to the view's parent size and will -> automatically update when the parent view's size changes. - -### tooltip : [`ViewTooltip`](#ViewTooltip)[`?`](../../API/builtins/nil.md) -> A ViewTooltip text that should be shown for this view on mouse hover. -> * Default: "" (no tip will be shown) - -### cursor : [`ViewCursorShape`](#ViewCursorShape)[`?`](../../API/builtins/nil.md) -> The cursor cursor for this view which apears on mouse hover. -> Using a "none" shape will use use underlying view's cursor or the default cursor. - - - - - ---- -## Aliases -### BitmapImagePath -[`string`](../../API/builtins/string.md) -> You can load an image from your tool's directory, -> or use one from Renoise's built-in icons. -> * For the built-in icons, use "Icons/ArrowRight.bmp" -> * For custom images, use a path relative to your tool's root folder. -> -> For example "Images/MyBitmap.bmp" will load the image from -> "com.me.MyTool.xrnx/Images/MyBitmap.bmp". -> If your custom path matches a built-in icon's (like "Icons/ArrowRight.bmp"), -> your image will be loaded instead of the one from Renoise. -> -> If you want to support high DPI UI scaling with your bitmaps like the -> built-in Icons, include high resolution versions with their filenames ending -> with "@4x" -> The following rules will be used when loading bitmaps -> * When UI scaling is 100%, only the base bitmaps are used. -> * When UI scaling is 125%, the base bitmaps are used, except if there is a -> ` BitmapName@x1.25.bmp` variant. -> * For all other UI scaling > 125% the "@4x" variants are used and -> downscaled as needed, except when there is an exact match for the current -> UI scaling factor (e.g. `BitmapName@1.5x.bmp` for 150%) - -### ButtonAlignment -`"center"` | `"left"` | `"right"` -> ```lua -> -- Setup the buttons text's or bitmap's alignment within the button. -> ButtonAlignment: -> | "left" -- aligned to the left -> | "right" -- aligned to the right -> | "center" -- center (default) -> ``` - -### ButtonBitmapPath -[`BitmapImagePath`](#BitmapImagePath) -> If set, existing text is removed and the loaded image is displayed instead. -> Supported bitmap file formats are ".bmp", ".png" and ".tiff". -> Colors in bitmaps will be overridden by the button's theme color, using black -> as the transparent color for BMPs and TIFFS, and the alpha channel for PNGs. -> All other colors are mapped to the theme color according to their grey value, -> so plain white is the target theme color, and all other colors blend into the -> button's background color of the theme. - -### ButtonColor -[`RGBColor`](#RGBColor) | [`ThemeColor`](#ThemeColor) -> ```lua -> -- When set, the unpressed button's background will be drawn in the specified color. -> -- A text color is automatically selected unless explicitly set, to make sure its -> -- always visible. -> -- Set color {0,0,0} to enable the theme colors for the button again. -> -- A table of 3 bytes (ranging from 0 to 255) -> -- representing the red, green and blue channels of a color. -> -- {0xFF, 0xFF, 0xFF} is white -> -- {165, 73, 35} is the red from the Renoise logo -> -- The application theme's colors -> ButtonColor: -> | "main_back" -> | "main_font" -> | "alternate_main_back" -> | "alternate_main_font" -> | "body_back" -> | "body_font" -> | "strong_body_font" -> | "button_back" -> | "button_font" -> | "button_highlight_font" -> | "selected_button_back" -> | "selected_button_font" -> | "selection_back" -> | "selection_font" -> | "standby_selection_back" -> | "standby_selection_font" -> | "midi_mapping_back" -> | "midi_mapping_font" -> | "tooltip_back" -> | "tooltip_font" -> | "valuebox_back" -> | "valuebox_font" -> | "valuebox_font_icons" -> | "scrollbar" -> | "slider" -> | "folder" -> | "pattern_default_back" -> | "pattern_default_font" -> | "pattern_default_font_volume" -> | "pattern_default_font_panning" -> | "pattern_default_font_pitch" -> | "pattern_default_font_delay" -> | "pattern_default_font_global" -> | "pattern_default_font_other" -> | "pattern_default_font_dspfx" -> | "pattern_default_font_unused" -> | "pattern_highlighted_back" -> | "pattern_highlighted_font" -> | "pattern_highlighted_font_volume" -> | "pattern_highlighted_font_panning" -> | "pattern_highlighted_font_pitch" -> | "pattern_highlighted_font_delay" -> | "pattern_highlighted_font_global" -> | "pattern_highlighted_font_other" -> | "pattern_highlighted_font_dspfx" -> | "pattern_highlighted_font_unused" -> | "pattern_playposition_back" -> | "pattern_playposition_font" -> | "pattern_centerbar_back" -> | "pattern_centerbar_font" -> | "pattern_centerbar_back_standby" -> | "pattern_centerbar_font_standby" -> | "pattern_selection" -> | "pattern_standby_selection" -> | "pattern_mute_state" -> | "automation_grid" -> | "automation_line_edge" -> | "automation_line_fill" -> | "automation_point" -> | "automation_marker_play" -> | "automation_marker_single" -> | "automation_marker_pair" -> | "automation_marker_diamond" -> | "vumeter_meter" -> | "vumeter_meter_low" -> | "vumeter_meter_middle" -> | "vumeter_meter_high" -> | "vumeter_peak" -> | "vumeter_back_normal" -> | "vumeter_back_clipped" -> | "default_color_01" -> | "default_color_02" -> | "default_color_03" -> | "default_color_04" -> | "default_color_05" -> | "default_color_06" -> | "default_color_07" -> | "default_color_08" -> | "default_color_09" -> | "default_color_10" -> | "default_color_11" -> | "default_color_12" -> | "default_color_13" -> | "default_color_14" -> | "default_color_15" -> | "default_color_16" -> ``` - -### ButtonLabel -[`string`](../../API/builtins/string.md) -> The text label of the button -> * Default: "" - -### ButtonNotifier -[`NotifierFunction`](#NotifierFunction) | [`NotifierMethod1`](#NotifierMethod1) | [`NotifierMethod2`](#NotifierMethod2) -> A click notifier - -### ButtonStyle -`"normal"` | `"rounded"` | `"rounded_bottom"` | `"rounded_left"` | `"rounded_right"` | `"rounded_top"` -> ```lua -> -- Get/set the style a button should be displayed with. -> ButtonStyle: -> | "normal" -- (Default) -> | "rounded" -- rounded corners on all sides -> | "rounded_left" -- rounded left side -> | "rounded_right" -- rounded right side -> | "rounded_top" -- rounded left side -> | "rounded_bottom" -- rounded right side -> ``` - -### ControlActive -[`boolean`](../../API/builtins/boolean.md) -> Instead of making a control invisible, you can also make it inactive. -> Deactivated controls will still be shown, and will still show their -> currently assigned values, but will not allow changes. Most controls will -> display as "grayed out" to visualize the deactivated state. - -### ControlMidiMappingString -[`string`](../../API/builtins/string.md) -> When set, the control will be highlighted when Renoise's MIDI mapping dialog -> is open. When clicked, it selects the specified string as a MIDI mapping -> target action. This target acton can either be one of the globally available -> mappings in Renoise, or those that were created by the tool itself. -> Target strings are not verified. When they point to nothing, the mapped MIDI -> message will do nothing and no error is fired. - -### NotifierFunction -fun() - - -### NotifierMemberContext -[`table`](../../API/builtins/table.md) | [`userdata`](../../API/builtins/userdata.md) - - -### NotifierMemberFunction -(self : [`NotifierMemberContext`](#NotifierMemberContext)) - - -### NotifierMethod1 -{ 1 : [`NotifierMemberContext`](#NotifierMemberContext), 2 : [`NotifierMemberFunction`](#NotifierMemberFunction) } - - -### NotifierMethod2 -{ 1 : [`NotifierMemberFunction`](#NotifierMemberFunction), 2 : [`NotifierMemberContext`](#NotifierMemberContext) } - - -### RGBColor -{ 1 : [`integer`](../../API/builtins/integer.md), 2 : [`integer`](../../API/builtins/integer.md), 3 : [`integer`](../../API/builtins/integer.md) } -> A table of 3 bytes (ranging from 0 to 255) -> representing the red, green and blue channels of a color. -> {0xFF, 0xFF, 0xFF} is white -> {165, 73, 35} is the red from the Renoise logo - -### TextFontStyle -`"big"` | `"bold"` | `"code"` | `"italic"` | `"mono"` | `"normal"` -> ```lua -> -- The style that the text should be displayed with. -> TextFontStyle: -> | "normal" -- (Default) -> | "big" -- big text -> | "bold" -- bold font -> | "italic" -- italic font -> | "mono" -- monospace font -> | "code" -- monospace code font -> ``` - -### ThemeColor -`"alternate_main_back"` | `"alternate_main_font"` | `"automation_grid"` | `"automation_line_edge"` | `"automation_line_fill"` | `"automation_marker_diamond"` | `"automation_marker_pair"` | `"automation_marker_play"` | `"automation_marker_single"` | `"automation_point"` | `"body_back"` | `"body_font"` | `"button_back"` | `"button_font"` | `"button_highlight_font"` | `"default_color_01"` | `"default_color_02"` | `"default_color_03"` | `"default_color_04"` | `"default_color_05"` | `"default_color_06"` | `"default_color_07"` | `"default_color_08"` | `"default_color_09"` | `"default_color_10"` | `"default_color_11"` | `"default_color_12"` | `"default_color_13"` | `"default_color_14"` | `"default_color_15"` | `"default_color_16"` | `"folder"` | `"main_back"` | `"main_font"` | `"midi_mapping_back"` | `"midi_mapping_font"` | `"pattern_centerbar_back"` | `"pattern_centerbar_back_standby"` | `"pattern_centerbar_font"` | `"pattern_centerbar_font_standby"` | `"pattern_default_back"` | `"pattern_default_font"` | `"pattern_default_font_delay"` | `"pattern_default_font_dspfx"` | `"pattern_default_font_global"` | `"pattern_default_font_other"` | `"pattern_default_font_panning"` | `"pattern_default_font_pitch"` | `"pattern_default_font_unused"` | `"pattern_default_font_volume"` | `"pattern_highlighted_back"` | `"pattern_highlighted_font"` | `"pattern_highlighted_font_delay"` | `"pattern_highlighted_font_dspfx"` | `"pattern_highlighted_font_global"` | `"pattern_highlighted_font_other"` | `"pattern_highlighted_font_panning"` | `"pattern_highlighted_font_pitch"` | `"pattern_highlighted_font_unused"` | `"pattern_highlighted_font_volume"` | `"pattern_mute_state"` | `"pattern_playposition_back"` | `"pattern_playposition_font"` | `"pattern_selection"` | `"pattern_standby_selection"` | `"scrollbar"` | `"selected_button_back"` | `"selected_button_font"` | `"selection_back"` | `"selection_font"` | `"slider"` | `"standby_selection_back"` | `"standby_selection_font"` | `"strong_body_font"` | `"tooltip_back"` | `"tooltip_font"` | `"valuebox_back"` | `"valuebox_font"` | `"valuebox_font_icons"` | `"vumeter_back_clipped"` | `"vumeter_back_normal"` | `"vumeter_meter"` | `"vumeter_meter_high"` | `"vumeter_meter_low"` | `"vumeter_meter_middle"` | `"vumeter_peak"` -> ```lua -> -- The application theme's colors -> ThemeColor: -> | "main_back" -> | "main_font" -> | "alternate_main_back" -> | "alternate_main_font" -> | "body_back" -> | "body_font" -> | "strong_body_font" -> | "button_back" -> | "button_font" -> | "button_highlight_font" -> | "selected_button_back" -> | "selected_button_font" -> | "selection_back" -> | "selection_font" -> | "standby_selection_back" -> | "standby_selection_font" -> | "midi_mapping_back" -> | "midi_mapping_font" -> | "tooltip_back" -> | "tooltip_font" -> | "valuebox_back" -> | "valuebox_font" -> | "valuebox_font_icons" -> | "scrollbar" -> | "slider" -> | "folder" -> | "pattern_default_back" -> | "pattern_default_font" -> | "pattern_default_font_volume" -> | "pattern_default_font_panning" -> | "pattern_default_font_pitch" -> | "pattern_default_font_delay" -> | "pattern_default_font_global" -> | "pattern_default_font_other" -> | "pattern_default_font_dspfx" -> | "pattern_default_font_unused" -> | "pattern_highlighted_back" -> | "pattern_highlighted_font" -> | "pattern_highlighted_font_volume" -> | "pattern_highlighted_font_panning" -> | "pattern_highlighted_font_pitch" -> | "pattern_highlighted_font_delay" -> | "pattern_highlighted_font_global" -> | "pattern_highlighted_font_other" -> | "pattern_highlighted_font_dspfx" -> | "pattern_highlighted_font_unused" -> | "pattern_playposition_back" -> | "pattern_playposition_font" -> | "pattern_centerbar_back" -> | "pattern_centerbar_font" -> | "pattern_centerbar_back_standby" -> | "pattern_centerbar_font_standby" -> | "pattern_selection" -> | "pattern_standby_selection" -> | "pattern_mute_state" -> | "automation_grid" -> | "automation_line_edge" -> | "automation_line_fill" -> | "automation_point" -> | "automation_marker_play" -> | "automation_marker_single" -> | "automation_marker_pair" -> | "automation_marker_diamond" -> | "vumeter_meter" -> | "vumeter_meter_low" -> | "vumeter_meter_middle" -> | "vumeter_meter_high" -> | "vumeter_peak" -> | "vumeter_back_normal" -> | "vumeter_back_clipped" -> | "default_color_01" -> | "default_color_02" -> | "default_color_03" -> | "default_color_04" -> | "default_color_05" -> | "default_color_06" -> | "default_color_07" -> | "default_color_08" -> | "default_color_09" -> | "default_color_10" -> | "default_color_11" -> | "default_color_12" -> | "default_color_13" -> | "default_color_14" -> | "default_color_15" -> | "default_color_16" -> ``` - -### ViewCursorShape -`"busy"` | `"change_value"` | `"crosshair"` | `"default"` | `"drag"` | `"drop"` | `"edit_text"` | `"empty"` | `"erase"` | `"extend_bottom"` | `"extend_bottom_alias"` | `"extend_left"` | `"extend_left_alias"` | `"extend_right"` | `"extend_right_alias"` | `"extend_top"` | `"extend_top_alias"` | `"marker"` | `"move"` | `"nodrop"` | `"none"` | `"pencil"` | `"play"` | `"resize_edge_diagonal_left"` | `"resize_edge_diagonal_right"` | `"resize_edge_horizontal"` | `"resize_edge_vertical"` | `"resize_horizontal"` | `"resize_vertical"` | `"zoom"` | `"zoom_horizontal"` | `"zoom_vertical"` -> ```lua -> -- The cursor cursor for this view which apears on mouse hover. -> -- Using a "none" shape will use use underlying view's cursor or the default cursor. -> ViewCursorShape: -> | "none" -> | "empty" -> | "default" -> | "change_value" -> | "edit_text" -> | "pencil" -> | "marker" -> | "crosshair" -> | "move" -> | "erase" -> | "play" -> | "drag" -> | "drop" -> | "nodrop" -> | "busy" -> | "resize_vertical" -> | "resize_horizontal" -> | "resize_edge_vertical" -> | "resize_edge_horizontal" -> | "resize_edge_diagonal_left" -> | "resize_edge_diagonal_right" -> | "extend_left" -> | "extend_right" -> | "extend_top" -> | "extend_bottom" -> | "extend_left_alias" -> | "extend_right_alias" -> | "extend_top_alias" -> | "extend_bottom_alias" -> | "zoom_vertical" -> | "zoom_horizontal" -> | "zoom" -> ``` - -### ViewDimension -[`string`](../../API/builtins/string.md) | [`integer`](../../API/builtins/integer.md) -> The dimensions of a view has to be larger than 0. -> For nested views you can also specify relative size -> for example `vb:text { width = "80%"}`. The percentage values are -> relative to the view's parent size and will automatically update on size changes. - -### ViewId -[`string`](../../API/builtins/string.md) -> Unique identifier to resolve the view later on in the viewbuilder, -> e.g. `vb.views.SomeString` or `vb.views["Some String"]` -> View ids must be unique within a single view builder instance. - -### ViewOrigin -{ 1 : [`ViewPosition`](#ViewPosition), 2 : [`ViewPosition`](#ViewPosition) } | { x : [`ViewPosition`](#ViewPosition), y : [`ViewPosition`](#ViewPosition) } -> The position of a view within its parent view. -> Only the `stack` layouts allows to freely position child views. Other -> layout views will automatically set the origin, but the origin -> then still can be read in for example mouse handlers. - -### ViewPosition -[`integer`](../../API/builtins/integer.md) -> Horizontal (x) or Vertical (y) position of a view within its parent view. - -### ViewSize -{ 1 : [`ViewDimension`](#ViewDimension), 2 : [`ViewDimension`](#ViewDimension) } | { height : [`ViewDimension`](#ViewDimension), width : [`ViewDimension`](#ViewDimension) } -> The dimensions of a view has to be larger than 0. -> For nested views you can also specify relative size, for example -> `vb:text { size = { width = "80%", height = 20}}`. -> The percentage values are relative to the view's parent size and will -> automatically update when the parent view's size changes. - -### ViewTooltip -[`string`](../../API/builtins/string.md) -> A ViewTooltip text that should be shown for this view on mouse hover. -> * Default: "" (no tip will be shown) - -### ViewVisibility -[`boolean`](../../API/builtins/boolean.md) -> Set visible to false to hide a view (make it invisible without removing -> it). Please note that view.visible will also return false when any of its -> parents are invisible (when its implicitly invisible). -> * Default: true - - - -# ButtonSwitchProperties - ---- -## Properties -### active : [`ControlActive`](#ControlActive)[`?`](../../API/builtins/nil.md) -> Instead of making a control invisible, you can also make it inactive. -> Deactivated controls will still be shown, and will still show their -> currently assigned values, but will not allow changes. Most controls will -> display as "grayed out" to visualize the deactivated state. - -### midi_mapping : [`ControlMidiMappingString`](#ControlMidiMappingString)[`?`](../../API/builtins/nil.md) -> When set, the control will be highlighted when Renoise's MIDI mapping dialog -> is open. When clicked, it selects the specified string as a MIDI mapping -> target action. This target acton can either be one of the globally available -> mappings in Renoise, or those that were created by the tool itself. -> Target strings are not verified. When they point to nothing, the mapped MIDI -> message will do nothing and no error is fired. - -### bind : [`ViewNumberObservable`](#ViewNumberObservable)[`?`](../../API/builtins/nil.md) -> Bind the view's value to a renoise.Document.ObservableNumber object. -> Automatically keep them in sync. -> The view will change the Observable value as soon as its value changes -> and change the view's value as soon as the Observable's value changes. -> Notifiers can be added to either the view or the Observable object. - -### value : [`SelectedItem`](#SelectedItem)[`?`](../../API/builtins/nil.md) -> The currently selected item's index - -### notifier : [`IntegerNotifier`](#IntegerNotifier)[`?`](../../API/builtins/nil.md) -> Set up a notifier that will be called whenever a new item is picked - -### items : [`ItemLabels`](#ItemLabels)[`?`](../../API/builtins/nil.md) -> A list of buttons labels to show in order. Must have more than one item. - -### id : [`ViewId`](#ViewId)[`?`](../../API/builtins/nil.md) -> Unique identifier to resolve the view later on in the viewbuilder, -> e.g. `vb.views.SomeString` or `vb.views["Some String"]` -> View ids must be unique within a single view builder instance. - -### visible : [`ViewVisibility`](#ViewVisibility)[`?`](../../API/builtins/nil.md) -> Set visible to false to hide a view (make it invisible without removing -> it). Please note that view.visible will also return false when any of its -> parents are invisible (when its implicitly invisible). -> * Default: true - -### origin : [`ViewOrigin`](#ViewOrigin)[`?`](../../API/builtins/nil.md) -> The position of a view within its parent view. -> Only the `stack` layouts allows to freely position child views. Other -> layout views will automatically set the origin, but the origin -> then still can be read in for example mouse handlers. - -### width : [`ViewDimension`](#ViewDimension)[`?`](../../API/builtins/nil.md) -> **Deprecated.** Use property `size` instead. - -### height : [`ViewDimension`](#ViewDimension)[`?`](../../API/builtins/nil.md) -> **Deprecated.** Use property `size` instead. - -### size : [`ViewSize`](#ViewSize)[`?`](../../API/builtins/nil.md) -> The dimensions of a view has to be larger than 0. -> For nested views you can also specify relative size, for example -> `vb:text { size = { width = "80%", height = 20}}`. -> The percentage values are relative to the view's parent size and will -> automatically update when the parent view's size changes. - -### tooltip : [`ViewTooltip`](#ViewTooltip)[`?`](../../API/builtins/nil.md) -> A ViewTooltip text that should be shown for this view on mouse hover. -> * Default: "" (no tip will be shown) - -### cursor : [`ViewCursorShape`](#ViewCursorShape)[`?`](../../API/builtins/nil.md) -> The cursor cursor for this view which apears on mouse hover. -> Using a "none" shape will use use underlying view's cursor or the default cursor. - - - - - ---- -## Aliases -### ControlActive -[`boolean`](../../API/builtins/boolean.md) -> Instead of making a control invisible, you can also make it inactive. -> Deactivated controls will still be shown, and will still show their -> currently assigned values, but will not allow changes. Most controls will -> display as "grayed out" to visualize the deactivated state. - -### ControlMidiMappingString -[`string`](../../API/builtins/string.md) -> When set, the control will be highlighted when Renoise's MIDI mapping dialog -> is open. When clicked, it selects the specified string as a MIDI mapping -> target action. This target acton can either be one of the globally available -> mappings in Renoise, or those that were created by the tool itself. -> Target strings are not verified. When they point to nothing, the mapped MIDI -> message will do nothing and no error is fired. - -### IntegerNotifier -[`IntegerValueNotifierFunction`](#IntegerValueNotifierFunction) | [`IntegerValueNotifierMethod1`](#IntegerValueNotifierMethod1) | [`IntegerValueNotifierMethod2`](#IntegerValueNotifierMethod2) -> Set up a notifier that will be called whenever a new item is picked - -### IntegerValueNotifierFunction -(value : [`integer`](../../API/builtins/integer.md)) - - -### IntegerValueNotifierMemberFunction -(self : [`NotifierMemberContext`](#NotifierMemberContext), value : [`integer`](../../API/builtins/integer.md)) - - -### IntegerValueNotifierMethod1 -{ 1 : [`NotifierMemberContext`](#NotifierMemberContext), 2 : [`IntegerValueNotifierMemberFunction`](#IntegerValueNotifierMemberFunction) } - - -### IntegerValueNotifierMethod2 -{ 1 : [`IntegerValueNotifierMemberFunction`](#IntegerValueNotifierMemberFunction), 2 : [`NotifierMemberContext`](#NotifierMemberContext) } - - -### ItemLabels -[`string`](../../API/builtins/string.md)[] -> A list of buttons labels to show in order. Must have more than one item. - -### NotifierFunction -fun() - - -### NotifierMemberContext -[`table`](../../API/builtins/table.md) | [`userdata`](../../API/builtins/userdata.md) - - -### SelectedItem -[`integer`](../../API/builtins/integer.md) -> The currently selected item's index - -### ViewCursorShape -`"busy"` | `"change_value"` | `"crosshair"` | `"default"` | `"drag"` | `"drop"` | `"edit_text"` | `"empty"` | `"erase"` | `"extend_bottom"` | `"extend_bottom_alias"` | `"extend_left"` | `"extend_left_alias"` | `"extend_right"` | `"extend_right_alias"` | `"extend_top"` | `"extend_top_alias"` | `"marker"` | `"move"` | `"nodrop"` | `"none"` | `"pencil"` | `"play"` | `"resize_edge_diagonal_left"` | `"resize_edge_diagonal_right"` | `"resize_edge_horizontal"` | `"resize_edge_vertical"` | `"resize_horizontal"` | `"resize_vertical"` | `"zoom"` | `"zoom_horizontal"` | `"zoom_vertical"` -> ```lua -> -- The cursor cursor for this view which apears on mouse hover. -> -- Using a "none" shape will use use underlying view's cursor or the default cursor. -> ViewCursorShape: -> | "none" -> | "empty" -> | "default" -> | "change_value" -> | "edit_text" -> | "pencil" -> | "marker" -> | "crosshair" -> | "move" -> | "erase" -> | "play" -> | "drag" -> | "drop" -> | "nodrop" -> | "busy" -> | "resize_vertical" -> | "resize_horizontal" -> | "resize_edge_vertical" -> | "resize_edge_horizontal" -> | "resize_edge_diagonal_left" -> | "resize_edge_diagonal_right" -> | "extend_left" -> | "extend_right" -> | "extend_top" -> | "extend_bottom" -> | "extend_left_alias" -> | "extend_right_alias" -> | "extend_top_alias" -> | "extend_bottom_alias" -> | "zoom_vertical" -> | "zoom_horizontal" -> | "zoom" -> ``` - -### ViewDimension -[`string`](../../API/builtins/string.md) | [`integer`](../../API/builtins/integer.md) -> The dimensions of a view has to be larger than 0. -> For nested views you can also specify relative size -> for example `vb:text { width = "80%"}`. The percentage values are -> relative to the view's parent size and will automatically update on size changes. - -### ViewId -[`string`](../../API/builtins/string.md) -> Unique identifier to resolve the view later on in the viewbuilder, -> e.g. `vb.views.SomeString` or `vb.views["Some String"]` -> View ids must be unique within a single view builder instance. - -### ViewNumberObservable -[`renoise.Document.ObservableNumber`](../../API/renoise/renoise.Document.ObservableNumber.md) -> Bind the view's value to a renoise.Document.ObservableNumber object. -> Automatically keep them in sync. -> The view will change the Observable value as soon as its value changes -> and change the view's value as soon as the Observable's value changes. -> Notifiers can be added to either the view or the Observable object. - -### ViewOrigin -{ 1 : [`ViewPosition`](#ViewPosition), 2 : [`ViewPosition`](#ViewPosition) } | { x : [`ViewPosition`](#ViewPosition), y : [`ViewPosition`](#ViewPosition) } -> The position of a view within its parent view. -> Only the `stack` layouts allows to freely position child views. Other -> layout views will automatically set the origin, but the origin -> then still can be read in for example mouse handlers. - -### ViewPosition -[`integer`](../../API/builtins/integer.md) -> Horizontal (x) or Vertical (y) position of a view within its parent view. - -### ViewSize -{ 1 : [`ViewDimension`](#ViewDimension), 2 : [`ViewDimension`](#ViewDimension) } | { height : [`ViewDimension`](#ViewDimension), width : [`ViewDimension`](#ViewDimension) } -> The dimensions of a view has to be larger than 0. -> For nested views you can also specify relative size, for example -> `vb:text { size = { width = "80%", height = 20}}`. -> The percentage values are relative to the view's parent size and will -> automatically update when the parent view's size changes. - -### ViewTooltip -[`string`](../../API/builtins/string.md) -> A ViewTooltip text that should be shown for this view on mouse hover. -> * Default: "" (no tip will be shown) - -### ViewVisibility -[`boolean`](../../API/builtins/boolean.md) -> Set visible to false to hide a view (make it invisible without removing -> it). Please note that view.visible will also return false when any of its -> parents are invisible (when its implicitly invisible). -> * Default: true - - - -# CanvasViewProperties - ---- -## Properties -### mode : [`CanvasMode`](#CanvasMode)[`?`](../../API/builtins/nil.md) -> How to draw the canvas context to screen: "transparent" draws with alpha from -> the canvas, "plain" ignores alpha values, which usually is a lot faster to draw. -> Use "plain" to speed up drawing background alike canvas views which cover the -> entire view area. Default: "transparent" - -### render : [`CanvasRenderFunction`](#CanvasRenderFunction)[`?`](../../API/builtins/nil.md) -> Rendering callback for a canvas. -> -> To update the canvas, use the canvas view's `update` function. -> This will will schedule a new drawing as soon as the backend is ready to draw. -> Always draw a complete image here, as the canvas will be completely empty in -> each new render call. -> -> **UI scaling**: the canvas context by default is set up, so that the global UI -> scaling gets applied. So all positions in the canvas context by default use -> **view sizes** and not pixels. If you want to draw in a raw pixel resolution -> reset the canvas transformation via `context.set_transform(1.0, 0.0, 0.0, 1.0, 0.0, 0.0)` -> To query the actual canvas size in pixels, use the context's `size` property. - -### mouse_handler : [`MouseHandler`](#MouseHandler)[`?`](../../API/builtins/nil.md) -> Optional mouse event handler for a view. return nil when the event got handled -> to stop propagating the event. return the event instance, as passed, to pass it -> to the next view in the view hirarchy. - -### mouse_events : [`MouseEventTypes`](#MouseEventTypes)[`?`](../../API/builtins/nil.md) -> The mouse event types that should be passed to your `mouse_handler` function. -> By default: `{ "down", "up", "double" }` -> Avoid adding event types that you don't use, especially "move" events as they do -> create quite some overhead. Also note that when enabling "drag", sub view controls -> can no longer handle drag events, even when you pass back the event in the handler, -> so only enable it when you want to completely override mouse drag behavior of -> *all* your content views. - -### views : [`CanvasChildViews`](#CanvasChildViews)[`?`](../../API/builtins/nil.md) -> The canvas view's optional child views. -> Views can later on also be added and removed dynamically after construction via -> `stack:add_view(child)` and `stack:remove_view(child)` - -### id : [`ViewId`](#ViewId)[`?`](../../API/builtins/nil.md) -> Unique identifier to resolve the view later on in the viewbuilder, -> e.g. `vb.views.SomeString` or `vb.views["Some String"]` -> View ids must be unique within a single view builder instance. - -### visible : [`ViewVisibility`](#ViewVisibility)[`?`](../../API/builtins/nil.md) -> Set visible to false to hide a view (make it invisible without removing -> it). Please note that view.visible will also return false when any of its -> parents are invisible (when its implicitly invisible). -> * Default: true - -### origin : [`ViewOrigin`](#ViewOrigin)[`?`](../../API/builtins/nil.md) -> The position of a view within its parent view. -> Only the `stack` layouts allows to freely position child views. Other -> layout views will automatically set the origin, but the origin -> then still can be read in for example mouse handlers. - -### width : [`ViewDimension`](#ViewDimension)[`?`](../../API/builtins/nil.md) -> **Deprecated.** Use property `size` instead. - -### height : [`ViewDimension`](#ViewDimension)[`?`](../../API/builtins/nil.md) -> **Deprecated.** Use property `size` instead. - -### size : [`ViewSize`](#ViewSize)[`?`](../../API/builtins/nil.md) -> The dimensions of a view has to be larger than 0. -> For nested views you can also specify relative size, for example -> `vb:text { size = { width = "80%", height = 20}}`. -> The percentage values are relative to the view's parent size and will -> automatically update when the parent view's size changes. - -### tooltip : [`ViewTooltip`](#ViewTooltip)[`?`](../../API/builtins/nil.md) -> A ViewTooltip text that should be shown for this view on mouse hover. -> * Default: "" (no tip will be shown) - -### cursor : [`ViewCursorShape`](#ViewCursorShape)[`?`](../../API/builtins/nil.md) -> The cursor cursor for this view which apears on mouse hover. -> Using a "none" shape will use use underlying view's cursor or the default cursor. - - - - - ---- -## Aliases -### CanvasChildViews -[`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)[] -> The canvas view's optional child views. -> Views can later on also be added and removed dynamically after construction via -> `stack:add_view(child)` and `stack:remove_view(child)` - -### CanvasMode -`"plain"` | `"transparent"` -> ```lua -> -- How to draw the canvas context to screen: "transparent" draws with alpha from -> -- the canvas, "plain" ignores alpha values, which usually is a lot faster to draw. -> -- Use "plain" to speed up drawing background alike canvas views which cover the -> -- entire view area. Default: "transparent" -> CanvasMode: -> | "plain" -> | "transparent" -> ``` - -### CanvasRenderFunction -(context : [`renoise.Views.Canvas.Context`](../../API/renoise/renoise.Views.Canvas.Context.md)) -> Rendering callback for a canvas. -> -> To update the canvas, use the canvas view's `update` function. -> This will will schedule a new drawing as soon as the backend is ready to draw. -> Always draw a complete image here, as the canvas will be completely empty in -> each new render call. -> -> **UI scaling**: the canvas context by default is set up, so that the global UI -> scaling gets applied. So all positions in the canvas context by default use -> **view sizes** and not pixels. If you want to draw in a raw pixel resolution -> reset the canvas transformation via `context.set_transform(1.0, 0.0, 0.0, 1.0, 0.0, 0.0)` -> To query the actual canvas size in pixels, use the context's `size` property. - -### MouseEventButton -`"left"` | `"middle"` | `"right"` -> ```lua -> -- Mouse button of a `MouseEvent` of type "up"|"down"|"double"|"drag". -> MouseEventButton: -> | "left" -> | "right" -> | "middle" -> ``` - -### MouseEventType -`"double"` | `"down"` | `"drag"` | `"enter"` | `"exit"` | `"move"` | `"up"` | `"wheel"` -> ```lua -> -- Event type of a `MouseEvent`. -> MouseEventType: -> | "enter" -> | "exit" -> | "move" -> | "down" -> | "up" -> | "double" -> | "drag" -> | "wheel" -> ``` - -### MouseEventTypes -[`MouseEventType`](#MouseEventType)[] -> The mouse event types that should be passed to your `mouse_handler` function. -> By default: `{ "down", "up", "double" }` -> Avoid adding event types that you don't use, especially "move" events as they do -> create quite some overhead. Also note that when enabling "drag", sub view controls -> can no longer handle drag events, even when you pass back the event in the handler, -> so only enable it when you want to completely override mouse drag behavior of -> *all* your content views. - -### MouseEventWheelDirection -`"down"` | `"left"` | `"right"` | `"up"` -> ```lua -> -- Mouse wheel direction in a `MouseEvent` of type "wheel". -> MouseEventWheelDirection: -> | "up" -> | "down" -> | "left" -> | "right" -> ``` - -### MouseHandler -[`MouseHandlerNotifierFunction`](#MouseHandlerNotifierFunction) | [`MouseHandlerNotifierMethod1`](#MouseHandlerNotifierMethod1) | [`MouseHandlerNotifierMethod2`](#MouseHandlerNotifierMethod2) -> Optional mouse event handler for a view. return nil when the event got handled -> to stop propagating the event. return the event instance, as passed, to pass it -> to the next view in the view hirarchy. - -### MouseHandlerNotifierFunction -(event : [`MouseEvent`](#mouseevent)) `->` [`MouseEvent`](#mouseevent)[`?`](../../API/builtins/nil.md) - - -### MouseHandlerNotifierMemberFunction -(self : [`NotifierMemberContext`](#NotifierMemberContext), event : [`MouseEvent`](#mouseevent)) `->` [`MouseEvent`](#mouseevent)[`?`](../../API/builtins/nil.md) - - -### MouseHandlerNotifierMethod1 -{ 1 : [`NotifierMemberContext`](#NotifierMemberContext), 2 : [`MouseHandlerNotifierMemberFunction`](#MouseHandlerNotifierMemberFunction) } - - -### MouseHandlerNotifierMethod2 -{ 1 : [`MouseHandlerNotifierMemberFunction`](#MouseHandlerNotifierMemberFunction), 2 : [`NotifierMemberContext`](#NotifierMemberContext) } - - -### NotifierMemberContext -[`table`](../../API/builtins/table.md) | [`userdata`](../../API/builtins/userdata.md) - - -### RGBAColor -{ 1 : [`integer`](../../API/builtins/integer.md), 2 : [`integer`](../../API/builtins/integer.md), 3 : [`integer`](../../API/builtins/integer.md), 4 : [`integer`](../../API/builtins/integer.md) } -> A table of 4 bytes (ranging from 0 to 255) -> representing the red, green, blue, alpha channels of a color. -> {0xFF, 0xFF, 0xFF, 0xFF} is white -> {165, 73, 35, 0x80} is the red from the Renoise logo, half opaque. - -### RGBColor -{ 1 : [`integer`](../../API/builtins/integer.md), 2 : [`integer`](../../API/builtins/integer.md), 3 : [`integer`](../../API/builtins/integer.md) } -> A table of 3 bytes (ranging from 0 to 255) -> representing the red, green and blue channels of a color. -> {0xFF, 0xFF, 0xFF} is white -> {165, 73, 35} is the red from the Renoise logo - -### ThemeColor -`"alternate_main_back"` | `"alternate_main_font"` | `"automation_grid"` | `"automation_line_edge"` | `"automation_line_fill"` | `"automation_marker_diamond"` | `"automation_marker_pair"` | `"automation_marker_play"` | `"automation_marker_single"` | `"automation_point"` | `"body_back"` | `"body_font"` | `"button_back"` | `"button_font"` | `"button_highlight_font"` | `"default_color_01"` | `"default_color_02"` | `"default_color_03"` | `"default_color_04"` | `"default_color_05"` | `"default_color_06"` | `"default_color_07"` | `"default_color_08"` | `"default_color_09"` | `"default_color_10"` | `"default_color_11"` | `"default_color_12"` | `"default_color_13"` | `"default_color_14"` | `"default_color_15"` | `"default_color_16"` | `"folder"` | `"main_back"` | `"main_font"` | `"midi_mapping_back"` | `"midi_mapping_font"` | `"pattern_centerbar_back"` | `"pattern_centerbar_back_standby"` | `"pattern_centerbar_font"` | `"pattern_centerbar_font_standby"` | `"pattern_default_back"` | `"pattern_default_font"` | `"pattern_default_font_delay"` | `"pattern_default_font_dspfx"` | `"pattern_default_font_global"` | `"pattern_default_font_other"` | `"pattern_default_font_panning"` | `"pattern_default_font_pitch"` | `"pattern_default_font_unused"` | `"pattern_default_font_volume"` | `"pattern_highlighted_back"` | `"pattern_highlighted_font"` | `"pattern_highlighted_font_delay"` | `"pattern_highlighted_font_dspfx"` | `"pattern_highlighted_font_global"` | `"pattern_highlighted_font_other"` | `"pattern_highlighted_font_panning"` | `"pattern_highlighted_font_pitch"` | `"pattern_highlighted_font_unused"` | `"pattern_highlighted_font_volume"` | `"pattern_mute_state"` | `"pattern_playposition_back"` | `"pattern_playposition_font"` | `"pattern_selection"` | `"pattern_standby_selection"` | `"scrollbar"` | `"selected_button_back"` | `"selected_button_font"` | `"selection_back"` | `"selection_font"` | `"slider"` | `"standby_selection_back"` | `"standby_selection_font"` | `"strong_body_font"` | `"tooltip_back"` | `"tooltip_font"` | `"valuebox_back"` | `"valuebox_font"` | `"valuebox_font_icons"` | `"vumeter_back_clipped"` | `"vumeter_back_normal"` | `"vumeter_meter"` | `"vumeter_meter_high"` | `"vumeter_meter_low"` | `"vumeter_meter_middle"` | `"vumeter_peak"` -> ```lua -> -- The application theme's colors -> ThemeColor: -> | "main_back" -> | "main_font" -> | "alternate_main_back" -> | "alternate_main_font" -> | "body_back" -> | "body_font" -> | "strong_body_font" -> | "button_back" -> | "button_font" -> | "button_highlight_font" -> | "selected_button_back" -> | "selected_button_font" -> | "selection_back" -> | "selection_font" -> | "standby_selection_back" -> | "standby_selection_font" -> | "midi_mapping_back" -> | "midi_mapping_font" -> | "tooltip_back" -> | "tooltip_font" -> | "valuebox_back" -> | "valuebox_font" -> | "valuebox_font_icons" -> | "scrollbar" -> | "slider" -> | "folder" -> | "pattern_default_back" -> | "pattern_default_font" -> | "pattern_default_font_volume" -> | "pattern_default_font_panning" -> | "pattern_default_font_pitch" -> | "pattern_default_font_delay" -> | "pattern_default_font_global" -> | "pattern_default_font_other" -> | "pattern_default_font_dspfx" -> | "pattern_default_font_unused" -> | "pattern_highlighted_back" -> | "pattern_highlighted_font" -> | "pattern_highlighted_font_volume" -> | "pattern_highlighted_font_panning" -> | "pattern_highlighted_font_pitch" -> | "pattern_highlighted_font_delay" -> | "pattern_highlighted_font_global" -> | "pattern_highlighted_font_other" -> | "pattern_highlighted_font_dspfx" -> | "pattern_highlighted_font_unused" -> | "pattern_playposition_back" -> | "pattern_playposition_font" -> | "pattern_centerbar_back" -> | "pattern_centerbar_font" -> | "pattern_centerbar_back_standby" -> | "pattern_centerbar_font_standby" -> | "pattern_selection" -> | "pattern_standby_selection" -> | "pattern_mute_state" -> | "automation_grid" -> | "automation_line_edge" -> | "automation_line_fill" -> | "automation_point" -> | "automation_marker_play" -> | "automation_marker_single" -> | "automation_marker_pair" -> | "automation_marker_diamond" -> | "vumeter_meter" -> | "vumeter_meter_low" -> | "vumeter_meter_middle" -> | "vumeter_meter_high" -> | "vumeter_peak" -> | "vumeter_back_normal" -> | "vumeter_back_clipped" -> | "default_color_01" -> | "default_color_02" -> | "default_color_03" -> | "default_color_04" -> | "default_color_05" -> | "default_color_06" -> | "default_color_07" -> | "default_color_08" -> | "default_color_09" -> | "default_color_10" -> | "default_color_11" -> | "default_color_12" -> | "default_color_13" -> | "default_color_14" -> | "default_color_15" -> | "default_color_16" -> ``` - -### ViewCursorShape -`"busy"` | `"change_value"` | `"crosshair"` | `"default"` | `"drag"` | `"drop"` | `"edit_text"` | `"empty"` | `"erase"` | `"extend_bottom"` | `"extend_bottom_alias"` | `"extend_left"` | `"extend_left_alias"` | `"extend_right"` | `"extend_right_alias"` | `"extend_top"` | `"extend_top_alias"` | `"marker"` | `"move"` | `"nodrop"` | `"none"` | `"pencil"` | `"play"` | `"resize_edge_diagonal_left"` | `"resize_edge_diagonal_right"` | `"resize_edge_horizontal"` | `"resize_edge_vertical"` | `"resize_horizontal"` | `"resize_vertical"` | `"zoom"` | `"zoom_horizontal"` | `"zoom_vertical"` -> ```lua -> -- The cursor cursor for this view which apears on mouse hover. -> -- Using a "none" shape will use use underlying view's cursor or the default cursor. -> ViewCursorShape: -> | "none" -> | "empty" -> | "default" -> | "change_value" -> | "edit_text" -> | "pencil" -> | "marker" -> | "crosshair" -> | "move" -> | "erase" -> | "play" -> | "drag" -> | "drop" -> | "nodrop" -> | "busy" -> | "resize_vertical" -> | "resize_horizontal" -> | "resize_edge_vertical" -> | "resize_edge_horizontal" -> | "resize_edge_diagonal_left" -> | "resize_edge_diagonal_right" -> | "extend_left" -> | "extend_right" -> | "extend_top" -> | "extend_bottom" -> | "extend_left_alias" -> | "extend_right_alias" -> | "extend_top_alias" -> | "extend_bottom_alias" -> | "zoom_vertical" -> | "zoom_horizontal" -> | "zoom" -> ``` - -### ViewDimension -[`string`](../../API/builtins/string.md) | [`integer`](../../API/builtins/integer.md) -> The dimensions of a view has to be larger than 0. -> For nested views you can also specify relative size -> for example `vb:text { width = "80%"}`. The percentage values are -> relative to the view's parent size and will automatically update on size changes. - -### ViewId -[`string`](../../API/builtins/string.md) -> Unique identifier to resolve the view later on in the viewbuilder, -> e.g. `vb.views.SomeString` or `vb.views["Some String"]` -> View ids must be unique within a single view builder instance. - -### ViewOrigin -{ 1 : [`ViewPosition`](#ViewPosition), 2 : [`ViewPosition`](#ViewPosition) } | { x : [`ViewPosition`](#ViewPosition), y : [`ViewPosition`](#ViewPosition) } -> The position of a view within its parent view. -> Only the `stack` layouts allows to freely position child views. Other -> layout views will automatically set the origin, but the origin -> then still can be read in for example mouse handlers. - -### ViewPosition -[`integer`](../../API/builtins/integer.md) -> Horizontal (x) or Vertical (y) position of a view within its parent view. - -### ViewSize -{ 1 : [`ViewDimension`](#ViewDimension), 2 : [`ViewDimension`](#ViewDimension) } | { height : [`ViewDimension`](#ViewDimension), width : [`ViewDimension`](#ViewDimension) } -> The dimensions of a view has to be larger than 0. -> For nested views you can also specify relative size, for example -> `vb:text { size = { width = "80%", height = 20}}`. -> The percentage values are relative to the view's parent size and will -> automatically update when the parent view's size changes. - -### ViewTooltip -[`string`](../../API/builtins/string.md) -> A ViewTooltip text that should be shown for this view on mouse hover. -> * Default: "" (no tip will be shown) - -### ViewVisibility -[`boolean`](../../API/builtins/boolean.md) -> Set visible to false to hide a view (make it invisible without removing -> it). Please note that view.visible will also return false when any of its -> parents are invisible (when its implicitly invisible). -> * Default: true - - - -# CheckBoxProperties - ---- -## Properties -### bind : [`ViewBooleanObservable`](#ViewBooleanObservable)[`?`](../../API/builtins/nil.md) -> Bind the view's value to a renoise.Document.ObservableBoolean object. -> Automatically keep them in sync. -> The view will change the Observable value as soon as its value changes -> and change the view's value as soon as the Observable's value changes. -> Notifiers can be added to either the view or the Observable object. - -### value : [`CheckBoxBoolean`](#CheckBoxBoolean)[`?`](../../API/builtins/nil.md) -> The current state of the checkbox, expressed as boolean. -> * Default: false - -### notifier : [`CheckBoxBooleanNotifier`](#CheckBoxBooleanNotifier)[`?`](../../API/builtins/nil.md) -> A notifier for when the checkbox is toggled - -### active : [`ControlActive`](#ControlActive)[`?`](../../API/builtins/nil.md) -> Instead of making a control invisible, you can also make it inactive. -> Deactivated controls will still be shown, and will still show their -> currently assigned values, but will not allow changes. Most controls will -> display as "grayed out" to visualize the deactivated state. - -### midi_mapping : [`ControlMidiMappingString`](#ControlMidiMappingString)[`?`](../../API/builtins/nil.md) -> When set, the control will be highlighted when Renoise's MIDI mapping dialog -> is open. When clicked, it selects the specified string as a MIDI mapping -> target action. This target acton can either be one of the globally available -> mappings in Renoise, or those that were created by the tool itself. -> Target strings are not verified. When they point to nothing, the mapped MIDI -> message will do nothing and no error is fired. - -### id : [`ViewId`](#ViewId)[`?`](../../API/builtins/nil.md) -> Unique identifier to resolve the view later on in the viewbuilder, -> e.g. `vb.views.SomeString` or `vb.views["Some String"]` -> View ids must be unique within a single view builder instance. - -### visible : [`ViewVisibility`](#ViewVisibility)[`?`](../../API/builtins/nil.md) -> Set visible to false to hide a view (make it invisible without removing -> it). Please note that view.visible will also return false when any of its -> parents are invisible (when its implicitly invisible). -> * Default: true - -### origin : [`ViewOrigin`](#ViewOrigin)[`?`](../../API/builtins/nil.md) -> The position of a view within its parent view. -> Only the `stack` layouts allows to freely position child views. Other -> layout views will automatically set the origin, but the origin -> then still can be read in for example mouse handlers. - -### width : [`ViewDimension`](#ViewDimension)[`?`](../../API/builtins/nil.md) -> **Deprecated.** Use property `size` instead. - -### height : [`ViewDimension`](#ViewDimension)[`?`](../../API/builtins/nil.md) -> **Deprecated.** Use property `size` instead. - -### size : [`ViewSize`](#ViewSize)[`?`](../../API/builtins/nil.md) -> The dimensions of a view has to be larger than 0. -> For nested views you can also specify relative size, for example -> `vb:text { size = { width = "80%", height = 20}}`. -> The percentage values are relative to the view's parent size and will -> automatically update when the parent view's size changes. - -### tooltip : [`ViewTooltip`](#ViewTooltip)[`?`](../../API/builtins/nil.md) -> A ViewTooltip text that should be shown for this view on mouse hover. -> * Default: "" (no tip will be shown) - -### cursor : [`ViewCursorShape`](#ViewCursorShape)[`?`](../../API/builtins/nil.md) -> The cursor cursor for this view which apears on mouse hover. -> Using a "none" shape will use use underlying view's cursor or the default cursor. - - - - - ---- -## Aliases -### BooleanValueNotifierFunction -(value : [`boolean`](../../API/builtins/boolean.md)) - - -### BooleanValueNotifierMemberFunction -(self : [`NotifierMemberContext`](#NotifierMemberContext), value : [`boolean`](../../API/builtins/boolean.md)) - - -### BooleanValueNotifierMethod1 -{ 1 : [`NotifierMemberContext`](#NotifierMemberContext), 2 : [`BooleanValueNotifierMemberFunction`](#BooleanValueNotifierMemberFunction) } - - -### BooleanValueNotifierMethod2 -{ 1 : [`BooleanValueNotifierMemberFunction`](#BooleanValueNotifierMemberFunction), 2 : [`NotifierMemberContext`](#NotifierMemberContext) } - - -### CheckBoxBoolean -[`boolean`](../../API/builtins/boolean.md) -> The current state of the checkbox, expressed as boolean. -> * Default: false - -### CheckBoxBooleanNotifier -[`BooleanValueNotifierFunction`](#BooleanValueNotifierFunction) | [`BooleanValueNotifierMethod1`](#BooleanValueNotifierMethod1) | [`BooleanValueNotifierMethod2`](#BooleanValueNotifierMethod2) -> A notifier for when the checkbox is toggled - -### ControlActive -[`boolean`](../../API/builtins/boolean.md) -> Instead of making a control invisible, you can also make it inactive. -> Deactivated controls will still be shown, and will still show their -> currently assigned values, but will not allow changes. Most controls will -> display as "grayed out" to visualize the deactivated state. - -### ControlMidiMappingString -[`string`](../../API/builtins/string.md) -> When set, the control will be highlighted when Renoise's MIDI mapping dialog -> is open. When clicked, it selects the specified string as a MIDI mapping -> target action. This target acton can either be one of the globally available -> mappings in Renoise, or those that were created by the tool itself. -> Target strings are not verified. When they point to nothing, the mapped MIDI -> message will do nothing and no error is fired. - -### NotifierFunction -fun() - - -### NotifierMemberContext -[`table`](../../API/builtins/table.md) | [`userdata`](../../API/builtins/userdata.md) - - -### ViewBooleanObservable -[`renoise.Document.ObservableBoolean`](../../API/renoise/renoise.Document.ObservableBoolean.md) -> Bind the view's value to a renoise.Document.ObservableBoolean object. -> Automatically keep them in sync. -> The view will change the Observable value as soon as its value changes -> and change the view's value as soon as the Observable's value changes. -> Notifiers can be added to either the view or the Observable object. - -### ViewCursorShape -`"busy"` | `"change_value"` | `"crosshair"` | `"default"` | `"drag"` | `"drop"` | `"edit_text"` | `"empty"` | `"erase"` | `"extend_bottom"` | `"extend_bottom_alias"` | `"extend_left"` | `"extend_left_alias"` | `"extend_right"` | `"extend_right_alias"` | `"extend_top"` | `"extend_top_alias"` | `"marker"` | `"move"` | `"nodrop"` | `"none"` | `"pencil"` | `"play"` | `"resize_edge_diagonal_left"` | `"resize_edge_diagonal_right"` | `"resize_edge_horizontal"` | `"resize_edge_vertical"` | `"resize_horizontal"` | `"resize_vertical"` | `"zoom"` | `"zoom_horizontal"` | `"zoom_vertical"` -> ```lua -> -- The cursor cursor for this view which apears on mouse hover. -> -- Using a "none" shape will use use underlying view's cursor or the default cursor. -> ViewCursorShape: -> | "none" -> | "empty" -> | "default" -> | "change_value" -> | "edit_text" -> | "pencil" -> | "marker" -> | "crosshair" -> | "move" -> | "erase" -> | "play" -> | "drag" -> | "drop" -> | "nodrop" -> | "busy" -> | "resize_vertical" -> | "resize_horizontal" -> | "resize_edge_vertical" -> | "resize_edge_horizontal" -> | "resize_edge_diagonal_left" -> | "resize_edge_diagonal_right" -> | "extend_left" -> | "extend_right" -> | "extend_top" -> | "extend_bottom" -> | "extend_left_alias" -> | "extend_right_alias" -> | "extend_top_alias" -> | "extend_bottom_alias" -> | "zoom_vertical" -> | "zoom_horizontal" -> | "zoom" -> ``` - -### ViewDimension -[`string`](../../API/builtins/string.md) | [`integer`](../../API/builtins/integer.md) -> The dimensions of a view has to be larger than 0. -> For nested views you can also specify relative size -> for example `vb:text { width = "80%"}`. The percentage values are -> relative to the view's parent size and will automatically update on size changes. - -### ViewId -[`string`](../../API/builtins/string.md) -> Unique identifier to resolve the view later on in the viewbuilder, -> e.g. `vb.views.SomeString` or `vb.views["Some String"]` -> View ids must be unique within a single view builder instance. - -### ViewOrigin -{ 1 : [`ViewPosition`](#ViewPosition), 2 : [`ViewPosition`](#ViewPosition) } | { x : [`ViewPosition`](#ViewPosition), y : [`ViewPosition`](#ViewPosition) } -> The position of a view within its parent view. -> Only the `stack` layouts allows to freely position child views. Other -> layout views will automatically set the origin, but the origin -> then still can be read in for example mouse handlers. - -### ViewPosition -[`integer`](../../API/builtins/integer.md) -> Horizontal (x) or Vertical (y) position of a view within its parent view. - -### ViewSize -{ 1 : [`ViewDimension`](#ViewDimension), 2 : [`ViewDimension`](#ViewDimension) } | { height : [`ViewDimension`](#ViewDimension), width : [`ViewDimension`](#ViewDimension) } -> The dimensions of a view has to be larger than 0. -> For nested views you can also specify relative size, for example -> `vb:text { size = { width = "80%", height = 20}}`. -> The percentage values are relative to the view's parent size and will -> automatically update when the parent view's size changes. - -### ViewTooltip -[`string`](../../API/builtins/string.md) -> A ViewTooltip text that should be shown for this view on mouse hover. -> * Default: "" (no tip will be shown) - -### ViewVisibility -[`boolean`](../../API/builtins/boolean.md) -> Set visible to false to hide a view (make it invisible without removing -> it). Please note that view.visible will also return false when any of its -> parents are invisible (when its implicitly invisible). -> * Default: true - - - -# ChooserProperties - ---- -## Properties -### bind : [`ViewNumberObservable`](#ViewNumberObservable)[`?`](../../API/builtins/nil.md) -> Bind the view's value to a renoise.Document.ObservableNumber object. -> Automatically keep them in sync. -> The view will change the Observable value as soon as its value changes -> and change the view's value as soon as the Observable's value changes. -> Notifiers can be added to either the view or the Observable object. - -### value : [`SelectedItem`](#SelectedItem)[`?`](../../API/builtins/nil.md) -> The currently selected item's index - -### notifier : [`IntegerNotifier`](#IntegerNotifier)[`?`](../../API/builtins/nil.md) -> Set up a notifier that will be called whenever a new item is picked - -### items : [`ItemLabels`](#ItemLabels)[`?`](../../API/builtins/nil.md) -> A list of buttons labels to show in order. Must have more than one item. - -### active : [`ControlActive`](#ControlActive)[`?`](../../API/builtins/nil.md) -> Instead of making a control invisible, you can also make it inactive. -> Deactivated controls will still be shown, and will still show their -> currently assigned values, but will not allow changes. Most controls will -> display as "grayed out" to visualize the deactivated state. - -### midi_mapping : [`ControlMidiMappingString`](#ControlMidiMappingString)[`?`](../../API/builtins/nil.md) -> When set, the control will be highlighted when Renoise's MIDI mapping dialog -> is open. When clicked, it selects the specified string as a MIDI mapping -> target action. This target acton can either be one of the globally available -> mappings in Renoise, or those that were created by the tool itself. -> Target strings are not verified. When they point to nothing, the mapped MIDI -> message will do nothing and no error is fired. - -### id : [`ViewId`](#ViewId)[`?`](../../API/builtins/nil.md) -> Unique identifier to resolve the view later on in the viewbuilder, -> e.g. `vb.views.SomeString` or `vb.views["Some String"]` -> View ids must be unique within a single view builder instance. - -### visible : [`ViewVisibility`](#ViewVisibility)[`?`](../../API/builtins/nil.md) -> Set visible to false to hide a view (make it invisible without removing -> it). Please note that view.visible will also return false when any of its -> parents are invisible (when its implicitly invisible). -> * Default: true - -### origin : [`ViewOrigin`](#ViewOrigin)[`?`](../../API/builtins/nil.md) -> The position of a view within its parent view. -> Only the `stack` layouts allows to freely position child views. Other -> layout views will automatically set the origin, but the origin -> then still can be read in for example mouse handlers. - -### width : [`ViewDimension`](#ViewDimension)[`?`](../../API/builtins/nil.md) -> **Deprecated.** Use property `size` instead. - -### height : [`ViewDimension`](#ViewDimension)[`?`](../../API/builtins/nil.md) -> **Deprecated.** Use property `size` instead. - -### size : [`ViewSize`](#ViewSize)[`?`](../../API/builtins/nil.md) -> The dimensions of a view has to be larger than 0. -> For nested views you can also specify relative size, for example -> `vb:text { size = { width = "80%", height = 20}}`. -> The percentage values are relative to the view's parent size and will -> automatically update when the parent view's size changes. - -### tooltip : [`ViewTooltip`](#ViewTooltip)[`?`](../../API/builtins/nil.md) -> A ViewTooltip text that should be shown for this view on mouse hover. -> * Default: "" (no tip will be shown) - -### cursor : [`ViewCursorShape`](#ViewCursorShape)[`?`](../../API/builtins/nil.md) -> The cursor cursor for this view which apears on mouse hover. -> Using a "none" shape will use use underlying view's cursor or the default cursor. - - - - - ---- -## Aliases -### ControlActive -[`boolean`](../../API/builtins/boolean.md) -> Instead of making a control invisible, you can also make it inactive. -> Deactivated controls will still be shown, and will still show their -> currently assigned values, but will not allow changes. Most controls will -> display as "grayed out" to visualize the deactivated state. - -### ControlMidiMappingString -[`string`](../../API/builtins/string.md) -> When set, the control will be highlighted when Renoise's MIDI mapping dialog -> is open. When clicked, it selects the specified string as a MIDI mapping -> target action. This target acton can either be one of the globally available -> mappings in Renoise, or those that were created by the tool itself. -> Target strings are not verified. When they point to nothing, the mapped MIDI -> message will do nothing and no error is fired. - -### IntegerNotifier -[`IntegerValueNotifierFunction`](#IntegerValueNotifierFunction) | [`IntegerValueNotifierMethod1`](#IntegerValueNotifierMethod1) | [`IntegerValueNotifierMethod2`](#IntegerValueNotifierMethod2) -> Set up a notifier that will be called whenever a new item is picked - -### IntegerValueNotifierFunction -(value : [`integer`](../../API/builtins/integer.md)) - - -### IntegerValueNotifierMemberFunction -(self : [`NotifierMemberContext`](#NotifierMemberContext), value : [`integer`](../../API/builtins/integer.md)) - - -### IntegerValueNotifierMethod1 -{ 1 : [`NotifierMemberContext`](#NotifierMemberContext), 2 : [`IntegerValueNotifierMemberFunction`](#IntegerValueNotifierMemberFunction) } - - -### IntegerValueNotifierMethod2 -{ 1 : [`IntegerValueNotifierMemberFunction`](#IntegerValueNotifierMemberFunction), 2 : [`NotifierMemberContext`](#NotifierMemberContext) } - - -### ItemLabels -[`string`](../../API/builtins/string.md)[] -> A list of buttons labels to show in order. Must have more than one item. - -### NotifierFunction -fun() - - -### NotifierMemberContext -[`table`](../../API/builtins/table.md) | [`userdata`](../../API/builtins/userdata.md) - - -### SelectedItem -[`integer`](../../API/builtins/integer.md) -> The currently selected item's index - -### ViewCursorShape -`"busy"` | `"change_value"` | `"crosshair"` | `"default"` | `"drag"` | `"drop"` | `"edit_text"` | `"empty"` | `"erase"` | `"extend_bottom"` | `"extend_bottom_alias"` | `"extend_left"` | `"extend_left_alias"` | `"extend_right"` | `"extend_right_alias"` | `"extend_top"` | `"extend_top_alias"` | `"marker"` | `"move"` | `"nodrop"` | `"none"` | `"pencil"` | `"play"` | `"resize_edge_diagonal_left"` | `"resize_edge_diagonal_right"` | `"resize_edge_horizontal"` | `"resize_edge_vertical"` | `"resize_horizontal"` | `"resize_vertical"` | `"zoom"` | `"zoom_horizontal"` | `"zoom_vertical"` -> ```lua -> -- The cursor cursor for this view which apears on mouse hover. -> -- Using a "none" shape will use use underlying view's cursor or the default cursor. -> ViewCursorShape: -> | "none" -> | "empty" -> | "default" -> | "change_value" -> | "edit_text" -> | "pencil" -> | "marker" -> | "crosshair" -> | "move" -> | "erase" -> | "play" -> | "drag" -> | "drop" -> | "nodrop" -> | "busy" -> | "resize_vertical" -> | "resize_horizontal" -> | "resize_edge_vertical" -> | "resize_edge_horizontal" -> | "resize_edge_diagonal_left" -> | "resize_edge_diagonal_right" -> | "extend_left" -> | "extend_right" -> | "extend_top" -> | "extend_bottom" -> | "extend_left_alias" -> | "extend_right_alias" -> | "extend_top_alias" -> | "extend_bottom_alias" -> | "zoom_vertical" -> | "zoom_horizontal" -> | "zoom" -> ``` - -### ViewDimension -[`string`](../../API/builtins/string.md) | [`integer`](../../API/builtins/integer.md) -> The dimensions of a view has to be larger than 0. -> For nested views you can also specify relative size -> for example `vb:text { width = "80%"}`. The percentage values are -> relative to the view's parent size and will automatically update on size changes. - -### ViewId -[`string`](../../API/builtins/string.md) -> Unique identifier to resolve the view later on in the viewbuilder, -> e.g. `vb.views.SomeString` or `vb.views["Some String"]` -> View ids must be unique within a single view builder instance. - -### ViewNumberObservable -[`renoise.Document.ObservableNumber`](../../API/renoise/renoise.Document.ObservableNumber.md) -> Bind the view's value to a renoise.Document.ObservableNumber object. -> Automatically keep them in sync. -> The view will change the Observable value as soon as its value changes -> and change the view's value as soon as the Observable's value changes. -> Notifiers can be added to either the view or the Observable object. - -### ViewOrigin -{ 1 : [`ViewPosition`](#ViewPosition), 2 : [`ViewPosition`](#ViewPosition) } | { x : [`ViewPosition`](#ViewPosition), y : [`ViewPosition`](#ViewPosition) } -> The position of a view within its parent view. -> Only the `stack` layouts allows to freely position child views. Other -> layout views will automatically set the origin, but the origin -> then still can be read in for example mouse handlers. - -### ViewPosition -[`integer`](../../API/builtins/integer.md) -> Horizontal (x) or Vertical (y) position of a view within its parent view. - -### ViewSize -{ 1 : [`ViewDimension`](#ViewDimension), 2 : [`ViewDimension`](#ViewDimension) } | { height : [`ViewDimension`](#ViewDimension), width : [`ViewDimension`](#ViewDimension) } -> The dimensions of a view has to be larger than 0. -> For nested views you can also specify relative size, for example -> `vb:text { size = { width = "80%", height = 20}}`. -> The percentage values are relative to the view's parent size and will -> automatically update when the parent view's size changes. - -### ViewTooltip -[`string`](../../API/builtins/string.md) -> A ViewTooltip text that should be shown for this view on mouse hover. -> * Default: "" (no tip will be shown) - -### ViewVisibility -[`boolean`](../../API/builtins/boolean.md) -> Set visible to false to hide a view (make it invisible without removing -> it). Please note that view.visible will also return false when any of its -> parents are invisible (when its implicitly invisible). -> * Default: true - - - -# MiniSliderProperties - ---- -## Properties -### active : [`ControlActive`](#ControlActive)[`?`](../../API/builtins/nil.md) -> Instead of making a control invisible, you can also make it inactive. -> Deactivated controls will still be shown, and will still show their -> currently assigned values, but will not allow changes. Most controls will -> display as "grayed out" to visualize the deactivated state. - -### midi_mapping : [`ControlMidiMappingString`](#ControlMidiMappingString)[`?`](../../API/builtins/nil.md) -> When set, the control will be highlighted when Renoise's MIDI mapping dialog -> is open. When clicked, it selects the specified string as a MIDI mapping -> target action. This target acton can either be one of the globally available -> mappings in Renoise, or those that were created by the tool itself. -> Target strings are not verified. When they point to nothing, the mapped MIDI -> message will do nothing and no error is fired. - -### bind : [`ViewNumberObservable`](#ViewNumberObservable)[`?`](../../API/builtins/nil.md) -> Bind the view's value to a renoise.Document.ObservableNumber object. -> Automatically keep them in sync. -> The view will change the Observable value as soon as its value changes -> and change the view's value as soon as the Observable's value changes. -> Notifiers can be added to either the view or the Observable object. - -### value : [`SliderNumberValue`](#SliderNumberValue)[`?`](../../API/builtins/nil.md) -> The current value of the view - -### notifier : [`NumberValueNotifier`](#NumberValueNotifier)[`?`](../../API/builtins/nil.md) -> Set up a value notifier that will be called whenever the value changes - -### polarity : [`SliderPolarity`](#SliderPolarity)[`?`](../../API/builtins/nil.md) -> Value polarity of the control. Bipolar controls show the value from the -> center to left and right or up and down and typically controls a range -> around zero, e.g. -1 to 1. Unipolar controls show the value from left to -> right or bottom to top. -> * Default: "unipolar" - -### min : [`SliderMinValue`](#SliderMinValue)[`?`](../../API/builtins/nil.md) -> The minimum value that can be set using the view -> * Default: 0 - -### max : [`SliderMaxValue`](#SliderMaxValue)[`?`](../../API/builtins/nil.md) -> The maximum value that can be set using the view -> * Default: 1.0 - -### default : [`SliderDefaultValue`](#SliderDefaultValue)[`?`](../../API/builtins/nil.md) -> The default value that will be re-applied on double-click - -### id : [`ViewId`](#ViewId)[`?`](../../API/builtins/nil.md) -> Unique identifier to resolve the view later on in the viewbuilder, -> e.g. `vb.views.SomeString` or `vb.views["Some String"]` -> View ids must be unique within a single view builder instance. - -### visible : [`ViewVisibility`](#ViewVisibility)[`?`](../../API/builtins/nil.md) -> Set visible to false to hide a view (make it invisible without removing -> it). Please note that view.visible will also return false when any of its -> parents are invisible (when its implicitly invisible). -> * Default: true - -### origin : [`ViewOrigin`](#ViewOrigin)[`?`](../../API/builtins/nil.md) -> The position of a view within its parent view. -> Only the `stack` layouts allows to freely position child views. Other -> layout views will automatically set the origin, but the origin -> then still can be read in for example mouse handlers. - -### width : [`ViewDimension`](#ViewDimension)[`?`](../../API/builtins/nil.md) -> **Deprecated.** Use property `size` instead. - -### height : [`ViewDimension`](#ViewDimension)[`?`](../../API/builtins/nil.md) -> **Deprecated.** Use property `size` instead. - -### size : [`ViewSize`](#ViewSize)[`?`](../../API/builtins/nil.md) -> The dimensions of a view has to be larger than 0. -> For nested views you can also specify relative size, for example -> `vb:text { size = { width = "80%", height = 20}}`. -> The percentage values are relative to the view's parent size and will -> automatically update when the parent view's size changes. - -### tooltip : [`ViewTooltip`](#ViewTooltip)[`?`](../../API/builtins/nil.md) -> A ViewTooltip text that should be shown for this view on mouse hover. -> * Default: "" (no tip will be shown) - -### cursor : [`ViewCursorShape`](#ViewCursorShape)[`?`](../../API/builtins/nil.md) -> The cursor cursor for this view which apears on mouse hover. -> Using a "none" shape will use use underlying view's cursor or the default cursor. - - - - - ---- -## Aliases -### ControlActive -[`boolean`](../../API/builtins/boolean.md) -> Instead of making a control invisible, you can also make it inactive. -> Deactivated controls will still be shown, and will still show their -> currently assigned values, but will not allow changes. Most controls will -> display as "grayed out" to visualize the deactivated state. - -### ControlMidiMappingString -[`string`](../../API/builtins/string.md) -> When set, the control will be highlighted when Renoise's MIDI mapping dialog -> is open. When clicked, it selects the specified string as a MIDI mapping -> target action. This target acton can either be one of the globally available -> mappings in Renoise, or those that were created by the tool itself. -> Target strings are not verified. When they point to nothing, the mapped MIDI -> message will do nothing and no error is fired. - -### NotifierFunction -fun() - - -### NotifierMemberContext -[`table`](../../API/builtins/table.md) | [`userdata`](../../API/builtins/userdata.md) - - -### NumberValueNotifier -[`NumberValueNotifierFunction`](#NumberValueNotifierFunction) | [`NumberValueNotifierMethod1`](#NumberValueNotifierMethod1) | [`NumberValueNotifierMethod2`](#NumberValueNotifierMethod2) -> Set up a value notifier that will be called whenever the value changes - -### NumberValueNotifierFunction -(value : [`number`](../../API/builtins/number.md)) - - -### NumberValueNotifierMemberFunction -(self : [`NotifierMemberContext`](#NotifierMemberContext), value : [`number`](../../API/builtins/number.md)) - - -### NumberValueNotifierMethod1 -{ 1 : [`NotifierMemberContext`](#NotifierMemberContext), 2 : [`NumberValueNotifierMemberFunction`](#NumberValueNotifierMemberFunction) } - - -### NumberValueNotifierMethod2 -{ 1 : [`NumberValueNotifierMemberFunction`](#NumberValueNotifierMemberFunction), 2 : [`NotifierMemberContext`](#NotifierMemberContext) } - - -### SliderDefaultValue -[`number`](../../API/builtins/number.md) -> The default value that will be re-applied on double-click - -### SliderMaxValue -[`number`](../../API/builtins/number.md) -> The maximum value that can be set using the view -> * Default: 1.0 - -### SliderMinValue -[`number`](../../API/builtins/number.md) -> The minimum value that can be set using the view -> * Default: 0 - -### SliderNumberValue -[`number`](../../API/builtins/number.md) -> The current value of the view - -### SliderPolarity -`"bipolar"` | `"unipolar"` -> ```lua -> -- Value polarity of the control. Bipolar controls show the value from the -> -- center to left and right or up and down and typically controls a range -> -- around zero, e.g. -1 to 1. Unipolar controls show the value from left to -> -- right or bottom to top. -> -- * Default: "unipolar" -> SliderPolarity: -> | "unipolar" -> | "bipolar" -> ``` - -### ViewCursorShape -`"busy"` | `"change_value"` | `"crosshair"` | `"default"` | `"drag"` | `"drop"` | `"edit_text"` | `"empty"` | `"erase"` | `"extend_bottom"` | `"extend_bottom_alias"` | `"extend_left"` | `"extend_left_alias"` | `"extend_right"` | `"extend_right_alias"` | `"extend_top"` | `"extend_top_alias"` | `"marker"` | `"move"` | `"nodrop"` | `"none"` | `"pencil"` | `"play"` | `"resize_edge_diagonal_left"` | `"resize_edge_diagonal_right"` | `"resize_edge_horizontal"` | `"resize_edge_vertical"` | `"resize_horizontal"` | `"resize_vertical"` | `"zoom"` | `"zoom_horizontal"` | `"zoom_vertical"` -> ```lua -> -- The cursor cursor for this view which apears on mouse hover. -> -- Using a "none" shape will use use underlying view's cursor or the default cursor. -> ViewCursorShape: -> | "none" -> | "empty" -> | "default" -> | "change_value" -> | "edit_text" -> | "pencil" -> | "marker" -> | "crosshair" -> | "move" -> | "erase" -> | "play" -> | "drag" -> | "drop" -> | "nodrop" -> | "busy" -> | "resize_vertical" -> | "resize_horizontal" -> | "resize_edge_vertical" -> | "resize_edge_horizontal" -> | "resize_edge_diagonal_left" -> | "resize_edge_diagonal_right" -> | "extend_left" -> | "extend_right" -> | "extend_top" -> | "extend_bottom" -> | "extend_left_alias" -> | "extend_right_alias" -> | "extend_top_alias" -> | "extend_bottom_alias" -> | "zoom_vertical" -> | "zoom_horizontal" -> | "zoom" -> ``` - -### ViewDimension -[`string`](../../API/builtins/string.md) | [`integer`](../../API/builtins/integer.md) -> The dimensions of a view has to be larger than 0. -> For nested views you can also specify relative size -> for example `vb:text { width = "80%"}`. The percentage values are -> relative to the view's parent size and will automatically update on size changes. - -### ViewId -[`string`](../../API/builtins/string.md) -> Unique identifier to resolve the view later on in the viewbuilder, -> e.g. `vb.views.SomeString` or `vb.views["Some String"]` -> View ids must be unique within a single view builder instance. - -### ViewNumberObservable -[`renoise.Document.ObservableNumber`](../../API/renoise/renoise.Document.ObservableNumber.md) -> Bind the view's value to a renoise.Document.ObservableNumber object. -> Automatically keep them in sync. -> The view will change the Observable value as soon as its value changes -> and change the view's value as soon as the Observable's value changes. -> Notifiers can be added to either the view or the Observable object. - -### ViewOrigin -{ 1 : [`ViewPosition`](#ViewPosition), 2 : [`ViewPosition`](#ViewPosition) } | { x : [`ViewPosition`](#ViewPosition), y : [`ViewPosition`](#ViewPosition) } -> The position of a view within its parent view. -> Only the `stack` layouts allows to freely position child views. Other -> layout views will automatically set the origin, but the origin -> then still can be read in for example mouse handlers. - -### ViewPosition -[`integer`](../../API/builtins/integer.md) -> Horizontal (x) or Vertical (y) position of a view within its parent view. - -### ViewSize -{ 1 : [`ViewDimension`](#ViewDimension), 2 : [`ViewDimension`](#ViewDimension) } | { height : [`ViewDimension`](#ViewDimension), width : [`ViewDimension`](#ViewDimension) } -> The dimensions of a view has to be larger than 0. -> For nested views you can also specify relative size, for example -> `vb:text { size = { width = "80%", height = 20}}`. -> The percentage values are relative to the view's parent size and will -> automatically update when the parent view's size changes. - -### ViewTooltip -[`string`](../../API/builtins/string.md) -> A ViewTooltip text that should be shown for this view on mouse hover. -> * Default: "" (no tip will be shown) - -### ViewVisibility -[`boolean`](../../API/builtins/boolean.md) -> Set visible to false to hide a view (make it invisible without removing -> it). Please note that view.visible will also return false when any of its -> parents are invisible (when its implicitly invisible). -> * Default: true - - - -# MouseEvent -> Mouse event as passed to a layout view's "mouse_handler" function. - ---- -## Properties -### type : [`MouseEventType`](#MouseEventType) -> Mouse event type. Only enabled types are passed to the handler. - -### button : [`MouseEventButton`](#MouseEventButton)[`?`](../../API/builtins/nil.md) -> For "up"|"down"|"double"|"drag" events, the mouse button which got pressed, -> nil for all other events. - -### direction : [`MouseEventWheelDirection`](#MouseEventWheelDirection)[`?`](../../API/builtins/nil.md) -> For "wheel" events, the wheel's direction, nil for all other events. - -### position : { x : [`number`](../../API/builtins/number.md), y : [`number`](../../API/builtins/number.md) } -> Mouse cursor position in relative coordinates to the layout. - -### modifier_flags : { alt : [`boolean`](../../API/builtins/boolean.md), control : [`boolean`](../../API/builtins/boolean.md), meta : [`boolean`](../../API/builtins/boolean.md), shift : [`boolean`](../../API/builtins/boolean.md) } -> Currently pressed (held down) keyboard modifier buttons. - -### button_flags : { left : [`boolean`](../../API/builtins/boolean.md), middle : [`boolean`](../../API/builtins/boolean.md), right : [`boolean`](../../API/builtins/boolean.md) } -> Currently pressed (held down) mouse buttons. - -### hover_views : { id : [`string`](../../API/builtins/string.md), view : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md) }[] -> List of sub views and possible layout subview's subviews, that are located below -> the mouse cursor. In other words: all views that are located below the mouse cursor. -> The list is orderd by containing the top-most visible view first, so you usually will -> need to check the first table entry only. -> -> NB: Only views that got created with the same view builder instance as the layout, -> and only subviews with valid viewbuilder "id"s will show up here! - - - - - ---- -## Aliases -### MouseEventButton -`"left"` | `"middle"` | `"right"` -> ```lua -> -- Mouse button of a `MouseEvent` of type "up"|"down"|"double"|"drag". -> MouseEventButton: -> | "left" -> | "right" -> | "middle" -> ``` - -### MouseEventType -`"double"` | `"down"` | `"drag"` | `"enter"` | `"exit"` | `"move"` | `"up"` | `"wheel"` -> ```lua -> -- Event type of a `MouseEvent`. -> MouseEventType: -> | "enter" -> | "exit" -> | "move" -> | "down" -> | "up" -> | "double" -> | "drag" -> | "wheel" -> ``` - -### MouseEventWheelDirection -`"down"` | `"left"` | `"right"` | `"up"` -> ```lua -> -- Mouse wheel direction in a `MouseEvent` of type "wheel". -> MouseEventWheelDirection: -> | "up" -> | "down" -> | "left" -> | "right" -> ``` - - - -# MultilineTextFieldProperties - ---- -## Properties -### bind : [`ViewStringListObservable`](#ViewStringListObservable)[`?`](../../API/builtins/nil.md) -> Bind the view's value to a renoise.Document.ObservableStringList object. -> Automatically keep them in sync. -> The view will change the Observable value as soon as its value changes -> and change the view's value as soon as the Observable's value changes. -> Notifiers can be added to either the view or the Observable object. - -### active : [`TextActive`](#TextActive)[`?`](../../API/builtins/nil.md) -> When false, text is displayed but can not be entered/modified by the user. -> * Default: true - -### value : [`TextMultilineString`](#TextMultilineString)[`?`](../../API/builtins/nil.md) -> The text that should be displayed. -> Newlines (Windows, Mac or Unix styled) in the text can be used to create -> paragraphs. - -### notifier : [`StringChangeNotifier`](#StringChangeNotifier)[`?`](../../API/builtins/nil.md) -> Set up a notifier for text changes - -### text : [`TextValueAlias`](#TextValueAlias)[`?`](../../API/builtins/nil.md) -> Exactly the same as "value"; provided for consistency. -> * Default: "" - -### paragraphs : [`TextParagraphs`](#TextParagraphs)[`?`](../../API/builtins/nil.md) -> A table of text lines to be used instead of specifying a single text -> line with newline characters like "text" -> * Default: [] - -### font : [`TextFontStyle`](#TextFontStyle)[`?`](../../API/builtins/nil.md) -> The style that the text should be displayed with. - -### style : [`TextBackgroundStyle`](#TextBackgroundStyle)[`?`](../../API/builtins/nil.md) -> Setup the text view's background: - -### edit_mode : [`TextEditMode`](#TextEditMode)[`?`](../../API/builtins/nil.md) -> True when the text field is focused. setting it at run-time programmatically -> will focus the text field or remove the focus (focus the dialog) accordingly. -> * Default: false - -### id : [`ViewId`](#ViewId)[`?`](../../API/builtins/nil.md) -> Unique identifier to resolve the view later on in the viewbuilder, -> e.g. `vb.views.SomeString` or `vb.views["Some String"]` -> View ids must be unique within a single view builder instance. - -### visible : [`ViewVisibility`](#ViewVisibility)[`?`](../../API/builtins/nil.md) -> Set visible to false to hide a view (make it invisible without removing -> it). Please note that view.visible will also return false when any of its -> parents are invisible (when its implicitly invisible). -> * Default: true - -### origin : [`ViewOrigin`](#ViewOrigin)[`?`](../../API/builtins/nil.md) -> The position of a view within its parent view. -> Only the `stack` layouts allows to freely position child views. Other -> layout views will automatically set the origin, but the origin -> then still can be read in for example mouse handlers. - -### width : [`ViewDimension`](#ViewDimension)[`?`](../../API/builtins/nil.md) -> **Deprecated.** Use property `size` instead. - -### height : [`ViewDimension`](#ViewDimension)[`?`](../../API/builtins/nil.md) -> **Deprecated.** Use property `size` instead. - -### size : [`ViewSize`](#ViewSize)[`?`](../../API/builtins/nil.md) -> The dimensions of a view has to be larger than 0. -> For nested views you can also specify relative size, for example -> `vb:text { size = { width = "80%", height = 20}}`. -> The percentage values are relative to the view's parent size and will -> automatically update when the parent view's size changes. - -### tooltip : [`ViewTooltip`](#ViewTooltip)[`?`](../../API/builtins/nil.md) -> A ViewTooltip text that should be shown for this view on mouse hover. -> * Default: "" (no tip will be shown) - -### cursor : [`ViewCursorShape`](#ViewCursorShape)[`?`](../../API/builtins/nil.md) -> The cursor cursor for this view which apears on mouse hover. -> Using a "none" shape will use use underlying view's cursor or the default cursor. - - - - - ---- -## Aliases -### ListElementAdded -{ index : [`integer`](../../API/builtins/integer.md), type : `"insert"` } - - -### ListElementChange -[`ListElementAdded`](#ListElementAdded) | [`ListElementRemoved`](#ListElementRemoved) | [`ListElementsSwapped`](#ListElementsSwapped) - - -### ListElementRemoved -{ index : [`integer`](../../API/builtins/integer.md), type : `"remove"` } - - -### ListElementsSwapped -{ index1 : [`integer`](../../API/builtins/integer.md), index2 : [`integer`](../../API/builtins/integer.md), type : `"swap"` } - - -### ListNotifierFunction -(change : [`ListElementChange`](#ListElementChange)) - - -### ListNotifierMemberContext -[`table`](../../API/builtins/table.md) | [`userdata`](../../API/builtins/userdata.md) - - -### NotifierMemberContext -[`table`](../../API/builtins/table.md) | [`userdata`](../../API/builtins/userdata.md) - - -### StringChangeNotifier -[`StringValueNotifierFunction`](#StringValueNotifierFunction) | [`StringValueNotifierMethod1`](#StringValueNotifierMethod1) | [`StringValueNotifierMethod2`](#StringValueNotifierMethod2) -> Set up a notifier for text changes - -### StringValueNotifierFunction -(value : [`string`](../../API/builtins/string.md)) - - -### StringValueNotifierMemberFunction -(self : [`NotifierMemberContext`](#NotifierMemberContext), value : [`string`](../../API/builtins/string.md)) - - -### StringValueNotifierMethod1 -{ 1 : [`NotifierMemberContext`](#NotifierMemberContext), 2 : [`StringValueNotifierMemberFunction`](#StringValueNotifierMemberFunction) } - - -### StringValueNotifierMethod2 -{ 1 : [`StringValueNotifierMemberFunction`](#StringValueNotifierMemberFunction), 2 : [`NotifierMemberContext`](#NotifierMemberContext) } - - -### TextActive -[`boolean`](../../API/builtins/boolean.md) -> When false, text is displayed but can not be entered/modified by the user. -> * Default: true - -### TextBackgroundStyle -`"body"` | `"border"` | `"strong"` -> ```lua -> -- Setup the text view's background: -> TextBackgroundStyle: -> | "body" -- simple text color with no background -> | "strong" -- stronger text color with no background -> | "border" -- text on a bordered background -> ``` - -### TextEditMode -[`boolean`](../../API/builtins/boolean.md) -> True when the text field is focused. setting it at run-time programmatically -> will focus the text field or remove the focus (focus the dialog) accordingly. -> * Default: false - -### TextFontStyle -`"big"` | `"bold"` | `"code"` | `"italic"` | `"mono"` | `"normal"` -> ```lua -> -- The style that the text should be displayed with. -> TextFontStyle: -> | "normal" -- (Default) -> | "big" -- big text -> | "bold" -- bold font -> | "italic" -- italic font -> | "mono" -- monospace font -> | "code" -- monospace code font -> ``` - -### TextMultilineString -[`string`](../../API/builtins/string.md) -> The text that should be displayed. -> Newlines (Windows, Mac or Unix styled) in the text can be used to create -> paragraphs. - -### TextParagraphs -[`string`](../../API/builtins/string.md)[] -> A table of text lines to be used instead of specifying a single text -> line with newline characters like "text" -> * Default: [] - -### TextValueAlias -[`string`](../../API/builtins/string.md) -> Exactly the same as "value"; provided for consistency. -> * Default: "" - -### ViewCursorShape -`"busy"` | `"change_value"` | `"crosshair"` | `"default"` | `"drag"` | `"drop"` | `"edit_text"` | `"empty"` | `"erase"` | `"extend_bottom"` | `"extend_bottom_alias"` | `"extend_left"` | `"extend_left_alias"` | `"extend_right"` | `"extend_right_alias"` | `"extend_top"` | `"extend_top_alias"` | `"marker"` | `"move"` | `"nodrop"` | `"none"` | `"pencil"` | `"play"` | `"resize_edge_diagonal_left"` | `"resize_edge_diagonal_right"` | `"resize_edge_horizontal"` | `"resize_edge_vertical"` | `"resize_horizontal"` | `"resize_vertical"` | `"zoom"` | `"zoom_horizontal"` | `"zoom_vertical"` -> ```lua -> -- The cursor cursor for this view which apears on mouse hover. -> -- Using a "none" shape will use use underlying view's cursor or the default cursor. -> ViewCursorShape: -> | "none" -> | "empty" -> | "default" -> | "change_value" -> | "edit_text" -> | "pencil" -> | "marker" -> | "crosshair" -> | "move" -> | "erase" -> | "play" -> | "drag" -> | "drop" -> | "nodrop" -> | "busy" -> | "resize_vertical" -> | "resize_horizontal" -> | "resize_edge_vertical" -> | "resize_edge_horizontal" -> | "resize_edge_diagonal_left" -> | "resize_edge_diagonal_right" -> | "extend_left" -> | "extend_right" -> | "extend_top" -> | "extend_bottom" -> | "extend_left_alias" -> | "extend_right_alias" -> | "extend_top_alias" -> | "extend_bottom_alias" -> | "zoom_vertical" -> | "zoom_horizontal" -> | "zoom" -> ``` - -### ViewDimension -[`string`](../../API/builtins/string.md) | [`integer`](../../API/builtins/integer.md) -> The dimensions of a view has to be larger than 0. -> For nested views you can also specify relative size -> for example `vb:text { width = "80%"}`. The percentage values are -> relative to the view's parent size and will automatically update on size changes. - -### ViewId -[`string`](../../API/builtins/string.md) -> Unique identifier to resolve the view later on in the viewbuilder, -> e.g. `vb.views.SomeString` or `vb.views["Some String"]` -> View ids must be unique within a single view builder instance. - -### ViewOrigin -{ 1 : [`ViewPosition`](#ViewPosition), 2 : [`ViewPosition`](#ViewPosition) } | { x : [`ViewPosition`](#ViewPosition), y : [`ViewPosition`](#ViewPosition) } -> The position of a view within its parent view. -> Only the `stack` layouts allows to freely position child views. Other -> layout views will automatically set the origin, but the origin -> then still can be read in for example mouse handlers. - -### ViewPosition -[`integer`](../../API/builtins/integer.md) -> Horizontal (x) or Vertical (y) position of a view within its parent view. - -### ViewSize -{ 1 : [`ViewDimension`](#ViewDimension), 2 : [`ViewDimension`](#ViewDimension) } | { height : [`ViewDimension`](#ViewDimension), width : [`ViewDimension`](#ViewDimension) } -> The dimensions of a view has to be larger than 0. -> For nested views you can also specify relative size, for example -> `vb:text { size = { width = "80%", height = 20}}`. -> The percentage values are relative to the view's parent size and will -> automatically update when the parent view's size changes. - -### ViewStringListObservable -[`renoise.Document.ObservableStringList`](../../API/renoise/renoise.Document.ObservableStringList.md) -> Bind the view's value to a renoise.Document.ObservableStringList object. -> Automatically keep them in sync. -> The view will change the Observable value as soon as its value changes -> and change the view's value as soon as the Observable's value changes. -> Notifiers can be added to either the view or the Observable object. - -### ViewTooltip -[`string`](../../API/builtins/string.md) -> A ViewTooltip text that should be shown for this view on mouse hover. -> * Default: "" (no tip will be shown) - -### ViewVisibility -[`boolean`](../../API/builtins/boolean.md) -> Set visible to false to hide a view (make it invisible without removing -> it). Please note that view.visible will also return false when any of its -> parents are invisible (when its implicitly invisible). -> * Default: true - - - -# MultilineTextViewProperties - ---- -## Properties -### text : [`TextMultilineString`](#TextMultilineString)[`?`](../../API/builtins/nil.md) -> The text that should be displayed. -> Newlines (Windows, Mac or Unix styled) in the text can be used to create -> paragraphs. - -### paragraphs : [`TextParagraphs`](#TextParagraphs)[`?`](../../API/builtins/nil.md) -> A table of text lines to be used instead of specifying a single text -> line with newline characters like "text" -> * Default: [] - -### font : [`TextFontStyle`](#TextFontStyle)[`?`](../../API/builtins/nil.md) -> The style that the text should be displayed with. - -### style : [`TextBackgroundStyle`](#TextBackgroundStyle)[`?`](../../API/builtins/nil.md) -> Setup the text view's background: - -### id : [`ViewId`](#ViewId)[`?`](../../API/builtins/nil.md) -> Unique identifier to resolve the view later on in the viewbuilder, -> e.g. `vb.views.SomeString` or `vb.views["Some String"]` -> View ids must be unique within a single view builder instance. - -### visible : [`ViewVisibility`](#ViewVisibility)[`?`](../../API/builtins/nil.md) -> Set visible to false to hide a view (make it invisible without removing -> it). Please note that view.visible will also return false when any of its -> parents are invisible (when its implicitly invisible). -> * Default: true - -### origin : [`ViewOrigin`](#ViewOrigin)[`?`](../../API/builtins/nil.md) -> The position of a view within its parent view. -> Only the `stack` layouts allows to freely position child views. Other -> layout views will automatically set the origin, but the origin -> then still can be read in for example mouse handlers. - -### width : [`ViewDimension`](#ViewDimension)[`?`](../../API/builtins/nil.md) -> **Deprecated.** Use property `size` instead. - -### height : [`ViewDimension`](#ViewDimension)[`?`](../../API/builtins/nil.md) -> **Deprecated.** Use property `size` instead. - -### size : [`ViewSize`](#ViewSize)[`?`](../../API/builtins/nil.md) -> The dimensions of a view has to be larger than 0. -> For nested views you can also specify relative size, for example -> `vb:text { size = { width = "80%", height = 20}}`. -> The percentage values are relative to the view's parent size and will -> automatically update when the parent view's size changes. - -### tooltip : [`ViewTooltip`](#ViewTooltip)[`?`](../../API/builtins/nil.md) -> A ViewTooltip text that should be shown for this view on mouse hover. -> * Default: "" (no tip will be shown) - -### cursor : [`ViewCursorShape`](#ViewCursorShape)[`?`](../../API/builtins/nil.md) -> The cursor cursor for this view which apears on mouse hover. -> Using a "none" shape will use use underlying view's cursor or the default cursor. - - - - - ---- -## Aliases -### TextBackgroundStyle -`"body"` | `"border"` | `"strong"` -> ```lua -> -- Setup the text view's background: -> TextBackgroundStyle: -> | "body" -- simple text color with no background -> | "strong" -- stronger text color with no background -> | "border" -- text on a bordered background -> ``` - -### TextFontStyle -`"big"` | `"bold"` | `"code"` | `"italic"` | `"mono"` | `"normal"` -> ```lua -> -- The style that the text should be displayed with. -> TextFontStyle: -> | "normal" -- (Default) -> | "big" -- big text -> | "bold" -- bold font -> | "italic" -- italic font -> | "mono" -- monospace font -> | "code" -- monospace code font -> ``` - -### TextMultilineString -[`string`](../../API/builtins/string.md) -> The text that should be displayed. -> Newlines (Windows, Mac or Unix styled) in the text can be used to create -> paragraphs. - -### TextParagraphs -[`string`](../../API/builtins/string.md)[] -> A table of text lines to be used instead of specifying a single text -> line with newline characters like "text" -> * Default: [] - -### ViewCursorShape -`"busy"` | `"change_value"` | `"crosshair"` | `"default"` | `"drag"` | `"drop"` | `"edit_text"` | `"empty"` | `"erase"` | `"extend_bottom"` | `"extend_bottom_alias"` | `"extend_left"` | `"extend_left_alias"` | `"extend_right"` | `"extend_right_alias"` | `"extend_top"` | `"extend_top_alias"` | `"marker"` | `"move"` | `"nodrop"` | `"none"` | `"pencil"` | `"play"` | `"resize_edge_diagonal_left"` | `"resize_edge_diagonal_right"` | `"resize_edge_horizontal"` | `"resize_edge_vertical"` | `"resize_horizontal"` | `"resize_vertical"` | `"zoom"` | `"zoom_horizontal"` | `"zoom_vertical"` -> ```lua -> -- The cursor cursor for this view which apears on mouse hover. -> -- Using a "none" shape will use use underlying view's cursor or the default cursor. -> ViewCursorShape: -> | "none" -> | "empty" -> | "default" -> | "change_value" -> | "edit_text" -> | "pencil" -> | "marker" -> | "crosshair" -> | "move" -> | "erase" -> | "play" -> | "drag" -> | "drop" -> | "nodrop" -> | "busy" -> | "resize_vertical" -> | "resize_horizontal" -> | "resize_edge_vertical" -> | "resize_edge_horizontal" -> | "resize_edge_diagonal_left" -> | "resize_edge_diagonal_right" -> | "extend_left" -> | "extend_right" -> | "extend_top" -> | "extend_bottom" -> | "extend_left_alias" -> | "extend_right_alias" -> | "extend_top_alias" -> | "extend_bottom_alias" -> | "zoom_vertical" -> | "zoom_horizontal" -> | "zoom" -> ``` - -### ViewDimension -[`string`](../../API/builtins/string.md) | [`integer`](../../API/builtins/integer.md) -> The dimensions of a view has to be larger than 0. -> For nested views you can also specify relative size -> for example `vb:text { width = "80%"}`. The percentage values are -> relative to the view's parent size and will automatically update on size changes. - -### ViewId -[`string`](../../API/builtins/string.md) -> Unique identifier to resolve the view later on in the viewbuilder, -> e.g. `vb.views.SomeString` or `vb.views["Some String"]` -> View ids must be unique within a single view builder instance. - -### ViewOrigin -{ 1 : [`ViewPosition`](#ViewPosition), 2 : [`ViewPosition`](#ViewPosition) } | { x : [`ViewPosition`](#ViewPosition), y : [`ViewPosition`](#ViewPosition) } -> The position of a view within its parent view. -> Only the `stack` layouts allows to freely position child views. Other -> layout views will automatically set the origin, but the origin -> then still can be read in for example mouse handlers. - -### ViewPosition -[`integer`](../../API/builtins/integer.md) -> Horizontal (x) or Vertical (y) position of a view within its parent view. - -### ViewSize -{ 1 : [`ViewDimension`](#ViewDimension), 2 : [`ViewDimension`](#ViewDimension) } | { height : [`ViewDimension`](#ViewDimension), width : [`ViewDimension`](#ViewDimension) } -> The dimensions of a view has to be larger than 0. -> For nested views you can also specify relative size, for example -> `vb:text { size = { width = "80%", height = 20}}`. -> The percentage values are relative to the view's parent size and will -> automatically update when the parent view's size changes. - -### ViewTooltip -[`string`](../../API/builtins/string.md) -> A ViewTooltip text that should be shown for this view on mouse hover. -> * Default: "" (no tip will be shown) - -### ViewVisibility -[`boolean`](../../API/builtins/boolean.md) -> Set visible to false to hide a view (make it invisible without removing -> it). Please note that view.visible will also return false when any of its -> parents are invisible (when its implicitly invisible). -> * Default: true - - - -# PopUpMenuProperties - ---- -## Properties -### active : [`ControlActive`](#ControlActive)[`?`](../../API/builtins/nil.md) -> Instead of making a control invisible, you can also make it inactive. -> Deactivated controls will still be shown, and will still show their -> currently assigned values, but will not allow changes. Most controls will -> display as "grayed out" to visualize the deactivated state. - -### midi_mapping : [`ControlMidiMappingString`](#ControlMidiMappingString)[`?`](../../API/builtins/nil.md) -> When set, the control will be highlighted when Renoise's MIDI mapping dialog -> is open. When clicked, it selects the specified string as a MIDI mapping -> target action. This target acton can either be one of the globally available -> mappings in Renoise, or those that were created by the tool itself. -> Target strings are not verified. When they point to nothing, the mapped MIDI -> message will do nothing and no error is fired. - -### bind : [`ViewNumberObservable`](#ViewNumberObservable)[`?`](../../API/builtins/nil.md) -> Bind the view's value to a renoise.Document.ObservableNumber object. -> Automatically keep them in sync. -> The view will change the Observable value as soon as its value changes -> and change the view's value as soon as the Observable's value changes. -> Notifiers can be added to either the view or the Observable object. - -### value : [`SelectedItem`](#SelectedItem)[`?`](../../API/builtins/nil.md) -> The currently selected item's index - -### notifier : [`IntegerNotifier`](#IntegerNotifier)[`?`](../../API/builtins/nil.md) -> Set up a notifier that will be called whenever a new item is picked - -### items : [`PopupItemLabels`](#PopupItemLabels)[`?`](../../API/builtins/nil.md) -> A list of buttons labels to show in order -> The list can be empty, then "None" is displayed and the value won't change. - -### id : [`ViewId`](#ViewId)[`?`](../../API/builtins/nil.md) -> Unique identifier to resolve the view later on in the viewbuilder, -> e.g. `vb.views.SomeString` or `vb.views["Some String"]` -> View ids must be unique within a single view builder instance. - -### visible : [`ViewVisibility`](#ViewVisibility)[`?`](../../API/builtins/nil.md) -> Set visible to false to hide a view (make it invisible without removing -> it). Please note that view.visible will also return false when any of its -> parents are invisible (when its implicitly invisible). -> * Default: true - -### origin : [`ViewOrigin`](#ViewOrigin)[`?`](../../API/builtins/nil.md) -> The position of a view within its parent view. -> Only the `stack` layouts allows to freely position child views. Other -> layout views will automatically set the origin, but the origin -> then still can be read in for example mouse handlers. - -### width : [`ViewDimension`](#ViewDimension)[`?`](../../API/builtins/nil.md) -> **Deprecated.** Use property `size` instead. - -### height : [`ViewDimension`](#ViewDimension)[`?`](../../API/builtins/nil.md) -> **Deprecated.** Use property `size` instead. - -### size : [`ViewSize`](#ViewSize)[`?`](../../API/builtins/nil.md) -> The dimensions of a view has to be larger than 0. -> For nested views you can also specify relative size, for example -> `vb:text { size = { width = "80%", height = 20}}`. -> The percentage values are relative to the view's parent size and will -> automatically update when the parent view's size changes. - -### tooltip : [`ViewTooltip`](#ViewTooltip)[`?`](../../API/builtins/nil.md) -> A ViewTooltip text that should be shown for this view on mouse hover. -> * Default: "" (no tip will be shown) - -### cursor : [`ViewCursorShape`](#ViewCursorShape)[`?`](../../API/builtins/nil.md) -> The cursor cursor for this view which apears on mouse hover. -> Using a "none" shape will use use underlying view's cursor or the default cursor. - - - - - ---- -## Aliases -### ControlActive -[`boolean`](../../API/builtins/boolean.md) -> Instead of making a control invisible, you can also make it inactive. -> Deactivated controls will still be shown, and will still show their -> currently assigned values, but will not allow changes. Most controls will -> display as "grayed out" to visualize the deactivated state. - -### ControlMidiMappingString -[`string`](../../API/builtins/string.md) -> When set, the control will be highlighted when Renoise's MIDI mapping dialog -> is open. When clicked, it selects the specified string as a MIDI mapping -> target action. This target acton can either be one of the globally available -> mappings in Renoise, or those that were created by the tool itself. -> Target strings are not verified. When they point to nothing, the mapped MIDI -> message will do nothing and no error is fired. - -### IntegerNotifier -[`IntegerValueNotifierFunction`](#IntegerValueNotifierFunction) | [`IntegerValueNotifierMethod1`](#IntegerValueNotifierMethod1) | [`IntegerValueNotifierMethod2`](#IntegerValueNotifierMethod2) -> Set up a notifier that will be called whenever a new item is picked - -### IntegerValueNotifierFunction -(value : [`integer`](../../API/builtins/integer.md)) - - -### IntegerValueNotifierMemberFunction -(self : [`NotifierMemberContext`](#NotifierMemberContext), value : [`integer`](../../API/builtins/integer.md)) - - -### IntegerValueNotifierMethod1 -{ 1 : [`NotifierMemberContext`](#NotifierMemberContext), 2 : [`IntegerValueNotifierMemberFunction`](#IntegerValueNotifierMemberFunction) } - - -### IntegerValueNotifierMethod2 -{ 1 : [`IntegerValueNotifierMemberFunction`](#IntegerValueNotifierMemberFunction), 2 : [`NotifierMemberContext`](#NotifierMemberContext) } - - -### NotifierFunction -fun() - - -### NotifierMemberContext -[`table`](../../API/builtins/table.md) | [`userdata`](../../API/builtins/userdata.md) - - -### PopupItemLabels -[`string`](../../API/builtins/string.md)[] -> A list of buttons labels to show in order -> The list can be empty, then "None" is displayed and the value won't change. - -### SelectedItem -[`integer`](../../API/builtins/integer.md) -> The currently selected item's index - -### ViewCursorShape -`"busy"` | `"change_value"` | `"crosshair"` | `"default"` | `"drag"` | `"drop"` | `"edit_text"` | `"empty"` | `"erase"` | `"extend_bottom"` | `"extend_bottom_alias"` | `"extend_left"` | `"extend_left_alias"` | `"extend_right"` | `"extend_right_alias"` | `"extend_top"` | `"extend_top_alias"` | `"marker"` | `"move"` | `"nodrop"` | `"none"` | `"pencil"` | `"play"` | `"resize_edge_diagonal_left"` | `"resize_edge_diagonal_right"` | `"resize_edge_horizontal"` | `"resize_edge_vertical"` | `"resize_horizontal"` | `"resize_vertical"` | `"zoom"` | `"zoom_horizontal"` | `"zoom_vertical"` -> ```lua -> -- The cursor cursor for this view which apears on mouse hover. -> -- Using a "none" shape will use use underlying view's cursor or the default cursor. -> ViewCursorShape: -> | "none" -> | "empty" -> | "default" -> | "change_value" -> | "edit_text" -> | "pencil" -> | "marker" -> | "crosshair" -> | "move" -> | "erase" -> | "play" -> | "drag" -> | "drop" -> | "nodrop" -> | "busy" -> | "resize_vertical" -> | "resize_horizontal" -> | "resize_edge_vertical" -> | "resize_edge_horizontal" -> | "resize_edge_diagonal_left" -> | "resize_edge_diagonal_right" -> | "extend_left" -> | "extend_right" -> | "extend_top" -> | "extend_bottom" -> | "extend_left_alias" -> | "extend_right_alias" -> | "extend_top_alias" -> | "extend_bottom_alias" -> | "zoom_vertical" -> | "zoom_horizontal" -> | "zoom" -> ``` - -### ViewDimension -[`string`](../../API/builtins/string.md) | [`integer`](../../API/builtins/integer.md) -> The dimensions of a view has to be larger than 0. -> For nested views you can also specify relative size -> for example `vb:text { width = "80%"}`. The percentage values are -> relative to the view's parent size and will automatically update on size changes. - -### ViewId -[`string`](../../API/builtins/string.md) -> Unique identifier to resolve the view later on in the viewbuilder, -> e.g. `vb.views.SomeString` or `vb.views["Some String"]` -> View ids must be unique within a single view builder instance. - -### ViewNumberObservable -[`renoise.Document.ObservableNumber`](../../API/renoise/renoise.Document.ObservableNumber.md) -> Bind the view's value to a renoise.Document.ObservableNumber object. -> Automatically keep them in sync. -> The view will change the Observable value as soon as its value changes -> and change the view's value as soon as the Observable's value changes. -> Notifiers can be added to either the view or the Observable object. - -### ViewOrigin -{ 1 : [`ViewPosition`](#ViewPosition), 2 : [`ViewPosition`](#ViewPosition) } | { x : [`ViewPosition`](#ViewPosition), y : [`ViewPosition`](#ViewPosition) } -> The position of a view within its parent view. -> Only the `stack` layouts allows to freely position child views. Other -> layout views will automatically set the origin, but the origin -> then still can be read in for example mouse handlers. - -### ViewPosition -[`integer`](../../API/builtins/integer.md) -> Horizontal (x) or Vertical (y) position of a view within its parent view. - -### ViewSize -{ 1 : [`ViewDimension`](#ViewDimension), 2 : [`ViewDimension`](#ViewDimension) } | { height : [`ViewDimension`](#ViewDimension), width : [`ViewDimension`](#ViewDimension) } -> The dimensions of a view has to be larger than 0. -> For nested views you can also specify relative size, for example -> `vb:text { size = { width = "80%", height = 20}}`. -> The percentage values are relative to the view's parent size and will -> automatically update when the parent view's size changes. - -### ViewTooltip -[`string`](../../API/builtins/string.md) -> A ViewTooltip text that should be shown for this view on mouse hover. -> * Default: "" (no tip will be shown) - -### ViewVisibility -[`boolean`](../../API/builtins/boolean.md) -> Set visible to false to hide a view (make it invisible without removing -> it). Please note that view.visible will also return false when any of its -> parents are invisible (when its implicitly invisible). -> * Default: true - - - -# RackViewProperties - ---- -## Properties -### margin : [`RackMargin`](#RackMargin)[`?`](../../API/builtins/nil.md) -> Set the "borders" of a rack (left, right, top and bottom inclusively) -> * Default: 0 (no borders) - -### spacing : [`RackSpacing`](#RackSpacing)[`?`](../../API/builtins/nil.md) -> Set the amount stacked child views are separated by (horizontally in -> rows, vertically in columns). -> * Default: 0 (no spacing) - -### background : [`ViewBackgroundStyle`](#ViewBackgroundStyle)[`?`](../../API/builtins/nil.md) -> Setup a background style for the view. - -### uniform : [`RackUniformity`](#RackUniformity)[`?`](../../API/builtins/nil.md) -> When set to true, all child views in the rack are automatically resized to -> the max size of all child views (width in ViewBuilder.column, height in -> ViewBuilder.row). This can be useful to automatically align all sub -> columns/panels to the same size. Resizing is done automatically, as soon -> as a child view size changes or new children are added. -> * Default: false - -### mouse_handler : [`MouseHandler`](#MouseHandler)[`?`](../../API/builtins/nil.md) -> Optional mouse event handler for a view. return nil when the event got handled -> to stop propagating the event. return the event instance, as passed, to pass it -> to the next view in the view hirarchy. - -### mouse_events : [`MouseEventTypes`](#MouseEventTypes)[`?`](../../API/builtins/nil.md) -> The mouse event types that should be passed to your `mouse_handler` function. -> By default: `{ "down", "up", "double" }` -> Avoid adding event types that you don't use, especially "move" events as they do -> create quite some overhead. Also note that when enabling "drag", sub view controls -> can no longer handle drag events, even when you pass back the event in the handler, -> so only enable it when you want to completely override mouse drag behavior of -> *all* your content views. - -### views : [`RackChildViews`](#RackChildViews)[`?`](../../API/builtins/nil.md) -> The rack view's initial child views. -> Views can later on also be added and removed dynamically after construction via -> `rack:add_view(child)` and `rack:remove_view(child)` - -### style : [`ViewBackgroundStyle`](#ViewBackgroundStyle)[`?`](../../API/builtins/nil.md) -> **Deprecated** Use `background` instead. - -### id : [`ViewId`](#ViewId)[`?`](../../API/builtins/nil.md) -> Unique identifier to resolve the view later on in the viewbuilder, -> e.g. `vb.views.SomeString` or `vb.views["Some String"]` -> View ids must be unique within a single view builder instance. - -### visible : [`ViewVisibility`](#ViewVisibility)[`?`](../../API/builtins/nil.md) -> Set visible to false to hide a view (make it invisible without removing -> it). Please note that view.visible will also return false when any of its -> parents are invisible (when its implicitly invisible). -> * Default: true - -### origin : [`ViewOrigin`](#ViewOrigin)[`?`](../../API/builtins/nil.md) -> The position of a view within its parent view. -> Only the `stack` layouts allows to freely position child views. Other -> layout views will automatically set the origin, but the origin -> then still can be read in for example mouse handlers. - -### width : [`ViewDimension`](#ViewDimension)[`?`](../../API/builtins/nil.md) -> **Deprecated.** Use property `size` instead. - -### height : [`ViewDimension`](#ViewDimension)[`?`](../../API/builtins/nil.md) -> **Deprecated.** Use property `size` instead. - -### size : [`ViewSize`](#ViewSize)[`?`](../../API/builtins/nil.md) -> The dimensions of a view has to be larger than 0. -> For nested views you can also specify relative size, for example -> `vb:text { size = { width = "80%", height = 20}}`. -> The percentage values are relative to the view's parent size and will -> automatically update when the parent view's size changes. - -### tooltip : [`ViewTooltip`](#ViewTooltip)[`?`](../../API/builtins/nil.md) -> A ViewTooltip text that should be shown for this view on mouse hover. -> * Default: "" (no tip will be shown) - -### cursor : [`ViewCursorShape`](#ViewCursorShape)[`?`](../../API/builtins/nil.md) -> The cursor cursor for this view which apears on mouse hover. -> Using a "none" shape will use use underlying view's cursor or the default cursor. - - - - - ---- -## Aliases -### MouseEventButton -`"left"` | `"middle"` | `"right"` -> ```lua -> -- Mouse button of a `MouseEvent` of type "up"|"down"|"double"|"drag". -> MouseEventButton: -> | "left" -> | "right" -> | "middle" -> ``` - -### MouseEventType -`"double"` | `"down"` | `"drag"` | `"enter"` | `"exit"` | `"move"` | `"up"` | `"wheel"` -> ```lua -> -- Event type of a `MouseEvent`. -> MouseEventType: -> | "enter" -> | "exit" -> | "move" -> | "down" -> | "up" -> | "double" -> | "drag" -> | "wheel" -> ``` - -### MouseEventTypes -[`MouseEventType`](#MouseEventType)[] -> The mouse event types that should be passed to your `mouse_handler` function. -> By default: `{ "down", "up", "double" }` -> Avoid adding event types that you don't use, especially "move" events as they do -> create quite some overhead. Also note that when enabling "drag", sub view controls -> can no longer handle drag events, even when you pass back the event in the handler, -> so only enable it when you want to completely override mouse drag behavior of -> *all* your content views. - -### MouseEventWheelDirection -`"down"` | `"left"` | `"right"` | `"up"` -> ```lua -> -- Mouse wheel direction in a `MouseEvent` of type "wheel". -> MouseEventWheelDirection: -> | "up" -> | "down" -> | "left" -> | "right" -> ``` - -### MouseHandler -[`MouseHandlerNotifierFunction`](#MouseHandlerNotifierFunction) | [`MouseHandlerNotifierMethod1`](#MouseHandlerNotifierMethod1) | [`MouseHandlerNotifierMethod2`](#MouseHandlerNotifierMethod2) -> Optional mouse event handler for a view. return nil when the event got handled -> to stop propagating the event. return the event instance, as passed, to pass it -> to the next view in the view hirarchy. - -### MouseHandlerNotifierFunction -(event : [`MouseEvent`](#mouseevent)) `->` [`MouseEvent`](#mouseevent)[`?`](../../API/builtins/nil.md) - - -### MouseHandlerNotifierMemberFunction -(self : [`NotifierMemberContext`](#NotifierMemberContext), event : [`MouseEvent`](#mouseevent)) `->` [`MouseEvent`](#mouseevent)[`?`](../../API/builtins/nil.md) - - -### MouseHandlerNotifierMethod1 -{ 1 : [`NotifierMemberContext`](#NotifierMemberContext), 2 : [`MouseHandlerNotifierMemberFunction`](#MouseHandlerNotifierMemberFunction) } - - -### MouseHandlerNotifierMethod2 -{ 1 : [`MouseHandlerNotifierMemberFunction`](#MouseHandlerNotifierMemberFunction), 2 : [`NotifierMemberContext`](#NotifierMemberContext) } - - -### NotifierMemberContext -[`table`](../../API/builtins/table.md) | [`userdata`](../../API/builtins/userdata.md) - - -### RackChildViews -[`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)[] -> The rack view's initial child views. -> Views can later on also be added and removed dynamically after construction via -> `rack:add_view(child)` and `rack:remove_view(child)` - -### RackMargin -[`integer`](../../API/builtins/integer.md) -> Set the "borders" of a rack (left, right, top and bottom inclusively) -> * Default: 0 (no borders) - -### RackSpacing -[`integer`](../../API/builtins/integer.md) -> Set the amount stacked child views are separated by (horizontally in -> rows, vertically in columns). -> * Default: 0 (no spacing) - -### RackUniformity -[`boolean`](../../API/builtins/boolean.md) -> When set to true, all child views in the rack are automatically resized to -> the max size of all child views (width in ViewBuilder.column, height in -> ViewBuilder.row). This can be useful to automatically align all sub -> columns/panels to the same size. Resizing is done automatically, as soon -> as a child view size changes or new children are added. -> * Default: false - -### ViewBackgroundStyle -`"body"` | `"border"` | `"group"` | `"invisible"` | `"panel"` | `"plain"` -> ```lua -> -- Setup a background style for the view. -> ViewBackgroundStyle: -> | "invisible" -- no background (Default) -> | "plain" -- undecorated, single coloured background -> | "border" -- same as plain, but with a bold nested border -> | "body" -- main "background" style, as used in dialog backgrounds -> | "panel" -- alternative "background" style, beveled -> | "group" -- background for "nested" groups within body -> ``` - -### ViewCursorShape -`"busy"` | `"change_value"` | `"crosshair"` | `"default"` | `"drag"` | `"drop"` | `"edit_text"` | `"empty"` | `"erase"` | `"extend_bottom"` | `"extend_bottom_alias"` | `"extend_left"` | `"extend_left_alias"` | `"extend_right"` | `"extend_right_alias"` | `"extend_top"` | `"extend_top_alias"` | `"marker"` | `"move"` | `"nodrop"` | `"none"` | `"pencil"` | `"play"` | `"resize_edge_diagonal_left"` | `"resize_edge_diagonal_right"` | `"resize_edge_horizontal"` | `"resize_edge_vertical"` | `"resize_horizontal"` | `"resize_vertical"` | `"zoom"` | `"zoom_horizontal"` | `"zoom_vertical"` -> ```lua -> -- The cursor cursor for this view which apears on mouse hover. -> -- Using a "none" shape will use use underlying view's cursor or the default cursor. -> ViewCursorShape: -> | "none" -> | "empty" -> | "default" -> | "change_value" -> | "edit_text" -> | "pencil" -> | "marker" -> | "crosshair" -> | "move" -> | "erase" -> | "play" -> | "drag" -> | "drop" -> | "nodrop" -> | "busy" -> | "resize_vertical" -> | "resize_horizontal" -> | "resize_edge_vertical" -> | "resize_edge_horizontal" -> | "resize_edge_diagonal_left" -> | "resize_edge_diagonal_right" -> | "extend_left" -> | "extend_right" -> | "extend_top" -> | "extend_bottom" -> | "extend_left_alias" -> | "extend_right_alias" -> | "extend_top_alias" -> | "extend_bottom_alias" -> | "zoom_vertical" -> | "zoom_horizontal" -> | "zoom" -> ``` - -### ViewDimension -[`string`](../../API/builtins/string.md) | [`integer`](../../API/builtins/integer.md) -> The dimensions of a view has to be larger than 0. -> For nested views you can also specify relative size -> for example `vb:text { width = "80%"}`. The percentage values are -> relative to the view's parent size and will automatically update on size changes. - -### ViewId -[`string`](../../API/builtins/string.md) -> Unique identifier to resolve the view later on in the viewbuilder, -> e.g. `vb.views.SomeString` or `vb.views["Some String"]` -> View ids must be unique within a single view builder instance. - -### ViewOrigin -{ 1 : [`ViewPosition`](#ViewPosition), 2 : [`ViewPosition`](#ViewPosition) } | { x : [`ViewPosition`](#ViewPosition), y : [`ViewPosition`](#ViewPosition) } -> The position of a view within its parent view. -> Only the `stack` layouts allows to freely position child views. Other -> layout views will automatically set the origin, but the origin -> then still can be read in for example mouse handlers. - -### ViewPosition -[`integer`](../../API/builtins/integer.md) -> Horizontal (x) or Vertical (y) position of a view within its parent view. - -### ViewSize -{ 1 : [`ViewDimension`](#ViewDimension), 2 : [`ViewDimension`](#ViewDimension) } | { height : [`ViewDimension`](#ViewDimension), width : [`ViewDimension`](#ViewDimension) } -> The dimensions of a view has to be larger than 0. -> For nested views you can also specify relative size, for example -> `vb:text { size = { width = "80%", height = 20}}`. -> The percentage values are relative to the view's parent size and will -> automatically update when the parent view's size changes. - -### ViewTooltip -[`string`](../../API/builtins/string.md) -> A ViewTooltip text that should be shown for this view on mouse hover. -> * Default: "" (no tip will be shown) - -### ViewVisibility -[`boolean`](../../API/builtins/boolean.md) -> Set visible to false to hide a view (make it invisible without removing -> it). Please note that view.visible will also return false when any of its -> parents are invisible (when its implicitly invisible). -> * Default: true - - - -# RotaryEncoderProperties - ---- -## Properties -### active : [`ControlActive`](#ControlActive)[`?`](../../API/builtins/nil.md) -> Instead of making a control invisible, you can also make it inactive. -> Deactivated controls will still be shown, and will still show their -> currently assigned values, but will not allow changes. Most controls will -> display as "grayed out" to visualize the deactivated state. - -### midi_mapping : [`ControlMidiMappingString`](#ControlMidiMappingString)[`?`](../../API/builtins/nil.md) -> When set, the control will be highlighted when Renoise's MIDI mapping dialog -> is open. When clicked, it selects the specified string as a MIDI mapping -> target action. This target acton can either be one of the globally available -> mappings in Renoise, or those that were created by the tool itself. -> Target strings are not verified. When they point to nothing, the mapped MIDI -> message will do nothing and no error is fired. - -### bind : [`ViewNumberObservable`](#ViewNumberObservable)[`?`](../../API/builtins/nil.md) -> Bind the view's value to a renoise.Document.ObservableNumber object. -> Automatically keep them in sync. -> The view will change the Observable value as soon as its value changes -> and change the view's value as soon as the Observable's value changes. -> Notifiers can be added to either the view or the Observable object. - -### value : [`SliderNumberValue`](#SliderNumberValue)[`?`](../../API/builtins/nil.md) -> The current value of the view - -### notifier : [`NumberValueNotifier`](#NumberValueNotifier)[`?`](../../API/builtins/nil.md) -> Set up a value notifier that will be called whenever the value changes - -### polarity : [`SliderPolarity`](#SliderPolarity)[`?`](../../API/builtins/nil.md) -> Value polarity of the control. Bipolar controls show the value from the -> center to left and right or up and down and typically controls a range -> around zero, e.g. -1 to 1. Unipolar controls show the value from left to -> right or bottom to top. -> * Default: "unipolar" - -### min : [`SliderMinValue`](#SliderMinValue)[`?`](../../API/builtins/nil.md) -> The minimum value that can be set using the view -> * Default: 0 - -### max : [`SliderMaxValue`](#SliderMaxValue)[`?`](../../API/builtins/nil.md) -> The maximum value that can be set using the view -> * Default: 1.0 - -### default : [`SliderDefaultValue`](#SliderDefaultValue)[`?`](../../API/builtins/nil.md) -> The default value that will be re-applied on double-click - -### id : [`ViewId`](#ViewId)[`?`](../../API/builtins/nil.md) -> Unique identifier to resolve the view later on in the viewbuilder, -> e.g. `vb.views.SomeString` or `vb.views["Some String"]` -> View ids must be unique within a single view builder instance. - -### visible : [`ViewVisibility`](#ViewVisibility)[`?`](../../API/builtins/nil.md) -> Set visible to false to hide a view (make it invisible without removing -> it). Please note that view.visible will also return false when any of its -> parents are invisible (when its implicitly invisible). -> * Default: true - -### origin : [`ViewOrigin`](#ViewOrigin)[`?`](../../API/builtins/nil.md) -> The position of a view within its parent view. -> Only the `stack` layouts allows to freely position child views. Other -> layout views will automatically set the origin, but the origin -> then still can be read in for example mouse handlers. - -### width : [`ViewDimension`](#ViewDimension)[`?`](../../API/builtins/nil.md) -> **Deprecated.** Use property `size` instead. - -### height : [`ViewDimension`](#ViewDimension)[`?`](../../API/builtins/nil.md) -> **Deprecated.** Use property `size` instead. - -### size : [`ViewSize`](#ViewSize)[`?`](../../API/builtins/nil.md) -> The dimensions of a view has to be larger than 0. -> For nested views you can also specify relative size, for example -> `vb:text { size = { width = "80%", height = 20}}`. -> The percentage values are relative to the view's parent size and will -> automatically update when the parent view's size changes. - -### tooltip : [`ViewTooltip`](#ViewTooltip)[`?`](../../API/builtins/nil.md) -> A ViewTooltip text that should be shown for this view on mouse hover. -> * Default: "" (no tip will be shown) - -### cursor : [`ViewCursorShape`](#ViewCursorShape)[`?`](../../API/builtins/nil.md) -> The cursor cursor for this view which apears on mouse hover. -> Using a "none" shape will use use underlying view's cursor or the default cursor. - - - - - ---- -## Aliases -### ControlActive -[`boolean`](../../API/builtins/boolean.md) -> Instead of making a control invisible, you can also make it inactive. -> Deactivated controls will still be shown, and will still show their -> currently assigned values, but will not allow changes. Most controls will -> display as "grayed out" to visualize the deactivated state. - -### ControlMidiMappingString -[`string`](../../API/builtins/string.md) -> When set, the control will be highlighted when Renoise's MIDI mapping dialog -> is open. When clicked, it selects the specified string as a MIDI mapping -> target action. This target acton can either be one of the globally available -> mappings in Renoise, or those that were created by the tool itself. -> Target strings are not verified. When they point to nothing, the mapped MIDI -> message will do nothing and no error is fired. - -### NotifierFunction -fun() - - -### NotifierMemberContext -[`table`](../../API/builtins/table.md) | [`userdata`](../../API/builtins/userdata.md) - - -### NumberValueNotifier -[`NumberValueNotifierFunction`](#NumberValueNotifierFunction) | [`NumberValueNotifierMethod1`](#NumberValueNotifierMethod1) | [`NumberValueNotifierMethod2`](#NumberValueNotifierMethod2) -> Set up a value notifier that will be called whenever the value changes - -### NumberValueNotifierFunction -(value : [`number`](../../API/builtins/number.md)) - - -### NumberValueNotifierMemberFunction -(self : [`NotifierMemberContext`](#NotifierMemberContext), value : [`number`](../../API/builtins/number.md)) - - -### NumberValueNotifierMethod1 -{ 1 : [`NotifierMemberContext`](#NotifierMemberContext), 2 : [`NumberValueNotifierMemberFunction`](#NumberValueNotifierMemberFunction) } - - -### NumberValueNotifierMethod2 -{ 1 : [`NumberValueNotifierMemberFunction`](#NumberValueNotifierMemberFunction), 2 : [`NotifierMemberContext`](#NotifierMemberContext) } - - -### SliderDefaultValue -[`number`](../../API/builtins/number.md) -> The default value that will be re-applied on double-click - -### SliderMaxValue -[`number`](../../API/builtins/number.md) -> The maximum value that can be set using the view -> * Default: 1.0 - -### SliderMinValue -[`number`](../../API/builtins/number.md) -> The minimum value that can be set using the view -> * Default: 0 - -### SliderNumberValue -[`number`](../../API/builtins/number.md) -> The current value of the view - -### SliderPolarity -`"bipolar"` | `"unipolar"` -> ```lua -> -- Value polarity of the control. Bipolar controls show the value from the -> -- center to left and right or up and down and typically controls a range -> -- around zero, e.g. -1 to 1. Unipolar controls show the value from left to -> -- right or bottom to top. -> -- * Default: "unipolar" -> SliderPolarity: -> | "unipolar" -> | "bipolar" -> ``` - -### ViewCursorShape -`"busy"` | `"change_value"` | `"crosshair"` | `"default"` | `"drag"` | `"drop"` | `"edit_text"` | `"empty"` | `"erase"` | `"extend_bottom"` | `"extend_bottom_alias"` | `"extend_left"` | `"extend_left_alias"` | `"extend_right"` | `"extend_right_alias"` | `"extend_top"` | `"extend_top_alias"` | `"marker"` | `"move"` | `"nodrop"` | `"none"` | `"pencil"` | `"play"` | `"resize_edge_diagonal_left"` | `"resize_edge_diagonal_right"` | `"resize_edge_horizontal"` | `"resize_edge_vertical"` | `"resize_horizontal"` | `"resize_vertical"` | `"zoom"` | `"zoom_horizontal"` | `"zoom_vertical"` -> ```lua -> -- The cursor cursor for this view which apears on mouse hover. -> -- Using a "none" shape will use use underlying view's cursor or the default cursor. -> ViewCursorShape: -> | "none" -> | "empty" -> | "default" -> | "change_value" -> | "edit_text" -> | "pencil" -> | "marker" -> | "crosshair" -> | "move" -> | "erase" -> | "play" -> | "drag" -> | "drop" -> | "nodrop" -> | "busy" -> | "resize_vertical" -> | "resize_horizontal" -> | "resize_edge_vertical" -> | "resize_edge_horizontal" -> | "resize_edge_diagonal_left" -> | "resize_edge_diagonal_right" -> | "extend_left" -> | "extend_right" -> | "extend_top" -> | "extend_bottom" -> | "extend_left_alias" -> | "extend_right_alias" -> | "extend_top_alias" -> | "extend_bottom_alias" -> | "zoom_vertical" -> | "zoom_horizontal" -> | "zoom" -> ``` - -### ViewDimension -[`string`](../../API/builtins/string.md) | [`integer`](../../API/builtins/integer.md) -> The dimensions of a view has to be larger than 0. -> For nested views you can also specify relative size -> for example `vb:text { width = "80%"}`. The percentage values are -> relative to the view's parent size and will automatically update on size changes. - -### ViewId -[`string`](../../API/builtins/string.md) -> Unique identifier to resolve the view later on in the viewbuilder, -> e.g. `vb.views.SomeString` or `vb.views["Some String"]` -> View ids must be unique within a single view builder instance. - -### ViewNumberObservable -[`renoise.Document.ObservableNumber`](../../API/renoise/renoise.Document.ObservableNumber.md) -> Bind the view's value to a renoise.Document.ObservableNumber object. -> Automatically keep them in sync. -> The view will change the Observable value as soon as its value changes -> and change the view's value as soon as the Observable's value changes. -> Notifiers can be added to either the view or the Observable object. - -### ViewOrigin -{ 1 : [`ViewPosition`](#ViewPosition), 2 : [`ViewPosition`](#ViewPosition) } | { x : [`ViewPosition`](#ViewPosition), y : [`ViewPosition`](#ViewPosition) } -> The position of a view within its parent view. -> Only the `stack` layouts allows to freely position child views. Other -> layout views will automatically set the origin, but the origin -> then still can be read in for example mouse handlers. - -### ViewPosition -[`integer`](../../API/builtins/integer.md) -> Horizontal (x) or Vertical (y) position of a view within its parent view. - -### ViewSize -{ 1 : [`ViewDimension`](#ViewDimension), 2 : [`ViewDimension`](#ViewDimension) } | { height : [`ViewDimension`](#ViewDimension), width : [`ViewDimension`](#ViewDimension) } -> The dimensions of a view has to be larger than 0. -> For nested views you can also specify relative size, for example -> `vb:text { size = { width = "80%", height = 20}}`. -> The percentage values are relative to the view's parent size and will -> automatically update when the parent view's size changes. - -### ViewTooltip -[`string`](../../API/builtins/string.md) -> A ViewTooltip text that should be shown for this view on mouse hover. -> * Default: "" (no tip will be shown) - -### ViewVisibility -[`boolean`](../../API/builtins/boolean.md) -> Set visible to false to hide a view (make it invisible without removing -> it). Please note that view.visible will also return false when any of its -> parents are invisible (when its implicitly invisible). -> * Default: true - - - -# ScrollBarProperties - ---- -## Properties -### active : [`ControlActive`](#ControlActive)[`?`](../../API/builtins/nil.md) -> Instead of making a control invisible, you can also make it inactive. -> Deactivated controls will still be shown, and will still show their -> currently assigned values, but will not allow changes. Most controls will -> display as "grayed out" to visualize the deactivated state. - -### midi_mapping : [`ControlMidiMappingString`](#ControlMidiMappingString)[`?`](../../API/builtins/nil.md) -> When set, the control will be highlighted when Renoise's MIDI mapping dialog -> is open. When clicked, it selects the specified string as a MIDI mapping -> target action. This target acton can either be one of the globally available -> mappings in Renoise, or those that were created by the tool itself. -> Target strings are not verified. When they point to nothing, the mapped MIDI -> message will do nothing and no error is fired. - -### bind : [`ViewNumberObservable`](#ViewNumberObservable)[`?`](../../API/builtins/nil.md) -> Bind the view's value to a renoise.Document.ObservableNumber object. -> Automatically keep them in sync. -> The view will change the Observable value as soon as its value changes -> and change the view's value as soon as the Observable's value changes. -> Notifiers can be added to either the view or the Observable object. - -### value : [`ScrollbarValue`](#ScrollbarValue)[`?`](../../API/builtins/nil.md) -> Default 0. Offset value in range `min to max - pagestep`. - -### notifier : [`NumberValueNotifier`](#NumberValueNotifier)[`?`](../../API/builtins/nil.md) -> Set up a value notifier that will be called whenever the value changes - -### min : [`ScrollbarMin`](#ScrollbarMin)[`?`](../../API/builtins/nil.md) -> Default 0. Minimum offset value. - -### max : [`ScrollbarMax`](#ScrollbarMax)[`?`](../../API/builtins/nil.md) -> Default 100. Maximum offset value. - -### step : [`ScrollbarStep`](#ScrollbarStep)[`?`](../../API/builtins/nil.md) -> Default 1. Amount the mouse-wheel or additional +/- buttons in the scroll bar -> move the scrollable area. - -### pagestep : [`ScrollbarPagestep`](#ScrollbarPagestep)[`?`](../../API/builtins/nil.md) -> Default 100. Size of the currently visible area. - -### background : [`ViewBackgroundStyle`](#ViewBackgroundStyle)[`?`](../../API/builtins/nil.md) -> Setup a background style for the view. - -### autohide : [`ScrollbarAutoHide`](#ScrollbarAutoHide)[`?`](../../API/builtins/nil.md) -> Default: false. When true, view gets automatically hidden when no scrolling is needed - -### id : [`ViewId`](#ViewId)[`?`](../../API/builtins/nil.md) -> Unique identifier to resolve the view later on in the viewbuilder, -> e.g. `vb.views.SomeString` or `vb.views["Some String"]` -> View ids must be unique within a single view builder instance. - -### visible : [`ViewVisibility`](#ViewVisibility)[`?`](../../API/builtins/nil.md) -> Set visible to false to hide a view (make it invisible without removing -> it). Please note that view.visible will also return false when any of its -> parents are invisible (when its implicitly invisible). -> * Default: true - -### origin : [`ViewOrigin`](#ViewOrigin)[`?`](../../API/builtins/nil.md) -> The position of a view within its parent view. -> Only the `stack` layouts allows to freely position child views. Other -> layout views will automatically set the origin, but the origin -> then still can be read in for example mouse handlers. - -### width : [`ViewDimension`](#ViewDimension)[`?`](../../API/builtins/nil.md) -> **Deprecated.** Use property `size` instead. - -### height : [`ViewDimension`](#ViewDimension)[`?`](../../API/builtins/nil.md) -> **Deprecated.** Use property `size` instead. - -### size : [`ViewSize`](#ViewSize)[`?`](../../API/builtins/nil.md) -> The dimensions of a view has to be larger than 0. -> For nested views you can also specify relative size, for example -> `vb:text { size = { width = "80%", height = 20}}`. -> The percentage values are relative to the view's parent size and will -> automatically update when the parent view's size changes. - -### tooltip : [`ViewTooltip`](#ViewTooltip)[`?`](../../API/builtins/nil.md) -> A ViewTooltip text that should be shown for this view on mouse hover. -> * Default: "" (no tip will be shown) - -### cursor : [`ViewCursorShape`](#ViewCursorShape)[`?`](../../API/builtins/nil.md) -> The cursor cursor for this view which apears on mouse hover. -> Using a "none" shape will use use underlying view's cursor or the default cursor. - - - - - ---- -## Aliases -### ControlActive -[`boolean`](../../API/builtins/boolean.md) -> Instead of making a control invisible, you can also make it inactive. -> Deactivated controls will still be shown, and will still show their -> currently assigned values, but will not allow changes. Most controls will -> display as "grayed out" to visualize the deactivated state. - -### ControlMidiMappingString -[`string`](../../API/builtins/string.md) -> When set, the control will be highlighted when Renoise's MIDI mapping dialog -> is open. When clicked, it selects the specified string as a MIDI mapping -> target action. This target acton can either be one of the globally available -> mappings in Renoise, or those that were created by the tool itself. -> Target strings are not verified. When they point to nothing, the mapped MIDI -> message will do nothing and no error is fired. - -### NotifierFunction -fun() - - -### NotifierMemberContext -[`table`](../../API/builtins/table.md) | [`userdata`](../../API/builtins/userdata.md) - - -### NumberValueNotifier -[`NumberValueNotifierFunction`](#NumberValueNotifierFunction) | [`NumberValueNotifierMethod1`](#NumberValueNotifierMethod1) | [`NumberValueNotifierMethod2`](#NumberValueNotifierMethod2) -> Set up a value notifier that will be called whenever the value changes - -### NumberValueNotifierFunction -(value : [`number`](../../API/builtins/number.md)) - - -### NumberValueNotifierMemberFunction -(self : [`NotifierMemberContext`](#NotifierMemberContext), value : [`number`](../../API/builtins/number.md)) - - -### NumberValueNotifierMethod1 -{ 1 : [`NotifierMemberContext`](#NotifierMemberContext), 2 : [`NumberValueNotifierMemberFunction`](#NumberValueNotifierMemberFunction) } - - -### NumberValueNotifierMethod2 -{ 1 : [`NumberValueNotifierMemberFunction`](#NumberValueNotifierMemberFunction), 2 : [`NotifierMemberContext`](#NotifierMemberContext) } - - -### ScrollbarAutoHide -[`boolean`](../../API/builtins/boolean.md) -> Default: false. When true, view gets automatically hidden when no scrolling is needed - -### ScrollbarMax -[`integer`](../../API/builtins/integer.md) -> Default 100. Maximum offset value. - -### ScrollbarMin -[`integer`](../../API/builtins/integer.md) -> Default 0. Minimum offset value. - -### ScrollbarPagestep -[`integer`](../../API/builtins/integer.md) -> Default 100. Size of the currently visible area. - -### ScrollbarStep -[`integer`](../../API/builtins/integer.md) -> Default 1. Amount the mouse-wheel or additional +/- buttons in the scroll bar -> move the scrollable area. - -### ScrollbarValue -[`integer`](../../API/builtins/integer.md) -> Default 0. Offset value in range `min to max - pagestep`. - -### ViewBackgroundStyle -`"body"` | `"border"` | `"group"` | `"invisible"` | `"panel"` | `"plain"` -> ```lua -> -- Setup a background style for the view. -> ViewBackgroundStyle: -> | "invisible" -- no background (Default) -> | "plain" -- undecorated, single coloured background -> | "border" -- same as plain, but with a bold nested border -> | "body" -- main "background" style, as used in dialog backgrounds -> | "panel" -- alternative "background" style, beveled -> | "group" -- background for "nested" groups within body -> ``` - -### ViewCursorShape -`"busy"` | `"change_value"` | `"crosshair"` | `"default"` | `"drag"` | `"drop"` | `"edit_text"` | `"empty"` | `"erase"` | `"extend_bottom"` | `"extend_bottom_alias"` | `"extend_left"` | `"extend_left_alias"` | `"extend_right"` | `"extend_right_alias"` | `"extend_top"` | `"extend_top_alias"` | `"marker"` | `"move"` | `"nodrop"` | `"none"` | `"pencil"` | `"play"` | `"resize_edge_diagonal_left"` | `"resize_edge_diagonal_right"` | `"resize_edge_horizontal"` | `"resize_edge_vertical"` | `"resize_horizontal"` | `"resize_vertical"` | `"zoom"` | `"zoom_horizontal"` | `"zoom_vertical"` -> ```lua -> -- The cursor cursor for this view which apears on mouse hover. -> -- Using a "none" shape will use use underlying view's cursor or the default cursor. -> ViewCursorShape: -> | "none" -> | "empty" -> | "default" -> | "change_value" -> | "edit_text" -> | "pencil" -> | "marker" -> | "crosshair" -> | "move" -> | "erase" -> | "play" -> | "drag" -> | "drop" -> | "nodrop" -> | "busy" -> | "resize_vertical" -> | "resize_horizontal" -> | "resize_edge_vertical" -> | "resize_edge_horizontal" -> | "resize_edge_diagonal_left" -> | "resize_edge_diagonal_right" -> | "extend_left" -> | "extend_right" -> | "extend_top" -> | "extend_bottom" -> | "extend_left_alias" -> | "extend_right_alias" -> | "extend_top_alias" -> | "extend_bottom_alias" -> | "zoom_vertical" -> | "zoom_horizontal" -> | "zoom" -> ``` - -### ViewDimension -[`string`](../../API/builtins/string.md) | [`integer`](../../API/builtins/integer.md) -> The dimensions of a view has to be larger than 0. -> For nested views you can also specify relative size -> for example `vb:text { width = "80%"}`. The percentage values are -> relative to the view's parent size and will automatically update on size changes. - -### ViewId -[`string`](../../API/builtins/string.md) -> Unique identifier to resolve the view later on in the viewbuilder, -> e.g. `vb.views.SomeString` or `vb.views["Some String"]` -> View ids must be unique within a single view builder instance. - -### ViewNumberObservable -[`renoise.Document.ObservableNumber`](../../API/renoise/renoise.Document.ObservableNumber.md) -> Bind the view's value to a renoise.Document.ObservableNumber object. -> Automatically keep them in sync. -> The view will change the Observable value as soon as its value changes -> and change the view's value as soon as the Observable's value changes. -> Notifiers can be added to either the view or the Observable object. - -### ViewOrigin -{ 1 : [`ViewPosition`](#ViewPosition), 2 : [`ViewPosition`](#ViewPosition) } | { x : [`ViewPosition`](#ViewPosition), y : [`ViewPosition`](#ViewPosition) } -> The position of a view within its parent view. -> Only the `stack` layouts allows to freely position child views. Other -> layout views will automatically set the origin, but the origin -> then still can be read in for example mouse handlers. - -### ViewPosition -[`integer`](../../API/builtins/integer.md) -> Horizontal (x) or Vertical (y) position of a view within its parent view. - -### ViewSize -{ 1 : [`ViewDimension`](#ViewDimension), 2 : [`ViewDimension`](#ViewDimension) } | { height : [`ViewDimension`](#ViewDimension), width : [`ViewDimension`](#ViewDimension) } -> The dimensions of a view has to be larger than 0. -> For nested views you can also specify relative size, for example -> `vb:text { size = { width = "80%", height = 20}}`. -> The percentage values are relative to the view's parent size and will -> automatically update when the parent view's size changes. - -### ViewTooltip -[`string`](../../API/builtins/string.md) -> A ViewTooltip text that should be shown for this view on mouse hover. -> * Default: "" (no tip will be shown) - -### ViewVisibility -[`boolean`](../../API/builtins/boolean.md) -> Set visible to false to hide a view (make it invisible without removing -> it). Please note that view.visible will also return false when any of its -> parents are invisible (when its implicitly invisible). -> * Default: true - - - -# SliderProperties - ---- -## Properties -### active : [`ControlActive`](#ControlActive)[`?`](../../API/builtins/nil.md) -> Instead of making a control invisible, you can also make it inactive. -> Deactivated controls will still be shown, and will still show their -> currently assigned values, but will not allow changes. Most controls will -> display as "grayed out" to visualize the deactivated state. - -### midi_mapping : [`ControlMidiMappingString`](#ControlMidiMappingString)[`?`](../../API/builtins/nil.md) -> When set, the control will be highlighted when Renoise's MIDI mapping dialog -> is open. When clicked, it selects the specified string as a MIDI mapping -> target action. This target acton can either be one of the globally available -> mappings in Renoise, or those that were created by the tool itself. -> Target strings are not verified. When they point to nothing, the mapped MIDI -> message will do nothing and no error is fired. - -### bind : [`ViewNumberObservable`](#ViewNumberObservable)[`?`](../../API/builtins/nil.md) -> Bind the view's value to a renoise.Document.ObservableNumber object. -> Automatically keep them in sync. -> The view will change the Observable value as soon as its value changes -> and change the view's value as soon as the Observable's value changes. -> Notifiers can be added to either the view or the Observable object. - -### value : [`SliderNumberValue`](#SliderNumberValue)[`?`](../../API/builtins/nil.md) -> The current value of the view - -### notifier : [`NumberValueNotifier`](#NumberValueNotifier)[`?`](../../API/builtins/nil.md) -> Set up a value notifier that will be called whenever the value changes - -### polarity : [`SliderPolarity`](#SliderPolarity)[`?`](../../API/builtins/nil.md) -> Value polarity of the control. Bipolar controls show the value from the -> center to left and right or up and down and typically controls a range -> around zero, e.g. -1 to 1. Unipolar controls show the value from left to -> right or bottom to top. -> * Default: "unipolar" - -### min : [`SliderMinValue`](#SliderMinValue)[`?`](../../API/builtins/nil.md) -> The minimum value that can be set using the view -> * Default: 0 - -### max : [`SliderMaxValue`](#SliderMaxValue)[`?`](../../API/builtins/nil.md) -> The maximum value that can be set using the view -> * Default: 1.0 - -### steps : [`SliderStepAmounts`](#SliderStepAmounts)[`?`](../../API/builtins/nil.md) -> A table containing two numbers representing the step amounts for incrementing -> and decrementing by clicking the <> buttons. -> The first value is the small step (applied on left clicks) -> second value is the big step (applied on right clicks) - -### default : [`SliderDefaultValue`](#SliderDefaultValue)[`?`](../../API/builtins/nil.md) -> The default value that will be re-applied on double-click - -### id : [`ViewId`](#ViewId)[`?`](../../API/builtins/nil.md) -> Unique identifier to resolve the view later on in the viewbuilder, -> e.g. `vb.views.SomeString` or `vb.views["Some String"]` -> View ids must be unique within a single view builder instance. - -### visible : [`ViewVisibility`](#ViewVisibility)[`?`](../../API/builtins/nil.md) -> Set visible to false to hide a view (make it invisible without removing -> it). Please note that view.visible will also return false when any of its -> parents are invisible (when its implicitly invisible). -> * Default: true - -### origin : [`ViewOrigin`](#ViewOrigin)[`?`](../../API/builtins/nil.md) -> The position of a view within its parent view. -> Only the `stack` layouts allows to freely position child views. Other -> layout views will automatically set the origin, but the origin -> then still can be read in for example mouse handlers. - -### width : [`ViewDimension`](#ViewDimension)[`?`](../../API/builtins/nil.md) -> **Deprecated.** Use property `size` instead. - -### height : [`ViewDimension`](#ViewDimension)[`?`](../../API/builtins/nil.md) -> **Deprecated.** Use property `size` instead. - -### size : [`ViewSize`](#ViewSize)[`?`](../../API/builtins/nil.md) -> The dimensions of a view has to be larger than 0. -> For nested views you can also specify relative size, for example -> `vb:text { size = { width = "80%", height = 20}}`. -> The percentage values are relative to the view's parent size and will -> automatically update when the parent view's size changes. - -### tooltip : [`ViewTooltip`](#ViewTooltip)[`?`](../../API/builtins/nil.md) -> A ViewTooltip text that should be shown for this view on mouse hover. -> * Default: "" (no tip will be shown) - -### cursor : [`ViewCursorShape`](#ViewCursorShape)[`?`](../../API/builtins/nil.md) -> The cursor cursor for this view which apears on mouse hover. -> Using a "none" shape will use use underlying view's cursor or the default cursor. - - - - - ---- -## Aliases -### ControlActive -[`boolean`](../../API/builtins/boolean.md) -> Instead of making a control invisible, you can also make it inactive. -> Deactivated controls will still be shown, and will still show their -> currently assigned values, but will not allow changes. Most controls will -> display as "grayed out" to visualize the deactivated state. - -### ControlMidiMappingString -[`string`](../../API/builtins/string.md) -> When set, the control will be highlighted when Renoise's MIDI mapping dialog -> is open. When clicked, it selects the specified string as a MIDI mapping -> target action. This target acton can either be one of the globally available -> mappings in Renoise, or those that were created by the tool itself. -> Target strings are not verified. When they point to nothing, the mapped MIDI -> message will do nothing and no error is fired. - -### NotifierFunction -fun() - - -### NotifierMemberContext -[`table`](../../API/builtins/table.md) | [`userdata`](../../API/builtins/userdata.md) - - -### NumberValueNotifier -[`NumberValueNotifierFunction`](#NumberValueNotifierFunction) | [`NumberValueNotifierMethod1`](#NumberValueNotifierMethod1) | [`NumberValueNotifierMethod2`](#NumberValueNotifierMethod2) -> Set up a value notifier that will be called whenever the value changes - -### NumberValueNotifierFunction -(value : [`number`](../../API/builtins/number.md)) - - -### NumberValueNotifierMemberFunction -(self : [`NotifierMemberContext`](#NotifierMemberContext), value : [`number`](../../API/builtins/number.md)) - - -### NumberValueNotifierMethod1 -{ 1 : [`NotifierMemberContext`](#NotifierMemberContext), 2 : [`NumberValueNotifierMemberFunction`](#NumberValueNotifierMemberFunction) } - - -### NumberValueNotifierMethod2 -{ 1 : [`NumberValueNotifierMemberFunction`](#NumberValueNotifierMemberFunction), 2 : [`NotifierMemberContext`](#NotifierMemberContext) } - - -### SliderDefaultValue -[`number`](../../API/builtins/number.md) -> The default value that will be re-applied on double-click - -### SliderMaxValue -[`number`](../../API/builtins/number.md) -> The maximum value that can be set using the view -> * Default: 1.0 - -### SliderMinValue -[`number`](../../API/builtins/number.md) -> The minimum value that can be set using the view -> * Default: 0 - -### SliderNumberValue -[`number`](../../API/builtins/number.md) -> The current value of the view - -### SliderPolarity -`"bipolar"` | `"unipolar"` -> ```lua -> -- Value polarity of the control. Bipolar controls show the value from the -> -- center to left and right or up and down and typically controls a range -> -- around zero, e.g. -1 to 1. Unipolar controls show the value from left to -> -- right or bottom to top. -> -- * Default: "unipolar" -> SliderPolarity: -> | "unipolar" -> | "bipolar" -> ``` - -### SliderStepAmounts -{ 1 : [`number`](../../API/builtins/number.md), 2 : [`number`](../../API/builtins/number.md) } -> A table containing two numbers representing the step amounts for incrementing -> and decrementing by clicking the <> buttons. -> The first value is the small step (applied on left clicks) -> second value is the big step (applied on right clicks) - -### ViewCursorShape -`"busy"` | `"change_value"` | `"crosshair"` | `"default"` | `"drag"` | `"drop"` | `"edit_text"` | `"empty"` | `"erase"` | `"extend_bottom"` | `"extend_bottom_alias"` | `"extend_left"` | `"extend_left_alias"` | `"extend_right"` | `"extend_right_alias"` | `"extend_top"` | `"extend_top_alias"` | `"marker"` | `"move"` | `"nodrop"` | `"none"` | `"pencil"` | `"play"` | `"resize_edge_diagonal_left"` | `"resize_edge_diagonal_right"` | `"resize_edge_horizontal"` | `"resize_edge_vertical"` | `"resize_horizontal"` | `"resize_vertical"` | `"zoom"` | `"zoom_horizontal"` | `"zoom_vertical"` -> ```lua -> -- The cursor cursor for this view which apears on mouse hover. -> -- Using a "none" shape will use use underlying view's cursor or the default cursor. -> ViewCursorShape: -> | "none" -> | "empty" -> | "default" -> | "change_value" -> | "edit_text" -> | "pencil" -> | "marker" -> | "crosshair" -> | "move" -> | "erase" -> | "play" -> | "drag" -> | "drop" -> | "nodrop" -> | "busy" -> | "resize_vertical" -> | "resize_horizontal" -> | "resize_edge_vertical" -> | "resize_edge_horizontal" -> | "resize_edge_diagonal_left" -> | "resize_edge_diagonal_right" -> | "extend_left" -> | "extend_right" -> | "extend_top" -> | "extend_bottom" -> | "extend_left_alias" -> | "extend_right_alias" -> | "extend_top_alias" -> | "extend_bottom_alias" -> | "zoom_vertical" -> | "zoom_horizontal" -> | "zoom" -> ``` - -### ViewDimension -[`string`](../../API/builtins/string.md) | [`integer`](../../API/builtins/integer.md) -> The dimensions of a view has to be larger than 0. -> For nested views you can also specify relative size -> for example `vb:text { width = "80%"}`. The percentage values are -> relative to the view's parent size and will automatically update on size changes. - -### ViewId -[`string`](../../API/builtins/string.md) -> Unique identifier to resolve the view later on in the viewbuilder, -> e.g. `vb.views.SomeString` or `vb.views["Some String"]` -> View ids must be unique within a single view builder instance. - -### ViewNumberObservable -[`renoise.Document.ObservableNumber`](../../API/renoise/renoise.Document.ObservableNumber.md) -> Bind the view's value to a renoise.Document.ObservableNumber object. -> Automatically keep them in sync. -> The view will change the Observable value as soon as its value changes -> and change the view's value as soon as the Observable's value changes. -> Notifiers can be added to either the view or the Observable object. - -### ViewOrigin -{ 1 : [`ViewPosition`](#ViewPosition), 2 : [`ViewPosition`](#ViewPosition) } | { x : [`ViewPosition`](#ViewPosition), y : [`ViewPosition`](#ViewPosition) } -> The position of a view within its parent view. -> Only the `stack` layouts allows to freely position child views. Other -> layout views will automatically set the origin, but the origin -> then still can be read in for example mouse handlers. - -### ViewPosition -[`integer`](../../API/builtins/integer.md) -> Horizontal (x) or Vertical (y) position of a view within its parent view. - -### ViewSize -{ 1 : [`ViewDimension`](#ViewDimension), 2 : [`ViewDimension`](#ViewDimension) } | { height : [`ViewDimension`](#ViewDimension), width : [`ViewDimension`](#ViewDimension) } -> The dimensions of a view has to be larger than 0. -> For nested views you can also specify relative size, for example -> `vb:text { size = { width = "80%", height = 20}}`. -> The percentage values are relative to the view's parent size and will -> automatically update when the parent view's size changes. - -### ViewTooltip -[`string`](../../API/builtins/string.md) -> A ViewTooltip text that should be shown for this view on mouse hover. -> * Default: "" (no tip will be shown) - -### ViewVisibility -[`boolean`](../../API/builtins/boolean.md) -> Set visible to false to hide a view (make it invisible without removing -> it). Please note that view.visible will also return false when any of its -> parents are invisible (when its implicitly invisible). -> * Default: true - - - -# StackViewProperties - ---- -## Properties -### autosize : [`StackAutoSize`](#StackAutoSize)[`?`](../../API/builtins/nil.md) -> When set to true, the width and height of the stack will be automatically -> calculated and updated from the stack's child views, to ensure all views fit -> into the stack. -> When disabled, the width and height must be set manually. -> * Default: true - -### background : [`ViewBackgroundStyle`](#ViewBackgroundStyle)[`?`](../../API/builtins/nil.md) -> Setup a background style for the view. - -### mouse_handler : [`MouseHandler`](#MouseHandler)[`?`](../../API/builtins/nil.md) -> Optional mouse event handler for a view. return nil when the event got handled -> to stop propagating the event. return the event instance, as passed, to pass it -> to the next view in the view hirarchy. - -### mouse_events : [`MouseEventTypes`](#MouseEventTypes)[`?`](../../API/builtins/nil.md) -> The mouse event types that should be passed to your `mouse_handler` function. -> By default: `{ "down", "up", "double" }` -> Avoid adding event types that you don't use, especially "move" events as they do -> create quite some overhead. Also note that when enabling "drag", sub view controls -> can no longer handle drag events, even when you pass back the event in the handler, -> so only enable it when you want to completely override mouse drag behavior of -> *all* your content views. - -### views : [`StackChildViews`](#StackChildViews)[`?`](../../API/builtins/nil.md) -> The stack view's optional child views. -> Views can later on also be added and removed dynamically after construction via -> `stack:add_view(child)` and `stack:remove_view(child)` - -### id : [`ViewId`](#ViewId)[`?`](../../API/builtins/nil.md) -> Unique identifier to resolve the view later on in the viewbuilder, -> e.g. `vb.views.SomeString` or `vb.views["Some String"]` -> View ids must be unique within a single view builder instance. - -### visible : [`ViewVisibility`](#ViewVisibility)[`?`](../../API/builtins/nil.md) -> Set visible to false to hide a view (make it invisible without removing -> it). Please note that view.visible will also return false when any of its -> parents are invisible (when its implicitly invisible). -> * Default: true - -### origin : [`ViewOrigin`](#ViewOrigin)[`?`](../../API/builtins/nil.md) -> The position of a view within its parent view. -> Only the `stack` layouts allows to freely position child views. Other -> layout views will automatically set the origin, but the origin -> then still can be read in for example mouse handlers. - -### width : [`ViewDimension`](#ViewDimension)[`?`](../../API/builtins/nil.md) -> **Deprecated.** Use property `size` instead. - -### height : [`ViewDimension`](#ViewDimension)[`?`](../../API/builtins/nil.md) -> **Deprecated.** Use property `size` instead. - -### size : [`ViewSize`](#ViewSize)[`?`](../../API/builtins/nil.md) -> The dimensions of a view has to be larger than 0. -> For nested views you can also specify relative size, for example -> `vb:text { size = { width = "80%", height = 20}}`. -> The percentage values are relative to the view's parent size and will -> automatically update when the parent view's size changes. - -### tooltip : [`ViewTooltip`](#ViewTooltip)[`?`](../../API/builtins/nil.md) -> A ViewTooltip text that should be shown for this view on mouse hover. -> * Default: "" (no tip will be shown) - -### cursor : [`ViewCursorShape`](#ViewCursorShape)[`?`](../../API/builtins/nil.md) -> The cursor cursor for this view which apears on mouse hover. -> Using a "none" shape will use use underlying view's cursor or the default cursor. - - - - - ---- -## Aliases -### MouseEventButton -`"left"` | `"middle"` | `"right"` -> ```lua -> -- Mouse button of a `MouseEvent` of type "up"|"down"|"double"|"drag". -> MouseEventButton: -> | "left" -> | "right" -> | "middle" -> ``` - -### MouseEventType -`"double"` | `"down"` | `"drag"` | `"enter"` | `"exit"` | `"move"` | `"up"` | `"wheel"` -> ```lua -> -- Event type of a `MouseEvent`. -> MouseEventType: -> | "enter" -> | "exit" -> | "move" -> | "down" -> | "up" -> | "double" -> | "drag" -> | "wheel" -> ``` - -### MouseEventTypes -[`MouseEventType`](#MouseEventType)[] -> The mouse event types that should be passed to your `mouse_handler` function. -> By default: `{ "down", "up", "double" }` -> Avoid adding event types that you don't use, especially "move" events as they do -> create quite some overhead. Also note that when enabling "drag", sub view controls -> can no longer handle drag events, even when you pass back the event in the handler, -> so only enable it when you want to completely override mouse drag behavior of -> *all* your content views. - -### MouseEventWheelDirection -`"down"` | `"left"` | `"right"` | `"up"` -> ```lua -> -- Mouse wheel direction in a `MouseEvent` of type "wheel". -> MouseEventWheelDirection: -> | "up" -> | "down" -> | "left" -> | "right" -> ``` - -### MouseHandler -[`MouseHandlerNotifierFunction`](#MouseHandlerNotifierFunction) | [`MouseHandlerNotifierMethod1`](#MouseHandlerNotifierMethod1) | [`MouseHandlerNotifierMethod2`](#MouseHandlerNotifierMethod2) -> Optional mouse event handler for a view. return nil when the event got handled -> to stop propagating the event. return the event instance, as passed, to pass it -> to the next view in the view hirarchy. - -### MouseHandlerNotifierFunction -(event : [`MouseEvent`](#mouseevent)) `->` [`MouseEvent`](#mouseevent)[`?`](../../API/builtins/nil.md) - - -### MouseHandlerNotifierMemberFunction -(self : [`NotifierMemberContext`](#NotifierMemberContext), event : [`MouseEvent`](#mouseevent)) `->` [`MouseEvent`](#mouseevent)[`?`](../../API/builtins/nil.md) - - -### MouseHandlerNotifierMethod1 -{ 1 : [`NotifierMemberContext`](#NotifierMemberContext), 2 : [`MouseHandlerNotifierMemberFunction`](#MouseHandlerNotifierMemberFunction) } - - -### MouseHandlerNotifierMethod2 -{ 1 : [`MouseHandlerNotifierMemberFunction`](#MouseHandlerNotifierMemberFunction), 2 : [`NotifierMemberContext`](#NotifierMemberContext) } - - -### NotifierMemberContext -[`table`](../../API/builtins/table.md) | [`userdata`](../../API/builtins/userdata.md) - - -### StackAutoSize -[`boolean`](../../API/builtins/boolean.md) -> When set to true, the width and height of the stack will be automatically -> calculated and updated from the stack's child views, to ensure all views fit -> into the stack. -> When disabled, the width and height must be set manually. -> * Default: true - -### StackChildViews -[`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)[] -> The stack view's optional child views. -> Views can later on also be added and removed dynamically after construction via -> `stack:add_view(child)` and `stack:remove_view(child)` - -### ViewBackgroundStyle -`"body"` | `"border"` | `"group"` | `"invisible"` | `"panel"` | `"plain"` -> ```lua -> -- Setup a background style for the view. -> ViewBackgroundStyle: -> | "invisible" -- no background (Default) -> | "plain" -- undecorated, single coloured background -> | "border" -- same as plain, but with a bold nested border -> | "body" -- main "background" style, as used in dialog backgrounds -> | "panel" -- alternative "background" style, beveled -> | "group" -- background for "nested" groups within body -> ``` - -### ViewCursorShape -`"busy"` | `"change_value"` | `"crosshair"` | `"default"` | `"drag"` | `"drop"` | `"edit_text"` | `"empty"` | `"erase"` | `"extend_bottom"` | `"extend_bottom_alias"` | `"extend_left"` | `"extend_left_alias"` | `"extend_right"` | `"extend_right_alias"` | `"extend_top"` | `"extend_top_alias"` | `"marker"` | `"move"` | `"nodrop"` | `"none"` | `"pencil"` | `"play"` | `"resize_edge_diagonal_left"` | `"resize_edge_diagonal_right"` | `"resize_edge_horizontal"` | `"resize_edge_vertical"` | `"resize_horizontal"` | `"resize_vertical"` | `"zoom"` | `"zoom_horizontal"` | `"zoom_vertical"` -> ```lua -> -- The cursor cursor for this view which apears on mouse hover. -> -- Using a "none" shape will use use underlying view's cursor or the default cursor. -> ViewCursorShape: -> | "none" -> | "empty" -> | "default" -> | "change_value" -> | "edit_text" -> | "pencil" -> | "marker" -> | "crosshair" -> | "move" -> | "erase" -> | "play" -> | "drag" -> | "drop" -> | "nodrop" -> | "busy" -> | "resize_vertical" -> | "resize_horizontal" -> | "resize_edge_vertical" -> | "resize_edge_horizontal" -> | "resize_edge_diagonal_left" -> | "resize_edge_diagonal_right" -> | "extend_left" -> | "extend_right" -> | "extend_top" -> | "extend_bottom" -> | "extend_left_alias" -> | "extend_right_alias" -> | "extend_top_alias" -> | "extend_bottom_alias" -> | "zoom_vertical" -> | "zoom_horizontal" -> | "zoom" -> ``` - -### ViewDimension -[`string`](../../API/builtins/string.md) | [`integer`](../../API/builtins/integer.md) -> The dimensions of a view has to be larger than 0. -> For nested views you can also specify relative size -> for example `vb:text { width = "80%"}`. The percentage values are -> relative to the view's parent size and will automatically update on size changes. - -### ViewId -[`string`](../../API/builtins/string.md) -> Unique identifier to resolve the view later on in the viewbuilder, -> e.g. `vb.views.SomeString` or `vb.views["Some String"]` -> View ids must be unique within a single view builder instance. - -### ViewOrigin -{ 1 : [`ViewPosition`](#ViewPosition), 2 : [`ViewPosition`](#ViewPosition) } | { x : [`ViewPosition`](#ViewPosition), y : [`ViewPosition`](#ViewPosition) } -> The position of a view within its parent view. -> Only the `stack` layouts allows to freely position child views. Other -> layout views will automatically set the origin, but the origin -> then still can be read in for example mouse handlers. - -### ViewPosition -[`integer`](../../API/builtins/integer.md) -> Horizontal (x) or Vertical (y) position of a view within its parent view. - -### ViewSize -{ 1 : [`ViewDimension`](#ViewDimension), 2 : [`ViewDimension`](#ViewDimension) } | { height : [`ViewDimension`](#ViewDimension), width : [`ViewDimension`](#ViewDimension) } -> The dimensions of a view has to be larger than 0. -> For nested views you can also specify relative size, for example -> `vb:text { size = { width = "80%", height = 20}}`. -> The percentage values are relative to the view's parent size and will -> automatically update when the parent view's size changes. - -### ViewTooltip -[`string`](../../API/builtins/string.md) -> A ViewTooltip text that should be shown for this view on mouse hover. -> * Default: "" (no tip will be shown) - -### ViewVisibility -[`boolean`](../../API/builtins/boolean.md) -> Set visible to false to hide a view (make it invisible without removing -> it). Please note that view.visible will also return false when any of its -> parents are invisible (when its implicitly invisible). -> * Default: true - - - -# TextFieldProperties - ---- -## Properties -### bind : [`ViewStringObservable`](#ViewStringObservable)[`?`](../../API/builtins/nil.md) -> Bind the view's value to a renoise.Document.ObservableString object. -> Automatically keep them in sync. -> The view will change the Observable value as soon as its value changes -> and change the view's value as soon as the Observable's value changes. -> Notifiers can be added to either the view or the Observable object. - -### active : [`TextActive`](#TextActive)[`?`](../../API/builtins/nil.md) -> When false, text is displayed but can not be entered/modified by the user. -> * Default: true - -### value : [`TextValue`](#TextValue)[`?`](../../API/builtins/nil.md) -> The currently shown text. The text will not be updated when editing, -> rather only after editing is complete (return is pressed, or focus is lost). -> * Default: "" - -### notifier : [`StringChangeNotifier`](#StringChangeNotifier)[`?`](../../API/builtins/nil.md) -> Set up a notifier for text changes - -### text : [`TextValueAlias`](#TextValueAlias)[`?`](../../API/builtins/nil.md) -> Exactly the same as "value"; provided for consistency. -> * Default: "" - -### align : [`TextAlignment`](#TextAlignment)[`?`](../../API/builtins/nil.md) -> Setup the text's alignment. Applies only when the view's size is larger than -> the needed size to draw the text - -### edit_mode : [`TextEditMode`](#TextEditMode)[`?`](../../API/builtins/nil.md) -> True when the text field is focused. setting it at run-time programmatically -> will focus the text field or remove the focus (focus the dialog) accordingly. -> * Default: false - -### id : [`ViewId`](#ViewId)[`?`](../../API/builtins/nil.md) -> Unique identifier to resolve the view later on in the viewbuilder, -> e.g. `vb.views.SomeString` or `vb.views["Some String"]` -> View ids must be unique within a single view builder instance. - -### visible : [`ViewVisibility`](#ViewVisibility)[`?`](../../API/builtins/nil.md) -> Set visible to false to hide a view (make it invisible without removing -> it). Please note that view.visible will also return false when any of its -> parents are invisible (when its implicitly invisible). -> * Default: true - -### origin : [`ViewOrigin`](#ViewOrigin)[`?`](../../API/builtins/nil.md) -> The position of a view within its parent view. -> Only the `stack` layouts allows to freely position child views. Other -> layout views will automatically set the origin, but the origin -> then still can be read in for example mouse handlers. - -### width : [`ViewDimension`](#ViewDimension)[`?`](../../API/builtins/nil.md) -> **Deprecated.** Use property `size` instead. - -### height : [`ViewDimension`](#ViewDimension)[`?`](../../API/builtins/nil.md) -> **Deprecated.** Use property `size` instead. - -### size : [`ViewSize`](#ViewSize)[`?`](../../API/builtins/nil.md) -> The dimensions of a view has to be larger than 0. -> For nested views you can also specify relative size, for example -> `vb:text { size = { width = "80%", height = 20}}`. -> The percentage values are relative to the view's parent size and will -> automatically update when the parent view's size changes. - -### tooltip : [`ViewTooltip`](#ViewTooltip)[`?`](../../API/builtins/nil.md) -> A ViewTooltip text that should be shown for this view on mouse hover. -> * Default: "" (no tip will be shown) - -### cursor : [`ViewCursorShape`](#ViewCursorShape)[`?`](../../API/builtins/nil.md) -> The cursor cursor for this view which apears on mouse hover. -> Using a "none" shape will use use underlying view's cursor or the default cursor. - - - - - ---- -## Aliases -### NotifierFunction -fun() - - -### NotifierMemberContext -[`table`](../../API/builtins/table.md) | [`userdata`](../../API/builtins/userdata.md) - - -### StringChangeNotifier -[`StringValueNotifierFunction`](#StringValueNotifierFunction) | [`StringValueNotifierMethod1`](#StringValueNotifierMethod1) | [`StringValueNotifierMethod2`](#StringValueNotifierMethod2) -> Set up a notifier for text changes - -### StringValueNotifierFunction -(value : [`string`](../../API/builtins/string.md)) - - -### StringValueNotifierMemberFunction -(self : [`NotifierMemberContext`](#NotifierMemberContext), value : [`string`](../../API/builtins/string.md)) - - -### StringValueNotifierMethod1 -{ 1 : [`NotifierMemberContext`](#NotifierMemberContext), 2 : [`StringValueNotifierMemberFunction`](#StringValueNotifierMemberFunction) } - - -### StringValueNotifierMethod2 -{ 1 : [`StringValueNotifierMemberFunction`](#StringValueNotifierMemberFunction), 2 : [`NotifierMemberContext`](#NotifierMemberContext) } - - -### TextActive -[`boolean`](../../API/builtins/boolean.md) -> When false, text is displayed but can not be entered/modified by the user. -> * Default: true - -### TextAlignment -`"center"` | `"left"` | `"right"` -> ```lua -> -- Setup the text's alignment. Applies only when the view's size is larger than -> -- the needed size to draw the text -> TextAlignment: -> | "left" -- (Default) -> | "right" -- aligned to the right -> | "center" -- center text -> ``` - -### TextEditMode -[`boolean`](../../API/builtins/boolean.md) -> True when the text field is focused. setting it at run-time programmatically -> will focus the text field or remove the focus (focus the dialog) accordingly. -> * Default: false - -### TextValue -[`string`](../../API/builtins/string.md) -> The currently shown text. The text will not be updated when editing, -> rather only after editing is complete (return is pressed, or focus is lost). -> * Default: "" - -### TextValueAlias -[`string`](../../API/builtins/string.md) -> Exactly the same as "value"; provided for consistency. -> * Default: "" - -### ViewCursorShape -`"busy"` | `"change_value"` | `"crosshair"` | `"default"` | `"drag"` | `"drop"` | `"edit_text"` | `"empty"` | `"erase"` | `"extend_bottom"` | `"extend_bottom_alias"` | `"extend_left"` | `"extend_left_alias"` | `"extend_right"` | `"extend_right_alias"` | `"extend_top"` | `"extend_top_alias"` | `"marker"` | `"move"` | `"nodrop"` | `"none"` | `"pencil"` | `"play"` | `"resize_edge_diagonal_left"` | `"resize_edge_diagonal_right"` | `"resize_edge_horizontal"` | `"resize_edge_vertical"` | `"resize_horizontal"` | `"resize_vertical"` | `"zoom"` | `"zoom_horizontal"` | `"zoom_vertical"` -> ```lua -> -- The cursor cursor for this view which apears on mouse hover. -> -- Using a "none" shape will use use underlying view's cursor or the default cursor. -> ViewCursorShape: -> | "none" -> | "empty" -> | "default" -> | "change_value" -> | "edit_text" -> | "pencil" -> | "marker" -> | "crosshair" -> | "move" -> | "erase" -> | "play" -> | "drag" -> | "drop" -> | "nodrop" -> | "busy" -> | "resize_vertical" -> | "resize_horizontal" -> | "resize_edge_vertical" -> | "resize_edge_horizontal" -> | "resize_edge_diagonal_left" -> | "resize_edge_diagonal_right" -> | "extend_left" -> | "extend_right" -> | "extend_top" -> | "extend_bottom" -> | "extend_left_alias" -> | "extend_right_alias" -> | "extend_top_alias" -> | "extend_bottom_alias" -> | "zoom_vertical" -> | "zoom_horizontal" -> | "zoom" -> ``` - -### ViewDimension -[`string`](../../API/builtins/string.md) | [`integer`](../../API/builtins/integer.md) -> The dimensions of a view has to be larger than 0. -> For nested views you can also specify relative size -> for example `vb:text { width = "80%"}`. The percentage values are -> relative to the view's parent size and will automatically update on size changes. - -### ViewId -[`string`](../../API/builtins/string.md) -> Unique identifier to resolve the view later on in the viewbuilder, -> e.g. `vb.views.SomeString` or `vb.views["Some String"]` -> View ids must be unique within a single view builder instance. - -### ViewOrigin -{ 1 : [`ViewPosition`](#ViewPosition), 2 : [`ViewPosition`](#ViewPosition) } | { x : [`ViewPosition`](#ViewPosition), y : [`ViewPosition`](#ViewPosition) } -> The position of a view within its parent view. -> Only the `stack` layouts allows to freely position child views. Other -> layout views will automatically set the origin, but the origin -> then still can be read in for example mouse handlers. - -### ViewPosition -[`integer`](../../API/builtins/integer.md) -> Horizontal (x) or Vertical (y) position of a view within its parent view. - -### ViewSize -{ 1 : [`ViewDimension`](#ViewDimension), 2 : [`ViewDimension`](#ViewDimension) } | { height : [`ViewDimension`](#ViewDimension), width : [`ViewDimension`](#ViewDimension) } -> The dimensions of a view has to be larger than 0. -> For nested views you can also specify relative size, for example -> `vb:text { size = { width = "80%", height = 20}}`. -> The percentage values are relative to the view's parent size and will -> automatically update when the parent view's size changes. - -### ViewStringObservable -[`renoise.Document.ObservableString`](../../API/renoise/renoise.Document.ObservableString.md) -> Bind the view's value to a renoise.Document.ObservableString object. -> Automatically keep them in sync. -> The view will change the Observable value as soon as its value changes -> and change the view's value as soon as the Observable's value changes. -> Notifiers can be added to either the view or the Observable object. - -### ViewTooltip -[`string`](../../API/builtins/string.md) -> A ViewTooltip text that should be shown for this view on mouse hover. -> * Default: "" (no tip will be shown) - -### ViewVisibility -[`boolean`](../../API/builtins/boolean.md) -> Set visible to false to hide a view (make it invisible without removing -> it). Please note that view.visible will also return false when any of its -> parents are invisible (when its implicitly invisible). -> * Default: true - - - -# TextLinkViewProperties - ---- -## Properties -### active : [`ControlActive`](#ControlActive)[`?`](../../API/builtins/nil.md) -> Instead of making a control invisible, you can also make it inactive. -> Deactivated controls will still be shown, and will still show their -> currently assigned values, but will not allow changes. Most controls will -> display as "grayed out" to visualize the deactivated state. - -### midi_mapping : [`ControlMidiMappingString`](#ControlMidiMappingString)[`?`](../../API/builtins/nil.md) -> When set, the control will be highlighted when Renoise's MIDI mapping dialog -> is open. When clicked, it selects the specified string as a MIDI mapping -> target action. This target acton can either be one of the globally available -> mappings in Renoise, or those that were created by the tool itself. -> Target strings are not verified. When they point to nothing, the mapped MIDI -> message will do nothing and no error is fired. - -### notifier : [`ButtonNotifier`](#ButtonNotifier)[`?`](../../API/builtins/nil.md) -> A click notifier - -### pressed : [`ButtonNotifier`](#ButtonNotifier)[`?`](../../API/builtins/nil.md) -> A click notifier - -### released : [`ButtonNotifier`](#ButtonNotifier)[`?`](../../API/builtins/nil.md) -> A click notifier - -### text : [`TextSingleLineString`](#TextSingleLineString)[`?`](../../API/builtins/nil.md) -> The text that should be displayed. Setting a new text will resize -> the view in order to make the text fully visible (expanding only). -> * Default: "" - -### font : [`TextFontStyle`](#TextFontStyle)[`?`](../../API/builtins/nil.md) -> The style that the text should be displayed with. - -### style : [`TextStyle`](#TextStyle)[`?`](../../API/builtins/nil.md) -> Get/set the color style the text should be displayed with. - -### color : [`TextColor`](#TextColor)[`?`](../../API/builtins/nil.md) -> When set, the text will be drawn in the specified color. -> Set style to something else than "custom" or color to `{0, 0, 0}` -> to enable the default theme color for the text again. - -### orientation : [`TextOrientation`](#TextOrientation)[`?`](../../API/builtins/nil.md) -> Setup the texts's orientation (writing direction). - -### align : [`TextAlignment`](#TextAlignment)[`?`](../../API/builtins/nil.md) -> Setup the text's alignment. Applies only when the view's size is larger than -> the needed size to draw the text - -### id : [`ViewId`](#ViewId)[`?`](../../API/builtins/nil.md) -> Unique identifier to resolve the view later on in the viewbuilder, -> e.g. `vb.views.SomeString` or `vb.views["Some String"]` -> View ids must be unique within a single view builder instance. - -### visible : [`ViewVisibility`](#ViewVisibility)[`?`](../../API/builtins/nil.md) -> Set visible to false to hide a view (make it invisible without removing -> it). Please note that view.visible will also return false when any of its -> parents are invisible (when its implicitly invisible). -> * Default: true - -### origin : [`ViewOrigin`](#ViewOrigin)[`?`](../../API/builtins/nil.md) -> The position of a view within its parent view. -> Only the `stack` layouts allows to freely position child views. Other -> layout views will automatically set the origin, but the origin -> then still can be read in for example mouse handlers. - -### width : [`ViewDimension`](#ViewDimension)[`?`](../../API/builtins/nil.md) -> **Deprecated.** Use property `size` instead. - -### height : [`ViewDimension`](#ViewDimension)[`?`](../../API/builtins/nil.md) -> **Deprecated.** Use property `size` instead. - -### size : [`ViewSize`](#ViewSize)[`?`](../../API/builtins/nil.md) -> The dimensions of a view has to be larger than 0. -> For nested views you can also specify relative size, for example -> `vb:text { size = { width = "80%", height = 20}}`. -> The percentage values are relative to the view's parent size and will -> automatically update when the parent view's size changes. - -### tooltip : [`ViewTooltip`](#ViewTooltip)[`?`](../../API/builtins/nil.md) -> A ViewTooltip text that should be shown for this view on mouse hover. -> * Default: "" (no tip will be shown) - -### cursor : [`ViewCursorShape`](#ViewCursorShape)[`?`](../../API/builtins/nil.md) -> The cursor cursor for this view which apears on mouse hover. -> Using a "none" shape will use use underlying view's cursor or the default cursor. - - - - - ---- -## Aliases -### ButtonNotifier -[`NotifierFunction`](#NotifierFunction) | [`NotifierMethod1`](#NotifierMethod1) | [`NotifierMethod2`](#NotifierMethod2) -> A click notifier - -### ControlActive -[`boolean`](../../API/builtins/boolean.md) -> Instead of making a control invisible, you can also make it inactive. -> Deactivated controls will still be shown, and will still show their -> currently assigned values, but will not allow changes. Most controls will -> display as "grayed out" to visualize the deactivated state. - -### ControlMidiMappingString -[`string`](../../API/builtins/string.md) -> When set, the control will be highlighted when Renoise's MIDI mapping dialog -> is open. When clicked, it selects the specified string as a MIDI mapping -> target action. This target acton can either be one of the globally available -> mappings in Renoise, or those that were created by the tool itself. -> Target strings are not verified. When they point to nothing, the mapped MIDI -> message will do nothing and no error is fired. - -### NotifierFunction -fun() - - -### NotifierMemberContext -[`table`](../../API/builtins/table.md) | [`userdata`](../../API/builtins/userdata.md) - - -### NotifierMemberFunction -(self : [`NotifierMemberContext`](#NotifierMemberContext)) - - -### NotifierMethod1 -{ 1 : [`NotifierMemberContext`](#NotifierMemberContext), 2 : [`NotifierMemberFunction`](#NotifierMemberFunction) } - - -### NotifierMethod2 -{ 1 : [`NotifierMemberFunction`](#NotifierMemberFunction), 2 : [`NotifierMemberContext`](#NotifierMemberContext) } - - -### RGBColor -{ 1 : [`integer`](../../API/builtins/integer.md), 2 : [`integer`](../../API/builtins/integer.md), 3 : [`integer`](../../API/builtins/integer.md) } -> A table of 3 bytes (ranging from 0 to 255) -> representing the red, green and blue channels of a color. -> {0xFF, 0xFF, 0xFF} is white -> {165, 73, 35} is the red from the Renoise logo - -### TextAlignment -`"center"` | `"left"` | `"right"` -> ```lua -> -- Setup the text's alignment. Applies only when the view's size is larger than -> -- the needed size to draw the text -> TextAlignment: -> | "left" -- (Default) -> | "right" -- aligned to the right -> | "center" -- center text -> ``` - -### TextColor -[`RGBColor`](#RGBColor) | [`ThemeColor`](#ThemeColor) -> ```lua -> -- When set, the text will be drawn in the specified color. -> -- Set style to something else than "custom" or color to `{0, 0, 0}` -> -- to enable the default theme color for the text again. -> -- A table of 3 bytes (ranging from 0 to 255) -> -- representing the red, green and blue channels of a color. -> -- {0xFF, 0xFF, 0xFF} is white -> -- {165, 73, 35} is the red from the Renoise logo -> -- The application theme's colors -> TextColor: -> | "main_back" -> | "main_font" -> | "alternate_main_back" -> | "alternate_main_font" -> | "body_back" -> | "body_font" -> | "strong_body_font" -> | "button_back" -> | "button_font" -> | "button_highlight_font" -> | "selected_button_back" -> | "selected_button_font" -> | "selection_back" -> | "selection_font" -> | "standby_selection_back" -> | "standby_selection_font" -> | "midi_mapping_back" -> | "midi_mapping_font" -> | "tooltip_back" -> | "tooltip_font" -> | "valuebox_back" -> | "valuebox_font" -> | "valuebox_font_icons" -> | "scrollbar" -> | "slider" -> | "folder" -> | "pattern_default_back" -> | "pattern_default_font" -> | "pattern_default_font_volume" -> | "pattern_default_font_panning" -> | "pattern_default_font_pitch" -> | "pattern_default_font_delay" -> | "pattern_default_font_global" -> | "pattern_default_font_other" -> | "pattern_default_font_dspfx" -> | "pattern_default_font_unused" -> | "pattern_highlighted_back" -> | "pattern_highlighted_font" -> | "pattern_highlighted_font_volume" -> | "pattern_highlighted_font_panning" -> | "pattern_highlighted_font_pitch" -> | "pattern_highlighted_font_delay" -> | "pattern_highlighted_font_global" -> | "pattern_highlighted_font_other" -> | "pattern_highlighted_font_dspfx" -> | "pattern_highlighted_font_unused" -> | "pattern_playposition_back" -> | "pattern_playposition_font" -> | "pattern_centerbar_back" -> | "pattern_centerbar_font" -> | "pattern_centerbar_back_standby" -> | "pattern_centerbar_font_standby" -> | "pattern_selection" -> | "pattern_standby_selection" -> | "pattern_mute_state" -> | "automation_grid" -> | "automation_line_edge" -> | "automation_line_fill" -> | "automation_point" -> | "automation_marker_play" -> | "automation_marker_single" -> | "automation_marker_pair" -> | "automation_marker_diamond" -> | "vumeter_meter" -> | "vumeter_meter_low" -> | "vumeter_meter_middle" -> | "vumeter_meter_high" -> | "vumeter_peak" -> | "vumeter_back_normal" -> | "vumeter_back_clipped" -> | "default_color_01" -> | "default_color_02" -> | "default_color_03" -> | "default_color_04" -> | "default_color_05" -> | "default_color_06" -> | "default_color_07" -> | "default_color_08" -> | "default_color_09" -> | "default_color_10" -> | "default_color_11" -> | "default_color_12" -> | "default_color_13" -> | "default_color_14" -> | "default_color_15" -> | "default_color_16" -> ``` - -### TextFontStyle -`"big"` | `"bold"` | `"code"` | `"italic"` | `"mono"` | `"normal"` -> ```lua -> -- The style that the text should be displayed with. -> TextFontStyle: -> | "normal" -- (Default) -> | "big" -- big text -> | "bold" -- bold font -> | "italic" -- italic font -> | "mono" -- monospace font -> | "code" -- monospace code font -> ``` - -### TextOrientation -`"horizontal"` | `"horizontal-rl"` | `"vertical"` | `"vertical-tb"` -> ```lua -> -- Setup the texts's orientation (writing direction). -> TextOrientation: -> | "horizontal" -- Draw from left to right (Default) -> | "horizontal-rl" -- Draw from right to left -> | "vertical" -- Draw from bottom to top -> | "vertical-tb" -- Draw from top to bottom -> ``` - -### TextSingleLineString -[`string`](../../API/builtins/string.md) -> The text that should be displayed. Setting a new text will resize -> the view in order to make the text fully visible (expanding only). -> * Default: "" - -### TextStyle -`"custom"` | `"disabled"` | `"normal"` | `"strong"` -> ```lua -> -- Get/set the color style the text should be displayed with. -> TextStyle: -> | "normal" -- (Default) -> | "strong" -- highlighted color -> | "disabled" -- greyed out color -> | "custom" -- custom color -> ``` - -### ThemeColor -`"alternate_main_back"` | `"alternate_main_font"` | `"automation_grid"` | `"automation_line_edge"` | `"automation_line_fill"` | `"automation_marker_diamond"` | `"automation_marker_pair"` | `"automation_marker_play"` | `"automation_marker_single"` | `"automation_point"` | `"body_back"` | `"body_font"` | `"button_back"` | `"button_font"` | `"button_highlight_font"` | `"default_color_01"` | `"default_color_02"` | `"default_color_03"` | `"default_color_04"` | `"default_color_05"` | `"default_color_06"` | `"default_color_07"` | `"default_color_08"` | `"default_color_09"` | `"default_color_10"` | `"default_color_11"` | `"default_color_12"` | `"default_color_13"` | `"default_color_14"` | `"default_color_15"` | `"default_color_16"` | `"folder"` | `"main_back"` | `"main_font"` | `"midi_mapping_back"` | `"midi_mapping_font"` | `"pattern_centerbar_back"` | `"pattern_centerbar_back_standby"` | `"pattern_centerbar_font"` | `"pattern_centerbar_font_standby"` | `"pattern_default_back"` | `"pattern_default_font"` | `"pattern_default_font_delay"` | `"pattern_default_font_dspfx"` | `"pattern_default_font_global"` | `"pattern_default_font_other"` | `"pattern_default_font_panning"` | `"pattern_default_font_pitch"` | `"pattern_default_font_unused"` | `"pattern_default_font_volume"` | `"pattern_highlighted_back"` | `"pattern_highlighted_font"` | `"pattern_highlighted_font_delay"` | `"pattern_highlighted_font_dspfx"` | `"pattern_highlighted_font_global"` | `"pattern_highlighted_font_other"` | `"pattern_highlighted_font_panning"` | `"pattern_highlighted_font_pitch"` | `"pattern_highlighted_font_unused"` | `"pattern_highlighted_font_volume"` | `"pattern_mute_state"` | `"pattern_playposition_back"` | `"pattern_playposition_font"` | `"pattern_selection"` | `"pattern_standby_selection"` | `"scrollbar"` | `"selected_button_back"` | `"selected_button_font"` | `"selection_back"` | `"selection_font"` | `"slider"` | `"standby_selection_back"` | `"standby_selection_font"` | `"strong_body_font"` | `"tooltip_back"` | `"tooltip_font"` | `"valuebox_back"` | `"valuebox_font"` | `"valuebox_font_icons"` | `"vumeter_back_clipped"` | `"vumeter_back_normal"` | `"vumeter_meter"` | `"vumeter_meter_high"` | `"vumeter_meter_low"` | `"vumeter_meter_middle"` | `"vumeter_peak"` -> ```lua -> -- The application theme's colors -> ThemeColor: -> | "main_back" -> | "main_font" -> | "alternate_main_back" -> | "alternate_main_font" -> | "body_back" -> | "body_font" -> | "strong_body_font" -> | "button_back" -> | "button_font" -> | "button_highlight_font" -> | "selected_button_back" -> | "selected_button_font" -> | "selection_back" -> | "selection_font" -> | "standby_selection_back" -> | "standby_selection_font" -> | "midi_mapping_back" -> | "midi_mapping_font" -> | "tooltip_back" -> | "tooltip_font" -> | "valuebox_back" -> | "valuebox_font" -> | "valuebox_font_icons" -> | "scrollbar" -> | "slider" -> | "folder" -> | "pattern_default_back" -> | "pattern_default_font" -> | "pattern_default_font_volume" -> | "pattern_default_font_panning" -> | "pattern_default_font_pitch" -> | "pattern_default_font_delay" -> | "pattern_default_font_global" -> | "pattern_default_font_other" -> | "pattern_default_font_dspfx" -> | "pattern_default_font_unused" -> | "pattern_highlighted_back" -> | "pattern_highlighted_font" -> | "pattern_highlighted_font_volume" -> | "pattern_highlighted_font_panning" -> | "pattern_highlighted_font_pitch" -> | "pattern_highlighted_font_delay" -> | "pattern_highlighted_font_global" -> | "pattern_highlighted_font_other" -> | "pattern_highlighted_font_dspfx" -> | "pattern_highlighted_font_unused" -> | "pattern_playposition_back" -> | "pattern_playposition_font" -> | "pattern_centerbar_back" -> | "pattern_centerbar_font" -> | "pattern_centerbar_back_standby" -> | "pattern_centerbar_font_standby" -> | "pattern_selection" -> | "pattern_standby_selection" -> | "pattern_mute_state" -> | "automation_grid" -> | "automation_line_edge" -> | "automation_line_fill" -> | "automation_point" -> | "automation_marker_play" -> | "automation_marker_single" -> | "automation_marker_pair" -> | "automation_marker_diamond" -> | "vumeter_meter" -> | "vumeter_meter_low" -> | "vumeter_meter_middle" -> | "vumeter_meter_high" -> | "vumeter_peak" -> | "vumeter_back_normal" -> | "vumeter_back_clipped" -> | "default_color_01" -> | "default_color_02" -> | "default_color_03" -> | "default_color_04" -> | "default_color_05" -> | "default_color_06" -> | "default_color_07" -> | "default_color_08" -> | "default_color_09" -> | "default_color_10" -> | "default_color_11" -> | "default_color_12" -> | "default_color_13" -> | "default_color_14" -> | "default_color_15" -> | "default_color_16" -> ``` - -### ViewCursorShape -`"busy"` | `"change_value"` | `"crosshair"` | `"default"` | `"drag"` | `"drop"` | `"edit_text"` | `"empty"` | `"erase"` | `"extend_bottom"` | `"extend_bottom_alias"` | `"extend_left"` | `"extend_left_alias"` | `"extend_right"` | `"extend_right_alias"` | `"extend_top"` | `"extend_top_alias"` | `"marker"` | `"move"` | `"nodrop"` | `"none"` | `"pencil"` | `"play"` | `"resize_edge_diagonal_left"` | `"resize_edge_diagonal_right"` | `"resize_edge_horizontal"` | `"resize_edge_vertical"` | `"resize_horizontal"` | `"resize_vertical"` | `"zoom"` | `"zoom_horizontal"` | `"zoom_vertical"` -> ```lua -> -- The cursor cursor for this view which apears on mouse hover. -> -- Using a "none" shape will use use underlying view's cursor or the default cursor. -> ViewCursorShape: -> | "none" -> | "empty" -> | "default" -> | "change_value" -> | "edit_text" -> | "pencil" -> | "marker" -> | "crosshair" -> | "move" -> | "erase" -> | "play" -> | "drag" -> | "drop" -> | "nodrop" -> | "busy" -> | "resize_vertical" -> | "resize_horizontal" -> | "resize_edge_vertical" -> | "resize_edge_horizontal" -> | "resize_edge_diagonal_left" -> | "resize_edge_diagonal_right" -> | "extend_left" -> | "extend_right" -> | "extend_top" -> | "extend_bottom" -> | "extend_left_alias" -> | "extend_right_alias" -> | "extend_top_alias" -> | "extend_bottom_alias" -> | "zoom_vertical" -> | "zoom_horizontal" -> | "zoom" -> ``` - -### ViewDimension -[`string`](../../API/builtins/string.md) | [`integer`](../../API/builtins/integer.md) -> The dimensions of a view has to be larger than 0. -> For nested views you can also specify relative size -> for example `vb:text { width = "80%"}`. The percentage values are -> relative to the view's parent size and will automatically update on size changes. - -### ViewId -[`string`](../../API/builtins/string.md) -> Unique identifier to resolve the view later on in the viewbuilder, -> e.g. `vb.views.SomeString` or `vb.views["Some String"]` -> View ids must be unique within a single view builder instance. - -### ViewOrigin -{ 1 : [`ViewPosition`](#ViewPosition), 2 : [`ViewPosition`](#ViewPosition) } | { x : [`ViewPosition`](#ViewPosition), y : [`ViewPosition`](#ViewPosition) } -> The position of a view within its parent view. -> Only the `stack` layouts allows to freely position child views. Other -> layout views will automatically set the origin, but the origin -> then still can be read in for example mouse handlers. - -### ViewPosition -[`integer`](../../API/builtins/integer.md) -> Horizontal (x) or Vertical (y) position of a view within its parent view. - -### ViewSize -{ 1 : [`ViewDimension`](#ViewDimension), 2 : [`ViewDimension`](#ViewDimension) } | { height : [`ViewDimension`](#ViewDimension), width : [`ViewDimension`](#ViewDimension) } -> The dimensions of a view has to be larger than 0. -> For nested views you can also specify relative size, for example -> `vb:text { size = { width = "80%", height = 20}}`. -> The percentage values are relative to the view's parent size and will -> automatically update when the parent view's size changes. - -### ViewTooltip -[`string`](../../API/builtins/string.md) -> A ViewTooltip text that should be shown for this view on mouse hover. -> * Default: "" (no tip will be shown) - -### ViewVisibility -[`boolean`](../../API/builtins/boolean.md) -> Set visible to false to hide a view (make it invisible without removing -> it). Please note that view.visible will also return false when any of its -> parents are invisible (when its implicitly invisible). -> * Default: true - - - -# TextViewProperties - ---- -## Properties -### text : [`TextSingleLineString`](#TextSingleLineString)[`?`](../../API/builtins/nil.md) -> The text that should be displayed. Setting a new text will resize -> the view in order to make the text fully visible (expanding only). -> * Default: "" - -### font : [`TextFontStyle`](#TextFontStyle)[`?`](../../API/builtins/nil.md) -> The style that the text should be displayed with. - -### style : [`TextStyle`](#TextStyle)[`?`](../../API/builtins/nil.md) -> Get/set the color style the text should be displayed with. - -### color : [`TextColor`](#TextColor)[`?`](../../API/builtins/nil.md) -> When set, the text will be drawn in the specified color. -> Set style to something else than "custom" or color to `{0, 0, 0}` -> to enable the default theme color for the text again. - -### orientation : [`TextOrientation`](#TextOrientation)[`?`](../../API/builtins/nil.md) -> Setup the texts's orientation (writing direction). - -### align : [`TextAlignment`](#TextAlignment)[`?`](../../API/builtins/nil.md) -> Setup the text's alignment. Applies only when the view's size is larger than -> the needed size to draw the text - -### id : [`ViewId`](#ViewId)[`?`](../../API/builtins/nil.md) -> Unique identifier to resolve the view later on in the viewbuilder, -> e.g. `vb.views.SomeString` or `vb.views["Some String"]` -> View ids must be unique within a single view builder instance. - -### visible : [`ViewVisibility`](#ViewVisibility)[`?`](../../API/builtins/nil.md) -> Set visible to false to hide a view (make it invisible without removing -> it). Please note that view.visible will also return false when any of its -> parents are invisible (when its implicitly invisible). -> * Default: true - -### origin : [`ViewOrigin`](#ViewOrigin)[`?`](../../API/builtins/nil.md) -> The position of a view within its parent view. -> Only the `stack` layouts allows to freely position child views. Other -> layout views will automatically set the origin, but the origin -> then still can be read in for example mouse handlers. - -### width : [`ViewDimension`](#ViewDimension)[`?`](../../API/builtins/nil.md) -> **Deprecated.** Use property `size` instead. - -### height : [`ViewDimension`](#ViewDimension)[`?`](../../API/builtins/nil.md) -> **Deprecated.** Use property `size` instead. - -### size : [`ViewSize`](#ViewSize)[`?`](../../API/builtins/nil.md) -> The dimensions of a view has to be larger than 0. -> For nested views you can also specify relative size, for example -> `vb:text { size = { width = "80%", height = 20}}`. -> The percentage values are relative to the view's parent size and will -> automatically update when the parent view's size changes. - -### tooltip : [`ViewTooltip`](#ViewTooltip)[`?`](../../API/builtins/nil.md) -> A ViewTooltip text that should be shown for this view on mouse hover. -> * Default: "" (no tip will be shown) - -### cursor : [`ViewCursorShape`](#ViewCursorShape)[`?`](../../API/builtins/nil.md) -> The cursor cursor for this view which apears on mouse hover. -> Using a "none" shape will use use underlying view's cursor or the default cursor. - - - - - ---- -## Aliases -### RGBColor -{ 1 : [`integer`](../../API/builtins/integer.md), 2 : [`integer`](../../API/builtins/integer.md), 3 : [`integer`](../../API/builtins/integer.md) } -> A table of 3 bytes (ranging from 0 to 255) -> representing the red, green and blue channels of a color. -> {0xFF, 0xFF, 0xFF} is white -> {165, 73, 35} is the red from the Renoise logo - -### TextAlignment -`"center"` | `"left"` | `"right"` -> ```lua -> -- Setup the text's alignment. Applies only when the view's size is larger than -> -- the needed size to draw the text -> TextAlignment: -> | "left" -- (Default) -> | "right" -- aligned to the right -> | "center" -- center text -> ``` - -### TextColor -[`RGBColor`](#RGBColor) | [`ThemeColor`](#ThemeColor) -> ```lua -> -- When set, the text will be drawn in the specified color. -> -- Set style to something else than "custom" or color to `{0, 0, 0}` -> -- to enable the default theme color for the text again. -> -- A table of 3 bytes (ranging from 0 to 255) -> -- representing the red, green and blue channels of a color. -> -- {0xFF, 0xFF, 0xFF} is white -> -- {165, 73, 35} is the red from the Renoise logo -> -- The application theme's colors -> TextColor: -> | "main_back" -> | "main_font" -> | "alternate_main_back" -> | "alternate_main_font" -> | "body_back" -> | "body_font" -> | "strong_body_font" -> | "button_back" -> | "button_font" -> | "button_highlight_font" -> | "selected_button_back" -> | "selected_button_font" -> | "selection_back" -> | "selection_font" -> | "standby_selection_back" -> | "standby_selection_font" -> | "midi_mapping_back" -> | "midi_mapping_font" -> | "tooltip_back" -> | "tooltip_font" -> | "valuebox_back" -> | "valuebox_font" -> | "valuebox_font_icons" -> | "scrollbar" -> | "slider" -> | "folder" -> | "pattern_default_back" -> | "pattern_default_font" -> | "pattern_default_font_volume" -> | "pattern_default_font_panning" -> | "pattern_default_font_pitch" -> | "pattern_default_font_delay" -> | "pattern_default_font_global" -> | "pattern_default_font_other" -> | "pattern_default_font_dspfx" -> | "pattern_default_font_unused" -> | "pattern_highlighted_back" -> | "pattern_highlighted_font" -> | "pattern_highlighted_font_volume" -> | "pattern_highlighted_font_panning" -> | "pattern_highlighted_font_pitch" -> | "pattern_highlighted_font_delay" -> | "pattern_highlighted_font_global" -> | "pattern_highlighted_font_other" -> | "pattern_highlighted_font_dspfx" -> | "pattern_highlighted_font_unused" -> | "pattern_playposition_back" -> | "pattern_playposition_font" -> | "pattern_centerbar_back" -> | "pattern_centerbar_font" -> | "pattern_centerbar_back_standby" -> | "pattern_centerbar_font_standby" -> | "pattern_selection" -> | "pattern_standby_selection" -> | "pattern_mute_state" -> | "automation_grid" -> | "automation_line_edge" -> | "automation_line_fill" -> | "automation_point" -> | "automation_marker_play" -> | "automation_marker_single" -> | "automation_marker_pair" -> | "automation_marker_diamond" -> | "vumeter_meter" -> | "vumeter_meter_low" -> | "vumeter_meter_middle" -> | "vumeter_meter_high" -> | "vumeter_peak" -> | "vumeter_back_normal" -> | "vumeter_back_clipped" -> | "default_color_01" -> | "default_color_02" -> | "default_color_03" -> | "default_color_04" -> | "default_color_05" -> | "default_color_06" -> | "default_color_07" -> | "default_color_08" -> | "default_color_09" -> | "default_color_10" -> | "default_color_11" -> | "default_color_12" -> | "default_color_13" -> | "default_color_14" -> | "default_color_15" -> | "default_color_16" -> ``` - -### TextFontStyle -`"big"` | `"bold"` | `"code"` | `"italic"` | `"mono"` | `"normal"` -> ```lua -> -- The style that the text should be displayed with. -> TextFontStyle: -> | "normal" -- (Default) -> | "big" -- big text -> | "bold" -- bold font -> | "italic" -- italic font -> | "mono" -- monospace font -> | "code" -- monospace code font -> ``` - -### TextOrientation -`"horizontal"` | `"horizontal-rl"` | `"vertical"` | `"vertical-tb"` -> ```lua -> -- Setup the texts's orientation (writing direction). -> TextOrientation: -> | "horizontal" -- Draw from left to right (Default) -> | "horizontal-rl" -- Draw from right to left -> | "vertical" -- Draw from bottom to top -> | "vertical-tb" -- Draw from top to bottom -> ``` - -### TextSingleLineString -[`string`](../../API/builtins/string.md) -> The text that should be displayed. Setting a new text will resize -> the view in order to make the text fully visible (expanding only). -> * Default: "" - -### TextStyle -`"custom"` | `"disabled"` | `"normal"` | `"strong"` -> ```lua -> -- Get/set the color style the text should be displayed with. -> TextStyle: -> | "normal" -- (Default) -> | "strong" -- highlighted color -> | "disabled" -- greyed out color -> | "custom" -- custom color -> ``` - -### ThemeColor -`"alternate_main_back"` | `"alternate_main_font"` | `"automation_grid"` | `"automation_line_edge"` | `"automation_line_fill"` | `"automation_marker_diamond"` | `"automation_marker_pair"` | `"automation_marker_play"` | `"automation_marker_single"` | `"automation_point"` | `"body_back"` | `"body_font"` | `"button_back"` | `"button_font"` | `"button_highlight_font"` | `"default_color_01"` | `"default_color_02"` | `"default_color_03"` | `"default_color_04"` | `"default_color_05"` | `"default_color_06"` | `"default_color_07"` | `"default_color_08"` | `"default_color_09"` | `"default_color_10"` | `"default_color_11"` | `"default_color_12"` | `"default_color_13"` | `"default_color_14"` | `"default_color_15"` | `"default_color_16"` | `"folder"` | `"main_back"` | `"main_font"` | `"midi_mapping_back"` | `"midi_mapping_font"` | `"pattern_centerbar_back"` | `"pattern_centerbar_back_standby"` | `"pattern_centerbar_font"` | `"pattern_centerbar_font_standby"` | `"pattern_default_back"` | `"pattern_default_font"` | `"pattern_default_font_delay"` | `"pattern_default_font_dspfx"` | `"pattern_default_font_global"` | `"pattern_default_font_other"` | `"pattern_default_font_panning"` | `"pattern_default_font_pitch"` | `"pattern_default_font_unused"` | `"pattern_default_font_volume"` | `"pattern_highlighted_back"` | `"pattern_highlighted_font"` | `"pattern_highlighted_font_delay"` | `"pattern_highlighted_font_dspfx"` | `"pattern_highlighted_font_global"` | `"pattern_highlighted_font_other"` | `"pattern_highlighted_font_panning"` | `"pattern_highlighted_font_pitch"` | `"pattern_highlighted_font_unused"` | `"pattern_highlighted_font_volume"` | `"pattern_mute_state"` | `"pattern_playposition_back"` | `"pattern_playposition_font"` | `"pattern_selection"` | `"pattern_standby_selection"` | `"scrollbar"` | `"selected_button_back"` | `"selected_button_font"` | `"selection_back"` | `"selection_font"` | `"slider"` | `"standby_selection_back"` | `"standby_selection_font"` | `"strong_body_font"` | `"tooltip_back"` | `"tooltip_font"` | `"valuebox_back"` | `"valuebox_font"` | `"valuebox_font_icons"` | `"vumeter_back_clipped"` | `"vumeter_back_normal"` | `"vumeter_meter"` | `"vumeter_meter_high"` | `"vumeter_meter_low"` | `"vumeter_meter_middle"` | `"vumeter_peak"` -> ```lua -> -- The application theme's colors -> ThemeColor: -> | "main_back" -> | "main_font" -> | "alternate_main_back" -> | "alternate_main_font" -> | "body_back" -> | "body_font" -> | "strong_body_font" -> | "button_back" -> | "button_font" -> | "button_highlight_font" -> | "selected_button_back" -> | "selected_button_font" -> | "selection_back" -> | "selection_font" -> | "standby_selection_back" -> | "standby_selection_font" -> | "midi_mapping_back" -> | "midi_mapping_font" -> | "tooltip_back" -> | "tooltip_font" -> | "valuebox_back" -> | "valuebox_font" -> | "valuebox_font_icons" -> | "scrollbar" -> | "slider" -> | "folder" -> | "pattern_default_back" -> | "pattern_default_font" -> | "pattern_default_font_volume" -> | "pattern_default_font_panning" -> | "pattern_default_font_pitch" -> | "pattern_default_font_delay" -> | "pattern_default_font_global" -> | "pattern_default_font_other" -> | "pattern_default_font_dspfx" -> | "pattern_default_font_unused" -> | "pattern_highlighted_back" -> | "pattern_highlighted_font" -> | "pattern_highlighted_font_volume" -> | "pattern_highlighted_font_panning" -> | "pattern_highlighted_font_pitch" -> | "pattern_highlighted_font_delay" -> | "pattern_highlighted_font_global" -> | "pattern_highlighted_font_other" -> | "pattern_highlighted_font_dspfx" -> | "pattern_highlighted_font_unused" -> | "pattern_playposition_back" -> | "pattern_playposition_font" -> | "pattern_centerbar_back" -> | "pattern_centerbar_font" -> | "pattern_centerbar_back_standby" -> | "pattern_centerbar_font_standby" -> | "pattern_selection" -> | "pattern_standby_selection" -> | "pattern_mute_state" -> | "automation_grid" -> | "automation_line_edge" -> | "automation_line_fill" -> | "automation_point" -> | "automation_marker_play" -> | "automation_marker_single" -> | "automation_marker_pair" -> | "automation_marker_diamond" -> | "vumeter_meter" -> | "vumeter_meter_low" -> | "vumeter_meter_middle" -> | "vumeter_meter_high" -> | "vumeter_peak" -> | "vumeter_back_normal" -> | "vumeter_back_clipped" -> | "default_color_01" -> | "default_color_02" -> | "default_color_03" -> | "default_color_04" -> | "default_color_05" -> | "default_color_06" -> | "default_color_07" -> | "default_color_08" -> | "default_color_09" -> | "default_color_10" -> | "default_color_11" -> | "default_color_12" -> | "default_color_13" -> | "default_color_14" -> | "default_color_15" -> | "default_color_16" -> ``` - -### ViewCursorShape -`"busy"` | `"change_value"` | `"crosshair"` | `"default"` | `"drag"` | `"drop"` | `"edit_text"` | `"empty"` | `"erase"` | `"extend_bottom"` | `"extend_bottom_alias"` | `"extend_left"` | `"extend_left_alias"` | `"extend_right"` | `"extend_right_alias"` | `"extend_top"` | `"extend_top_alias"` | `"marker"` | `"move"` | `"nodrop"` | `"none"` | `"pencil"` | `"play"` | `"resize_edge_diagonal_left"` | `"resize_edge_diagonal_right"` | `"resize_edge_horizontal"` | `"resize_edge_vertical"` | `"resize_horizontal"` | `"resize_vertical"` | `"zoom"` | `"zoom_horizontal"` | `"zoom_vertical"` -> ```lua -> -- The cursor cursor for this view which apears on mouse hover. -> -- Using a "none" shape will use use underlying view's cursor or the default cursor. -> ViewCursorShape: -> | "none" -> | "empty" -> | "default" -> | "change_value" -> | "edit_text" -> | "pencil" -> | "marker" -> | "crosshair" -> | "move" -> | "erase" -> | "play" -> | "drag" -> | "drop" -> | "nodrop" -> | "busy" -> | "resize_vertical" -> | "resize_horizontal" -> | "resize_edge_vertical" -> | "resize_edge_horizontal" -> | "resize_edge_diagonal_left" -> | "resize_edge_diagonal_right" -> | "extend_left" -> | "extend_right" -> | "extend_top" -> | "extend_bottom" -> | "extend_left_alias" -> | "extend_right_alias" -> | "extend_top_alias" -> | "extend_bottom_alias" -> | "zoom_vertical" -> | "zoom_horizontal" -> | "zoom" -> ``` - -### ViewDimension -[`string`](../../API/builtins/string.md) | [`integer`](../../API/builtins/integer.md) -> The dimensions of a view has to be larger than 0. -> For nested views you can also specify relative size -> for example `vb:text { width = "80%"}`. The percentage values are -> relative to the view's parent size and will automatically update on size changes. - -### ViewId -[`string`](../../API/builtins/string.md) -> Unique identifier to resolve the view later on in the viewbuilder, -> e.g. `vb.views.SomeString` or `vb.views["Some String"]` -> View ids must be unique within a single view builder instance. - -### ViewOrigin -{ 1 : [`ViewPosition`](#ViewPosition), 2 : [`ViewPosition`](#ViewPosition) } | { x : [`ViewPosition`](#ViewPosition), y : [`ViewPosition`](#ViewPosition) } -> The position of a view within its parent view. -> Only the `stack` layouts allows to freely position child views. Other -> layout views will automatically set the origin, but the origin -> then still can be read in for example mouse handlers. - -### ViewPosition -[`integer`](../../API/builtins/integer.md) -> Horizontal (x) or Vertical (y) position of a view within its parent view. - -### ViewSize -{ 1 : [`ViewDimension`](#ViewDimension), 2 : [`ViewDimension`](#ViewDimension) } | { height : [`ViewDimension`](#ViewDimension), width : [`ViewDimension`](#ViewDimension) } -> The dimensions of a view has to be larger than 0. -> For nested views you can also specify relative size, for example -> `vb:text { size = { width = "80%", height = 20}}`. -> The percentage values are relative to the view's parent size and will -> automatically update when the parent view's size changes. - -### ViewTooltip -[`string`](../../API/builtins/string.md) -> A ViewTooltip text that should be shown for this view on mouse hover. -> * Default: "" (no tip will be shown) - -### ViewVisibility -[`boolean`](../../API/builtins/boolean.md) -> Set visible to false to hide a view (make it invisible without removing -> it). Please note that view.visible will also return false when any of its -> parents are invisible (when its implicitly invisible). -> * Default: true - - - -# ValueBoxProperties - ---- -## Properties -### active : [`ControlActive`](#ControlActive)[`?`](../../API/builtins/nil.md) -> Instead of making a control invisible, you can also make it inactive. -> Deactivated controls will still be shown, and will still show their -> currently assigned values, but will not allow changes. Most controls will -> display as "grayed out" to visualize the deactivated state. - -### midi_mapping : [`ControlMidiMappingString`](#ControlMidiMappingString)[`?`](../../API/builtins/nil.md) -> When set, the control will be highlighted when Renoise's MIDI mapping dialog -> is open. When clicked, it selects the specified string as a MIDI mapping -> target action. This target acton can either be one of the globally available -> mappings in Renoise, or those that were created by the tool itself. -> Target strings are not verified. When they point to nothing, the mapped MIDI -> message will do nothing and no error is fired. - -### bind : [`ViewNumberObservable`](#ViewNumberObservable)[`?`](../../API/builtins/nil.md) -> Bind the view's value to a renoise.Document.ObservableNumber object. -> Automatically keep them in sync. -> The view will change the Observable value as soon as its value changes -> and change the view's value as soon as the Observable's value changes. -> Notifiers can be added to either the view or the Observable object. - -### value : [`SliderNumberValue`](#SliderNumberValue)[`?`](../../API/builtins/nil.md) -> The current value of the view - -### notifier : [`NumberValueNotifier`](#NumberValueNotifier)[`?`](../../API/builtins/nil.md) -> Set up a value notifier that will be called whenever the value changes - -### min : [`ValueBoxMinValue`](#ValueBoxMinValue)[`?`](../../API/builtins/nil.md) -> The minimum value that can be set using the view -> * Default: 0 - -### max : [`ValueBoxMaxValue`](#ValueBoxMaxValue)[`?`](../../API/builtins/nil.md) -> The maximum value that can be set using the view -> * Default: 100 - -### steps : [`SliderStepAmounts`](#SliderStepAmounts)[`?`](../../API/builtins/nil.md) -> A table containing two numbers representing the step amounts for incrementing -> and decrementing by clicking the <> buttons. -> The first value is the small step (applied on left clicks) -> second value is the big step (applied on right clicks) - -### tostring : [`PairedShowNumberAsString`](#PairedShowNumberAsString)[`?`](../../API/builtins/nil.md) -> Make sure to also set `tonumber` if you set this. - -### tonumber : [`PairedParseStringAsNumber`](#PairedParseStringAsNumber)[`?`](../../API/builtins/nil.md) -> Make sure to also set `tostring` if you set this. - -### id : [`ViewId`](#ViewId)[`?`](../../API/builtins/nil.md) -> Unique identifier to resolve the view later on in the viewbuilder, -> e.g. `vb.views.SomeString` or `vb.views["Some String"]` -> View ids must be unique within a single view builder instance. - -### visible : [`ViewVisibility`](#ViewVisibility)[`?`](../../API/builtins/nil.md) -> Set visible to false to hide a view (make it invisible without removing -> it). Please note that view.visible will also return false when any of its -> parents are invisible (when its implicitly invisible). -> * Default: true - -### origin : [`ViewOrigin`](#ViewOrigin)[`?`](../../API/builtins/nil.md) -> The position of a view within its parent view. -> Only the `stack` layouts allows to freely position child views. Other -> layout views will automatically set the origin, but the origin -> then still can be read in for example mouse handlers. - -### width : [`ViewDimension`](#ViewDimension)[`?`](../../API/builtins/nil.md) -> **Deprecated.** Use property `size` instead. - -### height : [`ViewDimension`](#ViewDimension)[`?`](../../API/builtins/nil.md) -> **Deprecated.** Use property `size` instead. - -### size : [`ViewSize`](#ViewSize)[`?`](../../API/builtins/nil.md) -> The dimensions of a view has to be larger than 0. -> For nested views you can also specify relative size, for example -> `vb:text { size = { width = "80%", height = 20}}`. -> The percentage values are relative to the view's parent size and will -> automatically update when the parent view's size changes. - -### tooltip : [`ViewTooltip`](#ViewTooltip)[`?`](../../API/builtins/nil.md) -> A ViewTooltip text that should be shown for this view on mouse hover. -> * Default: "" (no tip will be shown) - -### cursor : [`ViewCursorShape`](#ViewCursorShape)[`?`](../../API/builtins/nil.md) -> The cursor cursor for this view which apears on mouse hover. -> Using a "none" shape will use use underlying view's cursor or the default cursor. - - - - - ---- -## Aliases -### ControlActive -[`boolean`](../../API/builtins/boolean.md) -> Instead of making a control invisible, you can also make it inactive. -> Deactivated controls will still be shown, and will still show their -> currently assigned values, but will not allow changes. Most controls will -> display as "grayed out" to visualize the deactivated state. - -### ControlMidiMappingString -[`string`](../../API/builtins/string.md) -> When set, the control will be highlighted when Renoise's MIDI mapping dialog -> is open. When clicked, it selects the specified string as a MIDI mapping -> target action. This target acton can either be one of the globally available -> mappings in Renoise, or those that were created by the tool itself. -> Target strings are not verified. When they point to nothing, the mapped MIDI -> message will do nothing and no error is fired. - -### NotifierFunction -fun() - - -### NotifierMemberContext -[`table`](../../API/builtins/table.md) | [`userdata`](../../API/builtins/userdata.md) - - -### NumberValueNotifier -[`NumberValueNotifierFunction`](#NumberValueNotifierFunction) | [`NumberValueNotifierMethod1`](#NumberValueNotifierMethod1) | [`NumberValueNotifierMethod2`](#NumberValueNotifierMethod2) -> Set up a value notifier that will be called whenever the value changes - -### NumberValueNotifierFunction -(value : [`number`](../../API/builtins/number.md)) - - -### NumberValueNotifierMemberFunction -(self : [`NotifierMemberContext`](#NotifierMemberContext), value : [`number`](../../API/builtins/number.md)) - - -### NumberValueNotifierMethod1 -{ 1 : [`NotifierMemberContext`](#NotifierMemberContext), 2 : [`NumberValueNotifierMemberFunction`](#NumberValueNotifierMemberFunction) } - - -### NumberValueNotifierMethod2 -{ 1 : [`NumberValueNotifierMemberFunction`](#NumberValueNotifierMemberFunction), 2 : [`NotifierMemberContext`](#NotifierMemberContext) } - - -### PairedParseStringAsNumber -(value : [`string`](../../API/builtins/string.md)) `->` [`number`](../../API/builtins/number.md)[`?`](../../API/builtins/nil.md) -> Make sure to also set `tostring` if you set this. - -### PairedShowNumberAsString -[`ShowNumberAsString`](#ShowNumberAsString) -> Make sure to also set `tonumber` if you set this. - -### ShowNumberAsString -(value : [`number`](../../API/builtins/number.md)) `->` [`string`](../../API/builtins/string.md)[`?`](../../API/builtins/nil.md) -> Set a custom rule on how a number value should be displayed. -> Useful for showing units like decibel or note values etc. -> If none are set, a default string/number conversion is done, which -> simply shows the number with 3 digits after the decimal point. -> Note: When the callback fails with an error, it will be disabled to avoid -> a flood of error messages. - -### SliderNumberValue -[`number`](../../API/builtins/number.md) -> The current value of the view - -### SliderStepAmounts -{ 1 : [`number`](../../API/builtins/number.md), 2 : [`number`](../../API/builtins/number.md) } -> A table containing two numbers representing the step amounts for incrementing -> and decrementing by clicking the <> buttons. -> The first value is the small step (applied on left clicks) -> second value is the big step (applied on right clicks) - -### ValueBoxMaxValue -[`number`](../../API/builtins/number.md) -> The maximum value that can be set using the view -> * Default: 100 - -### ValueBoxMinValue -[`number`](../../API/builtins/number.md) -> The minimum value that can be set using the view -> * Default: 0 - -### ViewCursorShape -`"busy"` | `"change_value"` | `"crosshair"` | `"default"` | `"drag"` | `"drop"` | `"edit_text"` | `"empty"` | `"erase"` | `"extend_bottom"` | `"extend_bottom_alias"` | `"extend_left"` | `"extend_left_alias"` | `"extend_right"` | `"extend_right_alias"` | `"extend_top"` | `"extend_top_alias"` | `"marker"` | `"move"` | `"nodrop"` | `"none"` | `"pencil"` | `"play"` | `"resize_edge_diagonal_left"` | `"resize_edge_diagonal_right"` | `"resize_edge_horizontal"` | `"resize_edge_vertical"` | `"resize_horizontal"` | `"resize_vertical"` | `"zoom"` | `"zoom_horizontal"` | `"zoom_vertical"` -> ```lua -> -- The cursor cursor for this view which apears on mouse hover. -> -- Using a "none" shape will use use underlying view's cursor or the default cursor. -> ViewCursorShape: -> | "none" -> | "empty" -> | "default" -> | "change_value" -> | "edit_text" -> | "pencil" -> | "marker" -> | "crosshair" -> | "move" -> | "erase" -> | "play" -> | "drag" -> | "drop" -> | "nodrop" -> | "busy" -> | "resize_vertical" -> | "resize_horizontal" -> | "resize_edge_vertical" -> | "resize_edge_horizontal" -> | "resize_edge_diagonal_left" -> | "resize_edge_diagonal_right" -> | "extend_left" -> | "extend_right" -> | "extend_top" -> | "extend_bottom" -> | "extend_left_alias" -> | "extend_right_alias" -> | "extend_top_alias" -> | "extend_bottom_alias" -> | "zoom_vertical" -> | "zoom_horizontal" -> | "zoom" -> ``` - -### ViewDimension -[`string`](../../API/builtins/string.md) | [`integer`](../../API/builtins/integer.md) -> The dimensions of a view has to be larger than 0. -> For nested views you can also specify relative size -> for example `vb:text { width = "80%"}`. The percentage values are -> relative to the view's parent size and will automatically update on size changes. - -### ViewId -[`string`](../../API/builtins/string.md) -> Unique identifier to resolve the view later on in the viewbuilder, -> e.g. `vb.views.SomeString` or `vb.views["Some String"]` -> View ids must be unique within a single view builder instance. - -### ViewNumberObservable -[`renoise.Document.ObservableNumber`](../../API/renoise/renoise.Document.ObservableNumber.md) -> Bind the view's value to a renoise.Document.ObservableNumber object. -> Automatically keep them in sync. -> The view will change the Observable value as soon as its value changes -> and change the view's value as soon as the Observable's value changes. -> Notifiers can be added to either the view or the Observable object. - -### ViewOrigin -{ 1 : [`ViewPosition`](#ViewPosition), 2 : [`ViewPosition`](#ViewPosition) } | { x : [`ViewPosition`](#ViewPosition), y : [`ViewPosition`](#ViewPosition) } -> The position of a view within its parent view. -> Only the `stack` layouts allows to freely position child views. Other -> layout views will automatically set the origin, but the origin -> then still can be read in for example mouse handlers. - -### ViewPosition -[`integer`](../../API/builtins/integer.md) -> Horizontal (x) or Vertical (y) position of a view within its parent view. - -### ViewSize -{ 1 : [`ViewDimension`](#ViewDimension), 2 : [`ViewDimension`](#ViewDimension) } | { height : [`ViewDimension`](#ViewDimension), width : [`ViewDimension`](#ViewDimension) } -> The dimensions of a view has to be larger than 0. -> For nested views you can also specify relative size, for example -> `vb:text { size = { width = "80%", height = 20}}`. -> The percentage values are relative to the view's parent size and will -> automatically update when the parent view's size changes. - -### ViewTooltip -[`string`](../../API/builtins/string.md) -> A ViewTooltip text that should be shown for this view on mouse hover. -> * Default: "" (no tip will be shown) - -### ViewVisibility -[`boolean`](../../API/builtins/boolean.md) -> Set visible to false to hide a view (make it invisible without removing -> it). Please note that view.visible will also return false when any of its -> parents are invisible (when its implicitly invisible). -> * Default: true - - - -# ValueFieldProperties - ---- -## Properties -### active : [`ControlActive`](#ControlActive)[`?`](../../API/builtins/nil.md) -> Instead of making a control invisible, you can also make it inactive. -> Deactivated controls will still be shown, and will still show their -> currently assigned values, but will not allow changes. Most controls will -> display as "grayed out" to visualize the deactivated state. - -### midi_mapping : [`ControlMidiMappingString`](#ControlMidiMappingString)[`?`](../../API/builtins/nil.md) -> When set, the control will be highlighted when Renoise's MIDI mapping dialog -> is open. When clicked, it selects the specified string as a MIDI mapping -> target action. This target acton can either be one of the globally available -> mappings in Renoise, or those that were created by the tool itself. -> Target strings are not verified. When they point to nothing, the mapped MIDI -> message will do nothing and no error is fired. - -### bind : [`ViewNumberObservable`](#ViewNumberObservable)[`?`](../../API/builtins/nil.md) -> Bind the view's value to a renoise.Document.ObservableNumber object. -> Automatically keep them in sync. -> The view will change the Observable value as soon as its value changes -> and change the view's value as soon as the Observable's value changes. -> Notifiers can be added to either the view or the Observable object. - -### value : [`SliderNumberValue`](#SliderNumberValue)[`?`](../../API/builtins/nil.md) -> The current value of the view - -### notifier : [`NumberValueNotifier`](#NumberValueNotifier)[`?`](../../API/builtins/nil.md) -> Set up a value notifier that will be called whenever the value changes - -### min : [`SliderMinValue`](#SliderMinValue)[`?`](../../API/builtins/nil.md) -> The minimum value that can be set using the view -> * Default: 0 - -### max : [`SliderMaxValue`](#SliderMaxValue)[`?`](../../API/builtins/nil.md) -> The maximum value that can be set using the view -> * Default: 1.0 - -### align : [`TextAlignment`](#TextAlignment)[`?`](../../API/builtins/nil.md) -> Setup the text's alignment. Applies only when the view's size is larger than -> the needed size to draw the text - -### tostring : [`PairedShowNumberAsString`](#PairedShowNumberAsString)[`?`](../../API/builtins/nil.md) -> Make sure to also set `tonumber` if you set this. - -### tonumber : [`PairedParseStringAsNumber`](#PairedParseStringAsNumber)[`?`](../../API/builtins/nil.md) -> Make sure to also set `tostring` if you set this. - -### id : [`ViewId`](#ViewId)[`?`](../../API/builtins/nil.md) -> Unique identifier to resolve the view later on in the viewbuilder, -> e.g. `vb.views.SomeString` or `vb.views["Some String"]` -> View ids must be unique within a single view builder instance. - -### visible : [`ViewVisibility`](#ViewVisibility)[`?`](../../API/builtins/nil.md) -> Set visible to false to hide a view (make it invisible without removing -> it). Please note that view.visible will also return false when any of its -> parents are invisible (when its implicitly invisible). -> * Default: true - -### origin : [`ViewOrigin`](#ViewOrigin)[`?`](../../API/builtins/nil.md) -> The position of a view within its parent view. -> Only the `stack` layouts allows to freely position child views. Other -> layout views will automatically set the origin, but the origin -> then still can be read in for example mouse handlers. - -### width : [`ViewDimension`](#ViewDimension)[`?`](../../API/builtins/nil.md) -> **Deprecated.** Use property `size` instead. - -### height : [`ViewDimension`](#ViewDimension)[`?`](../../API/builtins/nil.md) -> **Deprecated.** Use property `size` instead. - -### size : [`ViewSize`](#ViewSize)[`?`](../../API/builtins/nil.md) -> The dimensions of a view has to be larger than 0. -> For nested views you can also specify relative size, for example -> `vb:text { size = { width = "80%", height = 20}}`. -> The percentage values are relative to the view's parent size and will -> automatically update when the parent view's size changes. - -### tooltip : [`ViewTooltip`](#ViewTooltip)[`?`](../../API/builtins/nil.md) -> A ViewTooltip text that should be shown for this view on mouse hover. -> * Default: "" (no tip will be shown) - -### cursor : [`ViewCursorShape`](#ViewCursorShape)[`?`](../../API/builtins/nil.md) -> The cursor cursor for this view which apears on mouse hover. -> Using a "none" shape will use use underlying view's cursor or the default cursor. - - - - - ---- -## Aliases -### ControlActive -[`boolean`](../../API/builtins/boolean.md) -> Instead of making a control invisible, you can also make it inactive. -> Deactivated controls will still be shown, and will still show their -> currently assigned values, but will not allow changes. Most controls will -> display as "grayed out" to visualize the deactivated state. - -### ControlMidiMappingString -[`string`](../../API/builtins/string.md) -> When set, the control will be highlighted when Renoise's MIDI mapping dialog -> is open. When clicked, it selects the specified string as a MIDI mapping -> target action. This target acton can either be one of the globally available -> mappings in Renoise, or those that were created by the tool itself. -> Target strings are not verified. When they point to nothing, the mapped MIDI -> message will do nothing and no error is fired. - -### NotifierFunction -fun() - - -### NotifierMemberContext -[`table`](../../API/builtins/table.md) | [`userdata`](../../API/builtins/userdata.md) - - -### NumberValueNotifier -[`NumberValueNotifierFunction`](#NumberValueNotifierFunction) | [`NumberValueNotifierMethod1`](#NumberValueNotifierMethod1) | [`NumberValueNotifierMethod2`](#NumberValueNotifierMethod2) -> Set up a value notifier that will be called whenever the value changes - -### NumberValueNotifierFunction -(value : [`number`](../../API/builtins/number.md)) - - -### NumberValueNotifierMemberFunction -(self : [`NotifierMemberContext`](#NotifierMemberContext), value : [`number`](../../API/builtins/number.md)) - - -### NumberValueNotifierMethod1 -{ 1 : [`NotifierMemberContext`](#NotifierMemberContext), 2 : [`NumberValueNotifierMemberFunction`](#NumberValueNotifierMemberFunction) } - - -### NumberValueNotifierMethod2 -{ 1 : [`NumberValueNotifierMemberFunction`](#NumberValueNotifierMemberFunction), 2 : [`NotifierMemberContext`](#NotifierMemberContext) } - - -### PairedParseStringAsNumber -(value : [`string`](../../API/builtins/string.md)) `->` [`number`](../../API/builtins/number.md)[`?`](../../API/builtins/nil.md) -> Make sure to also set `tostring` if you set this. - -### PairedShowNumberAsString -[`ShowNumberAsString`](#ShowNumberAsString) -> Make sure to also set `tonumber` if you set this. - -### ShowNumberAsString -(value : [`number`](../../API/builtins/number.md)) `->` [`string`](../../API/builtins/string.md)[`?`](../../API/builtins/nil.md) -> Set a custom rule on how a number value should be displayed. -> Useful for showing units like decibel or note values etc. -> If none are set, a default string/number conversion is done, which -> simply shows the number with 3 digits after the decimal point. -> Note: When the callback fails with an error, it will be disabled to avoid -> a flood of error messages. - -### SliderMaxValue -[`number`](../../API/builtins/number.md) -> The maximum value that can be set using the view -> * Default: 1.0 - -### SliderMinValue -[`number`](../../API/builtins/number.md) -> The minimum value that can be set using the view -> * Default: 0 - -### SliderNumberValue -[`number`](../../API/builtins/number.md) -> The current value of the view - -### TextAlignment -`"center"` | `"left"` | `"right"` -> ```lua -> -- Setup the text's alignment. Applies only when the view's size is larger than -> -- the needed size to draw the text -> TextAlignment: -> | "left" -- (Default) -> | "right" -- aligned to the right -> | "center" -- center text -> ``` - -### ViewCursorShape -`"busy"` | `"change_value"` | `"crosshair"` | `"default"` | `"drag"` | `"drop"` | `"edit_text"` | `"empty"` | `"erase"` | `"extend_bottom"` | `"extend_bottom_alias"` | `"extend_left"` | `"extend_left_alias"` | `"extend_right"` | `"extend_right_alias"` | `"extend_top"` | `"extend_top_alias"` | `"marker"` | `"move"` | `"nodrop"` | `"none"` | `"pencil"` | `"play"` | `"resize_edge_diagonal_left"` | `"resize_edge_diagonal_right"` | `"resize_edge_horizontal"` | `"resize_edge_vertical"` | `"resize_horizontal"` | `"resize_vertical"` | `"zoom"` | `"zoom_horizontal"` | `"zoom_vertical"` -> ```lua -> -- The cursor cursor for this view which apears on mouse hover. -> -- Using a "none" shape will use use underlying view's cursor or the default cursor. -> ViewCursorShape: -> | "none" -> | "empty" -> | "default" -> | "change_value" -> | "edit_text" -> | "pencil" -> | "marker" -> | "crosshair" -> | "move" -> | "erase" -> | "play" -> | "drag" -> | "drop" -> | "nodrop" -> | "busy" -> | "resize_vertical" -> | "resize_horizontal" -> | "resize_edge_vertical" -> | "resize_edge_horizontal" -> | "resize_edge_diagonal_left" -> | "resize_edge_diagonal_right" -> | "extend_left" -> | "extend_right" -> | "extend_top" -> | "extend_bottom" -> | "extend_left_alias" -> | "extend_right_alias" -> | "extend_top_alias" -> | "extend_bottom_alias" -> | "zoom_vertical" -> | "zoom_horizontal" -> | "zoom" -> ``` - -### ViewDimension -[`string`](../../API/builtins/string.md) | [`integer`](../../API/builtins/integer.md) -> The dimensions of a view has to be larger than 0. -> For nested views you can also specify relative size -> for example `vb:text { width = "80%"}`. The percentage values are -> relative to the view's parent size and will automatically update on size changes. - -### ViewId -[`string`](../../API/builtins/string.md) -> Unique identifier to resolve the view later on in the viewbuilder, -> e.g. `vb.views.SomeString` or `vb.views["Some String"]` -> View ids must be unique within a single view builder instance. - -### ViewNumberObservable -[`renoise.Document.ObservableNumber`](../../API/renoise/renoise.Document.ObservableNumber.md) -> Bind the view's value to a renoise.Document.ObservableNumber object. -> Automatically keep them in sync. -> The view will change the Observable value as soon as its value changes -> and change the view's value as soon as the Observable's value changes. -> Notifiers can be added to either the view or the Observable object. - -### ViewOrigin -{ 1 : [`ViewPosition`](#ViewPosition), 2 : [`ViewPosition`](#ViewPosition) } | { x : [`ViewPosition`](#ViewPosition), y : [`ViewPosition`](#ViewPosition) } -> The position of a view within its parent view. -> Only the `stack` layouts allows to freely position child views. Other -> layout views will automatically set the origin, but the origin -> then still can be read in for example mouse handlers. - -### ViewPosition -[`integer`](../../API/builtins/integer.md) -> Horizontal (x) or Vertical (y) position of a view within its parent view. - -### ViewSize -{ 1 : [`ViewDimension`](#ViewDimension), 2 : [`ViewDimension`](#ViewDimension) } | { height : [`ViewDimension`](#ViewDimension), width : [`ViewDimension`](#ViewDimension) } -> The dimensions of a view has to be larger than 0. -> For nested views you can also specify relative size, for example -> `vb:text { size = { width = "80%", height = 20}}`. -> The percentage values are relative to the view's parent size and will -> automatically update when the parent view's size changes. - -### ViewTooltip -[`string`](../../API/builtins/string.md) -> A ViewTooltip text that should be shown for this view on mouse hover. -> * Default: "" (no tip will be shown) - -### ViewVisibility -[`boolean`](../../API/builtins/boolean.md) -> Set visible to false to hide a view (make it invisible without removing -> it). Please note that view.visible will also return false when any of its -> parents are invisible (when its implicitly invisible). -> * Default: true - - - -# ValueViewProperties - ---- -## Properties -### bind : [`ViewNumberObservable`](#ViewNumberObservable)[`?`](../../API/builtins/nil.md) -> Bind the view's value to a renoise.Document.ObservableNumber object. -> Automatically keep them in sync. -> The view will change the Observable value as soon as its value changes -> and change the view's value as soon as the Observable's value changes. -> Notifiers can be added to either the view or the Observable object. - -### value : [`SliderNumberValue`](#SliderNumberValue)[`?`](../../API/builtins/nil.md) -> The current value of the view - -### notifier : [`NumberValueNotifier`](#NumberValueNotifier)[`?`](../../API/builtins/nil.md) -> Set up a value notifier that will be called whenever the value changes - -### align : [`TextAlignment`](#TextAlignment)[`?`](../../API/builtins/nil.md) -> Setup the text's alignment. Applies only when the view's size is larger than -> the needed size to draw the text - -### font : [`TextFontStyle`](#TextFontStyle)[`?`](../../API/builtins/nil.md) -> The style that the text should be displayed with. - -### tostring : [`ShowNumberAsString`](#ShowNumberAsString)[`?`](../../API/builtins/nil.md) -> Set a custom rule on how a number value should be displayed. -> Useful for showing units like decibel or note values etc. -> If none are set, a default string/number conversion is done, which -> simply shows the number with 3 digits after the decimal point. -> Note: When the callback fails with an error, it will be disabled to avoid -> a flood of error messages. - -### id : [`ViewId`](#ViewId)[`?`](../../API/builtins/nil.md) -> Unique identifier to resolve the view later on in the viewbuilder, -> e.g. `vb.views.SomeString` or `vb.views["Some String"]` -> View ids must be unique within a single view builder instance. - -### visible : [`ViewVisibility`](#ViewVisibility)[`?`](../../API/builtins/nil.md) -> Set visible to false to hide a view (make it invisible without removing -> it). Please note that view.visible will also return false when any of its -> parents are invisible (when its implicitly invisible). -> * Default: true - -### origin : [`ViewOrigin`](#ViewOrigin)[`?`](../../API/builtins/nil.md) -> The position of a view within its parent view. -> Only the `stack` layouts allows to freely position child views. Other -> layout views will automatically set the origin, but the origin -> then still can be read in for example mouse handlers. - -### width : [`ViewDimension`](#ViewDimension)[`?`](../../API/builtins/nil.md) -> **Deprecated.** Use property `size` instead. - -### height : [`ViewDimension`](#ViewDimension)[`?`](../../API/builtins/nil.md) -> **Deprecated.** Use property `size` instead. - -### size : [`ViewSize`](#ViewSize)[`?`](../../API/builtins/nil.md) -> The dimensions of a view has to be larger than 0. -> For nested views you can also specify relative size, for example -> `vb:text { size = { width = "80%", height = 20}}`. -> The percentage values are relative to the view's parent size and will -> automatically update when the parent view's size changes. - -### tooltip : [`ViewTooltip`](#ViewTooltip)[`?`](../../API/builtins/nil.md) -> A ViewTooltip text that should be shown for this view on mouse hover. -> * Default: "" (no tip will be shown) - -### cursor : [`ViewCursorShape`](#ViewCursorShape)[`?`](../../API/builtins/nil.md) -> The cursor cursor for this view which apears on mouse hover. -> Using a "none" shape will use use underlying view's cursor or the default cursor. - - - - - ---- -## Aliases -### NotifierFunction -fun() - - -### NotifierMemberContext -[`table`](../../API/builtins/table.md) | [`userdata`](../../API/builtins/userdata.md) - - -### NumberValueNotifier -[`NumberValueNotifierFunction`](#NumberValueNotifierFunction) | [`NumberValueNotifierMethod1`](#NumberValueNotifierMethod1) | [`NumberValueNotifierMethod2`](#NumberValueNotifierMethod2) -> Set up a value notifier that will be called whenever the value changes - -### NumberValueNotifierFunction -(value : [`number`](../../API/builtins/number.md)) - - -### NumberValueNotifierMemberFunction -(self : [`NotifierMemberContext`](#NotifierMemberContext), value : [`number`](../../API/builtins/number.md)) - - -### NumberValueNotifierMethod1 -{ 1 : [`NotifierMemberContext`](#NotifierMemberContext), 2 : [`NumberValueNotifierMemberFunction`](#NumberValueNotifierMemberFunction) } - - -### NumberValueNotifierMethod2 -{ 1 : [`NumberValueNotifierMemberFunction`](#NumberValueNotifierMemberFunction), 2 : [`NotifierMemberContext`](#NotifierMemberContext) } - - -### ShowNumberAsString -(value : [`number`](../../API/builtins/number.md)) `->` [`string`](../../API/builtins/string.md)[`?`](../../API/builtins/nil.md) -> Set a custom rule on how a number value should be displayed. -> Useful for showing units like decibel or note values etc. -> If none are set, a default string/number conversion is done, which -> simply shows the number with 3 digits after the decimal point. -> Note: When the callback fails with an error, it will be disabled to avoid -> a flood of error messages. - -### SliderNumberValue -[`number`](../../API/builtins/number.md) -> The current value of the view - -### TextAlignment -`"center"` | `"left"` | `"right"` -> ```lua -> -- Setup the text's alignment. Applies only when the view's size is larger than -> -- the needed size to draw the text -> TextAlignment: -> | "left" -- (Default) -> | "right" -- aligned to the right -> | "center" -- center text -> ``` - -### TextFontStyle -`"big"` | `"bold"` | `"code"` | `"italic"` | `"mono"` | `"normal"` -> ```lua -> -- The style that the text should be displayed with. -> TextFontStyle: -> | "normal" -- (Default) -> | "big" -- big text -> | "bold" -- bold font -> | "italic" -- italic font -> | "mono" -- monospace font -> | "code" -- monospace code font -> ``` - -### ViewCursorShape -`"busy"` | `"change_value"` | `"crosshair"` | `"default"` | `"drag"` | `"drop"` | `"edit_text"` | `"empty"` | `"erase"` | `"extend_bottom"` | `"extend_bottom_alias"` | `"extend_left"` | `"extend_left_alias"` | `"extend_right"` | `"extend_right_alias"` | `"extend_top"` | `"extend_top_alias"` | `"marker"` | `"move"` | `"nodrop"` | `"none"` | `"pencil"` | `"play"` | `"resize_edge_diagonal_left"` | `"resize_edge_diagonal_right"` | `"resize_edge_horizontal"` | `"resize_edge_vertical"` | `"resize_horizontal"` | `"resize_vertical"` | `"zoom"` | `"zoom_horizontal"` | `"zoom_vertical"` -> ```lua -> -- The cursor cursor for this view which apears on mouse hover. -> -- Using a "none" shape will use use underlying view's cursor or the default cursor. -> ViewCursorShape: -> | "none" -> | "empty" -> | "default" -> | "change_value" -> | "edit_text" -> | "pencil" -> | "marker" -> | "crosshair" -> | "move" -> | "erase" -> | "play" -> | "drag" -> | "drop" -> | "nodrop" -> | "busy" -> | "resize_vertical" -> | "resize_horizontal" -> | "resize_edge_vertical" -> | "resize_edge_horizontal" -> | "resize_edge_diagonal_left" -> | "resize_edge_diagonal_right" -> | "extend_left" -> | "extend_right" -> | "extend_top" -> | "extend_bottom" -> | "extend_left_alias" -> | "extend_right_alias" -> | "extend_top_alias" -> | "extend_bottom_alias" -> | "zoom_vertical" -> | "zoom_horizontal" -> | "zoom" -> ``` - -### ViewDimension -[`string`](../../API/builtins/string.md) | [`integer`](../../API/builtins/integer.md) -> The dimensions of a view has to be larger than 0. -> For nested views you can also specify relative size -> for example `vb:text { width = "80%"}`. The percentage values are -> relative to the view's parent size and will automatically update on size changes. - -### ViewId -[`string`](../../API/builtins/string.md) -> Unique identifier to resolve the view later on in the viewbuilder, -> e.g. `vb.views.SomeString` or `vb.views["Some String"]` -> View ids must be unique within a single view builder instance. - -### ViewNumberObservable -[`renoise.Document.ObservableNumber`](../../API/renoise/renoise.Document.ObservableNumber.md) -> Bind the view's value to a renoise.Document.ObservableNumber object. -> Automatically keep them in sync. -> The view will change the Observable value as soon as its value changes -> and change the view's value as soon as the Observable's value changes. -> Notifiers can be added to either the view or the Observable object. - -### ViewOrigin -{ 1 : [`ViewPosition`](#ViewPosition), 2 : [`ViewPosition`](#ViewPosition) } | { x : [`ViewPosition`](#ViewPosition), y : [`ViewPosition`](#ViewPosition) } -> The position of a view within its parent view. -> Only the `stack` layouts allows to freely position child views. Other -> layout views will automatically set the origin, but the origin -> then still can be read in for example mouse handlers. - -### ViewPosition -[`integer`](../../API/builtins/integer.md) -> Horizontal (x) or Vertical (y) position of a view within its parent view. - -### ViewSize -{ 1 : [`ViewDimension`](#ViewDimension), 2 : [`ViewDimension`](#ViewDimension) } | { height : [`ViewDimension`](#ViewDimension), width : [`ViewDimension`](#ViewDimension) } -> The dimensions of a view has to be larger than 0. -> For nested views you can also specify relative size, for example -> `vb:text { size = { width = "80%", height = 20}}`. -> The percentage values are relative to the view's parent size and will -> automatically update when the parent view's size changes. - -### ViewTooltip -[`string`](../../API/builtins/string.md) -> A ViewTooltip text that should be shown for this view on mouse hover. -> * Default: "" (no tip will be shown) - -### ViewVisibility -[`boolean`](../../API/builtins/boolean.md) -> Set visible to false to hide a view (make it invisible without removing -> it). Please note that view.visible will also return false when any of its -> parents are invisible (when its implicitly invisible). -> * Default: true - - - -# ViewProperties -> Base for all View constructor tables in the viewbuilder. - ---- -## Properties -### id : [`ViewId`](#ViewId)[`?`](../../API/builtins/nil.md) -> Unique identifier to resolve the view later on in the viewbuilder, -> e.g. `vb.views.SomeString` or `vb.views["Some String"]` -> View ids must be unique within a single view builder instance. - -### visible : [`ViewVisibility`](#ViewVisibility)[`?`](../../API/builtins/nil.md) -> Set visible to false to hide a view (make it invisible without removing -> it). Please note that view.visible will also return false when any of its -> parents are invisible (when its implicitly invisible). -> * Default: true - -### origin : [`ViewOrigin`](#ViewOrigin)[`?`](../../API/builtins/nil.md) -> The position of a view within its parent view. -> Only the `stack` layouts allows to freely position child views. Other -> layout views will automatically set the origin, but the origin -> then still can be read in for example mouse handlers. - -### width : [`ViewDimension`](#ViewDimension)[`?`](../../API/builtins/nil.md) -> **Deprecated.** Use property `size` instead. - -### height : [`ViewDimension`](#ViewDimension)[`?`](../../API/builtins/nil.md) -> **Deprecated.** Use property `size` instead. - -### size : [`ViewSize`](#ViewSize)[`?`](../../API/builtins/nil.md) -> The dimensions of a view has to be larger than 0. -> For nested views you can also specify relative size, for example -> `vb:text { size = { width = "80%", height = 20}}`. -> The percentage values are relative to the view's parent size and will -> automatically update when the parent view's size changes. - -### tooltip : [`ViewTooltip`](#ViewTooltip)[`?`](../../API/builtins/nil.md) -> A ViewTooltip text that should be shown for this view on mouse hover. -> * Default: "" (no tip will be shown) - -### cursor : [`ViewCursorShape`](#ViewCursorShape)[`?`](../../API/builtins/nil.md) -> The cursor cursor for this view which apears on mouse hover. -> Using a "none" shape will use use underlying view's cursor or the default cursor. - - - - - ---- -## Aliases -### ViewCursorShape -`"busy"` | `"change_value"` | `"crosshair"` | `"default"` | `"drag"` | `"drop"` | `"edit_text"` | `"empty"` | `"erase"` | `"extend_bottom"` | `"extend_bottom_alias"` | `"extend_left"` | `"extend_left_alias"` | `"extend_right"` | `"extend_right_alias"` | `"extend_top"` | `"extend_top_alias"` | `"marker"` | `"move"` | `"nodrop"` | `"none"` | `"pencil"` | `"play"` | `"resize_edge_diagonal_left"` | `"resize_edge_diagonal_right"` | `"resize_edge_horizontal"` | `"resize_edge_vertical"` | `"resize_horizontal"` | `"resize_vertical"` | `"zoom"` | `"zoom_horizontal"` | `"zoom_vertical"` -> ```lua -> -- The cursor cursor for this view which apears on mouse hover. -> -- Using a "none" shape will use use underlying view's cursor or the default cursor. -> ViewCursorShape: -> | "none" -> | "empty" -> | "default" -> | "change_value" -> | "edit_text" -> | "pencil" -> | "marker" -> | "crosshair" -> | "move" -> | "erase" -> | "play" -> | "drag" -> | "drop" -> | "nodrop" -> | "busy" -> | "resize_vertical" -> | "resize_horizontal" -> | "resize_edge_vertical" -> | "resize_edge_horizontal" -> | "resize_edge_diagonal_left" -> | "resize_edge_diagonal_right" -> | "extend_left" -> | "extend_right" -> | "extend_top" -> | "extend_bottom" -> | "extend_left_alias" -> | "extend_right_alias" -> | "extend_top_alias" -> | "extend_bottom_alias" -> | "zoom_vertical" -> | "zoom_horizontal" -> | "zoom" -> ``` - -### ViewDimension -[`string`](../../API/builtins/string.md) | [`integer`](../../API/builtins/integer.md) -> The dimensions of a view has to be larger than 0. -> For nested views you can also specify relative size -> for example `vb:text { width = "80%"}`. The percentage values are -> relative to the view's parent size and will automatically update on size changes. - -### ViewId -[`string`](../../API/builtins/string.md) -> Unique identifier to resolve the view later on in the viewbuilder, -> e.g. `vb.views.SomeString` or `vb.views["Some String"]` -> View ids must be unique within a single view builder instance. - -### ViewOrigin -{ 1 : [`ViewPosition`](#ViewPosition), 2 : [`ViewPosition`](#ViewPosition) } | { x : [`ViewPosition`](#ViewPosition), y : [`ViewPosition`](#ViewPosition) } -> The position of a view within its parent view. -> Only the `stack` layouts allows to freely position child views. Other -> layout views will automatically set the origin, but the origin -> then still can be read in for example mouse handlers. - -### ViewPosition -[`integer`](../../API/builtins/integer.md) -> Horizontal (x) or Vertical (y) position of a view within its parent view. - -### ViewSize -{ 1 : [`ViewDimension`](#ViewDimension), 2 : [`ViewDimension`](#ViewDimension) } | { height : [`ViewDimension`](#ViewDimension), width : [`ViewDimension`](#ViewDimension) } -> The dimensions of a view has to be larger than 0. -> For nested views you can also specify relative size, for example -> `vb:text { size = { width = "80%", height = 20}}`. -> The percentage values are relative to the view's parent size and will -> automatically update when the parent view's size changes. - -### ViewTooltip -[`string`](../../API/builtins/string.md) -> A ViewTooltip text that should be shown for this view on mouse hover. -> * Default: "" (no tip will be shown) - -### ViewVisibility -[`boolean`](../../API/builtins/boolean.md) -> Set visible to false to hide a view (make it invisible without removing -> it). Please note that view.visible will also return false when any of its -> parents are invisible (when its implicitly invisible). -> * Default: true - - - -# XYPadProperties - ---- -## Properties -### active : [`ControlActive`](#ControlActive)[`?`](../../API/builtins/nil.md) -> Instead of making a control invisible, you can also make it inactive. -> Deactivated controls will still be shown, and will still show their -> currently assigned values, but will not allow changes. Most controls will -> display as "grayed out" to visualize the deactivated state. - -### midi_mapping : [`ControlMidiMappingString`](#ControlMidiMappingString)[`?`](../../API/builtins/nil.md) -> When set, the control will be highlighted when Renoise's MIDI mapping dialog -> is open. When clicked, it selects the specified string as a MIDI mapping -> target action. This target acton can either be one of the globally available -> mappings in Renoise, or those that were created by the tool itself. -> Target strings are not verified. When they point to nothing, the mapped MIDI -> message will do nothing and no error is fired. - -### id : [`ViewId`](#ViewId)[`?`](../../API/builtins/nil.md) -> Unique identifier to resolve the view later on in the viewbuilder, -> e.g. `vb.views.SomeString` or `vb.views["Some String"]` -> View ids must be unique within a single view builder instance. - -### visible : [`ViewVisibility`](#ViewVisibility)[`?`](../../API/builtins/nil.md) -> Set visible to false to hide a view (make it invisible without removing -> it). Please note that view.visible will also return false when any of its -> parents are invisible (when its implicitly invisible). -> * Default: true - -### origin : [`ViewOrigin`](#ViewOrigin)[`?`](../../API/builtins/nil.md) -> The position of a view within its parent view. -> Only the `stack` layouts allows to freely position child views. Other -> layout views will automatically set the origin, but the origin -> then still can be read in for example mouse handlers. - -### width : [`ViewDimension`](#ViewDimension)[`?`](../../API/builtins/nil.md) -> **Deprecated.** Use property `size` instead. - -### height : [`ViewDimension`](#ViewDimension)[`?`](../../API/builtins/nil.md) -> **Deprecated.** Use property `size` instead. - -### size : [`ViewSize`](#ViewSize)[`?`](../../API/builtins/nil.md) -> The dimensions of a view has to be larger than 0. -> For nested views you can also specify relative size, for example -> `vb:text { size = { width = "80%", height = 20}}`. -> The percentage values are relative to the view's parent size and will -> automatically update when the parent view's size changes. - -### tooltip : [`ViewTooltip`](#ViewTooltip)[`?`](../../API/builtins/nil.md) -> A ViewTooltip text that should be shown for this view on mouse hover. -> * Default: "" (no tip will be shown) - -### cursor : [`ViewCursorShape`](#ViewCursorShape)[`?`](../../API/builtins/nil.md) -> The cursor cursor for this view which apears on mouse hover. -> Using a "none" shape will use use underlying view's cursor or the default cursor. - -### bind : [`XYPadObservables`](#XYPadObservables)[`?`](../../API/builtins/nil.md) -> Bind the view's value to a pair of renoise.Document.ObservableNumber objects. -> Automatically keep both values in sync. -> Will change the Observables' values as soon as the view's value changes, -> and change the view's values as soon as the Observable's value changes. -> Notifiers can be added to either the view or the Observable object. -> Just like in the other XYPad properties, a table with the fields X and Y -> is expected here and not a single value. So you have to bind two -> ObservableNumber object to the pad. - -### value : [`XYPadValues`](#XYPadValues)[`?`](../../API/builtins/nil.md) -> A table of the XYPad's current values on each axis - -### snapback : [`XYPadSnapbackValues`](#XYPadSnapbackValues)[`?`](../../API/builtins/nil.md) -> A table of snapback values for each axis -> When snapback is enabled, the pad will revert its values to the specified -> snapback values as soon as the mouse button is released in the pad. -> When disabled, releasing the mouse button will not change the value. -> You can disable snapback at runtime by setting it to nil or an empty table. - -### notifier : [`XYValueNotifier`](#XYValueNotifier)[`?`](../../API/builtins/nil.md) -> Set up a value notifier function that will be used whenever the pad's values change - -### min : [`XYPadMinValues`](#XYPadMinValues)[`?`](../../API/builtins/nil.md) -> A table of allowed minimum values for each axis -> * Default: {x: 0.0, y: 0.0} - -### max : [`XYPadMaxValues`](#XYPadMaxValues)[`?`](../../API/builtins/nil.md) -> A table of allowed maximum values for each axis -> * Default: {x: 1.0, y: 1.0} - - - - - ---- -## Aliases -### ControlActive -[`boolean`](../../API/builtins/boolean.md) -> Instead of making a control invisible, you can also make it inactive. -> Deactivated controls will still be shown, and will still show their -> currently assigned values, but will not allow changes. Most controls will -> display as "grayed out" to visualize the deactivated state. - -### ControlMidiMappingString -[`string`](../../API/builtins/string.md) -> When set, the control will be highlighted when Renoise's MIDI mapping dialog -> is open. When clicked, it selects the specified string as a MIDI mapping -> target action. This target acton can either be one of the globally available -> mappings in Renoise, or those that were created by the tool itself. -> Target strings are not verified. When they point to nothing, the mapped MIDI -> message will do nothing and no error is fired. - -### NotifierFunction -fun() - - -### NotifierMemberContext -[`table`](../../API/builtins/table.md) | [`userdata`](../../API/builtins/userdata.md) - - -### SliderMaxValue -[`number`](../../API/builtins/number.md) -> The maximum value that can be set using the view -> * Default: 1.0 - -### SliderMinValue -[`number`](../../API/builtins/number.md) -> The minimum value that can be set using the view -> * Default: 0 - -### SliderNumberValue -[`number`](../../API/builtins/number.md) -> The current value of the view - -### ViewCursorShape -`"busy"` | `"change_value"` | `"crosshair"` | `"default"` | `"drag"` | `"drop"` | `"edit_text"` | `"empty"` | `"erase"` | `"extend_bottom"` | `"extend_bottom_alias"` | `"extend_left"` | `"extend_left_alias"` | `"extend_right"` | `"extend_right_alias"` | `"extend_top"` | `"extend_top_alias"` | `"marker"` | `"move"` | `"nodrop"` | `"none"` | `"pencil"` | `"play"` | `"resize_edge_diagonal_left"` | `"resize_edge_diagonal_right"` | `"resize_edge_horizontal"` | `"resize_edge_vertical"` | `"resize_horizontal"` | `"resize_vertical"` | `"zoom"` | `"zoom_horizontal"` | `"zoom_vertical"` -> ```lua -> -- The cursor cursor for this view which apears on mouse hover. -> -- Using a "none" shape will use use underlying view's cursor or the default cursor. -> ViewCursorShape: -> | "none" -> | "empty" -> | "default" -> | "change_value" -> | "edit_text" -> | "pencil" -> | "marker" -> | "crosshair" -> | "move" -> | "erase" -> | "play" -> | "drag" -> | "drop" -> | "nodrop" -> | "busy" -> | "resize_vertical" -> | "resize_horizontal" -> | "resize_edge_vertical" -> | "resize_edge_horizontal" -> | "resize_edge_diagonal_left" -> | "resize_edge_diagonal_right" -> | "extend_left" -> | "extend_right" -> | "extend_top" -> | "extend_bottom" -> | "extend_left_alias" -> | "extend_right_alias" -> | "extend_top_alias" -> | "extend_bottom_alias" -> | "zoom_vertical" -> | "zoom_horizontal" -> | "zoom" -> ``` - -### ViewDimension -[`string`](../../API/builtins/string.md) | [`integer`](../../API/builtins/integer.md) -> The dimensions of a view has to be larger than 0. -> For nested views you can also specify relative size -> for example `vb:text { width = "80%"}`. The percentage values are -> relative to the view's parent size and will automatically update on size changes. - -### ViewId -[`string`](../../API/builtins/string.md) -> Unique identifier to resolve the view later on in the viewbuilder, -> e.g. `vb.views.SomeString` or `vb.views["Some String"]` -> View ids must be unique within a single view builder instance. - -### ViewOrigin -{ 1 : [`ViewPosition`](#ViewPosition), 2 : [`ViewPosition`](#ViewPosition) } | { x : [`ViewPosition`](#ViewPosition), y : [`ViewPosition`](#ViewPosition) } -> The position of a view within its parent view. -> Only the `stack` layouts allows to freely position child views. Other -> layout views will automatically set the origin, but the origin -> then still can be read in for example mouse handlers. - -### ViewPosition -[`integer`](../../API/builtins/integer.md) -> Horizontal (x) or Vertical (y) position of a view within its parent view. - -### ViewSize -{ 1 : [`ViewDimension`](#ViewDimension), 2 : [`ViewDimension`](#ViewDimension) } | { height : [`ViewDimension`](#ViewDimension), width : [`ViewDimension`](#ViewDimension) } -> The dimensions of a view has to be larger than 0. -> For nested views you can also specify relative size, for example -> `vb:text { size = { width = "80%", height = 20}}`. -> The percentage values are relative to the view's parent size and will -> automatically update when the parent view's size changes. - -### ViewTooltip -[`string`](../../API/builtins/string.md) -> A ViewTooltip text that should be shown for this view on mouse hover. -> * Default: "" (no tip will be shown) - -### ViewVisibility -[`boolean`](../../API/builtins/boolean.md) -> Set visible to false to hide a view (make it invisible without removing -> it). Please note that view.visible will also return false when any of its -> parents are invisible (when its implicitly invisible). -> * Default: true - -### XYPadMaxValues -{ x : [`SliderMaxValue`](#SliderMaxValue), y : [`SliderMaxValue`](#SliderMaxValue) } -> A table of allowed maximum values for each axis -> * Default: {x: 1.0, y: 1.0} - -### XYPadMinValues -{ x : [`SliderMinValue`](#SliderMinValue), y : [`SliderMinValue`](#SliderMinValue) } -> A table of allowed minimum values for each axis -> * Default: {x: 0.0, y: 0.0} - -### XYPadObservables -{ x : [`renoise.Document.ObservableNumber`](../../API/renoise/renoise.Document.ObservableNumber.md), y : [`renoise.Document.ObservableNumber`](../../API/renoise/renoise.Document.ObservableNumber.md) } -> Bind the view's value to a pair of renoise.Document.ObservableNumber objects. -> Automatically keep both values in sync. -> Will change the Observables' values as soon as the view's value changes, -> and change the view's values as soon as the Observable's value changes. -> Notifiers can be added to either the view or the Observable object. -> Just like in the other XYPad properties, a table with the fields X and Y -> is expected here and not a single value. So you have to bind two -> ObservableNumber object to the pad. - -### XYPadSnapbackValues -{ x : [`number`](../../API/builtins/number.md), y : [`number`](../../API/builtins/number.md) } -> A table of snapback values for each axis -> When snapback is enabled, the pad will revert its values to the specified -> snapback values as soon as the mouse button is released in the pad. -> When disabled, releasing the mouse button will not change the value. -> You can disable snapback at runtime by setting it to nil or an empty table. - -### XYPadValues -{ x : [`SliderNumberValue`](#SliderNumberValue), y : [`SliderNumberValue`](#SliderNumberValue) } -> A table of the XYPad's current values on each axis - -### XYValueNotifier -[`XYValueNotifierFunction`](#XYValueNotifierFunction) | [`XYValueNotifierMethod1`](#XYValueNotifierMethod1) | [`XYValueNotifierMethod2`](#XYValueNotifierMethod2) -> Set up a value notifier function that will be used whenever the pad's values change - -### XYValueNotifierFunction -(value : [`XYPadValues`](#XYPadValues)) - - -### XYValueNotifierMemberFunction -(self : [`NotifierMemberContext`](#NotifierMemberContext), value : [`XYPadValues`](#XYPadValues)) - - -### XYValueNotifierMethod1 -{ 1 : [`NotifierMemberContext`](#NotifierMemberContext), 2 : [`XYValueNotifierMemberFunction`](#XYValueNotifierMemberFunction) } - - -### XYValueNotifierMethod2 -{ 1 : [`XYValueNotifierMemberFunction`](#XYValueNotifierMemberFunction), 2 : [`NotifierMemberContext`](#NotifierMemberContext) } - - - - - - - ---- -## Aliases -### AlignerChildViews -[`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)[] -> The aligner view's initial child views. -> Views can later on also be added and removed dynamically after construction via -> `aligner:add_view(child)` and `aligner:remove_view(child)` - -### AlignerMode -`"bottom"` | `"center"` | `"distribute"` | `"justify"` | `"left"` | `"right"` | `"top"` -> ```lua -> -- * Default: "left" (for horizontal_aligner) "top" (for vertical_aligner) -> AlignerMode: -> | "left" -- align from left to right (for horizontal_aligner only) -> | "right" -- align from right to left (for horizontal_aligner only) -> | "top" -- align from top to bottom (for vertical_aligner only) -> | "bottom" -- align from bottom to top (for vertical_aligner only) -> | "center" -- center all views -> | "justify" -- keep outer views at the borders, distribute the rest -> | "distribute" -- equally distributes views over the aligners width/height -> ``` - -### BitmapColor -[`RGBColor`](#RGBColor) | [`ThemeColor`](#ThemeColor) -> ```lua -> -- When set, the bitmap will be drawn in the specified color and `mode` is set -> -- to `custom_color`. Set `mode` to something else than `custom_color` or the -> -- `color` to `{0, 0, 0}` to enable a `plain` display mode. -> -- A table of 3 bytes (ranging from 0 to 255) -> -- representing the red, green and blue channels of a color. -> -- {0xFF, 0xFF, 0xFF} is white -> -- {165, 73, 35} is the red from the Renoise logo -> -- The application theme's colors -> BitmapColor: -> | "main_back" -> | "main_font" -> | "alternate_main_back" -> | "alternate_main_font" -> | "body_back" -> | "body_font" -> | "strong_body_font" -> | "button_back" -> | "button_font" -> | "button_highlight_font" -> | "selected_button_back" -> | "selected_button_font" -> | "selection_back" -> | "selection_font" -> | "standby_selection_back" -> | "standby_selection_font" -> | "midi_mapping_back" -> | "midi_mapping_font" -> | "tooltip_back" -> | "tooltip_font" -> | "valuebox_back" -> | "valuebox_font" -> | "valuebox_font_icons" -> | "scrollbar" -> | "slider" -> | "folder" -> | "pattern_default_back" -> | "pattern_default_font" -> | "pattern_default_font_volume" -> | "pattern_default_font_panning" -> | "pattern_default_font_pitch" -> | "pattern_default_font_delay" -> | "pattern_default_font_global" -> | "pattern_default_font_other" -> | "pattern_default_font_dspfx" -> | "pattern_default_font_unused" -> | "pattern_highlighted_back" -> | "pattern_highlighted_font" -> | "pattern_highlighted_font_volume" -> | "pattern_highlighted_font_panning" -> | "pattern_highlighted_font_pitch" -> | "pattern_highlighted_font_delay" -> | "pattern_highlighted_font_global" -> | "pattern_highlighted_font_other" -> | "pattern_highlighted_font_dspfx" -> | "pattern_highlighted_font_unused" -> | "pattern_playposition_back" -> | "pattern_playposition_font" -> | "pattern_centerbar_back" -> | "pattern_centerbar_font" -> | "pattern_centerbar_back_standby" -> | "pattern_centerbar_font_standby" -> | "pattern_selection" -> | "pattern_standby_selection" -> | "pattern_mute_state" -> | "automation_grid" -> | "automation_line_edge" -> | "automation_line_fill" -> | "automation_point" -> | "automation_marker_play" -> | "automation_marker_single" -> | "automation_marker_pair" -> | "automation_marker_diamond" -> | "vumeter_meter" -> | "vumeter_meter_low" -> | "vumeter_meter_middle" -> | "vumeter_meter_high" -> | "vumeter_peak" -> | "vumeter_back_normal" -> | "vumeter_back_clipped" -> | "default_color_01" -> | "default_color_02" -> | "default_color_03" -> | "default_color_04" -> | "default_color_05" -> | "default_color_06" -> | "default_color_07" -> | "default_color_08" -> | "default_color_09" -> | "default_color_10" -> | "default_color_11" -> | "default_color_12" -> | "default_color_13" -> | "default_color_14" -> | "default_color_15" -> | "default_color_16" -> ``` - -### BitmapImagePath -[`string`](../../API/builtins/string.md) -> You can load an image from your tool's directory, -> or use one from Renoise's built-in icons. -> * For the built-in icons, use "Icons/ArrowRight.bmp" -> * For custom images, use a path relative to your tool's root folder. -> -> For example "Images/MyBitmap.bmp" will load the image from -> "com.me.MyTool.xrnx/Images/MyBitmap.bmp". -> If your custom path matches a built-in icon's (like "Icons/ArrowRight.bmp"), -> your image will be loaded instead of the one from Renoise. -> -> If you want to support high DPI UI scaling with your bitmaps like the -> built-in Icons, include high resolution versions with their filenames ending -> with "@4x" -> The following rules will be used when loading bitmaps -> * When UI scaling is 100%, only the base bitmaps are used. -> * When UI scaling is 125%, the base bitmaps are used, except if there is a -> ` BitmapName@x1.25.bmp` variant. -> * For all other UI scaling > 125% the "@4x" variants are used and -> downscaled as needed, except when there is an exact match for the current -> UI scaling factor (e.g. `BitmapName@1.5x.bmp` for 150%) - -### BitmapMode -`"body_color"` | `"button_color"` | `"custom_color"` | `"main_color"` | `"plain"` | `"transparent"` -> ```lua -> -- Setup how the bitmap should be drawn, recolored. Available modes are: -> BitmapMode: -> | "plain" -- bitmap is drawn as is, no recoloring is done (Default) -> | "transparent" -- same as plain, but black pixels will be fully transparent -> | "button_color" -- recolor the bitmap, using the theme's button color -> | "body_color" -- same as 'button_back' but with body text/back color -> | "main_color" -- same as 'button_back' but with main text/back colors -> | "custom_color" -- Recolor the bitmap using a custom color set by the `color' -> ``` - -### BitmapPath -[`BitmapImagePath`](#BitmapImagePath) -> Supported bitmap file formats are *.bmp, *.png or *.tif (no transparency). - -### BooleanValueNotifierFunction -(value : [`boolean`](../../API/builtins/boolean.md)) - - -### BooleanValueNotifierMemberFunction -(self : [`NotifierMemberContext`](#NotifierMemberContext), value : [`boolean`](../../API/builtins/boolean.md)) - - -### BooleanValueNotifierMethod1 -{ 1 : [`NotifierMemberContext`](#NotifierMemberContext), 2 : [`BooleanValueNotifierMemberFunction`](#BooleanValueNotifierMemberFunction) } - - -### BooleanValueNotifierMethod2 -{ 1 : [`BooleanValueNotifierMemberFunction`](#BooleanValueNotifierMemberFunction), 2 : [`NotifierMemberContext`](#NotifierMemberContext) } - - -### ButtonAlignment -`"center"` | `"left"` | `"right"` -> ```lua -> -- Setup the buttons text's or bitmap's alignment within the button. -> ButtonAlignment: -> | "left" -- aligned to the left -> | "right" -- aligned to the right -> | "center" -- center (default) -> ``` - -### ButtonBitmapPath -[`BitmapImagePath`](#BitmapImagePath) -> If set, existing text is removed and the loaded image is displayed instead. -> Supported bitmap file formats are ".bmp", ".png" and ".tiff". -> Colors in bitmaps will be overridden by the button's theme color, using black -> as the transparent color for BMPs and TIFFS, and the alpha channel for PNGs. -> All other colors are mapped to the theme color according to their grey value, -> so plain white is the target theme color, and all other colors blend into the -> button's background color of the theme. - -### ButtonColor -[`RGBColor`](#RGBColor) | [`ThemeColor`](#ThemeColor) -> ```lua -> -- When set, the unpressed button's background will be drawn in the specified color. -> -- A text color is automatically selected unless explicitly set, to make sure its -> -- always visible. -> -- Set color {0,0,0} to enable the theme colors for the button again. -> -- A table of 3 bytes (ranging from 0 to 255) -> -- representing the red, green and blue channels of a color. -> -- {0xFF, 0xFF, 0xFF} is white -> -- {165, 73, 35} is the red from the Renoise logo -> -- The application theme's colors -> ButtonColor: -> | "main_back" -> | "main_font" -> | "alternate_main_back" -> | "alternate_main_font" -> | "body_back" -> | "body_font" -> | "strong_body_font" -> | "button_back" -> | "button_font" -> | "button_highlight_font" -> | "selected_button_back" -> | "selected_button_font" -> | "selection_back" -> | "selection_font" -> | "standby_selection_back" -> | "standby_selection_font" -> | "midi_mapping_back" -> | "midi_mapping_font" -> | "tooltip_back" -> | "tooltip_font" -> | "valuebox_back" -> | "valuebox_font" -> | "valuebox_font_icons" -> | "scrollbar" -> | "slider" -> | "folder" -> | "pattern_default_back" -> | "pattern_default_font" -> | "pattern_default_font_volume" -> | "pattern_default_font_panning" -> | "pattern_default_font_pitch" -> | "pattern_default_font_delay" -> | "pattern_default_font_global" -> | "pattern_default_font_other" -> | "pattern_default_font_dspfx" -> | "pattern_default_font_unused" -> | "pattern_highlighted_back" -> | "pattern_highlighted_font" -> | "pattern_highlighted_font_volume" -> | "pattern_highlighted_font_panning" -> | "pattern_highlighted_font_pitch" -> | "pattern_highlighted_font_delay" -> | "pattern_highlighted_font_global" -> | "pattern_highlighted_font_other" -> | "pattern_highlighted_font_dspfx" -> | "pattern_highlighted_font_unused" -> | "pattern_playposition_back" -> | "pattern_playposition_font" -> | "pattern_centerbar_back" -> | "pattern_centerbar_font" -> | "pattern_centerbar_back_standby" -> | "pattern_centerbar_font_standby" -> | "pattern_selection" -> | "pattern_standby_selection" -> | "pattern_mute_state" -> | "automation_grid" -> | "automation_line_edge" -> | "automation_line_fill" -> | "automation_point" -> | "automation_marker_play" -> | "automation_marker_single" -> | "automation_marker_pair" -> | "automation_marker_diamond" -> | "vumeter_meter" -> | "vumeter_meter_low" -> | "vumeter_meter_middle" -> | "vumeter_meter_high" -> | "vumeter_peak" -> | "vumeter_back_normal" -> | "vumeter_back_clipped" -> | "default_color_01" -> | "default_color_02" -> | "default_color_03" -> | "default_color_04" -> | "default_color_05" -> | "default_color_06" -> | "default_color_07" -> | "default_color_08" -> | "default_color_09" -> | "default_color_10" -> | "default_color_11" -> | "default_color_12" -> | "default_color_13" -> | "default_color_14" -> | "default_color_15" -> | "default_color_16" -> ``` - -### ButtonLabel -[`string`](../../API/builtins/string.md) -> The text label of the button -> * Default: "" - -### ButtonNotifier -[`NotifierFunction`](#NotifierFunction) | [`NotifierMethod1`](#NotifierMethod1) | [`NotifierMethod2`](#NotifierMethod2) -> A click notifier - -### ButtonStyle -`"normal"` | `"rounded"` | `"rounded_bottom"` | `"rounded_left"` | `"rounded_right"` | `"rounded_top"` -> ```lua -> -- Get/set the style a button should be displayed with. -> ButtonStyle: -> | "normal" -- (Default) -> | "rounded" -- rounded corners on all sides -> | "rounded_left" -- rounded left side -> | "rounded_right" -- rounded right side -> | "rounded_top" -- rounded left side -> | "rounded_bottom" -- rounded right side -> ``` - -### CanvasChildViews -[`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)[] -> The canvas view's optional child views. -> Views can later on also be added and removed dynamically after construction via -> `stack:add_view(child)` and `stack:remove_view(child)` - -### CanvasMode -`"plain"` | `"transparent"` -> ```lua -> -- How to draw the canvas context to screen: "transparent" draws with alpha from -> -- the canvas, "plain" ignores alpha values, which usually is a lot faster to draw. -> -- Use "plain" to speed up drawing background alike canvas views which cover the -> -- entire view area. Default: "transparent" -> CanvasMode: -> | "plain" -> | "transparent" -> ``` - -### CanvasRenderFunction -(context : [`renoise.Views.Canvas.Context`](../../API/renoise/renoise.Views.Canvas.Context.md)) -> Rendering callback for a canvas. -> -> To update the canvas, use the canvas view's `update` function. -> This will will schedule a new drawing as soon as the backend is ready to draw. -> Always draw a complete image here, as the canvas will be completely empty in -> each new render call. -> -> **UI scaling**: the canvas context by default is set up, so that the global UI -> scaling gets applied. So all positions in the canvas context by default use -> **view sizes** and not pixels. If you want to draw in a raw pixel resolution -> reset the canvas transformation via `context.set_transform(1.0, 0.0, 0.0, 1.0, 0.0, 0.0)` -> To query the actual canvas size in pixels, use the context's `size` property. - -### CheckBoxBoolean -[`boolean`](../../API/builtins/boolean.md) -> The current state of the checkbox, expressed as boolean. -> * Default: false - -### CheckBoxBooleanNotifier -[`BooleanValueNotifierFunction`](#BooleanValueNotifierFunction) | [`BooleanValueNotifierMethod1`](#BooleanValueNotifierMethod1) | [`BooleanValueNotifierMethod2`](#BooleanValueNotifierMethod2) -> A notifier for when the checkbox is toggled - -### ControlActive -[`boolean`](../../API/builtins/boolean.md) -> Instead of making a control invisible, you can also make it inactive. -> Deactivated controls will still be shown, and will still show their -> currently assigned values, but will not allow changes. Most controls will -> display as "grayed out" to visualize the deactivated state. - -### ControlMidiMappingString -[`string`](../../API/builtins/string.md) -> When set, the control will be highlighted when Renoise's MIDI mapping dialog -> is open. When clicked, it selects the specified string as a MIDI mapping -> target action. This target acton can either be one of the globally available -> mappings in Renoise, or those that were created by the tool itself. -> Target strings are not verified. When they point to nothing, the mapped MIDI -> message will do nothing and no error is fired. - -### IntegerNotifier -[`IntegerValueNotifierFunction`](#IntegerValueNotifierFunction) | [`IntegerValueNotifierMethod1`](#IntegerValueNotifierMethod1) | [`IntegerValueNotifierMethod2`](#IntegerValueNotifierMethod2) -> Set up a notifier that will be called whenever a new item is picked - -### IntegerValueNotifierFunction -(value : [`integer`](../../API/builtins/integer.md)) - - -### IntegerValueNotifierMemberFunction -(self : [`NotifierMemberContext`](#NotifierMemberContext), value : [`integer`](../../API/builtins/integer.md)) - - -### IntegerValueNotifierMethod1 -{ 1 : [`NotifierMemberContext`](#NotifierMemberContext), 2 : [`IntegerValueNotifierMemberFunction`](#IntegerValueNotifierMemberFunction) } - - -### IntegerValueNotifierMethod2 -{ 1 : [`IntegerValueNotifierMemberFunction`](#IntegerValueNotifierMemberFunction), 2 : [`NotifierMemberContext`](#NotifierMemberContext) } - - -### ItemLabels -[`string`](../../API/builtins/string.md)[] -> A list of buttons labels to show in order. Must have more than one item. - -### ListElementAdded -{ index : [`integer`](../../API/builtins/integer.md), type : `"insert"` } - - -### ListElementChange -[`ListElementAdded`](#ListElementAdded) | [`ListElementRemoved`](#ListElementRemoved) | [`ListElementsSwapped`](#ListElementsSwapped) - - -### ListElementRemoved -{ index : [`integer`](../../API/builtins/integer.md), type : `"remove"` } - - -### ListElementsSwapped -{ index1 : [`integer`](../../API/builtins/integer.md), index2 : [`integer`](../../API/builtins/integer.md), type : `"swap"` } - - -### ListNotifierFunction -(change : [`ListElementChange`](#ListElementChange)) - - -### ListNotifierMemberContext -[`table`](../../API/builtins/table.md) | [`userdata`](../../API/builtins/userdata.md) - - -### MouseEventButton -`"left"` | `"middle"` | `"right"` -> ```lua -> -- Mouse button of a `MouseEvent` of type "up"|"down"|"double"|"drag". -> MouseEventButton: -> | "left" -> | "right" -> | "middle" -> ``` - -### MouseEventType -`"double"` | `"down"` | `"drag"` | `"enter"` | `"exit"` | `"move"` | `"up"` | `"wheel"` -> ```lua -> -- Event type of a `MouseEvent`. -> MouseEventType: -> | "enter" -> | "exit" -> | "move" -> | "down" -> | "up" -> | "double" -> | "drag" -> | "wheel" -> ``` - -### MouseEventTypes -[`MouseEventType`](#MouseEventType)[] -> The mouse event types that should be passed to your `mouse_handler` function. -> By default: `{ "down", "up", "double" }` -> Avoid adding event types that you don't use, especially "move" events as they do -> create quite some overhead. Also note that when enabling "drag", sub view controls -> can no longer handle drag events, even when you pass back the event in the handler, -> so only enable it when you want to completely override mouse drag behavior of -> *all* your content views. - -### MouseEventWheelDirection -`"down"` | `"left"` | `"right"` | `"up"` -> ```lua -> -- Mouse wheel direction in a `MouseEvent` of type "wheel". -> MouseEventWheelDirection: -> | "up" -> | "down" -> | "left" -> | "right" -> ``` - -### MouseHandler -[`MouseHandlerNotifierFunction`](#MouseHandlerNotifierFunction) | [`MouseHandlerNotifierMethod1`](#MouseHandlerNotifierMethod1) | [`MouseHandlerNotifierMethod2`](#MouseHandlerNotifierMethod2) -> Optional mouse event handler for a view. return nil when the event got handled -> to stop propagating the event. return the event instance, as passed, to pass it -> to the next view in the view hirarchy. - -### MouseHandlerNotifierFunction -(event : [`MouseEvent`](#mouseevent)) `->` [`MouseEvent`](#mouseevent)[`?`](../../API/builtins/nil.md) - - -### MouseHandlerNotifierMemberFunction -(self : [`NotifierMemberContext`](#NotifierMemberContext), event : [`MouseEvent`](#mouseevent)) `->` [`MouseEvent`](#mouseevent)[`?`](../../API/builtins/nil.md) - - -### MouseHandlerNotifierMethod1 -{ 1 : [`NotifierMemberContext`](#NotifierMemberContext), 2 : [`MouseHandlerNotifierMemberFunction`](#MouseHandlerNotifierMemberFunction) } - - -### MouseHandlerNotifierMethod2 -{ 1 : [`MouseHandlerNotifierMemberFunction`](#MouseHandlerNotifierMemberFunction), 2 : [`NotifierMemberContext`](#NotifierMemberContext) } - - -### NotifierFunction -fun() - - -### NotifierMemberContext -[`table`](../../API/builtins/table.md) | [`userdata`](../../API/builtins/userdata.md) - - -### NotifierMemberFunction -(self : [`NotifierMemberContext`](#NotifierMemberContext)) - - -### NotifierMethod1 -{ 1 : [`NotifierMemberContext`](#NotifierMemberContext), 2 : [`NotifierMemberFunction`](#NotifierMemberFunction) } - - -### NotifierMethod2 -{ 1 : [`NotifierMemberFunction`](#NotifierMemberFunction), 2 : [`NotifierMemberContext`](#NotifierMemberContext) } - - -### NumberValueNotifier -[`NumberValueNotifierFunction`](#NumberValueNotifierFunction) | [`NumberValueNotifierMethod1`](#NumberValueNotifierMethod1) | [`NumberValueNotifierMethod2`](#NumberValueNotifierMethod2) -> Set up a value notifier that will be called whenever the value changes - -### NumberValueNotifierFunction -(value : [`number`](../../API/builtins/number.md)) - - -### NumberValueNotifierMemberFunction -(self : [`NotifierMemberContext`](#NotifierMemberContext), value : [`number`](../../API/builtins/number.md)) - - -### NumberValueNotifierMethod1 -{ 1 : [`NotifierMemberContext`](#NotifierMemberContext), 2 : [`NumberValueNotifierMemberFunction`](#NumberValueNotifierMemberFunction) } - - -### NumberValueNotifierMethod2 -{ 1 : [`NumberValueNotifierMemberFunction`](#NumberValueNotifierMemberFunction), 2 : [`NotifierMemberContext`](#NotifierMemberContext) } - - -### PairedParseStringAsNumber -(value : [`string`](../../API/builtins/string.md)) `->` [`number`](../../API/builtins/number.md)[`?`](../../API/builtins/nil.md) -> Make sure to also set `tostring` if you set this. - -### PairedShowNumberAsString -[`ShowNumberAsString`](#ShowNumberAsString) -> Make sure to also set `tonumber` if you set this. - -### PopupItemLabels -[`string`](../../API/builtins/string.md)[] -> A list of buttons labels to show in order -> The list can be empty, then "None" is displayed and the value won't change. - -### RGBAColor -{ 1 : [`integer`](../../API/builtins/integer.md), 2 : [`integer`](../../API/builtins/integer.md), 3 : [`integer`](../../API/builtins/integer.md), 4 : [`integer`](../../API/builtins/integer.md) } -> A table of 4 bytes (ranging from 0 to 255) -> representing the red, green, blue, alpha channels of a color. -> {0xFF, 0xFF, 0xFF, 0xFF} is white -> {165, 73, 35, 0x80} is the red from the Renoise logo, half opaque. - -### RGBColor -{ 1 : [`integer`](../../API/builtins/integer.md), 2 : [`integer`](../../API/builtins/integer.md), 3 : [`integer`](../../API/builtins/integer.md) } -> A table of 3 bytes (ranging from 0 to 255) -> representing the red, green and blue channels of a color. -> {0xFF, 0xFF, 0xFF} is white -> {165, 73, 35} is the red from the Renoise logo - -### RackChildViews -[`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)[] -> The rack view's initial child views. -> Views can later on also be added and removed dynamically after construction via -> `rack:add_view(child)` and `rack:remove_view(child)` - -### RackMargin -[`integer`](../../API/builtins/integer.md) -> Set the "borders" of a rack (left, right, top and bottom inclusively) -> * Default: 0 (no borders) - -### RackSpacing -[`integer`](../../API/builtins/integer.md) -> Set the amount stacked child views are separated by (horizontally in -> rows, vertically in columns). -> * Default: 0 (no spacing) - -### RackUniformity -[`boolean`](../../API/builtins/boolean.md) -> When set to true, all child views in the rack are automatically resized to -> the max size of all child views (width in ViewBuilder.column, height in -> ViewBuilder.row). This can be useful to automatically align all sub -> columns/panels to the same size. Resizing is done automatically, as soon -> as a child view size changes or new children are added. -> * Default: false - -### ScrollbarAutoHide -[`boolean`](../../API/builtins/boolean.md) -> Default: false. When true, view gets automatically hidden when no scrolling is needed - -### ScrollbarMax -[`integer`](../../API/builtins/integer.md) -> Default 100. Maximum offset value. - -### ScrollbarMin -[`integer`](../../API/builtins/integer.md) -> Default 0. Minimum offset value. - -### ScrollbarPagestep -[`integer`](../../API/builtins/integer.md) -> Default 100. Size of the currently visible area. - -### ScrollbarStep -[`integer`](../../API/builtins/integer.md) -> Default 1. Amount the mouse-wheel or additional +/- buttons in the scroll bar -> move the scrollable area. - -### ScrollbarValue -[`integer`](../../API/builtins/integer.md) -> Default 0. Offset value in range `min to max - pagestep`. - -### SelectedItem -[`integer`](../../API/builtins/integer.md) -> The currently selected item's index - -### ShowNumberAsString -(value : [`number`](../../API/builtins/number.md)) `->` [`string`](../../API/builtins/string.md)[`?`](../../API/builtins/nil.md) -> Set a custom rule on how a number value should be displayed. -> Useful for showing units like decibel or note values etc. -> If none are set, a default string/number conversion is done, which -> simply shows the number with 3 digits after the decimal point. -> Note: When the callback fails with an error, it will be disabled to avoid -> a flood of error messages. - -### SliderDefaultValue -[`number`](../../API/builtins/number.md) -> The default value that will be re-applied on double-click - -### SliderMaxValue -[`number`](../../API/builtins/number.md) -> The maximum value that can be set using the view -> * Default: 1.0 - -### SliderMinValue -[`number`](../../API/builtins/number.md) -> The minimum value that can be set using the view -> * Default: 0 - -### SliderNumberValue -[`number`](../../API/builtins/number.md) -> The current value of the view - -### SliderPolarity -`"bipolar"` | `"unipolar"` -> ```lua -> -- Value polarity of the control. Bipolar controls show the value from the -> -- center to left and right or up and down and typically controls a range -> -- around zero, e.g. -1 to 1. Unipolar controls show the value from left to -> -- right or bottom to top. -> -- * Default: "unipolar" -> SliderPolarity: -> | "unipolar" -> | "bipolar" -> ``` - -### SliderStepAmounts -{ 1 : [`number`](../../API/builtins/number.md), 2 : [`number`](../../API/builtins/number.md) } -> A table containing two numbers representing the step amounts for incrementing -> and decrementing by clicking the <> buttons. -> The first value is the small step (applied on left clicks) -> second value is the big step (applied on right clicks) - -### StackAutoSize -[`boolean`](../../API/builtins/boolean.md) -> When set to true, the width and height of the stack will be automatically -> calculated and updated from the stack's child views, to ensure all views fit -> into the stack. -> When disabled, the width and height must be set manually. -> * Default: true - -### StackChildViews -[`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)[] -> The stack view's optional child views. -> Views can later on also be added and removed dynamically after construction via -> `stack:add_view(child)` and `stack:remove_view(child)` - -### StringChangeNotifier -[`StringValueNotifierFunction`](#StringValueNotifierFunction) | [`StringValueNotifierMethod1`](#StringValueNotifierMethod1) | [`StringValueNotifierMethod2`](#StringValueNotifierMethod2) -> Set up a notifier for text changes - -### StringValueNotifierFunction -(value : [`string`](../../API/builtins/string.md)) - - -### StringValueNotifierMemberFunction -(self : [`NotifierMemberContext`](#NotifierMemberContext), value : [`string`](../../API/builtins/string.md)) - - -### StringValueNotifierMethod1 -{ 1 : [`NotifierMemberContext`](#NotifierMemberContext), 2 : [`StringValueNotifierMemberFunction`](#StringValueNotifierMemberFunction) } - - -### StringValueNotifierMethod2 -{ 1 : [`StringValueNotifierMemberFunction`](#StringValueNotifierMemberFunction), 2 : [`NotifierMemberContext`](#NotifierMemberContext) } - - -### TextActive -[`boolean`](../../API/builtins/boolean.md) -> When false, text is displayed but can not be entered/modified by the user. -> * Default: true - -### TextAlignment -`"center"` | `"left"` | `"right"` -> ```lua -> -- Setup the text's alignment. Applies only when the view's size is larger than -> -- the needed size to draw the text -> TextAlignment: -> | "left" -- (Default) -> | "right" -- aligned to the right -> | "center" -- center text -> ``` - -### TextBackgroundStyle -`"body"` | `"border"` | `"strong"` -> ```lua -> -- Setup the text view's background: -> TextBackgroundStyle: -> | "body" -- simple text color with no background -> | "strong" -- stronger text color with no background -> | "border" -- text on a bordered background -> ``` - -### TextColor -[`RGBColor`](#RGBColor) | [`ThemeColor`](#ThemeColor) -> ```lua -> -- When set, the text will be drawn in the specified color. -> -- Set style to something else than "custom" or color to `{0, 0, 0}` -> -- to enable the default theme color for the text again. -> -- A table of 3 bytes (ranging from 0 to 255) -> -- representing the red, green and blue channels of a color. -> -- {0xFF, 0xFF, 0xFF} is white -> -- {165, 73, 35} is the red from the Renoise logo -> -- The application theme's colors -> TextColor: -> | "main_back" -> | "main_font" -> | "alternate_main_back" -> | "alternate_main_font" -> | "body_back" -> | "body_font" -> | "strong_body_font" -> | "button_back" -> | "button_font" -> | "button_highlight_font" -> | "selected_button_back" -> | "selected_button_font" -> | "selection_back" -> | "selection_font" -> | "standby_selection_back" -> | "standby_selection_font" -> | "midi_mapping_back" -> | "midi_mapping_font" -> | "tooltip_back" -> | "tooltip_font" -> | "valuebox_back" -> | "valuebox_font" -> | "valuebox_font_icons" -> | "scrollbar" -> | "slider" -> | "folder" -> | "pattern_default_back" -> | "pattern_default_font" -> | "pattern_default_font_volume" -> | "pattern_default_font_panning" -> | "pattern_default_font_pitch" -> | "pattern_default_font_delay" -> | "pattern_default_font_global" -> | "pattern_default_font_other" -> | "pattern_default_font_dspfx" -> | "pattern_default_font_unused" -> | "pattern_highlighted_back" -> | "pattern_highlighted_font" -> | "pattern_highlighted_font_volume" -> | "pattern_highlighted_font_panning" -> | "pattern_highlighted_font_pitch" -> | "pattern_highlighted_font_delay" -> | "pattern_highlighted_font_global" -> | "pattern_highlighted_font_other" -> | "pattern_highlighted_font_dspfx" -> | "pattern_highlighted_font_unused" -> | "pattern_playposition_back" -> | "pattern_playposition_font" -> | "pattern_centerbar_back" -> | "pattern_centerbar_font" -> | "pattern_centerbar_back_standby" -> | "pattern_centerbar_font_standby" -> | "pattern_selection" -> | "pattern_standby_selection" -> | "pattern_mute_state" -> | "automation_grid" -> | "automation_line_edge" -> | "automation_line_fill" -> | "automation_point" -> | "automation_marker_play" -> | "automation_marker_single" -> | "automation_marker_pair" -> | "automation_marker_diamond" -> | "vumeter_meter" -> | "vumeter_meter_low" -> | "vumeter_meter_middle" -> | "vumeter_meter_high" -> | "vumeter_peak" -> | "vumeter_back_normal" -> | "vumeter_back_clipped" -> | "default_color_01" -> | "default_color_02" -> | "default_color_03" -> | "default_color_04" -> | "default_color_05" -> | "default_color_06" -> | "default_color_07" -> | "default_color_08" -> | "default_color_09" -> | "default_color_10" -> | "default_color_11" -> | "default_color_12" -> | "default_color_13" -> | "default_color_14" -> | "default_color_15" -> | "default_color_16" -> ``` - -### TextEditMode -[`boolean`](../../API/builtins/boolean.md) -> True when the text field is focused. setting it at run-time programmatically -> will focus the text field or remove the focus (focus the dialog) accordingly. -> * Default: false - -### TextFontStyle -`"big"` | `"bold"` | `"code"` | `"italic"` | `"mono"` | `"normal"` -> ```lua -> -- The style that the text should be displayed with. -> TextFontStyle: -> | "normal" -- (Default) -> | "big" -- big text -> | "bold" -- bold font -> | "italic" -- italic font -> | "mono" -- monospace font -> | "code" -- monospace code font -> ``` - -### TextMultilineString -[`string`](../../API/builtins/string.md) -> The text that should be displayed. -> Newlines (Windows, Mac or Unix styled) in the text can be used to create -> paragraphs. - -### TextOrientation -`"horizontal"` | `"horizontal-rl"` | `"vertical"` | `"vertical-tb"` -> ```lua -> -- Setup the texts's orientation (writing direction). -> TextOrientation: -> | "horizontal" -- Draw from left to right (Default) -> | "horizontal-rl" -- Draw from right to left -> | "vertical" -- Draw from bottom to top -> | "vertical-tb" -- Draw from top to bottom -> ``` - -### TextParagraphs -[`string`](../../API/builtins/string.md)[] -> A table of text lines to be used instead of specifying a single text -> line with newline characters like "text" -> * Default: [] - -### TextSingleLineString -[`string`](../../API/builtins/string.md) -> The text that should be displayed. Setting a new text will resize -> the view in order to make the text fully visible (expanding only). -> * Default: "" - -### TextStyle -`"custom"` | `"disabled"` | `"normal"` | `"strong"` -> ```lua -> -- Get/set the color style the text should be displayed with. -> TextStyle: -> | "normal" -- (Default) -> | "strong" -- highlighted color -> | "disabled" -- greyed out color -> | "custom" -- custom color -> ``` - -### TextValue -[`string`](../../API/builtins/string.md) -> The currently shown text. The text will not be updated when editing, -> rather only after editing is complete (return is pressed, or focus is lost). -> * Default: "" - -### TextValueAlias -[`string`](../../API/builtins/string.md) -> Exactly the same as "value"; provided for consistency. -> * Default: "" - -### ThemeColor -`"alternate_main_back"` | `"alternate_main_font"` | `"automation_grid"` | `"automation_line_edge"` | `"automation_line_fill"` | `"automation_marker_diamond"` | `"automation_marker_pair"` | `"automation_marker_play"` | `"automation_marker_single"` | `"automation_point"` | `"body_back"` | `"body_font"` | `"button_back"` | `"button_font"` | `"button_highlight_font"` | `"default_color_01"` | `"default_color_02"` | `"default_color_03"` | `"default_color_04"` | `"default_color_05"` | `"default_color_06"` | `"default_color_07"` | `"default_color_08"` | `"default_color_09"` | `"default_color_10"` | `"default_color_11"` | `"default_color_12"` | `"default_color_13"` | `"default_color_14"` | `"default_color_15"` | `"default_color_16"` | `"folder"` | `"main_back"` | `"main_font"` | `"midi_mapping_back"` | `"midi_mapping_font"` | `"pattern_centerbar_back"` | `"pattern_centerbar_back_standby"` | `"pattern_centerbar_font"` | `"pattern_centerbar_font_standby"` | `"pattern_default_back"` | `"pattern_default_font"` | `"pattern_default_font_delay"` | `"pattern_default_font_dspfx"` | `"pattern_default_font_global"` | `"pattern_default_font_other"` | `"pattern_default_font_panning"` | `"pattern_default_font_pitch"` | `"pattern_default_font_unused"` | `"pattern_default_font_volume"` | `"pattern_highlighted_back"` | `"pattern_highlighted_font"` | `"pattern_highlighted_font_delay"` | `"pattern_highlighted_font_dspfx"` | `"pattern_highlighted_font_global"` | `"pattern_highlighted_font_other"` | `"pattern_highlighted_font_panning"` | `"pattern_highlighted_font_pitch"` | `"pattern_highlighted_font_unused"` | `"pattern_highlighted_font_volume"` | `"pattern_mute_state"` | `"pattern_playposition_back"` | `"pattern_playposition_font"` | `"pattern_selection"` | `"pattern_standby_selection"` | `"scrollbar"` | `"selected_button_back"` | `"selected_button_font"` | `"selection_back"` | `"selection_font"` | `"slider"` | `"standby_selection_back"` | `"standby_selection_font"` | `"strong_body_font"` | `"tooltip_back"` | `"tooltip_font"` | `"valuebox_back"` | `"valuebox_font"` | `"valuebox_font_icons"` | `"vumeter_back_clipped"` | `"vumeter_back_normal"` | `"vumeter_meter"` | `"vumeter_meter_high"` | `"vumeter_meter_low"` | `"vumeter_meter_middle"` | `"vumeter_peak"` -> ```lua -> -- The application theme's colors -> ThemeColor: -> | "main_back" -> | "main_font" -> | "alternate_main_back" -> | "alternate_main_font" -> | "body_back" -> | "body_font" -> | "strong_body_font" -> | "button_back" -> | "button_font" -> | "button_highlight_font" -> | "selected_button_back" -> | "selected_button_font" -> | "selection_back" -> | "selection_font" -> | "standby_selection_back" -> | "standby_selection_font" -> | "midi_mapping_back" -> | "midi_mapping_font" -> | "tooltip_back" -> | "tooltip_font" -> | "valuebox_back" -> | "valuebox_font" -> | "valuebox_font_icons" -> | "scrollbar" -> | "slider" -> | "folder" -> | "pattern_default_back" -> | "pattern_default_font" -> | "pattern_default_font_volume" -> | "pattern_default_font_panning" -> | "pattern_default_font_pitch" -> | "pattern_default_font_delay" -> | "pattern_default_font_global" -> | "pattern_default_font_other" -> | "pattern_default_font_dspfx" -> | "pattern_default_font_unused" -> | "pattern_highlighted_back" -> | "pattern_highlighted_font" -> | "pattern_highlighted_font_volume" -> | "pattern_highlighted_font_panning" -> | "pattern_highlighted_font_pitch" -> | "pattern_highlighted_font_delay" -> | "pattern_highlighted_font_global" -> | "pattern_highlighted_font_other" -> | "pattern_highlighted_font_dspfx" -> | "pattern_highlighted_font_unused" -> | "pattern_playposition_back" -> | "pattern_playposition_font" -> | "pattern_centerbar_back" -> | "pattern_centerbar_font" -> | "pattern_centerbar_back_standby" -> | "pattern_centerbar_font_standby" -> | "pattern_selection" -> | "pattern_standby_selection" -> | "pattern_mute_state" -> | "automation_grid" -> | "automation_line_edge" -> | "automation_line_fill" -> | "automation_point" -> | "automation_marker_play" -> | "automation_marker_single" -> | "automation_marker_pair" -> | "automation_marker_diamond" -> | "vumeter_meter" -> | "vumeter_meter_low" -> | "vumeter_meter_middle" -> | "vumeter_meter_high" -> | "vumeter_peak" -> | "vumeter_back_normal" -> | "vumeter_back_clipped" -> | "default_color_01" -> | "default_color_02" -> | "default_color_03" -> | "default_color_04" -> | "default_color_05" -> | "default_color_06" -> | "default_color_07" -> | "default_color_08" -> | "default_color_09" -> | "default_color_10" -> | "default_color_11" -> | "default_color_12" -> | "default_color_13" -> | "default_color_14" -> | "default_color_15" -> | "default_color_16" -> ``` - -### ValueBoxMaxValue -[`number`](../../API/builtins/number.md) -> The maximum value that can be set using the view -> * Default: 100 - -### ValueBoxMinValue -[`number`](../../API/builtins/number.md) -> The minimum value that can be set using the view -> * Default: 0 - -### ViewBackgroundStyle -`"body"` | `"border"` | `"group"` | `"invisible"` | `"panel"` | `"plain"` -> ```lua -> -- Setup a background style for the view. -> ViewBackgroundStyle: -> | "invisible" -- no background (Default) -> | "plain" -- undecorated, single coloured background -> | "border" -- same as plain, but with a bold nested border -> | "body" -- main "background" style, as used in dialog backgrounds -> | "panel" -- alternative "background" style, beveled -> | "group" -- background for "nested" groups within body -> ``` - -### ViewBooleanObservable -[`renoise.Document.ObservableBoolean`](../../API/renoise/renoise.Document.ObservableBoolean.md) -> Bind the view's value to a renoise.Document.ObservableBoolean object. -> Automatically keep them in sync. -> The view will change the Observable value as soon as its value changes -> and change the view's value as soon as the Observable's value changes. -> Notifiers can be added to either the view or the Observable object. - -### ViewCursorShape -`"busy"` | `"change_value"` | `"crosshair"` | `"default"` | `"drag"` | `"drop"` | `"edit_text"` | `"empty"` | `"erase"` | `"extend_bottom"` | `"extend_bottom_alias"` | `"extend_left"` | `"extend_left_alias"` | `"extend_right"` | `"extend_right_alias"` | `"extend_top"` | `"extend_top_alias"` | `"marker"` | `"move"` | `"nodrop"` | `"none"` | `"pencil"` | `"play"` | `"resize_edge_diagonal_left"` | `"resize_edge_diagonal_right"` | `"resize_edge_horizontal"` | `"resize_edge_vertical"` | `"resize_horizontal"` | `"resize_vertical"` | `"zoom"` | `"zoom_horizontal"` | `"zoom_vertical"` -> ```lua -> -- The cursor cursor for this view which apears on mouse hover. -> -- Using a "none" shape will use use underlying view's cursor or the default cursor. -> ViewCursorShape: -> | "none" -> | "empty" -> | "default" -> | "change_value" -> | "edit_text" -> | "pencil" -> | "marker" -> | "crosshair" -> | "move" -> | "erase" -> | "play" -> | "drag" -> | "drop" -> | "nodrop" -> | "busy" -> | "resize_vertical" -> | "resize_horizontal" -> | "resize_edge_vertical" -> | "resize_edge_horizontal" -> | "resize_edge_diagonal_left" -> | "resize_edge_diagonal_right" -> | "extend_left" -> | "extend_right" -> | "extend_top" -> | "extend_bottom" -> | "extend_left_alias" -> | "extend_right_alias" -> | "extend_top_alias" -> | "extend_bottom_alias" -> | "zoom_vertical" -> | "zoom_horizontal" -> | "zoom" -> ``` - -### ViewDimension -[`string`](../../API/builtins/string.md) | [`integer`](../../API/builtins/integer.md) -> The dimensions of a view has to be larger than 0. -> For nested views you can also specify relative size -> for example `vb:text { width = "80%"}`. The percentage values are -> relative to the view's parent size and will automatically update on size changes. - -### ViewId -[`string`](../../API/builtins/string.md) -> Unique identifier to resolve the view later on in the viewbuilder, -> e.g. `vb.views.SomeString` or `vb.views["Some String"]` -> View ids must be unique within a single view builder instance. - -### ViewNumberObservable -[`renoise.Document.ObservableNumber`](../../API/renoise/renoise.Document.ObservableNumber.md) -> Bind the view's value to a renoise.Document.ObservableNumber object. -> Automatically keep them in sync. -> The view will change the Observable value as soon as its value changes -> and change the view's value as soon as the Observable's value changes. -> Notifiers can be added to either the view or the Observable object. - -### ViewOrigin -{ 1 : [`ViewPosition`](#ViewPosition), 2 : [`ViewPosition`](#ViewPosition) } | { x : [`ViewPosition`](#ViewPosition), y : [`ViewPosition`](#ViewPosition) } -> The position of a view within its parent view. -> Only the `stack` layouts allows to freely position child views. Other -> layout views will automatically set the origin, but the origin -> then still can be read in for example mouse handlers. - -### ViewPosition -[`integer`](../../API/builtins/integer.md) -> Horizontal (x) or Vertical (y) position of a view within its parent view. - -### ViewSize -{ 1 : [`ViewDimension`](#ViewDimension), 2 : [`ViewDimension`](#ViewDimension) } | { height : [`ViewDimension`](#ViewDimension), width : [`ViewDimension`](#ViewDimension) } -> The dimensions of a view has to be larger than 0. -> For nested views you can also specify relative size, for example -> `vb:text { size = { width = "80%", height = 20}}`. -> The percentage values are relative to the view's parent size and will -> automatically update when the parent view's size changes. - -### ViewStringListObservable -[`renoise.Document.ObservableStringList`](../../API/renoise/renoise.Document.ObservableStringList.md) -> Bind the view's value to a renoise.Document.ObservableStringList object. -> Automatically keep them in sync. -> The view will change the Observable value as soon as its value changes -> and change the view's value as soon as the Observable's value changes. -> Notifiers can be added to either the view or the Observable object. - -### ViewStringObservable -[`renoise.Document.ObservableString`](../../API/renoise/renoise.Document.ObservableString.md) -> Bind the view's value to a renoise.Document.ObservableString object. -> Automatically keep them in sync. -> The view will change the Observable value as soon as its value changes -> and change the view's value as soon as the Observable's value changes. -> Notifiers can be added to either the view or the Observable object. - -### ViewTooltip -[`string`](../../API/builtins/string.md) -> A ViewTooltip text that should be shown for this view on mouse hover. -> * Default: "" (no tip will be shown) - -### ViewVisibility -[`boolean`](../../API/builtins/boolean.md) -> Set visible to false to hide a view (make it invisible without removing -> it). Please note that view.visible will also return false when any of its -> parents are invisible (when its implicitly invisible). -> * Default: true - -### XYPadMaxValues -{ x : [`SliderMaxValue`](#SliderMaxValue), y : [`SliderMaxValue`](#SliderMaxValue) } -> A table of allowed maximum values for each axis -> * Default: {x: 1.0, y: 1.0} - -### XYPadMinValues -{ x : [`SliderMinValue`](#SliderMinValue), y : [`SliderMinValue`](#SliderMinValue) } -> A table of allowed minimum values for each axis -> * Default: {x: 0.0, y: 0.0} - -### XYPadObservables -{ x : [`renoise.Document.ObservableNumber`](../../API/renoise/renoise.Document.ObservableNumber.md), y : [`renoise.Document.ObservableNumber`](../../API/renoise/renoise.Document.ObservableNumber.md) } -> Bind the view's value to a pair of renoise.Document.ObservableNumber objects. -> Automatically keep both values in sync. -> Will change the Observables' values as soon as the view's value changes, -> and change the view's values as soon as the Observable's value changes. -> Notifiers can be added to either the view or the Observable object. -> Just like in the other XYPad properties, a table with the fields X and Y -> is expected here and not a single value. So you have to bind two -> ObservableNumber object to the pad. - -### XYPadSnapbackValues -{ x : [`number`](../../API/builtins/number.md), y : [`number`](../../API/builtins/number.md) } -> A table of snapback values for each axis -> When snapback is enabled, the pad will revert its values to the specified -> snapback values as soon as the mouse button is released in the pad. -> When disabled, releasing the mouse button will not change the value. -> You can disable snapback at runtime by setting it to nil or an empty table. - -### XYPadValues -{ x : [`SliderNumberValue`](#SliderNumberValue), y : [`SliderNumberValue`](#SliderNumberValue) } -> A table of the XYPad's current values on each axis - -### XYValueNotifier -[`XYValueNotifierFunction`](#XYValueNotifierFunction) | [`XYValueNotifierMethod1`](#XYValueNotifierMethod1) | [`XYValueNotifierMethod2`](#XYValueNotifierMethod2) -> Set up a value notifier function that will be used whenever the pad's values change - -### XYValueNotifierFunction -(value : [`XYPadValues`](#XYPadValues)) - - -### XYValueNotifierMemberFunction -(self : [`NotifierMemberContext`](#NotifierMemberContext), value : [`XYPadValues`](#XYPadValues)) - - -### XYValueNotifierMethod1 -{ 1 : [`NotifierMemberContext`](#NotifierMemberContext), 2 : [`XYValueNotifierMemberFunction`](#XYValueNotifierMemberFunction) } - - -### XYValueNotifierMethod2 -{ 1 : [`XYValueNotifierMemberFunction`](#XYValueNotifierMemberFunction), 2 : [`NotifierMemberContext`](#NotifierMemberContext) } - - - diff --git a/docs/API/renoise/renoise.Views.Aligner.md b/docs/API/renoise/renoise.Views.Aligner.md deleted file mode 100644 index eca821c..0000000 --- a/docs/API/renoise/renoise.Views.Aligner.md +++ /dev/null @@ -1,204 +0,0 @@ -# renoise.Views.Aligner -> Just like a Rack, the Aligner shows no content on its own. It just aligns -> child views vertically or horizontally. As soon as children are added, the -> Aligner will expand itself to make sure that all children are visible -> (including spacing & margins). -> To make use of modes like "center", you manually have to setup a size that -> is bigger than the sum of the child sizes. - - - - ---- -## Properties -### margin : [`RackMargin`](#RackMargin) -> Set the "borders" of a rack (left, right, top and bottom inclusively) -> * Default: 0 (no borders) - -### spacing : [`RackSpacing`](#RackSpacing) -> Set the amount stacked child views are separated by (horizontally in -> rows, vertically in columns). -> * Default: 0 (no spacing) - -### mode : [`AlignerMode`](#AlignerMode) -> * Default: "left" (for horizontal_aligner) "top" (for vertical_aligner) - -### background : [`ViewBackgroundStyle`](#ViewBackgroundStyle) -> Setup a background style for the view. - -### visible : [`ViewVisibility`](#ViewVisibility) -> Set visible to false to hide a view (make it invisible without removing -> it). Please note that view.visible will also return false when any of its -> parents are invisible (when its implicitly invisible). -> * Default: true - -### origin : [`ViewOrigin`](#ViewOrigin) -> The position of a view within its parent view. -> Only the `stack` layouts allows to freely position child views. Other -> layout views will automatically set the origin, but the origin -> then still can be read in for example mouse handlers. - -### width : [`ViewDimension`](#ViewDimension) -> **Deprecated.** Use property `size` instead. - -### height : [`ViewDimension`](#ViewDimension) -> **Deprecated.** Use property `size` instead. - -### size : [`ViewSize`](#ViewSize) -> The dimensions of a view has to be larger than 0. -> For nested views you can also specify relative size, for example -> `vb:text { size = { width = "80%", height = 20}}`. -> The percentage values are relative to the view's parent size and will -> automatically update when the parent view's size changes. - -### tooltip : [`ViewTooltip`](#ViewTooltip) -> A ViewTooltip text that should be shown for this view on mouse hover. -> * Default: "" (no tip will be shown) - -### cursor : [`ViewCursorShape`](#ViewCursorShape) -> The cursor cursor for this view which apears on mouse hover. -> Using a "none" shape will use use underlying view's cursor or the default cursor. - -### views : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)[] -> **READ-ONLY** Empty for all controls, for layout views this contains the -> layout child views in the order they got added - - - ---- -## Functions -### add_view([*self*](../../API/builtins/self.md), child : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)) -> Add a new child view to this view. -### remove_view([*self*](../../API/builtins/self.md), child : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)) -> Remove a child view from this view. -### swap_views([*self*](../../API/builtins/self.md), child1 : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md), child2 : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)) -> Swap position of two child views in this view. With a series of swaps views -> can be moved to any position in the parent. -### add_child([*self*](../../API/builtins/self.md), child : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)) -> **Deprecated.** Use `add_view` instead -### remove_child([*self*](../../API/builtins/self.md), child : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)) -> **Deprecated.** Use `remove_view` instead -### swap_childs([*self*](../../API/builtins/self.md), child1 : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md), child2 : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)) -> **Deprecated.** Use `swap_views` instead - - - ---- -## Aliases -### AlignerMode -`"bottom"` | `"center"` | `"distribute"` | `"justify"` | `"left"` | `"right"` | `"top"` -> ```lua -> -- * Default: "left" (for horizontal_aligner) "top" (for vertical_aligner) -> AlignerMode: -> | "left" -- align from left to right (for horizontal_aligner only) -> | "right" -- align from right to left (for horizontal_aligner only) -> | "top" -- align from top to bottom (for vertical_aligner only) -> | "bottom" -- align from bottom to top (for vertical_aligner only) -> | "center" -- center all views -> | "justify" -- keep outer views at the borders, distribute the rest -> | "distribute" -- equally distributes views over the aligners width/height -> ``` - -### RackMargin -[`integer`](../../API/builtins/integer.md) -> Set the "borders" of a rack (left, right, top and bottom inclusively) -> * Default: 0 (no borders) - -### RackSpacing -[`integer`](../../API/builtins/integer.md) -> Set the amount stacked child views are separated by (horizontally in -> rows, vertically in columns). -> * Default: 0 (no spacing) - -### ViewBackgroundStyle -`"body"` | `"border"` | `"group"` | `"invisible"` | `"panel"` | `"plain"` -> ```lua -> -- Setup a background style for the view. -> ViewBackgroundStyle: -> | "invisible" -- no background (Default) -> | "plain" -- undecorated, single coloured background -> | "border" -- same as plain, but with a bold nested border -> | "body" -- main "background" style, as used in dialog backgrounds -> | "panel" -- alternative "background" style, beveled -> | "group" -- background for "nested" groups within body -> ``` - -### ViewCursorShape -`"busy"` | `"change_value"` | `"crosshair"` | `"default"` | `"drag"` | `"drop"` | `"edit_text"` | `"empty"` | `"erase"` | `"extend_bottom"` | `"extend_bottom_alias"` | `"extend_left"` | `"extend_left_alias"` | `"extend_right"` | `"extend_right_alias"` | `"extend_top"` | `"extend_top_alias"` | `"marker"` | `"move"` | `"nodrop"` | `"none"` | `"pencil"` | `"play"` | `"resize_edge_diagonal_left"` | `"resize_edge_diagonal_right"` | `"resize_edge_horizontal"` | `"resize_edge_vertical"` | `"resize_horizontal"` | `"resize_vertical"` | `"zoom"` | `"zoom_horizontal"` | `"zoom_vertical"` -> ```lua -> -- The cursor cursor for this view which apears on mouse hover. -> -- Using a "none" shape will use use underlying view's cursor or the default cursor. -> ViewCursorShape: -> | "none" -> | "empty" -> | "default" -> | "change_value" -> | "edit_text" -> | "pencil" -> | "marker" -> | "crosshair" -> | "move" -> | "erase" -> | "play" -> | "drag" -> | "drop" -> | "nodrop" -> | "busy" -> | "resize_vertical" -> | "resize_horizontal" -> | "resize_edge_vertical" -> | "resize_edge_horizontal" -> | "resize_edge_diagonal_left" -> | "resize_edge_diagonal_right" -> | "extend_left" -> | "extend_right" -> | "extend_top" -> | "extend_bottom" -> | "extend_left_alias" -> | "extend_right_alias" -> | "extend_top_alias" -> | "extend_bottom_alias" -> | "zoom_vertical" -> | "zoom_horizontal" -> | "zoom" -> ``` - -### ViewDimension -[`string`](../../API/builtins/string.md) | [`integer`](../../API/builtins/integer.md) -> The dimensions of a view has to be larger than 0. -> For nested views you can also specify relative size -> for example `vb:text { width = "80%"}`. The percentage values are -> relative to the view's parent size and will automatically update on size changes. - -### ViewOrigin -{ 1 : [`ViewPosition`](#ViewPosition), 2 : [`ViewPosition`](#ViewPosition) } | { x : [`ViewPosition`](#ViewPosition), y : [`ViewPosition`](#ViewPosition) } -> The position of a view within its parent view. -> Only the `stack` layouts allows to freely position child views. Other -> layout views will automatically set the origin, but the origin -> then still can be read in for example mouse handlers. - -### ViewPosition -[`integer`](../../API/builtins/integer.md) -> Horizontal (x) or Vertical (y) position of a view within its parent view. - -### ViewSize -{ 1 : [`ViewDimension`](#ViewDimension), 2 : [`ViewDimension`](#ViewDimension) } | { height : [`ViewDimension`](#ViewDimension), width : [`ViewDimension`](#ViewDimension) } -> The dimensions of a view has to be larger than 0. -> For nested views you can also specify relative size, for example -> `vb:text { size = { width = "80%", height = 20}}`. -> The percentage values are relative to the view's parent size and will -> automatically update when the parent view's size changes. - -### ViewTooltip -[`string`](../../API/builtins/string.md) -> A ViewTooltip text that should be shown for this view on mouse hover. -> * Default: "" (no tip will be shown) - -### ViewVisibility -[`boolean`](../../API/builtins/boolean.md) -> Set visible to false to hide a view (make it invisible without removing -> it). Please note that view.visible will also return false when any of its -> parents are invisible (when its implicitly invisible). -> * Default: true - - diff --git a/docs/API/renoise/renoise.Views.Bitmap.md b/docs/API/renoise/renoise.Views.Bitmap.md deleted file mode 100644 index 6add573..0000000 --- a/docs/API/renoise/renoise.Views.Bitmap.md +++ /dev/null @@ -1,450 +0,0 @@ -# renoise.Views.Bitmap -> Draws a bitmap, or a draws a bitmap which acts like a button (as soon as a -> notifier is specified). The notifier is called when clicking the mouse -> somewhere on the bitmap. When using a re-colorable style (see 'mode'), the -> bitmap is automatically recolored to match the current theme's colors. Mouse -> hover is also enabled when notifiers are present, to show that the bitmap can -> be clicked. -> ```text -> * -> *** -> + * -> / \ -> +---+ -> | O | o -> +---+ | -> |||||||||||| -> ``` - - - - ---- -## Properties -### mode : [`BitmapMode`](#BitmapMode) -> Setup how the bitmap should be drawn, recolored. Available modes are: - -### color : [`BitmapColor`](#BitmapColor) -> When set, the bitmap will be drawn in the specified color and `mode` is set -> to `custom_color`. Set `mode` to something else than `custom_color` or the -> `color` to `{0, 0, 0}` to enable a `plain` display mode. - -### bitmap : [`BitmapPath`](#BitmapPath) -> Supported bitmap file formats are *.bmp, *.png or *.tif (no transparency). - -### active : [`ControlActive`](#ControlActive) -> Instead of making a control invisible, you can also make it inactive. -> Deactivated controls will still be shown, and will still show their -> currently assigned values, but will not allow changes. Most controls will -> display as "grayed out" to visualize the deactivated state. - -### midi_mapping : [`ControlMidiMappingString`](#ControlMidiMappingString) -> When set, the control will be highlighted when Renoise's MIDI mapping dialog -> is open. When clicked, it selects the specified string as a MIDI mapping -> target action. This target acton can either be one of the globally available -> mappings in Renoise, or those that were created by the tool itself. -> Target strings are not verified. When they point to nothing, the mapped MIDI -> message will do nothing and no error is fired. - -### visible : [`ViewVisibility`](#ViewVisibility) -> Set visible to false to hide a view (make it invisible without removing -> it). Please note that view.visible will also return false when any of its -> parents are invisible (when its implicitly invisible). -> * Default: true - -### origin : [`ViewOrigin`](#ViewOrigin) -> The position of a view within its parent view. -> Only the `stack` layouts allows to freely position child views. Other -> layout views will automatically set the origin, but the origin -> then still can be read in for example mouse handlers. - -### width : [`ViewDimension`](#ViewDimension) -> **Deprecated.** Use property `size` instead. - -### height : [`ViewDimension`](#ViewDimension) -> **Deprecated.** Use property `size` instead. - -### size : [`ViewSize`](#ViewSize) -> The dimensions of a view has to be larger than 0. -> For nested views you can also specify relative size, for example -> `vb:text { size = { width = "80%", height = 20}}`. -> The percentage values are relative to the view's parent size and will -> automatically update when the parent view's size changes. - -### tooltip : [`ViewTooltip`](#ViewTooltip) -> A ViewTooltip text that should be shown for this view on mouse hover. -> * Default: "" (no tip will be shown) - -### cursor : [`ViewCursorShape`](#ViewCursorShape) -> The cursor cursor for this view which apears on mouse hover. -> Using a "none" shape will use use underlying view's cursor or the default cursor. - -### views : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)[] -> **READ-ONLY** Empty for all controls, for layout views this contains the -> layout child views in the order they got added - - - ---- -## Functions -### add_notifier([*self*](../../API/builtins/self.md), notifier : [`NotifierFunction`](#NotifierFunction)) -> Add mouse click notifier -### remove_notifier([*self*](../../API/builtins/self.md), notifier : [`NotifierFunction`](#NotifierFunction)) -> Remove mouse click notifier -### add_view([*self*](../../API/builtins/self.md), child : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)) -> Add a new child view to this view. -### remove_view([*self*](../../API/builtins/self.md), child : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)) -> Remove a child view from this view. -### swap_views([*self*](../../API/builtins/self.md), child1 : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md), child2 : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)) -> Swap position of two child views in this view. With a series of swaps views -> can be moved to any position in the parent. -### add_child([*self*](../../API/builtins/self.md), child : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)) -> **Deprecated.** Use `add_view` instead -### remove_child([*self*](../../API/builtins/self.md), child : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)) -> **Deprecated.** Use `remove_view` instead -### swap_childs([*self*](../../API/builtins/self.md), child1 : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md), child2 : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)) -> **Deprecated.** Use `swap_views` instead - - - ---- -## Aliases -### BitmapColor -[`RGBColor`](#RGBColor) | [`ThemeColor`](#ThemeColor) -> ```lua -> -- When set, the bitmap will be drawn in the specified color and `mode` is set -> -- to `custom_color`. Set `mode` to something else than `custom_color` or the -> -- `color` to `{0, 0, 0}` to enable a `plain` display mode. -> -- A table of 3 bytes (ranging from 0 to 255) -> -- representing the red, green and blue channels of a color. -> -- {0xFF, 0xFF, 0xFF} is white -> -- {165, 73, 35} is the red from the Renoise logo -> -- The application theme's colors -> BitmapColor: -> | "main_back" -> | "main_font" -> | "alternate_main_back" -> | "alternate_main_font" -> | "body_back" -> | "body_font" -> | "strong_body_font" -> | "button_back" -> | "button_font" -> | "button_highlight_font" -> | "selected_button_back" -> | "selected_button_font" -> | "selection_back" -> | "selection_font" -> | "standby_selection_back" -> | "standby_selection_font" -> | "midi_mapping_back" -> | "midi_mapping_font" -> | "tooltip_back" -> | "tooltip_font" -> | "valuebox_back" -> | "valuebox_font" -> | "valuebox_font_icons" -> | "scrollbar" -> | "slider" -> | "folder" -> | "pattern_default_back" -> | "pattern_default_font" -> | "pattern_default_font_volume" -> | "pattern_default_font_panning" -> | "pattern_default_font_pitch" -> | "pattern_default_font_delay" -> | "pattern_default_font_global" -> | "pattern_default_font_other" -> | "pattern_default_font_dspfx" -> | "pattern_default_font_unused" -> | "pattern_highlighted_back" -> | "pattern_highlighted_font" -> | "pattern_highlighted_font_volume" -> | "pattern_highlighted_font_panning" -> | "pattern_highlighted_font_pitch" -> | "pattern_highlighted_font_delay" -> | "pattern_highlighted_font_global" -> | "pattern_highlighted_font_other" -> | "pattern_highlighted_font_dspfx" -> | "pattern_highlighted_font_unused" -> | "pattern_playposition_back" -> | "pattern_playposition_font" -> | "pattern_centerbar_back" -> | "pattern_centerbar_font" -> | "pattern_centerbar_back_standby" -> | "pattern_centerbar_font_standby" -> | "pattern_selection" -> | "pattern_standby_selection" -> | "pattern_mute_state" -> | "automation_grid" -> | "automation_line_edge" -> | "automation_line_fill" -> | "automation_point" -> | "automation_marker_play" -> | "automation_marker_single" -> | "automation_marker_pair" -> | "automation_marker_diamond" -> | "vumeter_meter" -> | "vumeter_meter_low" -> | "vumeter_meter_middle" -> | "vumeter_meter_high" -> | "vumeter_peak" -> | "vumeter_back_normal" -> | "vumeter_back_clipped" -> | "default_color_01" -> | "default_color_02" -> | "default_color_03" -> | "default_color_04" -> | "default_color_05" -> | "default_color_06" -> | "default_color_07" -> | "default_color_08" -> | "default_color_09" -> | "default_color_10" -> | "default_color_11" -> | "default_color_12" -> | "default_color_13" -> | "default_color_14" -> | "default_color_15" -> | "default_color_16" -> ``` - -### BitmapImagePath -[`string`](../../API/builtins/string.md) -> You can load an image from your tool's directory, -> or use one from Renoise's built-in icons. -> * For the built-in icons, use "Icons/ArrowRight.bmp" -> * For custom images, use a path relative to your tool's root folder. -> -> For example "Images/MyBitmap.bmp" will load the image from -> "com.me.MyTool.xrnx/Images/MyBitmap.bmp". -> If your custom path matches a built-in icon's (like "Icons/ArrowRight.bmp"), -> your image will be loaded instead of the one from Renoise. -> -> If you want to support high DPI UI scaling with your bitmaps like the -> built-in Icons, include high resolution versions with their filenames ending -> with "@4x" -> The following rules will be used when loading bitmaps -> * When UI scaling is 100%, only the base bitmaps are used. -> * When UI scaling is 125%, the base bitmaps are used, except if there is a -> ` BitmapName@x1.25.bmp` variant. -> * For all other UI scaling > 125% the "@4x" variants are used and -> downscaled as needed, except when there is an exact match for the current -> UI scaling factor (e.g. `BitmapName@1.5x.bmp` for 150%) - -### BitmapMode -`"body_color"` | `"button_color"` | `"custom_color"` | `"main_color"` | `"plain"` | `"transparent"` -> ```lua -> -- Setup how the bitmap should be drawn, recolored. Available modes are: -> BitmapMode: -> | "plain" -- bitmap is drawn as is, no recoloring is done (Default) -> | "transparent" -- same as plain, but black pixels will be fully transparent -> | "button_color" -- recolor the bitmap, using the theme's button color -> | "body_color" -- same as 'button_back' but with body text/back color -> | "main_color" -- same as 'button_back' but with main text/back colors -> | "custom_color" -- Recolor the bitmap using a custom color set by the `color' -> ``` - -### BitmapPath -[`BitmapImagePath`](#BitmapImagePath) -> Supported bitmap file formats are *.bmp, *.png or *.tif (no transparency). - -### ControlActive -[`boolean`](../../API/builtins/boolean.md) -> Instead of making a control invisible, you can also make it inactive. -> Deactivated controls will still be shown, and will still show their -> currently assigned values, but will not allow changes. Most controls will -> display as "grayed out" to visualize the deactivated state. - -### ControlMidiMappingString -[`string`](../../API/builtins/string.md) -> When set, the control will be highlighted when Renoise's MIDI mapping dialog -> is open. When clicked, it selects the specified string as a MIDI mapping -> target action. This target acton can either be one of the globally available -> mappings in Renoise, or those that were created by the tool itself. -> Target strings are not verified. When they point to nothing, the mapped MIDI -> message will do nothing and no error is fired. - -### NotifierFunction -fun() - - -### RGBColor -{ 1 : [`integer`](../../API/builtins/integer.md), 2 : [`integer`](../../API/builtins/integer.md), 3 : [`integer`](../../API/builtins/integer.md) } -> A table of 3 bytes (ranging from 0 to 255) -> representing the red, green and blue channels of a color. -> {0xFF, 0xFF, 0xFF} is white -> {165, 73, 35} is the red from the Renoise logo - -### ThemeColor -`"alternate_main_back"` | `"alternate_main_font"` | `"automation_grid"` | `"automation_line_edge"` | `"automation_line_fill"` | `"automation_marker_diamond"` | `"automation_marker_pair"` | `"automation_marker_play"` | `"automation_marker_single"` | `"automation_point"` | `"body_back"` | `"body_font"` | `"button_back"` | `"button_font"` | `"button_highlight_font"` | `"default_color_01"` | `"default_color_02"` | `"default_color_03"` | `"default_color_04"` | `"default_color_05"` | `"default_color_06"` | `"default_color_07"` | `"default_color_08"` | `"default_color_09"` | `"default_color_10"` | `"default_color_11"` | `"default_color_12"` | `"default_color_13"` | `"default_color_14"` | `"default_color_15"` | `"default_color_16"` | `"folder"` | `"main_back"` | `"main_font"` | `"midi_mapping_back"` | `"midi_mapping_font"` | `"pattern_centerbar_back"` | `"pattern_centerbar_back_standby"` | `"pattern_centerbar_font"` | `"pattern_centerbar_font_standby"` | `"pattern_default_back"` | `"pattern_default_font"` | `"pattern_default_font_delay"` | `"pattern_default_font_dspfx"` | `"pattern_default_font_global"` | `"pattern_default_font_other"` | `"pattern_default_font_panning"` | `"pattern_default_font_pitch"` | `"pattern_default_font_unused"` | `"pattern_default_font_volume"` | `"pattern_highlighted_back"` | `"pattern_highlighted_font"` | `"pattern_highlighted_font_delay"` | `"pattern_highlighted_font_dspfx"` | `"pattern_highlighted_font_global"` | `"pattern_highlighted_font_other"` | `"pattern_highlighted_font_panning"` | `"pattern_highlighted_font_pitch"` | `"pattern_highlighted_font_unused"` | `"pattern_highlighted_font_volume"` | `"pattern_mute_state"` | `"pattern_playposition_back"` | `"pattern_playposition_font"` | `"pattern_selection"` | `"pattern_standby_selection"` | `"scrollbar"` | `"selected_button_back"` | `"selected_button_font"` | `"selection_back"` | `"selection_font"` | `"slider"` | `"standby_selection_back"` | `"standby_selection_font"` | `"strong_body_font"` | `"tooltip_back"` | `"tooltip_font"` | `"valuebox_back"` | `"valuebox_font"` | `"valuebox_font_icons"` | `"vumeter_back_clipped"` | `"vumeter_back_normal"` | `"vumeter_meter"` | `"vumeter_meter_high"` | `"vumeter_meter_low"` | `"vumeter_meter_middle"` | `"vumeter_peak"` -> ```lua -> -- The application theme's colors -> ThemeColor: -> | "main_back" -> | "main_font" -> | "alternate_main_back" -> | "alternate_main_font" -> | "body_back" -> | "body_font" -> | "strong_body_font" -> | "button_back" -> | "button_font" -> | "button_highlight_font" -> | "selected_button_back" -> | "selected_button_font" -> | "selection_back" -> | "selection_font" -> | "standby_selection_back" -> | "standby_selection_font" -> | "midi_mapping_back" -> | "midi_mapping_font" -> | "tooltip_back" -> | "tooltip_font" -> | "valuebox_back" -> | "valuebox_font" -> | "valuebox_font_icons" -> | "scrollbar" -> | "slider" -> | "folder" -> | "pattern_default_back" -> | "pattern_default_font" -> | "pattern_default_font_volume" -> | "pattern_default_font_panning" -> | "pattern_default_font_pitch" -> | "pattern_default_font_delay" -> | "pattern_default_font_global" -> | "pattern_default_font_other" -> | "pattern_default_font_dspfx" -> | "pattern_default_font_unused" -> | "pattern_highlighted_back" -> | "pattern_highlighted_font" -> | "pattern_highlighted_font_volume" -> | "pattern_highlighted_font_panning" -> | "pattern_highlighted_font_pitch" -> | "pattern_highlighted_font_delay" -> | "pattern_highlighted_font_global" -> | "pattern_highlighted_font_other" -> | "pattern_highlighted_font_dspfx" -> | "pattern_highlighted_font_unused" -> | "pattern_playposition_back" -> | "pattern_playposition_font" -> | "pattern_centerbar_back" -> | "pattern_centerbar_font" -> | "pattern_centerbar_back_standby" -> | "pattern_centerbar_font_standby" -> | "pattern_selection" -> | "pattern_standby_selection" -> | "pattern_mute_state" -> | "automation_grid" -> | "automation_line_edge" -> | "automation_line_fill" -> | "automation_point" -> | "automation_marker_play" -> | "automation_marker_single" -> | "automation_marker_pair" -> | "automation_marker_diamond" -> | "vumeter_meter" -> | "vumeter_meter_low" -> | "vumeter_meter_middle" -> | "vumeter_meter_high" -> | "vumeter_peak" -> | "vumeter_back_normal" -> | "vumeter_back_clipped" -> | "default_color_01" -> | "default_color_02" -> | "default_color_03" -> | "default_color_04" -> | "default_color_05" -> | "default_color_06" -> | "default_color_07" -> | "default_color_08" -> | "default_color_09" -> | "default_color_10" -> | "default_color_11" -> | "default_color_12" -> | "default_color_13" -> | "default_color_14" -> | "default_color_15" -> | "default_color_16" -> ``` - -### ViewCursorShape -`"busy"` | `"change_value"` | `"crosshair"` | `"default"` | `"drag"` | `"drop"` | `"edit_text"` | `"empty"` | `"erase"` | `"extend_bottom"` | `"extend_bottom_alias"` | `"extend_left"` | `"extend_left_alias"` | `"extend_right"` | `"extend_right_alias"` | `"extend_top"` | `"extend_top_alias"` | `"marker"` | `"move"` | `"nodrop"` | `"none"` | `"pencil"` | `"play"` | `"resize_edge_diagonal_left"` | `"resize_edge_diagonal_right"` | `"resize_edge_horizontal"` | `"resize_edge_vertical"` | `"resize_horizontal"` | `"resize_vertical"` | `"zoom"` | `"zoom_horizontal"` | `"zoom_vertical"` -> ```lua -> -- The cursor cursor for this view which apears on mouse hover. -> -- Using a "none" shape will use use underlying view's cursor or the default cursor. -> ViewCursorShape: -> | "none" -> | "empty" -> | "default" -> | "change_value" -> | "edit_text" -> | "pencil" -> | "marker" -> | "crosshair" -> | "move" -> | "erase" -> | "play" -> | "drag" -> | "drop" -> | "nodrop" -> | "busy" -> | "resize_vertical" -> | "resize_horizontal" -> | "resize_edge_vertical" -> | "resize_edge_horizontal" -> | "resize_edge_diagonal_left" -> | "resize_edge_diagonal_right" -> | "extend_left" -> | "extend_right" -> | "extend_top" -> | "extend_bottom" -> | "extend_left_alias" -> | "extend_right_alias" -> | "extend_top_alias" -> | "extend_bottom_alias" -> | "zoom_vertical" -> | "zoom_horizontal" -> | "zoom" -> ``` - -### ViewDimension -[`string`](../../API/builtins/string.md) | [`integer`](../../API/builtins/integer.md) -> The dimensions of a view has to be larger than 0. -> For nested views you can also specify relative size -> for example `vb:text { width = "80%"}`. The percentage values are -> relative to the view's parent size and will automatically update on size changes. - -### ViewOrigin -{ 1 : [`ViewPosition`](#ViewPosition), 2 : [`ViewPosition`](#ViewPosition) } | { x : [`ViewPosition`](#ViewPosition), y : [`ViewPosition`](#ViewPosition) } -> The position of a view within its parent view. -> Only the `stack` layouts allows to freely position child views. Other -> layout views will automatically set the origin, but the origin -> then still can be read in for example mouse handlers. - -### ViewPosition -[`integer`](../../API/builtins/integer.md) -> Horizontal (x) or Vertical (y) position of a view within its parent view. - -### ViewSize -{ 1 : [`ViewDimension`](#ViewDimension), 2 : [`ViewDimension`](#ViewDimension) } | { height : [`ViewDimension`](#ViewDimension), width : [`ViewDimension`](#ViewDimension) } -> The dimensions of a view has to be larger than 0. -> For nested views you can also specify relative size, for example -> `vb:text { size = { width = "80%", height = 20}}`. -> The percentage values are relative to the view's parent size and will -> automatically update when the parent view's size changes. - -### ViewTooltip -[`string`](../../API/builtins/string.md) -> A ViewTooltip text that should be shown for this view on mouse hover. -> * Default: "" (no tip will be shown) - -### ViewVisibility -[`boolean`](../../API/builtins/boolean.md) -> Set visible to false to hide a view (make it invisible without removing -> it). Please note that view.visible will also return false when any of its -> parents are invisible (when its implicitly invisible). -> * Default: true - - diff --git a/docs/API/renoise/renoise.Views.Button.md b/docs/API/renoise/renoise.Views.Button.md deleted file mode 100644 index 3df5984..0000000 --- a/docs/API/renoise/renoise.Views.Button.md +++ /dev/null @@ -1,603 +0,0 @@ -# renoise.Views.Button -> A simple button that calls a custom notifier function when clicked. -> Supports text or bitmap labels. -> ```text -> +--------+ -> | Button | -> +--------+ -> ``` - - - - ---- -## Properties -### text : [`ButtonLabel`](#ButtonLabel) -> The text label of the button -> * Default: "" - -### bitmap : [`ButtonBitmapPath`](#ButtonBitmapPath) -> If set, existing text is removed and the loaded image is displayed instead. -> Supported bitmap file formats are ".bmp", ".png" and ".tiff". -> Colors in bitmaps will be overridden by the button's theme color, using black -> as the transparent color for BMPs and TIFFS, and the alpha channel for PNGs. -> All other colors are mapped to the theme color according to their grey value, -> so plain white is the target theme color, and all other colors blend into the -> button's background color of the theme. - -### align : [`ButtonAlignment`](#ButtonAlignment) -> Setup the buttons text's or bitmap's alignment within the button. - -### font : [`TextFontStyle`](#TextFontStyle) -> The style that the text should be displayed with. - -### color : [`ButtonColor`](#ButtonColor) -> When set, the unpressed button's background will be drawn in the specified color. -> A text color is automatically selected unless explicitly set, to make sure its -> always visible. -> Set color {0,0,0} to enable the theme colors for the button again. - -### secondary_color : [`ButtonSecondaryColor`](#ButtonSecondaryColor) -> When set, the unpressed button's background text or bitmap will be drawn in the -> specified color. -> Set color {0,0,0} to enable the theme colors for the button again. - -### style : [`ButtonStyle`](#ButtonStyle) -> Get/set the style a button should be displayed with. - -### active : [`ControlActive`](#ControlActive) -> Instead of making a control invisible, you can also make it inactive. -> Deactivated controls will still be shown, and will still show their -> currently assigned values, but will not allow changes. Most controls will -> display as "grayed out" to visualize the deactivated state. - -### midi_mapping : [`ControlMidiMappingString`](#ControlMidiMappingString) -> When set, the control will be highlighted when Renoise's MIDI mapping dialog -> is open. When clicked, it selects the specified string as a MIDI mapping -> target action. This target acton can either be one of the globally available -> mappings in Renoise, or those that were created by the tool itself. -> Target strings are not verified. When they point to nothing, the mapped MIDI -> message will do nothing and no error is fired. - -### visible : [`ViewVisibility`](#ViewVisibility) -> Set visible to false to hide a view (make it invisible without removing -> it). Please note that view.visible will also return false when any of its -> parents are invisible (when its implicitly invisible). -> * Default: true - -### origin : [`ViewOrigin`](#ViewOrigin) -> The position of a view within its parent view. -> Only the `stack` layouts allows to freely position child views. Other -> layout views will automatically set the origin, but the origin -> then still can be read in for example mouse handlers. - -### width : [`ViewDimension`](#ViewDimension) -> **Deprecated.** Use property `size` instead. - -### height : [`ViewDimension`](#ViewDimension) -> **Deprecated.** Use property `size` instead. - -### size : [`ViewSize`](#ViewSize) -> The dimensions of a view has to be larger than 0. -> For nested views you can also specify relative size, for example -> `vb:text { size = { width = "80%", height = 20}}`. -> The percentage values are relative to the view's parent size and will -> automatically update when the parent view's size changes. - -### tooltip : [`ViewTooltip`](#ViewTooltip) -> A ViewTooltip text that should be shown for this view on mouse hover. -> * Default: "" (no tip will be shown) - -### cursor : [`ViewCursorShape`](#ViewCursorShape) -> The cursor cursor for this view which apears on mouse hover. -> Using a "none" shape will use use underlying view's cursor or the default cursor. - -### views : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)[] -> **READ-ONLY** Empty for all controls, for layout views this contains the -> layout child views in the order they got added - - - ---- -## Functions -### add_pressed_notifier([*self*](../../API/builtins/self.md), notifier : [`NotifierFunction`](#NotifierFunction)) -> Add/remove button hit/release notifier functions. -> When a "pressed" notifier is set, the release notifier is guaranteed to be -> called as soon as the mouse is released, either over your button or anywhere -> else. When a "release" notifier is set, it is only called when the mouse -> button is pressed !and! released over your button. -### add_released_notifier([*self*](../../API/builtins/self.md), notifier : [`NotifierFunction`](#NotifierFunction)) -### remove_pressed_notifier([*self*](../../API/builtins/self.md), notifier : [`NotifierFunction`](#NotifierFunction)) -### remove_released_notifier([*self*](../../API/builtins/self.md), notifier : [`NotifierFunction`](#NotifierFunction)) -### add_view([*self*](../../API/builtins/self.md), child : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)) -> Add a new child view to this view. -### remove_view([*self*](../../API/builtins/self.md), child : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)) -> Remove a child view from this view. -### swap_views([*self*](../../API/builtins/self.md), child1 : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md), child2 : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)) -> Swap position of two child views in this view. With a series of swaps views -> can be moved to any position in the parent. -### add_child([*self*](../../API/builtins/self.md), child : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)) -> **Deprecated.** Use `add_view` instead -### remove_child([*self*](../../API/builtins/self.md), child : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)) -> **Deprecated.** Use `remove_view` instead -### swap_childs([*self*](../../API/builtins/self.md), child1 : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md), child2 : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)) -> **Deprecated.** Use `swap_views` instead - - - ---- -## Aliases -### BitmapImagePath -[`string`](../../API/builtins/string.md) -> You can load an image from your tool's directory, -> or use one from Renoise's built-in icons. -> * For the built-in icons, use "Icons/ArrowRight.bmp" -> * For custom images, use a path relative to your tool's root folder. -> -> For example "Images/MyBitmap.bmp" will load the image from -> "com.me.MyTool.xrnx/Images/MyBitmap.bmp". -> If your custom path matches a built-in icon's (like "Icons/ArrowRight.bmp"), -> your image will be loaded instead of the one from Renoise. -> -> If you want to support high DPI UI scaling with your bitmaps like the -> built-in Icons, include high resolution versions with their filenames ending -> with "@4x" -> The following rules will be used when loading bitmaps -> * When UI scaling is 100%, only the base bitmaps are used. -> * When UI scaling is 125%, the base bitmaps are used, except if there is a -> ` BitmapName@x1.25.bmp` variant. -> * For all other UI scaling > 125% the "@4x" variants are used and -> downscaled as needed, except when there is an exact match for the current -> UI scaling factor (e.g. `BitmapName@1.5x.bmp` for 150%) - -### ButtonAlignment -`"center"` | `"left"` | `"right"` -> ```lua -> -- Setup the buttons text's or bitmap's alignment within the button. -> ButtonAlignment: -> | "left" -- aligned to the left -> | "right" -- aligned to the right -> | "center" -- center (default) -> ``` - -### ButtonBitmapPath -[`BitmapImagePath`](#BitmapImagePath) -> If set, existing text is removed and the loaded image is displayed instead. -> Supported bitmap file formats are ".bmp", ".png" and ".tiff". -> Colors in bitmaps will be overridden by the button's theme color, using black -> as the transparent color for BMPs and TIFFS, and the alpha channel for PNGs. -> All other colors are mapped to the theme color according to their grey value, -> so plain white is the target theme color, and all other colors blend into the -> button's background color of the theme. - -### ButtonColor -[`RGBColor`](#RGBColor) | [`ThemeColor`](#ThemeColor) -> ```lua -> -- When set, the unpressed button's background will be drawn in the specified color. -> -- A text color is automatically selected unless explicitly set, to make sure its -> -- always visible. -> -- Set color {0,0,0} to enable the theme colors for the button again. -> -- A table of 3 bytes (ranging from 0 to 255) -> -- representing the red, green and blue channels of a color. -> -- {0xFF, 0xFF, 0xFF} is white -> -- {165, 73, 35} is the red from the Renoise logo -> -- The application theme's colors -> ButtonColor: -> | "main_back" -> | "main_font" -> | "alternate_main_back" -> | "alternate_main_font" -> | "body_back" -> | "body_font" -> | "strong_body_font" -> | "button_back" -> | "button_font" -> | "button_highlight_font" -> | "selected_button_back" -> | "selected_button_font" -> | "selection_back" -> | "selection_font" -> | "standby_selection_back" -> | "standby_selection_font" -> | "midi_mapping_back" -> | "midi_mapping_font" -> | "tooltip_back" -> | "tooltip_font" -> | "valuebox_back" -> | "valuebox_font" -> | "valuebox_font_icons" -> | "scrollbar" -> | "slider" -> | "folder" -> | "pattern_default_back" -> | "pattern_default_font" -> | "pattern_default_font_volume" -> | "pattern_default_font_panning" -> | "pattern_default_font_pitch" -> | "pattern_default_font_delay" -> | "pattern_default_font_global" -> | "pattern_default_font_other" -> | "pattern_default_font_dspfx" -> | "pattern_default_font_unused" -> | "pattern_highlighted_back" -> | "pattern_highlighted_font" -> | "pattern_highlighted_font_volume" -> | "pattern_highlighted_font_panning" -> | "pattern_highlighted_font_pitch" -> | "pattern_highlighted_font_delay" -> | "pattern_highlighted_font_global" -> | "pattern_highlighted_font_other" -> | "pattern_highlighted_font_dspfx" -> | "pattern_highlighted_font_unused" -> | "pattern_playposition_back" -> | "pattern_playposition_font" -> | "pattern_centerbar_back" -> | "pattern_centerbar_font" -> | "pattern_centerbar_back_standby" -> | "pattern_centerbar_font_standby" -> | "pattern_selection" -> | "pattern_standby_selection" -> | "pattern_mute_state" -> | "automation_grid" -> | "automation_line_edge" -> | "automation_line_fill" -> | "automation_point" -> | "automation_marker_play" -> | "automation_marker_single" -> | "automation_marker_pair" -> | "automation_marker_diamond" -> | "vumeter_meter" -> | "vumeter_meter_low" -> | "vumeter_meter_middle" -> | "vumeter_meter_high" -> | "vumeter_peak" -> | "vumeter_back_normal" -> | "vumeter_back_clipped" -> | "default_color_01" -> | "default_color_02" -> | "default_color_03" -> | "default_color_04" -> | "default_color_05" -> | "default_color_06" -> | "default_color_07" -> | "default_color_08" -> | "default_color_09" -> | "default_color_10" -> | "default_color_11" -> | "default_color_12" -> | "default_color_13" -> | "default_color_14" -> | "default_color_15" -> | "default_color_16" -> ``` - -### ButtonLabel -[`string`](../../API/builtins/string.md) -> The text label of the button -> * Default: "" - -### ButtonSecondaryColor -[`RGBColor`](#RGBColor) | [`ThemeColor`](#ThemeColor) -> ```lua -> -- When set, the unpressed button's background text or bitmap will be drawn in the -> -- specified color. -> -- Set color {0,0,0} to enable the theme colors for the button again. -> -- A table of 3 bytes (ranging from 0 to 255) -> -- representing the red, green and blue channels of a color. -> -- {0xFF, 0xFF, 0xFF} is white -> -- {165, 73, 35} is the red from the Renoise logo -> -- The application theme's colors -> ButtonSecondaryColor: -> | "main_back" -> | "main_font" -> | "alternate_main_back" -> | "alternate_main_font" -> | "body_back" -> | "body_font" -> | "strong_body_font" -> | "button_back" -> | "button_font" -> | "button_highlight_font" -> | "selected_button_back" -> | "selected_button_font" -> | "selection_back" -> | "selection_font" -> | "standby_selection_back" -> | "standby_selection_font" -> | "midi_mapping_back" -> | "midi_mapping_font" -> | "tooltip_back" -> | "tooltip_font" -> | "valuebox_back" -> | "valuebox_font" -> | "valuebox_font_icons" -> | "scrollbar" -> | "slider" -> | "folder" -> | "pattern_default_back" -> | "pattern_default_font" -> | "pattern_default_font_volume" -> | "pattern_default_font_panning" -> | "pattern_default_font_pitch" -> | "pattern_default_font_delay" -> | "pattern_default_font_global" -> | "pattern_default_font_other" -> | "pattern_default_font_dspfx" -> | "pattern_default_font_unused" -> | "pattern_highlighted_back" -> | "pattern_highlighted_font" -> | "pattern_highlighted_font_volume" -> | "pattern_highlighted_font_panning" -> | "pattern_highlighted_font_pitch" -> | "pattern_highlighted_font_delay" -> | "pattern_highlighted_font_global" -> | "pattern_highlighted_font_other" -> | "pattern_highlighted_font_dspfx" -> | "pattern_highlighted_font_unused" -> | "pattern_playposition_back" -> | "pattern_playposition_font" -> | "pattern_centerbar_back" -> | "pattern_centerbar_font" -> | "pattern_centerbar_back_standby" -> | "pattern_centerbar_font_standby" -> | "pattern_selection" -> | "pattern_standby_selection" -> | "pattern_mute_state" -> | "automation_grid" -> | "automation_line_edge" -> | "automation_line_fill" -> | "automation_point" -> | "automation_marker_play" -> | "automation_marker_single" -> | "automation_marker_pair" -> | "automation_marker_diamond" -> | "vumeter_meter" -> | "vumeter_meter_low" -> | "vumeter_meter_middle" -> | "vumeter_meter_high" -> | "vumeter_peak" -> | "vumeter_back_normal" -> | "vumeter_back_clipped" -> | "default_color_01" -> | "default_color_02" -> | "default_color_03" -> | "default_color_04" -> | "default_color_05" -> | "default_color_06" -> | "default_color_07" -> | "default_color_08" -> | "default_color_09" -> | "default_color_10" -> | "default_color_11" -> | "default_color_12" -> | "default_color_13" -> | "default_color_14" -> | "default_color_15" -> | "default_color_16" -> ``` - -### ButtonStyle -`"normal"` | `"rounded"` | `"rounded_bottom"` | `"rounded_left"` | `"rounded_right"` | `"rounded_top"` -> ```lua -> -- Get/set the style a button should be displayed with. -> ButtonStyle: -> | "normal" -- (Default) -> | "rounded" -- rounded corners on all sides -> | "rounded_left" -- rounded left side -> | "rounded_right" -- rounded right side -> | "rounded_top" -- rounded left side -> | "rounded_bottom" -- rounded right side -> ``` - -### ControlActive -[`boolean`](../../API/builtins/boolean.md) -> Instead of making a control invisible, you can also make it inactive. -> Deactivated controls will still be shown, and will still show their -> currently assigned values, but will not allow changes. Most controls will -> display as "grayed out" to visualize the deactivated state. - -### ControlMidiMappingString -[`string`](../../API/builtins/string.md) -> When set, the control will be highlighted when Renoise's MIDI mapping dialog -> is open. When clicked, it selects the specified string as a MIDI mapping -> target action. This target acton can either be one of the globally available -> mappings in Renoise, or those that were created by the tool itself. -> Target strings are not verified. When they point to nothing, the mapped MIDI -> message will do nothing and no error is fired. - -### NotifierFunction -fun() - - -### RGBColor -{ 1 : [`integer`](../../API/builtins/integer.md), 2 : [`integer`](../../API/builtins/integer.md), 3 : [`integer`](../../API/builtins/integer.md) } -> A table of 3 bytes (ranging from 0 to 255) -> representing the red, green and blue channels of a color. -> {0xFF, 0xFF, 0xFF} is white -> {165, 73, 35} is the red from the Renoise logo - -### TextFontStyle -`"big"` | `"bold"` | `"code"` | `"italic"` | `"mono"` | `"normal"` -> ```lua -> -- The style that the text should be displayed with. -> TextFontStyle: -> | "normal" -- (Default) -> | "big" -- big text -> | "bold" -- bold font -> | "italic" -- italic font -> | "mono" -- monospace font -> | "code" -- monospace code font -> ``` - -### ThemeColor -`"alternate_main_back"` | `"alternate_main_font"` | `"automation_grid"` | `"automation_line_edge"` | `"automation_line_fill"` | `"automation_marker_diamond"` | `"automation_marker_pair"` | `"automation_marker_play"` | `"automation_marker_single"` | `"automation_point"` | `"body_back"` | `"body_font"` | `"button_back"` | `"button_font"` | `"button_highlight_font"` | `"default_color_01"` | `"default_color_02"` | `"default_color_03"` | `"default_color_04"` | `"default_color_05"` | `"default_color_06"` | `"default_color_07"` | `"default_color_08"` | `"default_color_09"` | `"default_color_10"` | `"default_color_11"` | `"default_color_12"` | `"default_color_13"` | `"default_color_14"` | `"default_color_15"` | `"default_color_16"` | `"folder"` | `"main_back"` | `"main_font"` | `"midi_mapping_back"` | `"midi_mapping_font"` | `"pattern_centerbar_back"` | `"pattern_centerbar_back_standby"` | `"pattern_centerbar_font"` | `"pattern_centerbar_font_standby"` | `"pattern_default_back"` | `"pattern_default_font"` | `"pattern_default_font_delay"` | `"pattern_default_font_dspfx"` | `"pattern_default_font_global"` | `"pattern_default_font_other"` | `"pattern_default_font_panning"` | `"pattern_default_font_pitch"` | `"pattern_default_font_unused"` | `"pattern_default_font_volume"` | `"pattern_highlighted_back"` | `"pattern_highlighted_font"` | `"pattern_highlighted_font_delay"` | `"pattern_highlighted_font_dspfx"` | `"pattern_highlighted_font_global"` | `"pattern_highlighted_font_other"` | `"pattern_highlighted_font_panning"` | `"pattern_highlighted_font_pitch"` | `"pattern_highlighted_font_unused"` | `"pattern_highlighted_font_volume"` | `"pattern_mute_state"` | `"pattern_playposition_back"` | `"pattern_playposition_font"` | `"pattern_selection"` | `"pattern_standby_selection"` | `"scrollbar"` | `"selected_button_back"` | `"selected_button_font"` | `"selection_back"` | `"selection_font"` | `"slider"` | `"standby_selection_back"` | `"standby_selection_font"` | `"strong_body_font"` | `"tooltip_back"` | `"tooltip_font"` | `"valuebox_back"` | `"valuebox_font"` | `"valuebox_font_icons"` | `"vumeter_back_clipped"` | `"vumeter_back_normal"` | `"vumeter_meter"` | `"vumeter_meter_high"` | `"vumeter_meter_low"` | `"vumeter_meter_middle"` | `"vumeter_peak"` -> ```lua -> -- The application theme's colors -> ThemeColor: -> | "main_back" -> | "main_font" -> | "alternate_main_back" -> | "alternate_main_font" -> | "body_back" -> | "body_font" -> | "strong_body_font" -> | "button_back" -> | "button_font" -> | "button_highlight_font" -> | "selected_button_back" -> | "selected_button_font" -> | "selection_back" -> | "selection_font" -> | "standby_selection_back" -> | "standby_selection_font" -> | "midi_mapping_back" -> | "midi_mapping_font" -> | "tooltip_back" -> | "tooltip_font" -> | "valuebox_back" -> | "valuebox_font" -> | "valuebox_font_icons" -> | "scrollbar" -> | "slider" -> | "folder" -> | "pattern_default_back" -> | "pattern_default_font" -> | "pattern_default_font_volume" -> | "pattern_default_font_panning" -> | "pattern_default_font_pitch" -> | "pattern_default_font_delay" -> | "pattern_default_font_global" -> | "pattern_default_font_other" -> | "pattern_default_font_dspfx" -> | "pattern_default_font_unused" -> | "pattern_highlighted_back" -> | "pattern_highlighted_font" -> | "pattern_highlighted_font_volume" -> | "pattern_highlighted_font_panning" -> | "pattern_highlighted_font_pitch" -> | "pattern_highlighted_font_delay" -> | "pattern_highlighted_font_global" -> | "pattern_highlighted_font_other" -> | "pattern_highlighted_font_dspfx" -> | "pattern_highlighted_font_unused" -> | "pattern_playposition_back" -> | "pattern_playposition_font" -> | "pattern_centerbar_back" -> | "pattern_centerbar_font" -> | "pattern_centerbar_back_standby" -> | "pattern_centerbar_font_standby" -> | "pattern_selection" -> | "pattern_standby_selection" -> | "pattern_mute_state" -> | "automation_grid" -> | "automation_line_edge" -> | "automation_line_fill" -> | "automation_point" -> | "automation_marker_play" -> | "automation_marker_single" -> | "automation_marker_pair" -> | "automation_marker_diamond" -> | "vumeter_meter" -> | "vumeter_meter_low" -> | "vumeter_meter_middle" -> | "vumeter_meter_high" -> | "vumeter_peak" -> | "vumeter_back_normal" -> | "vumeter_back_clipped" -> | "default_color_01" -> | "default_color_02" -> | "default_color_03" -> | "default_color_04" -> | "default_color_05" -> | "default_color_06" -> | "default_color_07" -> | "default_color_08" -> | "default_color_09" -> | "default_color_10" -> | "default_color_11" -> | "default_color_12" -> | "default_color_13" -> | "default_color_14" -> | "default_color_15" -> | "default_color_16" -> ``` - -### ViewCursorShape -`"busy"` | `"change_value"` | `"crosshair"` | `"default"` | `"drag"` | `"drop"` | `"edit_text"` | `"empty"` | `"erase"` | `"extend_bottom"` | `"extend_bottom_alias"` | `"extend_left"` | `"extend_left_alias"` | `"extend_right"` | `"extend_right_alias"` | `"extend_top"` | `"extend_top_alias"` | `"marker"` | `"move"` | `"nodrop"` | `"none"` | `"pencil"` | `"play"` | `"resize_edge_diagonal_left"` | `"resize_edge_diagonal_right"` | `"resize_edge_horizontal"` | `"resize_edge_vertical"` | `"resize_horizontal"` | `"resize_vertical"` | `"zoom"` | `"zoom_horizontal"` | `"zoom_vertical"` -> ```lua -> -- The cursor cursor for this view which apears on mouse hover. -> -- Using a "none" shape will use use underlying view's cursor or the default cursor. -> ViewCursorShape: -> | "none" -> | "empty" -> | "default" -> | "change_value" -> | "edit_text" -> | "pencil" -> | "marker" -> | "crosshair" -> | "move" -> | "erase" -> | "play" -> | "drag" -> | "drop" -> | "nodrop" -> | "busy" -> | "resize_vertical" -> | "resize_horizontal" -> | "resize_edge_vertical" -> | "resize_edge_horizontal" -> | "resize_edge_diagonal_left" -> | "resize_edge_diagonal_right" -> | "extend_left" -> | "extend_right" -> | "extend_top" -> | "extend_bottom" -> | "extend_left_alias" -> | "extend_right_alias" -> | "extend_top_alias" -> | "extend_bottom_alias" -> | "zoom_vertical" -> | "zoom_horizontal" -> | "zoom" -> ``` - -### ViewDimension -[`string`](../../API/builtins/string.md) | [`integer`](../../API/builtins/integer.md) -> The dimensions of a view has to be larger than 0. -> For nested views you can also specify relative size -> for example `vb:text { width = "80%"}`. The percentage values are -> relative to the view's parent size and will automatically update on size changes. - -### ViewOrigin -{ 1 : [`ViewPosition`](#ViewPosition), 2 : [`ViewPosition`](#ViewPosition) } | { x : [`ViewPosition`](#ViewPosition), y : [`ViewPosition`](#ViewPosition) } -> The position of a view within its parent view. -> Only the `stack` layouts allows to freely position child views. Other -> layout views will automatically set the origin, but the origin -> then still can be read in for example mouse handlers. - -### ViewPosition -[`integer`](../../API/builtins/integer.md) -> Horizontal (x) or Vertical (y) position of a view within its parent view. - -### ViewSize -{ 1 : [`ViewDimension`](#ViewDimension), 2 : [`ViewDimension`](#ViewDimension) } | { height : [`ViewDimension`](#ViewDimension), width : [`ViewDimension`](#ViewDimension) } -> The dimensions of a view has to be larger than 0. -> For nested views you can also specify relative size, for example -> `vb:text { size = { width = "80%", height = 20}}`. -> The percentage values are relative to the view's parent size and will -> automatically update when the parent view's size changes. - -### ViewTooltip -[`string`](../../API/builtins/string.md) -> A ViewTooltip text that should be shown for this view on mouse hover. -> * Default: "" (no tip will be shown) - -### ViewVisibility -[`boolean`](../../API/builtins/boolean.md) -> Set visible to false to hide a view (make it invisible without removing -> it). Please note that view.visible will also return false when any of its -> parents are invisible (when its implicitly invisible). -> * Default: true - - diff --git a/docs/API/renoise/renoise.Views.Canvas.Context.md b/docs/API/renoise/renoise.Views.Canvas.Context.md deleted file mode 100644 index 9c06e0e..0000000 --- a/docs/API/renoise/renoise.Views.Canvas.Context.md +++ /dev/null @@ -1,698 +0,0 @@ -# renoise.Views.Canvas.Context -> Drawing context for a canvas view.
-> -> The context is *similar* to the HTML5 canvas 2d drawing context, with the -> following differences and limitations: -> -> * no text drawing: layer a renoise.Views.Text on top of this view instead. -> * no image and pattern drawing: layer a renoise.Views.Bitmap on top of this -> view, if you need to draw bitmaps in the canvas. -> * no shadow rendering: that would be awful slow -> * colors can be specified as strings or rgba tables in range [0-255]. when -> specifying strings, only renoise theme colors are supported (e.g. "button_back"). -> * to create gradients use the available `start_XXX` gradient functions -> instead of creating gradient objects. -> * to set a new fill or stroke color, use the `fill_color` and `stroke_color` -> properties instead of `fill/strokeStyle` -> -> This canvas implementation is based on 'canvas_ity' by Andrew Kensler -> https://github.com/a-e-k/canvas_ity -> -> [HTML5 Canvas Documentation](https://www.w3schools.com/tags/ref_canvas.asp) - - - - ---- -## Properties -### pixel_size : { height : [`integer`](../../API/builtins/integer.md), width : [`integer`](../../API/builtins/integer.md) } -> **READ_ONLY** Size of the render context backend **in raw pixel resolution**. -> This is the view ports size, multiplied with the global UI scaling factor. -> It does not change with transformations. - -### size : { height : [`integer`](../../API/builtins/integer.md), width : [`integer`](../../API/builtins/integer.md) } -> **READ_ONLY** Size of the render context **with transformations applied**. -> This initially will be the view's size. Calls to `transform` or `scale` -> may change the size further. - -### global_alpha : [`number`](../../API/builtins/number.md) -> The degree of opacity applied to all drawing operations.
-> -> If an operation already uses a transparent color, this can make it -> yet more transparent. It must be in the range from 0 for fully transparent -> to 255 for fully opaque. Defaults to 255 (opaque). - -### global_composite_operation : `"source_atop"` | `"source_copy"` | `"source_in"` | `"source_out"` | `"source_over"` | `"destination_atop"` | `"destination_in"` | `"destination_out"` | `"destination_over"` | `"exclusive_or"` | `"lighter"` -> Compositing operation for blending new drawing and old pixels.
-> -> The source_copy, source_in, source_out, destination_atop, and -> destination_in operations may clear parts of the canvas outside the -> new drawing but within the clip region. Defaults to "source_over". - -### fill_color : [`RGBColor`](#RGBColor) | [`RGBAColor`](#RGBAColor) | [`ThemeColor`](#ThemeColor) -> Set filling to use a constant color and opacity.
-> -> Defaults a constant color with 0,0,0,255 (opaque black). - -### stroke_color : [`RGBColor`](#RGBColor) | [`RGBAColor`](#RGBAColor) | [`ThemeColor`](#ThemeColor) -> Set stroking to use a constant color and opacity.
-> -> Defaults a constant color with 0,0,0,255 (opaque black). - -### line_cap : `"butt"` | `"square"` | `"circle"` -> Cap style for the ends of open subpaths and dash segments.
-> -> The actual shape may be affected by the current transform at the time -> of drawing. Only affects stroking. Defaults to "butt". - -### line_join : `"miter"` | `"bevel"` | `"rounded"` -> Join style for connecting lines within the paths.
-> -> The actual shape may be affected by the current transform at the time -> of drawing. Only affects stroking. Defaults to "miter". - -### line_width : [`number`](../../API/builtins/number.md) -> The width of the lines when stroking.
-> -> Initially this is measured in pixels, though the current transform -> at the time of drawing can affect this. Must be positive. Defaults to 1.0. - -### miter_limit : [`number`](../../API/builtins/number.md) -> Limit on maximum pointiness allowed for miter joins.
-> -> If the distance from the point where the lines intersect to the -> point where the outside edges of the join intersect exceeds this -> ratio relative to the line width, then a bevel join will be used -> instead, and the miter will be lopped off. Larger values allow -> pointier miters. Only affects stroking and only when the line join -> style is miter. Defaults to 10.0. - -### line_dash_offset : [`number`](../../API/builtins/number.md) -> Offset where each subpath starts the dash pattern.
-> -> Changing this shifts the location of the dashes along the path and -> animating it will produce a marching ants effect. Only affects -> stroking and only when a dash pattern is set. May be negative or -> exceed the length of the dash pattern, in which case it will wrap. -> Defaults to 0.0. - - - ---- -## Functions -### clip([*self*](../../API/builtins/self.md)) -> Restrict the clip region by the current path.
-> -> Intersects the current clip region with the interior of the current -> path (the region that would be filled), and replaces the current -> clip region with this intersection. Subsequent calls to clip can -> only reduce this further. When filling or stroking, only pixels -> within the current clip region will change. The current path is -> left unchanged by updating the clip region; begin a new path to -> clear it. Defaults to the entire canvas. -> -> Tip: to be able to reset the current clip region, save the canvas -> state first before clipping then restore the state to reset it. -### save([*self*](../../API/builtins/self.md)) -> Save the current state as though to a stack.
-> -> The full state of the canvas is saved, except for the pixels in the -> canvas buffer, and the current path. -> -> Tip: to be able to reset the current clip region, save the canvas -> state first before clipping then restore the state to reset it. -### restore([*self*](../../API/builtins/self.md)) -> Restore a previously saved state as though from a stack.
-> -> This does not affect the pixels in the canvas buffer or the current -> path. If the stack of canvas states is empty, this does nothing. -### fill_rect([*self*](../../API/builtins/self.md), x : [`number`](../../API/builtins/number.md), y : [`number`](../../API/builtins/number.md), width : [`number`](../../API/builtins/number.md), height : [`number`](../../API/builtins/number.md)) -> Fill a rectangular area.
-> -> This behaves as though the current path were reset to a single -> rectangle and then filled as usual. However, the current path is -> not actually changed. The current transform at the time that this is -> called will affect the given point and rectangle. The width and/or -> the height may be negative but not zero. If either is zero, or the -> current transform is not invertible, this does nothing. -### stroke_rect([*self*](../../API/builtins/self.md), x : [`number`](../../API/builtins/number.md), y : [`number`](../../API/builtins/number.md), width : [`number`](../../API/builtins/number.md), height : [`number`](../../API/builtins/number.md)) -> Stroke a rectangular area.
-> -> This behaves as though the current path were reset to a single -> rectangle and then stroked as usual. However, the current path is -> not actually changed. The current transform at the time that this -> is called will affect the given point and rectangle. The width -> and/or the height may be negative or zero. If both are zero, or -> the current transform is not invertible, this does nothing. If only -> one is zero, this behaves as though it strokes a single horizontal or -> vertical line. -### clear_rect([*self*](../../API/builtins/self.md), x : [`number`](../../API/builtins/number.md), y : [`number`](../../API/builtins/number.md), width : [`number`](../../API/builtins/number.md), height : [`number`](../../API/builtins/number.md)) -> Clear a rectangular area back to transparent black.
-> -> The clip region may limit the area cleared. The current path is not -> affected by this clearing. The current transform at the time that -> this is called will affect the given point and rectangle. The width -> and/or the height may be negative or zero. If either is zero, or the -> current transform is not invertible, this does nothing. -### begin_path([*self*](../../API/builtins/self.md)) -> Reset the current path.
-> -> The current path and all subpaths will be cleared after this, and a -> new path can be built. -### close_path([*self*](../../API/builtins/self.md)) -> Close the current subpath.
-> -> Adds a straight line from the end of the current subpath back to its -> first point and marks the subpath as closed so that this line will -> join with the beginning of the path at this point. A new, empty -> subpath will be started beginning with the same first point. If the -> current path is empty, this does nothing. -### move_to([*self*](../../API/builtins/self.md), x : [`number`](../../API/builtins/number.md), y : [`number`](../../API/builtins/number.md)) -> Create a new subpath.
-> -> The given point will become the first point of the new subpath and -> is subject to the current transform at the time this is called. -### line_to([*self*](../../API/builtins/self.md), x : [`number`](../../API/builtins/number.md), y : [`number`](../../API/builtins/number.md)) -> Extend the current subpath with a straight line.
-> -> The line will go from the current end point (if the current path is -> not empty) to the given point, which will become the new end point. -> Its position is affected by the current transform at the time that -> this is called. If the current path was empty, this is equivalent -> to just a move. -### fill([*self*](../../API/builtins/self.md)) -> Draw the interior of the current path using the fill style.
-> -> Interior pixels are determined by the non-zero winding rule, with -> all open subpaths implicitly closed by a straight line beforehand. -> If shadows have been enabled by setting the shadow color with any -> opacity and either offsetting or blurring the shadows, then the -> shadows of the filled areas will be drawn first, followed by the -> filled areas themselves. Both will be blended into the canvas -> according to the global alpha, the global compositing operation, -> and the clip region. If the fill style is a gradient or a pattern, -> it will be affected by the current transform. The current path is -> left unchanged by filling; begin a new path to clear it. If the -> current transform is not invertible, this does nothing. -### stroke([*self*](../../API/builtins/self.md)) -> Draw the edges of the current path using the stroke style.
-> -> Edges of the path will be expanded into strokes according to the -> current dash pattern, dash offset, line width, line join style -> (and possibly miter limit), line cap, and transform. If shadows -> have been enabled by setting the shadow color with any opacity and -> either offsetting or blurring the shadows, then the shadow will be -> drawn for the stroked lines first, then the stroked lines themselves. -> Both will be blended into the canvas according to the global alpha, -> the global compositing operation, and the clip region. If the stroke -> style is a gradient or a pattern, it will be affected by the current -> transform. The current path is left unchanged by stroking; begin a -> new path to clear it. If the current transform is not invertible, -> this does nothing. -> -> Tip: to draw with a calligraphy-like angled brush effect, add a -> non-uniform scale transform just before stroking. -### set_line_dash([*self*](../../API/builtins/self.md), segments : [`number`](../../API/builtins/number.md)[]) -> Set or clear the line dash pattern.
-> -> Takes an array with entries alternately giving the lengths of dash -> and gap segments. All must be non-negative; if any are not, this -> does nothing. These will be used to draw with dashed lines when -> stroking, with each subpath starting at the length along the dash -> pattern indicated by the line dash offset. Initially these lengths -> are measured in pixels, though the current transform at the time of -> drawing can affect this. The count must be non-negative. If it is -> odd, the array will be appended to itself to make an even count. If -> it is zero, or the pointer is null, the dash pattern will be cleared -> and strokes will be drawn as solid lines. The array is copied and -> it is safe to change or destroy it after this call. Defaults to -> solid lines. -### set_fill_linear_gradient([*self*](../../API/builtins/self.md), start_x : [`number`](../../API/builtins/number.md), start_y : [`number`](../../API/builtins/number.md), end_x : [`number`](../../API/builtins/number.md), end_y : [`number`](../../API/builtins/number.md)) -> Set filling to use a linear gradient.
-> -> Positions the start and end points of the gradient and clears all -> color stops to reset the gradient to transparent black. Color stops -> can then be added again. When drawing, pixels will be painted with -> the color of the gradient at the nearest point on the line segment -> between the start and end points. This is affected by the current -> transform at the time of drawing. -### set_stroke_linear_gradient([*self*](../../API/builtins/self.md), start_x : [`number`](../../API/builtins/number.md), start_y : [`number`](../../API/builtins/number.md), end_x : [`number`](../../API/builtins/number.md), end_y : [`number`](../../API/builtins/number.md)) -> Set filling to use a linear gradient.
-> See: `renoise.Views.Canvas.Context` set_fill_linear_gradient -### set_fill_radial_gradient([*self*](../../API/builtins/self.md), start_x : [`number`](../../API/builtins/number.md), start_y : [`number`](../../API/builtins/number.md), start_radius : [`number`](../../API/builtins/number.md), end_x : [`number`](../../API/builtins/number.md), end_y : [`number`](../../API/builtins/number.md), end_radius : [`number`](../../API/builtins/number.md)) -> Set filling to use a radial gradient.
-> -> Positions the start and end circles of the gradient and clears all -> color stops to reset the gradient to transparent black. Color stops -> can then be added again. When drawing, pixels will be painted as -> though the starting circle moved and changed size linearly to match -> the ending circle, while sweeping through the colors of the gradient. -> Pixels not touched by the moving circle will be left transparent -> black. The radial gradient is affected by the current transform -> at the time of drawing. The radii must be non-negative. -### set_stroke_radial_gradient([*self*](../../API/builtins/self.md), start_x : [`number`](../../API/builtins/number.md), start_y : [`number`](../../API/builtins/number.md), start_radius : [`number`](../../API/builtins/number.md), end_x : [`number`](../../API/builtins/number.md), end_y : [`number`](../../API/builtins/number.md), end_radius : [`number`](../../API/builtins/number.md)) -> Set stroke to use a radial gradient.
-> See: `renoise.Views.Canvas.Context` set_fill_radial_gradient -### add_fill_color_stop([*self*](../../API/builtins/self.md), offset : [`number`](../../API/builtins/number.md), color : [`RGBAColor`](#RGBAColor) | [`RGBColor`](#RGBColor) | [`ThemeColor`](#ThemeColor)) -> Add a color stop to a linear or radial gradient fill.
-> -> Each color stop has an offset which defines its position from 0.0 at -> the start of the gradient to 1.0 at the end. Colors and opacity are -> linearly interpolated along the gradient between adjacent pairs of -> stops without premultiplying the alpha. If more than one stop is -> added for a given offset, the first one added is considered closest -> to 0.0 and the last is closest to 1.0. If no stop is at offset 0.0 -> or 1.0, the stops with the closest offsets will be extended. If no -> stops are added, the gradient will be fully transparent black. Set a -> new linear or radial gradient to clear all the stops and redefine the -> gradient colors. Color stops may be added to a gradient at any time. -> The color and opacity values will be clamped to the 0.0 to 1.0 range, -> inclusive. The offset must be in the 0.0 to 1.0 range, inclusive. -> If it is not, or if chosen style type is not currently set to a -> gradient, this does nothing. -> -> ```lua -> -- A table of 3 bytes (ranging from 0 to 255) -> -- representing the red, green and blue channels of a color. -> -- {0xFF, 0xFF, 0xFF} is white -> -- {165, 73, 35} is the red from the Renoise logo -> -- A table of 4 bytes (ranging from 0 to 255) -> -- representing the red, green, blue, alpha channels of a color. -> -- {0xFF, 0xFF, 0xFF, 0xFF} is white -> -- {165, 73, 35, 0x80} is the red from the Renoise logo, half opaque. -> -- The application theme's colors -> color: -> | "main_back" -> | "main_font" -> | "alternate_main_back" -> | "alternate_main_font" -> | "body_back" -> | "body_font" -> | "strong_body_font" -> | "button_back" -> | "button_font" -> | "button_highlight_font" -> | "selected_button_back" -> | "selected_button_font" -> | "selection_back" -> | "selection_font" -> | "standby_selection_back" -> | "standby_selection_font" -> | "midi_mapping_back" -> | "midi_mapping_font" -> | "tooltip_back" -> | "tooltip_font" -> | "valuebox_back" -> | "valuebox_font" -> | "valuebox_font_icons" -> | "scrollbar" -> | "slider" -> | "folder" -> | "pattern_default_back" -> | "pattern_default_font" -> | "pattern_default_font_volume" -> | "pattern_default_font_panning" -> | "pattern_default_font_pitch" -> | "pattern_default_font_delay" -> | "pattern_default_font_global" -> | "pattern_default_font_other" -> | "pattern_default_font_dspfx" -> | "pattern_default_font_unused" -> | "pattern_highlighted_back" -> | "pattern_highlighted_font" -> | "pattern_highlighted_font_volume" -> | "pattern_highlighted_font_panning" -> | "pattern_highlighted_font_pitch" -> | "pattern_highlighted_font_delay" -> | "pattern_highlighted_font_global" -> | "pattern_highlighted_font_other" -> | "pattern_highlighted_font_dspfx" -> | "pattern_highlighted_font_unused" -> | "pattern_playposition_back" -> | "pattern_playposition_font" -> | "pattern_centerbar_back" -> | "pattern_centerbar_font" -> | "pattern_centerbar_back_standby" -> | "pattern_centerbar_font_standby" -> | "pattern_selection" -> | "pattern_standby_selection" -> | "pattern_mute_state" -> | "automation_grid" -> | "automation_line_edge" -> | "automation_line_fill" -> | "automation_point" -> | "automation_marker_play" -> | "automation_marker_single" -> | "automation_marker_pair" -> | "automation_marker_diamond" -> | "vumeter_meter" -> | "vumeter_meter_low" -> | "vumeter_meter_middle" -> | "vumeter_meter_high" -> | "vumeter_peak" -> | "vumeter_back_normal" -> | "vumeter_back_clipped" -> | "default_color_01" -> | "default_color_02" -> | "default_color_03" -> | "default_color_04" -> | "default_color_05" -> | "default_color_06" -> | "default_color_07" -> | "default_color_08" -> | "default_color_09" -> | "default_color_10" -> | "default_color_11" -> | "default_color_12" -> | "default_color_13" -> | "default_color_14" -> | "default_color_15" -> | "default_color_16" -> ``` -### add_stroke_color_stop([*self*](../../API/builtins/self.md), offset : [`number`](../../API/builtins/number.md), color : [`RGBAColor`](#RGBAColor) | [`RGBColor`](#RGBColor) | [`ThemeColor`](#ThemeColor)) -> Add a color stop to a linear or radial gradient stroke.
-> -> -> ```lua -> -- A table of 3 bytes (ranging from 0 to 255) -> -- representing the red, green and blue channels of a color. -> -- {0xFF, 0xFF, 0xFF} is white -> -- {165, 73, 35} is the red from the Renoise logo -> -- A table of 4 bytes (ranging from 0 to 255) -> -- representing the red, green, blue, alpha channels of a color. -> -- {0xFF, 0xFF, 0xFF, 0xFF} is white -> -- {165, 73, 35, 0x80} is the red from the Renoise logo, half opaque. -> -- The application theme's colors -> color: -> | "main_back" -> | "main_font" -> | "alternate_main_back" -> | "alternate_main_font" -> | "body_back" -> | "body_font" -> | "strong_body_font" -> | "button_back" -> | "button_font" -> | "button_highlight_font" -> | "selected_button_back" -> | "selected_button_font" -> | "selection_back" -> | "selection_font" -> | "standby_selection_back" -> | "standby_selection_font" -> | "midi_mapping_back" -> | "midi_mapping_font" -> | "tooltip_back" -> | "tooltip_font" -> | "valuebox_back" -> | "valuebox_font" -> | "valuebox_font_icons" -> | "scrollbar" -> | "slider" -> | "folder" -> | "pattern_default_back" -> | "pattern_default_font" -> | "pattern_default_font_volume" -> | "pattern_default_font_panning" -> | "pattern_default_font_pitch" -> | "pattern_default_font_delay" -> | "pattern_default_font_global" -> | "pattern_default_font_other" -> | "pattern_default_font_dspfx" -> | "pattern_default_font_unused" -> | "pattern_highlighted_back" -> | "pattern_highlighted_font" -> | "pattern_highlighted_font_volume" -> | "pattern_highlighted_font_panning" -> | "pattern_highlighted_font_pitch" -> | "pattern_highlighted_font_delay" -> | "pattern_highlighted_font_global" -> | "pattern_highlighted_font_other" -> | "pattern_highlighted_font_dspfx" -> | "pattern_highlighted_font_unused" -> | "pattern_playposition_back" -> | "pattern_playposition_font" -> | "pattern_centerbar_back" -> | "pattern_centerbar_font" -> | "pattern_centerbar_back_standby" -> | "pattern_centerbar_font_standby" -> | "pattern_selection" -> | "pattern_standby_selection" -> | "pattern_mute_state" -> | "automation_grid" -> | "automation_line_edge" -> | "automation_line_fill" -> | "automation_point" -> | "automation_marker_play" -> | "automation_marker_single" -> | "automation_marker_pair" -> | "automation_marker_diamond" -> | "vumeter_meter" -> | "vumeter_meter_low" -> | "vumeter_meter_middle" -> | "vumeter_meter_high" -> | "vumeter_peak" -> | "vumeter_back_normal" -> | "vumeter_back_clipped" -> | "default_color_01" -> | "default_color_02" -> | "default_color_03" -> | "default_color_04" -> | "default_color_05" -> | "default_color_06" -> | "default_color_07" -> | "default_color_08" -> | "default_color_09" -> | "default_color_10" -> | "default_color_11" -> | "default_color_12" -> | "default_color_13" -> | "default_color_14" -> | "default_color_15" -> | "default_color_16" -> ``` -> See: `renoise.Views.Canvas.Context` add_fill_color_stop -### rect([*self*](../../API/builtins/self.md), x : [`number`](../../API/builtins/number.md), y : [`number`](../../API/builtins/number.md), width : [`number`](../../API/builtins/number.md), height : [`number`](../../API/builtins/number.md)) -> Add a closed subpath in the shape of a rectangle.
-> -> The rectangle has one corner at the given point and then goes in the -> direction along the width before going in the direction of the height -> towards the opposite corner. The current transform at the time that -> this is called will affect the given point and rectangle. The width -> and/or the height may be negative or zero, and this can affect the -> winding direction. -### bezier_curve_to([*self*](../../API/builtins/self.md), control_1_x : [`number`](../../API/builtins/number.md), control_1_y : [`number`](../../API/builtins/number.md), control_2_x : [`number`](../../API/builtins/number.md), control_2_y : [`number`](../../API/builtins/number.md), x : [`number`](../../API/builtins/number.md), y : [`number`](../../API/builtins/number.md)) -> Extend the current subpath with a cubic Bezier curve.
-> -> The curve will go from the current end point (or the first control -> point if the current path is empty) to the given point, which will -> become the new end point. The curve will be tangent toward the first -> control point at the beginning and tangent toward the second control -> point at the end. The current transform at the time that this is -> called will affect all points passed in. -> -> Tip: to make multiple curves join smoothly, ensure that each new end -> point is on a line between the adjacent control points. -### arc([*self*](../../API/builtins/self.md), x : [`number`](../../API/builtins/number.md), y : [`number`](../../API/builtins/number.md), radius : [`number`](../../API/builtins/number.md), start_angle : [`number`](../../API/builtins/number.md), end_angle : [`number`](../../API/builtins/number.md), counter_clockwise : [`boolean`](../../API/builtins/boolean.md)[`?`](../../API/builtins/nil.md)) -> Extend the current subpath with an arc between two angles.
-> -> The arc is from the circle centered at the given point and with the -> given radius. A straight line will be added from the current end -> point to the starting point of the arc (unless the current path is -> empty), then the arc along the circle from the starting angle to the -> ending angle in the given direction will be added. If they are more -> than two pi radians apart in the given direction, the arc will stop -> after one full circle. The point at the ending angle will become -> the new end point of the path. Initially, the angles are clockwise -> relative to the x-axis. The current transform at the time that -> this is called will affect the passed in point, angles, and arc. -> The radius must be non-negative. -### arc_to([*self*](../../API/builtins/self.md), vertex_x : [`number`](../../API/builtins/number.md), vertex_y : [`number`](../../API/builtins/number.md), x : [`number`](../../API/builtins/number.md), y : [`number`](../../API/builtins/number.md), radius : [`number`](../../API/builtins/number.md)) -> Extend the current subpath with an arc tangent to two lines.
-> -> The arc is from the circle with the given radius tangent to both -> the line from the current end point to the vertex, and to the line -> from the vertex to the given point. A straight line will be added -> from the current end point to the first tangent point (unless the -> current path is empty), then the shortest arc from the first to the -> second tangent points will be added. The second tangent point will -> become the new end point. If the radius is large, these tangent -> points may fall outside the line segments. The current transform -> at the time that this is called will affect the passed in points -> and the arc. If the current path was empty, this is equivalent to -> a move. If the arc would be degenerate, it is equivalent to a line -> to the vertex point. The radius must be non-negative. If it is not, -> or if the current transform is not invertible, this does nothing. -> -> Tip: to draw a polygon with rounded corners, call this once for each -> vertex and pass the midpoint of the adjacent edge as the second -> point; this works especially well for rounded boxes. -### quadratic_curve_to([*self*](../../API/builtins/self.md), control_x : [`number`](../../API/builtins/number.md), control_y : [`number`](../../API/builtins/number.md), x : [`number`](../../API/builtins/number.md), y : [`number`](../../API/builtins/number.md)) -> Extend the current subpath with a quadratic Bezier curve.
-> -> The curve will go from the current end point (or the control point -> if the current path is empty) to the given point, which will become -> the new end point. The curve will be tangent toward the control -> point at both ends. The current transform at the time that this -> is called will affect both points passed in. -> -> Tip: to make multiple curves join smoothly, ensure that each new end -> point is on a line between the adjacent control points. -### scale([*self*](../../API/builtins/self.md), x : [`number`](../../API/builtins/number.md), y : [`number`](../../API/builtins/number.md)) -> Scale the current transform.
-> -> Scaling may be non-uniform if the x and y scaling factors are -> different. When a scale factor is less than one, things will be -> shrunk in that direction. When a scale factor is greater than -> one, they will grow bigger. Negative scaling factors will flip or -> mirror it in that direction. The scaling factors must be non-zero. -> If either is zero, most drawing operations will do nothing. -### rotate([*self*](../../API/builtins/self.md), angle : [`number`](../../API/builtins/number.md)) -> Rotate the current transform.
-> -> The rotation is applied clockwise in a direction around the origin. -> -> Tip: to rotate around another point, first translate that point to -> the origin, then do the rotation, and then translate back. -### translate([*self*](../../API/builtins/self.md), x : [`number`](../../API/builtins/number.md), y : [`number`](../../API/builtins/number.md)) -> Translate the current transform.
-> -> By default, positive x values shift that many pixels to the right, -> while negative y values shift left, positive y values shift up, and -> negative y values shift down. -### transform([*self*](../../API/builtins/self.md), a : [`number`](../../API/builtins/number.md), b : [`number`](../../API/builtins/number.md), c : [`number`](../../API/builtins/number.md), d : [`number`](../../API/builtins/number.md), e : [`number`](../../API/builtins/number.md), f : [`number`](../../API/builtins/number.md)) -> Add an arbitrary transform to the current transform.
-> -> This takes six values for the upper two rows of a homogenous 3x3 -> matrix (i.e., {{a, c, e}, {b, d, f}, {0.0, 0.0, 1.0}}) describing an -> arbitrary affine transform and appends it to the current transform. -> The values can represent any affine transform such as scaling, -> rotation, translation, or skew, or any composition of affine -> transforms. The matrix must be invertible. If it is not, most -> drawing operations will do nothing. -### set_transform([*self*](../../API/builtins/self.md), a : [`number`](../../API/builtins/number.md), b : [`number`](../../API/builtins/number.md), c : [`number`](../../API/builtins/number.md), d : [`number`](../../API/builtins/number.md), e : [`number`](../../API/builtins/number.md), f : [`number`](../../API/builtins/number.md)) -> Replace the current transform.
-> -> This takes six values for the upper two rows of a homogenous 3x3 -> matrix (i.e., {{a, c, e}, {b, d, f}, {0.0, 0.0, 1.0}}) describing -> an arbitrary affine transform and replaces the current transform -> with it. The values can represent any affine transform such as -> scaling, rotation, translation, or skew, or any composition of -> affine transforms. The matrix must be invertible. If it is not, -> most drawing operations will do nothing. -> -> Tip: to reset the current transform back to the default, use -> 1.0, 0.0, 0.0, 1.0, 0.0, 0.0. - - - ---- -## Aliases -### RGBAColor -{ 1 : [`integer`](../../API/builtins/integer.md), 2 : [`integer`](../../API/builtins/integer.md), 3 : [`integer`](../../API/builtins/integer.md), 4 : [`integer`](../../API/builtins/integer.md) } -> A table of 4 bytes (ranging from 0 to 255) -> representing the red, green, blue, alpha channels of a color. -> {0xFF, 0xFF, 0xFF, 0xFF} is white -> {165, 73, 35, 0x80} is the red from the Renoise logo, half opaque. - -### RGBColor -{ 1 : [`integer`](../../API/builtins/integer.md), 2 : [`integer`](../../API/builtins/integer.md), 3 : [`integer`](../../API/builtins/integer.md) } -> A table of 3 bytes (ranging from 0 to 255) -> representing the red, green and blue channels of a color. -> {0xFF, 0xFF, 0xFF} is white -> {165, 73, 35} is the red from the Renoise logo - -### ThemeColor -`"alternate_main_back"` | `"alternate_main_font"` | `"automation_grid"` | `"automation_line_edge"` | `"automation_line_fill"` | `"automation_marker_diamond"` | `"automation_marker_pair"` | `"automation_marker_play"` | `"automation_marker_single"` | `"automation_point"` | `"body_back"` | `"body_font"` | `"button_back"` | `"button_font"` | `"button_highlight_font"` | `"default_color_01"` | `"default_color_02"` | `"default_color_03"` | `"default_color_04"` | `"default_color_05"` | `"default_color_06"` | `"default_color_07"` | `"default_color_08"` | `"default_color_09"` | `"default_color_10"` | `"default_color_11"` | `"default_color_12"` | `"default_color_13"` | `"default_color_14"` | `"default_color_15"` | `"default_color_16"` | `"folder"` | `"main_back"` | `"main_font"` | `"midi_mapping_back"` | `"midi_mapping_font"` | `"pattern_centerbar_back"` | `"pattern_centerbar_back_standby"` | `"pattern_centerbar_font"` | `"pattern_centerbar_font_standby"` | `"pattern_default_back"` | `"pattern_default_font"` | `"pattern_default_font_delay"` | `"pattern_default_font_dspfx"` | `"pattern_default_font_global"` | `"pattern_default_font_other"` | `"pattern_default_font_panning"` | `"pattern_default_font_pitch"` | `"pattern_default_font_unused"` | `"pattern_default_font_volume"` | `"pattern_highlighted_back"` | `"pattern_highlighted_font"` | `"pattern_highlighted_font_delay"` | `"pattern_highlighted_font_dspfx"` | `"pattern_highlighted_font_global"` | `"pattern_highlighted_font_other"` | `"pattern_highlighted_font_panning"` | `"pattern_highlighted_font_pitch"` | `"pattern_highlighted_font_unused"` | `"pattern_highlighted_font_volume"` | `"pattern_mute_state"` | `"pattern_playposition_back"` | `"pattern_playposition_font"` | `"pattern_selection"` | `"pattern_standby_selection"` | `"scrollbar"` | `"selected_button_back"` | `"selected_button_font"` | `"selection_back"` | `"selection_font"` | `"slider"` | `"standby_selection_back"` | `"standby_selection_font"` | `"strong_body_font"` | `"tooltip_back"` | `"tooltip_font"` | `"valuebox_back"` | `"valuebox_font"` | `"valuebox_font_icons"` | `"vumeter_back_clipped"` | `"vumeter_back_normal"` | `"vumeter_meter"` | `"vumeter_meter_high"` | `"vumeter_meter_low"` | `"vumeter_meter_middle"` | `"vumeter_peak"` -> ```lua -> -- The application theme's colors -> ThemeColor: -> | "main_back" -> | "main_font" -> | "alternate_main_back" -> | "alternate_main_font" -> | "body_back" -> | "body_font" -> | "strong_body_font" -> | "button_back" -> | "button_font" -> | "button_highlight_font" -> | "selected_button_back" -> | "selected_button_font" -> | "selection_back" -> | "selection_font" -> | "standby_selection_back" -> | "standby_selection_font" -> | "midi_mapping_back" -> | "midi_mapping_font" -> | "tooltip_back" -> | "tooltip_font" -> | "valuebox_back" -> | "valuebox_font" -> | "valuebox_font_icons" -> | "scrollbar" -> | "slider" -> | "folder" -> | "pattern_default_back" -> | "pattern_default_font" -> | "pattern_default_font_volume" -> | "pattern_default_font_panning" -> | "pattern_default_font_pitch" -> | "pattern_default_font_delay" -> | "pattern_default_font_global" -> | "pattern_default_font_other" -> | "pattern_default_font_dspfx" -> | "pattern_default_font_unused" -> | "pattern_highlighted_back" -> | "pattern_highlighted_font" -> | "pattern_highlighted_font_volume" -> | "pattern_highlighted_font_panning" -> | "pattern_highlighted_font_pitch" -> | "pattern_highlighted_font_delay" -> | "pattern_highlighted_font_global" -> | "pattern_highlighted_font_other" -> | "pattern_highlighted_font_dspfx" -> | "pattern_highlighted_font_unused" -> | "pattern_playposition_back" -> | "pattern_playposition_font" -> | "pattern_centerbar_back" -> | "pattern_centerbar_font" -> | "pattern_centerbar_back_standby" -> | "pattern_centerbar_font_standby" -> | "pattern_selection" -> | "pattern_standby_selection" -> | "pattern_mute_state" -> | "automation_grid" -> | "automation_line_edge" -> | "automation_line_fill" -> | "automation_point" -> | "automation_marker_play" -> | "automation_marker_single" -> | "automation_marker_pair" -> | "automation_marker_diamond" -> | "vumeter_meter" -> | "vumeter_meter_low" -> | "vumeter_meter_middle" -> | "vumeter_meter_high" -> | "vumeter_peak" -> | "vumeter_back_normal" -> | "vumeter_back_clipped" -> | "default_color_01" -> | "default_color_02" -> | "default_color_03" -> | "default_color_04" -> | "default_color_05" -> | "default_color_06" -> | "default_color_07" -> | "default_color_08" -> | "default_color_09" -> | "default_color_10" -> | "default_color_11" -> | "default_color_12" -> | "default_color_13" -> | "default_color_14" -> | "default_color_15" -> | "default_color_16" -> ``` - - diff --git a/docs/API/renoise/renoise.Views.Canvas.md b/docs/API/renoise/renoise.Views.Canvas.md deleted file mode 100644 index f17fe95..0000000 --- a/docs/API/renoise/renoise.Views.Canvas.md +++ /dev/null @@ -1,187 +0,0 @@ -# renoise.Views.Canvas -> A canvas view lets you draw and handle mouse events in a completely -> customisable way. -> -> Note: The content is cached in a texture and not hardware accelerated, so -> it's not suitable for animations, but for static content such as custom -> backgrounds or bitmap-like views. -> ```text -> .--. -> .'_\/_'. -> '. /\ .' -> "||" -> || /\ -> /\ ||//\) -> (/\\||/ -> ______\||/_______ -> ``` - - - - ---- -## Properties -### mode : [`CanvasMode`](#CanvasMode) -> How to draw the canvas context to screen: "transparent" draws with alpha from -> the canvas, "plain" ignores alpha values, which usually is a lot faster to draw. -> Use "plain" to speed up drawing background alike canvas views which cover the -> entire view area. Default: "transparent" - -### visible : [`ViewVisibility`](#ViewVisibility) -> Set visible to false to hide a view (make it invisible without removing -> it). Please note that view.visible will also return false when any of its -> parents are invisible (when its implicitly invisible). -> * Default: true - -### origin : [`ViewOrigin`](#ViewOrigin) -> The position of a view within its parent view. -> Only the `stack` layouts allows to freely position child views. Other -> layout views will automatically set the origin, but the origin -> then still can be read in for example mouse handlers. - -### width : [`ViewDimension`](#ViewDimension) -> **Deprecated.** Use property `size` instead. - -### height : [`ViewDimension`](#ViewDimension) -> **Deprecated.** Use property `size` instead. - -### size : [`ViewSize`](#ViewSize) -> The dimensions of a view has to be larger than 0. -> For nested views you can also specify relative size, for example -> `vb:text { size = { width = "80%", height = 20}}`. -> The percentage values are relative to the view's parent size and will -> automatically update when the parent view's size changes. - -### tooltip : [`ViewTooltip`](#ViewTooltip) -> A ViewTooltip text that should be shown for this view on mouse hover. -> * Default: "" (no tip will be shown) - -### cursor : [`ViewCursorShape`](#ViewCursorShape) -> The cursor cursor for this view which apears on mouse hover. -> Using a "none" shape will use use underlying view's cursor or the default cursor. - -### views : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)[] -> **READ-ONLY** Empty for all controls, for layout views this contains the -> layout child views in the order they got added - - - ---- -## Functions -### update([*self*](../../API/builtins/self.md)) -> Request background drawing contents of the canvas to be updated in the next -> UI draw cycle.
-> -> Size changes of the canvas view, global UI scaling changes, and color theme -> changes will automatically update the canvas, so this is only necessary to -> call when your draw content needs to be updated due to some internal state -> changes. -### add_view([*self*](../../API/builtins/self.md), child : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)) -> Add a new child view to this view. -### remove_view([*self*](../../API/builtins/self.md), child : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)) -> Remove a child view from this view. -### swap_views([*self*](../../API/builtins/self.md), child1 : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md), child2 : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)) -> Swap position of two child views in this view. With a series of swaps views -> can be moved to any position in the parent. -### add_child([*self*](../../API/builtins/self.md), child : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)) -> **Deprecated.** Use `add_view` instead -### remove_child([*self*](../../API/builtins/self.md), child : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)) -> **Deprecated.** Use `remove_view` instead -### swap_childs([*self*](../../API/builtins/self.md), child1 : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md), child2 : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)) -> **Deprecated.** Use `swap_views` instead - - - ---- -## Aliases -### CanvasMode -`"plain"` | `"transparent"` -> ```lua -> -- How to draw the canvas context to screen: "transparent" draws with alpha from -> -- the canvas, "plain" ignores alpha values, which usually is a lot faster to draw. -> -- Use "plain" to speed up drawing background alike canvas views which cover the -> -- entire view area. Default: "transparent" -> CanvasMode: -> | "plain" -> | "transparent" -> ``` - -### ViewCursorShape -`"busy"` | `"change_value"` | `"crosshair"` | `"default"` | `"drag"` | `"drop"` | `"edit_text"` | `"empty"` | `"erase"` | `"extend_bottom"` | `"extend_bottom_alias"` | `"extend_left"` | `"extend_left_alias"` | `"extend_right"` | `"extend_right_alias"` | `"extend_top"` | `"extend_top_alias"` | `"marker"` | `"move"` | `"nodrop"` | `"none"` | `"pencil"` | `"play"` | `"resize_edge_diagonal_left"` | `"resize_edge_diagonal_right"` | `"resize_edge_horizontal"` | `"resize_edge_vertical"` | `"resize_horizontal"` | `"resize_vertical"` | `"zoom"` | `"zoom_horizontal"` | `"zoom_vertical"` -> ```lua -> -- The cursor cursor for this view which apears on mouse hover. -> -- Using a "none" shape will use use underlying view's cursor or the default cursor. -> ViewCursorShape: -> | "none" -> | "empty" -> | "default" -> | "change_value" -> | "edit_text" -> | "pencil" -> | "marker" -> | "crosshair" -> | "move" -> | "erase" -> | "play" -> | "drag" -> | "drop" -> | "nodrop" -> | "busy" -> | "resize_vertical" -> | "resize_horizontal" -> | "resize_edge_vertical" -> | "resize_edge_horizontal" -> | "resize_edge_diagonal_left" -> | "resize_edge_diagonal_right" -> | "extend_left" -> | "extend_right" -> | "extend_top" -> | "extend_bottom" -> | "extend_left_alias" -> | "extend_right_alias" -> | "extend_top_alias" -> | "extend_bottom_alias" -> | "zoom_vertical" -> | "zoom_horizontal" -> | "zoom" -> ``` - -### ViewDimension -[`string`](../../API/builtins/string.md) | [`integer`](../../API/builtins/integer.md) -> The dimensions of a view has to be larger than 0. -> For nested views you can also specify relative size -> for example `vb:text { width = "80%"}`. The percentage values are -> relative to the view's parent size and will automatically update on size changes. - -### ViewOrigin -{ 1 : [`ViewPosition`](#ViewPosition), 2 : [`ViewPosition`](#ViewPosition) } | { x : [`ViewPosition`](#ViewPosition), y : [`ViewPosition`](#ViewPosition) } -> The position of a view within its parent view. -> Only the `stack` layouts allows to freely position child views. Other -> layout views will automatically set the origin, but the origin -> then still can be read in for example mouse handlers. - -### ViewPosition -[`integer`](../../API/builtins/integer.md) -> Horizontal (x) or Vertical (y) position of a view within its parent view. - -### ViewSize -{ 1 : [`ViewDimension`](#ViewDimension), 2 : [`ViewDimension`](#ViewDimension) } | { height : [`ViewDimension`](#ViewDimension), width : [`ViewDimension`](#ViewDimension) } -> The dimensions of a view has to be larger than 0. -> For nested views you can also specify relative size, for example -> `vb:text { size = { width = "80%", height = 20}}`. -> The percentage values are relative to the view's parent size and will -> automatically update when the parent view's size changes. - -### ViewTooltip -[`string`](../../API/builtins/string.md) -> A ViewTooltip text that should be shown for this view on mouse hover. -> * Default: "" (no tip will be shown) - -### ViewVisibility -[`boolean`](../../API/builtins/boolean.md) -> Set visible to false to hide a view (make it invisible without removing -> it). Please note that view.visible will also return false when any of its -> parents are invisible (when its implicitly invisible). -> * Default: true - - diff --git a/docs/API/renoise/renoise.Views.CheckBox.md b/docs/API/renoise/renoise.Views.CheckBox.md deleted file mode 100644 index 11c622b..0000000 --- a/docs/API/renoise/renoise.Views.CheckBox.md +++ /dev/null @@ -1,199 +0,0 @@ -# renoise.Views.CheckBox -> A single button with a checkbox bitmap, which can be used to toggle -> something on/off. -> ```text -> +----+ -> | _/ | -> +----+ -> ``` - - - - ---- -## Properties -### value : [`CheckBoxBoolean`](#CheckBoxBoolean) -> The current state of the checkbox, expressed as boolean. -> * Default: false - -### active : [`ControlActive`](#ControlActive) -> Instead of making a control invisible, you can also make it inactive. -> Deactivated controls will still be shown, and will still show their -> currently assigned values, but will not allow changes. Most controls will -> display as "grayed out" to visualize the deactivated state. - -### midi_mapping : [`ControlMidiMappingString`](#ControlMidiMappingString) -> When set, the control will be highlighted when Renoise's MIDI mapping dialog -> is open. When clicked, it selects the specified string as a MIDI mapping -> target action. This target acton can either be one of the globally available -> mappings in Renoise, or those that were created by the tool itself. -> Target strings are not verified. When they point to nothing, the mapped MIDI -> message will do nothing and no error is fired. - -### visible : [`ViewVisibility`](#ViewVisibility) -> Set visible to false to hide a view (make it invisible without removing -> it). Please note that view.visible will also return false when any of its -> parents are invisible (when its implicitly invisible). -> * Default: true - -### origin : [`ViewOrigin`](#ViewOrigin) -> The position of a view within its parent view. -> Only the `stack` layouts allows to freely position child views. Other -> layout views will automatically set the origin, but the origin -> then still can be read in for example mouse handlers. - -### width : [`ViewDimension`](#ViewDimension) -> **Deprecated.** Use property `size` instead. - -### height : [`ViewDimension`](#ViewDimension) -> **Deprecated.** Use property `size` instead. - -### size : [`ViewSize`](#ViewSize) -> The dimensions of a view has to be larger than 0. -> For nested views you can also specify relative size, for example -> `vb:text { size = { width = "80%", height = 20}}`. -> The percentage values are relative to the view's parent size and will -> automatically update when the parent view's size changes. - -### tooltip : [`ViewTooltip`](#ViewTooltip) -> A ViewTooltip text that should be shown for this view on mouse hover. -> * Default: "" (no tip will be shown) - -### cursor : [`ViewCursorShape`](#ViewCursorShape) -> The cursor cursor for this view which apears on mouse hover. -> Using a "none" shape will use use underlying view's cursor or the default cursor. - -### views : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)[] -> **READ-ONLY** Empty for all controls, for layout views this contains the -> layout child views in the order they got added - - - ---- -## Functions -### add_notifier([*self*](../../API/builtins/self.md), notifier : [`BooleanValueNotifierFunction`](#BooleanValueNotifierFunction)) -> Add value change notifier -### remove_notifier([*self*](../../API/builtins/self.md), notifier : [`BooleanValueNotifierFunction`](#BooleanValueNotifierFunction)) -> Remove value change notifier -### add_view([*self*](../../API/builtins/self.md), child : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)) -> Add a new child view to this view. -### remove_view([*self*](../../API/builtins/self.md), child : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)) -> Remove a child view from this view. -### swap_views([*self*](../../API/builtins/self.md), child1 : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md), child2 : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)) -> Swap position of two child views in this view. With a series of swaps views -> can be moved to any position in the parent. -### add_child([*self*](../../API/builtins/self.md), child : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)) -> **Deprecated.** Use `add_view` instead -### remove_child([*self*](../../API/builtins/self.md), child : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)) -> **Deprecated.** Use `remove_view` instead -### swap_childs([*self*](../../API/builtins/self.md), child1 : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md), child2 : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)) -> **Deprecated.** Use `swap_views` instead - - - ---- -## Aliases -### BooleanValueNotifierFunction -(value : [`boolean`](../../API/builtins/boolean.md)) - - -### CheckBoxBoolean -[`boolean`](../../API/builtins/boolean.md) -> The current state of the checkbox, expressed as boolean. -> * Default: false - -### ControlActive -[`boolean`](../../API/builtins/boolean.md) -> Instead of making a control invisible, you can also make it inactive. -> Deactivated controls will still be shown, and will still show their -> currently assigned values, but will not allow changes. Most controls will -> display as "grayed out" to visualize the deactivated state. - -### ControlMidiMappingString -[`string`](../../API/builtins/string.md) -> When set, the control will be highlighted when Renoise's MIDI mapping dialog -> is open. When clicked, it selects the specified string as a MIDI mapping -> target action. This target acton can either be one of the globally available -> mappings in Renoise, or those that were created by the tool itself. -> Target strings are not verified. When they point to nothing, the mapped MIDI -> message will do nothing and no error is fired. - -### ViewCursorShape -`"busy"` | `"change_value"` | `"crosshair"` | `"default"` | `"drag"` | `"drop"` | `"edit_text"` | `"empty"` | `"erase"` | `"extend_bottom"` | `"extend_bottom_alias"` | `"extend_left"` | `"extend_left_alias"` | `"extend_right"` | `"extend_right_alias"` | `"extend_top"` | `"extend_top_alias"` | `"marker"` | `"move"` | `"nodrop"` | `"none"` | `"pencil"` | `"play"` | `"resize_edge_diagonal_left"` | `"resize_edge_diagonal_right"` | `"resize_edge_horizontal"` | `"resize_edge_vertical"` | `"resize_horizontal"` | `"resize_vertical"` | `"zoom"` | `"zoom_horizontal"` | `"zoom_vertical"` -> ```lua -> -- The cursor cursor for this view which apears on mouse hover. -> -- Using a "none" shape will use use underlying view's cursor or the default cursor. -> ViewCursorShape: -> | "none" -> | "empty" -> | "default" -> | "change_value" -> | "edit_text" -> | "pencil" -> | "marker" -> | "crosshair" -> | "move" -> | "erase" -> | "play" -> | "drag" -> | "drop" -> | "nodrop" -> | "busy" -> | "resize_vertical" -> | "resize_horizontal" -> | "resize_edge_vertical" -> | "resize_edge_horizontal" -> | "resize_edge_diagonal_left" -> | "resize_edge_diagonal_right" -> | "extend_left" -> | "extend_right" -> | "extend_top" -> | "extend_bottom" -> | "extend_left_alias" -> | "extend_right_alias" -> | "extend_top_alias" -> | "extend_bottom_alias" -> | "zoom_vertical" -> | "zoom_horizontal" -> | "zoom" -> ``` - -### ViewDimension -[`string`](../../API/builtins/string.md) | [`integer`](../../API/builtins/integer.md) -> The dimensions of a view has to be larger than 0. -> For nested views you can also specify relative size -> for example `vb:text { width = "80%"}`. The percentage values are -> relative to the view's parent size and will automatically update on size changes. - -### ViewOrigin -{ 1 : [`ViewPosition`](#ViewPosition), 2 : [`ViewPosition`](#ViewPosition) } | { x : [`ViewPosition`](#ViewPosition), y : [`ViewPosition`](#ViewPosition) } -> The position of a view within its parent view. -> Only the `stack` layouts allows to freely position child views. Other -> layout views will automatically set the origin, but the origin -> then still can be read in for example mouse handlers. - -### ViewPosition -[`integer`](../../API/builtins/integer.md) -> Horizontal (x) or Vertical (y) position of a view within its parent view. - -### ViewSize -{ 1 : [`ViewDimension`](#ViewDimension), 2 : [`ViewDimension`](#ViewDimension) } | { height : [`ViewDimension`](#ViewDimension), width : [`ViewDimension`](#ViewDimension) } -> The dimensions of a view has to be larger than 0. -> For nested views you can also specify relative size, for example -> `vb:text { size = { width = "80%", height = 20}}`. -> The percentage values are relative to the view's parent size and will -> automatically update when the parent view's size changes. - -### ViewTooltip -[`string`](../../API/builtins/string.md) -> A ViewTooltip text that should be shown for this view on mouse hover. -> * Default: "" (no tip will be shown) - -### ViewVisibility -[`boolean`](../../API/builtins/boolean.md) -> Set visible to false to hide a view (make it invisible without removing -> it). Please note that view.visible will also return false when any of its -> parents are invisible (when its implicitly invisible). -> * Default: true - - diff --git a/docs/API/renoise/renoise.Views.Chooser.md b/docs/API/renoise/renoise.Views.Chooser.md deleted file mode 100644 index 8038e75..0000000 --- a/docs/API/renoise/renoise.Views.Chooser.md +++ /dev/null @@ -1,204 +0,0 @@ -# renoise.Views.Chooser -> A radio button like set of vertically stacked items. Only one value can be -> selected at a time. -> ```text -> . Item A -> o Item B -> . Item C -> ``` - - - - ---- -## Properties -### items : [`ItemLabels`](#ItemLabels) -> A list of buttons labels to show in order. Must have more than one item. - -### value : [`SelectedItem`](#SelectedItem) -> The currently selected item's index - -### active : [`ControlActive`](#ControlActive) -> Instead of making a control invisible, you can also make it inactive. -> Deactivated controls will still be shown, and will still show their -> currently assigned values, but will not allow changes. Most controls will -> display as "grayed out" to visualize the deactivated state. - -### midi_mapping : [`ControlMidiMappingString`](#ControlMidiMappingString) -> When set, the control will be highlighted when Renoise's MIDI mapping dialog -> is open. When clicked, it selects the specified string as a MIDI mapping -> target action. This target acton can either be one of the globally available -> mappings in Renoise, or those that were created by the tool itself. -> Target strings are not verified. When they point to nothing, the mapped MIDI -> message will do nothing and no error is fired. - -### visible : [`ViewVisibility`](#ViewVisibility) -> Set visible to false to hide a view (make it invisible without removing -> it). Please note that view.visible will also return false when any of its -> parents are invisible (when its implicitly invisible). -> * Default: true - -### origin : [`ViewOrigin`](#ViewOrigin) -> The position of a view within its parent view. -> Only the `stack` layouts allows to freely position child views. Other -> layout views will automatically set the origin, but the origin -> then still can be read in for example mouse handlers. - -### width : [`ViewDimension`](#ViewDimension) -> **Deprecated.** Use property `size` instead. - -### height : [`ViewDimension`](#ViewDimension) -> **Deprecated.** Use property `size` instead. - -### size : [`ViewSize`](#ViewSize) -> The dimensions of a view has to be larger than 0. -> For nested views you can also specify relative size, for example -> `vb:text { size = { width = "80%", height = 20}}`. -> The percentage values are relative to the view's parent size and will -> automatically update when the parent view's size changes. - -### tooltip : [`ViewTooltip`](#ViewTooltip) -> A ViewTooltip text that should be shown for this view on mouse hover. -> * Default: "" (no tip will be shown) - -### cursor : [`ViewCursorShape`](#ViewCursorShape) -> The cursor cursor for this view which apears on mouse hover. -> Using a "none" shape will use use underlying view's cursor or the default cursor. - -### views : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)[] -> **READ-ONLY** Empty for all controls, for layout views this contains the -> layout child views in the order they got added - - - ---- -## Functions -### add_notifier([*self*](../../API/builtins/self.md), notifier : [`IntegerValueNotifierFunction`](#IntegerValueNotifierFunction)) -> Add index change notifier -### remove_notifier([*self*](../../API/builtins/self.md), notifier : [`IntegerValueNotifierFunction`](#IntegerValueNotifierFunction)) -> Remove index change notifier -### add_view([*self*](../../API/builtins/self.md), child : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)) -> Add a new child view to this view. -### remove_view([*self*](../../API/builtins/self.md), child : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)) -> Remove a child view from this view. -### swap_views([*self*](../../API/builtins/self.md), child1 : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md), child2 : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)) -> Swap position of two child views in this view. With a series of swaps views -> can be moved to any position in the parent. -### add_child([*self*](../../API/builtins/self.md), child : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)) -> **Deprecated.** Use `add_view` instead -### remove_child([*self*](../../API/builtins/self.md), child : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)) -> **Deprecated.** Use `remove_view` instead -### swap_childs([*self*](../../API/builtins/self.md), child1 : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md), child2 : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)) -> **Deprecated.** Use `swap_views` instead - - - ---- -## Aliases -### ControlActive -[`boolean`](../../API/builtins/boolean.md) -> Instead of making a control invisible, you can also make it inactive. -> Deactivated controls will still be shown, and will still show their -> currently assigned values, but will not allow changes. Most controls will -> display as "grayed out" to visualize the deactivated state. - -### ControlMidiMappingString -[`string`](../../API/builtins/string.md) -> When set, the control will be highlighted when Renoise's MIDI mapping dialog -> is open. When clicked, it selects the specified string as a MIDI mapping -> target action. This target acton can either be one of the globally available -> mappings in Renoise, or those that were created by the tool itself. -> Target strings are not verified. When they point to nothing, the mapped MIDI -> message will do nothing and no error is fired. - -### IntegerValueNotifierFunction -(value : [`integer`](../../API/builtins/integer.md)) - - -### ItemLabels -[`string`](../../API/builtins/string.md)[] -> A list of buttons labels to show in order. Must have more than one item. - -### SelectedItem -[`integer`](../../API/builtins/integer.md) -> The currently selected item's index - -### ViewCursorShape -`"busy"` | `"change_value"` | `"crosshair"` | `"default"` | `"drag"` | `"drop"` | `"edit_text"` | `"empty"` | `"erase"` | `"extend_bottom"` | `"extend_bottom_alias"` | `"extend_left"` | `"extend_left_alias"` | `"extend_right"` | `"extend_right_alias"` | `"extend_top"` | `"extend_top_alias"` | `"marker"` | `"move"` | `"nodrop"` | `"none"` | `"pencil"` | `"play"` | `"resize_edge_diagonal_left"` | `"resize_edge_diagonal_right"` | `"resize_edge_horizontal"` | `"resize_edge_vertical"` | `"resize_horizontal"` | `"resize_vertical"` | `"zoom"` | `"zoom_horizontal"` | `"zoom_vertical"` -> ```lua -> -- The cursor cursor for this view which apears on mouse hover. -> -- Using a "none" shape will use use underlying view's cursor or the default cursor. -> ViewCursorShape: -> | "none" -> | "empty" -> | "default" -> | "change_value" -> | "edit_text" -> | "pencil" -> | "marker" -> | "crosshair" -> | "move" -> | "erase" -> | "play" -> | "drag" -> | "drop" -> | "nodrop" -> | "busy" -> | "resize_vertical" -> | "resize_horizontal" -> | "resize_edge_vertical" -> | "resize_edge_horizontal" -> | "resize_edge_diagonal_left" -> | "resize_edge_diagonal_right" -> | "extend_left" -> | "extend_right" -> | "extend_top" -> | "extend_bottom" -> | "extend_left_alias" -> | "extend_right_alias" -> | "extend_top_alias" -> | "extend_bottom_alias" -> | "zoom_vertical" -> | "zoom_horizontal" -> | "zoom" -> ``` - -### ViewDimension -[`string`](../../API/builtins/string.md) | [`integer`](../../API/builtins/integer.md) -> The dimensions of a view has to be larger than 0. -> For nested views you can also specify relative size -> for example `vb:text { width = "80%"}`. The percentage values are -> relative to the view's parent size and will automatically update on size changes. - -### ViewOrigin -{ 1 : [`ViewPosition`](#ViewPosition), 2 : [`ViewPosition`](#ViewPosition) } | { x : [`ViewPosition`](#ViewPosition), y : [`ViewPosition`](#ViewPosition) } -> The position of a view within its parent view. -> Only the `stack` layouts allows to freely position child views. Other -> layout views will automatically set the origin, but the origin -> then still can be read in for example mouse handlers. - -### ViewPosition -[`integer`](../../API/builtins/integer.md) -> Horizontal (x) or Vertical (y) position of a view within its parent view. - -### ViewSize -{ 1 : [`ViewDimension`](#ViewDimension), 2 : [`ViewDimension`](#ViewDimension) } | { height : [`ViewDimension`](#ViewDimension), width : [`ViewDimension`](#ViewDimension) } -> The dimensions of a view has to be larger than 0. -> For nested views you can also specify relative size, for example -> `vb:text { size = { width = "80%", height = 20}}`. -> The percentage values are relative to the view's parent size and will -> automatically update when the parent view's size changes. - -### ViewTooltip -[`string`](../../API/builtins/string.md) -> A ViewTooltip text that should be shown for this view on mouse hover. -> * Default: "" (no tip will be shown) - -### ViewVisibility -[`boolean`](../../API/builtins/boolean.md) -> Set visible to false to hide a view (make it invisible without removing -> it). Please note that view.visible will also return false when any of its -> parents are invisible (when its implicitly invisible). -> * Default: true - - diff --git a/docs/API/renoise/renoise.Views.Control.md b/docs/API/renoise/renoise.Views.Control.md deleted file mode 100644 index 1360338..0000000 --- a/docs/API/renoise/renoise.Views.Control.md +++ /dev/null @@ -1,177 +0,0 @@ -# renoise.Views.Control -> Control is the base class for all views which let the user change a value or -> some "state" from the UI. - - - - ---- -## Properties -### active : [`ControlActive`](#ControlActive) -> Instead of making a control invisible, you can also make it inactive. -> Deactivated controls will still be shown, and will still show their -> currently assigned values, but will not allow changes. Most controls will -> display as "grayed out" to visualize the deactivated state. - -### midi_mapping : [`ControlMidiMappingString`](#ControlMidiMappingString) -> When set, the control will be highlighted when Renoise's MIDI mapping dialog -> is open. When clicked, it selects the specified string as a MIDI mapping -> target action. This target acton can either be one of the globally available -> mappings in Renoise, or those that were created by the tool itself. -> Target strings are not verified. When they point to nothing, the mapped MIDI -> message will do nothing and no error is fired. - -### visible : [`ViewVisibility`](#ViewVisibility) -> Set visible to false to hide a view (make it invisible without removing -> it). Please note that view.visible will also return false when any of its -> parents are invisible (when its implicitly invisible). -> * Default: true - -### origin : [`ViewOrigin`](#ViewOrigin) -> The position of a view within its parent view. -> Only the `stack` layouts allows to freely position child views. Other -> layout views will automatically set the origin, but the origin -> then still can be read in for example mouse handlers. - -### width : [`ViewDimension`](#ViewDimension) -> **Deprecated.** Use property `size` instead. - -### height : [`ViewDimension`](#ViewDimension) -> **Deprecated.** Use property `size` instead. - -### size : [`ViewSize`](#ViewSize) -> The dimensions of a view has to be larger than 0. -> For nested views you can also specify relative size, for example -> `vb:text { size = { width = "80%", height = 20}}`. -> The percentage values are relative to the view's parent size and will -> automatically update when the parent view's size changes. - -### tooltip : [`ViewTooltip`](#ViewTooltip) -> A ViewTooltip text that should be shown for this view on mouse hover. -> * Default: "" (no tip will be shown) - -### cursor : [`ViewCursorShape`](#ViewCursorShape) -> The cursor cursor for this view which apears on mouse hover. -> Using a "none" shape will use use underlying view's cursor or the default cursor. - -### views : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)[] -> **READ-ONLY** Empty for all controls, for layout views this contains the -> layout child views in the order they got added - - - ---- -## Functions -### add_view([*self*](../../API/builtins/self.md), child : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)) -> Add a new child view to this view. -### remove_view([*self*](../../API/builtins/self.md), child : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)) -> Remove a child view from this view. -### swap_views([*self*](../../API/builtins/self.md), child1 : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md), child2 : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)) -> Swap position of two child views in this view. With a series of swaps views -> can be moved to any position in the parent. -### add_child([*self*](../../API/builtins/self.md), child : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)) -> **Deprecated.** Use `add_view` instead -### remove_child([*self*](../../API/builtins/self.md), child : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)) -> **Deprecated.** Use `remove_view` instead -### swap_childs([*self*](../../API/builtins/self.md), child1 : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md), child2 : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)) -> **Deprecated.** Use `swap_views` instead - - - ---- -## Aliases -### ControlActive -[`boolean`](../../API/builtins/boolean.md) -> Instead of making a control invisible, you can also make it inactive. -> Deactivated controls will still be shown, and will still show their -> currently assigned values, but will not allow changes. Most controls will -> display as "grayed out" to visualize the deactivated state. - -### ControlMidiMappingString -[`string`](../../API/builtins/string.md) -> When set, the control will be highlighted when Renoise's MIDI mapping dialog -> is open. When clicked, it selects the specified string as a MIDI mapping -> target action. This target acton can either be one of the globally available -> mappings in Renoise, or those that were created by the tool itself. -> Target strings are not verified. When they point to nothing, the mapped MIDI -> message will do nothing and no error is fired. - -### ViewCursorShape -`"busy"` | `"change_value"` | `"crosshair"` | `"default"` | `"drag"` | `"drop"` | `"edit_text"` | `"empty"` | `"erase"` | `"extend_bottom"` | `"extend_bottom_alias"` | `"extend_left"` | `"extend_left_alias"` | `"extend_right"` | `"extend_right_alias"` | `"extend_top"` | `"extend_top_alias"` | `"marker"` | `"move"` | `"nodrop"` | `"none"` | `"pencil"` | `"play"` | `"resize_edge_diagonal_left"` | `"resize_edge_diagonal_right"` | `"resize_edge_horizontal"` | `"resize_edge_vertical"` | `"resize_horizontal"` | `"resize_vertical"` | `"zoom"` | `"zoom_horizontal"` | `"zoom_vertical"` -> ```lua -> -- The cursor cursor for this view which apears on mouse hover. -> -- Using a "none" shape will use use underlying view's cursor or the default cursor. -> ViewCursorShape: -> | "none" -> | "empty" -> | "default" -> | "change_value" -> | "edit_text" -> | "pencil" -> | "marker" -> | "crosshair" -> | "move" -> | "erase" -> | "play" -> | "drag" -> | "drop" -> | "nodrop" -> | "busy" -> | "resize_vertical" -> | "resize_horizontal" -> | "resize_edge_vertical" -> | "resize_edge_horizontal" -> | "resize_edge_diagonal_left" -> | "resize_edge_diagonal_right" -> | "extend_left" -> | "extend_right" -> | "extend_top" -> | "extend_bottom" -> | "extend_left_alias" -> | "extend_right_alias" -> | "extend_top_alias" -> | "extend_bottom_alias" -> | "zoom_vertical" -> | "zoom_horizontal" -> | "zoom" -> ``` - -### ViewDimension -[`string`](../../API/builtins/string.md) | [`integer`](../../API/builtins/integer.md) -> The dimensions of a view has to be larger than 0. -> For nested views you can also specify relative size -> for example `vb:text { width = "80%"}`. The percentage values are -> relative to the view's parent size and will automatically update on size changes. - -### ViewOrigin -{ 1 : [`ViewPosition`](#ViewPosition), 2 : [`ViewPosition`](#ViewPosition) } | { x : [`ViewPosition`](#ViewPosition), y : [`ViewPosition`](#ViewPosition) } -> The position of a view within its parent view. -> Only the `stack` layouts allows to freely position child views. Other -> layout views will automatically set the origin, but the origin -> then still can be read in for example mouse handlers. - -### ViewPosition -[`integer`](../../API/builtins/integer.md) -> Horizontal (x) or Vertical (y) position of a view within its parent view. - -### ViewSize -{ 1 : [`ViewDimension`](#ViewDimension), 2 : [`ViewDimension`](#ViewDimension) } | { height : [`ViewDimension`](#ViewDimension), width : [`ViewDimension`](#ViewDimension) } -> The dimensions of a view has to be larger than 0. -> For nested views you can also specify relative size, for example -> `vb:text { size = { width = "80%", height = 20}}`. -> The percentage values are relative to the view's parent size and will -> automatically update when the parent view's size changes. - -### ViewTooltip -[`string`](../../API/builtins/string.md) -> A ViewTooltip text that should be shown for this view on mouse hover. -> * Default: "" (no tip will be shown) - -### ViewVisibility -[`boolean`](../../API/builtins/boolean.md) -> Set visible to false to hide a view (make it invisible without removing -> it). Please note that view.visible will also return false when any of its -> parents are invisible (when its implicitly invisible). -> * Default: true - - diff --git a/docs/API/renoise/renoise.Views.MiniSlider.md b/docs/API/renoise/renoise.Views.MiniSlider.md deleted file mode 100644 index df00e79..0000000 --- a/docs/API/renoise/renoise.Views.MiniSlider.md +++ /dev/null @@ -1,241 +0,0 @@ -# renoise.Views.MiniSlider -> Same as a slider, but without arrow buttons and a really tiny height. Just -> like the slider, a mini slider can be horizontal or vertical. It will flip -> its orientation according to the set width and height. By default horizontal. -> ```text -> --------[] -> ``` - - - - ---- -## Properties -### active : [`ControlActive`](#ControlActive) -> Instead of making a control invisible, you can also make it inactive. -> Deactivated controls will still be shown, and will still show their -> currently assigned values, but will not allow changes. Most controls will -> display as "grayed out" to visualize the deactivated state. - -### midi_mapping : [`ControlMidiMappingString`](#ControlMidiMappingString) -> When set, the control will be highlighted when Renoise's MIDI mapping dialog -> is open. When clicked, it selects the specified string as a MIDI mapping -> target action. This target acton can either be one of the globally available -> mappings in Renoise, or those that were created by the tool itself. -> Target strings are not verified. When they point to nothing, the mapped MIDI -> message will do nothing and no error is fired. - -### polarity : [`SliderPolarity`](#SliderPolarity) -> Value polarity of the control. Bipolar controls show the value from the -> center to left and right or up and down and typically controls a range -> around zero, e.g. -1 to 1. Unipolar controls show the value from left to -> right or bottom to top. -> * Default: "unipolar" - -### min : [`SliderMinValue`](#SliderMinValue) -> The minimum value that can be set using the view -> * Default: 0 - -### max : [`SliderMaxValue`](#SliderMaxValue) -> The maximum value that can be set using the view -> * Default: 1.0 - -### default : [`SliderDefaultValue`](#SliderDefaultValue) -> The default value that will be re-applied on double-click - -### value : [`SliderNumberValue`](#SliderNumberValue) -> The current value of the view - -### visible : [`ViewVisibility`](#ViewVisibility) -> Set visible to false to hide a view (make it invisible without removing -> it). Please note that view.visible will also return false when any of its -> parents are invisible (when its implicitly invisible). -> * Default: true - -### origin : [`ViewOrigin`](#ViewOrigin) -> The position of a view within its parent view. -> Only the `stack` layouts allows to freely position child views. Other -> layout views will automatically set the origin, but the origin -> then still can be read in for example mouse handlers. - -### width : [`ViewDimension`](#ViewDimension) -> **Deprecated.** Use property `size` instead. - -### height : [`ViewDimension`](#ViewDimension) -> **Deprecated.** Use property `size` instead. - -### size : [`ViewSize`](#ViewSize) -> The dimensions of a view has to be larger than 0. -> For nested views you can also specify relative size, for example -> `vb:text { size = { width = "80%", height = 20}}`. -> The percentage values are relative to the view's parent size and will -> automatically update when the parent view's size changes. - -### tooltip : [`ViewTooltip`](#ViewTooltip) -> A ViewTooltip text that should be shown for this view on mouse hover. -> * Default: "" (no tip will be shown) - -### cursor : [`ViewCursorShape`](#ViewCursorShape) -> The cursor cursor for this view which apears on mouse hover. -> Using a "none" shape will use use underlying view's cursor or the default cursor. - -### views : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)[] -> **READ-ONLY** Empty for all controls, for layout views this contains the -> layout child views in the order they got added - - - ---- -## Functions -### add_notifier([*self*](../../API/builtins/self.md), notifier : [`NumberValueNotifierFunction`](#NumberValueNotifierFunction)) -> Add value change notifier -### remove_notifier([*self*](../../API/builtins/self.md), notifier : [`NumberValueNotifierFunction`](#NumberValueNotifierFunction)) -> Remove value change notifier -### add_view([*self*](../../API/builtins/self.md), child : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)) -> Add a new child view to this view. -### remove_view([*self*](../../API/builtins/self.md), child : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)) -> Remove a child view from this view. -### swap_views([*self*](../../API/builtins/self.md), child1 : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md), child2 : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)) -> Swap position of two child views in this view. With a series of swaps views -> can be moved to any position in the parent. -### add_child([*self*](../../API/builtins/self.md), child : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)) -> **Deprecated.** Use `add_view` instead -### remove_child([*self*](../../API/builtins/self.md), child : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)) -> **Deprecated.** Use `remove_view` instead -### swap_childs([*self*](../../API/builtins/self.md), child1 : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md), child2 : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)) -> **Deprecated.** Use `swap_views` instead - - - ---- -## Aliases -### ControlActive -[`boolean`](../../API/builtins/boolean.md) -> Instead of making a control invisible, you can also make it inactive. -> Deactivated controls will still be shown, and will still show their -> currently assigned values, but will not allow changes. Most controls will -> display as "grayed out" to visualize the deactivated state. - -### ControlMidiMappingString -[`string`](../../API/builtins/string.md) -> When set, the control will be highlighted when Renoise's MIDI mapping dialog -> is open. When clicked, it selects the specified string as a MIDI mapping -> target action. This target acton can either be one of the globally available -> mappings in Renoise, or those that were created by the tool itself. -> Target strings are not verified. When they point to nothing, the mapped MIDI -> message will do nothing and no error is fired. - -### NumberValueNotifierFunction -(value : [`number`](../../API/builtins/number.md)) - - -### SliderDefaultValue -[`number`](../../API/builtins/number.md) -> The default value that will be re-applied on double-click - -### SliderMaxValue -[`number`](../../API/builtins/number.md) -> The maximum value that can be set using the view -> * Default: 1.0 - -### SliderMinValue -[`number`](../../API/builtins/number.md) -> The minimum value that can be set using the view -> * Default: 0 - -### SliderNumberValue -[`number`](../../API/builtins/number.md) -> The current value of the view - -### SliderPolarity -`"bipolar"` | `"unipolar"` -> ```lua -> -- Value polarity of the control. Bipolar controls show the value from the -> -- center to left and right or up and down and typically controls a range -> -- around zero, e.g. -1 to 1. Unipolar controls show the value from left to -> -- right or bottom to top. -> -- * Default: "unipolar" -> SliderPolarity: -> | "unipolar" -> | "bipolar" -> ``` - -### ViewCursorShape -`"busy"` | `"change_value"` | `"crosshair"` | `"default"` | `"drag"` | `"drop"` | `"edit_text"` | `"empty"` | `"erase"` | `"extend_bottom"` | `"extend_bottom_alias"` | `"extend_left"` | `"extend_left_alias"` | `"extend_right"` | `"extend_right_alias"` | `"extend_top"` | `"extend_top_alias"` | `"marker"` | `"move"` | `"nodrop"` | `"none"` | `"pencil"` | `"play"` | `"resize_edge_diagonal_left"` | `"resize_edge_diagonal_right"` | `"resize_edge_horizontal"` | `"resize_edge_vertical"` | `"resize_horizontal"` | `"resize_vertical"` | `"zoom"` | `"zoom_horizontal"` | `"zoom_vertical"` -> ```lua -> -- The cursor cursor for this view which apears on mouse hover. -> -- Using a "none" shape will use use underlying view's cursor or the default cursor. -> ViewCursorShape: -> | "none" -> | "empty" -> | "default" -> | "change_value" -> | "edit_text" -> | "pencil" -> | "marker" -> | "crosshair" -> | "move" -> | "erase" -> | "play" -> | "drag" -> | "drop" -> | "nodrop" -> | "busy" -> | "resize_vertical" -> | "resize_horizontal" -> | "resize_edge_vertical" -> | "resize_edge_horizontal" -> | "resize_edge_diagonal_left" -> | "resize_edge_diagonal_right" -> | "extend_left" -> | "extend_right" -> | "extend_top" -> | "extend_bottom" -> | "extend_left_alias" -> | "extend_right_alias" -> | "extend_top_alias" -> | "extend_bottom_alias" -> | "zoom_vertical" -> | "zoom_horizontal" -> | "zoom" -> ``` - -### ViewDimension -[`string`](../../API/builtins/string.md) | [`integer`](../../API/builtins/integer.md) -> The dimensions of a view has to be larger than 0. -> For nested views you can also specify relative size -> for example `vb:text { width = "80%"}`. The percentage values are -> relative to the view's parent size and will automatically update on size changes. - -### ViewOrigin -{ 1 : [`ViewPosition`](#ViewPosition), 2 : [`ViewPosition`](#ViewPosition) } | { x : [`ViewPosition`](#ViewPosition), y : [`ViewPosition`](#ViewPosition) } -> The position of a view within its parent view. -> Only the `stack` layouts allows to freely position child views. Other -> layout views will automatically set the origin, but the origin -> then still can be read in for example mouse handlers. - -### ViewPosition -[`integer`](../../API/builtins/integer.md) -> Horizontal (x) or Vertical (y) position of a view within its parent view. - -### ViewSize -{ 1 : [`ViewDimension`](#ViewDimension), 2 : [`ViewDimension`](#ViewDimension) } | { height : [`ViewDimension`](#ViewDimension), width : [`ViewDimension`](#ViewDimension) } -> The dimensions of a view has to be larger than 0. -> For nested views you can also specify relative size, for example -> `vb:text { size = { width = "80%", height = 20}}`. -> The percentage values are relative to the view's parent size and will -> automatically update when the parent view's size changes. - -### ViewTooltip -[`string`](../../API/builtins/string.md) -> A ViewTooltip text that should be shown for this view on mouse hover. -> * Default: "" (no tip will be shown) - -### ViewVisibility -[`boolean`](../../API/builtins/boolean.md) -> Set visible to false to hide a view (make it invisible without removing -> it). Please note that view.visible will also return false when any of its -> parents are invisible (when its implicitly invisible). -> * Default: true - - diff --git a/docs/API/renoise/renoise.Views.MultiLineText.md b/docs/API/renoise/renoise.Views.MultiLineText.md deleted file mode 100644 index 3ff911b..0000000 --- a/docs/API/renoise/renoise.Views.MultiLineText.md +++ /dev/null @@ -1,227 +0,0 @@ -# renoise.Views.MultiLineText -> Shows multiple lines of text, auto-formatting and auto-wrapping paragraphs -> into lines. Size is not automatically set. As soon as the text no longer fits -> into the view, a vertical scroll bar will be shown. -> -> by the user. -> ```text -> +--------------+-+ -> | Text, Bla 1 |+| -> | Text, Bla 2 | | -> | Text, Bla 3 | | -> | Text, Bla 4 |+| -> +--------------+-+ -> ``` - - - - ---- -## Properties -### text : [`TextMultilineString`](#TextMultilineString) -> The text that should be displayed. -> Newlines (Windows, Mac or Unix styled) in the text can be used to create -> paragraphs. - -### selected_text : [`TextMultilineSelectedString`](#TextMultilineSelectedString) -> **READ-ONLY** The currently selected text, if any. -> Newlines (Windows, Mac or Unix styled) will use the unix newline format. - -### paragraphs : [`TextParagraphs`](#TextParagraphs) -> A table of text lines to be used instead of specifying a single text -> line with newline characters like "text" -> * Default: [] - -### font : [`TextFontStyle`](#TextFontStyle) -> The style that the text should be displayed with. - -### style : [`TextBackgroundStyle`](#TextBackgroundStyle) -> Default: "body" - -### visible : [`ViewVisibility`](#ViewVisibility) -> Set visible to false to hide a view (make it invisible without removing -> it). Please note that view.visible will also return false when any of its -> parents are invisible (when its implicitly invisible). -> * Default: true - -### origin : [`ViewOrigin`](#ViewOrigin) -> The position of a view within its parent view. -> Only the `stack` layouts allows to freely position child views. Other -> layout views will automatically set the origin, but the origin -> then still can be read in for example mouse handlers. - -### width : [`ViewDimension`](#ViewDimension) -> **Deprecated.** Use property `size` instead. - -### height : [`ViewDimension`](#ViewDimension) -> **Deprecated.** Use property `size` instead. - -### size : [`ViewSize`](#ViewSize) -> The dimensions of a view has to be larger than 0. -> For nested views you can also specify relative size, for example -> `vb:text { size = { width = "80%", height = 20}}`. -> The percentage values are relative to the view's parent size and will -> automatically update when the parent view's size changes. - -### tooltip : [`ViewTooltip`](#ViewTooltip) -> A ViewTooltip text that should be shown for this view on mouse hover. -> * Default: "" (no tip will be shown) - -### cursor : [`ViewCursorShape`](#ViewCursorShape) -> The cursor cursor for this view which apears on mouse hover. -> Using a "none" shape will use use underlying view's cursor or the default cursor. - -### views : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)[] -> **READ-ONLY** Empty for all controls, for layout views this contains the -> layout child views in the order they got added - - - ---- -## Functions -### scroll_to_last_line([*self*](../../API/builtins/self.md)) -> When a scroll bar is visible (needed), scroll the text to show the last line. -### scroll_to_first_line([*self*](../../API/builtins/self.md)) -> When a scroll bar is visible, scroll the text to show the first line. -### add_line([*self*](../../API/builtins/self.md), text : [`string`](../../API/builtins/string.md)) -> Append text to the existing text. Newlines in the text will create new -> paragraphs, just like in the "text" property. -### clear([*self*](../../API/builtins/self.md)) -> Clear the whole text, same as multiline_text.text="". -### add_view([*self*](../../API/builtins/self.md), child : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)) -> Add a new child view to this view. -### remove_view([*self*](../../API/builtins/self.md), child : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)) -> Remove a child view from this view. -### swap_views([*self*](../../API/builtins/self.md), child1 : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md), child2 : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)) -> Swap position of two child views in this view. With a series of swaps views -> can be moved to any position in the parent. -### add_child([*self*](../../API/builtins/self.md), child : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)) -> **Deprecated.** Use `add_view` instead -### remove_child([*self*](../../API/builtins/self.md), child : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)) -> **Deprecated.** Use `remove_view` instead -### swap_childs([*self*](../../API/builtins/self.md), child1 : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md), child2 : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)) -> **Deprecated.** Use `swap_views` instead - - - ---- -## Aliases -### TextBackgroundStyle -`"body"` | `"border"` | `"strong"` -> ```lua -> -- Setup the text view's background: -> TextBackgroundStyle: -> | "body" -- simple text color with no background -> | "strong" -- stronger text color with no background -> | "border" -- text on a bordered background -> ``` - -### TextFontStyle -`"big"` | `"bold"` | `"code"` | `"italic"` | `"mono"` | `"normal"` -> ```lua -> -- The style that the text should be displayed with. -> TextFontStyle: -> | "normal" -- (Default) -> | "big" -- big text -> | "bold" -- bold font -> | "italic" -- italic font -> | "mono" -- monospace font -> | "code" -- monospace code font -> ``` - -### TextMultilineSelectedString -[`string`](../../API/builtins/string.md) -> **READ-ONLY** The currently selected text, if any. -> Newlines (Windows, Mac or Unix styled) will use the unix newline format. - -### TextMultilineString -[`string`](../../API/builtins/string.md) -> The text that should be displayed. -> Newlines (Windows, Mac or Unix styled) in the text can be used to create -> paragraphs. - -### TextParagraphs -[`string`](../../API/builtins/string.md)[] -> A table of text lines to be used instead of specifying a single text -> line with newline characters like "text" -> * Default: [] - -### ViewCursorShape -`"busy"` | `"change_value"` | `"crosshair"` | `"default"` | `"drag"` | `"drop"` | `"edit_text"` | `"empty"` | `"erase"` | `"extend_bottom"` | `"extend_bottom_alias"` | `"extend_left"` | `"extend_left_alias"` | `"extend_right"` | `"extend_right_alias"` | `"extend_top"` | `"extend_top_alias"` | `"marker"` | `"move"` | `"nodrop"` | `"none"` | `"pencil"` | `"play"` | `"resize_edge_diagonal_left"` | `"resize_edge_diagonal_right"` | `"resize_edge_horizontal"` | `"resize_edge_vertical"` | `"resize_horizontal"` | `"resize_vertical"` | `"zoom"` | `"zoom_horizontal"` | `"zoom_vertical"` -> ```lua -> -- The cursor cursor for this view which apears on mouse hover. -> -- Using a "none" shape will use use underlying view's cursor or the default cursor. -> ViewCursorShape: -> | "none" -> | "empty" -> | "default" -> | "change_value" -> | "edit_text" -> | "pencil" -> | "marker" -> | "crosshair" -> | "move" -> | "erase" -> | "play" -> | "drag" -> | "drop" -> | "nodrop" -> | "busy" -> | "resize_vertical" -> | "resize_horizontal" -> | "resize_edge_vertical" -> | "resize_edge_horizontal" -> | "resize_edge_diagonal_left" -> | "resize_edge_diagonal_right" -> | "extend_left" -> | "extend_right" -> | "extend_top" -> | "extend_bottom" -> | "extend_left_alias" -> | "extend_right_alias" -> | "extend_top_alias" -> | "extend_bottom_alias" -> | "zoom_vertical" -> | "zoom_horizontal" -> | "zoom" -> ``` - -### ViewDimension -[`string`](../../API/builtins/string.md) | [`integer`](../../API/builtins/integer.md) -> The dimensions of a view has to be larger than 0. -> For nested views you can also specify relative size -> for example `vb:text { width = "80%"}`. The percentage values are -> relative to the view's parent size and will automatically update on size changes. - -### ViewOrigin -{ 1 : [`ViewPosition`](#ViewPosition), 2 : [`ViewPosition`](#ViewPosition) } | { x : [`ViewPosition`](#ViewPosition), y : [`ViewPosition`](#ViewPosition) } -> The position of a view within its parent view. -> Only the `stack` layouts allows to freely position child views. Other -> layout views will automatically set the origin, but the origin -> then still can be read in for example mouse handlers. - -### ViewPosition -[`integer`](../../API/builtins/integer.md) -> Horizontal (x) or Vertical (y) position of a view within its parent view. - -### ViewSize -{ 1 : [`ViewDimension`](#ViewDimension), 2 : [`ViewDimension`](#ViewDimension) } | { height : [`ViewDimension`](#ViewDimension), width : [`ViewDimension`](#ViewDimension) } -> The dimensions of a view has to be larger than 0. -> For nested views you can also specify relative size, for example -> `vb:text { size = { width = "80%", height = 20}}`. -> The percentage values are relative to the view's parent size and will -> automatically update when the parent view's size changes. - -### ViewTooltip -[`string`](../../API/builtins/string.md) -> A ViewTooltip text that should be shown for this view on mouse hover. -> * Default: "" (no tip will be shown) - -### ViewVisibility -[`boolean`](../../API/builtins/boolean.md) -> Set visible to false to hide a view (make it invisible without removing -> it). Please note that view.visible will also return false when any of its -> parents are invisible (when its implicitly invisible). -> * Default: true - - diff --git a/docs/API/renoise/renoise.Views.MultiLineTextField.md b/docs/API/renoise/renoise.Views.MultiLineTextField.md deleted file mode 100644 index d28d754..0000000 --- a/docs/API/renoise/renoise.Views.MultiLineTextField.md +++ /dev/null @@ -1,261 +0,0 @@ -# renoise.Views.MultiLineTextField -> Shows multiple text lines of text, auto-wrapping paragraphs into lines. The -> text can be edited by the user. -> ```text -> +--------------------------+-+ -> | Editable Te|xt. |+| -> | | | -> | With multiple paragraphs | | -> | and auto-wrapping |+| -> +--------------------------+-+ -> ``` - - - - ---- -## Properties -### active : [`TextActive`](#TextActive) -> When false, text is displayed but can not be entered/modified by the user. -> * Default: true - -### value : [`TextMultilineString`](#TextMultilineString) -> The text that should be displayed. -> Newlines (Windows, Mac or Unix styled) in the text can be used to create -> paragraphs. - -### text : [`TextValueAlias`](#TextValueAlias) -> Exactly the same as "value"; provided for consistency. -> * Default: "" - -### selected_text : [`TextMultilineSelectedString`](#TextMultilineSelectedString) -> **READ-ONLY** The currently selected text, if any. -> Newlines (Windows, Mac or Unix styled) will use the unix newline format. - -### paragraphs : [`TextParagraphs`](#TextParagraphs) -> A table of text lines to be used instead of specifying a single text -> line with newline characters like "text" -> * Default: [] - -### font : [`TextFontStyle`](#TextFontStyle) -> The style that the text should be displayed with. - -### style : [`TextBackgroundStyle`](#TextBackgroundStyle) -> Default: "border" - -### edit_mode : [`TextEditMode`](#TextEditMode) -> True when the text field is focused. setting it at run-time programmatically -> will focus the text field or remove the focus (focus the dialog) accordingly. -> * Default: false - -### visible : [`ViewVisibility`](#ViewVisibility) -> Set visible to false to hide a view (make it invisible without removing -> it). Please note that view.visible will also return false when any of its -> parents are invisible (when its implicitly invisible). -> * Default: true - -### origin : [`ViewOrigin`](#ViewOrigin) -> The position of a view within its parent view. -> Only the `stack` layouts allows to freely position child views. Other -> layout views will automatically set the origin, but the origin -> then still can be read in for example mouse handlers. - -### width : [`ViewDimension`](#ViewDimension) -> **Deprecated.** Use property `size` instead. - -### height : [`ViewDimension`](#ViewDimension) -> **Deprecated.** Use property `size` instead. - -### size : [`ViewSize`](#ViewSize) -> The dimensions of a view has to be larger than 0. -> For nested views you can also specify relative size, for example -> `vb:text { size = { width = "80%", height = 20}}`. -> The percentage values are relative to the view's parent size and will -> automatically update when the parent view's size changes. - -### tooltip : [`ViewTooltip`](#ViewTooltip) -> A ViewTooltip text that should be shown for this view on mouse hover. -> * Default: "" (no tip will be shown) - -### cursor : [`ViewCursorShape`](#ViewCursorShape) -> The cursor cursor for this view which apears on mouse hover. -> Using a "none" shape will use use underlying view's cursor or the default cursor. - -### views : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)[] -> **READ-ONLY** Empty for all controls, for layout views this contains the -> layout child views in the order they got added - - - ---- -## Functions -### add_notifier([*self*](../../API/builtins/self.md), notifier : [`StringValueNotifierFunction`](#StringValueNotifierFunction)) -> Add value change (text change) notifier -### remove_notifier([*self*](../../API/builtins/self.md), notifier : [`StringValueNotifierFunction`](#StringValueNotifierFunction)) -> Remove value change (text change) notifier -### scroll_to_last_line([*self*](../../API/builtins/self.md)) -> When a scroll bar is visible, scroll the text to show the last line. -### scroll_to_first_line([*self*](../../API/builtins/self.md)) -> When a scroll bar is visible, scroll the text to show the first line. -### add_line([*self*](../../API/builtins/self.md), text : [`string`](../../API/builtins/string.md)) -> Append a new text to the existing text. Newline characters in the string will -> create new paragraphs, otherwise a single paragraph is appended. -### clear([*self*](../../API/builtins/self.md)) -> Clear the whole text. -### add_view([*self*](../../API/builtins/self.md), child : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)) -> Add a new child view to this view. -### remove_view([*self*](../../API/builtins/self.md), child : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)) -> Remove a child view from this view. -### swap_views([*self*](../../API/builtins/self.md), child1 : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md), child2 : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)) -> Swap position of two child views in this view. With a series of swaps views -> can be moved to any position in the parent. -### add_child([*self*](../../API/builtins/self.md), child : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)) -> **Deprecated.** Use `add_view` instead -### remove_child([*self*](../../API/builtins/self.md), child : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)) -> **Deprecated.** Use `remove_view` instead -### swap_childs([*self*](../../API/builtins/self.md), child1 : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md), child2 : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)) -> **Deprecated.** Use `swap_views` instead - - - ---- -## Aliases -### StringValueNotifierFunction -(value : [`string`](../../API/builtins/string.md)) - - -### TextActive -[`boolean`](../../API/builtins/boolean.md) -> When false, text is displayed but can not be entered/modified by the user. -> * Default: true - -### TextBackgroundStyle -`"body"` | `"border"` | `"strong"` -> ```lua -> -- Setup the text view's background: -> TextBackgroundStyle: -> | "body" -- simple text color with no background -> | "strong" -- stronger text color with no background -> | "border" -- text on a bordered background -> ``` - -### TextEditMode -[`boolean`](../../API/builtins/boolean.md) -> True when the text field is focused. setting it at run-time programmatically -> will focus the text field or remove the focus (focus the dialog) accordingly. -> * Default: false - -### TextFontStyle -`"big"` | `"bold"` | `"code"` | `"italic"` | `"mono"` | `"normal"` -> ```lua -> -- The style that the text should be displayed with. -> TextFontStyle: -> | "normal" -- (Default) -> | "big" -- big text -> | "bold" -- bold font -> | "italic" -- italic font -> | "mono" -- monospace font -> | "code" -- monospace code font -> ``` - -### TextMultilineSelectedString -[`string`](../../API/builtins/string.md) -> **READ-ONLY** The currently selected text, if any. -> Newlines (Windows, Mac or Unix styled) will use the unix newline format. - -### TextMultilineString -[`string`](../../API/builtins/string.md) -> The text that should be displayed. -> Newlines (Windows, Mac or Unix styled) in the text can be used to create -> paragraphs. - -### TextParagraphs -[`string`](../../API/builtins/string.md)[] -> A table of text lines to be used instead of specifying a single text -> line with newline characters like "text" -> * Default: [] - -### TextValueAlias -[`string`](../../API/builtins/string.md) -> Exactly the same as "value"; provided for consistency. -> * Default: "" - -### ViewCursorShape -`"busy"` | `"change_value"` | `"crosshair"` | `"default"` | `"drag"` | `"drop"` | `"edit_text"` | `"empty"` | `"erase"` | `"extend_bottom"` | `"extend_bottom_alias"` | `"extend_left"` | `"extend_left_alias"` | `"extend_right"` | `"extend_right_alias"` | `"extend_top"` | `"extend_top_alias"` | `"marker"` | `"move"` | `"nodrop"` | `"none"` | `"pencil"` | `"play"` | `"resize_edge_diagonal_left"` | `"resize_edge_diagonal_right"` | `"resize_edge_horizontal"` | `"resize_edge_vertical"` | `"resize_horizontal"` | `"resize_vertical"` | `"zoom"` | `"zoom_horizontal"` | `"zoom_vertical"` -> ```lua -> -- The cursor cursor for this view which apears on mouse hover. -> -- Using a "none" shape will use use underlying view's cursor or the default cursor. -> ViewCursorShape: -> | "none" -> | "empty" -> | "default" -> | "change_value" -> | "edit_text" -> | "pencil" -> | "marker" -> | "crosshair" -> | "move" -> | "erase" -> | "play" -> | "drag" -> | "drop" -> | "nodrop" -> | "busy" -> | "resize_vertical" -> | "resize_horizontal" -> | "resize_edge_vertical" -> | "resize_edge_horizontal" -> | "resize_edge_diagonal_left" -> | "resize_edge_diagonal_right" -> | "extend_left" -> | "extend_right" -> | "extend_top" -> | "extend_bottom" -> | "extend_left_alias" -> | "extend_right_alias" -> | "extend_top_alias" -> | "extend_bottom_alias" -> | "zoom_vertical" -> | "zoom_horizontal" -> | "zoom" -> ``` - -### ViewDimension -[`string`](../../API/builtins/string.md) | [`integer`](../../API/builtins/integer.md) -> The dimensions of a view has to be larger than 0. -> For nested views you can also specify relative size -> for example `vb:text { width = "80%"}`. The percentage values are -> relative to the view's parent size and will automatically update on size changes. - -### ViewOrigin -{ 1 : [`ViewPosition`](#ViewPosition), 2 : [`ViewPosition`](#ViewPosition) } | { x : [`ViewPosition`](#ViewPosition), y : [`ViewPosition`](#ViewPosition) } -> The position of a view within its parent view. -> Only the `stack` layouts allows to freely position child views. Other -> layout views will automatically set the origin, but the origin -> then still can be read in for example mouse handlers. - -### ViewPosition -[`integer`](../../API/builtins/integer.md) -> Horizontal (x) or Vertical (y) position of a view within its parent view. - -### ViewSize -{ 1 : [`ViewDimension`](#ViewDimension), 2 : [`ViewDimension`](#ViewDimension) } | { height : [`ViewDimension`](#ViewDimension), width : [`ViewDimension`](#ViewDimension) } -> The dimensions of a view has to be larger than 0. -> For nested views you can also specify relative size, for example -> `vb:text { size = { width = "80%", height = 20}}`. -> The percentage values are relative to the view's parent size and will -> automatically update when the parent view's size changes. - -### ViewTooltip -[`string`](../../API/builtins/string.md) -> A ViewTooltip text that should be shown for this view on mouse hover. -> * Default: "" (no tip will be shown) - -### ViewVisibility -[`boolean`](../../API/builtins/boolean.md) -> Set visible to false to hide a view (make it invisible without removing -> it). Please note that view.visible will also return false when any of its -> parents are invisible (when its implicitly invisible). -> * Default: true - - diff --git a/docs/API/renoise/renoise.Views.Popup.md b/docs/API/renoise/renoise.Views.Popup.md deleted file mode 100644 index cdfbab2..0000000 --- a/docs/API/renoise/renoise.Views.Popup.md +++ /dev/null @@ -1,206 +0,0 @@ -# renoise.Views.Popup -> A drop-down menu which shows the currently selected value when closed. -> When clicked, it pops up a list of all available items. -> ```text -> +--------------++---+ -> | Current Item || ^ | -> +--------------++---+ -> ``` - - - - ---- -## Properties -### active : [`ControlActive`](#ControlActive) -> Instead of making a control invisible, you can also make it inactive. -> Deactivated controls will still be shown, and will still show their -> currently assigned values, but will not allow changes. Most controls will -> display as "grayed out" to visualize the deactivated state. - -### midi_mapping : [`ControlMidiMappingString`](#ControlMidiMappingString) -> When set, the control will be highlighted when Renoise's MIDI mapping dialog -> is open. When clicked, it selects the specified string as a MIDI mapping -> target action. This target acton can either be one of the globally available -> mappings in Renoise, or those that were created by the tool itself. -> Target strings are not verified. When they point to nothing, the mapped MIDI -> message will do nothing and no error is fired. - -### items : [`PopupItemLabels`](#PopupItemLabels) -> A list of buttons labels to show in order -> The list can be empty, then "None" is displayed and the value won't change. - -### value : [`SelectedItem`](#SelectedItem) -> The currently selected item's index - -### visible : [`ViewVisibility`](#ViewVisibility) -> Set visible to false to hide a view (make it invisible without removing -> it). Please note that view.visible will also return false when any of its -> parents are invisible (when its implicitly invisible). -> * Default: true - -### origin : [`ViewOrigin`](#ViewOrigin) -> The position of a view within its parent view. -> Only the `stack` layouts allows to freely position child views. Other -> layout views will automatically set the origin, but the origin -> then still can be read in for example mouse handlers. - -### width : [`ViewDimension`](#ViewDimension) -> **Deprecated.** Use property `size` instead. - -### height : [`ViewDimension`](#ViewDimension) -> **Deprecated.** Use property `size` instead. - -### size : [`ViewSize`](#ViewSize) -> The dimensions of a view has to be larger than 0. -> For nested views you can also specify relative size, for example -> `vb:text { size = { width = "80%", height = 20}}`. -> The percentage values are relative to the view's parent size and will -> automatically update when the parent view's size changes. - -### tooltip : [`ViewTooltip`](#ViewTooltip) -> A ViewTooltip text that should be shown for this view on mouse hover. -> * Default: "" (no tip will be shown) - -### cursor : [`ViewCursorShape`](#ViewCursorShape) -> The cursor cursor for this view which apears on mouse hover. -> Using a "none" shape will use use underlying view's cursor or the default cursor. - -### views : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)[] -> **READ-ONLY** Empty for all controls, for layout views this contains the -> layout child views in the order they got added - - - ---- -## Functions -### add_notifier([*self*](../../API/builtins/self.md), notifier : [`IntegerValueNotifierFunction`](#IntegerValueNotifierFunction)) -> Add index change notifier -### remove_notifier([*self*](../../API/builtins/self.md), notifier : [`IntegerValueNotifierFunction`](#IntegerValueNotifierFunction)) -> Remove index change notifier -### add_view([*self*](../../API/builtins/self.md), child : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)) -> Add a new child view to this view. -### remove_view([*self*](../../API/builtins/self.md), child : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)) -> Remove a child view from this view. -### swap_views([*self*](../../API/builtins/self.md), child1 : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md), child2 : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)) -> Swap position of two child views in this view. With a series of swaps views -> can be moved to any position in the parent. -### add_child([*self*](../../API/builtins/self.md), child : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)) -> **Deprecated.** Use `add_view` instead -### remove_child([*self*](../../API/builtins/self.md), child : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)) -> **Deprecated.** Use `remove_view` instead -### swap_childs([*self*](../../API/builtins/self.md), child1 : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md), child2 : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)) -> **Deprecated.** Use `swap_views` instead - - - ---- -## Aliases -### ControlActive -[`boolean`](../../API/builtins/boolean.md) -> Instead of making a control invisible, you can also make it inactive. -> Deactivated controls will still be shown, and will still show their -> currently assigned values, but will not allow changes. Most controls will -> display as "grayed out" to visualize the deactivated state. - -### ControlMidiMappingString -[`string`](../../API/builtins/string.md) -> When set, the control will be highlighted when Renoise's MIDI mapping dialog -> is open. When clicked, it selects the specified string as a MIDI mapping -> target action. This target acton can either be one of the globally available -> mappings in Renoise, or those that were created by the tool itself. -> Target strings are not verified. When they point to nothing, the mapped MIDI -> message will do nothing and no error is fired. - -### IntegerValueNotifierFunction -(value : [`integer`](../../API/builtins/integer.md)) - - -### PopupItemLabels -[`string`](../../API/builtins/string.md)[] -> A list of buttons labels to show in order -> The list can be empty, then "None" is displayed and the value won't change. - -### SelectedItem -[`integer`](../../API/builtins/integer.md) -> The currently selected item's index - -### ViewCursorShape -`"busy"` | `"change_value"` | `"crosshair"` | `"default"` | `"drag"` | `"drop"` | `"edit_text"` | `"empty"` | `"erase"` | `"extend_bottom"` | `"extend_bottom_alias"` | `"extend_left"` | `"extend_left_alias"` | `"extend_right"` | `"extend_right_alias"` | `"extend_top"` | `"extend_top_alias"` | `"marker"` | `"move"` | `"nodrop"` | `"none"` | `"pencil"` | `"play"` | `"resize_edge_diagonal_left"` | `"resize_edge_diagonal_right"` | `"resize_edge_horizontal"` | `"resize_edge_vertical"` | `"resize_horizontal"` | `"resize_vertical"` | `"zoom"` | `"zoom_horizontal"` | `"zoom_vertical"` -> ```lua -> -- The cursor cursor for this view which apears on mouse hover. -> -- Using a "none" shape will use use underlying view's cursor or the default cursor. -> ViewCursorShape: -> | "none" -> | "empty" -> | "default" -> | "change_value" -> | "edit_text" -> | "pencil" -> | "marker" -> | "crosshair" -> | "move" -> | "erase" -> | "play" -> | "drag" -> | "drop" -> | "nodrop" -> | "busy" -> | "resize_vertical" -> | "resize_horizontal" -> | "resize_edge_vertical" -> | "resize_edge_horizontal" -> | "resize_edge_diagonal_left" -> | "resize_edge_diagonal_right" -> | "extend_left" -> | "extend_right" -> | "extend_top" -> | "extend_bottom" -> | "extend_left_alias" -> | "extend_right_alias" -> | "extend_top_alias" -> | "extend_bottom_alias" -> | "zoom_vertical" -> | "zoom_horizontal" -> | "zoom" -> ``` - -### ViewDimension -[`string`](../../API/builtins/string.md) | [`integer`](../../API/builtins/integer.md) -> The dimensions of a view has to be larger than 0. -> For nested views you can also specify relative size -> for example `vb:text { width = "80%"}`. The percentage values are -> relative to the view's parent size and will automatically update on size changes. - -### ViewOrigin -{ 1 : [`ViewPosition`](#ViewPosition), 2 : [`ViewPosition`](#ViewPosition) } | { x : [`ViewPosition`](#ViewPosition), y : [`ViewPosition`](#ViewPosition) } -> The position of a view within its parent view. -> Only the `stack` layouts allows to freely position child views. Other -> layout views will automatically set the origin, but the origin -> then still can be read in for example mouse handlers. - -### ViewPosition -[`integer`](../../API/builtins/integer.md) -> Horizontal (x) or Vertical (y) position of a view within its parent view. - -### ViewSize -{ 1 : [`ViewDimension`](#ViewDimension), 2 : [`ViewDimension`](#ViewDimension) } | { height : [`ViewDimension`](#ViewDimension), width : [`ViewDimension`](#ViewDimension) } -> The dimensions of a view has to be larger than 0. -> For nested views you can also specify relative size, for example -> `vb:text { size = { width = "80%", height = 20}}`. -> The percentage values are relative to the view's parent size and will -> automatically update when the parent view's size changes. - -### ViewTooltip -[`string`](../../API/builtins/string.md) -> A ViewTooltip text that should be shown for this view on mouse hover. -> * Default: "" (no tip will be shown) - -### ViewVisibility -[`boolean`](../../API/builtins/boolean.md) -> Set visible to false to hide a view (make it invisible without removing -> it). Please note that view.visible will also return false when any of its -> parents are invisible (when its implicitly invisible). -> * Default: true - - diff --git a/docs/API/renoise/renoise.Views.Rack.md b/docs/API/renoise/renoise.Views.Rack.md deleted file mode 100644 index d03a99d..0000000 --- a/docs/API/renoise/renoise.Views.Rack.md +++ /dev/null @@ -1,204 +0,0 @@ -# renoise.Views.Rack -> A Rack has no content on its own. It only stacks child views. Either -> vertically (ViewBuilder.column) or horizontally (ViewBuilder.row). It allows -> you to create view layouts. - - - - ---- -## Properties -### margin : [`RackMargin`](#RackMargin) -> Set the "borders" of a rack (left, right, top and bottom inclusively) -> * Default: 0 (no borders) - -### spacing : [`RackSpacing`](#RackSpacing) -> Set the amount stacked child views are separated by (horizontally in -> rows, vertically in columns). -> * Default: 0 (no spacing) - -### background : [`ViewBackgroundStyle`](#ViewBackgroundStyle) -> Setup a background style for the view. - -### uniform : [`RackUniformity`](#RackUniformity) -> When set to true, all child views in the rack are automatically resized to -> the max size of all child views (width in ViewBuilder.column, height in -> ViewBuilder.row). This can be useful to automatically align all sub -> columns/panels to the same size. Resizing is done automatically, as soon -> as a child view size changes or new children are added. -> * Default: false - -### style : [`ViewBackgroundStyle`](#ViewBackgroundStyle) -> **Deprecated** Use `background` instead. - -### visible : [`ViewVisibility`](#ViewVisibility) -> Set visible to false to hide a view (make it invisible without removing -> it). Please note that view.visible will also return false when any of its -> parents are invisible (when its implicitly invisible). -> * Default: true - -### origin : [`ViewOrigin`](#ViewOrigin) -> The position of a view within its parent view. -> Only the `stack` layouts allows to freely position child views. Other -> layout views will automatically set the origin, but the origin -> then still can be read in for example mouse handlers. - -### width : [`ViewDimension`](#ViewDimension) -> **Deprecated.** Use property `size` instead. - -### height : [`ViewDimension`](#ViewDimension) -> **Deprecated.** Use property `size` instead. - -### size : [`ViewSize`](#ViewSize) -> The dimensions of a view has to be larger than 0. -> For nested views you can also specify relative size, for example -> `vb:text { size = { width = "80%", height = 20}}`. -> The percentage values are relative to the view's parent size and will -> automatically update when the parent view's size changes. - -### tooltip : [`ViewTooltip`](#ViewTooltip) -> A ViewTooltip text that should be shown for this view on mouse hover. -> * Default: "" (no tip will be shown) - -### cursor : [`ViewCursorShape`](#ViewCursorShape) -> The cursor cursor for this view which apears on mouse hover. -> Using a "none" shape will use use underlying view's cursor or the default cursor. - -### views : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)[] -> **READ-ONLY** Empty for all controls, for layout views this contains the -> layout child views in the order they got added - - - ---- -## Functions -### add_view([*self*](../../API/builtins/self.md), child : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)) -> Add a new child view to this view. -### remove_view([*self*](../../API/builtins/self.md), child : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)) -> Remove a child view from this view. -### swap_views([*self*](../../API/builtins/self.md), child1 : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md), child2 : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)) -> Swap position of two child views in this view. With a series of swaps views -> can be moved to any position in the parent. -### add_child([*self*](../../API/builtins/self.md), child : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)) -> **Deprecated.** Use `add_view` instead -### remove_child([*self*](../../API/builtins/self.md), child : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)) -> **Deprecated.** Use `remove_view` instead -### swap_childs([*self*](../../API/builtins/self.md), child1 : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md), child2 : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)) -> **Deprecated.** Use `swap_views` instead - - - ---- -## Aliases -### RackMargin -[`integer`](../../API/builtins/integer.md) -> Set the "borders" of a rack (left, right, top and bottom inclusively) -> * Default: 0 (no borders) - -### RackSpacing -[`integer`](../../API/builtins/integer.md) -> Set the amount stacked child views are separated by (horizontally in -> rows, vertically in columns). -> * Default: 0 (no spacing) - -### RackUniformity -[`boolean`](../../API/builtins/boolean.md) -> When set to true, all child views in the rack are automatically resized to -> the max size of all child views (width in ViewBuilder.column, height in -> ViewBuilder.row). This can be useful to automatically align all sub -> columns/panels to the same size. Resizing is done automatically, as soon -> as a child view size changes or new children are added. -> * Default: false - -### ViewBackgroundStyle -`"body"` | `"border"` | `"group"` | `"invisible"` | `"panel"` | `"plain"` -> ```lua -> -- Setup a background style for the view. -> ViewBackgroundStyle: -> | "invisible" -- no background (Default) -> | "plain" -- undecorated, single coloured background -> | "border" -- same as plain, but with a bold nested border -> | "body" -- main "background" style, as used in dialog backgrounds -> | "panel" -- alternative "background" style, beveled -> | "group" -- background for "nested" groups within body -> ``` - -### ViewCursorShape -`"busy"` | `"change_value"` | `"crosshair"` | `"default"` | `"drag"` | `"drop"` | `"edit_text"` | `"empty"` | `"erase"` | `"extend_bottom"` | `"extend_bottom_alias"` | `"extend_left"` | `"extend_left_alias"` | `"extend_right"` | `"extend_right_alias"` | `"extend_top"` | `"extend_top_alias"` | `"marker"` | `"move"` | `"nodrop"` | `"none"` | `"pencil"` | `"play"` | `"resize_edge_diagonal_left"` | `"resize_edge_diagonal_right"` | `"resize_edge_horizontal"` | `"resize_edge_vertical"` | `"resize_horizontal"` | `"resize_vertical"` | `"zoom"` | `"zoom_horizontal"` | `"zoom_vertical"` -> ```lua -> -- The cursor cursor for this view which apears on mouse hover. -> -- Using a "none" shape will use use underlying view's cursor or the default cursor. -> ViewCursorShape: -> | "none" -> | "empty" -> | "default" -> | "change_value" -> | "edit_text" -> | "pencil" -> | "marker" -> | "crosshair" -> | "move" -> | "erase" -> | "play" -> | "drag" -> | "drop" -> | "nodrop" -> | "busy" -> | "resize_vertical" -> | "resize_horizontal" -> | "resize_edge_vertical" -> | "resize_edge_horizontal" -> | "resize_edge_diagonal_left" -> | "resize_edge_diagonal_right" -> | "extend_left" -> | "extend_right" -> | "extend_top" -> | "extend_bottom" -> | "extend_left_alias" -> | "extend_right_alias" -> | "extend_top_alias" -> | "extend_bottom_alias" -> | "zoom_vertical" -> | "zoom_horizontal" -> | "zoom" -> ``` - -### ViewDimension -[`string`](../../API/builtins/string.md) | [`integer`](../../API/builtins/integer.md) -> The dimensions of a view has to be larger than 0. -> For nested views you can also specify relative size -> for example `vb:text { width = "80%"}`. The percentage values are -> relative to the view's parent size and will automatically update on size changes. - -### ViewOrigin -{ 1 : [`ViewPosition`](#ViewPosition), 2 : [`ViewPosition`](#ViewPosition) } | { x : [`ViewPosition`](#ViewPosition), y : [`ViewPosition`](#ViewPosition) } -> The position of a view within its parent view. -> Only the `stack` layouts allows to freely position child views. Other -> layout views will automatically set the origin, but the origin -> then still can be read in for example mouse handlers. - -### ViewPosition -[`integer`](../../API/builtins/integer.md) -> Horizontal (x) or Vertical (y) position of a view within its parent view. - -### ViewSize -{ 1 : [`ViewDimension`](#ViewDimension), 2 : [`ViewDimension`](#ViewDimension) } | { height : [`ViewDimension`](#ViewDimension), width : [`ViewDimension`](#ViewDimension) } -> The dimensions of a view has to be larger than 0. -> For nested views you can also specify relative size, for example -> `vb:text { size = { width = "80%", height = 20}}`. -> The percentage values are relative to the view's parent size and will -> automatically update when the parent view's size changes. - -### ViewTooltip -[`string`](../../API/builtins/string.md) -> A ViewTooltip text that should be shown for this view on mouse hover. -> * Default: "" (no tip will be shown) - -### ViewVisibility -[`boolean`](../../API/builtins/boolean.md) -> Set visible to false to hide a view (make it invisible without removing -> it). Please note that view.visible will also return false when any of its -> parents are invisible (when its implicitly invisible). -> * Default: true - - diff --git a/docs/API/renoise/renoise.Views.RotaryEncoder.md b/docs/API/renoise/renoise.Views.RotaryEncoder.md deleted file mode 100644 index d4588c0..0000000 --- a/docs/API/renoise/renoise.Views.RotaryEncoder.md +++ /dev/null @@ -1,246 +0,0 @@ -# renoise.Views.RotaryEncoder -> A slider which looks like a potentiometer. -> Note: when changing the size, the minimum of either width or height will be -> used to draw and control the rotary, therefore you should always set both -> equally when possible. -> ```text -> +-+ -> / \ \ -> | o | -> \ | / -> +-+ -> ``` - - - - ---- -## Properties -### active : [`ControlActive`](#ControlActive) -> Instead of making a control invisible, you can also make it inactive. -> Deactivated controls will still be shown, and will still show their -> currently assigned values, but will not allow changes. Most controls will -> display as "grayed out" to visualize the deactivated state. - -### midi_mapping : [`ControlMidiMappingString`](#ControlMidiMappingString) -> When set, the control will be highlighted when Renoise's MIDI mapping dialog -> is open. When clicked, it selects the specified string as a MIDI mapping -> target action. This target acton can either be one of the globally available -> mappings in Renoise, or those that were created by the tool itself. -> Target strings are not verified. When they point to nothing, the mapped MIDI -> message will do nothing and no error is fired. - -### polarity : [`SliderPolarity`](#SliderPolarity) -> Value polarity of the control. Bipolar controls show the value from the -> center to left and right or up and down and typically controls a range -> around zero, e.g. -1 to 1. Unipolar controls show the value from left to -> right or bottom to top. -> * Default: "unipolar" - -### min : [`SliderMinValue`](#SliderMinValue) -> The minimum value that can be set using the view -> * Default: 0 - -### max : [`SliderMaxValue`](#SliderMaxValue) -> The maximum value that can be set using the view -> * Default: 1.0 - -### default : [`SliderDefaultValue`](#SliderDefaultValue) -> The default value that will be re-applied on double-click - -### value : [`SliderNumberValue`](#SliderNumberValue) -> The current value of the view - -### visible : [`ViewVisibility`](#ViewVisibility) -> Set visible to false to hide a view (make it invisible without removing -> it). Please note that view.visible will also return false when any of its -> parents are invisible (when its implicitly invisible). -> * Default: true - -### origin : [`ViewOrigin`](#ViewOrigin) -> The position of a view within its parent view. -> Only the `stack` layouts allows to freely position child views. Other -> layout views will automatically set the origin, but the origin -> then still can be read in for example mouse handlers. - -### width : [`ViewDimension`](#ViewDimension) -> **Deprecated.** Use property `size` instead. - -### height : [`ViewDimension`](#ViewDimension) -> **Deprecated.** Use property `size` instead. - -### size : [`ViewSize`](#ViewSize) -> The dimensions of a view has to be larger than 0. -> For nested views you can also specify relative size, for example -> `vb:text { size = { width = "80%", height = 20}}`. -> The percentage values are relative to the view's parent size and will -> automatically update when the parent view's size changes. - -### tooltip : [`ViewTooltip`](#ViewTooltip) -> A ViewTooltip text that should be shown for this view on mouse hover. -> * Default: "" (no tip will be shown) - -### cursor : [`ViewCursorShape`](#ViewCursorShape) -> The cursor cursor for this view which apears on mouse hover. -> Using a "none" shape will use use underlying view's cursor or the default cursor. - -### views : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)[] -> **READ-ONLY** Empty for all controls, for layout views this contains the -> layout child views in the order they got added - - - ---- -## Functions -### add_notifier([*self*](../../API/builtins/self.md), notifier : [`NumberValueNotifierFunction`](#NumberValueNotifierFunction)) -> Add value change notifier -### remove_notifier([*self*](../../API/builtins/self.md), notifier : [`NumberValueNotifierFunction`](#NumberValueNotifierFunction)) -> Remove value change notifier -### add_view([*self*](../../API/builtins/self.md), child : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)) -> Add a new child view to this view. -### remove_view([*self*](../../API/builtins/self.md), child : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)) -> Remove a child view from this view. -### swap_views([*self*](../../API/builtins/self.md), child1 : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md), child2 : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)) -> Swap position of two child views in this view. With a series of swaps views -> can be moved to any position in the parent. -### add_child([*self*](../../API/builtins/self.md), child : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)) -> **Deprecated.** Use `add_view` instead -### remove_child([*self*](../../API/builtins/self.md), child : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)) -> **Deprecated.** Use `remove_view` instead -### swap_childs([*self*](../../API/builtins/self.md), child1 : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md), child2 : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)) -> **Deprecated.** Use `swap_views` instead - - - ---- -## Aliases -### ControlActive -[`boolean`](../../API/builtins/boolean.md) -> Instead of making a control invisible, you can also make it inactive. -> Deactivated controls will still be shown, and will still show their -> currently assigned values, but will not allow changes. Most controls will -> display as "grayed out" to visualize the deactivated state. - -### ControlMidiMappingString -[`string`](../../API/builtins/string.md) -> When set, the control will be highlighted when Renoise's MIDI mapping dialog -> is open. When clicked, it selects the specified string as a MIDI mapping -> target action. This target acton can either be one of the globally available -> mappings in Renoise, or those that were created by the tool itself. -> Target strings are not verified. When they point to nothing, the mapped MIDI -> message will do nothing and no error is fired. - -### NumberValueNotifierFunction -(value : [`number`](../../API/builtins/number.md)) - - -### SliderDefaultValue -[`number`](../../API/builtins/number.md) -> The default value that will be re-applied on double-click - -### SliderMaxValue -[`number`](../../API/builtins/number.md) -> The maximum value that can be set using the view -> * Default: 1.0 - -### SliderMinValue -[`number`](../../API/builtins/number.md) -> The minimum value that can be set using the view -> * Default: 0 - -### SliderNumberValue -[`number`](../../API/builtins/number.md) -> The current value of the view - -### SliderPolarity -`"bipolar"` | `"unipolar"` -> ```lua -> -- Value polarity of the control. Bipolar controls show the value from the -> -- center to left and right or up and down and typically controls a range -> -- around zero, e.g. -1 to 1. Unipolar controls show the value from left to -> -- right or bottom to top. -> -- * Default: "unipolar" -> SliderPolarity: -> | "unipolar" -> | "bipolar" -> ``` - -### ViewCursorShape -`"busy"` | `"change_value"` | `"crosshair"` | `"default"` | `"drag"` | `"drop"` | `"edit_text"` | `"empty"` | `"erase"` | `"extend_bottom"` | `"extend_bottom_alias"` | `"extend_left"` | `"extend_left_alias"` | `"extend_right"` | `"extend_right_alias"` | `"extend_top"` | `"extend_top_alias"` | `"marker"` | `"move"` | `"nodrop"` | `"none"` | `"pencil"` | `"play"` | `"resize_edge_diagonal_left"` | `"resize_edge_diagonal_right"` | `"resize_edge_horizontal"` | `"resize_edge_vertical"` | `"resize_horizontal"` | `"resize_vertical"` | `"zoom"` | `"zoom_horizontal"` | `"zoom_vertical"` -> ```lua -> -- The cursor cursor for this view which apears on mouse hover. -> -- Using a "none" shape will use use underlying view's cursor or the default cursor. -> ViewCursorShape: -> | "none" -> | "empty" -> | "default" -> | "change_value" -> | "edit_text" -> | "pencil" -> | "marker" -> | "crosshair" -> | "move" -> | "erase" -> | "play" -> | "drag" -> | "drop" -> | "nodrop" -> | "busy" -> | "resize_vertical" -> | "resize_horizontal" -> | "resize_edge_vertical" -> | "resize_edge_horizontal" -> | "resize_edge_diagonal_left" -> | "resize_edge_diagonal_right" -> | "extend_left" -> | "extend_right" -> | "extend_top" -> | "extend_bottom" -> | "extend_left_alias" -> | "extend_right_alias" -> | "extend_top_alias" -> | "extend_bottom_alias" -> | "zoom_vertical" -> | "zoom_horizontal" -> | "zoom" -> ``` - -### ViewDimension -[`string`](../../API/builtins/string.md) | [`integer`](../../API/builtins/integer.md) -> The dimensions of a view has to be larger than 0. -> For nested views you can also specify relative size -> for example `vb:text { width = "80%"}`. The percentage values are -> relative to the view's parent size and will automatically update on size changes. - -### ViewOrigin -{ 1 : [`ViewPosition`](#ViewPosition), 2 : [`ViewPosition`](#ViewPosition) } | { x : [`ViewPosition`](#ViewPosition), y : [`ViewPosition`](#ViewPosition) } -> The position of a view within its parent view. -> Only the `stack` layouts allows to freely position child views. Other -> layout views will automatically set the origin, but the origin -> then still can be read in for example mouse handlers. - -### ViewPosition -[`integer`](../../API/builtins/integer.md) -> Horizontal (x) or Vertical (y) position of a view within its parent view. - -### ViewSize -{ 1 : [`ViewDimension`](#ViewDimension), 2 : [`ViewDimension`](#ViewDimension) } | { height : [`ViewDimension`](#ViewDimension), width : [`ViewDimension`](#ViewDimension) } -> The dimensions of a view has to be larger than 0. -> For nested views you can also specify relative size, for example -> `vb:text { size = { width = "80%", height = 20}}`. -> The percentage values are relative to the view's parent size and will -> automatically update when the parent view's size changes. - -### ViewTooltip -[`string`](../../API/builtins/string.md) -> A ViewTooltip text that should be shown for this view on mouse hover. -> * Default: "" (no tip will be shown) - -### ViewVisibility -[`boolean`](../../API/builtins/boolean.md) -> Set visible to false to hide a view (make it invisible without removing -> it). Please note that view.visible will also return false when any of its -> parents are invisible (when its implicitly invisible). -> * Default: true - - diff --git a/docs/API/renoise/renoise.Views.ScrollBar.md b/docs/API/renoise/renoise.Views.ScrollBar.md deleted file mode 100644 index fca2dfe..0000000 --- a/docs/API/renoise/renoise.Views.ScrollBar.md +++ /dev/null @@ -1,261 +0,0 @@ -# renoise.Views.ScrollBar -> A special slider alike control to scroll through some content. -> -> `min` and `max` define to the scrollable area's range. `pagesize` is the -> currently visible area within that range and `value` is the offset from -> `min` to `max - pagestep` within the whole scrollable area: -> -> ```text -> min value max -> | [xxxxxxxxxxxxxx] | -> <---pagestep---> -> <---------scroll-area------------> -> ``` -> -> Note that the *minimum offset value* is `min` and the *maximum offset -> value* is `max - pagestep`. -> -> A scrollbar can be horizontal or vertical. It will flip its orientation -> according to the set width and height. By default it's horizontal. - - - - ---- -## Properties -### active : [`ControlActive`](#ControlActive) -> Instead of making a control invisible, you can also make it inactive. -> Deactivated controls will still be shown, and will still show their -> currently assigned values, but will not allow changes. Most controls will -> display as "grayed out" to visualize the deactivated state. - -### midi_mapping : [`ControlMidiMappingString`](#ControlMidiMappingString) -> When set, the control will be highlighted when Renoise's MIDI mapping dialog -> is open. When clicked, it selects the specified string as a MIDI mapping -> target action. This target acton can either be one of the globally available -> mappings in Renoise, or those that were created by the tool itself. -> Target strings are not verified. When they point to nothing, the mapped MIDI -> message will do nothing and no error is fired. - -### min : [`ScrollbarMin`](#ScrollbarMin) -> Default 0. Minimum offset value. - -### max : [`ScrollbarMax`](#ScrollbarMax) -> Default 100. Maximum offset value. - -### value : [`ScrollbarValue`](#ScrollbarValue) -> Default 0. Offset value in range `min to max - pagestep`. - -### step : [`ScrollbarStep`](#ScrollbarStep) -> Default 1. Amount the mouse-wheel or additional +/- buttons in the scroll bar -> move the scrollable area. - -### pagestep : [`ScrollbarPagestep`](#ScrollbarPagestep) -> Default 100. Size of the currently visible area. - -### background : [`ViewBackgroundStyle`](#ViewBackgroundStyle) -> Setup a background style for the view. - -### autohide : [`ScrollbarAutoHide`](#ScrollbarAutoHide) -> Default: false. When true, view gets automatically hidden when no scrolling is needed - -### visible : [`ViewVisibility`](#ViewVisibility) -> Set visible to false to hide a view (make it invisible without removing -> it). Please note that view.visible will also return false when any of its -> parents are invisible (when its implicitly invisible). -> * Default: true - -### origin : [`ViewOrigin`](#ViewOrigin) -> The position of a view within its parent view. -> Only the `stack` layouts allows to freely position child views. Other -> layout views will automatically set the origin, but the origin -> then still can be read in for example mouse handlers. - -### width : [`ViewDimension`](#ViewDimension) -> **Deprecated.** Use property `size` instead. - -### height : [`ViewDimension`](#ViewDimension) -> **Deprecated.** Use property `size` instead. - -### size : [`ViewSize`](#ViewSize) -> The dimensions of a view has to be larger than 0. -> For nested views you can also specify relative size, for example -> `vb:text { size = { width = "80%", height = 20}}`. -> The percentage values are relative to the view's parent size and will -> automatically update when the parent view's size changes. - -### tooltip : [`ViewTooltip`](#ViewTooltip) -> A ViewTooltip text that should be shown for this view on mouse hover. -> * Default: "" (no tip will be shown) - -### cursor : [`ViewCursorShape`](#ViewCursorShape) -> The cursor cursor for this view which apears on mouse hover. -> Using a "none" shape will use use underlying view's cursor or the default cursor. - -### views : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)[] -> **READ-ONLY** Empty for all controls, for layout views this contains the -> layout child views in the order they got added - - - ---- -## Functions -### add_notifier([*self*](../../API/builtins/self.md), notifier : [`IntegerValueNotifierFunction`](#IntegerValueNotifierFunction)) -> Add offset value change notifier -### remove_notifier([*self*](../../API/builtins/self.md), notifier : [`IntegerValueNotifierFunction`](#IntegerValueNotifierFunction)) -> Remove offset value change notifier -### add_view([*self*](../../API/builtins/self.md), child : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)) -> Add a new child view to this view. -### remove_view([*self*](../../API/builtins/self.md), child : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)) -> Remove a child view from this view. -### swap_views([*self*](../../API/builtins/self.md), child1 : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md), child2 : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)) -> Swap position of two child views in this view. With a series of swaps views -> can be moved to any position in the parent. -### add_child([*self*](../../API/builtins/self.md), child : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)) -> **Deprecated.** Use `add_view` instead -### remove_child([*self*](../../API/builtins/self.md), child : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)) -> **Deprecated.** Use `remove_view` instead -### swap_childs([*self*](../../API/builtins/self.md), child1 : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md), child2 : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)) -> **Deprecated.** Use `swap_views` instead - - - ---- -## Aliases -### ControlActive -[`boolean`](../../API/builtins/boolean.md) -> Instead of making a control invisible, you can also make it inactive. -> Deactivated controls will still be shown, and will still show their -> currently assigned values, but will not allow changes. Most controls will -> display as "grayed out" to visualize the deactivated state. - -### ControlMidiMappingString -[`string`](../../API/builtins/string.md) -> When set, the control will be highlighted when Renoise's MIDI mapping dialog -> is open. When clicked, it selects the specified string as a MIDI mapping -> target action. This target acton can either be one of the globally available -> mappings in Renoise, or those that were created by the tool itself. -> Target strings are not verified. When they point to nothing, the mapped MIDI -> message will do nothing and no error is fired. - -### IntegerValueNotifierFunction -(value : [`integer`](../../API/builtins/integer.md)) - - -### ScrollbarAutoHide -[`boolean`](../../API/builtins/boolean.md) -> Default: false. When true, view gets automatically hidden when no scrolling is needed - -### ScrollbarMax -[`integer`](../../API/builtins/integer.md) -> Default 100. Maximum offset value. - -### ScrollbarMin -[`integer`](../../API/builtins/integer.md) -> Default 0. Minimum offset value. - -### ScrollbarPagestep -[`integer`](../../API/builtins/integer.md) -> Default 100. Size of the currently visible area. - -### ScrollbarStep -[`integer`](../../API/builtins/integer.md) -> Default 1. Amount the mouse-wheel or additional +/- buttons in the scroll bar -> move the scrollable area. - -### ScrollbarValue -[`integer`](../../API/builtins/integer.md) -> Default 0. Offset value in range `min to max - pagestep`. - -### ViewBackgroundStyle -`"body"` | `"border"` | `"group"` | `"invisible"` | `"panel"` | `"plain"` -> ```lua -> -- Setup a background style for the view. -> ViewBackgroundStyle: -> | "invisible" -- no background (Default) -> | "plain" -- undecorated, single coloured background -> | "border" -- same as plain, but with a bold nested border -> | "body" -- main "background" style, as used in dialog backgrounds -> | "panel" -- alternative "background" style, beveled -> | "group" -- background for "nested" groups within body -> ``` - -### ViewCursorShape -`"busy"` | `"change_value"` | `"crosshair"` | `"default"` | `"drag"` | `"drop"` | `"edit_text"` | `"empty"` | `"erase"` | `"extend_bottom"` | `"extend_bottom_alias"` | `"extend_left"` | `"extend_left_alias"` | `"extend_right"` | `"extend_right_alias"` | `"extend_top"` | `"extend_top_alias"` | `"marker"` | `"move"` | `"nodrop"` | `"none"` | `"pencil"` | `"play"` | `"resize_edge_diagonal_left"` | `"resize_edge_diagonal_right"` | `"resize_edge_horizontal"` | `"resize_edge_vertical"` | `"resize_horizontal"` | `"resize_vertical"` | `"zoom"` | `"zoom_horizontal"` | `"zoom_vertical"` -> ```lua -> -- The cursor cursor for this view which apears on mouse hover. -> -- Using a "none" shape will use use underlying view's cursor or the default cursor. -> ViewCursorShape: -> | "none" -> | "empty" -> | "default" -> | "change_value" -> | "edit_text" -> | "pencil" -> | "marker" -> | "crosshair" -> | "move" -> | "erase" -> | "play" -> | "drag" -> | "drop" -> | "nodrop" -> | "busy" -> | "resize_vertical" -> | "resize_horizontal" -> | "resize_edge_vertical" -> | "resize_edge_horizontal" -> | "resize_edge_diagonal_left" -> | "resize_edge_diagonal_right" -> | "extend_left" -> | "extend_right" -> | "extend_top" -> | "extend_bottom" -> | "extend_left_alias" -> | "extend_right_alias" -> | "extend_top_alias" -> | "extend_bottom_alias" -> | "zoom_vertical" -> | "zoom_horizontal" -> | "zoom" -> ``` - -### ViewDimension -[`string`](../../API/builtins/string.md) | [`integer`](../../API/builtins/integer.md) -> The dimensions of a view has to be larger than 0. -> For nested views you can also specify relative size -> for example `vb:text { width = "80%"}`. The percentage values are -> relative to the view's parent size and will automatically update on size changes. - -### ViewOrigin -{ 1 : [`ViewPosition`](#ViewPosition), 2 : [`ViewPosition`](#ViewPosition) } | { x : [`ViewPosition`](#ViewPosition), y : [`ViewPosition`](#ViewPosition) } -> The position of a view within its parent view. -> Only the `stack` layouts allows to freely position child views. Other -> layout views will automatically set the origin, but the origin -> then still can be read in for example mouse handlers. - -### ViewPosition -[`integer`](../../API/builtins/integer.md) -> Horizontal (x) or Vertical (y) position of a view within its parent view. - -### ViewSize -{ 1 : [`ViewDimension`](#ViewDimension), 2 : [`ViewDimension`](#ViewDimension) } | { height : [`ViewDimension`](#ViewDimension), width : [`ViewDimension`](#ViewDimension) } -> The dimensions of a view has to be larger than 0. -> For nested views you can also specify relative size, for example -> `vb:text { size = { width = "80%", height = 20}}`. -> The percentage values are relative to the view's parent size and will -> automatically update when the parent view's size changes. - -### ViewTooltip -[`string`](../../API/builtins/string.md) -> A ViewTooltip text that should be shown for this view on mouse hover. -> * Default: "" (no tip will be shown) - -### ViewVisibility -[`boolean`](../../API/builtins/boolean.md) -> Set visible to false to hide a view (make it invisible without removing -> it). Please note that view.visible will also return false when any of its -> parents are invisible (when its implicitly invisible). -> * Default: true - - diff --git a/docs/API/renoise/renoise.Views.Slider.md b/docs/API/renoise/renoise.Views.Slider.md deleted file mode 100644 index ee4cc07..0000000 --- a/docs/API/renoise/renoise.Views.Slider.md +++ /dev/null @@ -1,256 +0,0 @@ -# renoise.Views.Slider -> A slider with arrow buttons, which shows and allows editing of values in a -> custom range. A slider can be horizontal or vertical; will flip its -> orientation according to the set width and height. By default horizontal. -> ```text -> +---+---------------+ -> |<|>| --------[] | -> +---+---------------+ -> ``` - - - - ---- -## Properties -### active : [`ControlActive`](#ControlActive) -> Instead of making a control invisible, you can also make it inactive. -> Deactivated controls will still be shown, and will still show their -> currently assigned values, but will not allow changes. Most controls will -> display as "grayed out" to visualize the deactivated state. - -### midi_mapping : [`ControlMidiMappingString`](#ControlMidiMappingString) -> When set, the control will be highlighted when Renoise's MIDI mapping dialog -> is open. When clicked, it selects the specified string as a MIDI mapping -> target action. This target acton can either be one of the globally available -> mappings in Renoise, or those that were created by the tool itself. -> Target strings are not verified. When they point to nothing, the mapped MIDI -> message will do nothing and no error is fired. - -### polarity : [`SliderPolarity`](#SliderPolarity) -> Value polarity of the control. Bipolar controls show the value from the -> center to left and right or up and down and typically controls a range -> around zero, e.g. -1 to 1. Unipolar controls show the value from left to -> right or bottom to top. -> * Default: "unipolar" - -### min : [`SliderMinValue`](#SliderMinValue) -> The minimum value that can be set using the view -> * Default: 0 - -### max : [`SliderMaxValue`](#SliderMaxValue) -> The maximum value that can be set using the view -> * Default: 1.0 - -### steps : [`SliderStepAmounts`](#SliderStepAmounts) -> A table containing two numbers representing the step amounts for incrementing -> and decrementing by clicking the <> buttons. -> The first value is the small step (applied on left clicks) -> second value is the big step (applied on right clicks) - -### default : [`SliderDefaultValue`](#SliderDefaultValue) -> The default value that will be re-applied on double-click - -### value : [`SliderNumberValue`](#SliderNumberValue) -> The current value of the view - -### visible : [`ViewVisibility`](#ViewVisibility) -> Set visible to false to hide a view (make it invisible without removing -> it). Please note that view.visible will also return false when any of its -> parents are invisible (when its implicitly invisible). -> * Default: true - -### origin : [`ViewOrigin`](#ViewOrigin) -> The position of a view within its parent view. -> Only the `stack` layouts allows to freely position child views. Other -> layout views will automatically set the origin, but the origin -> then still can be read in for example mouse handlers. - -### width : [`ViewDimension`](#ViewDimension) -> **Deprecated.** Use property `size` instead. - -### height : [`ViewDimension`](#ViewDimension) -> **Deprecated.** Use property `size` instead. - -### size : [`ViewSize`](#ViewSize) -> The dimensions of a view has to be larger than 0. -> For nested views you can also specify relative size, for example -> `vb:text { size = { width = "80%", height = 20}}`. -> The percentage values are relative to the view's parent size and will -> automatically update when the parent view's size changes. - -### tooltip : [`ViewTooltip`](#ViewTooltip) -> A ViewTooltip text that should be shown for this view on mouse hover. -> * Default: "" (no tip will be shown) - -### cursor : [`ViewCursorShape`](#ViewCursorShape) -> The cursor cursor for this view which apears on mouse hover. -> Using a "none" shape will use use underlying view's cursor or the default cursor. - -### views : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)[] -> **READ-ONLY** Empty for all controls, for layout views this contains the -> layout child views in the order they got added - - - ---- -## Functions -### add_notifier([*self*](../../API/builtins/self.md), notifier : [`NumberValueNotifierFunction`](#NumberValueNotifierFunction)) -> Add value change notifier -### remove_notifier([*self*](../../API/builtins/self.md), notifier : [`NumberValueNotifierFunction`](#NumberValueNotifierFunction)) -> Remove value change notifier -### add_view([*self*](../../API/builtins/self.md), child : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)) -> Add a new child view to this view. -### remove_view([*self*](../../API/builtins/self.md), child : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)) -> Remove a child view from this view. -### swap_views([*self*](../../API/builtins/self.md), child1 : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md), child2 : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)) -> Swap position of two child views in this view. With a series of swaps views -> can be moved to any position in the parent. -### add_child([*self*](../../API/builtins/self.md), child : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)) -> **Deprecated.** Use `add_view` instead -### remove_child([*self*](../../API/builtins/self.md), child : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)) -> **Deprecated.** Use `remove_view` instead -### swap_childs([*self*](../../API/builtins/self.md), child1 : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md), child2 : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)) -> **Deprecated.** Use `swap_views` instead - - - ---- -## Aliases -### ControlActive -[`boolean`](../../API/builtins/boolean.md) -> Instead of making a control invisible, you can also make it inactive. -> Deactivated controls will still be shown, and will still show their -> currently assigned values, but will not allow changes. Most controls will -> display as "grayed out" to visualize the deactivated state. - -### ControlMidiMappingString -[`string`](../../API/builtins/string.md) -> When set, the control will be highlighted when Renoise's MIDI mapping dialog -> is open. When clicked, it selects the specified string as a MIDI mapping -> target action. This target acton can either be one of the globally available -> mappings in Renoise, or those that were created by the tool itself. -> Target strings are not verified. When they point to nothing, the mapped MIDI -> message will do nothing and no error is fired. - -### NumberValueNotifierFunction -(value : [`number`](../../API/builtins/number.md)) - - -### SliderDefaultValue -[`number`](../../API/builtins/number.md) -> The default value that will be re-applied on double-click - -### SliderMaxValue -[`number`](../../API/builtins/number.md) -> The maximum value that can be set using the view -> * Default: 1.0 - -### SliderMinValue -[`number`](../../API/builtins/number.md) -> The minimum value that can be set using the view -> * Default: 0 - -### SliderNumberValue -[`number`](../../API/builtins/number.md) -> The current value of the view - -### SliderPolarity -`"bipolar"` | `"unipolar"` -> ```lua -> -- Value polarity of the control. Bipolar controls show the value from the -> -- center to left and right or up and down and typically controls a range -> -- around zero, e.g. -1 to 1. Unipolar controls show the value from left to -> -- right or bottom to top. -> -- * Default: "unipolar" -> SliderPolarity: -> | "unipolar" -> | "bipolar" -> ``` - -### SliderStepAmounts -{ 1 : [`number`](../../API/builtins/number.md), 2 : [`number`](../../API/builtins/number.md) } -> A table containing two numbers representing the step amounts for incrementing -> and decrementing by clicking the <> buttons. -> The first value is the small step (applied on left clicks) -> second value is the big step (applied on right clicks) - -### ViewCursorShape -`"busy"` | `"change_value"` | `"crosshair"` | `"default"` | `"drag"` | `"drop"` | `"edit_text"` | `"empty"` | `"erase"` | `"extend_bottom"` | `"extend_bottom_alias"` | `"extend_left"` | `"extend_left_alias"` | `"extend_right"` | `"extend_right_alias"` | `"extend_top"` | `"extend_top_alias"` | `"marker"` | `"move"` | `"nodrop"` | `"none"` | `"pencil"` | `"play"` | `"resize_edge_diagonal_left"` | `"resize_edge_diagonal_right"` | `"resize_edge_horizontal"` | `"resize_edge_vertical"` | `"resize_horizontal"` | `"resize_vertical"` | `"zoom"` | `"zoom_horizontal"` | `"zoom_vertical"` -> ```lua -> -- The cursor cursor for this view which apears on mouse hover. -> -- Using a "none" shape will use use underlying view's cursor or the default cursor. -> ViewCursorShape: -> | "none" -> | "empty" -> | "default" -> | "change_value" -> | "edit_text" -> | "pencil" -> | "marker" -> | "crosshair" -> | "move" -> | "erase" -> | "play" -> | "drag" -> | "drop" -> | "nodrop" -> | "busy" -> | "resize_vertical" -> | "resize_horizontal" -> | "resize_edge_vertical" -> | "resize_edge_horizontal" -> | "resize_edge_diagonal_left" -> | "resize_edge_diagonal_right" -> | "extend_left" -> | "extend_right" -> | "extend_top" -> | "extend_bottom" -> | "extend_left_alias" -> | "extend_right_alias" -> | "extend_top_alias" -> | "extend_bottom_alias" -> | "zoom_vertical" -> | "zoom_horizontal" -> | "zoom" -> ``` - -### ViewDimension -[`string`](../../API/builtins/string.md) | [`integer`](../../API/builtins/integer.md) -> The dimensions of a view has to be larger than 0. -> For nested views you can also specify relative size -> for example `vb:text { width = "80%"}`. The percentage values are -> relative to the view's parent size and will automatically update on size changes. - -### ViewOrigin -{ 1 : [`ViewPosition`](#ViewPosition), 2 : [`ViewPosition`](#ViewPosition) } | { x : [`ViewPosition`](#ViewPosition), y : [`ViewPosition`](#ViewPosition) } -> The position of a view within its parent view. -> Only the `stack` layouts allows to freely position child views. Other -> layout views will automatically set the origin, but the origin -> then still can be read in for example mouse handlers. - -### ViewPosition -[`integer`](../../API/builtins/integer.md) -> Horizontal (x) or Vertical (y) position of a view within its parent view. - -### ViewSize -{ 1 : [`ViewDimension`](#ViewDimension), 2 : [`ViewDimension`](#ViewDimension) } | { height : [`ViewDimension`](#ViewDimension), width : [`ViewDimension`](#ViewDimension) } -> The dimensions of a view has to be larger than 0. -> For nested views you can also specify relative size, for example -> `vb:text { size = { width = "80%", height = 20}}`. -> The percentage values are relative to the view's parent size and will -> automatically update when the parent view's size changes. - -### ViewTooltip -[`string`](../../API/builtins/string.md) -> A ViewTooltip text that should be shown for this view on mouse hover. -> * Default: "" (no tip will be shown) - -### ViewVisibility -[`boolean`](../../API/builtins/boolean.md) -> Set visible to false to hide a view (make it invisible without removing -> it). Please note that view.visible will also return false when any of its -> parents are invisible (when its implicitly invisible). -> * Default: true - - diff --git a/docs/API/renoise/renoise.Views.Stack.md b/docs/API/renoise/renoise.Views.Stack.md deleted file mode 100644 index 2704481..0000000 --- a/docs/API/renoise/renoise.Views.Stack.md +++ /dev/null @@ -1,179 +0,0 @@ -# renoise.Views.Stack -> A Stack has no content on its own. It only *stacks* it's child views. -> The position of the child views in the stack can be freely set by using -> the `origin` property of the views. - - - - ---- -## Properties -### autosize : [`StackAutoSize`](#StackAutoSize) -> When set to true, the width and height of the stack will be automatically -> calculated and updated from the stack's child views, to ensure all views fit -> into the stack. -> When disabled, the width and height must be set manually. -> * Default: true - -### background : [`ViewBackgroundStyle`](#ViewBackgroundStyle) -> Setup a background style for the view. - -### visible : [`ViewVisibility`](#ViewVisibility) -> Set visible to false to hide a view (make it invisible without removing -> it). Please note that view.visible will also return false when any of its -> parents are invisible (when its implicitly invisible). -> * Default: true - -### origin : [`ViewOrigin`](#ViewOrigin) -> The position of a view within its parent view. -> Only the `stack` layouts allows to freely position child views. Other -> layout views will automatically set the origin, but the origin -> then still can be read in for example mouse handlers. - -### width : [`ViewDimension`](#ViewDimension) -> **Deprecated.** Use property `size` instead. - -### height : [`ViewDimension`](#ViewDimension) -> **Deprecated.** Use property `size` instead. - -### size : [`ViewSize`](#ViewSize) -> The dimensions of a view has to be larger than 0. -> For nested views you can also specify relative size, for example -> `vb:text { size = { width = "80%", height = 20}}`. -> The percentage values are relative to the view's parent size and will -> automatically update when the parent view's size changes. - -### tooltip : [`ViewTooltip`](#ViewTooltip) -> A ViewTooltip text that should be shown for this view on mouse hover. -> * Default: "" (no tip will be shown) - -### cursor : [`ViewCursorShape`](#ViewCursorShape) -> The cursor cursor for this view which apears on mouse hover. -> Using a "none" shape will use use underlying view's cursor or the default cursor. - -### views : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)[] -> **READ-ONLY** Empty for all controls, for layout views this contains the -> layout child views in the order they got added - - - ---- -## Functions -### add_view([*self*](../../API/builtins/self.md), child : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)) -> Add a new child view to this view. -### remove_view([*self*](../../API/builtins/self.md), child : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)) -> Remove a child view from this view. -### swap_views([*self*](../../API/builtins/self.md), child1 : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md), child2 : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)) -> Swap position of two child views in this view. With a series of swaps views -> can be moved to any position in the parent. -### add_child([*self*](../../API/builtins/self.md), child : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)) -> **Deprecated.** Use `add_view` instead -### remove_child([*self*](../../API/builtins/self.md), child : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)) -> **Deprecated.** Use `remove_view` instead -### swap_childs([*self*](../../API/builtins/self.md), child1 : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md), child2 : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)) -> **Deprecated.** Use `swap_views` instead - - - ---- -## Aliases -### StackAutoSize -[`boolean`](../../API/builtins/boolean.md) -> When set to true, the width and height of the stack will be automatically -> calculated and updated from the stack's child views, to ensure all views fit -> into the stack. -> When disabled, the width and height must be set manually. -> * Default: true - -### ViewBackgroundStyle -`"body"` | `"border"` | `"group"` | `"invisible"` | `"panel"` | `"plain"` -> ```lua -> -- Setup a background style for the view. -> ViewBackgroundStyle: -> | "invisible" -- no background (Default) -> | "plain" -- undecorated, single coloured background -> | "border" -- same as plain, but with a bold nested border -> | "body" -- main "background" style, as used in dialog backgrounds -> | "panel" -- alternative "background" style, beveled -> | "group" -- background for "nested" groups within body -> ``` - -### ViewCursorShape -`"busy"` | `"change_value"` | `"crosshair"` | `"default"` | `"drag"` | `"drop"` | `"edit_text"` | `"empty"` | `"erase"` | `"extend_bottom"` | `"extend_bottom_alias"` | `"extend_left"` | `"extend_left_alias"` | `"extend_right"` | `"extend_right_alias"` | `"extend_top"` | `"extend_top_alias"` | `"marker"` | `"move"` | `"nodrop"` | `"none"` | `"pencil"` | `"play"` | `"resize_edge_diagonal_left"` | `"resize_edge_diagonal_right"` | `"resize_edge_horizontal"` | `"resize_edge_vertical"` | `"resize_horizontal"` | `"resize_vertical"` | `"zoom"` | `"zoom_horizontal"` | `"zoom_vertical"` -> ```lua -> -- The cursor cursor for this view which apears on mouse hover. -> -- Using a "none" shape will use use underlying view's cursor or the default cursor. -> ViewCursorShape: -> | "none" -> | "empty" -> | "default" -> | "change_value" -> | "edit_text" -> | "pencil" -> | "marker" -> | "crosshair" -> | "move" -> | "erase" -> | "play" -> | "drag" -> | "drop" -> | "nodrop" -> | "busy" -> | "resize_vertical" -> | "resize_horizontal" -> | "resize_edge_vertical" -> | "resize_edge_horizontal" -> | "resize_edge_diagonal_left" -> | "resize_edge_diagonal_right" -> | "extend_left" -> | "extend_right" -> | "extend_top" -> | "extend_bottom" -> | "extend_left_alias" -> | "extend_right_alias" -> | "extend_top_alias" -> | "extend_bottom_alias" -> | "zoom_vertical" -> | "zoom_horizontal" -> | "zoom" -> ``` - -### ViewDimension -[`string`](../../API/builtins/string.md) | [`integer`](../../API/builtins/integer.md) -> The dimensions of a view has to be larger than 0. -> For nested views you can also specify relative size -> for example `vb:text { width = "80%"}`. The percentage values are -> relative to the view's parent size and will automatically update on size changes. - -### ViewOrigin -{ 1 : [`ViewPosition`](#ViewPosition), 2 : [`ViewPosition`](#ViewPosition) } | { x : [`ViewPosition`](#ViewPosition), y : [`ViewPosition`](#ViewPosition) } -> The position of a view within its parent view. -> Only the `stack` layouts allows to freely position child views. Other -> layout views will automatically set the origin, but the origin -> then still can be read in for example mouse handlers. - -### ViewPosition -[`integer`](../../API/builtins/integer.md) -> Horizontal (x) or Vertical (y) position of a view within its parent view. - -### ViewSize -{ 1 : [`ViewDimension`](#ViewDimension), 2 : [`ViewDimension`](#ViewDimension) } | { height : [`ViewDimension`](#ViewDimension), width : [`ViewDimension`](#ViewDimension) } -> The dimensions of a view has to be larger than 0. -> For nested views you can also specify relative size, for example -> `vb:text { size = { width = "80%", height = 20}}`. -> The percentage values are relative to the view's parent size and will -> automatically update when the parent view's size changes. - -### ViewTooltip -[`string`](../../API/builtins/string.md) -> A ViewTooltip text that should be shown for this view on mouse hover. -> * Default: "" (no tip will be shown) - -### ViewVisibility -[`boolean`](../../API/builtins/boolean.md) -> Set visible to false to hide a view (make it invisible without removing -> it). Please note that view.visible will also return false when any of its -> parents are invisible (when its implicitly invisible). -> * Default: true - - diff --git a/docs/API/renoise/renoise.Views.Switch.md b/docs/API/renoise/renoise.Views.Switch.md deleted file mode 100644 index 3afc50b..0000000 --- a/docs/API/renoise/renoise.Views.Switch.md +++ /dev/null @@ -1,204 +0,0 @@ -# renoise.Views.Switch -> A set of horizontally aligned buttons, where only one button can be enabled -> at the same time. Select one of multiple choices, indices. -> ```text -> +-----------+------------+----------+ -> | Button A | +Button+B+ | Button C | -> +-----------+------------+----------+ -> ``` - - - - ---- -## Properties -### active : [`ControlActive`](#ControlActive) -> Instead of making a control invisible, you can also make it inactive. -> Deactivated controls will still be shown, and will still show their -> currently assigned values, but will not allow changes. Most controls will -> display as "grayed out" to visualize the deactivated state. - -### midi_mapping : [`ControlMidiMappingString`](#ControlMidiMappingString) -> When set, the control will be highlighted when Renoise's MIDI mapping dialog -> is open. When clicked, it selects the specified string as a MIDI mapping -> target action. This target acton can either be one of the globally available -> mappings in Renoise, or those that were created by the tool itself. -> Target strings are not verified. When they point to nothing, the mapped MIDI -> message will do nothing and no error is fired. - -### items : [`ItemLabels`](#ItemLabels) -> A list of buttons labels to show in order. Must have more than one item. - -### value : [`SelectedItem`](#SelectedItem) -> The currently selected item's index - -### visible : [`ViewVisibility`](#ViewVisibility) -> Set visible to false to hide a view (make it invisible without removing -> it). Please note that view.visible will also return false when any of its -> parents are invisible (when its implicitly invisible). -> * Default: true - -### origin : [`ViewOrigin`](#ViewOrigin) -> The position of a view within its parent view. -> Only the `stack` layouts allows to freely position child views. Other -> layout views will automatically set the origin, but the origin -> then still can be read in for example mouse handlers. - -### width : [`ViewDimension`](#ViewDimension) -> **Deprecated.** Use property `size` instead. - -### height : [`ViewDimension`](#ViewDimension) -> **Deprecated.** Use property `size` instead. - -### size : [`ViewSize`](#ViewSize) -> The dimensions of a view has to be larger than 0. -> For nested views you can also specify relative size, for example -> `vb:text { size = { width = "80%", height = 20}}`. -> The percentage values are relative to the view's parent size and will -> automatically update when the parent view's size changes. - -### tooltip : [`ViewTooltip`](#ViewTooltip) -> A ViewTooltip text that should be shown for this view on mouse hover. -> * Default: "" (no tip will be shown) - -### cursor : [`ViewCursorShape`](#ViewCursorShape) -> The cursor cursor for this view which apears on mouse hover. -> Using a "none" shape will use use underlying view's cursor or the default cursor. - -### views : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)[] -> **READ-ONLY** Empty for all controls, for layout views this contains the -> layout child views in the order they got added - - - ---- -## Functions -### add_notifier([*self*](../../API/builtins/self.md), notifier : [`IntegerValueNotifierFunction`](#IntegerValueNotifierFunction)) -> Add index change notifier -### remove_notifier([*self*](../../API/builtins/self.md), notifier : [`IntegerValueNotifierFunction`](#IntegerValueNotifierFunction)) -> Remove index change notifier -### add_view([*self*](../../API/builtins/self.md), child : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)) -> Add a new child view to this view. -### remove_view([*self*](../../API/builtins/self.md), child : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)) -> Remove a child view from this view. -### swap_views([*self*](../../API/builtins/self.md), child1 : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md), child2 : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)) -> Swap position of two child views in this view. With a series of swaps views -> can be moved to any position in the parent. -### add_child([*self*](../../API/builtins/self.md), child : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)) -> **Deprecated.** Use `add_view` instead -### remove_child([*self*](../../API/builtins/self.md), child : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)) -> **Deprecated.** Use `remove_view` instead -### swap_childs([*self*](../../API/builtins/self.md), child1 : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md), child2 : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)) -> **Deprecated.** Use `swap_views` instead - - - ---- -## Aliases -### ControlActive -[`boolean`](../../API/builtins/boolean.md) -> Instead of making a control invisible, you can also make it inactive. -> Deactivated controls will still be shown, and will still show their -> currently assigned values, but will not allow changes. Most controls will -> display as "grayed out" to visualize the deactivated state. - -### ControlMidiMappingString -[`string`](../../API/builtins/string.md) -> When set, the control will be highlighted when Renoise's MIDI mapping dialog -> is open. When clicked, it selects the specified string as a MIDI mapping -> target action. This target acton can either be one of the globally available -> mappings in Renoise, or those that were created by the tool itself. -> Target strings are not verified. When they point to nothing, the mapped MIDI -> message will do nothing and no error is fired. - -### IntegerValueNotifierFunction -(value : [`integer`](../../API/builtins/integer.md)) - - -### ItemLabels -[`string`](../../API/builtins/string.md)[] -> A list of buttons labels to show in order. Must have more than one item. - -### SelectedItem -[`integer`](../../API/builtins/integer.md) -> The currently selected item's index - -### ViewCursorShape -`"busy"` | `"change_value"` | `"crosshair"` | `"default"` | `"drag"` | `"drop"` | `"edit_text"` | `"empty"` | `"erase"` | `"extend_bottom"` | `"extend_bottom_alias"` | `"extend_left"` | `"extend_left_alias"` | `"extend_right"` | `"extend_right_alias"` | `"extend_top"` | `"extend_top_alias"` | `"marker"` | `"move"` | `"nodrop"` | `"none"` | `"pencil"` | `"play"` | `"resize_edge_diagonal_left"` | `"resize_edge_diagonal_right"` | `"resize_edge_horizontal"` | `"resize_edge_vertical"` | `"resize_horizontal"` | `"resize_vertical"` | `"zoom"` | `"zoom_horizontal"` | `"zoom_vertical"` -> ```lua -> -- The cursor cursor for this view which apears on mouse hover. -> -- Using a "none" shape will use use underlying view's cursor or the default cursor. -> ViewCursorShape: -> | "none" -> | "empty" -> | "default" -> | "change_value" -> | "edit_text" -> | "pencil" -> | "marker" -> | "crosshair" -> | "move" -> | "erase" -> | "play" -> | "drag" -> | "drop" -> | "nodrop" -> | "busy" -> | "resize_vertical" -> | "resize_horizontal" -> | "resize_edge_vertical" -> | "resize_edge_horizontal" -> | "resize_edge_diagonal_left" -> | "resize_edge_diagonal_right" -> | "extend_left" -> | "extend_right" -> | "extend_top" -> | "extend_bottom" -> | "extend_left_alias" -> | "extend_right_alias" -> | "extend_top_alias" -> | "extend_bottom_alias" -> | "zoom_vertical" -> | "zoom_horizontal" -> | "zoom" -> ``` - -### ViewDimension -[`string`](../../API/builtins/string.md) | [`integer`](../../API/builtins/integer.md) -> The dimensions of a view has to be larger than 0. -> For nested views you can also specify relative size -> for example `vb:text { width = "80%"}`. The percentage values are -> relative to the view's parent size and will automatically update on size changes. - -### ViewOrigin -{ 1 : [`ViewPosition`](#ViewPosition), 2 : [`ViewPosition`](#ViewPosition) } | { x : [`ViewPosition`](#ViewPosition), y : [`ViewPosition`](#ViewPosition) } -> The position of a view within its parent view. -> Only the `stack` layouts allows to freely position child views. Other -> layout views will automatically set the origin, but the origin -> then still can be read in for example mouse handlers. - -### ViewPosition -[`integer`](../../API/builtins/integer.md) -> Horizontal (x) or Vertical (y) position of a view within its parent view. - -### ViewSize -{ 1 : [`ViewDimension`](#ViewDimension), 2 : [`ViewDimension`](#ViewDimension) } | { height : [`ViewDimension`](#ViewDimension), width : [`ViewDimension`](#ViewDimension) } -> The dimensions of a view has to be larger than 0. -> For nested views you can also specify relative size, for example -> `vb:text { size = { width = "80%", height = 20}}`. -> The percentage values are relative to the view's parent size and will -> automatically update when the parent view's size changes. - -### ViewTooltip -[`string`](../../API/builtins/string.md) -> A ViewTooltip text that should be shown for this view on mouse hover. -> * Default: "" (no tip will be shown) - -### ViewVisibility -[`boolean`](../../API/builtins/boolean.md) -> Set visible to false to hide a view (make it invisible without removing -> it). Please note that view.visible will also return false when any of its -> parents are invisible (when its implicitly invisible). -> * Default: true - - diff --git a/docs/API/renoise/renoise.Views.Text.md b/docs/API/renoise/renoise.Views.Text.md deleted file mode 100644 index 9fc372f..0000000 --- a/docs/API/renoise/renoise.Views.Text.md +++ /dev/null @@ -1,427 +0,0 @@ -# renoise.Views.Text -> Shows a "static" text string. Static just means that its not linked, bound -> to some value and has no notifiers. The text can not be edited by the user. -> Nevertheless you can of course change the text at run-time with the "text" -> property. -> ```text -> Text, Bla 1 -> ``` - - - - ---- -## Properties -### text : [`TextSingleLineString`](#TextSingleLineString) -> The text that should be displayed. Setting a new text will resize -> the view in order to make the text fully visible (expanding only). -> * Default: "" - -### font : [`TextFontStyle`](#TextFontStyle) -> The style that the text should be displayed with. - -### style : [`TextStyle`](#TextStyle) -> Get/set the color style the text should be displayed with. - -### color : [`TextColor`](#TextColor) -> When set, the text will be drawn in the specified color. -> Set style to something else than "custom" or color to `{0, 0, 0}` -> to enable the default theme color for the text again. - -### orientation : [`TextOrientation`](#TextOrientation) -> Setup the texts's orientation (writing direction). - -### align : [`TextAlignment`](#TextAlignment) -> Setup the text's alignment. Applies only when the view's size is larger than -> the needed size to draw the text - -### visible : [`ViewVisibility`](#ViewVisibility) -> Set visible to false to hide a view (make it invisible without removing -> it). Please note that view.visible will also return false when any of its -> parents are invisible (when its implicitly invisible). -> * Default: true - -### origin : [`ViewOrigin`](#ViewOrigin) -> The position of a view within its parent view. -> Only the `stack` layouts allows to freely position child views. Other -> layout views will automatically set the origin, but the origin -> then still can be read in for example mouse handlers. - -### width : [`ViewDimension`](#ViewDimension) -> **Deprecated.** Use property `size` instead. - -### height : [`ViewDimension`](#ViewDimension) -> **Deprecated.** Use property `size` instead. - -### size : [`ViewSize`](#ViewSize) -> The dimensions of a view has to be larger than 0. -> For nested views you can also specify relative size, for example -> `vb:text { size = { width = "80%", height = 20}}`. -> The percentage values are relative to the view's parent size and will -> automatically update when the parent view's size changes. - -### tooltip : [`ViewTooltip`](#ViewTooltip) -> A ViewTooltip text that should be shown for this view on mouse hover. -> * Default: "" (no tip will be shown) - -### cursor : [`ViewCursorShape`](#ViewCursorShape) -> The cursor cursor for this view which apears on mouse hover. -> Using a "none" shape will use use underlying view's cursor or the default cursor. - -### views : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)[] -> **READ-ONLY** Empty for all controls, for layout views this contains the -> layout child views in the order they got added - - - ---- -## Functions -### add_view([*self*](../../API/builtins/self.md), child : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)) -> Add a new child view to this view. -### remove_view([*self*](../../API/builtins/self.md), child : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)) -> Remove a child view from this view. -### swap_views([*self*](../../API/builtins/self.md), child1 : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md), child2 : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)) -> Swap position of two child views in this view. With a series of swaps views -> can be moved to any position in the parent. -### add_child([*self*](../../API/builtins/self.md), child : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)) -> **Deprecated.** Use `add_view` instead -### remove_child([*self*](../../API/builtins/self.md), child : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)) -> **Deprecated.** Use `remove_view` instead -### swap_childs([*self*](../../API/builtins/self.md), child1 : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md), child2 : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)) -> **Deprecated.** Use `swap_views` instead - - - ---- -## Aliases -### RGBColor -{ 1 : [`integer`](../../API/builtins/integer.md), 2 : [`integer`](../../API/builtins/integer.md), 3 : [`integer`](../../API/builtins/integer.md) } -> A table of 3 bytes (ranging from 0 to 255) -> representing the red, green and blue channels of a color. -> {0xFF, 0xFF, 0xFF} is white -> {165, 73, 35} is the red from the Renoise logo - -### TextAlignment -`"center"` | `"left"` | `"right"` -> ```lua -> -- Setup the text's alignment. Applies only when the view's size is larger than -> -- the needed size to draw the text -> TextAlignment: -> | "left" -- (Default) -> | "right" -- aligned to the right -> | "center" -- center text -> ``` - -### TextColor -[`RGBColor`](#RGBColor) | [`ThemeColor`](#ThemeColor) -> ```lua -> -- When set, the text will be drawn in the specified color. -> -- Set style to something else than "custom" or color to `{0, 0, 0}` -> -- to enable the default theme color for the text again. -> -- A table of 3 bytes (ranging from 0 to 255) -> -- representing the red, green and blue channels of a color. -> -- {0xFF, 0xFF, 0xFF} is white -> -- {165, 73, 35} is the red from the Renoise logo -> -- The application theme's colors -> TextColor: -> | "main_back" -> | "main_font" -> | "alternate_main_back" -> | "alternate_main_font" -> | "body_back" -> | "body_font" -> | "strong_body_font" -> | "button_back" -> | "button_font" -> | "button_highlight_font" -> | "selected_button_back" -> | "selected_button_font" -> | "selection_back" -> | "selection_font" -> | "standby_selection_back" -> | "standby_selection_font" -> | "midi_mapping_back" -> | "midi_mapping_font" -> | "tooltip_back" -> | "tooltip_font" -> | "valuebox_back" -> | "valuebox_font" -> | "valuebox_font_icons" -> | "scrollbar" -> | "slider" -> | "folder" -> | "pattern_default_back" -> | "pattern_default_font" -> | "pattern_default_font_volume" -> | "pattern_default_font_panning" -> | "pattern_default_font_pitch" -> | "pattern_default_font_delay" -> | "pattern_default_font_global" -> | "pattern_default_font_other" -> | "pattern_default_font_dspfx" -> | "pattern_default_font_unused" -> | "pattern_highlighted_back" -> | "pattern_highlighted_font" -> | "pattern_highlighted_font_volume" -> | "pattern_highlighted_font_panning" -> | "pattern_highlighted_font_pitch" -> | "pattern_highlighted_font_delay" -> | "pattern_highlighted_font_global" -> | "pattern_highlighted_font_other" -> | "pattern_highlighted_font_dspfx" -> | "pattern_highlighted_font_unused" -> | "pattern_playposition_back" -> | "pattern_playposition_font" -> | "pattern_centerbar_back" -> | "pattern_centerbar_font" -> | "pattern_centerbar_back_standby" -> | "pattern_centerbar_font_standby" -> | "pattern_selection" -> | "pattern_standby_selection" -> | "pattern_mute_state" -> | "automation_grid" -> | "automation_line_edge" -> | "automation_line_fill" -> | "automation_point" -> | "automation_marker_play" -> | "automation_marker_single" -> | "automation_marker_pair" -> | "automation_marker_diamond" -> | "vumeter_meter" -> | "vumeter_meter_low" -> | "vumeter_meter_middle" -> | "vumeter_meter_high" -> | "vumeter_peak" -> | "vumeter_back_normal" -> | "vumeter_back_clipped" -> | "default_color_01" -> | "default_color_02" -> | "default_color_03" -> | "default_color_04" -> | "default_color_05" -> | "default_color_06" -> | "default_color_07" -> | "default_color_08" -> | "default_color_09" -> | "default_color_10" -> | "default_color_11" -> | "default_color_12" -> | "default_color_13" -> | "default_color_14" -> | "default_color_15" -> | "default_color_16" -> ``` - -### TextFontStyle -`"big"` | `"bold"` | `"code"` | `"italic"` | `"mono"` | `"normal"` -> ```lua -> -- The style that the text should be displayed with. -> TextFontStyle: -> | "normal" -- (Default) -> | "big" -- big text -> | "bold" -- bold font -> | "italic" -- italic font -> | "mono" -- monospace font -> | "code" -- monospace code font -> ``` - -### TextOrientation -`"horizontal"` | `"horizontal-rl"` | `"vertical"` | `"vertical-tb"` -> ```lua -> -- Setup the texts's orientation (writing direction). -> TextOrientation: -> | "horizontal" -- Draw from left to right (Default) -> | "horizontal-rl" -- Draw from right to left -> | "vertical" -- Draw from bottom to top -> | "vertical-tb" -- Draw from top to bottom -> ``` - -### TextSingleLineString -[`string`](../../API/builtins/string.md) -> The text that should be displayed. Setting a new text will resize -> the view in order to make the text fully visible (expanding only). -> * Default: "" - -### TextStyle -`"custom"` | `"disabled"` | `"normal"` | `"strong"` -> ```lua -> -- Get/set the color style the text should be displayed with. -> TextStyle: -> | "normal" -- (Default) -> | "strong" -- highlighted color -> | "disabled" -- greyed out color -> | "custom" -- custom color -> ``` - -### ThemeColor -`"alternate_main_back"` | `"alternate_main_font"` | `"automation_grid"` | `"automation_line_edge"` | `"automation_line_fill"` | `"automation_marker_diamond"` | `"automation_marker_pair"` | `"automation_marker_play"` | `"automation_marker_single"` | `"automation_point"` | `"body_back"` | `"body_font"` | `"button_back"` | `"button_font"` | `"button_highlight_font"` | `"default_color_01"` | `"default_color_02"` | `"default_color_03"` | `"default_color_04"` | `"default_color_05"` | `"default_color_06"` | `"default_color_07"` | `"default_color_08"` | `"default_color_09"` | `"default_color_10"` | `"default_color_11"` | `"default_color_12"` | `"default_color_13"` | `"default_color_14"` | `"default_color_15"` | `"default_color_16"` | `"folder"` | `"main_back"` | `"main_font"` | `"midi_mapping_back"` | `"midi_mapping_font"` | `"pattern_centerbar_back"` | `"pattern_centerbar_back_standby"` | `"pattern_centerbar_font"` | `"pattern_centerbar_font_standby"` | `"pattern_default_back"` | `"pattern_default_font"` | `"pattern_default_font_delay"` | `"pattern_default_font_dspfx"` | `"pattern_default_font_global"` | `"pattern_default_font_other"` | `"pattern_default_font_panning"` | `"pattern_default_font_pitch"` | `"pattern_default_font_unused"` | `"pattern_default_font_volume"` | `"pattern_highlighted_back"` | `"pattern_highlighted_font"` | `"pattern_highlighted_font_delay"` | `"pattern_highlighted_font_dspfx"` | `"pattern_highlighted_font_global"` | `"pattern_highlighted_font_other"` | `"pattern_highlighted_font_panning"` | `"pattern_highlighted_font_pitch"` | `"pattern_highlighted_font_unused"` | `"pattern_highlighted_font_volume"` | `"pattern_mute_state"` | `"pattern_playposition_back"` | `"pattern_playposition_font"` | `"pattern_selection"` | `"pattern_standby_selection"` | `"scrollbar"` | `"selected_button_back"` | `"selected_button_font"` | `"selection_back"` | `"selection_font"` | `"slider"` | `"standby_selection_back"` | `"standby_selection_font"` | `"strong_body_font"` | `"tooltip_back"` | `"tooltip_font"` | `"valuebox_back"` | `"valuebox_font"` | `"valuebox_font_icons"` | `"vumeter_back_clipped"` | `"vumeter_back_normal"` | `"vumeter_meter"` | `"vumeter_meter_high"` | `"vumeter_meter_low"` | `"vumeter_meter_middle"` | `"vumeter_peak"` -> ```lua -> -- The application theme's colors -> ThemeColor: -> | "main_back" -> | "main_font" -> | "alternate_main_back" -> | "alternate_main_font" -> | "body_back" -> | "body_font" -> | "strong_body_font" -> | "button_back" -> | "button_font" -> | "button_highlight_font" -> | "selected_button_back" -> | "selected_button_font" -> | "selection_back" -> | "selection_font" -> | "standby_selection_back" -> | "standby_selection_font" -> | "midi_mapping_back" -> | "midi_mapping_font" -> | "tooltip_back" -> | "tooltip_font" -> | "valuebox_back" -> | "valuebox_font" -> | "valuebox_font_icons" -> | "scrollbar" -> | "slider" -> | "folder" -> | "pattern_default_back" -> | "pattern_default_font" -> | "pattern_default_font_volume" -> | "pattern_default_font_panning" -> | "pattern_default_font_pitch" -> | "pattern_default_font_delay" -> | "pattern_default_font_global" -> | "pattern_default_font_other" -> | "pattern_default_font_dspfx" -> | "pattern_default_font_unused" -> | "pattern_highlighted_back" -> | "pattern_highlighted_font" -> | "pattern_highlighted_font_volume" -> | "pattern_highlighted_font_panning" -> | "pattern_highlighted_font_pitch" -> | "pattern_highlighted_font_delay" -> | "pattern_highlighted_font_global" -> | "pattern_highlighted_font_other" -> | "pattern_highlighted_font_dspfx" -> | "pattern_highlighted_font_unused" -> | "pattern_playposition_back" -> | "pattern_playposition_font" -> | "pattern_centerbar_back" -> | "pattern_centerbar_font" -> | "pattern_centerbar_back_standby" -> | "pattern_centerbar_font_standby" -> | "pattern_selection" -> | "pattern_standby_selection" -> | "pattern_mute_state" -> | "automation_grid" -> | "automation_line_edge" -> | "automation_line_fill" -> | "automation_point" -> | "automation_marker_play" -> | "automation_marker_single" -> | "automation_marker_pair" -> | "automation_marker_diamond" -> | "vumeter_meter" -> | "vumeter_meter_low" -> | "vumeter_meter_middle" -> | "vumeter_meter_high" -> | "vumeter_peak" -> | "vumeter_back_normal" -> | "vumeter_back_clipped" -> | "default_color_01" -> | "default_color_02" -> | "default_color_03" -> | "default_color_04" -> | "default_color_05" -> | "default_color_06" -> | "default_color_07" -> | "default_color_08" -> | "default_color_09" -> | "default_color_10" -> | "default_color_11" -> | "default_color_12" -> | "default_color_13" -> | "default_color_14" -> | "default_color_15" -> | "default_color_16" -> ``` - -### ViewCursorShape -`"busy"` | `"change_value"` | `"crosshair"` | `"default"` | `"drag"` | `"drop"` | `"edit_text"` | `"empty"` | `"erase"` | `"extend_bottom"` | `"extend_bottom_alias"` | `"extend_left"` | `"extend_left_alias"` | `"extend_right"` | `"extend_right_alias"` | `"extend_top"` | `"extend_top_alias"` | `"marker"` | `"move"` | `"nodrop"` | `"none"` | `"pencil"` | `"play"` | `"resize_edge_diagonal_left"` | `"resize_edge_diagonal_right"` | `"resize_edge_horizontal"` | `"resize_edge_vertical"` | `"resize_horizontal"` | `"resize_vertical"` | `"zoom"` | `"zoom_horizontal"` | `"zoom_vertical"` -> ```lua -> -- The cursor cursor for this view which apears on mouse hover. -> -- Using a "none" shape will use use underlying view's cursor or the default cursor. -> ViewCursorShape: -> | "none" -> | "empty" -> | "default" -> | "change_value" -> | "edit_text" -> | "pencil" -> | "marker" -> | "crosshair" -> | "move" -> | "erase" -> | "play" -> | "drag" -> | "drop" -> | "nodrop" -> | "busy" -> | "resize_vertical" -> | "resize_horizontal" -> | "resize_edge_vertical" -> | "resize_edge_horizontal" -> | "resize_edge_diagonal_left" -> | "resize_edge_diagonal_right" -> | "extend_left" -> | "extend_right" -> | "extend_top" -> | "extend_bottom" -> | "extend_left_alias" -> | "extend_right_alias" -> | "extend_top_alias" -> | "extend_bottom_alias" -> | "zoom_vertical" -> | "zoom_horizontal" -> | "zoom" -> ``` - -### ViewDimension -[`string`](../../API/builtins/string.md) | [`integer`](../../API/builtins/integer.md) -> The dimensions of a view has to be larger than 0. -> For nested views you can also specify relative size -> for example `vb:text { width = "80%"}`. The percentage values are -> relative to the view's parent size and will automatically update on size changes. - -### ViewOrigin -{ 1 : [`ViewPosition`](#ViewPosition), 2 : [`ViewPosition`](#ViewPosition) } | { x : [`ViewPosition`](#ViewPosition), y : [`ViewPosition`](#ViewPosition) } -> The position of a view within its parent view. -> Only the `stack` layouts allows to freely position child views. Other -> layout views will automatically set the origin, but the origin -> then still can be read in for example mouse handlers. - -### ViewPosition -[`integer`](../../API/builtins/integer.md) -> Horizontal (x) or Vertical (y) position of a view within its parent view. - -### ViewSize -{ 1 : [`ViewDimension`](#ViewDimension), 2 : [`ViewDimension`](#ViewDimension) } | { height : [`ViewDimension`](#ViewDimension), width : [`ViewDimension`](#ViewDimension) } -> The dimensions of a view has to be larger than 0. -> For nested views you can also specify relative size, for example -> `vb:text { size = { width = "80%", height = 20}}`. -> The percentage values are relative to the view's parent size and will -> automatically update when the parent view's size changes. - -### ViewTooltip -[`string`](../../API/builtins/string.md) -> A ViewTooltip text that should be shown for this view on mouse hover. -> * Default: "" (no tip will be shown) - -### ViewVisibility -[`boolean`](../../API/builtins/boolean.md) -> Set visible to false to hide a view (make it invisible without removing -> it). Please note that view.visible will also return false when any of its -> parents are invisible (when its implicitly invisible). -> * Default: true - - diff --git a/docs/API/renoise/renoise.Views.TextField.md b/docs/API/renoise/renoise.Views.TextField.md deleted file mode 100644 index d6f645f..0000000 --- a/docs/API/renoise/renoise.Views.TextField.md +++ /dev/null @@ -1,213 +0,0 @@ -# renoise.Views.TextField -> Shows a text string that can be clicked and edited by the user. -> ```text -> +----------------+ -> | Editable Te|xt | -> +----------------+ -> ``` - - - - ---- -## Properties -### active : [`TextActive`](#TextActive) -> When false, text is displayed but can not be entered/modified by the user. -> * Default: true - -### value : [`TextValue`](#TextValue) -> The currently shown text. The text will not be updated when editing, -> rather only after editing is complete (return is pressed, or focus is lost). -> * Default: "" - -### text : [`TextValueAlias`](#TextValueAlias) -> Exactly the same as "value"; provided for consistency. -> * Default: "" - -### align : [`TextAlignment`](#TextAlignment) -> Only used when not editing. - -### edit_mode : [`TextEditMode`](#TextEditMode) -> True when the text field is focused. setting it at run-time programmatically -> will focus the text field or remove the focus (focus the dialog) accordingly. -> * Default: false - -### visible : [`ViewVisibility`](#ViewVisibility) -> Set visible to false to hide a view (make it invisible without removing -> it). Please note that view.visible will also return false when any of its -> parents are invisible (when its implicitly invisible). -> * Default: true - -### origin : [`ViewOrigin`](#ViewOrigin) -> The position of a view within its parent view. -> Only the `stack` layouts allows to freely position child views. Other -> layout views will automatically set the origin, but the origin -> then still can be read in for example mouse handlers. - -### width : [`ViewDimension`](#ViewDimension) -> **Deprecated.** Use property `size` instead. - -### height : [`ViewDimension`](#ViewDimension) -> **Deprecated.** Use property `size` instead. - -### size : [`ViewSize`](#ViewSize) -> The dimensions of a view has to be larger than 0. -> For nested views you can also specify relative size, for example -> `vb:text { size = { width = "80%", height = 20}}`. -> The percentage values are relative to the view's parent size and will -> automatically update when the parent view's size changes. - -### tooltip : [`ViewTooltip`](#ViewTooltip) -> A ViewTooltip text that should be shown for this view on mouse hover. -> * Default: "" (no tip will be shown) - -### cursor : [`ViewCursorShape`](#ViewCursorShape) -> The cursor cursor for this view which apears on mouse hover. -> Using a "none" shape will use use underlying view's cursor or the default cursor. - -### views : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)[] -> **READ-ONLY** Empty for all controls, for layout views this contains the -> layout child views in the order they got added - - - ---- -## Functions -### add_notifier([*self*](../../API/builtins/self.md), notifier : [`StringValueNotifierFunction`](#StringValueNotifierFunction)) -> Add value change (text change) notifier -### remove_notifier([*self*](../../API/builtins/self.md), notifier : [`StringValueNotifierFunction`](#StringValueNotifierFunction)) -> Remove value change (text change) notifier -### add_view([*self*](../../API/builtins/self.md), child : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)) -> Add a new child view to this view. -### remove_view([*self*](../../API/builtins/self.md), child : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)) -> Remove a child view from this view. -### swap_views([*self*](../../API/builtins/self.md), child1 : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md), child2 : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)) -> Swap position of two child views in this view. With a series of swaps views -> can be moved to any position in the parent. -### add_child([*self*](../../API/builtins/self.md), child : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)) -> **Deprecated.** Use `add_view` instead -### remove_child([*self*](../../API/builtins/self.md), child : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)) -> **Deprecated.** Use `remove_view` instead -### swap_childs([*self*](../../API/builtins/self.md), child1 : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md), child2 : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)) -> **Deprecated.** Use `swap_views` instead - - - ---- -## Aliases -### StringValueNotifierFunction -(value : [`string`](../../API/builtins/string.md)) - - -### TextActive -[`boolean`](../../API/builtins/boolean.md) -> When false, text is displayed but can not be entered/modified by the user. -> * Default: true - -### TextAlignment -`"center"` | `"left"` | `"right"` -> ```lua -> -- Setup the text's alignment. Applies only when the view's size is larger than -> -- the needed size to draw the text -> TextAlignment: -> | "left" -- (Default) -> | "right" -- aligned to the right -> | "center" -- center text -> ``` - -### TextEditMode -[`boolean`](../../API/builtins/boolean.md) -> True when the text field is focused. setting it at run-time programmatically -> will focus the text field or remove the focus (focus the dialog) accordingly. -> * Default: false - -### TextValue -[`string`](../../API/builtins/string.md) -> The currently shown text. The text will not be updated when editing, -> rather only after editing is complete (return is pressed, or focus is lost). -> * Default: "" - -### TextValueAlias -[`string`](../../API/builtins/string.md) -> Exactly the same as "value"; provided for consistency. -> * Default: "" - -### ViewCursorShape -`"busy"` | `"change_value"` | `"crosshair"` | `"default"` | `"drag"` | `"drop"` | `"edit_text"` | `"empty"` | `"erase"` | `"extend_bottom"` | `"extend_bottom_alias"` | `"extend_left"` | `"extend_left_alias"` | `"extend_right"` | `"extend_right_alias"` | `"extend_top"` | `"extend_top_alias"` | `"marker"` | `"move"` | `"nodrop"` | `"none"` | `"pencil"` | `"play"` | `"resize_edge_diagonal_left"` | `"resize_edge_diagonal_right"` | `"resize_edge_horizontal"` | `"resize_edge_vertical"` | `"resize_horizontal"` | `"resize_vertical"` | `"zoom"` | `"zoom_horizontal"` | `"zoom_vertical"` -> ```lua -> -- The cursor cursor for this view which apears on mouse hover. -> -- Using a "none" shape will use use underlying view's cursor or the default cursor. -> ViewCursorShape: -> | "none" -> | "empty" -> | "default" -> | "change_value" -> | "edit_text" -> | "pencil" -> | "marker" -> | "crosshair" -> | "move" -> | "erase" -> | "play" -> | "drag" -> | "drop" -> | "nodrop" -> | "busy" -> | "resize_vertical" -> | "resize_horizontal" -> | "resize_edge_vertical" -> | "resize_edge_horizontal" -> | "resize_edge_diagonal_left" -> | "resize_edge_diagonal_right" -> | "extend_left" -> | "extend_right" -> | "extend_top" -> | "extend_bottom" -> | "extend_left_alias" -> | "extend_right_alias" -> | "extend_top_alias" -> | "extend_bottom_alias" -> | "zoom_vertical" -> | "zoom_horizontal" -> | "zoom" -> ``` - -### ViewDimension -[`string`](../../API/builtins/string.md) | [`integer`](../../API/builtins/integer.md) -> The dimensions of a view has to be larger than 0. -> For nested views you can also specify relative size -> for example `vb:text { width = "80%"}`. The percentage values are -> relative to the view's parent size and will automatically update on size changes. - -### ViewOrigin -{ 1 : [`ViewPosition`](#ViewPosition), 2 : [`ViewPosition`](#ViewPosition) } | { x : [`ViewPosition`](#ViewPosition), y : [`ViewPosition`](#ViewPosition) } -> The position of a view within its parent view. -> Only the `stack` layouts allows to freely position child views. Other -> layout views will automatically set the origin, but the origin -> then still can be read in for example mouse handlers. - -### ViewPosition -[`integer`](../../API/builtins/integer.md) -> Horizontal (x) or Vertical (y) position of a view within its parent view. - -### ViewSize -{ 1 : [`ViewDimension`](#ViewDimension), 2 : [`ViewDimension`](#ViewDimension) } | { height : [`ViewDimension`](#ViewDimension), width : [`ViewDimension`](#ViewDimension) } -> The dimensions of a view has to be larger than 0. -> For nested views you can also specify relative size, for example -> `vb:text { size = { width = "80%", height = 20}}`. -> The percentage values are relative to the view's parent size and will -> automatically update when the parent view's size changes. - -### ViewTooltip -[`string`](../../API/builtins/string.md) -> A ViewTooltip text that should be shown for this view on mouse hover. -> * Default: "" (no tip will be shown) - -### ViewVisibility -[`boolean`](../../API/builtins/boolean.md) -> Set visible to false to hide a view (make it invisible without removing -> it). Please note that view.visible will also return false when any of its -> parents are invisible (when its implicitly invisible). -> * Default: true - - diff --git a/docs/API/renoise/renoise.Views.TextLink.md b/docs/API/renoise/renoise.Views.TextLink.md deleted file mode 100644 index a820384..0000000 --- a/docs/API/renoise/renoise.Views.TextLink.md +++ /dev/null @@ -1,467 +0,0 @@ -# renoise.Views.TextLink -> Shows a text string which is highlighted when hovering with the mouse, -> and which can be clicked to perform some action. -> To create a hyperlink alike text, add a notifier which opens an url via: -> `renoise.app():open_url("https://some.url.com")` -> property. -> ```text -> *Text, * -> ``` - - - - ---- -## Properties -### active : [`ControlActive`](#ControlActive) -> Instead of making a control invisible, you can also make it inactive. -> Deactivated controls will still be shown, and will still show their -> currently assigned values, but will not allow changes. Most controls will -> display as "grayed out" to visualize the deactivated state. - -### midi_mapping : [`ControlMidiMappingString`](#ControlMidiMappingString)[`?`](../../API/builtins/nil.md) -> When set, the control will be highlighted when Renoise's MIDI mapping dialog -> is open. When clicked, it selects the specified string as a MIDI mapping -> target action. This target acton can either be one of the globally available -> mappings in Renoise, or those that were created by the tool itself. -> Target strings are not verified. When they point to nothing, the mapped MIDI -> message will do nothing and no error is fired. - -### text : [`TextSingleLineString`](#TextSingleLineString) -> The text that should be displayed. Setting a new text will resize -> the view in order to make the text fully visible (expanding only). -> * Default: "" - -### font : [`TextFontStyle`](#TextFontStyle) -> The style that the text should be displayed with. - -### style : [`TextStyle`](#TextStyle) -> Get/set the color style the text should be displayed with. - -### color : [`TextColor`](#TextColor) -> When set, the text will be drawn in the specified color. -> Set style to something else than "custom" or color to `{0, 0, 0}` -> to enable the default theme color for the text again. - -### orientation : [`TextOrientation`](#TextOrientation) -> Setup the texts's orientation (writing direction). - -### align : [`TextAlignment`](#TextAlignment) -> Setup the text's alignment. Applies only when the view's size is larger than -> the needed size to draw the text - -### visible : [`ViewVisibility`](#ViewVisibility) -> Set visible to false to hide a view (make it invisible without removing -> it). Please note that view.visible will also return false when any of its -> parents are invisible (when its implicitly invisible). -> * Default: true - -### origin : [`ViewOrigin`](#ViewOrigin) -> The position of a view within its parent view. -> Only the `stack` layouts allows to freely position child views. Other -> layout views will automatically set the origin, but the origin -> then still can be read in for example mouse handlers. - -### width : [`ViewDimension`](#ViewDimension) -> **Deprecated.** Use property `size` instead. - -### height : [`ViewDimension`](#ViewDimension) -> **Deprecated.** Use property `size` instead. - -### size : [`ViewSize`](#ViewSize) -> The dimensions of a view has to be larger than 0. -> For nested views you can also specify relative size, for example -> `vb:text { size = { width = "80%", height = 20}}`. -> The percentage values are relative to the view's parent size and will -> automatically update when the parent view's size changes. - -### tooltip : [`ViewTooltip`](#ViewTooltip) -> A ViewTooltip text that should be shown for this view on mouse hover. -> * Default: "" (no tip will be shown) - -### cursor : [`ViewCursorShape`](#ViewCursorShape) -> The cursor cursor for this view which apears on mouse hover. -> Using a "none" shape will use use underlying view's cursor or the default cursor. - -### views : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)[] -> **READ-ONLY** Empty for all controls, for layout views this contains the -> layout child views in the order they got added - - - ---- -## Functions -### add_pressed_notifier([*self*](../../API/builtins/self.md), notifier : [`NotifierFunction`](#NotifierFunction)) -> Add/remove text link hit/release notifier functions. -### add_released_notifier([*self*](../../API/builtins/self.md), notifier : [`NotifierFunction`](#NotifierFunction)) -### remove_pressed_notifier([*self*](../../API/builtins/self.md), notifier : [`NotifierFunction`](#NotifierFunction)) -### remove_released_notifier([*self*](../../API/builtins/self.md), notifier : [`NotifierFunction`](#NotifierFunction)) -### add_view([*self*](../../API/builtins/self.md), child : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)) -> Add a new child view to this view. -### remove_view([*self*](../../API/builtins/self.md), child : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)) -> Remove a child view from this view. -### swap_views([*self*](../../API/builtins/self.md), child1 : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md), child2 : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)) -> Swap position of two child views in this view. With a series of swaps views -> can be moved to any position in the parent. -### add_child([*self*](../../API/builtins/self.md), child : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)) -> **Deprecated.** Use `add_view` instead -### remove_child([*self*](../../API/builtins/self.md), child : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)) -> **Deprecated.** Use `remove_view` instead -### swap_childs([*self*](../../API/builtins/self.md), child1 : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md), child2 : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)) -> **Deprecated.** Use `swap_views` instead - - - ---- -## Aliases -### ControlActive -[`boolean`](../../API/builtins/boolean.md) -> Instead of making a control invisible, you can also make it inactive. -> Deactivated controls will still be shown, and will still show their -> currently assigned values, but will not allow changes. Most controls will -> display as "grayed out" to visualize the deactivated state. - -### ControlMidiMappingString -[`string`](../../API/builtins/string.md) -> When set, the control will be highlighted when Renoise's MIDI mapping dialog -> is open. When clicked, it selects the specified string as a MIDI mapping -> target action. This target acton can either be one of the globally available -> mappings in Renoise, or those that were created by the tool itself. -> Target strings are not verified. When they point to nothing, the mapped MIDI -> message will do nothing and no error is fired. - -### NotifierFunction -fun() - - -### RGBColor -{ 1 : [`integer`](../../API/builtins/integer.md), 2 : [`integer`](../../API/builtins/integer.md), 3 : [`integer`](../../API/builtins/integer.md) } -> A table of 3 bytes (ranging from 0 to 255) -> representing the red, green and blue channels of a color. -> {0xFF, 0xFF, 0xFF} is white -> {165, 73, 35} is the red from the Renoise logo - -### TextAlignment -`"center"` | `"left"` | `"right"` -> ```lua -> -- Setup the text's alignment. Applies only when the view's size is larger than -> -- the needed size to draw the text -> TextAlignment: -> | "left" -- (Default) -> | "right" -- aligned to the right -> | "center" -- center text -> ``` - -### TextColor -[`RGBColor`](#RGBColor) | [`ThemeColor`](#ThemeColor) -> ```lua -> -- When set, the text will be drawn in the specified color. -> -- Set style to something else than "custom" or color to `{0, 0, 0}` -> -- to enable the default theme color for the text again. -> -- A table of 3 bytes (ranging from 0 to 255) -> -- representing the red, green and blue channels of a color. -> -- {0xFF, 0xFF, 0xFF} is white -> -- {165, 73, 35} is the red from the Renoise logo -> -- The application theme's colors -> TextColor: -> | "main_back" -> | "main_font" -> | "alternate_main_back" -> | "alternate_main_font" -> | "body_back" -> | "body_font" -> | "strong_body_font" -> | "button_back" -> | "button_font" -> | "button_highlight_font" -> | "selected_button_back" -> | "selected_button_font" -> | "selection_back" -> | "selection_font" -> | "standby_selection_back" -> | "standby_selection_font" -> | "midi_mapping_back" -> | "midi_mapping_font" -> | "tooltip_back" -> | "tooltip_font" -> | "valuebox_back" -> | "valuebox_font" -> | "valuebox_font_icons" -> | "scrollbar" -> | "slider" -> | "folder" -> | "pattern_default_back" -> | "pattern_default_font" -> | "pattern_default_font_volume" -> | "pattern_default_font_panning" -> | "pattern_default_font_pitch" -> | "pattern_default_font_delay" -> | "pattern_default_font_global" -> | "pattern_default_font_other" -> | "pattern_default_font_dspfx" -> | "pattern_default_font_unused" -> | "pattern_highlighted_back" -> | "pattern_highlighted_font" -> | "pattern_highlighted_font_volume" -> | "pattern_highlighted_font_panning" -> | "pattern_highlighted_font_pitch" -> | "pattern_highlighted_font_delay" -> | "pattern_highlighted_font_global" -> | "pattern_highlighted_font_other" -> | "pattern_highlighted_font_dspfx" -> | "pattern_highlighted_font_unused" -> | "pattern_playposition_back" -> | "pattern_playposition_font" -> | "pattern_centerbar_back" -> | "pattern_centerbar_font" -> | "pattern_centerbar_back_standby" -> | "pattern_centerbar_font_standby" -> | "pattern_selection" -> | "pattern_standby_selection" -> | "pattern_mute_state" -> | "automation_grid" -> | "automation_line_edge" -> | "automation_line_fill" -> | "automation_point" -> | "automation_marker_play" -> | "automation_marker_single" -> | "automation_marker_pair" -> | "automation_marker_diamond" -> | "vumeter_meter" -> | "vumeter_meter_low" -> | "vumeter_meter_middle" -> | "vumeter_meter_high" -> | "vumeter_peak" -> | "vumeter_back_normal" -> | "vumeter_back_clipped" -> | "default_color_01" -> | "default_color_02" -> | "default_color_03" -> | "default_color_04" -> | "default_color_05" -> | "default_color_06" -> | "default_color_07" -> | "default_color_08" -> | "default_color_09" -> | "default_color_10" -> | "default_color_11" -> | "default_color_12" -> | "default_color_13" -> | "default_color_14" -> | "default_color_15" -> | "default_color_16" -> ``` - -### TextFontStyle -`"big"` | `"bold"` | `"code"` | `"italic"` | `"mono"` | `"normal"` -> ```lua -> -- The style that the text should be displayed with. -> TextFontStyle: -> | "normal" -- (Default) -> | "big" -- big text -> | "bold" -- bold font -> | "italic" -- italic font -> | "mono" -- monospace font -> | "code" -- monospace code font -> ``` - -### TextOrientation -`"horizontal"` | `"horizontal-rl"` | `"vertical"` | `"vertical-tb"` -> ```lua -> -- Setup the texts's orientation (writing direction). -> TextOrientation: -> | "horizontal" -- Draw from left to right (Default) -> | "horizontal-rl" -- Draw from right to left -> | "vertical" -- Draw from bottom to top -> | "vertical-tb" -- Draw from top to bottom -> ``` - -### TextSingleLineString -[`string`](../../API/builtins/string.md) -> The text that should be displayed. Setting a new text will resize -> the view in order to make the text fully visible (expanding only). -> * Default: "" - -### TextStyle -`"custom"` | `"disabled"` | `"normal"` | `"strong"` -> ```lua -> -- Get/set the color style the text should be displayed with. -> TextStyle: -> | "normal" -- (Default) -> | "strong" -- highlighted color -> | "disabled" -- greyed out color -> | "custom" -- custom color -> ``` - -### ThemeColor -`"alternate_main_back"` | `"alternate_main_font"` | `"automation_grid"` | `"automation_line_edge"` | `"automation_line_fill"` | `"automation_marker_diamond"` | `"automation_marker_pair"` | `"automation_marker_play"` | `"automation_marker_single"` | `"automation_point"` | `"body_back"` | `"body_font"` | `"button_back"` | `"button_font"` | `"button_highlight_font"` | `"default_color_01"` | `"default_color_02"` | `"default_color_03"` | `"default_color_04"` | `"default_color_05"` | `"default_color_06"` | `"default_color_07"` | `"default_color_08"` | `"default_color_09"` | `"default_color_10"` | `"default_color_11"` | `"default_color_12"` | `"default_color_13"` | `"default_color_14"` | `"default_color_15"` | `"default_color_16"` | `"folder"` | `"main_back"` | `"main_font"` | `"midi_mapping_back"` | `"midi_mapping_font"` | `"pattern_centerbar_back"` | `"pattern_centerbar_back_standby"` | `"pattern_centerbar_font"` | `"pattern_centerbar_font_standby"` | `"pattern_default_back"` | `"pattern_default_font"` | `"pattern_default_font_delay"` | `"pattern_default_font_dspfx"` | `"pattern_default_font_global"` | `"pattern_default_font_other"` | `"pattern_default_font_panning"` | `"pattern_default_font_pitch"` | `"pattern_default_font_unused"` | `"pattern_default_font_volume"` | `"pattern_highlighted_back"` | `"pattern_highlighted_font"` | `"pattern_highlighted_font_delay"` | `"pattern_highlighted_font_dspfx"` | `"pattern_highlighted_font_global"` | `"pattern_highlighted_font_other"` | `"pattern_highlighted_font_panning"` | `"pattern_highlighted_font_pitch"` | `"pattern_highlighted_font_unused"` | `"pattern_highlighted_font_volume"` | `"pattern_mute_state"` | `"pattern_playposition_back"` | `"pattern_playposition_font"` | `"pattern_selection"` | `"pattern_standby_selection"` | `"scrollbar"` | `"selected_button_back"` | `"selected_button_font"` | `"selection_back"` | `"selection_font"` | `"slider"` | `"standby_selection_back"` | `"standby_selection_font"` | `"strong_body_font"` | `"tooltip_back"` | `"tooltip_font"` | `"valuebox_back"` | `"valuebox_font"` | `"valuebox_font_icons"` | `"vumeter_back_clipped"` | `"vumeter_back_normal"` | `"vumeter_meter"` | `"vumeter_meter_high"` | `"vumeter_meter_low"` | `"vumeter_meter_middle"` | `"vumeter_peak"` -> ```lua -> -- The application theme's colors -> ThemeColor: -> | "main_back" -> | "main_font" -> | "alternate_main_back" -> | "alternate_main_font" -> | "body_back" -> | "body_font" -> | "strong_body_font" -> | "button_back" -> | "button_font" -> | "button_highlight_font" -> | "selected_button_back" -> | "selected_button_font" -> | "selection_back" -> | "selection_font" -> | "standby_selection_back" -> | "standby_selection_font" -> | "midi_mapping_back" -> | "midi_mapping_font" -> | "tooltip_back" -> | "tooltip_font" -> | "valuebox_back" -> | "valuebox_font" -> | "valuebox_font_icons" -> | "scrollbar" -> | "slider" -> | "folder" -> | "pattern_default_back" -> | "pattern_default_font" -> | "pattern_default_font_volume" -> | "pattern_default_font_panning" -> | "pattern_default_font_pitch" -> | "pattern_default_font_delay" -> | "pattern_default_font_global" -> | "pattern_default_font_other" -> | "pattern_default_font_dspfx" -> | "pattern_default_font_unused" -> | "pattern_highlighted_back" -> | "pattern_highlighted_font" -> | "pattern_highlighted_font_volume" -> | "pattern_highlighted_font_panning" -> | "pattern_highlighted_font_pitch" -> | "pattern_highlighted_font_delay" -> | "pattern_highlighted_font_global" -> | "pattern_highlighted_font_other" -> | "pattern_highlighted_font_dspfx" -> | "pattern_highlighted_font_unused" -> | "pattern_playposition_back" -> | "pattern_playposition_font" -> | "pattern_centerbar_back" -> | "pattern_centerbar_font" -> | "pattern_centerbar_back_standby" -> | "pattern_centerbar_font_standby" -> | "pattern_selection" -> | "pattern_standby_selection" -> | "pattern_mute_state" -> | "automation_grid" -> | "automation_line_edge" -> | "automation_line_fill" -> | "automation_point" -> | "automation_marker_play" -> | "automation_marker_single" -> | "automation_marker_pair" -> | "automation_marker_diamond" -> | "vumeter_meter" -> | "vumeter_meter_low" -> | "vumeter_meter_middle" -> | "vumeter_meter_high" -> | "vumeter_peak" -> | "vumeter_back_normal" -> | "vumeter_back_clipped" -> | "default_color_01" -> | "default_color_02" -> | "default_color_03" -> | "default_color_04" -> | "default_color_05" -> | "default_color_06" -> | "default_color_07" -> | "default_color_08" -> | "default_color_09" -> | "default_color_10" -> | "default_color_11" -> | "default_color_12" -> | "default_color_13" -> | "default_color_14" -> | "default_color_15" -> | "default_color_16" -> ``` - -### ViewCursorShape -`"busy"` | `"change_value"` | `"crosshair"` | `"default"` | `"drag"` | `"drop"` | `"edit_text"` | `"empty"` | `"erase"` | `"extend_bottom"` | `"extend_bottom_alias"` | `"extend_left"` | `"extend_left_alias"` | `"extend_right"` | `"extend_right_alias"` | `"extend_top"` | `"extend_top_alias"` | `"marker"` | `"move"` | `"nodrop"` | `"none"` | `"pencil"` | `"play"` | `"resize_edge_diagonal_left"` | `"resize_edge_diagonal_right"` | `"resize_edge_horizontal"` | `"resize_edge_vertical"` | `"resize_horizontal"` | `"resize_vertical"` | `"zoom"` | `"zoom_horizontal"` | `"zoom_vertical"` -> ```lua -> -- The cursor cursor for this view which apears on mouse hover. -> -- Using a "none" shape will use use underlying view's cursor or the default cursor. -> ViewCursorShape: -> | "none" -> | "empty" -> | "default" -> | "change_value" -> | "edit_text" -> | "pencil" -> | "marker" -> | "crosshair" -> | "move" -> | "erase" -> | "play" -> | "drag" -> | "drop" -> | "nodrop" -> | "busy" -> | "resize_vertical" -> | "resize_horizontal" -> | "resize_edge_vertical" -> | "resize_edge_horizontal" -> | "resize_edge_diagonal_left" -> | "resize_edge_diagonal_right" -> | "extend_left" -> | "extend_right" -> | "extend_top" -> | "extend_bottom" -> | "extend_left_alias" -> | "extend_right_alias" -> | "extend_top_alias" -> | "extend_bottom_alias" -> | "zoom_vertical" -> | "zoom_horizontal" -> | "zoom" -> ``` - -### ViewDimension -[`string`](../../API/builtins/string.md) | [`integer`](../../API/builtins/integer.md) -> The dimensions of a view has to be larger than 0. -> For nested views you can also specify relative size -> for example `vb:text { width = "80%"}`. The percentage values are -> relative to the view's parent size and will automatically update on size changes. - -### ViewOrigin -{ 1 : [`ViewPosition`](#ViewPosition), 2 : [`ViewPosition`](#ViewPosition) } | { x : [`ViewPosition`](#ViewPosition), y : [`ViewPosition`](#ViewPosition) } -> The position of a view within its parent view. -> Only the `stack` layouts allows to freely position child views. Other -> layout views will automatically set the origin, but the origin -> then still can be read in for example mouse handlers. - -### ViewPosition -[`integer`](../../API/builtins/integer.md) -> Horizontal (x) or Vertical (y) position of a view within its parent view. - -### ViewSize -{ 1 : [`ViewDimension`](#ViewDimension), 2 : [`ViewDimension`](#ViewDimension) } | { height : [`ViewDimension`](#ViewDimension), width : [`ViewDimension`](#ViewDimension) } -> The dimensions of a view has to be larger than 0. -> For nested views you can also specify relative size, for example -> `vb:text { size = { width = "80%", height = 20}}`. -> The percentage values are relative to the view's parent size and will -> automatically update when the parent view's size changes. - -### ViewTooltip -[`string`](../../API/builtins/string.md) -> A ViewTooltip text that should be shown for this view on mouse hover. -> * Default: "" (no tip will be shown) - -### ViewVisibility -[`boolean`](../../API/builtins/boolean.md) -> Set visible to false to hide a view (make it invisible without removing -> it). Please note that view.visible will also return false when any of its -> parents are invisible (when its implicitly invisible). -> * Default: true - - diff --git a/docs/API/renoise/renoise.Views.Value.md b/docs/API/renoise/renoise.Views.Value.md deleted file mode 100644 index 4615a10..0000000 --- a/docs/API/renoise/renoise.Views.Value.md +++ /dev/null @@ -1,198 +0,0 @@ -# renoise.Views.Value -> A static text view. Shows a string representation of a number and -> allows custom "number to string" conversion. -> ```text -> +---+-------+ -> | 12.1 dB | -> +---+-------+ -> ``` - - - - ---- -## Properties -### value : [`SliderNumberValue`](#SliderNumberValue) -> The current value of the view - -### font : [`TextFontStyle`](#TextFontStyle) -> The style that the text should be displayed with. - -### align : [`TextAlignment`](#TextAlignment) -> Setup the text's alignment. Applies only when the view's size is larger than -> the needed size to draw the text - -### visible : [`ViewVisibility`](#ViewVisibility) -> Set visible to false to hide a view (make it invisible without removing -> it). Please note that view.visible will also return false when any of its -> parents are invisible (when its implicitly invisible). -> * Default: true - -### origin : [`ViewOrigin`](#ViewOrigin) -> The position of a view within its parent view. -> Only the `stack` layouts allows to freely position child views. Other -> layout views will automatically set the origin, but the origin -> then still can be read in for example mouse handlers. - -### width : [`ViewDimension`](#ViewDimension) -> **Deprecated.** Use property `size` instead. - -### height : [`ViewDimension`](#ViewDimension) -> **Deprecated.** Use property `size` instead. - -### size : [`ViewSize`](#ViewSize) -> The dimensions of a view has to be larger than 0. -> For nested views you can also specify relative size, for example -> `vb:text { size = { width = "80%", height = 20}}`. -> The percentage values are relative to the view's parent size and will -> automatically update when the parent view's size changes. - -### tooltip : [`ViewTooltip`](#ViewTooltip) -> A ViewTooltip text that should be shown for this view on mouse hover. -> * Default: "" (no tip will be shown) - -### cursor : [`ViewCursorShape`](#ViewCursorShape) -> The cursor cursor for this view which apears on mouse hover. -> Using a "none" shape will use use underlying view's cursor or the default cursor. - -### views : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)[] -> **READ-ONLY** Empty for all controls, for layout views this contains the -> layout child views in the order they got added - - - ---- -## Functions -### add_notifier([*self*](../../API/builtins/self.md), notifier : [`NumberValueNotifierFunction`](#NumberValueNotifierFunction)) -> Add value change notifier -### remove_notifier([*self*](../../API/builtins/self.md), notifier : [`NumberValueNotifierFunction`](#NumberValueNotifierFunction)) -> Remove value change notifier -### add_view([*self*](../../API/builtins/self.md), child : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)) -> Add a new child view to this view. -### remove_view([*self*](../../API/builtins/self.md), child : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)) -> Remove a child view from this view. -### swap_views([*self*](../../API/builtins/self.md), child1 : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md), child2 : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)) -> Swap position of two child views in this view. With a series of swaps views -> can be moved to any position in the parent. -### add_child([*self*](../../API/builtins/self.md), child : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)) -> **Deprecated.** Use `add_view` instead -### remove_child([*self*](../../API/builtins/self.md), child : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)) -> **Deprecated.** Use `remove_view` instead -### swap_childs([*self*](../../API/builtins/self.md), child1 : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md), child2 : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)) -> **Deprecated.** Use `swap_views` instead - - - ---- -## Aliases -### NumberValueNotifierFunction -(value : [`number`](../../API/builtins/number.md)) - - -### SliderNumberValue -[`number`](../../API/builtins/number.md) -> The current value of the view - -### TextAlignment -`"center"` | `"left"` | `"right"` -> ```lua -> -- Setup the text's alignment. Applies only when the view's size is larger than -> -- the needed size to draw the text -> TextAlignment: -> | "left" -- (Default) -> | "right" -- aligned to the right -> | "center" -- center text -> ``` - -### TextFontStyle -`"big"` | `"bold"` | `"code"` | `"italic"` | `"mono"` | `"normal"` -> ```lua -> -- The style that the text should be displayed with. -> TextFontStyle: -> | "normal" -- (Default) -> | "big" -- big text -> | "bold" -- bold font -> | "italic" -- italic font -> | "mono" -- monospace font -> | "code" -- monospace code font -> ``` - -### ViewCursorShape -`"busy"` | `"change_value"` | `"crosshair"` | `"default"` | `"drag"` | `"drop"` | `"edit_text"` | `"empty"` | `"erase"` | `"extend_bottom"` | `"extend_bottom_alias"` | `"extend_left"` | `"extend_left_alias"` | `"extend_right"` | `"extend_right_alias"` | `"extend_top"` | `"extend_top_alias"` | `"marker"` | `"move"` | `"nodrop"` | `"none"` | `"pencil"` | `"play"` | `"resize_edge_diagonal_left"` | `"resize_edge_diagonal_right"` | `"resize_edge_horizontal"` | `"resize_edge_vertical"` | `"resize_horizontal"` | `"resize_vertical"` | `"zoom"` | `"zoom_horizontal"` | `"zoom_vertical"` -> ```lua -> -- The cursor cursor for this view which apears on mouse hover. -> -- Using a "none" shape will use use underlying view's cursor or the default cursor. -> ViewCursorShape: -> | "none" -> | "empty" -> | "default" -> | "change_value" -> | "edit_text" -> | "pencil" -> | "marker" -> | "crosshair" -> | "move" -> | "erase" -> | "play" -> | "drag" -> | "drop" -> | "nodrop" -> | "busy" -> | "resize_vertical" -> | "resize_horizontal" -> | "resize_edge_vertical" -> | "resize_edge_horizontal" -> | "resize_edge_diagonal_left" -> | "resize_edge_diagonal_right" -> | "extend_left" -> | "extend_right" -> | "extend_top" -> | "extend_bottom" -> | "extend_left_alias" -> | "extend_right_alias" -> | "extend_top_alias" -> | "extend_bottom_alias" -> | "zoom_vertical" -> | "zoom_horizontal" -> | "zoom" -> ``` - -### ViewDimension -[`string`](../../API/builtins/string.md) | [`integer`](../../API/builtins/integer.md) -> The dimensions of a view has to be larger than 0. -> For nested views you can also specify relative size -> for example `vb:text { width = "80%"}`. The percentage values are -> relative to the view's parent size and will automatically update on size changes. - -### ViewOrigin -{ 1 : [`ViewPosition`](#ViewPosition), 2 : [`ViewPosition`](#ViewPosition) } | { x : [`ViewPosition`](#ViewPosition), y : [`ViewPosition`](#ViewPosition) } -> The position of a view within its parent view. -> Only the `stack` layouts allows to freely position child views. Other -> layout views will automatically set the origin, but the origin -> then still can be read in for example mouse handlers. - -### ViewPosition -[`integer`](../../API/builtins/integer.md) -> Horizontal (x) or Vertical (y) position of a view within its parent view. - -### ViewSize -{ 1 : [`ViewDimension`](#ViewDimension), 2 : [`ViewDimension`](#ViewDimension) } | { height : [`ViewDimension`](#ViewDimension), width : [`ViewDimension`](#ViewDimension) } -> The dimensions of a view has to be larger than 0. -> For nested views you can also specify relative size, for example -> `vb:text { size = { width = "80%", height = 20}}`. -> The percentage values are relative to the view's parent size and will -> automatically update when the parent view's size changes. - -### ViewTooltip -[`string`](../../API/builtins/string.md) -> A ViewTooltip text that should be shown for this view on mouse hover. -> * Default: "" (no tip will be shown) - -### ViewVisibility -[`boolean`](../../API/builtins/boolean.md) -> Set visible to false to hide a view (make it invisible without removing -> it). Please note that view.visible will also return false when any of its -> parents are invisible (when its implicitly invisible). -> * Default: true - - diff --git a/docs/API/renoise/renoise.Views.ValueBox.md b/docs/API/renoise/renoise.Views.ValueBox.md deleted file mode 100644 index 4512dd9..0000000 --- a/docs/API/renoise/renoise.Views.ValueBox.md +++ /dev/null @@ -1,228 +0,0 @@ -# renoise.Views.ValueBox -> A box with arrow buttons and a text field that can be edited by the user. -> Allows showing and editing natural numbers in a custom range. -> ```text -> +---+-------+ -> |<|>| 12 | -> +---+-------+ -> ``` - - - - ---- -## Properties -### active : [`ControlActive`](#ControlActive) -> Instead of making a control invisible, you can also make it inactive. -> Deactivated controls will still be shown, and will still show their -> currently assigned values, but will not allow changes. Most controls will -> display as "grayed out" to visualize the deactivated state. - -### midi_mapping : [`ControlMidiMappingString`](#ControlMidiMappingString) -> When set, the control will be highlighted when Renoise's MIDI mapping dialog -> is open. When clicked, it selects the specified string as a MIDI mapping -> target action. This target acton can either be one of the globally available -> mappings in Renoise, or those that were created by the tool itself. -> Target strings are not verified. When they point to nothing, the mapped MIDI -> message will do nothing and no error is fired. - -### min : [`ValueBoxMinValue`](#ValueBoxMinValue) -> The minimum value that can be set using the view -> * Default: 0 - -### max : [`ValueBoxMaxValue`](#ValueBoxMaxValue) -> The maximum value that can be set using the view -> * Default: 100 - -### steps : [`SliderStepAmounts`](#SliderStepAmounts) -> A table containing two numbers representing the step amounts for incrementing -> and decrementing by clicking the <> buttons. -> The first value is the small step (applied on left clicks) -> second value is the big step (applied on right clicks) - -### value : [`SliderNumberValue`](#SliderNumberValue) -> The current value of the view - -### visible : [`ViewVisibility`](#ViewVisibility) -> Set visible to false to hide a view (make it invisible without removing -> it). Please note that view.visible will also return false when any of its -> parents are invisible (when its implicitly invisible). -> * Default: true - -### origin : [`ViewOrigin`](#ViewOrigin) -> The position of a view within its parent view. -> Only the `stack` layouts allows to freely position child views. Other -> layout views will automatically set the origin, but the origin -> then still can be read in for example mouse handlers. - -### width : [`ViewDimension`](#ViewDimension) -> **Deprecated.** Use property `size` instead. - -### height : [`ViewDimension`](#ViewDimension) -> **Deprecated.** Use property `size` instead. - -### size : [`ViewSize`](#ViewSize) -> The dimensions of a view has to be larger than 0. -> For nested views you can also specify relative size, for example -> `vb:text { size = { width = "80%", height = 20}}`. -> The percentage values are relative to the view's parent size and will -> automatically update when the parent view's size changes. - -### tooltip : [`ViewTooltip`](#ViewTooltip) -> A ViewTooltip text that should be shown for this view on mouse hover. -> * Default: "" (no tip will be shown) - -### cursor : [`ViewCursorShape`](#ViewCursorShape) -> The cursor cursor for this view which apears on mouse hover. -> Using a "none" shape will use use underlying view's cursor or the default cursor. - -### views : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)[] -> **READ-ONLY** Empty for all controls, for layout views this contains the -> layout child views in the order they got added - - - ---- -## Functions -### add_notifier([*self*](../../API/builtins/self.md), notifier : [`NumberValueNotifierFunction`](#NumberValueNotifierFunction)) -> Add value change notifier -### remove_notifier([*self*](../../API/builtins/self.md), notifier : [`NumberValueNotifierFunction`](#NumberValueNotifierFunction)) -> Remove value change notifier -### add_view([*self*](../../API/builtins/self.md), child : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)) -> Add a new child view to this view. -### remove_view([*self*](../../API/builtins/self.md), child : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)) -> Remove a child view from this view. -### swap_views([*self*](../../API/builtins/self.md), child1 : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md), child2 : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)) -> Swap position of two child views in this view. With a series of swaps views -> can be moved to any position in the parent. -### add_child([*self*](../../API/builtins/self.md), child : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)) -> **Deprecated.** Use `add_view` instead -### remove_child([*self*](../../API/builtins/self.md), child : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)) -> **Deprecated.** Use `remove_view` instead -### swap_childs([*self*](../../API/builtins/self.md), child1 : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md), child2 : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)) -> **Deprecated.** Use `swap_views` instead - - - ---- -## Aliases -### ControlActive -[`boolean`](../../API/builtins/boolean.md) -> Instead of making a control invisible, you can also make it inactive. -> Deactivated controls will still be shown, and will still show their -> currently assigned values, but will not allow changes. Most controls will -> display as "grayed out" to visualize the deactivated state. - -### ControlMidiMappingString -[`string`](../../API/builtins/string.md) -> When set, the control will be highlighted when Renoise's MIDI mapping dialog -> is open. When clicked, it selects the specified string as a MIDI mapping -> target action. This target acton can either be one of the globally available -> mappings in Renoise, or those that were created by the tool itself. -> Target strings are not verified. When they point to nothing, the mapped MIDI -> message will do nothing and no error is fired. - -### NumberValueNotifierFunction -(value : [`number`](../../API/builtins/number.md)) - - -### SliderNumberValue -[`number`](../../API/builtins/number.md) -> The current value of the view - -### SliderStepAmounts -{ 1 : [`number`](../../API/builtins/number.md), 2 : [`number`](../../API/builtins/number.md) } -> A table containing two numbers representing the step amounts for incrementing -> and decrementing by clicking the <> buttons. -> The first value is the small step (applied on left clicks) -> second value is the big step (applied on right clicks) - -### ValueBoxMaxValue -[`number`](../../API/builtins/number.md) -> The maximum value that can be set using the view -> * Default: 100 - -### ValueBoxMinValue -[`number`](../../API/builtins/number.md) -> The minimum value that can be set using the view -> * Default: 0 - -### ViewCursorShape -`"busy"` | `"change_value"` | `"crosshair"` | `"default"` | `"drag"` | `"drop"` | `"edit_text"` | `"empty"` | `"erase"` | `"extend_bottom"` | `"extend_bottom_alias"` | `"extend_left"` | `"extend_left_alias"` | `"extend_right"` | `"extend_right_alias"` | `"extend_top"` | `"extend_top_alias"` | `"marker"` | `"move"` | `"nodrop"` | `"none"` | `"pencil"` | `"play"` | `"resize_edge_diagonal_left"` | `"resize_edge_diagonal_right"` | `"resize_edge_horizontal"` | `"resize_edge_vertical"` | `"resize_horizontal"` | `"resize_vertical"` | `"zoom"` | `"zoom_horizontal"` | `"zoom_vertical"` -> ```lua -> -- The cursor cursor for this view which apears on mouse hover. -> -- Using a "none" shape will use use underlying view's cursor or the default cursor. -> ViewCursorShape: -> | "none" -> | "empty" -> | "default" -> | "change_value" -> | "edit_text" -> | "pencil" -> | "marker" -> | "crosshair" -> | "move" -> | "erase" -> | "play" -> | "drag" -> | "drop" -> | "nodrop" -> | "busy" -> | "resize_vertical" -> | "resize_horizontal" -> | "resize_edge_vertical" -> | "resize_edge_horizontal" -> | "resize_edge_diagonal_left" -> | "resize_edge_diagonal_right" -> | "extend_left" -> | "extend_right" -> | "extend_top" -> | "extend_bottom" -> | "extend_left_alias" -> | "extend_right_alias" -> | "extend_top_alias" -> | "extend_bottom_alias" -> | "zoom_vertical" -> | "zoom_horizontal" -> | "zoom" -> ``` - -### ViewDimension -[`string`](../../API/builtins/string.md) | [`integer`](../../API/builtins/integer.md) -> The dimensions of a view has to be larger than 0. -> For nested views you can also specify relative size -> for example `vb:text { width = "80%"}`. The percentage values are -> relative to the view's parent size and will automatically update on size changes. - -### ViewOrigin -{ 1 : [`ViewPosition`](#ViewPosition), 2 : [`ViewPosition`](#ViewPosition) } | { x : [`ViewPosition`](#ViewPosition), y : [`ViewPosition`](#ViewPosition) } -> The position of a view within its parent view. -> Only the `stack` layouts allows to freely position child views. Other -> layout views will automatically set the origin, but the origin -> then still can be read in for example mouse handlers. - -### ViewPosition -[`integer`](../../API/builtins/integer.md) -> Horizontal (x) or Vertical (y) position of a view within its parent view. - -### ViewSize -{ 1 : [`ViewDimension`](#ViewDimension), 2 : [`ViewDimension`](#ViewDimension) } | { height : [`ViewDimension`](#ViewDimension), width : [`ViewDimension`](#ViewDimension) } -> The dimensions of a view has to be larger than 0. -> For nested views you can also specify relative size, for example -> `vb:text { size = { width = "80%", height = 20}}`. -> The percentage values are relative to the view's parent size and will -> automatically update when the parent view's size changes. - -### ViewTooltip -[`string`](../../API/builtins/string.md) -> A ViewTooltip text that should be shown for this view on mouse hover. -> * Default: "" (no tip will be shown) - -### ViewVisibility -[`boolean`](../../API/builtins/boolean.md) -> Set visible to false to hide a view (make it invisible without removing -> it). Please note that view.visible will also return false when any of its -> parents are invisible (when its implicitly invisible). -> * Default: true - - diff --git a/docs/API/renoise/renoise.Views.ValueField.md b/docs/API/renoise/renoise.Views.ValueField.md deleted file mode 100644 index 1c01d1d..0000000 --- a/docs/API/renoise/renoise.Views.ValueField.md +++ /dev/null @@ -1,231 +0,0 @@ -# renoise.Views.ValueField -> A text view, which shows a string representation of a number and allows -> custom "number to string" conversion. The value's text can be edited by the -> user. -> ```lua -> +---+-------+ -> | 12.1 dB | -> +---+-------+ -> ``` - - - - ---- -## Properties -### active : [`ControlActive`](#ControlActive) -> Instead of making a control invisible, you can also make it inactive. -> Deactivated controls will still be shown, and will still show their -> currently assigned values, but will not allow changes. Most controls will -> display as "grayed out" to visualize the deactivated state. - -### midi_mapping : [`ControlMidiMappingString`](#ControlMidiMappingString) -> When set, the control will be highlighted when Renoise's MIDI mapping dialog -> is open. When clicked, it selects the specified string as a MIDI mapping -> target action. This target acton can either be one of the globally available -> mappings in Renoise, or those that were created by the tool itself. -> Target strings are not verified. When they point to nothing, the mapped MIDI -> message will do nothing and no error is fired. - -### min : [`SliderMinValue`](#SliderMinValue) -> The minimum value that can be set using the view -> * Default: 0 - -### max : [`SliderMaxValue`](#SliderMaxValue) -> The maximum value that can be set using the view -> * Default: 1.0 - -### value : [`SliderNumberValue`](#SliderNumberValue) -> The current value of the view - -### align : [`TextAlignment`](#TextAlignment) -> Setup the text's alignment. Applies only when the view's size is larger than -> the needed size to draw the text - -### visible : [`ViewVisibility`](#ViewVisibility) -> Set visible to false to hide a view (make it invisible without removing -> it). Please note that view.visible will also return false when any of its -> parents are invisible (when its implicitly invisible). -> * Default: true - -### origin : [`ViewOrigin`](#ViewOrigin) -> The position of a view within its parent view. -> Only the `stack` layouts allows to freely position child views. Other -> layout views will automatically set the origin, but the origin -> then still can be read in for example mouse handlers. - -### width : [`ViewDimension`](#ViewDimension) -> **Deprecated.** Use property `size` instead. - -### height : [`ViewDimension`](#ViewDimension) -> **Deprecated.** Use property `size` instead. - -### size : [`ViewSize`](#ViewSize) -> The dimensions of a view has to be larger than 0. -> For nested views you can also specify relative size, for example -> `vb:text { size = { width = "80%", height = 20}}`. -> The percentage values are relative to the view's parent size and will -> automatically update when the parent view's size changes. - -### tooltip : [`ViewTooltip`](#ViewTooltip) -> A ViewTooltip text that should be shown for this view on mouse hover. -> * Default: "" (no tip will be shown) - -### cursor : [`ViewCursorShape`](#ViewCursorShape) -> The cursor cursor for this view which apears on mouse hover. -> Using a "none" shape will use use underlying view's cursor or the default cursor. - -### views : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)[] -> **READ-ONLY** Empty for all controls, for layout views this contains the -> layout child views in the order they got added - - - ---- -## Functions -### add_notifier([*self*](../../API/builtins/self.md), notifier : [`NumberValueNotifierFunction`](#NumberValueNotifierFunction)) -> Add value change notifier -### remove_notifier([*self*](../../API/builtins/self.md), notifier : [`NumberValueNotifierFunction`](#NumberValueNotifierFunction)) -> Remove value change notifier -### add_view([*self*](../../API/builtins/self.md), child : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)) -> Add a new child view to this view. -### remove_view([*self*](../../API/builtins/self.md), child : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)) -> Remove a child view from this view. -### swap_views([*self*](../../API/builtins/self.md), child1 : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md), child2 : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)) -> Swap position of two child views in this view. With a series of swaps views -> can be moved to any position in the parent. -### add_child([*self*](../../API/builtins/self.md), child : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)) -> **Deprecated.** Use `add_view` instead -### remove_child([*self*](../../API/builtins/self.md), child : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)) -> **Deprecated.** Use `remove_view` instead -### swap_childs([*self*](../../API/builtins/self.md), child1 : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md), child2 : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)) -> **Deprecated.** Use `swap_views` instead - - - ---- -## Aliases -### ControlActive -[`boolean`](../../API/builtins/boolean.md) -> Instead of making a control invisible, you can also make it inactive. -> Deactivated controls will still be shown, and will still show their -> currently assigned values, but will not allow changes. Most controls will -> display as "grayed out" to visualize the deactivated state. - -### ControlMidiMappingString -[`string`](../../API/builtins/string.md) -> When set, the control will be highlighted when Renoise's MIDI mapping dialog -> is open. When clicked, it selects the specified string as a MIDI mapping -> target action. This target acton can either be one of the globally available -> mappings in Renoise, or those that were created by the tool itself. -> Target strings are not verified. When they point to nothing, the mapped MIDI -> message will do nothing and no error is fired. - -### NumberValueNotifierFunction -(value : [`number`](../../API/builtins/number.md)) - - -### SliderMaxValue -[`number`](../../API/builtins/number.md) -> The maximum value that can be set using the view -> * Default: 1.0 - -### SliderMinValue -[`number`](../../API/builtins/number.md) -> The minimum value that can be set using the view -> * Default: 0 - -### SliderNumberValue -[`number`](../../API/builtins/number.md) -> The current value of the view - -### TextAlignment -`"center"` | `"left"` | `"right"` -> ```lua -> -- Setup the text's alignment. Applies only when the view's size is larger than -> -- the needed size to draw the text -> TextAlignment: -> | "left" -- (Default) -> | "right" -- aligned to the right -> | "center" -- center text -> ``` - -### ViewCursorShape -`"busy"` | `"change_value"` | `"crosshair"` | `"default"` | `"drag"` | `"drop"` | `"edit_text"` | `"empty"` | `"erase"` | `"extend_bottom"` | `"extend_bottom_alias"` | `"extend_left"` | `"extend_left_alias"` | `"extend_right"` | `"extend_right_alias"` | `"extend_top"` | `"extend_top_alias"` | `"marker"` | `"move"` | `"nodrop"` | `"none"` | `"pencil"` | `"play"` | `"resize_edge_diagonal_left"` | `"resize_edge_diagonal_right"` | `"resize_edge_horizontal"` | `"resize_edge_vertical"` | `"resize_horizontal"` | `"resize_vertical"` | `"zoom"` | `"zoom_horizontal"` | `"zoom_vertical"` -> ```lua -> -- The cursor cursor for this view which apears on mouse hover. -> -- Using a "none" shape will use use underlying view's cursor or the default cursor. -> ViewCursorShape: -> | "none" -> | "empty" -> | "default" -> | "change_value" -> | "edit_text" -> | "pencil" -> | "marker" -> | "crosshair" -> | "move" -> | "erase" -> | "play" -> | "drag" -> | "drop" -> | "nodrop" -> | "busy" -> | "resize_vertical" -> | "resize_horizontal" -> | "resize_edge_vertical" -> | "resize_edge_horizontal" -> | "resize_edge_diagonal_left" -> | "resize_edge_diagonal_right" -> | "extend_left" -> | "extend_right" -> | "extend_top" -> | "extend_bottom" -> | "extend_left_alias" -> | "extend_right_alias" -> | "extend_top_alias" -> | "extend_bottom_alias" -> | "zoom_vertical" -> | "zoom_horizontal" -> | "zoom" -> ``` - -### ViewDimension -[`string`](../../API/builtins/string.md) | [`integer`](../../API/builtins/integer.md) -> The dimensions of a view has to be larger than 0. -> For nested views you can also specify relative size -> for example `vb:text { width = "80%"}`. The percentage values are -> relative to the view's parent size and will automatically update on size changes. - -### ViewOrigin -{ 1 : [`ViewPosition`](#ViewPosition), 2 : [`ViewPosition`](#ViewPosition) } | { x : [`ViewPosition`](#ViewPosition), y : [`ViewPosition`](#ViewPosition) } -> The position of a view within its parent view. -> Only the `stack` layouts allows to freely position child views. Other -> layout views will automatically set the origin, but the origin -> then still can be read in for example mouse handlers. - -### ViewPosition -[`integer`](../../API/builtins/integer.md) -> Horizontal (x) or Vertical (y) position of a view within its parent view. - -### ViewSize -{ 1 : [`ViewDimension`](#ViewDimension), 2 : [`ViewDimension`](#ViewDimension) } | { height : [`ViewDimension`](#ViewDimension), width : [`ViewDimension`](#ViewDimension) } -> The dimensions of a view has to be larger than 0. -> For nested views you can also specify relative size, for example -> `vb:text { size = { width = "80%", height = 20}}`. -> The percentage values are relative to the view's parent size and will -> automatically update when the parent view's size changes. - -### ViewTooltip -[`string`](../../API/builtins/string.md) -> A ViewTooltip text that should be shown for this view on mouse hover. -> * Default: "" (no tip will be shown) - -### ViewVisibility -[`boolean`](../../API/builtins/boolean.md) -> Set visible to false to hide a view (make it invisible without removing -> it). Please note that view.visible will also return false when any of its -> parents are invisible (when its implicitly invisible). -> * Default: true - - diff --git a/docs/API/renoise/renoise.Views.View.md b/docs/API/renoise/renoise.Views.View.md deleted file mode 100644 index a0f4c43..0000000 --- a/docs/API/renoise/renoise.Views.View.md +++ /dev/null @@ -1,147 +0,0 @@ -# renoise.Views.View -> View is the base class for all child views. All View properties can be -> applied to any of the following specialized views. - - - - ---- -## Properties -### visible : [`ViewVisibility`](#ViewVisibility) -> Set visible to false to hide a view (make it invisible without removing -> it). Please note that view.visible will also return false when any of its -> parents are invisible (when its implicitly invisible). -> * Default: true - -### origin : [`ViewOrigin`](#ViewOrigin) -> The position of a view within its parent view. -> Only the `stack` layouts allows to freely position child views. Other -> layout views will automatically set the origin, but the origin -> then still can be read in for example mouse handlers. - -### width : [`ViewDimension`](#ViewDimension) -> **Deprecated.** Use property `size` instead. - -### height : [`ViewDimension`](#ViewDimension) -> **Deprecated.** Use property `size` instead. - -### size : [`ViewSize`](#ViewSize) -> The dimensions of a view has to be larger than 0. -> For nested views you can also specify relative size, for example -> `vb:text { size = { width = "80%", height = 20}}`. -> The percentage values are relative to the view's parent size and will -> automatically update when the parent view's size changes. - -### tooltip : [`ViewTooltip`](#ViewTooltip) -> A ViewTooltip text that should be shown for this view on mouse hover. -> * Default: "" (no tip will be shown) - -### cursor : [`ViewCursorShape`](#ViewCursorShape) -> The cursor cursor for this view which apears on mouse hover. -> Using a "none" shape will use use underlying view's cursor or the default cursor. - -### views : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)[] -> **READ-ONLY** Empty for all controls, for layout views this contains the -> layout child views in the order they got added - - - ---- -## Functions -### add_view([*self*](../../API/builtins/self.md), child : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)) -> Add a new child view to this view. -### remove_view([*self*](../../API/builtins/self.md), child : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)) -> Remove a child view from this view. -### swap_views([*self*](../../API/builtins/self.md), child1 : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md), child2 : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)) -> Swap position of two child views in this view. With a series of swaps views -> can be moved to any position in the parent. -### add_child([*self*](../../API/builtins/self.md), child : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)) -> **Deprecated.** Use `add_view` instead -### remove_child([*self*](../../API/builtins/self.md), child : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)) -> **Deprecated.** Use `remove_view` instead -### swap_childs([*self*](../../API/builtins/self.md), child1 : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md), child2 : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)) -> **Deprecated.** Use `swap_views` instead - - - ---- -## Aliases -### ViewCursorShape -`"busy"` | `"change_value"` | `"crosshair"` | `"default"` | `"drag"` | `"drop"` | `"edit_text"` | `"empty"` | `"erase"` | `"extend_bottom"` | `"extend_bottom_alias"` | `"extend_left"` | `"extend_left_alias"` | `"extend_right"` | `"extend_right_alias"` | `"extend_top"` | `"extend_top_alias"` | `"marker"` | `"move"` | `"nodrop"` | `"none"` | `"pencil"` | `"play"` | `"resize_edge_diagonal_left"` | `"resize_edge_diagonal_right"` | `"resize_edge_horizontal"` | `"resize_edge_vertical"` | `"resize_horizontal"` | `"resize_vertical"` | `"zoom"` | `"zoom_horizontal"` | `"zoom_vertical"` -> ```lua -> -- The cursor cursor for this view which apears on mouse hover. -> -- Using a "none" shape will use use underlying view's cursor or the default cursor. -> ViewCursorShape: -> | "none" -> | "empty" -> | "default" -> | "change_value" -> | "edit_text" -> | "pencil" -> | "marker" -> | "crosshair" -> | "move" -> | "erase" -> | "play" -> | "drag" -> | "drop" -> | "nodrop" -> | "busy" -> | "resize_vertical" -> | "resize_horizontal" -> | "resize_edge_vertical" -> | "resize_edge_horizontal" -> | "resize_edge_diagonal_left" -> | "resize_edge_diagonal_right" -> | "extend_left" -> | "extend_right" -> | "extend_top" -> | "extend_bottom" -> | "extend_left_alias" -> | "extend_right_alias" -> | "extend_top_alias" -> | "extend_bottom_alias" -> | "zoom_vertical" -> | "zoom_horizontal" -> | "zoom" -> ``` - -### ViewDimension -[`string`](../../API/builtins/string.md) | [`integer`](../../API/builtins/integer.md) -> The dimensions of a view has to be larger than 0. -> For nested views you can also specify relative size -> for example `vb:text { width = "80%"}`. The percentage values are -> relative to the view's parent size and will automatically update on size changes. - -### ViewOrigin -{ 1 : [`ViewPosition`](#ViewPosition), 2 : [`ViewPosition`](#ViewPosition) } | { x : [`ViewPosition`](#ViewPosition), y : [`ViewPosition`](#ViewPosition) } -> The position of a view within its parent view. -> Only the `stack` layouts allows to freely position child views. Other -> layout views will automatically set the origin, but the origin -> then still can be read in for example mouse handlers. - -### ViewPosition -[`integer`](../../API/builtins/integer.md) -> Horizontal (x) or Vertical (y) position of a view within its parent view. - -### ViewSize -{ 1 : [`ViewDimension`](#ViewDimension), 2 : [`ViewDimension`](#ViewDimension) } | { height : [`ViewDimension`](#ViewDimension), width : [`ViewDimension`](#ViewDimension) } -> The dimensions of a view has to be larger than 0. -> For nested views you can also specify relative size, for example -> `vb:text { size = { width = "80%", height = 20}}`. -> The percentage values are relative to the view's parent size and will -> automatically update when the parent view's size changes. - -### ViewTooltip -[`string`](../../API/builtins/string.md) -> A ViewTooltip text that should be shown for this view on mouse hover. -> * Default: "" (no tip will be shown) - -### ViewVisibility -[`boolean`](../../API/builtins/boolean.md) -> Set visible to false to hide a view (make it invisible without removing -> it). Please note that view.visible will also return false when any of its -> parents are invisible (when its implicitly invisible). -> * Default: true - - diff --git a/docs/API/renoise/renoise.Views.XYPad.md b/docs/API/renoise/renoise.Views.XYPad.md deleted file mode 100644 index 7dd2c92..0000000 --- a/docs/API/renoise/renoise.Views.XYPad.md +++ /dev/null @@ -1,251 +0,0 @@ -# renoise.Views.XYPad -> A slider like pad which allows for controlling two values at once. By default -> it freely moves the XY values, but it can also be configured to snap back to -> a predefined value when releasing the mouse button. -> -> All values, notifiers, current value or min/max properties will act just -> like a slider or a rotary's properties, but nstead of a single number, a -> table with the fields `{x = xvalue, y = yvalue}` is expected, returned. -> ```text -> +-------+ -> | o | -> | + | -> | | -> +-------+ -> ``` - - - - ---- -## Properties -### active : [`ControlActive`](#ControlActive) -> Instead of making a control invisible, you can also make it inactive. -> Deactivated controls will still be shown, and will still show their -> currently assigned values, but will not allow changes. Most controls will -> display as "grayed out" to visualize the deactivated state. - -### midi_mapping : [`ControlMidiMappingString`](#ControlMidiMappingString) -> When set, the control will be highlighted when Renoise's MIDI mapping dialog -> is open. When clicked, it selects the specified string as a MIDI mapping -> target action. This target acton can either be one of the globally available -> mappings in Renoise, or those that were created by the tool itself. -> Target strings are not verified. When they point to nothing, the mapped MIDI -> message will do nothing and no error is fired. - -### visible : [`ViewVisibility`](#ViewVisibility) -> Set visible to false to hide a view (make it invisible without removing -> it). Please note that view.visible will also return false when any of its -> parents are invisible (when its implicitly invisible). -> * Default: true - -### origin : [`ViewOrigin`](#ViewOrigin) -> The position of a view within its parent view. -> Only the `stack` layouts allows to freely position child views. Other -> layout views will automatically set the origin, but the origin -> then still can be read in for example mouse handlers. - -### width : [`ViewDimension`](#ViewDimension) -> **Deprecated.** Use property `size` instead. - -### height : [`ViewDimension`](#ViewDimension) -> **Deprecated.** Use property `size` instead. - -### size : [`ViewSize`](#ViewSize) -> The dimensions of a view has to be larger than 0. -> For nested views you can also specify relative size, for example -> `vb:text { size = { width = "80%", height = 20}}`. -> The percentage values are relative to the view's parent size and will -> automatically update when the parent view's size changes. - -### tooltip : [`ViewTooltip`](#ViewTooltip) -> A ViewTooltip text that should be shown for this view on mouse hover. -> * Default: "" (no tip will be shown) - -### cursor : [`ViewCursorShape`](#ViewCursorShape) -> The cursor cursor for this view which apears on mouse hover. -> Using a "none" shape will use use underlying view's cursor or the default cursor. - -### views : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)[] -> **READ-ONLY** Empty for all controls, for layout views this contains the -> layout child views in the order they got added - -### min : [`XYPadMinValues`](#XYPadMinValues) -> A table of allowed minimum values for each axis -> * Default: {x: 0.0, y: 0.0} - -### max : [`XYPadMaxValues`](#XYPadMaxValues) -> A table of allowed maximum values for each axis -> * Default: {x: 1.0, y: 1.0} - -### value : [`XYPadValues`](#XYPadValues) -> A table of the XYPad's current values on each axis - -### snapback : [`XYPadSnapbackValues`](#XYPadSnapbackValues)[`?`](../../API/builtins/nil.md) -> A table of snapback values for each axis -> When snapback is enabled, the pad will revert its values to the specified -> snapback values as soon as the mouse button is released in the pad. -> When disabled, releasing the mouse button will not change the value. -> You can disable snapback at runtime by setting it to nil or an empty table. - - - ---- -## Functions -### add_view([*self*](../../API/builtins/self.md), child : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)) -> Add a new child view to this view. -### remove_view([*self*](../../API/builtins/self.md), child : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)) -> Remove a child view from this view. -### swap_views([*self*](../../API/builtins/self.md), child1 : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md), child2 : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)) -> Swap position of two child views in this view. With a series of swaps views -> can be moved to any position in the parent. -### add_child([*self*](../../API/builtins/self.md), child : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)) -> **Deprecated.** Use `add_view` instead -### remove_child([*self*](../../API/builtins/self.md), child : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)) -> **Deprecated.** Use `remove_view` instead -### swap_childs([*self*](../../API/builtins/self.md), child1 : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md), child2 : [`renoise.Views.View`](../../API/renoise/renoise.Views.View.md)) -> **Deprecated.** Use `swap_views` instead -### add_notifier([*self*](../../API/builtins/self.md), notifier : [`XYValueNotifierFunction`](#XYValueNotifierFunction)) -> Add value change notifier -### remove_notifier([*self*](../../API/builtins/self.md), notifier : [`XYValueNotifierFunction`](#XYValueNotifierFunction)) -> Remove value change notifier - - - ---- -## Aliases -### ControlActive -[`boolean`](../../API/builtins/boolean.md) -> Instead of making a control invisible, you can also make it inactive. -> Deactivated controls will still be shown, and will still show their -> currently assigned values, but will not allow changes. Most controls will -> display as "grayed out" to visualize the deactivated state. - -### ControlMidiMappingString -[`string`](../../API/builtins/string.md) -> When set, the control will be highlighted when Renoise's MIDI mapping dialog -> is open. When clicked, it selects the specified string as a MIDI mapping -> target action. This target acton can either be one of the globally available -> mappings in Renoise, or those that were created by the tool itself. -> Target strings are not verified. When they point to nothing, the mapped MIDI -> message will do nothing and no error is fired. - -### SliderMaxValue -[`number`](../../API/builtins/number.md) -> The maximum value that can be set using the view -> * Default: 1.0 - -### SliderMinValue -[`number`](../../API/builtins/number.md) -> The minimum value that can be set using the view -> * Default: 0 - -### SliderNumberValue -[`number`](../../API/builtins/number.md) -> The current value of the view - -### ViewCursorShape -`"busy"` | `"change_value"` | `"crosshair"` | `"default"` | `"drag"` | `"drop"` | `"edit_text"` | `"empty"` | `"erase"` | `"extend_bottom"` | `"extend_bottom_alias"` | `"extend_left"` | `"extend_left_alias"` | `"extend_right"` | `"extend_right_alias"` | `"extend_top"` | `"extend_top_alias"` | `"marker"` | `"move"` | `"nodrop"` | `"none"` | `"pencil"` | `"play"` | `"resize_edge_diagonal_left"` | `"resize_edge_diagonal_right"` | `"resize_edge_horizontal"` | `"resize_edge_vertical"` | `"resize_horizontal"` | `"resize_vertical"` | `"zoom"` | `"zoom_horizontal"` | `"zoom_vertical"` -> ```lua -> -- The cursor cursor for this view which apears on mouse hover. -> -- Using a "none" shape will use use underlying view's cursor or the default cursor. -> ViewCursorShape: -> | "none" -> | "empty" -> | "default" -> | "change_value" -> | "edit_text" -> | "pencil" -> | "marker" -> | "crosshair" -> | "move" -> | "erase" -> | "play" -> | "drag" -> | "drop" -> | "nodrop" -> | "busy" -> | "resize_vertical" -> | "resize_horizontal" -> | "resize_edge_vertical" -> | "resize_edge_horizontal" -> | "resize_edge_diagonal_left" -> | "resize_edge_diagonal_right" -> | "extend_left" -> | "extend_right" -> | "extend_top" -> | "extend_bottom" -> | "extend_left_alias" -> | "extend_right_alias" -> | "extend_top_alias" -> | "extend_bottom_alias" -> | "zoom_vertical" -> | "zoom_horizontal" -> | "zoom" -> ``` - -### ViewDimension -[`string`](../../API/builtins/string.md) | [`integer`](../../API/builtins/integer.md) -> The dimensions of a view has to be larger than 0. -> For nested views you can also specify relative size -> for example `vb:text { width = "80%"}`. The percentage values are -> relative to the view's parent size and will automatically update on size changes. - -### ViewOrigin -{ 1 : [`ViewPosition`](#ViewPosition), 2 : [`ViewPosition`](#ViewPosition) } | { x : [`ViewPosition`](#ViewPosition), y : [`ViewPosition`](#ViewPosition) } -> The position of a view within its parent view. -> Only the `stack` layouts allows to freely position child views. Other -> layout views will automatically set the origin, but the origin -> then still can be read in for example mouse handlers. - -### ViewPosition -[`integer`](../../API/builtins/integer.md) -> Horizontal (x) or Vertical (y) position of a view within its parent view. - -### ViewSize -{ 1 : [`ViewDimension`](#ViewDimension), 2 : [`ViewDimension`](#ViewDimension) } | { height : [`ViewDimension`](#ViewDimension), width : [`ViewDimension`](#ViewDimension) } -> The dimensions of a view has to be larger than 0. -> For nested views you can also specify relative size, for example -> `vb:text { size = { width = "80%", height = 20}}`. -> The percentage values are relative to the view's parent size and will -> automatically update when the parent view's size changes. - -### ViewTooltip -[`string`](../../API/builtins/string.md) -> A ViewTooltip text that should be shown for this view on mouse hover. -> * Default: "" (no tip will be shown) - -### ViewVisibility -[`boolean`](../../API/builtins/boolean.md) -> Set visible to false to hide a view (make it invisible without removing -> it). Please note that view.visible will also return false when any of its -> parents are invisible (when its implicitly invisible). -> * Default: true - -### XYPadMaxValues -{ x : [`SliderMaxValue`](#SliderMaxValue), y : [`SliderMaxValue`](#SliderMaxValue) } -> A table of allowed maximum values for each axis -> * Default: {x: 1.0, y: 1.0} - -### XYPadMinValues -{ x : [`SliderMinValue`](#SliderMinValue), y : [`SliderMinValue`](#SliderMinValue) } -> A table of allowed minimum values for each axis -> * Default: {x: 0.0, y: 0.0} - -### XYPadSnapbackValues -{ x : [`number`](../../API/builtins/number.md), y : [`number`](../../API/builtins/number.md) } -> A table of snapback values for each axis -> When snapback is enabled, the pad will revert its values to the specified -> snapback values as soon as the mouse button is released in the pad. -> When disabled, releasing the mouse button will not change the value. -> You can disable snapback at runtime by setting it to nil or an empty table. - -### XYPadValues -{ x : [`SliderNumberValue`](#SliderNumberValue), y : [`SliderNumberValue`](#SliderNumberValue) } -> A table of the XYPad's current values on each axis - -### XYValueNotifierFunction -(value : [`XYPadValues`](#XYPadValues)) - - - diff --git a/docs/API/renoise/renoise.Views.md b/docs/API/renoise/renoise.Views.md deleted file mode 100644 index c60ed78..0000000 --- a/docs/API/renoise/renoise.Views.md +++ /dev/null @@ -1,6 +0,0 @@ -# renoise.Views -> Namespace for renoise view widgets. - - - - From 2eb6a7f3c470e1a3dfab267d84d13dd0df768f37 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Eduard=20M=C3=BCller?= Date: Wed, 23 Sep 2026 16:42:16 +0200 Subject: [PATCH 02/12] update definitions --- definitions | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/definitions b/definitions index 684c9e8..2fe2fe9 160000 --- a/definitions +++ b/definitions @@ -1 +1 @@ -Subproject commit 684c9e855362ea5be4300fd5179c1b2d3fb1a77a +Subproject commit 2fe2fe92d7885f3b70e9ad378c50d329387751bd From 99d52b0d53842fb3063b9742fc29587e9e6040d6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Eduard=20M=C3=BCller?= Date: Wed, 23 Sep 2026 16:42:42 +0200 Subject: [PATCH 03/12] update dependencies --- .github/workflows/pages.yml | 6 +++--- BUILD.md | 4 ++-- generate/Cargo.toml | 2 +- 3 files changed, 6 insertions(+), 6 deletions(-) diff --git a/.github/workflows/pages.yml b/.github/workflows/pages.yml index 467695f..86408ee 100644 --- a/.github/workflows/pages.yml +++ b/.github/workflows/pages.yml @@ -16,12 +16,12 @@ jobs: - name: Install Rust uses: actions-rust-lang/setup-rust-toolchain@v1 - with: + with: cache-workspaces: "docs" cache-key: "renoise-xrnx" - name: Install mdbook - run: cargo install mdbook@0.4.51 mdbook-linkcheck@0.7.5 mdbook-toc@0.14.2 mdbook-alerts@0.8.0 + run: cargo install mdbook@0.4 mdbook-linkcheck@0.7 mdbook-toc@0.14 mdbook-alerts@0.8 - name: Build the API run: cargo run @@ -34,7 +34,7 @@ jobs: with: name: github-pages path: ./book/html - + deploy: # Add a dependency to the build job needs: build diff --git a/BUILD.md b/BUILD.md index a7fce69..f87ef71 100644 --- a/BUILD.md +++ b/BUILD.md @@ -6,7 +6,7 @@ The docs are generated using [mdBook](https://github.com/rust-lang/mdBook). To p ```sh # or `binstall`, to fetch latest binaries -cargo install mdbook mdbook-linkcheck mdbook-toc mdbook-alerts +cargo install mdbook@0.4 mdbook-linkcheck@0.7 mdbook-toc@0.14 mdbook-alerts@0.8 ``` ### Building @@ -19,4 +19,4 @@ mdbook serve --open ### Generate API reference -See [generate/README.md](./generate/README.md) \ No newline at end of file +See [generate/README.md](./generate/README.md) diff --git a/generate/Cargo.toml b/generate/Cargo.toml index e45944b..6ffc1a1 100644 --- a/generate/Cargo.toml +++ b/generate/Cargo.toml @@ -5,4 +5,4 @@ edition = "2021" [dependencies] # luals-docs-gen = { path = "../../Crates/luals-docs-gen" } -luals-docs-gen = { git = "https://github.com/emuell/luals-docs-gen", tag = "v0.2.2" } +luals-docs-gen = { git = "https://github.com/emuell/luals-docs-gen", tag = "v0.2.3" } From 6e1bf9378158f2ed2302708a079f97637253037d Mon Sep 17 00:00:00 2001 From: unless Date: Thu, 24 Sep 2026 18:33:18 +0200 Subject: [PATCH 04/12] remove autogenerated renoise.md --- docs/API/renoise.md | 45 --------------------------------------------- 1 file changed, 45 deletions(-) delete mode 100644 docs/API/renoise.md diff --git a/docs/API/renoise.md b/docs/API/renoise.md deleted file mode 100644 index 22cd834..0000000 --- a/docs/API/renoise.md +++ /dev/null @@ -1,45 +0,0 @@ -# renoise -> Holds all renoise related API functions and classes. - - - -## Constants - -### API_VERSION : [`number`](../API/builtins/number.md) -> Currently 6.2. Any changes in the API which are not backwards compatible, -> will increase the internal API's major version number (e.g. from 1.4 -> 2.0). -> All other backwards compatible changes, like new functionality, new functions -> and classes which do not break existing scripts, will increase only the minor -> version number (e.g. 1.0 -> 1.1). - -### RENOISE_VERSION : [`string`](../API/builtins/string.md) -> Renoise Version "Major.Minor.Revision[AlphaBetaRcVersion][Demo]" - - ---- -## Functions -### `ViewBuilder()` -`->`[`renoise.ViewBuilder`](../API/renoise/renoise.ViewBuilder.md) - -> Construct a new viewbuilder instance you can use to create views. -### `app()` -`->`[`renoise.Application`](../API/renoise/renoise.Application.md) - -> Global access to the Renoise Application. -### `song()` -`->`[`renoise.Song`](../API/renoise/renoise.Song.md)[`?`](../API/builtins/nil.md) - -> Global access to the Renoise Song. -> -> NB: The song instance changes when a new song is loaded or created in Renoise, -> so tools can not memorize the song instance globally once, but must instead -> react on the application's `new_document_observable` -> observable. -### `tool()` -`->`[`renoise.ScriptingTool`](../API/renoise/renoise.ScriptingTool.md) - -> Global access to the Renoise Scripting Tool (your XRNX tool). -> -> This is only valid when getting called from a tool and not when e.g. using the -> scripting terminal and editor in Renoise. - From 907d60f336f104cca523f01adf2f9ff989635ef9 Mon Sep 17 00:00:00 2001 From: unless Date: Thu, 24 Sep 2026 18:33:38 +0200 Subject: [PATCH 05/12] fix links to api readme --- docs/guide/observables.md | 2 +- docs/start/installing.md | 2 +- docs/start/possibilities.md | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/guide/observables.md b/docs/guide/observables.md index 960731d..cd8da5c 100644 --- a/docs/guide/observables.md +++ b/docs/guide/observables.md @@ -2,7 +2,7 @@ The Renoise API makes extensive use of the [Observer pattern](https://en.wikipedia.org/wiki/Observer_pattern). In short, many values are wrapped in "Observable" objects. You can register "notifier" functions on these objects, which will be called whenever the underlying value changes. This is a powerful way to react to changes in the application state without constantly polling and comparing values. -When browsing the [API documentation](../API/README.md), you will find many properties with an `_observable` suffix. Let's see how to use this feature by attaching a notifier that runs when the user loads a new song. +When browsing the [API documentation](../API/), you will find many properties with an `_observable` suffix. Let's see how to use this feature by attaching a notifier that runs when the user loads a new song. ```lua local function on_new_document() diff --git a/docs/start/installing.md b/docs/start/installing.md index ffd64be..ae69ef8 100644 --- a/docs/start/installing.md +++ b/docs/start/installing.md @@ -8,4 +8,4 @@ You can install any tool by dragging its folder (or a zip file with the `.xrnx` -After you've installed a tool, it will be activated automatically. When in doubt, click the *Tools / Reload All Tools*. \ No newline at end of file +After you've installed a tool, it will be activated automatically. When in doubt, click the *Tools / Reload All Tools*. diff --git a/docs/start/possibilities.md b/docs/start/possibilities.md index ad30d68..5f861ad 100644 --- a/docs/start/possibilities.md +++ b/docs/start/possibilities.md @@ -1,6 +1,6 @@ # Possibilities -Before you delve into writing your own scripts and tools, it worth considering what is even possible to do with them. In general, you can automate and manage different aspects Renoise, add or modify song data using algorithms or create interfaces to connect with other software or hardware. You can see some examples below about what you can access inside Renoise, for a complete reference, check out the [API Definitions](../API/README.md). +Before you delve into writing your own scripts and tools, it worth considering what is even possible to do with them. In general, you can automate and manage different aspects Renoise, add or modify song data using algorithms or create interfaces to connect with other software or hardware. You can see some examples below about what you can access inside Renoise, for a complete reference, check out the [API Definitions](../API/). ### Process song data * Generate, modify or filter notes, patterns or phrases From aa9095aee0977f124d4723cb07e34f074a79ec4a Mon Sep 17 00:00:00 2001 From: unless Date: Thu, 24 Sep 2026 18:33:50 +0200 Subject: [PATCH 06/12] fix missing logo --- docs/SUMMARY.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md index 4639866..58ac28d 100644 --- a/docs/SUMMARY.md +++ b/docs/SUMMARY.md @@ -1,4 +1,4 @@ -Renoise +Renoise - [Introduction](start/README.md) - [Possibilities and Limitations](start/possibilities.md) @@ -130,8 +130,10 @@ - [table](API/modules/table.md) - [Builtin Types](API/builtins.md) - [any](API/builtins/any.md) + - [array](API/builtins/array.md) - [boolean](API/builtins/boolean.md) - [function](API/builtins/function.md) + - [generic](API/builtins/generic.md) - [integer](API/builtins/integer.md) - [lightuserdata](API/builtins/lightuserdata.md) - [nil](API/builtins/nil.md) From f3dd54bc63b5185b6049dc3f22fb37664cc809be Mon Sep 17 00:00:00 2001 From: unless Date: Thu, 24 Sep 2026 18:34:36 +0200 Subject: [PATCH 07/12] drop mdbook deps, update to mdbook 0.5, use lychee for link checking --- .github/workflows/pages.yml | 8 +++++++- .gitignore | 3 ++- book.toml | 8 +------- 3 files changed, 10 insertions(+), 9 deletions(-) diff --git a/.github/workflows/pages.yml b/.github/workflows/pages.yml index 86408ee..428f74e 100644 --- a/.github/workflows/pages.yml +++ b/.github/workflows/pages.yml @@ -21,7 +21,7 @@ jobs: cache-key: "renoise-xrnx" - name: Install mdbook - run: cargo install mdbook@0.4 mdbook-linkcheck@0.7 mdbook-toc@0.14 mdbook-alerts@0.8 + run: cargo install mdbook@0.5 - name: Build the API run: cargo run @@ -29,6 +29,12 @@ jobs: - name: Build the book run: mdbook build + - name: Validate links + uses: lycheeverse/lychee-action@v2 + with: + args: --no-progress --offline --root-dir "$GITHUB_WORKSPACE/book" book + fail: true + - name: Upload uses: actions/upload-pages-artifact@v3 with: diff --git a/.gitignore b/.gitignore index 5d410e4..ec950de 100644 --- a/.gitignore +++ b/.gitignore @@ -3,8 +3,9 @@ Cargo.lock /dist/ /docs/API/builtins /docs/API/renoise +/docs/API/renoise.md /docs/API/modules /generate/Cargo.lock /generate/target/ /generate/lua-language-server/ -/target/ \ No newline at end of file +/target/ diff --git a/book.toml b/book.toml index c9fa279..aa1bfb2 100644 --- a/book.toml +++ b/book.toml @@ -1,7 +1,6 @@ [book] authors = ["renoise"] language = "en" -multilingual = false src = "docs" title = "Renoise Scripting" @@ -12,12 +11,7 @@ create-missing = false default-theme = "dark" preferred-dark-theme = "ayu" git-repository-url = "https://github.com/renoise/xrnx" -git-repository-icon = "fa-github" edit-url-template = "https://github.com/renoise/xrnx/edit/master/{path}" additional-css = [ "docs/styles.css" ] +sidebar-header-nav = false -[output.linkcheck] -warning-policy = "ignore" - -[preprocessor.toc] -[preprocessor.alerts] \ No newline at end of file From 3c747f5959e5609af8a4bf97b58a29936a446912 Mon Sep 17 00:00:00 2001 From: unless Date: Thu, 24 Sep 2026 18:34:45 +0200 Subject: [PATCH 08/12] increate search results limit --- book.toml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/book.toml b/book.toml index aa1bfb2..87c9b88 100644 --- a/book.toml +++ b/book.toml @@ -15,3 +15,5 @@ edit-url-template = "https://github.com/renoise/xrnx/edit/master/{path}" additional-css = [ "docs/styles.css" ] sidebar-header-nav = false +[output.html.search] +limit-results = 100 From ba2e0ffe3c2a928d7aafe8203ec65611e6e1c9f0 Mon Sep 17 00:00:00 2001 From: unless Date: Thu, 24 Sep 2026 18:38:33 +0200 Subject: [PATCH 09/12] update archive workflow --- .github/workflows/archive.yml | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/.github/workflows/archive.yml b/.github/workflows/archive.yml index ff55a8d..7cd0349 100644 --- a/.github/workflows/archive.yml +++ b/.github/workflows/archive.yml @@ -26,7 +26,7 @@ jobs: cache-key: "renoise-xrnx" - name: Install mdbook - run: cargo install mdbook@0.4.51 mdbook-linkcheck@0.7.5 mdbook-toc@0.14.2 mdbook-alerts@0.8.0 + run: cargo install mdbook@0.5 - name: Build the API run: cargo run @@ -34,11 +34,17 @@ jobs: - name: Build the book run: mdbook build + - name: Validate links + uses: lycheeverse/lychee-action@v2 + with: + args: --no-progress --offline --root-dir "$GITHUB_WORKSPACE/book" book + fail: true + - name: Create XRNX_Starter_Pack run: | mkdir dist cp -rf definitions dist/definitions - cp -rf book/html dist/docs + cp -rf book dist/docs cp -rf tools dist/tools rm -rf dist/*/.git dist/*/.gitignore echo -e '\n\n\n\n' > dist/docs.html From 57bed5031e1918786d8a0b16adabea56ddfe400e Mon Sep 17 00:00:00 2001 From: unless Date: Thu, 24 Sep 2026 18:40:08 +0200 Subject: [PATCH 10/12] fix mdbook semver --- .github/workflows/archive.yml | 2 +- .github/workflows/pages.yml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/archive.yml b/.github/workflows/archive.yml index 7cd0349..9bcbd6a 100644 --- a/.github/workflows/archive.yml +++ b/.github/workflows/archive.yml @@ -26,7 +26,7 @@ jobs: cache-key: "renoise-xrnx" - name: Install mdbook - run: cargo install mdbook@0.5 + run: cargo install mdbook@^0.5 - name: Build the API run: cargo run diff --git a/.github/workflows/pages.yml b/.github/workflows/pages.yml index 428f74e..0ded808 100644 --- a/.github/workflows/pages.yml +++ b/.github/workflows/pages.yml @@ -21,7 +21,7 @@ jobs: cache-key: "renoise-xrnx" - name: Install mdbook - run: cargo install mdbook@0.5 + run: cargo install mdbook@^0.5 - name: Build the API run: cargo run From 40b5d15d3fb2fda24a75a657943020bd4ecb705c Mon Sep 17 00:00:00 2001 From: Eduard Mueller Date: Fri, 25 Sep 2026 21:57:12 +0200 Subject: [PATCH 11/12] update mdbook dependencies --- BUILD.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/BUILD.md b/BUILD.md index f87ef71..8dd02fd 100644 --- a/BUILD.md +++ b/BUILD.md @@ -5,8 +5,7 @@ The docs are generated using [mdBook](https://github.com/rust-lang/mdBook). To preview the pages locally you will need [cargo](https://doc.rust-lang.org/cargo/getting-started/installation.html) to install mdbook, mdbook-linkcheck and mdbook-toc. ```sh -# or `binstall`, to fetch latest binaries -cargo install mdbook@0.4 mdbook-linkcheck@0.7 mdbook-toc@0.14 mdbook-alerts@0.8 +cargo install mdbook@^0.5 # or `binstall` to fetch binaries ``` ### Building From d69b563b2d5f3f2518eea83f6f2a1249b13c5776 Mon Sep 17 00:00:00 2001 From: Eduard Mueller Date: Fri, 25 Sep 2026 22:02:19 +0200 Subject: [PATCH 12/12] use luals-docs-gen v0.3.0 --- generate/Cargo.toml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/generate/Cargo.toml b/generate/Cargo.toml index 6ffc1a1..e689508 100644 --- a/generate/Cargo.toml +++ b/generate/Cargo.toml @@ -5,4 +5,4 @@ edition = "2021" [dependencies] # luals-docs-gen = { path = "../../Crates/luals-docs-gen" } -luals-docs-gen = { git = "https://github.com/emuell/luals-docs-gen", tag = "v0.2.3" } +luals-docs-gen = { git = "https://github.com/emuell/luals-docs-gen", tag = "v0.3.0" }