Magnum::Vk::DeviceCreateInfo class new in Git master

#include <Magnum/Vk/DeviceCreateInfo.h>

enum class Magnum::Vk::DeviceCreateInfo::Flag: UnsignedInt

Device creation flag.

Wraps VkDeviceCreateFlagBits.

typedef Containers::EnumSet<Flag> Magnum::Vk::DeviceCreateInfo::Flags

Device creation flags.

Type-safe wrapper for VkDeviceCreateFlags.

Magnum::Vk::DeviceCreateInfo::DeviceCreateInfo(DeviceProperties& deviceProperties, const ExtensionProperties* extensionProperties, Flags flags = {}) explicit

Constructor.

The following VkDeviceCreateInfo fields are pre-filled in addition to sType:

• flags

You need to call at least addQueues() for a valid setup.

Magnum::Vk::DeviceCreateInfo::DeviceCreateInfo(DeviceProperties& deviceProperties, Flags flags = {}) explicit

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Magnum::Vk::DeviceCreateInfo::DeviceCreateInfo(DeviceProperties&& deviceProperties, const ExtensionProperties* extensionProperties, Flags flags = {}) explicit

Construct with allowing to reuse already populated device properties.

Compared to DeviceCreateInfo(DeviceProperties&, const ExtensionProperties*, Flags), if the Device is subsequently constructed via Device::Device(Instance&, DeviceCreateInfo&&), the deviceProperties instance gets directly transferred to the device, meaning Device::properties() and any APIs relying on it can reuse what was possibly already queried without having to repeat the potentially complex queries second time.

Magnum::Vk::DeviceCreateInfo::DeviceCreateInfo(DeviceProperties&& deviceProperties, Flags flags = {}) explicit

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Magnum::Vk::DeviceCreateInfo::DeviceCreateInfo(NoInitT) explicit noexcept

Construct without initializing the contents.

Note that not even the sType field is set — the structure has to be fully initialized afterwards in order to be usable.

Magnum::Vk::DeviceCreateInfo::DeviceCreateInfo(VkPhysicalDevice physicalDevice, const VkDeviceCreateInfo& info) explicit

Construct from existing data.

Copies the existing values verbatim, pointers are kept unchanged without taking over the ownership. Modifying the newly created instance will not modify the original data nor the pointed-to data.

Magnum::Vk::DeviceCreateInfo::operator const VkDeviceCreateInfo*() const

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

DeviceCreateInfo& Magnum::Vk::DeviceCreateInfo::addEnabledExtensions(const Containers::StringIterable& extensions) &

Add enabled device extensions.

All listed extensions are expected to be supported either globally or in at least one of the enabled layers, use ExtensionProperties::isSupported() to check for their presence.

The following VkDeviceCreateInfo fields are set by this function:

• enabledExtensionCount to the count of extensions added previously by this function plus extensions.size()
• pEnabledExtensionNames to an array containing all extension strings added previously by this function together with ones from extensions (doing a copy where needed)

DeviceCreateInfo&& Magnum::Vk::DeviceCreateInfo::addEnabledExtensions(const Containers::StringIterable& extensions) &&

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

DeviceCreateInfo& Magnum::Vk::DeviceCreateInfo::addEnabledExtensions(Containers::ArrayView<const Extension> extensions) &

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

DeviceCreateInfo&& Magnum::Vk::DeviceCreateInfo::addEnabledExtensions(Containers::ArrayView<const Extension> extensions) &&

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

DeviceCreateInfo& Magnum::Vk::DeviceCreateInfo::addEnabledExtensions(std::initializer_list<Extension> extension) &

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

DeviceCreateInfo&& Magnum::Vk::DeviceCreateInfo::addEnabledExtensions(std::initializer_list<Extension> extension) &&

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

template<class ... E>

DeviceCreateInfo& Magnum::Vk::DeviceCreateInfo::addEnabledExtensions() &

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

template<class ... E>

