Struct basalt::Basalt

pub struct Basalt { /* private fields */ }

Implementations

impl Basalt

pub fn initialize(
    options: BstOptions,
    result_fn: Box<dyn Fn(Result<Arc<Self>, String>) + Send + Sync>
)

Begin initializing Basalt, this thread will be taken for window event polling and the function provided in result_fn will be executed after Basalt initialization has completed or errored.

pub fn poll_events(&self) -> Vec<BstEvent>

Panics:

• Panics if the current cofiguration is an app_loop.

pub fn input_ref(&self) -> &Input

pub fn interval(&self) -> Arc<Interval>

pub fn interval_ref(&self) -> &Arc<Interval>

pub fn interface(&self) -> Arc<Interface>

pub fn interface_ref(&self) -> &Arc<Interface>

pub fn atlas(&self) -> Arc<Atlas>

pub fn atlas_ref(&self) -> &Arc<Atlas>

pub fn device(&self) -> Arc<Device>

pub fn device_ref(&self) -> &Arc<Device>

pub fn compute_queue(&self) -> Arc<Queue>

Notes:

• This queue may be the same as the graphics queue in cases where the device only has a single queue present.

pub fn compute_queue_ref(&self) -> &Arc<Queue>

Notes:

• This queue may be the same as the graphics queue in cases where the device only has a single queue present.

pub fn transfer_queue(&self) -> Arc<Queue>

Notes:

• This queue may be the same as the compute queue in cases where the device only has two queues present. In cases where there is only one queue the graphics, compute, and transfer queues will all be the same queue.

pub fn transfer_queue_ref(&self) -> &Arc<Queue>

Notes:

• This queue may be the same as the compute queue in cases where the device only has two queues present. In cases where there is only one queue the graphics, compute, and transfer queues will all be the same queue.

pub fn graphics_queue(&self) -> Arc<Queue>

pub fn graphics_queue_ref(&self) -> &Arc<Queue>

pub fn secondary_compute_queue(&self) -> Option<Arc<Queue>>

pub fn secondary_compute_queue_ref(&self) -> Option<&Arc<Queue>>

pub fn secondary_transfer_queue(&self) -> Option<Arc<Queue>>

pub fn secondary_transfer_queue_ref(&self) -> Option<&Arc<Queue>>

pub fn secondary_graphics_queue(&self) -> Option<Arc<Queue>>

pub fn secondary_graphics_queue_ref(&self) -> Option<&Arc<Queue>>

pub fn physical_device_ref(&self) -> &Arc<PhysicalDevice>

pub fn physical_device(&self) -> Arc<PhysicalDevice>

pub fn surface_capabilities(
    &self,
    fse: FullScreenExclusive
) -> SurfaceCapabilities

pub fn surface_formats(
    &self,
    fse: FullScreenExclusive
) -> Vec<(VkFormat, VkColorSpace)>

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

pub fn instance(&self) -> Arc<Instance>

pub fn instance_ref(&self) -> &Arc<Instance>

pub fn surface(&self) -> Arc<Surface<Arc<dyn BasaltWindow>>>

pub fn surface_ref(&self) -> &Arc<Surface<Arc<dyn BasaltWindow>>>

pub fn formats_in_use(&self) -> BstFormatsInUse

Returns list of Format’s used by Basalt.

pub fn current_extent(&self, fse: FullScreenExclusive) -> [u32; 2]

Get the current extent of the surface. In the case current extent is none, the window’s inner dimensions will be used instead.

pub fn wants_exit(&self) -> bool

pub fn window(&self) -> Arc<dyn BasaltWindow>

pub fn options(&self) -> BstOptions

pub fn options_ref(&self) -> &BstOptions

pub fn exit(&self)

Signal the application to exit.

pub fn fps(&self) -> usize

Retrieve the current FPS.

Notes:

• Returns zero if not configured for app_loop.

pub fn force_recreate_swapchain(&self)

Trigger the Swapchain to be recreated.

Notes:

• Does nothing if not configured for app_loop.

pub fn wait_for_exit(&self) -> Result<(), String>

Wait for the application to exit.

Notes:

• Always returns Ok if not configured for app_loop or the application has already closed.