Struct vulkano::device::Device

pub struct Device { /* fields omitted */ }

Represents a Vulkan context.

Methods

impl Device

fn new<'a, I, Ext>(
    phys: PhysicalDevice,
    requested_features: &Features,
    extensions: Ext,
    queue_families: I
) -> Result<(Arc<Device>, QueuesIter), DeviceCreationError> where
    I: IntoIterator<Item = (QueueFamily<'a>, f32)>,
    Ext: Into<RawDeviceExtensions>, 

Builds a new Vulkan device for the given physical device.

You must pass two things when creating a logical device:

• A list of optional Vulkan features that must be enabled on the device. Note that if a feature is not enabled at device creation, you can't use it later even it it's supported by the physical device.

• An iterator to a list of queues to create. Each element of the iterator must indicate the family whose queue belongs to and a priority between 0.0 and 1.0 to assign to it. A queue with a higher value indicates that the commands will execute faster than on a queue with a lower value. Note however that no guarantee can be made on the way the priority value is handled by the implementation.

Panic

• Panics if one of the queue families doesn't belong to the given device.

unsafe fn wait(&self) -> Result<(), OomError>

Waits until all work on this device has finished. You should never need to call this function, but it can be useful for debugging or benchmarking purposes.

Note: This is the Vulkan equivalent of OpenGL's glFinish.

Safety

This function is not thread-safe. You must not submit anything to any of the queue of the device (either explicitely or implicitely, for example with a future's destructor) while this function is waiting.

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

Returns the instance used to create this device.

fn physical_device(&self) -> PhysicalDevice

Returns the physical device that was used to create this device.

fn active_queue_families<'a>(
    &'a self
) -> Box<ExactSizeIterator<Item = QueueFamily<'a>> + 'a>

Returns an iterator to the list of queues families that this device uses.

Note: Will return -> impl ExactSizeIterator<Item = QueueFamily> in the future.

fn enabled_features(&self) -> &Features

Returns the features that are enabled in the device.

fn loaded_extensions(&self) -> &DeviceExtensions

Returns the list of extensions that have been loaded.

fn standard_pool(me: &Arc<Self>) -> Arc<StdMemoryPool>

Returns the standard memory pool used by default if you don't provide any other pool.

fn standard_descriptor_pool(me: &Arc<Self>) -> Arc<StdDescriptorPool>

Returns the standard descriptor pool used by default if you don't provide any other pool.

fn standard_command_pool(
    me: &Arc<Self>,
    queue: QueueFamily
) -> Arc<StandardCommandPool>

Returns the standard command buffer pool used by default if you don't provide any other pool.

Panic

• Panics if the device and the queue family don't belong to the same physical device.

Trait Implementations

impl Send for Device

impl Sync for Device

impl Debug for Device

fn fmt(&self, fmt: &mut Formatter) -> Result<(), Error>

Formats the value using the given formatter.

impl VulkanObject for Device

type Object = Device

The type of the object.

fn internal_object(&self) -> Device

Returns a reference to the object.

impl Drop for Device

fn drop(&mut self)

Executes the destructor for this type.