0.21.0

Version 0.21.0 (May 12, 2024)

This release involved rewriting a good portion of basalt, around 60%! There has been many bugs fixed and probably a few introduced. Basalt is now approaching the point where widgets are likely to be the next big feature release. There, however, may be some more refactoring regarding input handling to make a better distinction between key location and key name.

---

General Changes

• BREAKING: vulkano & vulkano-shaders upgraded to 0.34
• BREAKING: ilmenite has been removed.
• BREAKING: Imports have been rearraged to allow everything to be accessed at a single module level.
  • Ex: use basalt::interface::bin::style::BinStyle; is now use basalt::interface::BinStyle;.
• BREAKING: misc module has been removed.
• BREAKING: image_view module as its struct BstImageView has been removed.
  • These were used by these Atlas for tracking image usage. In vulkano 0.34 this functionality is no longer able to be implemented. It wasn't ever correct to begin with.
• BREAKING: Removed feature built_in_font
  • System fonts will be used as a fallback/default instead.
• winit upgraded to 0.29
• Added default feature image_decode which allows decoding of images using the image crate.
• Added default feature image_download which allows downloading of images using the curl crate.

Changes to Basalt

• BREAKING: initialize now takes FnMut directly instead of Box'd.
• BREAKING: Removed atlas, atlas_ref methods.
  • The atlas has been replaced by ImageCache.
  • Added methods image_cache and image_cache_ref.
• BREAKING: Removed current_extent, surface, surface_ref, window, & window_ref methods.
  • Now that basalt is multi-window these methods have been moved to the window/window_manager.
  • Added methods window_manager & window_mangager_ref.
• BREAKING: Removed wait_for_exit force_recreate_swapchain, formats_in_use, fps, & poll_events methods.
  • Renderer's will exit upon a close request.
  • Renderer's fully control their swapchain, removing the need for external event handling.
  • Renderer's have a configurable advance metrics which can provide stats such as fps.
• BREAKING: BstFormatsInUse, BstEvent, & BstWinEv removed.
• BREAKING: basalt_required_vk_features is now removed as it is handled internally.

Changes to BasaltOptions

• BREAKING: Renamed BstOptions to BasaltOptions.
• BREAKING: Removed app_loop, bin_parallel_threads, composite_alpha conservative_draw, ignore_dpi, msaa scale, title, use_exclusive_fullscreen, & window_size methods.
  • With the new window system and renderer these methods have been removed.
  • Some of these options can be specified at window creation or methods on the window.
  • Added render_default_consv_draw, render_default_msaa, render_default_vsync, render_default_worker_threads, window_default_scale, & window_ignore_dpi methods.
• BREAKING: force_unix_backend_x11 renamed to winit_force_x11.
• BREAKING: Removed imt_fill_quality, imt_gpu_accelerated, & imt_sample_quality methods.
  • ilmenite is no longer used so these methods are obsolete.
• BREAKING: Removed device_ext_union, instance_ext_union, with_features methods.
  • Added methods prefer_device_extensions, prefer_device_features, prefer_instance_extensions, require_device_features, require_device_extensions, & require_instance_extensions.
  • The new methods allow features/extensions to be more configurable.
• BREAKING: Portability subset devices now must be allowed via the allow_portability_subset method.
• Added method add_binary_font for loading fonts during initialization.

Changes to Interface

• BREAKING: Methods default_font & set_default_font now use the DefaultFont struct.
• BREAKING: Removed has_font method.
• BREAKING: Removed current_effective_scale, current_msaa, current_scale, decrease_msaa, increase_msaa, set_effective_scale, set_msaa, & set_scale methods.
  • Now with multi-window support similar methods now exist on Window.
• BREAKING: add_font has been replaced by add_binary_font.
• BREAKING: draw method has been removed as Renderer now does the drawing.

Changes to BinStyle

• BREAKING: Added field child_float_mode & enum ChildFloatMode for configuring float style.
• BREAKING: back_image field now takes an ImageCacheKey instead of a path.
• BREAKING: back_image_url, back_image_atlas, & back_image_cache fields removed.
• BREAKING: back_image_raw & back_image_raw_coords have been replaced by back_image_vk & back_image_coords.
• BREAKING: text_wrap field now takes TextWrap instead of ImtTextWrap.
• BREAKING: text_vert_align field now takes TextVertAlign instead of ImtVertAlign.
• BREAKING: text_hori_align field now takes TextHoriAlign instead of ImtHoriAlign.
• BREAKING: Added fields font_weight, font_stretch, & font_style for further selection of fonts.
• Added support for borders with border radius.

