Main Vulkan context, allocated as AVHWDeviceContext.hwctx. More...

#include <hwcontext_vulkan.h>

Data Fields
const VkAllocationCallbacks *	alloc
	Custom memory allocator, else NULL. More...

PFN_vkGetInstanceProcAddr	get_proc_addr
	Pointer to the instance-provided vkGetInstanceProcAddr loading function. More...

VkInstance	inst
	Vulkan instance. More...

VkPhysicalDevice	phys_dev
	Physical device. More...

VkDevice	act_dev
	Active device. More...

VkPhysicalDeviceFeatures2	device_features
	This structure should be set to the set of features that present and enabled during device creation. More...

const char const	enabled_inst_extensions
	Enabled instance extensions. More...

int	nb_enabled_inst_extensions

const char const	enabled_dev_extensions
	Enabled device extensions. More...

int	nb_enabled_dev_extensions

int	queue_family_index
	Queue family index for graphics operations, and the number of queues enabled for it. More...

int	nb_graphics_queues

int	queue_family_tx_index
	Queue family index for transfer operations and the number of queues enabled. More...

int	nb_tx_queues

int	queue_family_comp_index
	Queue family index for compute operations and the number of queues enabled. More...

int	nb_comp_queues

int	queue_family_encode_index
	Queue family index for video encode ops, and the amount of queues enabled. More...

int	nb_encode_queues

int	queue_family_decode_index
	Queue family index for video decode ops, and the amount of queues enabled. More...

int	nb_decode_queues

void(*	lock_queue )(struct AVHWDeviceContext *ctx, uint32_t queue_family, uint32_t index)
	Locks a queue, preventing other threads from submitting any command buffers to this queue. More...

void(*	unlock_queue )(struct AVHWDeviceContext *ctx, uint32_t queue_family, uint32_t index)
	Similar to lock_queue(), unlocks a queue. More...

Detailed Description

Main Vulkan context, allocated as AVHWDeviceContext.hwctx.

All of these can be set before init to change what the context uses

Definition at line 44 of file hwcontext_vulkan.h.

Field Documentation

◆ alloc

const VkAllocationCallbacks* AVVulkanDeviceContext::alloc

Custom memory allocator, else NULL.

Definition at line 48 of file hwcontext_vulkan.h.

Referenced by alloc_mem(), avgblur_vulkan_uninit(), bwdif_vulkan_uninit(), chromaber_vulkan_uninit(), create_frame(), create_instance(), ff_vk_decode_free_frame(), flip_vulkan_uninit(), gblur_vulkan_uninit(), overlay_vulkan_uninit(), scale_vulkan_uninit(), transpose_vulkan_uninit(), uninit(), vulkan_device_create_internal(), vulkan_device_free(), and vulkan_frame_free().

◆ get_proc_addr

PFN_vkGetInstanceProcAddr AVVulkanDeviceContext::get_proc_addr

Pointer to the instance-provided vkGetInstanceProcAddr loading function.

If NULL, will pick either libvulkan or libvolk, depending on libavutil's compilation settings, and set this field.

Definition at line 55 of file hwcontext_vulkan.h.

Referenced by create_instance(), cuda_device_derive(), ff_vk_load_functions(), init_vulkan(), and load_libvulkan().

◆ inst

VkInstance AVVulkanDeviceContext::inst

Vulkan instance.

Must be at least version 1.3.

Definition at line 60 of file hwcontext_vulkan.h.

Referenced by create_instance(), cuda_device_derive(), ff_vk_load_functions(), find_device(), init_vulkan(), and vulkan_device_free().

◆ phys_dev

VkPhysicalDevice AVVulkanDeviceContext::phys_dev

Physical device.

Definition at line 65 of file hwcontext_vulkan.h.

Referenced by check_extensions(), cuda_device_derive(), ff_vk_filter_init_context(), find_device(), init_vulkan(), setup_queue_families(), try_export_flags(), vkfmt_from_pixfmt2(), vulkan_decode_get_profile(), vulkan_device_create_internal(), vulkan_device_init(), and vulkan_setup_profile().

◆ act_dev

VkDevice AVVulkanDeviceContext::act_dev

◆ device_features

VkPhysicalDeviceFeatures2 AVVulkanDeviceContext::device_features

This structure should be set to the set of features that present and enabled during device creation.

When a device is created by FFmpeg, it will default to enabling all that are present of the shaderImageGatherExtended, fragmentStoresAndAtomics, shaderInt64 and vertexPipelineStoresAndAtomics features.

Definition at line 78 of file hwcontext_vulkan.h.

Referenced by init_vulkan(), and vulkan_device_create_internal().

◆ enabled_inst_extensions

const char* const * AVVulkanDeviceContext::enabled_inst_extensions

Enabled instance extensions.

If supplying your own device context, set this to an array of strings, with each entry containing the specified Vulkan extension string to enable. Duplicates are possible and accepted. If no extensions are enabled, set these fields to NULL, and 0 respectively.

Definition at line 87 of file hwcontext_vulkan.h.

Referenced by create_instance(), and vulkan_device_free().

◆ nb_enabled_inst_extensions

int AVVulkanDeviceContext::nb_enabled_inst_extensions

Definition at line 88 of file hwcontext_vulkan.h.

Referenced by create_instance(), and vulkan_device_free().

◆ enabled_dev_extensions

const char* const * AVVulkanDeviceContext::enabled_dev_extensions

Enabled device extensions.

By default, VK_KHR_external_memory_fd, VK_EXT_external_memory_dma_buf, VK_EXT_image_drm_format_modifier, VK_KHR_external_semaphore_fd and VK_EXT_external_memory_host are enabled if found. If supplying your own device context, these fields takes the same format as the above fields, with the same conditions that duplicates are possible and accepted, and that NULL and 0 respectively means no extensions are enabled.

Definition at line 98 of file hwcontext_vulkan.h.

Referenced by ff_vk_filter_init_context(), init_vulkan(), vulkan_decode_bootstrap(), vulkan_device_create_internal(), vulkan_device_free(), and vulkan_device_init().

◆ nb_enabled_dev_extensions

int AVVulkanDeviceContext::nb_enabled_dev_extensions

Definition at line 99 of file hwcontext_vulkan.h.

Referenced by ff_vk_filter_init_context(), init_vulkan(), vulkan_decode_bootstrap(), vulkan_device_create_internal(), vulkan_device_free(), and vulkan_device_init().

◆ queue_family_index

int AVVulkanDeviceContext::queue_family_index

Queue family index for graphics operations, and the number of queues enabled for it.

If unavaiable, will be set to -1. Not required. av_hwdevice_create() will attempt to find a dedicated queue for each queue family, or pick the one with the least unrelated flags set. Queue indices here may overlap if a queue has to share capabilities.

Definition at line 108 of file hwcontext_vulkan.h.

Referenced by setup_queue_families(), and vulkan_device_init().