Struct basalt::Basalt

pub struct Basalt { /* private fields */ }

The main object of this crate.

Notes

• This is expected to be kept alive for the lifetime of the application.
• There should only ever be one instance of this struct.

Implementations

impl Basalt

pub fn initialize<F: FnMut(Result<Arc<Self>, String>) + Send + 'static>( options: BasaltOptions, result_fn: F )

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 input_ref(&self) -> &Input

Obtain a reference of Input

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

Obtain a copy of Arc<Interval>

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

Obtain a reference of Arc<Interval>

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

Obtain a copy of Arc<Interface>

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

Obtain a reference of Arc<Interface>

pub fn image_cache(&self) -> Arc<ImageCache>

Obtain a copy of Arc<ImageCache>

pub fn image_cache_ref(&self) -> &Arc<ImageCache>

Obtain a refernce of Arc<ImageCache>

pub fn window_manager(&self) -> Arc<WindowManager>

Obtain a copy of Arc<WindowManager>

pub fn window_manager_ref(&self) -> &Arc<WindowManager>

Obtain a reference of Arc<WindowManager>

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

Obtain a copy of Arc<Instance>

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

Obtain a reference of Arc<Instance>

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

Obtain a copy of Arc<PhysicalDevice>

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

Obtain a reference of Arc<PhysicalDevice>

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

Obtain a copy of Arc<Devcie>

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

Obtain a refernce of Arc<Device>

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

Obtain a copy of the Arc<Queue> assigned for graphics operations.

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

Obtain a reference of the Arc<Queue> assigned for graphics operations.

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

Obtain a copy of the Arc<Queue> assigned for secondary graphics operations.

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

Obtain a reference of the Arc<Queue> assigned for secondary graphics operations.

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

Obtain a copy of the Arc<Queue> assigned for compute operations.

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>

Obtain a reference of the Arc<Queue> assigned for compute operations.

Notes:

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

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

Obtain a copy of the Arc<Queue> assigned for secondary compute operations.

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

Obtain a reference of the Arc<Queue> assigned for secondary compute operations.

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

Obtain a copy of the Arc<Queue> assigned for transfers.

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>

Obtain a reference of the Arc<Queue> assigned for transfers.

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 secondary_transfer_queue(&self) -> Option<Arc<Queue>>

Obtain a copy of the Arc<Queue> assigned for secondary transfers.

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

Obtain a reference of the Arc<Queue> assigned for secondary transfers.

pub fn exit(&self)

Signal the application to exit.

pub fn wants_exit(&self) -> bool

Check if basalt is attempting to exit.

Trait Implementations

impl Debug for Basalt

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

Formats the value using the given formatter.