Add missing docs.
[platform/upstream/gstreamer-vaapi.git] / docs / reference / libs / libs-sections.txt
1 <SECTION>
2 <FILE>gstvaapisurfacepool</FILE>
3 <TITLE>GstVaapiSurfacePool</TITLE>
4 GstVaapiSurfacePool
5 GstVaapiSurfacePoolClass
6 gst_vaapi_surface_pool_new
7 <SUBSECTION Standard>
8 GST_VAAPI_SURFACE_POOL
9 GST_VAAPI_IS_SURFACE_POOL
10 GST_VAAPI_TYPE_SURFACE_POOL
11 gst_vaapi_surface_pool_get_type
12 GST_VAAPI_SURFACE_POOL_CLASS
13 GST_VAAPI_IS_SURFACE_POOL_CLASS
14 GST_VAAPI_SURFACE_POOL_GET_CLASS
15 </SECTION>
16
17 <SECTION>
18 <FILE>gstvaapivideopool</FILE>
19 <TITLE>GstVaapiVideoPool</TITLE>
20 GstVaapiVideoPool
21 GstVaapiVideoPoolClass
22 gst_vaapi_video_pool_get_caps
23 gst_vaapi_video_pool_get_object
24 gst_vaapi_video_pool_put_object
25 gst_vaapi_video_pool_add_object
26 gst_vaapi_video_pool_add_objects
27 gst_vaapi_video_pool_get_capacity
28 gst_vaapi_video_pool_set_capacity
29 gst_vaapi_video_pool_get_size
30 gst_vaapi_video_pool_reserve
31 <SUBSECTION Standard>
32 GST_VAAPI_VIDEO_POOL
33 GST_VAAPI_IS_VIDEO_POOL
34 GST_VAAPI_TYPE_VIDEO_POOL
35 gst_vaapi_video_pool_get_type
36 GST_VAAPI_VIDEO_POOL_CLASS
37 GST_VAAPI_IS_VIDEO_POOL_CLASS
38 GST_VAAPI_VIDEO_POOL_GET_CLASS
39 </SECTION>
40
41 <SECTION>
42 <FILE>gstvaapivideosink</FILE>
43 <TITLE>GstVaapiVideoSink</TITLE>
44 GST_VAAPI_VIDEO_SINK_GET_INTERFACE
45 GstVaapiVideoSinkInterface
46 gst_vaapi_video_sink_get_display
47 gst_vaapi_video_sink_lookup
48 <SUBSECTION Standard>
49 GST_VAAPI_VIDEO_SINK
50 GST_VAAPI_IS_VIDEO_SINK
51 GST_VAAPI_TYPE_VIDEO_SINK
52 gst_vaapi_video_sink_get_type
53 </SECTION>
54
55 <SECTION>
56 <FILE>gstvaapidisplay_x11</FILE>
57 <TITLE>GstVaapiDisplayX11</TITLE>
58 GstVaapiDisplayX11
59 GstVaapiDisplayX11Class
60 gst_vaapi_display_x11_new
61 gst_vaapi_display_x11_new_with_display
62 gst_vaapi_display_x11_get_display
63 gst_vaapi_display_x11_get_screen
64 <SUBSECTION Standard>
65 GST_VAAPI_DISPLAY_X11
66 GST_VAAPI_IS_DISPLAY_X11
67 GST_VAAPI_TYPE_DISPLAY_X11
68 gst_vaapi_display_x11_get_type
69 GST_VAAPI_DISPLAY_X11_CLASS
70 GST_VAAPI_IS_DISPLAY_X11_CLASS
71 GST_VAAPI_DISPLAY_X11_GET_CLASS
72 </SECTION>
73
74 <SECTION>
75 <FILE>gstvaapiwindow_x11</FILE>
76 <TITLE>GstVaapiWindowX11</TITLE>
77 GstVaapiWindowX11
78 GstVaapiWindowX11Class
79 GST_VAAPI_WINDOW_XWINDOW
80 gst_vaapi_window_x11_new
81 gst_vaapi_window_x11_new_with_xid
82 gst_vaapi_window_x11_get_xid
83 gst_vaapi_window_x11_is_foreign_xid
84 <SUBSECTION Standard>
85 GST_VAAPI_WINDOW_X11
86 GST_VAAPI_IS_WINDOW_X11
87 GST_VAAPI_TYPE_WINDOW_X11
88 gst_vaapi_window_x11_get_type
89 GST_VAAPI_WINDOW_X11_CLASS
90 GST_VAAPI_IS_WINDOW_X11_CLASS
91 GST_VAAPI_WINDOW_X11_GET_CLASS
92 </SECTION>
93
94 <SECTION>
95 <FILE>gstvaapidisplay_glx</FILE>
96 <TITLE>GstVaapiDisplayGLX</TITLE>
97 GstVaapiDisplayGLX
98 GstVaapiDisplayGLXClass
99 gst_vaapi_display_glx_new
100 gst_vaapi_display_glx_new_with_display
101 <SUBSECTION Standard>
102 GST_VAAPI_DISPLAY_GLX
103 GST_VAAPI_IS_DISPLAY_GLX
104 GST_VAAPI_TYPE_DISPLAY_GLX
105 gst_vaapi_display_glx_get_type
106 GST_VAAPI_DISPLAY_GLX_CLASS
107 GST_VAAPI_IS_DISPLAY_GLX_CLASS
108 GST_VAAPI_DISPLAY_GLX_GET_CLASS
109 </SECTION>
110
111 <SECTION>
112 <FILE>gstvaapiwindow_glx</FILE>
113 <TITLE>GstVaapiWindowGLX</TITLE>
114 GstVaapiWindowGLX
115 GstVaapiWindowGLXClass
116 gst_vaapi_window_glx_new
117 gst_vaapi_window_glx_new_with_xid
118 gst_vaapi_window_glx_get_context
119 gst_vaapi_window_glx_set_context
120 gst_vaapi_window_glx_make_current
121 gst_vaapi_window_glx_swap_buffers
122 gst_vaapi_window_glx_put_texture
123 <SUBSECTION Standard>
124 GST_VAAPI_WINDOW_GLX
125 GST_VAAPI_IS_WINDOW_GLX
126 GST_VAAPI_TYPE_WINDOW_GLX
127 gst_vaapi_window_glx_get_type
128 GST_VAAPI_WINDOW_GLX_CLASS
129 GST_VAAPI_IS_WINDOW_GLX_CLASS
130 GST_VAAPI_WINDOW_GLX_GET_CLASS
131 </SECTION>
132
133 <SECTION>
134 <FILE>gstvaapidisplay</FILE>
135 GST_VAAPI_DISPLAY_VADISPLAY
136 GST_VAAPI_DISPLAY_LOCK
137 GST_VAAPI_DISPLAY_UNLOCK
138 <TITLE>GstVaapiDisplay</TITLE>
139 GstVaapiDisplay
140 GstVaapiDisplayClass
141 gst_vaapi_display_new_with_display
142 gst_vaapi_display_lock
143 gst_vaapi_display_unlock
144 gst_vaapi_display_sync
145 gst_vaapi_display_flush
146 gst_vaapi_display_get_display
147 gst_vaapi_display_get_width
148 gst_vaapi_display_get_height
149 gst_vaapi_display_get_size
150 gst_vaapi_display_get_pixel_aspect_ratio
151 gst_vaapi_display_get_decode_caps
152 gst_vaapi_display_has_decoder
153 gst_vaapi_display_get_encode_caps
154 gst_vaapi_display_has_encoder
155 gst_vaapi_display_get_image_caps
156 gst_vaapi_display_has_image_format
157 gst_vaapi_display_get_subpicture_caps
158 gst_vaapi_display_has_subpicture_format
159 <SUBSECTION Standard>
160 GST_VAAPI_DISPLAY
161 GST_VAAPI_IS_DISPLAY
162 GST_VAAPI_TYPE_DISPLAY
163 gst_vaapi_display_get_type
164 GST_VAAPI_DISPLAY_CLASS
165 GST_VAAPI_IS_DISPLAY_CLASS
166 GST_VAAPI_DISPLAY_GET_CLASS
167 </SECTION>
168
169 <SECTION>
170 <FILE>gstvaapiimagepool</FILE>
171 <TITLE>GstVaapiImagePool</TITLE>
172 GstVaapiImagePool
173 GstVaapiImagePoolClass
174 gst_vaapi_image_pool_new
175 <SUBSECTION Standard>
176 GST_VAAPI_IMAGE_POOL
177 GST_VAAPI_IS_IMAGE_POOL
178 GST_VAAPI_TYPE_IMAGE_POOL
179 gst_vaapi_image_pool_get_type
180 GST_VAAPI_IMAGE_POOL_CLASS
181 GST_VAAPI_IS_IMAGE_POOL_CLASS
182 GST_VAAPI_IMAGE_POOL_GET_CLASS
183 </SECTION>
184
185 <SECTION>
186 <FILE>gstvaapivideobuffer</FILE>
187 <TITLE>GstVaapiVideoBuffer</TITLE>
188 GstVaapiVideoBuffer
189 GstVaapiVideoBufferClass
190 gst_vaapi_video_buffer_new
191 gst_vaapi_video_buffer_new_from_pool
192 gst_vaapi_video_buffer_new_with_image
193 gst_vaapi_video_buffer_new_with_surface
194 gst_vaapi_video_buffer_new_with_surface_proxy
195 gst_vaapi_video_buffer_get_image
196 gst_vaapi_video_buffer_set_image
197 gst_vaapi_video_buffer_set_image_from_pool
198 gst_vaapi_video_buffer_get_surface
199 gst_vaapi_video_buffer_get_surface_proxy
200 gst_vaapi_video_buffer_set_surface
201 gst_vaapi_video_buffer_set_surface_proxy
202 gst_vaapi_video_buffer_set_surface_from_pool
203 <SUBSECTION Standard>
204 GST_VAAPI_VIDEO_BUFFER
205 GST_VAAPI_IS_VIDEO_BUFFER
206 GST_VAAPI_TYPE_VIDEO_BUFFER
207 gst_vaapi_video_buffer_get_type
208 GST_VAAPI_VIDEO_BUFFER_CLASS
209 GST_VAAPI_IS_VIDEO_BUFFER_CLASS
210 GST_VAAPI_VIDEO_BUFFER_GET_CLASS
211 </SECTION>
212
213 <SECTION>
214 <FILE>gstvaapitypes</FILE>
215 <TITLE>Basic data structures</TITLE>
216 GstVaapiID
217 GST_VAAPI_ID_FORMAT
218 GST_VAAPI_ID_ARGS
219 GST_VAAPI_ID
220 GST_VAAPI_ID_NONE
221 GstVaapiPoint
222 GstVaapiRectangle
223 </SECTION>
224
225 <SECTION>
226 <FILE>gstvaapivalue</FILE>
227 <TITLE></TITLE>
228 GST_VAAPI_TYPE_ID
229 gst_vaapi_value_get_id
230 gst_vaapi_value_set_id
231 </SECTION>
232
233 <SECTION>
234 <FILE>gstvaapiparamspecs</FILE>
235 <TITLE></TITLE>
236 GstVaapiParamSpecID
237 gst_vaapi_param_spec_id
238 </SECTION>
239
240 <SECTION>
241 <FILE>gstvaapiwindow</FILE>
242 <TITLE>GstVaapiWindow</TITLE>
243 GstVaapiWindow
244 GstVaapiWindowClass
245 gst_vaapi_window_get_display
246 gst_vaapi_window_show
247 gst_vaapi_window_hide
248 gst_vaapi_window_get_fullscreen
249 gst_vaapi_window_set_fullscreen
250 gst_vaapi_window_get_width
251 gst_vaapi_window_get_height
252 gst_vaapi_window_get_size
253 gst_vaapi_window_set_width
254 gst_vaapi_window_set_height
255 gst_vaapi_window_set_size
256 gst_vaapi_window_put_surface
257 <SUBSECTION Standard>
258 GST_VAAPI_WINDOW
259 GST_VAAPI_IS_WINDOW
260 GST_VAAPI_TYPE_WINDOW
261 gst_vaapi_window_get_type
262 GST_VAAPI_WINDOW_CLASS
263 GST_VAAPI_IS_WINDOW_CLASS
264 GST_VAAPI_WINDOW_GET_CLASS
265 </SECTION>
266
267 <SECTION>
268 <FILE>gstvaapiobject</FILE>
269 <TITLE>GstVaapiObject</TITLE>
270 GstVaapiObject
271 GstVaapiObjectClass
272 gst_vaapi_object_get_display
273 gst_vaapi_object_lock_display
274 gst_vaapi_object_unlock_display
275 gst_vaapi_object_get_id
276 <SUBSECTION Standard>
277 GST_VAAPI_OBJECT
278 GST_VAAPI_IS_OBJECT
279 GST_VAAPI_TYPE_OBJECT
280 gst_vaapi_object_get_type
281 GST_VAAPI_OBJECT_CLASS
282 GST_VAAPI_IS_OBJECT_CLASS
283 GST_VAAPI_OBJECT_GET_CLASS
284 </SECTION>
285
286 <SECTION>
287 <FILE>gstvaapiimage</FILE>
288 GST_VAAPI_IMAGE_FORMAT
289 GST_VAAPI_IMAGE_WIDTH
290 GST_VAAPI_IMAGE_HEIGHT
291 <TITLE>GstVaapiImage</TITLE>
292 GstVaapiImage
293 GstVaapiImageClass
294 gst_vaapi_image_new
295 gst_vaapi_image_new_with_image
296 gst_vaapi_image_get_id
297 gst_vaapi_image_get_image
298 gst_vaapi_image_get_format
299 gst_vaapi_image_get_width
300 gst_vaapi_image_get_height
301 gst_vaapi_image_get_size
302 gst_vaapi_image_is_linear
303 gst_vaapi_image_is_mapped
304 gst_vaapi_image_map
305 gst_vaapi_image_unmap
306 gst_vaapi_image_get_plane_count
307 gst_vaapi_image_get_plane
308 gst_vaapi_image_get_pitch
309 gst_vaapi_image_get_data_size
310 gst_vaapi_image_update_from_buffer
311 <SUBSECTION Standard>
312 GST_VAAPI_IMAGE
313 GST_VAAPI_IS_IMAGE
314 GST_VAAPI_TYPE_IMAGE
315 gst_vaapi_image_get_type
316 GST_VAAPI_IMAGE_CLASS
317 GST_VAAPI_IS_IMAGE_CLASS
318 GST_VAAPI_IMAGE_GET_CLASS
319 </SECTION>
320
321 <SECTION>
322 <FILE>gstvaapisurface</FILE>
323 GstVaapiChromaType
324 GstVaapiSurfaceStatus
325 GstVaapiSurfaceRenderFlags
326 <TITLE>GstVaapiSurface</TITLE>
327 GstVaapiSurface
328 GstVaapiSurfaceClass
329 gst_vaapi_surface_new
330 gst_vaapi_surface_get_id
331 gst_vaapi_surface_get_chroma_type
332 gst_vaapi_surface_get_width
333 gst_vaapi_surface_get_height
334 gst_vaapi_surface_get_size
335 gst_vaapi_surface_derive_image
336 gst_vaapi_surface_get_image
337 gst_vaapi_surface_put_image
338 gst_vaapi_surface_associate_subpicture
339 gst_vaapi_surface_deassociate_subpicture
340 gst_vaapi_surface_sync
341 gst_vaapi_surface_query_status
342 <SUBSECTION Standard>
343 GST_VAAPI_SURFACE
344 GST_VAAPI_IS_SURFACE
345 GST_VAAPI_TYPE_SURFACE
346 gst_vaapi_surface_get_type
347 GST_VAAPI_SURFACE_CLASS
348 GST_VAAPI_IS_SURFACE_CLASS
349 GST_VAAPI_SURFACE_GET_CLASS
350 </SECTION>
351
352 <SECTION>
353 <FILE>gstvaapisubpicture</FILE>
354 <TITLE>GstVaapiSubpicture</TITLE>
355 GstVaapiSubpicture
356 GstVaapiSubpictureClass
357 gst_vaapi_subpicture_new
358 gst_vaapi_subpicture_get_id
359 gst_vaapi_subpicture_get_image
360 gst_vaapi_subpicture_set_image
361 <SUBSECTION Standard>
362 GST_VAAPI_SUBPICTURE
363 GST_VAAPI_IS_SUBPICTURE
364 GST_VAAPI_TYPE_SUBPICTURE
365 gst_vaapi_subpicture_get_type
366 GST_VAAPI_SUBPICTURE_CLASS
367 GST_VAAPI_IS_SUBPICTURE_CLASS
368 GST_VAAPI_SUBPICTURE_GET_CLASS
369 </SECTION>
370
371 <SECTION>
372 <FILE>gstvaapiimageformat</FILE>
373 <TITLE>GstVaapiImageFormat</TITLE>
374 GstVaapiImageFormat
375 gst_vaapi_image_format_is_rgb
376 gst_vaapi_image_format_is_yuv
377 gst_vaapi_image_format
378 gst_vaapi_image_format_from_caps
379 gst_vaapi_image_format_from_fourcc
380 gst_vaapi_image_format_get_va_format
381 gst_vaapi_image_format_get_caps
382 gst_vaapi_image_format_get_score
383 </SECTION>
384
385 <SECTION>
386 <FILE>gstvaapiprofile</FILE>
387 <TITLE>GstVaapiProfile</TITLE>
388 GstVaapiCodec
389 GstVaapiProfile
390 GstVaapiEntrypoint
391 gst_vaapi_profile
392 gst_vaapi_profile_from_caps
393 gst_vaapi_profile_get_va_profile
394 gst_vaapi_profile_get_caps
395 gst_vaapi_profile_get_codec
396 gst_vaapi_entrypoint
397 gst_vaapi_entrypoint_get_va_entrypoint
398 </SECTION>
399
400 <SECTION>
401 <FILE>gstvaapitexture</FILE>
402 <TITLE>GstVaapiTexture</TITLE>
403 GstVaapiTexture
404 GstVaapiTextureClass
405 gst_vaapi_texture_new
406 gst_vaapi_texture_new_with_texture
407 gst_vaapi_texture_get_id
408 gst_vaapi_texture_get_target
409 gst_vaapi_texture_get_format
410 gst_vaapi_texture_get_width
411 gst_vaapi_texture_get_height
412 gst_vaapi_texture_get_size
413 gst_vaapi_texture_put_surface
414 <SUBSECTION Standard>
415 GST_VAAPI_TEXTURE
416 GST_VAAPI_IS_TEXTURE
417 GST_VAAPI_TYPE_TEXTURE
418 gst_vaapi_texture_get_type
419 GST_VAAPI_TEXTURE_CLASS
420 GST_VAAPI_IS_TEXTURE_CLASS
421 GST_VAAPI_TEXTURE_GET_CLASS
422 </SECTION>
423
424 <SECTION>
425 <FILE>gstvaapicontext</FILE>
426 <TITLE>GstVaapiContext</TITLE>
427 GstVaapiContext
428 GstVaapiContextClass
429 gst_vaapi_context_new
430 gst_vaapi_context_reset
431 gst_vaapi_context_get_id
432 gst_vaapi_context_get_profile
433 gst_vaapi_context_set_profile
434 gst_vaapi_context_get_entrypoint
435 gst_vaapi_context_get_size
436 gst_vaapi_context_get_surface
437 gst_vaapi_context_put_surface
438 gst_vaapi_context_find_surface_by_id
439 <SUBSECTION Standard>
440 GST_VAAPI_CONTEXT
441 GST_VAAPI_IS_CONTEXT
442 GST_VAAPI_TYPE_CONTEXT
443 gst_vaapi_context_get_type
444 GST_VAAPI_CONTEXT_CLASS
445 GST_VAAPI_IS_CONTEXT_CLASS
446 GST_VAAPI_CONTEXT_GET_CLASS
447 </SECTION>
448
449 <SECTION>
450 <FILE>gstvaapidecoder</FILE>
451 GstVaapiDecoderStatus
452 <TITLE>GstVaapiDecoder</TITLE>
453 GstVaapiDecoder
454 GstVaapiDecoderClass
455 gst_vaapi_decoder_put_buffer
456 gst_vaapi_decoder_get_surface
457 <SUBSECTION Standard>
458 GST_VAAPI_DECODER
459 GST_VAAPI_IS_DECODER
460 GST_VAAPI_TYPE_DECODER
461 gst_vaapi_decoder_get_type
462 GST_VAAPI_DECODER_CLASS
463 GST_VAAPI_IS_DECODER_CLASS
464 GST_VAAPI_DECODER_GET_CLASS
465 </SECTION>
466
467 <SECTION>
468 <FILE>gstvaapidecoder_ffmpeg</FILE>
469 <TITLE>GstVaapiDecoderFfmpeg</TITLE>
470 GstVaapiDecoderFfmpeg
471 GstVaapiDecoderFfmpegClass
472 gst_vaapi_decoder_ffmpeg_new
473 <SUBSECTION Standard>
474 GST_VAAPI_DECODER_FFMPEG
475 GST_VAAPI_IS_DECODER_FFMPEG
476 GST_VAAPI_TYPE_DECODER_FFMPEG
477 gst_vaapi_decoder_ffmpeg_get_type
478 GST_VAAPI_DECODER_FFMPEG_CLASS
479 GST_VAAPI_IS_DECODER_FFMPEG_CLASS
480 GST_VAAPI_DECODER_FFMPEG_GET_CLASS
481 </SECTION>
482
483 <SECTION>
484 <FILE>gstvaapisurfaceproxy</FILE>
485 <TITLE>GstVaapiSurfaceProxy</TITLE>
486 GstVaapiSurfaceProxy
487 GstVaapiSurfaceProxyClass
488 gst_vaapi_surface_proxy_new
489 gst_vaapi_surface_proxy_get_context
490 gst_vaapi_surface_proxy_set_context
491 gst_vaapi_surface_proxy_get_surface
492 gst_vaapi_surface_proxy_set_surface
493 gst_vaapi_surface_proxy_get_timestamp
494 gst_vaapi_surface_proxy_set_timestamp
495 <SUBSECTION Standard>
496 GST_VAAPI_SURFACE_PROXY
497 GST_VAAPI_IS_SURFACE_PROXY
498 GST_VAAPI_TYPE_SURFACE_PROXY
499 gst_vaapi_surface_proxy_get_type
500 GST_VAAPI_SURFACE_PROXY_CLASS
501 GST_VAAPI_IS_SURFACE_PROXY_CLASS
502 GST_VAAPI_SURFACE_PROXY_GET_CLASS
503 </SECTION>