Struct Title 

pub struct Title {
    pub transform: Matrix,
    pub text: String,
    pub text_style: Option<TextStyle>,
    /* private fields */
}

Title is a basic Stepper to show a big title in the scene.

Fields that can be changed before initialization:

• transform - The transform of the text. Default is [0.0, 1.0, -0.5] * Y_180°
• text - The text to display. Default is “Title”.
• text_style - The style of the text. Default is a white text with a size of 0.5 and the default font.

Events this stepper is listening to:

None, This stepper does not listen to any event.

Examples

use stereokit_rust::{tools::title::Title, util::named_colors, maths::Matrix};

let mut title = Title::new("My Title", Some(named_colors::RED), None, None);
title.transform = Matrix::t_r([-0.2, 0.0, -0.3], [0.0, 160.0, 0.0]);
sk.send_event(StepperAction::add("Title", title));

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

Fields

transform: Matrix

text: String

text_style: Option<TextStyle>

Implementations

impl Title

All the code here run in the main thread

pub fn new( text: &str, color: Option<Color32>, font_size: Option<f32>, font: Option<Font>, ) -> Self

Create a new Title stepper

• text - The text to display
• color - The color of the text. Default is WHITE
• font_size - The size of the font. Default is 0.5
• font - The font to use. Default is the default font

Trait Implementations

impl Clone for Title

fn clone(&self) -> Title

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Default for Title

fn default() -> Self

This code may be called in some threads, so no StereoKit code. It’s better to use Title::new instead as you need to set the text.

impl IStepper for Title

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 Title