GstVulkanFullScreenQuad

A GstVulkan.VulkanFullScreenQuad is a helper object for rendering a single input image to an output Gst.Buffer

GstVulkan.VulkanFullScreenQuad

GObject.Object
    ╰──GObject.InitiallyUnowned
        ╰──Gst.Object
            ╰──GstVulkan.VulkanFullScreenQuad

Members

parent (Gst.Object) –

the parent Gst.Object

out_info (GstVideo.VideoInfo) –

the configured output GstVideo.VideoInfo

in_info (GstVideo.VideoInfo) –

the configured input GstVideo.VideoInfo

render_pass (GstVulkan.VulkanHandle) –

the configured VkRenderPass

pipeline_layout (GstVulkan.VulkanHandle) –

the configured VkPipelineLayout

graphics_pipeline (GstVulkan.VulkanHandle) –

the configured VkPipeline

descriptor_set_layout (GstVulkan.VulkanHandle) –

the configured VkDescriptorSetLayout

descriptor_set (GstVulkan.VulkanDescriptorSet) –

the configured GstVulkan.VulkanDescriptorSet

framebuffer (GstVulkan.VulkanHandle) –

the configured VkFramebuffer

sampler (GstVulkan.VulkanHandle) –

the configured VkSampler

trash_list (GstVulkan.VulkanTrashList) –

the GstVulkan.VulkanTrashList for freeing unused resources

last_fence (GstVulkan.VulkanFence) –

the last configured GstVulkan.VulkanFence

Since : 1.18


Constructors

GstVulkan.VulkanFullScreenQuad.prototype.new

function GstVulkan.VulkanFullScreenQuad.prototype.new(queue: GstVulkan.VulkanQueue): {
    // javascript wrapper for 'gst_vulkan_full_screen_quad_new'
}

Parameters:

Since : 1.18


Methods

GstVulkan.VulkanFullScreenQuad.prototype.draw

function GstVulkan.VulkanFullScreenQuad.prototype.draw(): {
    // javascript wrapper for 'gst_vulkan_full_screen_quad_draw'
}

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.prototype.prepare_draw, GstVulkan.VulkanFullScreenQuad.prototype.fill_command_buffer and GstVulkan.VulkanFullScreenQuad.prototype.submit instead.

Returns (Number)

whether the draw was successful

Since : 1.18


GstVulkan.VulkanFullScreenQuad.prototype.enable_blend

function GstVulkan.VulkanFullScreenQuad.prototype.enable_blend(enable_blend: Number): {
    // javascript wrapper for 'gst_vulkan_full_screen_quad_enable_blend'
}

Enables blending of the input image to the output image.

See also: GstVulkan.VulkanFullScreenQuad.prototype.set_blend_operation and GstVulkan.VulkanFullScreenQuad.prototype.set_blend_factors.

Parameters:

enable_blend (Number)

whether to enable blending

Since : 1.22


GstVulkan.VulkanFullScreenQuad.prototype.enable_clear

function GstVulkan.VulkanFullScreenQuad.prototype.enable_clear(enable_clear: Number): {
    // javascript wrapper for 'gst_vulkan_full_screen_quad_enable_clear'
}

Parameters:

enable_clear (Number)

whether to clear the framebuffer on load

Since : 1.22


GstVulkan.VulkanFullScreenQuad.prototype.fill_command_buffer

function GstVulkan.VulkanFullScreenQuad.prototype.fill_command_buffer(cmd: GstVulkan.VulkanCommandBuffer, fence: GstVulkan.VulkanFence): {
    // javascript wrapper for 'gst_vulkan_full_screen_quad_fill_command_buffer'
}

Parameters:

the GstVulkan.VulkanCommandBuffer to fill with commands

fence (GstVulkan.VulkanFence)
No description available
Returns (Number)

whether cmd could be filled with the necessary commands

Since : 1.18


GstVulkan.VulkanFullScreenQuad.prototype.get_last_fence

function GstVulkan.VulkanFullScreenQuad.prototype.get_last_fence(): {
    // javascript wrapper for 'gst_vulkan_full_screen_quad_get_last_fence'
}

Parameters:

No description available
Returns (GstVulkan.VulkanFence)
No description available

GstVulkan.VulkanFullScreenQuad.prototype.get_queue

function GstVulkan.VulkanFullScreenQuad.prototype.get_queue(): {
    // javascript wrapper for 'gst_vulkan_full_screen_quad_get_queue'
}
Returns (GstVulkan.VulkanQueue)

The currently configured GstVulkan.VulkanQueue

Since : 1.26


GstVulkan.VulkanFullScreenQuad.prototype.prepare_draw

function GstVulkan.VulkanFullScreenQuad.prototype.prepare_draw(fence: GstVulkan.VulkanFence): {
    // javascript wrapper for 'gst_vulkan_full_screen_quad_prepare_draw'
}

Parameters:

fence (GstVulkan.VulkanFence)

a GstVulkan.VulkanFence that will be signalled after submission

Returns (Number)

whether the necessary information could be generated for drawing a frame.

Since : 1.18


GstVulkan.VulkanFullScreenQuad.prototype.set_blend_factors

