Struct vulkano::device::Device

pub struct Device { /* fields omitted */ }

Represents a Vulkan context.

Implementations

impl Device

pub fn new<'a, I>(
    physical_device: PhysicalDevice<'_>,
    requested_features: &Features,
    requested_extensions: &DeviceExtensions,
    queue_families: I
) -> Result<(Arc<Device>, QueuesIter), DeviceCreationError> where
    I: IntoIterator<Item = (QueueFamily<'a>, f32)>, 

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.

pub fn api_version(&self) -> Version

Returns the Vulkan version supported by the device.

This is the lower of the physical device’s supported version and the instance’s max_api_version.

pub fn fns(&self) -> &DeviceFunctions

Grants access to the Vulkan functions of the device.

pub 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 explicitly or implicitly, for example with a future’s destructor) while this function is waiting.

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

Returns the instance used to create this device.

pub fn physical_device(&self) -> PhysicalDevice<'_>

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

pub fn active_queue_families<'a>(
    &'a self
) -> impl ExactSizeIterator<Item = QueueFamily<'a>>

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

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

pub fn enabled_features(&self) -> &Features

Returns the features that have been enabled on the device.

pub fn enabled_extensions(&self) -> &DeviceExtensions

Returns the extensions that have been enabled on the device.

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

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

pub 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.

pub 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.

pub fn set_object_name<T: VulkanObject + DeviceOwned>(
    &self,
    object: &T,
    name: &CStr
) -> Result<(), OomError>

Assigns a human-readable name to object for debugging purposes.

Panics

• If object is not owned by this device.

pub unsafe fn set_object_name_raw(
    &self,
    ty: ObjectType,
    object: u64,
    name: &CStr
) -> Result<(), OomError>

Assigns a human-readable name to object for debugging purposes.

Safety

object must be a Vulkan handle owned by this device, and its type must be accurately described by ty.

pub fn image_format_properties(
    &self,
    format: Format,
    ty: ImageType,
    tiling: ImageTiling,
    usage: ImageUsage,
    create_flags: ImageCreateFlags
) -> Result<ImageFormatProperties, String>

Checks the given combination of image attributes/configuration for compatibility with the physical device.

Returns a struct with additional capabilities available for this image configuration.

Trait Implementations

impl Debug for Device

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

Formats the value using the given formatter.

impl Drop for Device

fn drop(&mut self)

Executes the destructor for this type.

impl Hash for Device

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl PartialEq<Device> for Device

fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl VulkanObject for Device

type Object = Device

The type of the object.

fn internal_object(&self) -> Device

Returns a reference to the object.

impl Eq for Device

impl Send for Device

impl Sync for Device