d3d11: Update library doc
[platform/upstream/gstreamer.git] / subprojects / gst-plugins-bad / gst-libs / gst / d3d11 / gstd3d11bufferpool.h
1 /*
2  * GStreamer
3  * Copyright (C) 2019 Seungha Yang <seungha.yang@navercorp.com>
4  * Copyright (C) 2020 Seungha Yang <seungha@centricular.com>
5  *
6  * This library is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Library General Public
8  * License as published by the Free Software Foundation; either
9  * version 2 of the License, or (at your option) any later version.
10  *
11  * This library is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14  * Library General Public License for more details.
15  *
16  * You should have received a copy of the GNU Library General Public
17  * License along with this library; if not, write to the
18  * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
19  * Boston, MA 02110-1301, USA.
20  */
21
22 #pragma once
23
24 #include <gst/gst.h>
25 #include <gst/video/video.h>
26 #include <gst/d3d11/gstd3d11_fwd.h>
27
28 G_BEGIN_DECLS
29
30 #define GST_TYPE_D3D11_BUFFER_POOL            (gst_d3d11_buffer_pool_get_type())
31 #define GST_D3D11_BUFFER_POOL(obj)            (G_TYPE_CHECK_INSTANCE_CAST((obj), GST_TYPE_D3D11_BUFFER_POOL, GstD3D11BufferPool))
32 #define GST_D3D11_BUFFER_POOL_CLASS(klass)    (G_TYPE_CHECK_CLASS((klass), GST_TYPE_D3D11_BUFFER_POOL, GstD3D11BufferPoolClass))
33 #define GST_IS_D3D11_BUFFER_POOL(obj)         (G_TYPE_CHECK_INSTANCE_TYPE((obj), GST_TYPE_D3D11_BUFFER_POOL))
34 #define GST_IS_D3D11_BUFFER_POOL_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE((klass), GST_TYPE_D3D11_BUFFER_POOL))
35 #define GST_D3D11_BUFFER_POOL_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS((obj), GST_TYPE_D3D11_BUFFER_POOL, GstD3D11BufferPoolClass))
36
37 /**
38  * GstD3D11BufferPool:
39  *
40  * Opaque GstD3D11BufferPool struct
41  *
42  * Since: 1.22
43  */
44 struct _GstD3D11BufferPool
45 {
46   GstBufferPool parent;
47
48   GstD3D11Device *device;
49
50   /*< private >*/
51   GstD3D11BufferPoolPrivate *priv;
52   gpointer _gst_reserved[GST_PADDING];
53 };
54
55 /**
56  * GstD3D11BufferPoolClass:
57  *
58  * Opaque GstD3D11BufferPoolClass struct
59  *
60  * Since: 1.22
61  */
62 struct _GstD3D11BufferPoolClass
63 {
64   GstBufferPoolClass parent_class;
65
66   /*< private >*/
67   gpointer _gst_reserved[GST_PADDING];
68 };
69
70 GST_D3D11_API
71 GType                gst_d3d11_buffer_pool_get_type  (void);
72
73 GST_D3D11_API
74 GstBufferPool *      gst_d3d11_buffer_pool_new       (GstD3D11Device * device);
75
76 GST_D3D11_API
77 GstD3D11AllocationParams * gst_buffer_pool_config_get_d3d11_allocation_params (GstStructure * config);
78
79 GST_D3D11_API
80 void                 gst_buffer_pool_config_set_d3d11_allocation_params (GstStructure * config,
81                                                                          GstD3D11AllocationParams * params);
82
83 G_END_DECLS
84