Functions

	context_get_vulkan_device (context, device)
	context_get_vulkan_display (context, display)
	context_get_vulkan_instance (context, instance)
	context_get_vulkan_queue (context, queue)
	context_set_vulkan_device (context, device)
	context_set_vulkan_display (context, display)
	context_set_vulkan_instance (context, instance)
	context_set_vulkan_queue (context, queue)
	is_vulkan_buffer_memory (mem)
	is_vulkan_image_memory (mem)
	is_vulkan_memory (mem)
	vulkan_buffer_memory_alloc (device, size, usage, mem_prop_flags)
	vulkan_buffer_memory_alloc_with_buffer_info (device, buffer_info, mem_prop_flags)
	vulkan_buffer_memory_init_once ()
	vulkan_buffer_memory_wrapped (device, buffer, usage, user_data, notify)
	vulkan_create_shader (device, code, size)
	vulkan_display_type_to_extension_string (type)
	vulkan_ensure_element_data (element, display_ptr, instance_ptr)
	vulkan_error_quark ()
	vulkan_format_get_aspect (format)
	vulkan_format_get_info (format)
	vulkan_format_to_video_format (vk_format)
	vulkan_get_or_create_image_view (image)
	vulkan_get_or_create_image_view_with_info (image, create_info)
	vulkan_global_context_query (element, context_type)
	vulkan_handle_context_query (element, query, display, instance, device)
	vulkan_handle_set_context (element, context, display, instance)
	vulkan_image_memory_alloc (device, format, width, height, tiling, usage, mem_prop_flags)
	vulkan_image_memory_alloc_with_image_info (device, image_info, mem_prop_flags)
	vulkan_image_memory_init_once ()
	vulkan_image_memory_wrapped (device, image, format, width, height, tiling, usage, user_data, notify)
	vulkan_local_context_query (element, context_type)
	vulkan_memory_alloc (device, memory_type_index, params, size, mem_prop_flags)
	vulkan_memory_find_memory_type_index_with_requirements (device, req, properties)
	vulkan_memory_heap_flags_to_string (prop_bits)
	vulkan_memory_init_once ()
	vulkan_memory_property_flags_to_string (prop_bits)
	vulkan_present_mode_to_string (present_mode)
	vulkan_run_query (element, query, direction)
	vulkan_sample_count_flags_to_string (sample_count_bits)
	vulkan_trash_mini_object_unref (device, user_data)
	vulkan_trash_object_unref (device, user_data)
	vulkan_window_error_quark ()

Details

GstVulkan.context_get_vulkan_device(context, device)

Parameters:

• context (Gst.Context) – a Gst.Context

• device (GstVulkan.VulkanDevice) – resulting GstVulkan.VulkanDevice

Returns:

Whether device was in context

Return type:

bool

New in version 1.18.

GstVulkan.context_get_vulkan_display(context, display)

Parameters:

• context (Gst.Context) – a Gst.Context

• display (GstVulkan.VulkanDisplay) – resulting GstVulkan.VulkanDisplay

Returns:

Whether display was in context

Return type:

bool

New in version 1.18.

GstVulkan.context_get_vulkan_instance(context, instance)

Parameters:

• context (Gst.Context) – a Gst.Context

• instance (GstVulkan.VulkanInstance) – resulting GstVulkan.VulkanInstance

Returns:

Whether instance was in context

Return type:

bool

New in version 1.18.

GstVulkan.context_get_vulkan_queue(context, queue)

Parameters:

• context (Gst.Context) – a Gst.Context

• queue (GstVulkan.VulkanQueue) – resulting GstVulkan.VulkanQueue

Returns:

Whether queue was in context

Return type:

bool

New in version 1.18.

GstVulkan.context_set_vulkan_device(context, device)

Parameters:

• context (Gst.Context) – a Gst.Context

• device (GstVulkan.VulkanDevice) – a GstVulkan.VulkanDevice

Sets device on context

New in version 1.18.

GstVulkan.context_set_vulkan_display(context, display)

Parameters:

• context (Gst.Context) – a Gst.Context

• display (GstVulkan.VulkanDisplay) – a GstVulkan.VulkanDisplay

Sets display on context

New in version 1.18.

GstVulkan.context_set_vulkan_instance(context, instance)

Parameters:

• context (Gst.Context) – a Gst.Context

• instance (GstVulkan.VulkanInstance) – a GstVulkan.VulkanInstance

Sets instance on context

New in version 1.18.

GstVulkan.context_set_vulkan_queue(context, queue)

Parameters:

• context (Gst.Context) – a Gst.Context

• queue (GstVulkan.VulkanQueue) – a GstVulkan.VulkanQueue

Sets queue on context

New in version 1.18.

GstVulkan.is_vulkan_buffer_memory(mem)

Parameters:

