Struct basalt::Basalt

pub struct Basalt { /* private fields */ }

Implementations

impl Basalt

pub fn initialize(
    options: Options,
    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 if the current cofiguration is an app_loop.

pub fn input_ref(&self) -> &Arc<Input>

pub fn limits(&self) -> Arc<Limits>

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>

Note: 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>

Note: 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>

Note: 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>

Note: 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_index(&self) -> usize

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

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

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

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

pub fn formats_in_use(&self) -> BstFormatsInUse

pub fn swap_caps(&self) -> Capabilities

pub fn current_extent(&self) -> [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. This function is equivlent to:

basalt
	.surface()
	.capabilities(
		PhysicalDevice::from_index(basalt.instance(), basalt.physical_device_index())
			.unwrap(),
	)
	.unwrap()
	.current_extent
	.unwrap_or(basalt.surface_ref().window().inner_dimmension())

pub fn wants_exit(&self) -> bool

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

pub fn options(&self) -> Options

pub fn options_ref(&self) -> &Options

pub fn resize(&self, w: u32, h: u32)

pub fn enable_fullscreen(&self)

pub fn disable_fullscreen(&self)

pub fn toggle_fullscreen(&self)

pub fn exit(&self)

pub fn fps(&self) -> usize

only works with app loop

pub fn force_recreate_swapchain(&self)

only works with app loop

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

only works with app loop