gstreamer/subprojects/gst-plugins-bad/gst-libs/gst/vulkan/gstvkfullscreenquad.h

/*
 * GStreamer Plugins
 * Copyright (C) 2019 Matthew Waters <matthew@centricular.com>
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Library General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Library General Public License for more details.
 *
 * You should have received a copy of the GNU Library General Public
 * License along with this library; if not, write to the
 * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
 * Boston, MA 02110-1301, USA.
 */

#ifndef __GST_VULKAN_FULL_SCREEN_QUAD_H__
#define __GST_VULKAN_FULL_SCREEN_QUAD_H__


#include <gst/gst.h>

#include <gst/vulkan/vulkan.h>

G_BEGIN_DECLS

GST_VULKAN_API
GType gst_vulkan_full_screen_quad_get_type (void);
#define GST_TYPE_VULKAN_FULL_SCREEN_QUAD            (gst_vulkan_full_screen_quad_get_type ())
#define GST_VULKAN_FULL_SCREEN_QUAD(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), GST_TYPE_VULKAN_FULL_SCREEN_QUAD, GstVulkanFullScreenQuad))
#define GST_VULKAN_FULL_SCREEN_QUAD_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST ((klass), GST_TYPE_VULKAN_FULL_SCREEN_QUAD, GstVulkanFullScreenQuadClass))
#define GST_IS_VULKAN_FULL_SCREEN_QUAD(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GST_TYPE_VULKAN_FULL_SCREEN_QUAD))
#define GST_IS_VULKAN_FULL_SCREEN_QUAD_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GST_TYPE_VULKAN_FULL_SCREEN_QUAD))
#define GST_VULKAN_FULL_SCREEN_QUAD_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS ((obj), GST_TYPE_VULKAN_FULL_SCREEN_QUAD, GstVulkanFullScreenQuadClass))

/**
 * GstVulkanFullScreenQuad:
 * @parent: the parent #GstObject
 * @in_info: the configured input #GstVideoInfo
 * @out_info: the configured output #GstVideoInfo
 * @queue: the #GstVulkanQueue to submit #GstVulkanCommandBuffer's on
 * @render_pass: the configured `VkRenderPass`
 * @pipeline_layout: the configured `VkPipelineLayout`
 * @graphics_pipeline: the configured `VkPipeline`
 * @descriptor_set_layout: the configured `VkDescriptorSetLayout`
 * @descriptor_cache: the configured #GstVulkanDescriptorCache
 * @descriptor_set: the configured #GstVulkanDescriptorSet
 * @framebuffer: the configured `VkFramebuffer`
 * @sampler: the configured `VkSampler`
 * @cmd_pool: the #GstVulkanCommandPool to allocate #GstVulkanCommandBuffer's from
 * @trash_list: the #GstVulkanTrashList for freeing unused resources
 * @last_fence: the last configured #GstVulkanFences
 *
 * Since: 1.18
 */
struct _GstVulkanFullScreenQuad
{
  GstObject                         parent;

  /* <protected> */
  GstVideoInfo                      out_info;
  GstVideoInfo                      in_info;

  GstVulkanQueue                   *queue;

  GstVulkanHandle                  *render_pass;
  GstVulkanHandle                  *pipeline_layout;
  GstVulkanHandle                  *graphics_pipeline;
  GstVulkanHandle                  *descriptor_set_layout;
  GstVulkanDescriptorCache         *descriptor_cache;
  GstVulkanDescriptorSet           *descriptor_set;
  GstVulkanHandle                  *framebuffer;
  GstVulkanHandle                  *sampler;

  GstVulkanCommandPool             *cmd_pool;

  GstVulkanTrashList               *trash_list;
  GstVulkanFence                   *last_fence;

  /* <private> */
  gpointer _reserved        [GST_PADDING];
};

/**
 * GstVulkanFullScreenQuadClass:
 * @parent_class: the parent #GstObjectClass
 *
 * Since: 1.18
 */
struct _GstVulkanFullScreenQuadClass
{
  GstObjectClass                    parent_class;