mem (Gst.Memory) – a Gst.Memory

Returns:

whether the memory at mem is a GstVulkan.VulkanBufferMemory

Return type:

bool

New in version 1.18.

GstVulkan.is_vulkan_image_memory(mem)

Parameters:

mem (Gst.Memory) – a Gst.Memory

Returns:

whether the memory at mem is a GstVulkan.VulkanImageMemory

Return type:

bool

New in version 1.18.

GstVulkan.is_vulkan_memory(mem)

Parameters:

mem (Gst.Memory) – a Gst.Memory

Returns:

whether the memory at mem is a GstVulkan.VulkanMemory

Return type:

bool

New in version 1.18.

GstVulkan.vulkan_buffer_memory_alloc(device, size, usage, mem_prop_flags)

Parameters:

• device (GstVulkan.VulkanDevice) – a GstVulkan.VulkanDevice

• size (int) – size of the new buffer

• usage (Vulkan.BufferUsageFlags) – buffer usage flags

• mem_prop_flags (Vulkan.MemoryPropertyFlags) – memory properties flags for the backing memory

Returns:

a Gst.Memory object backed by a vulkan buffer backed by vulkan device memory

Return type:

Gst.Memory

Allocate a new GstVulkan.VulkanBufferMemory.

New in version 1.18.

GstVulkan.vulkan_buffer_memory_alloc_with_buffer_info(device, buffer_info, mem_prop_flags)

Parameters:

• device (GstVulkan.VulkanDevice) – a GstVulkan.VulkanDevice

• buffer_info (Vulkan.BufferCreateInfo) – the Vulkan.BufferCreateInfo structure

• mem_prop_flags (Vulkan.MemoryPropertyFlags) – memory properties flags for the backing memory

Returns:

a Gst.Memory object backed by a vulkan buffer backed by vulkan device memory

Return type:

Gst.Memory

Allocate a new GstVulkan.VulkanBufferMemory.

New in version 1.24.

GstVulkan.vulkan_buffer_memory_init_once()

Initializes the Vulkan buffer memory allocator. It is safe to call this function multiple times. This must be called before any other GstVulkan.VulkanBufferMemory operation.

New in version 1.18.

GstVulkan.vulkan_buffer_memory_wrapped(device, buffer, usage, user_data, notify)

Parameters:

• device (GstVulkan.VulkanDevice) – a GstVulkan.VulkanDevice

• buffer (Vulkan.Buffer) – a VkBuffer

• usage (Vulkan.BufferUsageFlags) – usage flags of buffer

• user_data (object or None) – user data to call notify with

• notify (GLib.DestroyNotify or None) – a GLib.DestroyNotify called when buffer is no longer in use

Returns:

a Gst.Memory object backed by a vulkan device memory

Return type:

Gst.Memory

Allocated a new wrapped GstVulkan.VulkanBufferMemory with buffer.

New in version 1.18.

GstVulkan.vulkan_create_shader(device, code, size)

Parameters:

• device (GstVulkan.VulkanDevice) – a GstVulkan.VulkanDevice

• code (str) – the SPIR-V shader byte code

• size (int) – length of code. Must be a multiple of 4

Raises:

GLib.Error

Returns:

a GstVulkan.VulkanHandle for image matching the original layout and format of image or None

Return type:

GstVulkan.VulkanHandle

New in version 1.18.

GstVulkan.vulkan_display_type_to_extension_string(type)

Parameters:

type (GstVulkan.VulkanDisplayType) – a GstVulkan.VulkanDisplayType

Returns:

the Vulkan extension string required for creating a Vulkan.SurfaceKHR using a window system handle or None

Return type:

str or None

New in version 1.18.

GstVulkan.vulkan_ensure_element_data(element, display_ptr, instance_ptr)

Parameters:

• element (Gst.Element) – a Gst.Element

• display_ptr (GstVulkan.VulkanDisplay) – the resulting GstVulkan.VulkanDisplay

• instance_ptr (GstVulkan.VulkanInstance) – the resulting GstVulkan.VulkanInstance

Returns:

whether a GstVulkan.VulkanInstance exists in instance_ptr and if display_ptr is not None, whether a GstVulkan.VulkanDisplay exists in display_ptr

display_ptr:

the resulting GstVulkan.VulkanDisplay

instance_ptr:

the resulting GstVulkan.VulkanInstance

Return type:

(bool, display_ptr: GstVulkan.VulkanDisplay, instance_ptr: GstVulkan.VulkanInstance)

Perform the steps necessary for retrieving a GstVulkan.VulkanInstance and (optionally) an GstVulkan.VulkanDisplay from the surrounding elements or from the application using the Gst.Context mechanism.

If the contents of display_ptr or instance_ptr are not None, then no Gst.Context query is necessary and no GstVulkan.VulkanInstance or GstVulkan.VulkanDisplay retrieval is performed.

