Struct pixel_widgets::backend::wgpu::Ui

pub struct Ui<C: 'static + Component> { /* fields omitted */ }

Wrapper for Ui that adds wgpu rendering. Requires the “wgpu” feature.

Implementations

impl<C: Component> Ui<C>

pub fn new<S, E>(
    root_component: C,
    viewport: Rectangle,
    hidpi_scale: f32,
    style: S,
    format: TextureFormat,
    device: &Device
) -> Result<Self> where
    S: TryInto<Style, Error = E>,
    Error: From<E>, 

Constructs a new Ui. Returns an error if the style fails to load.

pub fn draw<'a>(
    &'a mut self,
    device: &Device,
    queue: &Queue,
    render_pass: &mut RenderPass<'a>
)

Draw the ui to a RenderPass. The device must be the same as the one passed to new(). The render_pass render target must be compatible with the texture_format passed to new.

Methods from Deref<Target = Ui<C>>

pub fn update_and_poll(
    &mut self,
    message: C::Message,
    waker: Waker
) -> Vec<C::Output>

Updates the root component with a message.

If the ui has any pending futures internally, they are polled using the waker. Returns output messages from the root component if the update or the poll yielded any.

It’s up to the user to make sure that the waker will schedule a call to poll() on this Ui.

pub fn handle_event_and_poll(
    &mut self,
    event: Event,
    waker: Waker
) -> Vec<C::Output>

Handles a ui Event.

If the ui has any pending futures internally, they are polled using the waker. Returns output messages from the root component if the event or the poll yielded any.

It’s up to the user to make sure that the waker will schedule a call to poll() on this Ui.

pub fn poll(&mut self, waker: Waker) -> Vec<C::Output>

If the ui has any pending futures internally, this method will poll them using the waker. Returns output messages from the root component if the poll yielded any.

It’s up to the user to make sure that the waker will schedule another call to poll().

pub fn resize(&mut self, viewport: Rectangle)

Resizes the viewport. This forces the view to be rerendered.

pub fn needs_redraw(&self) -> bool

Returns true if the ui needs to be redrawn. If the ui doesn’t need to be redrawn the Commands from the last draw may be used again.

pub fn draw(&mut self) -> DrawList

Generate a DrawList for the view.

Trait Implementations

impl<C: Component> Deref for Ui<C>

type Target = Ui<C>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<C: Component> DerefMut for Ui<C>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.