Struct basalt::Options

pub struct Options { /* fields omitted */ }

Options for Basalt’s creation and operation.

Implementations

impl Options

pub fn app_loop(self) -> Self

Configure Basalt to run in app mode. The swapchain will be managed by Basalt and all renderering to the swapchain will be done by Basalt. Additional rendering to the swapchain will be unavailable. This is useful for applications that are UI only. Enabling app mode also automatically enables the interface_limit_draw option. If this is not wanted after app_loop() use interface_limit_draw(false).

pub fn interface_limit_draw(self, to: bool) -> Self

Defaults to true in app mode. Limits interface redraws where possible. In the app loop the application will only render frames when there are updates. In an external loop when ItfRenderer is not rendering to the swapchain directly it will avoid redrawing to the interface image if there are no updates needed. Note this is currently unstable outside of the app mode. Please use with caution!

pub fn use_exclusive_fullscreen(self, to: bool) -> Self

Defaults to false. Enables the device extension required for exclusive fullscreen. Generally this extension is only present on Windows. Basalt will return an error upon creation if this feature isn’t supported. With this option enabled BasaltWindow::enable_fullscreen() will use exclusive fullscreen; otherwise, borderless window will be used.

pub fn ignore_dpi(self, to: bool) -> Self

Defaults to false. Ignore dpi hints provided by the platform.

pub fn window_size(self, width: u32, height: u32) -> Self

Set the inner size of the window to be created

pub fn title<T: AsRef<str>>(self, title: T) -> Self

Set the title of the window to be created

pub fn scale(self, to: f32) -> Self

Set the initial scale of the UI

pub fn msaa(self, to: BstMSAALevel) -> Self

Set the the amount of MSAA of the UI

pub fn prefer_integrated_gpu(self) -> Self

Prefer integrated graphics if they are available

pub fn instance_ext_union(self, ext: &InstanceExtensions) -> Self

Add additional instance extensions

pub fn device_ext_union(self, ext: &DeviceExtensions) -> Self

Add additional device extensions

pub fn composite_alpha(self, to: CompositeAlpha) -> Self

Set the composite alpha mode used when creating the swapchain. Only effective when using app loop.

pub fn force_unix_backend_x11(self, to: bool) -> Self

Setting this to true, will set the environment variable WINIT_UNIX_BACKEND=x11 forcing winit to use x11 over wayland. This is false by default, but it is recommended to set this to true if you intend to use Basalt::capture_cursor(). With winit on wayland, MouseMotion will not be emitted.

Trait Implementations

impl Clone for Options

fn clone(&self) -> Options

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Options

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Options

fn default() -> Self

Returns the “default value” for a type.