vulkan: fix up some gir annotations
[platform/upstream/gstreamer.git] / ext / vulkan / vkfullscreenquad.h
1 /*
2  * GStreamer Plugins
3  * Copyright (C) 2019 Matthew Waters <matthew@centricular.com>
4  *
5  * This library is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU Library General Public
7  * License as published by the Free Software Foundation; either
8  * version 2 of the License, or (at your option) any later version.
9  *
10  * This library is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13  * Library General Public License for more details.
14  *
15  * You should have received a copy of the GNU Library General Public
16  * License along with this library; if not, write to the
17  * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
18  * Boston, MA 02110-1301, USA.
19  */
20
21 #ifndef __GST_VULKAN_FULL_SCREEN_QUAD_H__
22 #define __GST_VULKAN_FULL_SCREEN_QUAD_H__
23
24
25 #include <gst/gst.h>
26
27 #include <gst/vulkan/vulkan.h>
28
29 G_BEGIN_DECLS
30
31 GType gst_vulkan_full_screen_quad_get_type (void);
32 #define GST_TYPE_VULKAN_FULL_SCREEN_QUAD            (gst_vulkan_full_screen_quad_get_type ())
33 #define GST_VULKAN_FULL_SCREEN_QUAD(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), GST_TYPE_VULKAN_FULL_SCREEN_QUAD, GstVulkanFullScreenQuad))
34 #define GST_VULKAN_FULL_SCREEN_QUAD_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST ((klass), GST_TYPE_VULKAN_FULL_SCREEN_QUAD, GstVulkanFullScreenQuadClass))
35 #define GST_IS_VULKAN_FULL_SCREEN_QUAD(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GST_TYPE_VULKAN_FULL_SCREEN_QUAD))
36 #define GST_IS_VULKAN_FULL_SCREEN_QUAD_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GST_TYPE_VULKAN_FULL_SCREEN_QUAD))
37 #define GST_VULKAN_FULL_SCREEN_QUAD_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS ((obj), GST_TYPE_VULKAN_FULL_SCREEN_QUAD, GstVulkanFullScreenQuadClass))
38
39 /* XXX: privatise this on moving to lib */
40 struct Vertex
41 {
42   float x, y, z;
43   float s, t;
44 };
45
46 typedef struct _GstVulkanFullScreenQuad GstVulkanFullScreenQuad;
47 typedef struct _GstVulkanFullScreenQuadClass GstVulkanFullScreenQuadClass;
48 typedef struct _GstVulkanFullScreenQuadPrivate GstVulkanFullScreenQuadPrivate;
49
50 struct _GstVulkanFullScreenQuad
51 {
52   GstObject                         parent;
53
54   GstVideoInfo                      out_info;
55   GstVideoInfo                      in_info;
56
57   GstVulkanQueue                   *queue;
58
59   GstVulkanHandle                  *render_pass;
60   GstVulkanHandle                  *pipeline_layout;
61   GstVulkanHandle                  *graphics_pipeline;
62   GstVulkanHandle                  *descriptor_set_layout;
63   GstVulkanDescriptorCache         *descriptor_cache;
64   GstVulkanDescriptorSet           *descriptor_set;
65   GstVulkanHandle                  *framebuffer;
66   GstVulkanHandle                  *sampler;
67
68   GstVulkanCommandPool             *cmd_pool;
69
70   GstVulkanTrashList               *trash_list;
71   GstVulkanFence                   *last_fence;
72 };
73
74 struct _GstVulkanFullScreenQuadClass
75 {
76   GstObjectClass                    parent_class;
77 };
78
79 GstVulkanFullScreenQuad *   gst_vulkan_full_screen_quad_new         (GstVulkanQueue * queue);
80
81 gboolean            gst_vulkan_full_screen_quad_set_info            (GstVulkanFullScreenQuad * self, GstVideoInfo *in_info, GstVideoInfo * out_info);
82 gboolean            gst_vulkan_full_screen_quad_set_shaders         (GstVulkanFullScreenQuad * self, GstVulkanHandle * vert, GstVulkanHandle * frag);
83 gboolean            gst_vulkan_full_screen_quad_set_uniform_buffer  (GstVulkanFullScreenQuad * self, GstMemory * uniforms, GError ** error);
84
85 gboolean            gst_vulkan_full_screen_quad_set_input_buffer    (GstVulkanFullScreenQuad * self, GstBuffer * buffer, GError ** error);
86 gboolean            gst_vulkan_full_screen_quad_set_output_buffer   (GstVulkanFullScreenQuad * self, GstBuffer * buffer, GError ** error);
87
88 gboolean            gst_vulkan_full_screen_quad_prepare_draw        (GstVulkanFullScreenQuad * self, GstVulkanFence * fence, GError ** error);
89 gboolean            gst_vulkan_full_screen_quad_fill_command_buffer (GstVulkanFullScreenQuad * self, GstVulkanCommandBuffer * cmd, GstVulkanFence * fence, GError ** error);
90 gboolean            gst_vulkan_full_screen_quad_submit              (GstVulkanFullScreenQuad * self, GstVulkanCommandBuffer * cmd, GstVulkanFence * fence, GError ** error);
91 gboolean            gst_vulkan_full_screen_quad_draw                (GstVulkanFullScreenQuad * self, GError ** error);
92
93 GstVulkanFence *    gst_vulkan_full_screen_quad_get_last_fence      (GstVulkanFullScreenQuad * self);
94
95 G_END_DECLS
96 #endif /* __GST_VULKAN_FULL_SCREEN_QUAD_H__ */