pub struct Options { /* private fields */ }
Expand description
Options for Basalt’s creation and operation.
Implementations
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.
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.
Defaults to false
. Ignore dpi hints provided by the platform.
Set the inner size of the window to be created
Set the the amount of MSAA of the UI
Prefer integrated graphics if they are available
Add additional instance extensions
Add additional device extensions
Specifify a custom set of vulkan features. This should be used with
basalt_required_vk_features()
to ensure Basalt functions correctly. For example:
.with_features(
Features {
storage_buffer16_bit_access: true,
.. basalt_required_vk_features()
}
)
Set the composite alpha mode used when creating the swapchain. Only effective when using app loop.
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.
Basalt uses ilmenite in the backend for text. Setting this option to true will allow ilmenite to use a gpu code path which will have some performance gain; however, this code path may be broken on some systems. This defaults to true.
Basalt uses ilmenite in the backend for text. This option allows for modifying the fill quality (the amount of casted rays) that ilmenite will use. This defaults to `ImtFillQuality::Normal“.
Basalt uses ilmenite in the backend for text. This option allows for modifying the sample quality (the amount of samples in a subpixel) that ilmenite will use. This defaults to `ImtSampleQuality::Normal.
Trait Implementations
Auto Trait Implementations
impl RefUnwindSafe for Options
impl UnwindSafe for Options
Blanket Implementations
Mutably borrows from an owned value. Read more
Builds a pointer to this type from a raw pointer.
Returns true if the size is suitable to store a type like this.
Returns the size of an individual element.
Read this value from the supplied reader. Same as ReadEndian::read_from_little_endian()
.
Read this value from the supplied reader. Same as ReadEndian::read_from_big_endian()
.
Read this value from the supplied reader. Same as ReadEndian::read_from_native_endian()
.