New in version 1.18.

GstVulkan.vulkan_error_quark()

Return type:

int

New in version 1.18.

GstVulkan.vulkan_format_get_aspect(format)

Parameters:

format (Vulkan.Format) – Vulkan Format

Returns:

the format aspect

Return type:

int

New in version 1.24.

GstVulkan.vulkan_format_get_info(format)

Parameters:

format (Vulkan.Format) – a valid VkFormat

Returns:

the GstVulkan.VulkanFormatInfo for format or None

Return type:

GstVulkan.VulkanFormatInfo or None

New in version 1.18.

GstVulkan.vulkan_format_to_video_format(vk_format)

Parameters:

vk_format (Vulkan.Format) – the Vulkan format to convert

Returns:

the GstVideo.VideoFormat that maps to vk_format

Return type:

GstVideo.VideoFormat

New in version 1.24.

GstVulkan.vulkan_get_or_create_image_view(image)

Parameters:

image (GstVulkan.VulkanImageMemory) – a GstVulkan.VulkanImageMemory

Returns:

a GstVulkan.VulkanImageView for image matching the original layout and format of image

Return type:

GstVulkan.VulkanImageView

New in version 1.18.

GstVulkan.vulkan_get_or_create_image_view_with_info(image, create_info)

Parameters:

• image (GstVulkan.VulkanImageMemory) – a GstVulkan.VulkanImageMemory

• create_info (Vulkan.ImageViewCreateInfo or None) – a Vulkan.ImageViewCreateInfo

Returns:

a GstVulkan.VulkanImageView for image matching the original layout and format of image

Return type:

GstVulkan.VulkanImageView

Create a new GstVulkan.VulkanImageView with a specific create_info.

New in version 1.24.

GstVulkan.vulkan_global_context_query(element, context_type)

Parameters:

• element (Gst.Element) – a Gst.Element

• context_type (str) – the context type to query for

Performs the steps necessary for executing a context query including posting a message for the application to respond.

New in version 1.18.

GstVulkan.vulkan_handle_context_query(element, query, display, instance, device)

Parameters:

• element (Gst.Element) – a Gst.Element

• query (Gst.Query) – a Gst.Query of type Gst.QueryType.CONTEXT

• display (GstVulkan.VulkanDisplay or None) – a GstVulkan.VulkanDisplay

• instance (GstVulkan.VulkanInstance or None) – a GstVulkan.VulkanInstance

• device (GstVulkan.VulkanDevice or None) – a GstVulkan.VulkanInstance

Returns:

Whether the query was successfully responded to from the passed display, instance, and device.

Return type:

bool

New in version 1.18.

GstVulkan.vulkan_handle_set_context(element, context, display, instance)

Parameters:

• element (Gst.Element) – a Gst.Element

• context (Gst.Context) – a Gst.Context

• display (GstVulkan.VulkanDisplay) – location of a GstVulkan.VulkanDisplay

• instance (GstVulkan.VulkanInstance) – location of a GstVulkan.VulkanInstance

Returns:

whether the display or instance could be set successfully

display:

location of a GstVulkan.VulkanDisplay

instance:

location of a GstVulkan.VulkanInstance

Return type:

(bool, display: GstVulkan.VulkanDisplay, instance: GstVulkan.VulkanInstance)

Helper function for implementing Gst.Element.do_set_context() in Vulkan capable elements.

Retrieve’s the GstVulkan.VulkanDisplay or GstVulkan.VulkanInstance in context and places the result in display or instance respectively.

New in version 1.18.

GstVulkan.vulkan_image_memory_alloc(device, format, width, height, tiling, usage, mem_prop_flags)

Parameters:

• device (GstVulkan.VulkanDevice) – a GstVulkan.VulkanDevice

• format (Vulkan.Format) – the Vulkan.Format for the new image

• width (int) – width for the new image

• height (int) – height for the new image

• tiling (Vulkan.ImageTiling) – tiling for the new image

• usage (Vulkan.ImageUsageFlags) – usage flags for the new image

• mem_prop_flags (Vulkan.MemoryPropertyFlags) – Vulkan.DeviceMemory property flags for the new image

Returns:

a Gst.Memory object backed by a vulkan device memory

Return type:

Gst.Memory

Allocated a new GstVulkan.VulkanImageMemory.

New in version 1.18.

GstVulkan.vulkan_image_memory_alloc_with_image_info(device, image_info, mem_prop_flags)

Parameters:

• device (GstVulkan.VulkanDevice) – a GstVulkan.VulkanDevice

• image_info (Vulkan.ImageCreateInfo) – Vulkan.ImageCreateInfo structure

• mem_prop_flags (Vulkan.MemoryPropertyFlags) – Vulkan.MemoryPropertyFlags flags

