Skip to main content

BuiltinEditor

Struct BuiltinEditor 

Source
pub struct BuiltinEditor<P: Params> { /* private fields */ }
Expand description

Built-in editor that renders parameter widgets to a pixel buffer.

Uses the CPU backend (tiny-skia) for software rasterization. When open() is called, creates a platform view and blits pixels at ~60fps.

Implementations§

Source§

impl<P: Params + 'static> BuiltinEditor<P>

Source

pub fn new(params: Arc<P>, layout: PluginLayout) -> Self

Source

pub fn new_with_layout(params: Arc<P>, layout: Layout) -> Self

Source

pub fn new_grid(params: Arc<P>, layout: GridLayout) -> Self

Source

pub fn with_theme(self, theme: Theme) -> Self

Source

pub fn render(&mut self)

Render the full UI to the internal CPU pixel buffer.

Source

pub fn pixel_data(&self) -> Option<&[u8]>

Get the raw pixel data after rendering (RGBA premultiplied).

Source

pub fn set_context(&mut self, context: EditorContext)

Set the editor context (host callbacks) without opening the CPU view.

Source

pub fn render_to(&mut self, backend: &mut dyn RenderBackend)

Render all widgets to an external RenderBackend.

Used by truce-gpu to draw through the GPU backend instead of the internal CPU backend.

Source

pub fn on_mouse_down(&mut self, x: f32, y: f32)

Source

pub fn on_mouse_dragged(&mut self, x: f32, y: f32)

Source

pub fn on_mouse_up(&mut self, _x: f32, _y: f32)

Source

pub fn on_double_click(&mut self, x: f32, y: f32)

Source

pub fn on_scroll(&mut self, x: f32, y: f32, delta_y: f32)

Source

pub fn on_mouse_moved(&mut self, x: f32, y: f32) -> bool

Trait Implementations§

Source§

impl<P: Params + 'static> Editor for BuiltinEditor<P>

Source§

fn size(&self) -> (u32, u32)

Initial window size in logical points. Read more
Source§

fn open(&mut self, parent: RawWindowHandle, context: EditorContext)

Create the GUI as a child of the host-provided parent window.
Source§

fn close(&mut self)

Destroy the GUI.
Source§

fn idle(&mut self)

Called ~60fps on the host’s UI thread for repaint/animation.
Source§

fn set_size(&mut self, _width: u32, _height: u32) -> bool

Host requests a resize. Return true to accept.
Source§

fn can_resize(&self) -> bool

Whether the plugin supports resizing.
Source§

fn set_scale_factor(&mut self, _factor: f64)

DPI scale factor changed.
Source§

impl<P: Params> Send for BuiltinEditor<P>

Auto Trait Implementations§

§

impl<P> Freeze for BuiltinEditor<P>

§

impl<P> !RefUnwindSafe for BuiltinEditor<P>

§

impl<P> !Sync for BuiltinEditor<P>

§

impl<P> Unpin for BuiltinEditor<P>

§

impl<P> UnsafeUnpin for BuiltinEditor<P>

§

impl<P> !UnwindSafe for BuiltinEditor<P>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.