Changes to Color

• BREAKING: srgb_hex has been renamed to shex.
• BREAKING: from_hex has been renamed to hex.
• BREAKING: clamp, to_linear, & to_nonlinear methods removed.
• BREAKING: as_array has been renamed to rgbaf_array.
• Added many more constructor methods.
  • Includes standard/linear u8/u16/f32 color formats.
  • Added support for constructing from an hsl/hsla color.
• Added many more conversion methods converting to an array of various types.
• Added methods for construction of standard svg colors.

Changes to Bin

• BREAKING: Removed add_button_fade_events.
• BREAKING: Replaced force_update, update_children, & force_recursive_update with trigger_update, trigger_children_update, & trigger_recursive_update.
  • The methods have been rework internally and have been renamed to be match what they do.
  • It should be noted however that having to use these methods generally means there is a bug in basalt.
• BREAKING: hidden & visible methods have been replaced with set_hidden & is_hidden.
• BREAKING: keep_alive method no longer requires objects with KeepAlive trait.
• BREAKING: Removed update_stats method.
  • Stats are now done within the Renderer and can be configured by the Window.
• Added associate_window, associate_window_recursive, & window methods.
  • Now that Bin's must be associated with a window these methods provide the means to do that. It is still preferred however to create Bin via the Window.
• Added method children_recursive_with_self.
• Added method style_inspect which allows inspecting a style without cloning an Arc.
• Various bug fixes regarding placement, overflow, and update triggering.

Changes to BinPostUpdate

• BREAKING: Renamed PostUpdate to BinPostUpdate.
• BREAKING: Added fields visible & floating.
• BREAKInG: unbound_mm_y & unbound_mm_x fields have been replaced by optimal_inner_bounds, optimal_outer_bounds, content_bounds, & optimal_content_bounds as part of the rework in overflow calculations.

Changes to Images

• BREAKING: Atlas has been replaced by ImageCache.
• ImageCache has similar methods for loading images.
• Images are now referenced by their ImageCacheKey instead of AtlasCoords.

Changes to Windows

• BREAKING: basalt no longer automatically creates a window upon initialization.
• BREAKING: BasaltWindow trait has been removed.
• Added WindowManager which is responsible for creating Window's and handling their events.

Changes to Rendering

• BREAKING: Drawing is no longer done with the Interface::draw method.
• Added Renderer which handles all the rendering of a Window.

0.20.0

• BREAKING Update dependency vulkano & vulkano-shaders to 0.33.
• BREAKING Update dependency ilmenite to 0.14.
• BREAKING Removed enable_validation from BstOptions.
• Update dependency winit to 0.28.

0.19.1

• Fixed non-uniform access in interface shader.
• Fixed bug with slider not releasing when mouse left button is released.
• Fixed bug with slider calling on change methods when there wasn't a change.

0.19.0

• BREAKING Update dependency vulkano & vulkano-shaders to 0.32.
• Custom Font Support
  • BREAKING BinStyle now has font_family & font_weight fields.
  • Added default feature built_in_font that allows disabling loading/including of built-in font.
  • Interface now has default_font, set_default_font & add_font methods.
• Changes to BinStyle updates/validation.
  • BREAKING Bin::style_update now returns BinStyleValidation which must be used.
    • Introduced non-default feature style_validation_debug_on_drop which will use the debug method of BinStyleValidation upon dropping. This also removes the #[must_use] attribute of BinStyleValidation.
  • Supress warnings about body being too small when using text.
• BREAKING Removed seperate_ image methods on Bin.
  • Using seperate images not provided by the atlas should use the back_image_raw style of BinStyle.
  • BREAKING Removed back_srgb_yuv field from BinStyle.
    • This wasn't proper yuv supported as probably not used. For those that may be using this either use the Atlas for yuv conversion or convert the image to RGB and use the back_image_raw field.
• Added method window_ref to Basalt.

0.18.0

• BREAKING Update dependency vulkano & vulkano-shaders to 0.30.
• BREAKING Update dependency ilmenite to 0.12.
• BREAKING Input and HookManager (a.k.a. BinHook) have been rewritten/merged.
  • As this is a rewrite, the design has changed greatly. Please refer to docs.
  • Convenience methods on Input are now accessed on windows instead.
    • For example a press can be added via basalt.window().on_press(...).
  • Convenience methods on Bin have had their named changed and some additional ones added.
    • For example bin.on_mouse_press(...) is now bin.on_press(...).
  • More specific/customized hooks are created via builders accessed by Input.hook().
  • Hook method signatures have changed away from an enum style and now have specific signatures for each type of hook.
  • Most data available for hooks is still available, but is accessed differently.
    • on_hold is an exception where querying the cursor position, or any other window state, is no longer available.
  • The concept of weights are now implemented.
    • This allows hooks to be processed in certain order and block the calling of other hooks of the same class. Refer to the docs for more specfic details on how this system works.
