Struct vulkano::device::Device

pub struct Device { /* private fields */ }

Represents a Vulkan context.

Implementations

impl Device

pub fn new( physical_device: Arc<PhysicalDevice>, create_info: DeviceCreateInfo ) -> Result<(Arc<Device>, impl ExactSizeIterator<Item = Arc<Queue>>), DeviceCreationError>

Creates a new Device.

Panics

• Panics if create_info.queues is empty.
• Panics if one of the queue families in create_info.queues doesn’t belong to the given physical device.
• Panics if create_info.queues contains multiple elements for the same queue family.
• Panics if create_info.queues contains an element where queues is empty.
• Panics if create_info.queues contains an element where queues contains a value that is not between 0.0 and 1.0 inclusive.

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

Returns pointers to the raw Vulkan functions of the device.

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

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

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

Returns the instance used to create this device.

pub fn active_queue_family_indices(&self) -> &[u32]

Returns the queue family indices that this device uses.

pub fn enabled_extensions(&self) -> &DeviceExtensions

Returns the extensions that have been enabled on the device.

pub fn enabled_features(&self) -> &Features

Returns the features that have been enabled on the device.

pub fn allocation_count(&self) -> u32

Returns the current number of active DeviceMemory allocations the device has.

pub unsafe fn memory_fd_properties( &self, handle_type: ExternalMemoryHandleType, file: File ) -> Result<MemoryFdProperties, MemoryFdPropertiesError>

Retrieves the properties of an external file descriptor when imported as a given external handle type.

An error will be returned if the khr_external_memory_fd extension was not enabled on the device, or if handle_type is ExternalMemoryHandleType::OpaqueFd.

Safety

• file must be a handle to external memory that was created outside the Vulkan API.

pub fn set_debug_utils_object_name<T: VulkanObject + DeviceOwned>( &self, object: &T, object_name: Option<&str> ) -> Result<(), OomError>

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

If object_name is None, a previously set object name is removed.

Panics

• If object is not owned by this device.

pub unsafe fn wait_idle(&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.

Trait Implementations

impl Debug for Device

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

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, Self: Sized,

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 !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl VulkanObject for Device

type Handle = Device

The type of the object.

fn handle(&self) -> Self::Handle

Returns the raw Vulkan handle of the object.

impl Eq for Device