Struct let_engine::settings::Graphics

pub struct Graphics { /* private fields */ }

Engine wide Graphics settings.

By default the present mode is determined by this order based on availability on the device:

1. Mailbox
2. Immediate
3. Fifo

The framerate limit is None, so off.

Only alter settings after the game engine has been initialized. The initialisation of the game engine also initializes the settings.

Implementations

impl Graphics

pub fn present_mode(&self) -> PresentMode

Returns the present mode of the game.

pub fn set_present_mode(&self, mode: PresentMode) -> Result<()>

Sets and applies the present mode of the game.

pub fn framerate_limit(&self) -> Duration

Returns waiting time between frames to wait.

pub fn set_framerate_limit(&self, limit: Duration)

Sets the framerate limit as waiting time between frames.

This should be able to be changed by the user in case they have a device with limited power capacity like a laptop with a battery.

Setting the duration to no wait time at all will turn off the limit.

pub fn set_fps_cap(&self, cap: u64)

Sets the cap for the max frames per second the game should be able to output.

This method is the same as setting the set_framerate_limit of this setting to 1.0 / cap in seconds.

Turns off the framerate cap if 0 was given.

pub fn get_supported_present_modes(&self) -> Vec<PresentMode>

Returns all the present modes this device supports.

If the vec is empty the engine has not been initialized and the settings should not be changed at this state.