• BREAKING BinStyle.pass_events is now removed.
  • This has been removed in favor of the weight system.
  • This was introduced originally as sort of hack for having scrollable content within other scrollable content.
    • Specifically InputScrollBuilder.upper_blocks(...) replaces this hack.
• BREAKING BinID is now a concrete type instead of an alias.
• BREAKING Interface.get_bin_id_atop(...) and Interface.get_bin_atop(...) now additionally take a BstWindowID.
• BREAKING ImageEffect now has GlyphWithColor varient.
• BREAKING Removed Basalt::physical_device_index() as vulkano no longer has indexes for physical devices.
• Interface now has the methods get_bins_atop(...) and get_bin_ids_atop which function like their singular varients, but return a sorted Vec instead where the top most is first.
• New Interval system
  • This system introduces the ability to run a hook on a specfic interval down to 1 ms of precision.
    • The minimum resolution is platform/scheduler specific, but generally Windows is about 1.4ms and linux at 1 ms.
  • The rewritten Input system utilizes this functionality with on_hold and on_scroll, where smooth scrolling is enabled, to provide more frequent and consistent intervals.
• Changed font used to a more common, less quirky font Roboto.
• Improved subpixel sampling for glyphs in interface shaders.
• Added method Basalt::physical_device_ref().

0.17.0

• Atlas now internally uses the guillotiere crate for allocation.
• atlas::Coords has been reworked.
  • BREAKING Renamed to AtlasCoords to reduce name conflicts.
  • BREAKING All fields are now private.
  • BEHAVIOR AtlasCoords is now required to be kept alive for the coordinates to be valid.
    • Upon dropping AtlasCoords deletion may occur depending on behavior defined by AtlasCacheCtrl upon adding an image to the Atlas.
  • Added external method to allow construction for use in BinStyle.back_image_raw_coords and other use cases.
  • Added is_external method to check if AtlasCoords was created via external.
  • Added none method to create none/invalid AtlasCoords for use as a placeholder.
  • Added is_none to check if AtlasCoords was created via none.
  • Added image_id method to get the AtlasImageID.
  • Added tlwh for getting the top-left-width-height, size/position.
  • Internal positional and dimensional fields are represented as f32 instead of u32 to reduce coercion.
• Atlas image removal support.
  • Added enum AtlasCacheCtrl to define behavior around removal.
  • BREAKING Atlas methods load_image, load_image_from_bytes, load_image_from_path, and load_image_from_url now additionally takes AtlasCacheCtrl as an argument.
  • BREAKING Added BinStyle field back_image_cache to specify AtlasCacheCtrl used for various back image sources.
• BREAKING All methods taking signature of Arc<Fn(_) -> _ + Send + Sync> now take FnMut(_) -> _ + Send + 'static.
  • In most cases wrapping a closure in an Arc was arbitrary.
    • For users wanting to reuse functions:
      • Option A: Define function if there isn't a need to send variables to within the closure.
      • Option B: Call the Arc<Fn(_) -> _ + ...> from a closure, |args| arcd_fn(args).
  • This change removes the need for Sync in types.
  • 'static maybe appear as an additional requirment, but was previously implied.
  • FnMut is now used instead of Fn allowing state to be kept without the need of synchronization primatives.
• BREAKING InputHookFn type alias has been removed.
• BREAKING InputHookRes has been renamed to InputHookCtrl.
  • BREAKING Error & Warning varients are now removed.
    • Users should instead print the message themselves.
  • BREAKING Success varient has been renamed to Retain.
  • InputHookCtrl now implements Default and will default to Retain.
• BREAKING BinHookFn type alias has been removed.
• BREAKING Bin::add_hook_raw has been renamed to Bin::add_hook.
• BREAKING Bin::on_update & Bin::on_update_once now take FnMut(bin: &Arc<Bin>, post_update: &PostUpdate).
• BREAKING CheckBox::on_change no longer spawns a thread to call method.
• BREAKING Slider::on_change no longer spawns a thread to call method.
• BREAKING Atlas::new() now takes Arc<Queue>, VkFormat, max_alloc_size: u32 instead of Arc<Basalt>.
• BREAKING basalt::Options has been renamed to BstOptions.
• BREAKING basalt::Limits and the associated method Basalt::limits() has been removed.
  • Use Basalt::physical_device().properties() instead.
