GstVulkan.VulkanFullScreenQuad¶

Subclasses:: None

Methods¶

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

class	`new` (queue)
	`draw` ()
	`enable_blend` (enable_blend)
	`enable_clear` (enable_clear)
	`fill_command_buffer` (cmd, fence)
	`get_last_fence` ()
	`get_queue` ()
	`prepare_draw` (fence)
	`set_blend_factors` (src_blend_factor, dst_blend_factor, src_alpha_blend_factor, dst_alpha_blend_factor)
	`set_blend_operation` (colour_blend_op, alpha_blend_op)
	`set_index_buffer` (indices, n_indices)
	`set_info` (in_info, out_info)
	`set_input_buffer` (buffer)
	`set_output_buffer` (buffer)
	`set_shaders` (vert, frag)
	`set_uniform_buffer` (uniforms)
	`set_vertex_buffer` (vertices)
	`submit` (cmd, fence)

Virtual Methods¶

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

Properties¶

Inherited:: Gst.Object (2)

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 `GstVulkan.VulkanCommandBuffer`'s from
descriptor_cache	`GstVulkan.VulkanDescriptorCache`	r	the configured `GstVulkan.VulkanDescriptorCache`
descriptor_set	`GstVulkan.VulkanDescriptorSet`	r	the configured `GstVulkan.VulkanDescriptorSet`
descriptor_set_layout	`GstVulkan.VulkanHandle`	r	the configured `VkDescriptorSetLayout`
framebuffer	`GstVulkan.VulkanHandle`	r	the configured `VkFramebuffer`
graphics_pipeline	`GstVulkan.VulkanHandle`	r	the configured `VkPipeline`
in_info	`GstVideo.VideoInfo`	r	the configured input `GstVideo.VideoInfo`
last_fence	`GstVulkan.VulkanFence`	r	the last configured `GstVulkan.VulkanFences`
out_info	`GstVideo.VideoInfo`	r	the configured output `GstVideo.VideoInfo`
parent	`Gst.Object`	r	the parent `Gst.Object`
pipeline_layout	`GstVulkan.VulkanHandle`	r	the configured `VkPipelineLayout`
queue	`GstVulkan.VulkanQueue`	r	the `GstVulkan.VulkanQueue` to submit `GstVulkan.VulkanCommandBuffer`'s on
render_pass	`GstVulkan.VulkanHandle`	r	the configured `VkRenderPass`
sampler	`GstVulkan.VulkanHandle`	r	the configured `VkSampler`
trash_list	`GstVulkan.VulkanTrashList`	r	the `GstVulkan.VulkanTrashList` for freeing unused resources

Class Details¶

class GstVulkan.VulkanFullScreenQuad(**kwargs)¶

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

New in version 1.18.

classmethod new(queue)¶

Parameters:: queue (GstVulkan.VulkanQueue) – a GstVulkan.VulkanQueue
Returns:: a new GstVulkan.VulkanFullScreenQuad
Return type:: GstVulkan.VulkanFullScreenQuad

New in version 1.18.

draw()¶

Raises:: GLib.Error
Returns:: whether the draw was successful
Return type:: bool

Helper function for creation and submission of a command buffer that draws a full screen quad. If you need to add other things to the command buffer, create the command buffer manually and call GstVulkan.VulkanFullScreenQuad.prepare_draw(), GstVulkan.VulkanFullScreenQuad.fill_command_buffer() and GstVulkan.VulkanFullScreenQuad.submit() instead.

New in version 1.18.

enable_blend(enable_blend)¶

Parameters:: enable_blend (bool) – whether to enable blending

Enables blending of the input image to the output image.

New in version 1.22.

enable_clear(enable_clear)¶

Parameters:: enable_clear (bool) – whether to clear the framebuffer on load

New in version 1.22.

fill_command_buffer(cmd, fence)¶

Parameters:

cmd (GstVulkan.VulkanCommandBuffer) – the GstVulkan.VulkanCommandBuffer to fill with commands
fence (GstVulkan.VulkanFence) –

Raises:

GLib.Error

Returns:

