GstVulkan.VulkanPhysicalDevice¶

Subclasses:: None

Methods¶

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

class	`new` (instance, device_index)
class	`type_to_string` (type)
	`check_api_version` (major, minor, patch)
	`get_api_version` ()
	`get_extension_info` (name)
	`get_instance` ()
	`get_layer_info` (name)

Virtual Methods¶

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

Properties¶

Inherited:: Gst.Object (2)

Name	Type	Flags	Short Description
`device-index`	`int`	r/w/co	Device Index
`instance`	`GstVulkan.VulkanInstance`	r/w/co	Associated Vulkan Instance

Signals¶

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

Fields¶

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

Name	Type	Access	Description
device	`Vulkan.PhysicalDevice`	r	the vulkan physical device handle
device_index	`int`	r	the index into the physical device list in instance
features	`Vulkan.PhysicalDeviceFeatures`	r	retrieved physical device features
instance	`GstVulkan.VulkanInstance`	r	the parent `GstVulkan.VulkanInstance` for this physical device
memory_properties	`Vulkan.PhysicalDeviceMemoryProperties`	r	retrieved physical device memory properties
n_queue_families	`int`	r	number of elements in queue_family_props
parent	`Gst.Object`	r	the parent `Gst.Object`
properties	`Vulkan.PhysicalDeviceProperties`	r	retrieved physical device properties
queue_family_ops	`GstVulkan.VulkanQueueFamilyOps`	r	vulkan operations allowed per queue family
queue_family_props	`Vulkan.QueueFamilyProperties`	r	vulkan family properties

Class Details¶

class GstVulkan.VulkanPhysicalDevice(**kwargs)¶

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

New in version 1.18.

classmethod new(instance, device_index)¶

Parameters:

instance (GstVulkan.VulkanInstance) – the parent GstVulkan.VulkanInstance
device_index (int) –

Returns:

a new GstVulkan.VulkanPhysicalDevice

Return type:

GstVulkan.VulkanPhysicalDevice

New in version 1.18.

classmethod type_to_string(type)¶

Parameters:: type (Vulkan.PhysicalDeviceType) – a `:obj:Vulkan.PhysicalDeviceType
Returns:: name of type
Return type:: str

New in version 1.18.

check_api_version(major, minor, patch)¶

Parameters:

major (int) – the API major version to check
minor (int) – the API minor version to check
patch (int) – the API patch version to check

Returns:

whether the GstVulkan.VulkanPhysicalDevice supports the version specified by major, minor and patch.

Return type:

bool

Note: This is the intersection of the exposed supported API version as would be returned by GstVulkan.VulkanPhysicalDevice.get_api_version() and GstVulkan.VulkanInstance.check_version(). The latter will take into account any requested API version and may result in a different result than directly comparing against GstVulkan.VulkanInstance.get_version().

New in version 1.26.

get_api_version()¶

Returns:

major:: major version
minor:: minor version
patch:: patch version

Return type:

(major: int, minor: int, patch: int)

Retrieves the advertised Vulkan API version of the GstVulkan.VulkanPhysicalDevice.

New in version 1.26.

get_extension_info(name)¶

Parameters:

name (str) – the extension name to look for

Returns:

whether extension name is available

spec_version:: return value for the exteion specification version

Return type:

(bool, spec_version: int)

Retrieves information about a device extension.

Will not find any extensions before GstVulkan.VulkanInstance.fill_info() has been called.

New in version 1.18.

get_instance()¶

Returns:: The GstVulkan.VulkanInstance associated with this physical device
Return type:: GstVulkan.VulkanInstance

New in version 1.18.

get_layer_info(name)¶

Parameters:

name (str) – the layer name to look for

Returns:

whether layer name is available

description:: return value for the layer description or None
spec_version:: return value for the layer specification version
implementation_version:: return value for the layer implementation version

Return type:

(bool, description: str or None, spec_version: int, implementation_version: int)

Retrieves information about a layer.

Will not find any layers before GstVulkan.VulkanInstance.fill_info() has been called.

New in version 1.18.

Property Details¶

GstVulkan.VulkanPhysicalDevice.props.device_index¶

Name:: device-index
Type:: int
Default Value:: 0
Flags:: READABLE, WRITABLE, CONSTRUCT_ONLY

Device Index

GstVulkan.VulkanPhysicalDevice.props.instance¶

Name:: instance
Type:: GstVulkan.VulkanInstance
Default Value:: None
Flags:: READABLE, WRITABLE, CONSTRUCT_ONLY

Associated Vulkan Instance