• BREAKING InputHookData::Character { .. } is now InputHookData::Character(char) and BinHookData::Character { .. } is now BinHookData::Character(char).
  • No longer mapped from scan code. This allows non-US languages to work.
  • Use '\r' to detect new lines and '\u{8}' for backspaces.
• BREAKING Removed Qwerty::into_char().
  • This was not proper to begin within. If you need to receive characters, use either InputHook::Character or BinHook::Character.
• BREAKING Removed methods resize, enable_fullscreen, disable_fullscreen, and toggle_fullscreen from Basalt.
  • Used methods on BasaltWindow returned by Basalt::window() instead.
• BREAKING BasaltWindow::enable_fullscreen() now takes FullScreenBehavior as an argument and returns Result<(), FullScreenError>.
• BREAKING SubImageCacheID::Glyph is now a struct not a tuple.
• AtlasImage now has the load_from_bytes, load_from_path, load_from_url methods that are used by the corresponding Atlas methods.
• BstImageView now has the set_drop_fn for setting a method to be called when all temporary views are dropped.
• BinPosition, BstEvent, & BstWinEv types that already derived PartialEq now also derive Eq.
• Fixed bug when input hooks return'd InputHookRes::Remove (now InputHookCtrl::Remove) it didn't actually do anything.
• Bin now has on_children_added & on_children_removed methods.
• Removed unsafe code from Basalt initialization which caused undefined behavior.
• Added BstOptions::bin_parallel_threads to specify amount of parallel threads used for Bin updates.
• Update dependancy winit to 0.27.2.
• Additional BasaltWindow methods where added:
  • is_fullscreen(): check if the window is in fullscreen.
  • monitors(): returns a list of monitors.
    • Introduces Monitor and MonitorMode used in FullScreenBehavior.
  • primary_monitor() returns the primary monitor if determinable.
  • current_monitor() returns the current monitor if determinable.

0.16.1

• Fixed VUID-vkCmdDraw-None-02703 & VUID-vkCmdDraw-None-02699 validation errors.

0.16.0

• BREAKING Update dependency vulkano & vulkano-shaders to 0.30.
• BREAKING Update dependency ilmenite to 0.11.
• BREAKING BstFormatsInUse now has swapchain & swapchain_colorspace fields used primary for app loop applications. This can double as a recommended swapchain format for other applications.
• BREAKING misc methods partial_ord_min, partial_ord_min3, partial_ord_max, & partial_ord_max3 have been removed.
• BREAKING PostUpdate fields pre_bound_min_y & pre_bound_max_y have been replaced with unbound_mm_y.
• BREAKING Bin::calc_overflow has been renamed to calc_vert_overflow.
• BEHAVIOR overflow_x & scroll_x are now implemented on BinStyle. Previously overflowing horizontal content will now be removed.
  • Usage overflow_x: Some(true) to revert this behavior where needed.
• Added conservative_draw method to Options. This is currently experimental and will attempt to limit interface redraws for app loop applications.
• Fixed bug where if MSAA was in use with ItfDrawTarget::Image an error would occur.
• Fixed bug where overflow on a Bin was not calculated correctly with calc_vert_overflow method.
• PostUpdate added field unbound_mm_x for min/max of horizontal content before bound (overflow removal).
• Bin now has calc_hori_overflow method.
• Fixed bug where alternative Atlas formats weren't actually supported.
• Fixed bug where atlas formats were not checked for transfer_src support.
• Fixed bug where OnOffButton would never drop.
• atlas::Image now has to_8b_srgba & to_8b_lrgba methods.

0.15.0

• BREAKING Update dependency vulkano & vulkano-shaders to 0.29.
• BREAKING Basalt::swap_caps() has been replaced by Basalt::surface_capabilities, Basalt::surface_formats, & Basalt::surface_present_modes.
• BREAKING Basalt::current_extent() now takes FullScreenExclusive as an argument.
• BREAKING Renamed Qwery to Qwerty...
• BREAKING BinColor::as_tuple() has been removed and replaced by BinColor::as_array().
• BREAKING atlas::Coords methods top_left, top_right, bottom_left, & bottom_right now return [f32; 2] instead of (f32, f32).
• BEHAVIOR Camera::mouse_inside() will now return false for Bin's that have pass_events set to Some(true).
• Fixed various instances of buffers being created with zero size.
• Fixed wrong image values for Atlas's empty image.
• Refactored queue creation to have weights more inline with vulkan spec.

