Fix 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 <TITLE>GstVaapiDisplay</TITLE>
136 GstVaapiDisplay
137 GstVaapiDisplayClass
138 gst_vaapi_display_new_with_display
139 gst_vaapi_display_lock
140 gst_vaapi_display_unlock
141 gst_vaapi_display_sync
142 gst_vaapi_display_flush
143 gst_vaapi_display_get_display
144 gst_vaapi_display_get_width
145 gst_vaapi_display_get_height
146 gst_vaapi_display_get_size
147 gst_vaapi_display_get_pixel_aspect_ratio
148 gst_vaapi_display_get_decode_caps
149 gst_vaapi_display_has_decoder
150 gst_vaapi_display_get_encode_caps
151 gst_vaapi_display_has_encoder
152 gst_vaapi_display_get_image_caps
153 gst_vaapi_display_has_image_format
154 gst_vaapi_display_get_subpicture_caps
155 gst_vaapi_display_has_subpicture_format
156 <SUBSECTION Standard>
157 GST_VAAPI_DISPLAY
158 GST_VAAPI_IS_DISPLAY
159 GST_VAAPI_TYPE_DISPLAY
160 gst_vaapi_display_get_type
161 GST_VAAPI_DISPLAY_CLASS
162 GST_VAAPI_IS_DISPLAY_CLASS
163 GST_VAAPI_DISPLAY_GET_CLASS
164 </SECTION>
165
166 <SECTION>
167 <FILE>gstvaapiimagepool</FILE>
168 <TITLE>GstVaapiImagePool</TITLE>
169 GstVaapiImagePool
170 GstVaapiImagePoolClass
171 gst_vaapi_image_pool_new
172 <SUBSECTION Standard>
173 GST_VAAPI_IMAGE_POOL
174 GST_VAAPI_IS_IMAGE_POOL
175 GST_VAAPI_TYPE_IMAGE_POOL
176 gst_vaapi_image_pool_get_type
177 GST_VAAPI_IMAGE_POOL_CLASS
178 GST_VAAPI_IS_IMAGE_POOL_CLASS
179 GST_VAAPI_IMAGE_POOL_GET_CLASS
180 </SECTION>
181
182 <SECTION>
183 <FILE>gstvaapivideobuffer</FILE>
184 <TITLE>GstVaapiVideoBuffer</TITLE>
185 GstVaapiVideoBuffer
186 GstVaapiVideoBufferClass
187 gst_vaapi_video_buffer_new
188 gst_vaapi_video_buffer_new_from_pool
189 gst_vaapi_video_buffer_new_with_image
190 gst_vaapi_video_buffer_new_with_surface
191 gst_vaapi_video_buffer_new_with_surface_proxy
192 gst_vaapi_video_buffer_get_image
193 gst_vaapi_video_buffer_set_image
194 gst_vaapi_video_buffer_set_image_from_pool
195 gst_vaapi_video_buffer_get_surface
196 gst_vaapi_video_buffer_get_surface_proxy
197 gst_vaapi_video_buffer_set_surface
198 gst_vaapi_video_buffer_set_surface_proxy
199 gst_vaapi_video_buffer_set_surface_from_pool
200 <SUBSECTION Standard>
201 GST_VAAPI_VIDEO_BUFFER
202 GST_VAAPI_IS_VIDEO_BUFFER
203 GST_VAAPI_TYPE_VIDEO_BUFFER
204 gst_vaapi_video_buffer_get_type
205 GST_VAAPI_VIDEO_BUFFER_CLASS
206 GST_VAAPI_IS_VIDEO_BUFFER_CLASS
207 GST_VAAPI_VIDEO_BUFFER_GET_CLASS
208 </SECTION>
209
210 <SECTION>
211 <FILE>gstvaapitypes</FILE>
212 <TITLE>Basic data structures</TITLE>
213 GstVaapiID
214 GST_VAAPI_ID_FORMAT
215 GST_VAAPI_ID_ARGS
216 GST_VAAPI_ID
217 GST_VAAPI_ID_NONE
218 GstVaapiPoint
219 GstVaapiRectangle
220 </SECTION>
221
222 <SECTION>
223 <FILE>gstvaapivalue</FILE>
224 <TITLE></TITLE>
225 GST_VAAPI_TYPE_ID
226 gst_vaapi_value_get_id
227 gst_vaapi_value_set_id
228 </SECTION>
229
230 <SECTION>
231 <FILE>gstvaapiparamspecs</FILE>
232 <TITLE></TITLE>
233 GstVaapiParamSpecID
234 gst_vaapi_param_spec_id
235 </SECTION>
236
237 <SECTION>
238 <FILE>gstvaapiwindow</FILE>
239 <TITLE>GstVaapiWindow</TITLE>
240 GstVaapiWindow
241 GstVaapiWindowClass
242 gst_vaapi_window_get_display
243 gst_vaapi_window_show
244 gst_vaapi_window_hide
245 gst_vaapi_window_get_fullscreen
246 gst_vaapi_window_set_fullscreen
247 gst_vaapi_window_get_width
248 gst_vaapi_window_get_height
249 gst_vaapi_window_get_size
250 gst_vaapi_window_set_width
251 gst_vaapi_window_set_height
252 gst_vaapi_window_set_size
253 gst_vaapi_window_put_surface
254 <SUBSECTION Standard>
255 GST_VAAPI_WINDOW
256 GST_VAAPI_IS_WINDOW
257 GST_VAAPI_TYPE_WINDOW
258 gst_vaapi_window_get_type
259 GST_VAAPI_WINDOW_CLASS
260 GST_VAAPI_IS_WINDOW_CLASS
261 GST_VAAPI_WINDOW_GET_CLASS
262 </SECTION>
263
264 <SECTION>
265 <FILE>gstvaapiobject</FILE>
266 <TITLE>GstVaapiObject</TITLE>
267 GstVaapiObject
268 GstVaapiObjectClass
269 gst_vaapi_object_get_display
270 gst_vaapi_object_lock_display
271 gst_vaapi_object_unlock_display
272 gst_vaapi_object_get_id
273 <SUBSECTION Standard>
274 GST_VAAPI_OBJECT
275 GST_VAAPI_IS_OBJECT
276 GST_VAAPI_TYPE_OBJECT
277 gst_vaapi_object_get_type
278 GST_VAAPI_OBJECT_CLASS
279 GST_VAAPI_IS_OBJECT_CLASS
280 GST_VAAPI_OBJECT_GET_CLASS
281 </SECTION>
282
283 <SECTION>
284 <FILE>gstvaapiimage</FILE>
285 GST_VAAPI_IMAGE_FORMAT
286 GST_VAAPI_IMAGE_WIDTH
287 GST_VAAPI_IMAGE_HEIGHT
288 <TITLE>GstVaapiImage</TITLE>
289 GstVaapiImage
290 GstVaapiImageClass
291 gst_vaapi_image_new
292 gst_vaapi_image_new_with_image
293 gst_vaapi_image_get_id
294 gst_vaapi_image_get_image
295 gst_vaapi_image_get_format
296 gst_vaapi_image_get_width
297 gst_vaapi_image_get_height
298 gst_vaapi_image_get_size
299 gst_vaapi_image_is_linear
300 gst_vaapi_image_is_mapped
301 gst_vaapi_image_map
302 gst_vaapi_image_unmap
303 gst_vaapi_image_get_plane_count
304 gst_vaapi_image_get_plane
305 gst_vaapi_image_get_pitch
306 gst_vaapi_image_get_data_size
307 gst_vaapi_image_update_from_buffer
308 <SUBSECTION Standard>
309 GST_VAAPI_IMAGE
310 GST_VAAPI_IS_IMAGE
311 GST_VAAPI_TYPE_IMAGE
312 gst_vaapi_image_get_type
313 GST_VAAPI_IMAGE_CLASS
314 GST_VAAPI_IS_IMAGE_CLASS
315 GST_VAAPI_IMAGE_GET_CLASS
316 </SECTION>
317
318 <SECTION>
319 <FILE>gstvaapisurface</FILE>
320 GstVaapiChromaType
321 GstVaapiSurfaceStatus
322 GstVaapiSurfaceRenderFlags
323 <TITLE>GstVaapiSurface</TITLE>
324 GstVaapiSurface
325 GstVaapiSurfaceClass
326 gst_vaapi_surface_new
327 gst_vaapi_surface_get_id
328 gst_vaapi_surface_get_chroma_type
329 gst_vaapi_surface_get_width
330 gst_vaapi_surface_get_height
331 gst_vaapi_surface_get_size
332 gst_vaapi_surface_derive_image
333 gst_vaapi_surface_get_image
334 gst_vaapi_surface_put_image
335 gst_vaapi_surface_associate_subpicture
336 gst_vaapi_surface_deassociate_subpicture
337 gst_vaapi_surface_sync
338 gst_vaapi_surface_query_status
339 <SUBSECTION Standard>
340 GST_VAAPI_SURFACE
341 GST_VAAPI_IS_SURFACE
342 GST_VAAPI_TYPE_SURFACE
343 gst_vaapi_surface_get_type
344 GST_VAAPI_SURFACE_CLASS
345 GST_VAAPI_IS_SURFACE_CLASS
346 GST_VAAPI_SURFACE_GET_CLASS
347 </SECTION>
348
349 <SECTION>
350 <FILE>gstvaapisubpicture</FILE>
351 <TITLE>GstVaapiSubpicture</TITLE>
352 GstVaapiSubpicture
353 GstVaapiSubpictureClass
354 gst_vaapi_subpicture_new
355 gst_vaapi_subpicture_get_id
356 gst_vaapi_subpicture_get_image
357 gst_vaapi_subpicture_set_image
358 <SUBSECTION Standard>
359 GST_VAAPI_SUBPICTURE
360 GST_VAAPI_IS_SUBPICTURE
361 GST_VAAPI_TYPE_SUBPICTURE
362 gst_vaapi_subpicture_get_type
363 GST_VAAPI_SUBPICTURE_CLASS
364 GST_VAAPI_IS_SUBPICTURE_CLASS
365 GST_VAAPI_SUBPICTURE_GET_CLASS
366 </SECTION>
367
368 <SECTION>
369 <FILE>gstvaapiimageformat</FILE>
370 <TITLE>GstVaapiImageFormat</TITLE>
371 GstVaapiImageFormat
372 gst_vaapi_image_format_is_rgb
373 gst_vaapi_image_format_is_yuv
374 gst_vaapi_image_format
375 gst_vaapi_image_format_from_caps
376 gst_vaapi_image_format_from_fourcc
377 gst_vaapi_image_format_get_va_format
378 gst_vaapi_image_format_get_caps
379 gst_vaapi_image_format_get_score
380 </SECTION>
381
382 <SECTION>
383 <FILE>gstvaapiprofile</FILE>
384 <TITLE>GstVaapiProfile</TITLE>
385 GstVaapiCodec
386 GstVaapiProfile
387 GstVaapiEntrypoint
388 gst_vaapi_profile
389 gst_vaapi_profile_from_caps
390 gst_vaapi_profile_get_va_profile
391 gst_vaapi_profile_get_caps
392 gst_vaapi_profile_get_codec
393 gst_vaapi_entrypoint
394 gst_vaapi_entrypoint_get_va_entrypoint
395 </SECTION>
396
397 <SECTION>
398 <FILE>gstvaapitexture</FILE>
399 <TITLE>GstVaapiTexture</TITLE>
400 GstVaapiTexture
401 GstVaapiTextureClass
402 gst_vaapi_texture_new
403 gst_vaapi_texture_new_with_texture
404 gst_vaapi_texture_get_id
405 gst_vaapi_texture_get_target
406 gst_vaapi_texture_get_format
407 gst_vaapi_texture_get_width
408 gst_vaapi_texture_get_height
409 gst_vaapi_texture_get_size
410 gst_vaapi_texture_put_surface
411 <SUBSECTION Standard>
412 GST_VAAPI_TEXTURE
413 GST_VAAPI_IS_TEXTURE
414 GST_VAAPI_TYPE_TEXTURE
415 gst_vaapi_texture_get_type
416 GST_VAAPI_TEXTURE_CLASS
417 GST_VAAPI_IS_TEXTURE_CLASS
418 GST_VAAPI_TEXTURE_GET_CLASS
419 </SECTION>
420
421 <SECTION>
422 <FILE>gstvaapicontext</FILE>
423 <TITLE>GstVaapiContext</TITLE>
424 GstVaapiContext
425 GstVaapiContextClass
426 gst_vaapi_context_new
427 gst_vaapi_context_reset
428 gst_vaapi_context_get_id
429 gst_vaapi_context_get_profile
430 gst_vaapi_context_set_profile
431 gst_vaapi_context_get_entrypoint
432 gst_vaapi_context_get_size
433 gst_vaapi_context_get_surface
434 gst_vaapi_context_put_surface
435 gst_vaapi_context_find_surface_by_id
436 <SUBSECTION Standard>
437 GST_VAAPI_CONTEXT
438 GST_VAAPI_IS_CONTEXT
439 GST_VAAPI_TYPE_CONTEXT
440 gst_vaapi_context_get_type
441 GST_VAAPI_CONTEXT_CLASS
442 GST_VAAPI_IS_CONTEXT_CLASS
443 GST_VAAPI_CONTEXT_GET_CLASS
444 </SECTION>
445
446 <SECTION>
447 <FILE>gstvaapidecoder</FILE>
448 GstVaapiDecoderStatus
449 <TITLE>GstVaapiDecoder</TITLE>
450 GstVaapiDecoder
451 GstVaapiDecoderClass
452 gst_vaapi_decoder_put_buffer
453 gst_vaapi_decoder_get_surface
454 <SUBSECTION Standard>
455 GST_VAAPI_DECODER
456 GST_VAAPI_IS_DECODER
457 GST_VAAPI_TYPE_DECODER
458 gst_vaapi_decoder_get_type
459 GST_VAAPI_DECODER_CLASS
460 GST_VAAPI_IS_DECODER_CLASS
461 GST_VAAPI_DECODER_GET_CLASS
462 </SECTION>
463
464 <SECTION>
465 <FILE>gstvaapidecoder_ffmpeg</FILE>
466 <TITLE>GstVaapiDecoderFfmpeg</TITLE>
467 GstVaapiDecoderFfmpeg
468 GstVaapiDecoderFfmpegClass
469 gst_vaapi_decoder_ffmpeg_new
470 <SUBSECTION Standard>
471 GST_VAAPI_DECODER_FFMPEG
472 GST_VAAPI_IS_DECODER_FFMPEG
473 GST_VAAPI_TYPE_DECODER_FFMPEG
474 gst_vaapi_decoder_ffmpeg_get_type
475 GST_VAAPI_DECODER_FFMPEG_CLASS
476 GST_VAAPI_IS_DECODER_FFMPEG_CLASS
477 GST_VAAPI_DECODER_FFMPEG_GET_CLASS
478 </SECTION>
479
480 <SECTION>
481 <FILE>gstvaapisurfaceproxy</FILE>
482 <TITLE>GstVaapiSurfaceProxy</TITLE>
483 GstVaapiSurfaceProxy
484 GstVaapiSurfaceProxyClass
485 gst_vaapi_surface_proxy_new
486 gst_vaapi_surface_proxy_get_context
487 gst_vaapi_surface_proxy_set_context
488 gst_vaapi_surface_proxy_get_surface
489 gst_vaapi_surface_proxy_set_surface
490 gst_vaapi_surface_proxy_get_timestamp
491 gst_vaapi_surface_proxy_set_timestamp
492 <SUBSECTION Standard>
493 GST_VAAPI_SURFACE_PROXY
494 GST_VAAPI_IS_SURFACE_PROXY
495 GST_VAAPI_TYPE_SURFACE_PROXY
496 gst_vaapi_surface_proxy_get_type
497 GST_VAAPI_SURFACE_PROXY_CLASS
498 GST_VAAPI_IS_SURFACE_PROXY_CLASS
499 GST_VAAPI_SURFACE_PROXY_GET_CLASS
500 </SECTION>