Returns:

a Gst.Memory object backed by a vulkan device memory

Return type:

Gst.Memory

New in version 1.24.

GstVulkan.vulkan_image_memory_init_once()

Initializes the Vulkan image memory allocator. It is safe to call this function multiple times. This must be called before any other GstVulkan.VulkanImageMemory operation.

New in version 1.18.

GstVulkan.vulkan_image_memory_wrapped(device, image, format, width, height, tiling, usage, user_data, notify)

Parameters:

• device (GstVulkan.VulkanDevice) – a GstVulkan.VulkanDevice

• image (Vulkan.Image) – a Vulkan.Image

• format (Vulkan.Format) – the Vulkan.Format for image

• width (int) – width of image

• height (int) – height of image

• tiling (Vulkan.ImageTiling) – tiling of image

• usage (Vulkan.ImageUsageFlags) – usage flags of image

• user_data (object or None) – user data for notify

• notify (GLib.DestroyNotify) – a GLib.DestroyNotify when image is no longer needed

Returns:

a new GstVulkan.VulkanImageMemory wrapping image

Return type:

Gst.Memory

New in version 1.18.

GstVulkan.vulkan_local_context_query(element, context_type)

Parameters:

• element (Gst.Element) – a Gst.Element

• context_type (str) – the context type to query for

Return type:

Gst.Query

Performs the steps necessary for executing a context query between only other elements in the pipeline

New in version 1.18.

GstVulkan.vulkan_memory_alloc(device, memory_type_index, params, size, mem_prop_flags)

Parameters:

• device (GstVulkan.VulkanDevice) – a GstVulkan.VulkanDevice

• memory_type_index (int) – the Vulkan memory type index

• params (Gst.AllocationParams) – a Gst.AllocationParams

• size (int) – the size to allocate

• mem_prop_flags (Vulkan.MemoryPropertyFlags) –

Returns:

a Gst.Memory object backed by a vulkan device memory

Return type:

Gst.Memory

Allocated a new GstVulkan.VulkanMemory.

New in version 1.18.

GstVulkan.vulkan_memory_find_memory_type_index_with_requirements(device, req, properties)

Parameters:

• device (GstVulkan.VulkanDevice) – a GstVulkan.VulkanDevice

• req (Vulkan.MemoryRequirements) – memory requirements to look for

• properties (Vulkan.MemoryPropertyFlags) – memory properties to search for

Returns:

whether a valid memory type could be found

type_index:

resulting index of the memory type

Return type:

(bool, type_index: int)

New in version 1.24.

GstVulkan.vulkan_memory_heap_flags_to_string(prop_bits)

Parameters:

prop_bits (Vulkan.MemoryHeapFlags) –

Return type:

str

New in version 1.18.

GstVulkan.vulkan_memory_init_once()

Initializes the Vulkan memory allocator. It is safe to call this function multiple times. This must be called before any other GstVulkan.VulkanMemory operation.

New in version 1.18.

GstVulkan.vulkan_memory_property_flags_to_string(prop_bits)

Parameters:

prop_bits (Vulkan.MemoryPropertyFlags) –

Return type:

str

New in version 1.18.

GstVulkan.vulkan_present_mode_to_string(present_mode)

Parameters:

present_mode (Vulkan.PresentModeKHR) – a VkPresentModeKHR

Returns:

name of present_mode

Return type:

str

New in version 1.20.

GstVulkan.vulkan_run_query(element, query, direction)

Parameters:

• element (Gst.Element) – a Gst.Element

• query (Gst.Query) – the Gst.Query to perform

• direction (Gst.PadDirection) – the Gst.PadDirection to perform query on

Returns:

whether query was answered successfully

Return type:

bool

New in version 1.18.

GstVulkan.vulkan_sample_count_flags_to_string(sample_count_bits)

Parameters:

sample_count_bits (Vulkan.SampleCountFlags) –

Return type:

str

New in version 1.18.

GstVulkan.vulkan_trash_mini_object_unref(device, user_data)

Parameters:

• device (GstVulkan.VulkanDevice) – the GstVulkan.VulkanDevice

• user_data (object or None) – the Gst.MiniObject

A GstVulkan.VulkanTrashNotify implementation for unreffing a Gst.MiniObject when the associated GstVulkan.VulkanFence is signalled

New in version 1.18.

GstVulkan.vulkan_trash_object_unref(device, user_data)

Parameters:

• device (GstVulkan.VulkanDevice) – the GstVulkan.VulkanDevice

• user_data (object or None) – the Gst.MiniObject

A GstVulkan.VulkanTrashNotify implementation for unreffing a Gst.Object when the associated GstVulkan.VulkanFence is signalled

New in version 1.18.

GstVulkan.vulkan_window_error_quark()

Return type:

int

New in version 1.18.