0.12.0

• BREAKING Update dependency ilmenite to 0.7.0.
• BREAKING Update dependency vulkano & vulkano-shaders to 0.26.
• BREAKING Atlas has been reworked
  • BREAKING Renamed method default_sampler to linear_sampler.
  • Now uses 16 bit Linear formats for images instead of 8 bit SRGB.
  • Added method nearest_sampler that provides a nearest filter sampler.
  • Methods load_image_from_bytes, load_image_from_path, & load_image_from_url now support loading of 16 bit images fully instead of converting them to 8 bit.
  • Secondary graphics queue will be used instead of compute queue when available and will fallback to the primary graphics queue. This is needed as blit operations need to be done on a queue with support for blit operations.
  • ImageData
    • BREAKING No longer nonexhaustive.
    • BREAKING Added Varients
      • D16: 16 bit images
      • Imt for ImtImageView.
      • Bst for BstImageView.
  • ImageType
    • BREAKING No longer has Glyph varient. Use SMono.
    • BREAKING Added Raw varient that is used for Image's constructed from from_bst & from_imt.
  • Image
    • Now implements Debug and Clone.
    • New constructors
      • from_bst for construction from BstImageView.
      • from_imt for construction from ImtImageView.
    • BREAKING to_srgba has been renamed to to_16b_srgba which converts Image to one constructed of ImageType::SRGBA & ImageData::D16. This does not effect Image's of ImageType::Raw.
    • BREAKING to_lrgba has been renamed to to_16b_lrgba which converts Image to one constructed of ImageType::LRGBA & ImageData::D16. This does not effect Image's of ImageType::Raw.
• BREAKING Interface rendering has been reworked.
  • BREAKING Moved interface::interace into interface.
  • BREAKING ItfRenderer is no longer public. Its public facing functionality is now moved to Interface via draw.
    • Draw method now takes a command buffer builder and a ItfDrawTarget.
      • ItfDrawTarget replaces the previous win_size, resize, swap_imgs, render_to_swapchain & image_num.
      • This limits the amount of fields only to what is required.
        • i.e. ItfDrawTarget::Image only needs an extent.
      • It is no longer required to pass resize when the swapchain is recreated or resized. Given the context the renderer will automatically recreate the target when needed.
      • ItfDrawTarget also has SwapchainWithSource which is recommended when doing additional graphics on top of basalt. This will render the source in the background and have proper blending with component aware alpha. This replaces the need to have a seperate pipeline where the end user would have to have a seperate pipeline to combine their image with Basalt's.
  • New rendering is done on a layer basis with component aware alpha blending which allows for more correct alpha blending and text blending along with more advance rendering features to come.
• BREAKING BstImageView temporary views have been reworked.
  • BREAKING create_tmp no longer returns an AtomicBool.
  • Added method temporary_views to fetch the amount of temporary views.
  • Added method mark_stale to mark the image view stale.
    • This is used on the parent view to hint to owners of temporary views that the view that is provided is stale and should be replaced.
  • Added method is_stale to check if the view is stale.
    • Check if the owner view has marked this view stale. If true the view should be replaced or dropped as soon as possible.
• BREAKING Options no longer has interface_limit_draw. Limiting the draw had weird quirks and is removed for the time being.
• BREAKING input::Event::WindowScale now expects scale to be provided.
• BREAKING BstMSAALevel has been moved into the interface mod.
• BREAKING BstEvent::BstItfEv & BstItfEv are no longer.
• BREAKING Changed how scale & msaa are accessed and handled.
  • BREAKINGBasalt::current_scale() has been moved to Interface::current_scale().
  • BREAKINGBasalt::set_scale() has been moved to Inteface::set_scale().
  • BREAKINGBasalt::add_scale() has been removed.
  • BREAKINGInterface::msaa() method has been renamed to current_msaa.
  • Interface now has the following methods added:
    • current_effective_scale: current scale taking into account dpi window scaling.
    • set_effective_scale: set the scale taking into account dpi window scaling.
• Options now has imt_gpu_accelerated to select whether ilmenite will use gpu accerated font rasterization. imt_fill_quality to select the fill quality for ilmenite, and imt_sample_quality to select the sample quality for ilmenite.
• Fixed bug where glyph alignment was incorrect when scale was not 100%.
• Bins will now load images into the atlas directly from ilmenite.
• Interface shader will now use nearest filter sampler when sampling glyph images. This resolves issues with subpixel hinting being incorrect.