GstVulkan.VulkanSwapper

Subclasses:

None

Methods

Inherited:

Gst.Object (27), GObject.Object (37)

Structs:

GObject.ObjectClass (5)

class	new (device, window)
	choose_queue (available_queue)
	get_supported_caps ()
	get_surface_rectangles ()
	render_buffer (buffer)
	set_caps (caps)

Virtual Methods

Inherited:

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

Properties

Inherited:

Gst.Object (2)

Name	Type	Flags	Short Description
force-aspect-ratio	bool	r/w	When enabled, scaling will respect original aspect ratio
pixel-aspect-ratio	Gst.Fraction	r/w	The pixel aspect ratio of the device

Signals

Inherited:

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

Fields

Inherited:

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

Name	Type	Access	Description
cmd_pool	GstVulkan.VulkanCommandPool	r	the GstVulkan.VulkanCommandPool to allocate command buffers from
device	GstVulkan.VulkanDevice	r	the GstVulkan.VulkanDevice
parent	Gst.Object	r	parent Gst.Object
queue	GstVulkan.VulkanQueue	r	the GstVulkan.VulkanQueue to display with
window	GstVulkan.VulkanWindow	r	the GstVulkan.VulkanWindow to display into

Class Details

class GstVulkan.VulkanSwapper(**kwargs)

Bases:

Gst.Object

Abstract:

No

Structure:

GstVulkan.VulkanSwapperClass

New in version 1.18.

classmethod new(device, window)

Parameters:

• device (GstVulkan.VulkanDevice) –

• window (GstVulkan.VulkanWindow) –

Return type:

GstVulkan.VulkanSwapper

choose_queue(available_queue)

Parameters:

available_queue (GstVulkan.VulkanQueue or None) – a GstVulkan.VulkanQueue chosen elsewhere

Raises:

GLib.Error

Return type:

bool

get_supported_caps()

Raises:

GLib.Error

Return type:

Gst.Caps

get_surface_rectangles()

Returns:

input_image:

The GstVideo.VideoRectangle for the configured caps modified for DAR.

surface_location:

The GstVideo.VideoRectangle for where the output surface is located relative to its parent

display_rect:

The GstVideo.VideoRectangle for where the input images are placed inside surface_location

Return type:

(input_image: GstVideo.VideoRectangle or None, surface_location: GstVideo.VideoRectangle or None, display_rect: GstVideo.VideoRectangle or None)

New in version 1.18.

render_buffer(buffer)

Parameters:

buffer (Gst.Buffer) –

Raises:

GLib.Error

Return type:

bool

set_caps(caps)

Parameters:

caps (Gst.Caps) –

Raises:

GLib.Error

Return type:

bool

Property Details

GstVulkan.VulkanSwapper.props.force_aspect_ratio

Name:

force-aspect-ratio

Type:

bool

Default Value:

True

Flags:

READABLE, WRITABLE

When enabled, scaling will respect original aspect ratio

GstVulkan.VulkanSwapper.props.pixel_aspect_ratio

Name:

pixel-aspect-ratio

Type:

Gst.Fraction

Default Value:

None

Flags:

READABLE, WRITABLE

The pixel aspect ratio of the device