GstVulkan.VulkanDisplay¶

Subclasses:: None

Methods¶

Inherited:: Gst.Object (27), GObject.Object (37)
Structs:: GObject.ObjectClass (5)

class	`choose_type` (instance)
class	`handle_context_query` (element, query, display)
class	`new` (instance)
class	`new_with_type` (instance, type)
class	`run_context_query` (element, display)
	`create_window` ()
	`find_window` (data, compare_func)
	`get_handle` ()
	`get_handle_type` ()
	`remove_window` (window)

Virtual Methods¶

Inherited:: Gst.Object (1), GObject.Object (7)

	`do_create_window` ()
	`do_get_handle` ()

Properties¶

Inherited:: Gst.Object (2)

Signals¶

Inherited:: Gst.Object (1), GObject.Object (1)

Fields¶

Inherited:: Gst.Object (1), GObject.Object (1)

Name	Type	Access
event_source	`GLib.Source`	r
instance	`GstVulkan.VulkanInstance`	r
main_context	`GLib.MainContext`	r
main_loop	`GLib.MainLoop`	r
object	`Gst.Object`	r
type	`GstVulkan.VulkanDisplayType`	r
windows	[`object`]	r

Class Details¶

class GstVulkan.VulkanDisplay(**kwargs)¶

Bases:: Gst.Object
Abstract:: No
Structure:: GstVulkan.VulkanDisplayClass

The contents of a GstVulkan.VulkanDisplay are private and should only be accessed through the provided API

New in version 1.18.

classmethod choose_type(instance)¶

Parameters:: instance (GstVulkan.VulkanInstance) – a GstVulkan.VulkanInstance
Returns:: the default GstVulkan.VulkanDisplayType GstVulkan.VulkanInstance will choose on creation
Return type:: GstVulkan.VulkanDisplayType

This function will read the GST_VULKAN_WINDOW environment variable for a user choice or choose the first supported implementation.

GstVulkan.VulkanInstance.fill_info() must have been called prior to this function.

New in version 1.18.

classmethod handle_context_query(element, query, display)¶

Parameters:

element (Gst.Element) – a Gst.Element
query (Gst.Query) – a Gst.Query of type Gst.QueryType.CONTEXT
display (GstVulkan.VulkanDisplay or None) – the GstVulkan.VulkanDisplay

Returns:

whether query was responded to with display

Return type:

bool

If a GstVulkan.VulkanDisplay is requested in query, sets device as the reply.

Intended for use with element query handlers to respond to Gst.QueryType.CONTEXT for a GstVulkan.VulkanDisplay.

New in version 1.18.

classmethod new(instance)¶

Parameters:: instance (GstVulkan.VulkanInstance) –
Returns:: a new GstVulkan.VulkanDisplay
Return type:: GstVulkan.VulkanDisplay

New in version 1.18.

classmethod new_with_type(instance, type)¶

Parameters:

instance (GstVulkan.VulkanInstance) – a GstVulkan.VulkanInstance
type (GstVulkan.VulkanDisplayType) – the GstVulkan.VulkanDisplayType to create

Returns:

a new GstVulkan.VulkanDisplay or None if e.g. type is unsupported

Return type:

GstVulkan.VulkanDisplay or None

New in version 1.18.

classmethod run_context_query(element, display)¶

Parameters:

element (Gst.Element) – a Gst.Element
display (GstVulkan.VulkanDisplay) – a GstVulkan.VulkanDisplay

Returns:

whether display contains a valid GstVulkan.VulkanDisplay

display:: a GstVulkan.VulkanDisplay

Return type:

(bool, display: GstVulkan.VulkanDisplay)

Attempt to retrieve a GstVulkan.VulkanDisplay using Gst.QueryType.CONTEXT from the surrounding elements of element.

New in version 1.18.

create_window()¶

Returns:: a new GstVulkan.VulkanWindow for self or None.
Return type:: GstVulkan.VulkanWindow or None

New in version 1.18.

find_window(data, compare_func)¶

Parameters:

data (object or None) – some data to pass to compare_func
compare_func (GLib.CompareFunc) – a comparison function to run

Returns:

The first GstVulkan.VulkanWindow that compare_func matches, or None

Return type:

GstVulkan.VulkanWindow or None

Execute compare_func over the list of windows stored by self. The first argument to compare_func is the GstVulkan.VulkanWindow being checked and the second argument is data.

New in version 1.18.

get_handle()¶

Returns:: the winsys specific handle of self
Return type:: object or None

New in version 1.18.

get_handle_type()¶

Returns:: the GstVulkan.VulkanDisplayType of self
Return type:: GstVulkan.VulkanDisplayType

New in version 1.18.

remove_window(window)¶

Parameters:: window (GstVulkan.VulkanWindow) – the GstVulkan.VulkanWindow to remove
Returns:: whether the window was successfully removed
Return type:: bool

New in version 1.18.

do_create_window() virtual¶

Returns:: a new GstVulkan.VulkanWindow for display or None.
Return type:: GstVulkan.VulkanWindow or None

create a window

New in version 1.18.

do_get_handle() virtual¶

Returns:: the winsys specific handle of display
Return type:: object or None

get the native handle to the display

New in version 1.18.