Struct Viewer

#[repr(C)]
pub struct Viewer {
    pub gpu_res: Option<GpuResources>,
    pub camera: Camera,
    pub scene: Scene,
    pub config: Config,
    pub runner: Runner,
    pub plugins: Plugins,
    /* private fields */
}

Viewer encapsulates the window and event managing of the app. The viewer contains a Window, a Scene and a Renderer. Typically the viewer is used by calling Viewer::run which automatically spins a rendering loop and processes keyboard and mouse events. The rendering loop can also be created manually by running Viewer::update in a loop {}

Fields

gpu_res: Option<GpuResources>

camera: Camera

scene: Scene

config: Config

runner: Runner

plugins: Plugins

Implementations

impl Viewer

pub fn new(config_path: Option<&str>) -> Self

pub fn new_with_config(config: &Config) -> Self

pub fn request_redraw(&mut self)

pub fn update(&mut self)

Runs only one update of the rendering loop by processing events and rendering a single frame. Useful for cases when the rendering loop needs to be created manually. WASM cannot compile this because of internal calls to run_return()

pub fn update_offscreen_texture(&mut self)

pub fn start_frame(&mut self) -> Duration

pub fn render(&mut self) -> Result<(), SurfaceError>

Panics

Will panic if the gpu_resources have not been created

Errors

Will return error if the surface texture cannot be adquired

pub fn render_to_texture(&mut self) -> Result<(), SurfaceError>

Panics

Will panic if the gpu_resources have not been created

Errors

Will return error if the surface texture cannot be adquired

pub fn run(&mut self)

Runs the rendering loop automatically. This function does not return as it will take full control of the loop. If you need to still have control over the loop use Viewer::update

pub fn run_static_ref(&'static mut self)

Same as the run function but uses a static reference to the Viewer. Useful for web apps when the viewer is a static member.

pub fn recreate_event_loop(&mut self)

if the event loop is running we can call this to destroy everything and be able to call viewer.run() again and potentially connect to a new canvas

pub fn stop_event_loop(&self)

pub fn suspend(&mut self)

pub fn warmup(&mut self)

pub fn reset_for_first_time(&mut self)

pub fn add_logic_system(&mut self, sys: LogicSystem)

pub fn add_gui_system(&mut self, sys: GuiSystem)

pub fn run_manual_plugins(&mut self)

pub fn insert_plugin<T: Plugin + 'static>(&mut self, plugin: &T)

pub fn wait_gpu_finish(&self) -> MaintainResult

Panics

Will panic if the gpu_resources have not been created

pub fn override_dt(&mut self, new_dt: f32)

pub fn get_final_tex(&self) -> &Texture

pub fn get_final_depth(&self) -> &Texture

Trait Implementations

impl ApplicationHandler<CustomEvent> for Viewer

fn resumed(&mut self, event_loop: &ActiveEventLoop)

Emitted when the application has been resumed.

fn user_event(&mut self, event_loop: &ActiveEventLoop, event: CustomEvent)

Emitted when an event is sent from EventLoopProxy::send_event.

fn window_event( &mut self, event_loop: &ActiveEventLoop, window_id: WindowId, event: WindowEvent, )

Emitted when the OS sends an event to a winit window.

fn about_to_wait(&mut self, event_loop: &ActiveEventLoop)

Emitted when the event loop is about to block and wait for new events.

fn suspended(&mut self, _event_loop: &ActiveEventLoop)

Emitted when the application has been suspended.

fn exiting(&mut self, event_loop: &ActiveEventLoop)

Emitted when the event loop is being shut down.

fn new_events(&mut self, event_loop: &ActiveEventLoop, cause: StartCause)

Emitted when new events arrive from the OS to be processed.

fn device_event( &mut self, event_loop: &ActiveEventLoop, device_id: DeviceId, event: DeviceEvent, )

Emitted when the OS sends an event to a device.

fn memory_warning(&mut self, event_loop: &ActiveEventLoop)

Emitted when the application has received a memory warning.