Struct HudNotification 

pub struct HudNotification {
    pub text: String,
    pub duration: f32,
    pub position: Vec3,
    pub text_style: TextStyle,
    /* private fields */
}

A simple notification to display a text for a given duration in second.

Fields that can be changed before initialization:

• text - The text to display. Default is “???”.
• duration - The duration in seconds to display the text. Default is 5.0.
• position - The position of the text. Default is Vec3::new(0.0, -0.2, -0.2).
• text_style - The style of the text. Default is a black text with a size of 0.03 and a shader from “shaders/hud_text.hlsl.sks”.

Events this stepper is listening to:

None, This stepper does not listen to any event.

Examples

use stereokit_rust::tools::notif::HudNotification;

let mut hud_notif = HudNotification::default();
hud_notif.text = "Notification!".into();
hud_notif.text_style.layout_height(0.2);
sk.send_event(StepperAction::add("HudNotification1", hud_notif));

filename_scr = "screenshots/hud_notification.jpeg";
test_screenshot!( // !!!! Get a proper main loop !!!!
);

Fields

text: String

duration: f32

position: Vec3

text_style: TextStyle

Trait Implementations

impl Default for HudNotification

fn default() -> Self

Returns the “default value” for a type.

impl IStepper for HudNotification

fn initialize(&mut self, id: StepperId, sk_info: Rc<RefCell<SkInfo>>) -> bool

This is called by StereoKit at the start of the next frame, and on the main thread. This happens before StereoKit’s main Step callback, and always after Sk.initialize. https://stereokit.net/Pages/StereoKit.Framework/IStepper/Initialize.html id : The id of the stepper sk : The SkInfo of the runnin Sk instance.

fn step(&mut self, token: &MainThreadToken)

This Step method will be called every frame of the application, as long as Enabled is true. This happens immediately before the main application’s Step callback. https://stereokit.net/Pages/StereoKit.Framework/IStepper/Step.html

fn initialize_done(&mut self) -> bool

If initialization is to be performed in multiple steps, with or without threads and in order to avoid black or frozen screens, write the on going initialization here

fn enabled(&self) -> bool

Is this IStepper enabled? When false, StereoKit will not call Step. This can be a good way to temporarily disable the IStepper without removing or shutting it down. https://stereokit.net/Pages/StereoKit.Framework/IStepper/Enabled.html

fn shutdown(&mut self)

This is called when the IStepper is removed, or the application shuts down. This is always called on the main thread, and happens at the start of the next frame, before the main application’s Step callback. https://stereokit.net/Pages/StereoKit.Framework/IStepper/Shutdown.html

fn shutdown_done(&mut self) -> bool

If shutdown is to be performed in multiple steps, with or without threads and in order to avoid black or frozen screens, write the on going shutdown here

impl Send for HudNotification