Struct keeshond::gameloop::GameInfo

pub struct GameInfo {

    pub package_name: &'static str,
    pub friendly_name: &'static str,
    pub base_width: u32,
    pub base_height: u32,
    pub default_window_scale: WindowScaleMode,
    pub texture_filtering: bool,
    pub viewport_mode: ViewportMode,
    pub fullscreen: bool,
    pub target_framerate: f64,
    pub frame_interpolation: FrameInterpolationMode,
    pub frame_interpolation_cap: FrameInterpolationCap,
    pub frame_interpolation_pacing: FrameInterpolationPacing,
    pub cursor_visible: bool,
    pub auto_unload: bool,
    pub allow_system_sleep: bool,
    pub low_energy_app: bool,
    pub log_stats: bool,
    pub log_packages: Vec<&'static str>,
    pub kiosk_mode: bool,
}

Properties and metadata for this game

Fields

package_name: &'static str

The name of the Rust package, used for some internal operations

friendly_name: &'static str

Friendly, user-facing name, displayed in the window title

base_width: u32

Base resolution width of the game graphics

base_height: u32

Base resolution height of the game graphics

default_window_scale: WindowScaleMode

The window scale strategy to use when creating the window

texture_filtering: bool

Whether to use texture filtering. Set to false for pixel art style games.

viewport_mode: ViewportMode

The viewport mode to use, which determines how the game scales to different resolutions.

fullscreen: bool

Whether to default to fullscreen as opposed to windowed mode

target_framerate: f64

The framerate that game logic should run at.

frame_interpolation: FrameInterpolationMode

Unlock display framerate from logic and enable frame interpolation for alternate refresh rates or Variable Refresh Rate displays.

frame_interpolation_cap: FrameInterpolationCap

Optional framerate cap for frame interpolation mode, useful for keeping the display framerate below the maximum supported VRR rate.

frame_interpolation_pacing: FrameInterpolationPacing

Whether to space out display frames for smoother motion when the framerate is higher than the target rate and there is significant logic processing.

cursor_visible: bool

Whether to display the mouse cursor when it is over the window.

auto_unload: bool

Whether unused resources should be automatically unloaded between scenes.

allow_system_sleep: bool

Whether the computer should automatically go to sleep while the application is running. Useful for editors and other utilities.

low_energy_app: bool

Whether to reduce the framerate when the user is not interacting with the application. Also pauses the application when it is not focused unless there is interaction. Useful for editors and other utilities.

log_stats: bool

Whether to print basic stats (number of entities and components, framerate, basic timing information) to the log. Does nothing on release builds.

log_packages: Vec<&'static str>

A list of additional packages to include in the filter used by the default logger (DogLog).

kiosk_mode: bool

Enable kiosk mode, which forces fullscreen and disables closing the window. Note that the user may still be able to close the program depending on your operating environment’s global shortcuts.

Trait Implementations

impl Clone for GameInfo

fn clone(&self) -> GameInfo

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for GameInfo

fn default() -> GameInfo

Returns the “default value” for a type.