function GstVulkan.VulkanFullScreenQuad.prototype.set_blend_factors(src_blend_factor: Vulkan.BlendFactor, dst_blend_factor: Vulkan.BlendFactor, src_alpha_blend_factor: Vulkan.BlendFactor, dst_alpha_blend_factor: Vulkan.BlendFactor): {
    // javascript wrapper for 'gst_vulkan_full_screen_quad_set_blend_factors'
}

You need to enable blend with GstVulkan.VulkanFullScreenQuad.prototype.enable_blend.

See also: GstVulkan.VulkanFullScreenQuad.prototype.set_blend_operation.

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.

Since : 1.22


GstVulkan.VulkanFullScreenQuad.prototype.set_blend_operation

function GstVulkan.VulkanFullScreenQuad.prototype.set_blend_operation(colour_blend_op: Vulkan.BlendOp, alpha_blend_op: Vulkan.BlendOp): {
    // javascript wrapper for 'gst_vulkan_full_screen_quad_set_blend_operation'
}

You need to enable blend with GstVulkan.VulkanFullScreenQuad.prototype.enable_blend.

See also: GstVulkan.VulkanFullScreenQuad.prototype.set_blend_factors.

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

Since : 1.22


GstVulkan.VulkanFullScreenQuad.prototype.set_index_buffer

function GstVulkan.VulkanFullScreenQuad.prototype.set_index_buffer(indices: Gst.Memory, n_indices: Number): {
    // javascript wrapper for 'gst_vulkan_full_screen_quad_set_index_buffer'
}

See also GstVulkan.VulkanFullScreenQuad.prototype.set_vertex_buffer

Parameters:

indices (Gst.Memory)

the index data. Must be a GstVulkan.VulkanBufferMemory

n_indices (Number)

number of indices in indices

Returns (Number)

whether the index data could be set

Since : 1.18


GstVulkan.VulkanFullScreenQuad.prototype.set_info

function GstVulkan.VulkanFullScreenQuad.prototype.set_info(in_info: GstVideo.VideoInfo, out_info: GstVideo.VideoInfo): {
    // javascript wrapper for 'gst_vulkan_full_screen_quad_set_info'
}

Parameters:

in_info (GstVideo.VideoInfo)

the input GstVideo.VideoInfo to set

out_info (GstVideo.VideoInfo)

the output GstVideo.VideoInfo to set

Returns (Number)

whether the information could be successfully set

Since : 1.18


GstVulkan.VulkanFullScreenQuad.prototype.set_input_buffer

function GstVulkan.VulkanFullScreenQuad.prototype.set_input_buffer(buffer: Gst.Buffer): {
    // javascript wrapper for 'gst_vulkan_full_screen_quad_set_input_buffer'
}

Parameters:

buffer (Gst.Buffer)

the input Gst.Buffer to set

Returns (Number)

whether the input buffer could be changed

Since : 1.18


GstVulkan.VulkanFullScreenQuad.prototype.set_output_buffer

function GstVulkan.VulkanFullScreenQuad.prototype.set_output_buffer(buffer: Gst.Buffer): {
    // javascript wrapper for 'gst_vulkan_full_screen_quad_set_output_buffer'
}

Parameters:

buffer (Gst.Buffer)

the output Gst.Buffer to set

Returns (Number)

whether the input buffer could be changed

Since : 1.18


GstVulkan.VulkanFullScreenQuad.prototype.set_shaders

function GstVulkan.VulkanFullScreenQuad.prototype.set_shaders(vert: GstVulkan.VulkanHandle, frag: GstVulkan.VulkanHandle): {
    // javascript wrapper for 'gst_vulkan_full_screen_quad_set_shaders'
}

Parameters:

the vertex shader to set

the fragment shader to set

Returns (Number)

whether the shaders could be set

Since : 1.18


GstVulkan.VulkanFullScreenQuad.prototype.set_uniform_buffer

function GstVulkan.VulkanFullScreenQuad.prototype.set_uniform_buffer(uniforms: Gst.Memory): {
    // javascript wrapper for 'gst_vulkan_full_screen_quad_set_uniform_buffer'
}

Parameters:

uniforms (Gst.Memory)

the uniform data to set. Must be a GstVulkan.VulkanBufferMemory

Returns (Number)

whether the shaders could be set

Since : 1.18


GstVulkan.VulkanFullScreenQuad.prototype.set_vertex_buffer

function GstVulkan.VulkanFullScreenQuad.prototype.set_vertex_buffer(vertices: Gst.Memory): {
    // javascript wrapper for 'gst_vulkan_full_screen_quad_set_vertex_buffer'
}

Parameters:

vertices (Gst.Memory)

the vertex data. Must be a GstVulkan.VulkanBufferMemory

Returns (Number)

whether the index data could be set

Since : 1.18


GstVulkan.VulkanFullScreenQuad.prototype.submit

function GstVulkan.VulkanFullScreenQuad.prototype.submit(cmd: GstVulkan.VulkanCommandBuffer, fence: GstVulkan.VulkanFence): {
    // javascript wrapper for 'gst_vulkan_full_screen_quad_submit'
}
Returns (Number)

whether cmd could be submitted to the queue

Since : 1.18


The results of the search are