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.
.--. .'_\/_'. '. /\ .' "||" || /\ /\ ||//\) (/\\||/ ______\||/_______
- Properties
- Functions
- update(self)
- add_view(self, child :
renoise.Views.View
) - remove_view(self, child :
renoise.Views.View
) - swap_views(self, child1 :
renoise.Views.View
, child2 :renoise.Views.View
) - add_child(self, child :
renoise.Views.View
) - remove_child(self, child :
renoise.Views.View
) - swap_childs(self, child1 :
renoise.Views.View
, child2 :renoise.Views.View
)
- Aliases
Properties
mode : 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
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
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
Deprecated. Use property
size
instead.
height : ViewDimension
Deprecated. Use property
size
instead.
size : 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
A ViewTooltip text that should be shown for this view on mouse hover.
- Default: "" (no tip will be shown)
cursor : 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
[]
READ-ONLY Empty for all controls, for layout views this contains the layout child views in the order they got added
Functions
update(self)
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, child : renoise.Views.View
)
Add a new child view to this view.
remove_view(self, child : renoise.Views.View
)
Remove a child view from this view.
swap_views(self, child1 : renoise.Views.View
, child2 : renoise.Views.View
)
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, child : renoise.Views.View
)
Deprecated. Use
add_view
instead
remove_child(self, child : renoise.Views.View
)
Deprecated. Use
remove_view
instead
swap_childs(self, child1 : renoise.Views.View
, child2 : renoise.Views.View
)
Deprecated. Use
swap_views
instead
Aliases
CanvasMode
"plain"
| "transparent"
-- 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"
-- 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
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
, 2 : ViewPosition
} | { x : ViewPosition
, y : 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
Horizontal (x) or Vertical (y) position of a view within its parent view.
ViewSize
{ 1 : ViewDimension
, 2 : ViewDimension
} | { height : ViewDimension
, width : 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
A ViewTooltip text that should be shown for this view on mouse hover.
- Default: "" (no tip will be shown)
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