Struct vulkano::device::Device

source · [−]

pub struct Device { /* private fields */ }

Expand description

Represents a Vulkan context.

Implementations

source

impl Device

source

pub fn new(
physical_device: 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.

source

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.

source

pub fn fns(&self) -> &DeviceFunctions

Grants access to the Vulkan functions of the device.

source

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.

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.

source

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

Returns the instance used to create this device.

source

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

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

source

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.

source

pub fn enabled_extensions(&self) -> &DeviceExtensions

Returns the extensions that have been enabled on the device.

source

pub fn enabled_features(&self) -> &Features

Returns the features that have been enabled on the device.

source

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.

source

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.

source

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.

source

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.