DeviceCreateInfo&& Magnum::Vk::DeviceCreateInfo::addEnabledExtensions() &&

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

DeviceCreateInfo& Magnum::Vk::DeviceCreateInfo::setEnabledFeatures(const DeviceFeatures& features) &

Add enabled device features.

All enabled features are expected to be reported as supported by the device and either their core version supported by the device or the corresponding extension enabled via addEnabledExtensions(). Use DeviceProperties::features() to check for feature support.

If Vulkan 1.1 is not supported and KHR_get_physical_device_properties2 is not enabled on the instance, the pEnabledFeatures field in VkDeviceCreateInfo is set to the Vulkan 1.0 subset of features. Otherwise, depending on what features are enabled, a subset of the following structures will be added to the pNext chain:

• VkPhysicalDeviceProtectedMemoryFeatures (Vulkan 1.1)
• VkPhysicalDeviceMultiviewFeatures (Vulkan 1.1, KHR_multiview)
• VkPhysicalDeviceShaderDrawParametersFeatures (Vulkan 1.1, KHR_shader_draw_parameters)
• VkPhysicalDeviceTextureCompressionASTCHDRFeaturesEXT ( EXT_texture_compression_astc_hdr)
• VkPhysicalDeviceShaderFloat16Int8Features (Vulkan 1.2, KHR_shader_float16_int8)
• VkPhysicalDevice16BitStorageFeatures (Vulkan 1.1, KHR_16bit_storage)
• VkPhysicalDeviceImagelessFramebufferFeatures (Vulkan 1.2, KHR_imageless_framebuffer)
• VkPhysicalDeviceVariablePointersFeatures (Vulkan 1.1, KHR_variable_pointers)
• VkPhysicalDeviceAccelerationStructureFeaturesKHR ( KHR_acceleration_structure)
• VkPhysicalDeviceSamplerYcbcrConversionFeatures (Vulkan 1.1, KHR_sampler_ycbcr_conversion)
• VkPhysicalDeviceDescriptorIndexingFeatures (Vulkan 1.2, EXT_descriptor_indexing)
• VkPhysicalDevicePortabilitySubsetFeaturesKHR ( KHR_portability_subset)
• VkPhysicalDeviceShaderSubgroupExtendedTypesFeatures (Vulkan 1.2, KHR_shader_subgroup_extended_types)
• VkPhysicalDevice8BitStorageFeatures (Vulkan 1.2, KHR_8bit_storage)
• VkPhysicalDeviceShaderAtomicInt64Features (Vulkan 1.2, KHR_shader_atomic_int64)
• VkPhysicalDeviceVertexAttributeDivisorFeaturesEXT ( EXT_vertex_attribute_divisor)
• VkPhysicalDeviceTimelineSemaphoreFeatures (Vulkan 1.2, KHR_timeline_semaphore)
• VkPhysicalDeviceVulkanMemoryModelFeatures (Vulkan 1.2, KHR_vulkan_memory_model)
• VkPhysicalDeviceScalarBlockLayoutFeatures (Vulkan 1.2, EXT_scalar_block_layout)
• VkPhysicalDeviceSeparateDepthStencilLayoutsFeatures (Vulkan 1.2, KHR_separate_depth_stencil_layouts)
• VkPhysicalDeviceUniformBufferStandardLayoutFeatures (Vulkan 1.2, KHR_uniform_buffer_standard_layout)
• VkPhysicalDeviceBufferDeviceAddressFeatures (Vulkan 1.2, KHR_buffer_device_address)
• VkPhysicalDeviceHostQueryResetFeatures (Vulkan 1.2, EXT_host_query_reset)
• VkPhysicalDeviceIndexTypeUint8FeaturesEXT ( EXT_index_type_uint8)
• VkPhysicalDeviceExtendedDynamicStateFeaturesEXT ( EXT_extended_dynamic_state)
• VkPhysicalDeviceRobustness2FeaturesEXT ( EXT_robustness2)
• VkPhysicalDeviceImageRobustnessFeaturesEXT ( EXT_image_robustness)
• VkPhysicalDeviceRayTracingPipelineFeaturesKHR ( KHR_ray_tracing_pipeline)
• VkPhysicalDeviceRayQueryFeaturesKHR ( KHR_ray_query)