whether cmd could be filled with the necessary commands

Return type:

bool

New in version 1.18.

get_last_fence()¶

Return type:: GstVulkan.VulkanFence

get_queue()¶

Returns:: The currently configured GstVulkan.VulkanQueue
Return type:: GstVulkan.VulkanQueue or None

New in version 1.26.

prepare_draw(fence)¶

Parameters:: fence (GstVulkan.VulkanFence) – a GstVulkan.VulkanFence that will be signalled after submission
Raises:: GLib.Error
Returns:: whether the necessary information could be generated for drawing a frame.
Return type:: bool

New in version 1.18.

set_blend_factors(src_blend_factor, dst_blend_factor, src_alpha_blend_factor, dst_alpha_blend_factor)¶

Parameters:

src_blend_factor (Vulkan.BlendFactor) – the VkBlendFactor for the source image for the colour components (RGB)
dst_blend_factor (Vulkan.BlendFactor) – the VkBlendFactor for the destination image for the colour components (RGB)
src_alpha_blend_factor (Vulkan.BlendFactor) – the VkBlendFactor for the source image for the alpha component.
dst_alpha_blend_factor (Vulkan.BlendFactor) – the VkBlendFactor for the destination image for the alpha component.

You need to enable blend with GstVulkan.VulkanFullScreenQuad.enable_blend().

New in version 1.22.

set_blend_operation(colour_blend_op, alpha_blend_op)¶

Parameters:

colour_blend_op (Vulkan.BlendOp) – the VkBlendOp to use for blending colour (RGB) values
alpha_blend_op (Vulkan.BlendOp) – the VkBlendOp to use for blending alpha values

You need to enable blend with GstVulkan.VulkanFullScreenQuad.enable_blend().

New in version 1.22.

set_index_buffer(indices, n_indices)¶

Parameters:

indices (Gst.Memory) – the index data. Must be a GstVulkan.VulkanBufferMemory
n_indices (int) – number of indices in indices

Raises:

GLib.Error

Returns:

whether the index data could be set

Return type:

bool

New in version 1.18.

set_info(in_info, out_info)¶

Parameters:

in_info (GstVideo.VideoInfo) – the input GstVideo.VideoInfo to set
out_info (GstVideo.VideoInfo) – the output GstVideo.VideoInfo to set

Returns:

whether the information could be successfully set

Return type:

bool

New in version 1.18.

set_input_buffer(buffer)¶

Parameters:: buffer (Gst.Buffer or None) – the input Gst.Buffer to set
Raises:: GLib.Error
Returns:: whether the input buffer could be changed
Return type:: bool

New in version 1.18.

set_output_buffer(buffer)¶

Parameters:: buffer (Gst.Buffer or None) – the output Gst.Buffer to set
Raises:: GLib.Error
Returns:: whether the input buffer could be changed
Return type:: bool

New in version 1.18.

set_shaders(vert, frag)¶

Parameters:

vert (GstVulkan.VulkanHandle) – the vertex shader to set
frag (GstVulkan.VulkanHandle) – the fragment shader to set

Returns:

whether the shaders could be set

Return type:

bool

New in version 1.18.

set_uniform_buffer(uniforms)¶

Parameters:: uniforms (Gst.Memory) – the uniform data to set. Must be a GstVulkan.VulkanBufferMemory
Raises:: GLib.Error
Returns:: whether the shaders could be set
Return type:: bool

New in version 1.18.

set_vertex_buffer(vertices)¶

Parameters:: vertices (Gst.Memory) – the vertex data. Must be a GstVulkan.VulkanBufferMemory
Raises:: GLib.Error
Returns:: whether the index data could be set
Return type:: bool

New in version 1.18.

submit(cmd, fence)¶

Parameters:

cmd (GstVulkan.VulkanCommandBuffer) – a GstVulkan.VulkanCommandBuffer to submit
fence (GstVulkan.VulkanFence) – a GstVulkan.VulkanFence to signal on completion

Raises:

GLib.Error

Returns:

whether cmd could be submitted to the queue

Return type:

bool

New in version 1.18.