  /* <private> */
  gpointer _reserved        [GST_PADDING];
};

G_DEFINE_AUTOPTR_CLEANUP_FUNC (GstVulkanFullScreenQuad, gst_object_unref)

GST_VULKAN_API
GstVulkanFullScreenQuad *   gst_vulkan_full_screen_quad_new         (GstVulkanQueue * queue);

GST_VULKAN_API
gboolean            gst_vulkan_full_screen_quad_set_info            (GstVulkanFullScreenQuad * self, const GstVideoInfo *in_info, const GstVideoInfo * out_info);
GST_VULKAN_API
gboolean            gst_vulkan_full_screen_quad_set_shaders         (GstVulkanFullScreenQuad * self, GstVulkanHandle * vert, GstVulkanHandle * frag);
GST_VULKAN_API
gboolean            gst_vulkan_full_screen_quad_set_uniform_buffer  (GstVulkanFullScreenQuad * self, GstMemory * uniforms, GError ** error);
GST_VULKAN_API
gboolean            gst_vulkan_full_screen_quad_set_vertex_buffer   (GstVulkanFullScreenQuad * self, GstMemory * vertices, GError ** error);
GST_VULKAN_API
gboolean            gst_vulkan_full_screen_quad_set_index_buffer    (GstVulkanFullScreenQuad * self, GstMemory * indices, gsize n_indices, GError ** error);

GST_VULKAN_API
gboolean            gst_vulkan_full_screen_quad_set_input_buffer    (GstVulkanFullScreenQuad * self, GstBuffer * buffer, GError ** error);
GST_VULKAN_API
gboolean            gst_vulkan_full_screen_quad_set_output_buffer   (GstVulkanFullScreenQuad * self, GstBuffer * buffer, GError ** error);
GST_VULKAN_API
void                gst_vulkan_full_screen_quad_enable_blend        (GstVulkanFullScreenQuad * self,
                                                                     gboolean enable_blend);
GST_VULKAN_API
void                gst_vulkan_full_screen_quad_set_blend_operation (GstVulkanFullScreenQuad * self,
                                                                     VkBlendOp colour_blend_op,
                                                                     VkBlendOp alpha_blend_op);
GST_VULKAN_API
void                gst_vulkan_full_screen_quad_set_blend_factors   (GstVulkanFullScreenQuad * self,
                                                                     VkBlendFactor src_blend_factor,
                                                                     VkBlendFactor dst_blend_factor,
                                                                     VkBlendFactor src_alpha_blend_factor,
                                                                     VkBlendFactor dst_alpha_blend_factor);
GST_VULKAN_API
void                gst_vulkan_full_screen_quad_enable_clear        (GstVulkanFullScreenQuad * self,
                                                                     gboolean enable_clear);

GST_VULKAN_API
gboolean            gst_vulkan_full_screen_quad_prepare_draw        (GstVulkanFullScreenQuad * self, GstVulkanFence * fence, GError ** error);
GST_VULKAN_API
gboolean            gst_vulkan_full_screen_quad_fill_command_buffer (GstVulkanFullScreenQuad * self, GstVulkanCommandBuffer * cmd, GstVulkanFence * fence, GError ** error);
GST_VULKAN_API
gboolean            gst_vulkan_full_screen_quad_submit              (GstVulkanFullScreenQuad * self, GstVulkanCommandBuffer * cmd, GstVulkanFence * fence, GError ** error);
GST_VULKAN_API
gboolean            gst_vulkan_full_screen_quad_draw                (GstVulkanFullScreenQuad * self, GError ** error);

GST_VULKAN_API
GstVulkanFence *    gst_vulkan_full_screen_quad_get_last_fence      (GstVulkanFullScreenQuad * self);

GST_VULKAN_API
GstVulkanQueue *    gst_vulkan_full_screen_quad_get_queue           (GstVulkanFullScreenQuad * self);

G_END_DECLS
#endif /* __GST_VULKAN_FULL_SCREEN_QUAD_H__ */