DeviceCreateInfo&& Magnum::Vk::DeviceCreateInfo::setEnabledFeatures(const DeviceFeatures& features) &&

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

DeviceCreateInfo& Magnum::Vk::DeviceCreateInfo::addQueues(UnsignedInt family, Containers::ArrayView<const Float> priorities, Containers::ArrayView<const Containers::Reference<Queue>> output) &

Add queues.

At least one queue has to be added.

The following VkDeviceCreateInfo fields are set by this function:

• queueCreateInfoCount to the count of queues added previously by this function plus queues.size()
• pQueueCreateInfos to an array containing all queue create infos added previously by this function together with ones from family and priorities

DeviceCreateInfo&& Magnum::Vk::DeviceCreateInfo::addQueues(UnsignedInt family, Containers::ArrayView<const Float> priorities, Containers::ArrayView<const Containers::Reference<Queue>> output) &&

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

DeviceCreateInfo& Magnum::Vk::DeviceCreateInfo::addQueues(UnsignedInt family, std::initializer_list<Float> priorities, std::initializer_list<Containers::Reference<Queue>> output) &

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

DeviceCreateInfo&& Magnum::Vk::DeviceCreateInfo::addQueues(UnsignedInt family, std::initializer_list<Float> priorities, std::initializer_list<Containers::Reference<Queue>> output) &&

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

DeviceCreateInfo& Magnum::Vk::DeviceCreateInfo::addQueues(QueueFlags flags, Containers::ArrayView<const Float> priorities, Containers::ArrayView<const Containers::Reference<Queue>> output) &

Add queues of family matching given flags.

Equivalent to picking a queue family first using DeviceProperties::pickQueueFamily() based on flags and then calling the above addQueues() variant with the family index.

Note that DeviceProperties::pickQueueFamily() exits in case it doesn't find any family satisfying given flags — for a failproof scenario you may want to go with the above overload and DeviceProperties::tryPickQueueFamily() instead.

DeviceCreateInfo&& Magnum::Vk::DeviceCreateInfo::addQueues(QueueFlags flags, Containers::ArrayView<const Float> priorities, Containers::ArrayView<const Containers::Reference<Queue>> output) &&

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

DeviceCreateInfo& Magnum::Vk::DeviceCreateInfo::addQueues(QueueFlags flags, std::initializer_list<Float> priorities, std::initializer_list<Containers::Reference<Queue>> output) &

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

DeviceCreateInfo&& Magnum::Vk::DeviceCreateInfo::addQueues(QueueFlags flags, std::initializer_list<Float> priorities, std::initializer_list<Containers::Reference<Queue>> output) &&

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

DeviceCreateInfo& Magnum::Vk::DeviceCreateInfo::addQueues(const VkDeviceQueueCreateInfo& info) &

Add queues using raw info.

Compared to addQueues() this allows you to specify additional queue properties using the pNext chain. The info is used as-is, with all pointers expected to stay in scope until device creation.

The following VkDeviceCreateInfo fields are set by this function:

• queueCreateInfoCount to the count of queues added previously by this function plus 1
• pQueueCreateInfos to an array containing all queue create infos added previously by this function together with info

DeviceCreateInfo&& Magnum::Vk::DeviceCreateInfo::addQueues(const VkDeviceQueueCreateInfo& info) &&

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

const VkDeviceCreateInfo& Magnum::Vk::DeviceCreateInfo::operator*() const

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

VkDeviceCreateInfo* Magnum::Vk::DeviceCreateInfo::operator->()

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

const VkDeviceCreateInfo* Magnum::Vk::DeviceCreateInfo::operator->() const

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.