Fix documentation.

This commit is contained in:
gb 2010-03-29 11:25:20 +00:00
parent dd92195093
commit ab8b90aa59
4 changed files with 67 additions and 2 deletions

View file

@ -22,6 +22,7 @@
<xi:include href="xml/gstvaapiimage.xml"/> <xi:include href="xml/gstvaapiimage.xml"/>
<xi:include href="xml/gstvaapiimageformat.xml"/> <xi:include href="xml/gstvaapiimageformat.xml"/>
<xi:include href="xml/gstvaapisubpicture.xml"/> <xi:include href="xml/gstvaapisubpicture.xml"/>
<xi:include href="xml/gstvaapitexture.xml"/>
<xi:include href="xml/gstvaapivideopool.xml"/> <xi:include href="xml/gstvaapivideopool.xml"/>
<xi:include href="xml/gstvaapisurfacepool.xml"/> <xi:include href="xml/gstvaapisurfacepool.xml"/>
<xi:include href="xml/gstvaapiimagepool.xml"/> <xi:include href="xml/gstvaapiimagepool.xml"/>

View file

@ -111,7 +111,9 @@ gst_vaapi_window_glx_new
gst_vaapi_window_glx_new_with_xid gst_vaapi_window_glx_new_with_xid
gst_vaapi_window_glx_get_context gst_vaapi_window_glx_get_context
gst_vaapi_window_glx_set_context gst_vaapi_window_glx_set_context
gst_vaapi_window_glx_make_current
gst_vaapi_window_glx_swap_buffers gst_vaapi_window_glx_swap_buffers
gst_vaapi_window_glx_put_texture
<SUBSECTION Standard> <SUBSECTION Standard>
GST_VAAPI_WINDOW_GLX GST_VAAPI_WINDOW_GLX
GST_VAAPI_IS_WINDOW_GLX GST_VAAPI_IS_WINDOW_GLX
@ -364,3 +366,27 @@ gst_vaapi_image_format_get_va_format
gst_vaapi_image_format_get_caps gst_vaapi_image_format_get_caps
gst_vaapi_image_format_get_score gst_vaapi_image_format_get_score
</SECTION> </SECTION>
<SECTION>
<FILE>gstvaapitexture</FILE>
<TITLE>GstVaapiTexture</TITLE>
GstVaapiTexture
GstVaapiTextureClass
gst_vaapi_texture_new
gst_vaapi_texture_new_with_texture
gst_vaapi_texture_get_id
gst_vaapi_texture_get_target
gst_vaapi_texture_get_format
gst_vaapi_texture_get_width
gst_vaapi_texture_get_height
gst_vaapi_texture_get_size
gst_vaapi_texture_put_surface
<SUBSECTION Standard>
GST_VAAPI_TEXTURE
GST_VAAPI_IS_TEXTURE
GST_VAAPI_TYPE_TEXTURE
gst_vaapi_texture_get_type
GST_VAAPI_TEXTURE_CLASS
GST_VAAPI_IS_TEXTURE_CLASS
GST_VAAPI_TEXTURE_GET_CLASS
</SECTION>

View file

@ -595,7 +595,7 @@ gst_vaapi_display_sync(GstVaapiDisplay *display)
} }
/** /**
* gst_vaapi_display_sync: * gst_vaapi_display_flush:
* @display: a #GstVaapiDisplay * @display: a #GstVaapiDisplay
* *
* Flushes any requests queued for the windowing system. * Flushes any requests queued for the windowing system.

View file

@ -263,6 +263,25 @@ gst_vaapi_texture_init(GstVaapiTexture *texture)
priv->is_constructed = FALSE; priv->is_constructed = FALSE;
} }
/**
* gst_vaapi_texture_new:
* @display: a #GstVaapiDisplay
* @target: the target to which the texture is bound
* @format: the format of the pixel data
* @width: the requested width, in pixels
* @height: the requested height, in pixels
*
* Creates a texture with the specified dimensions, @target and
* @format. Note that only GL_TEXTURE_2D @target and GL_RGBA or
* GL_BGRA formats are supported at this time.
*
* The application shall maintain the live GL context itself. That is,
* gst_vaapi_window_glx_make_current() must be called beforehand, or
* any other function like glXMakeCurrent() if the context is managed
* outside of this library.
*
* Return value: the newly created #GstVaapiTexture object
*/
GstVaapiTexture * GstVaapiTexture *
gst_vaapi_texture_new( gst_vaapi_texture_new(
GstVaapiDisplay *display, GstVaapiDisplay *display,
@ -284,6 +303,25 @@ gst_vaapi_texture_new(
NULL); NULL);
} }
/**
* gst_vaapi_texture_new_with_texture:
* @display: a #GstVaapiDisplay
* @texture: the foreign GL texture name to use
* @target: the target to which the texture is bound
* @format: the format of the pixel data
*
* Creates a texture from an existing GL texture, with the specified
* @target and @format. Note that only GL_TEXTURE_2D @target and
* GL_RGBA or GL_BGRA formats are supported at this time. The
* dimensions will be retrieved from the @texture.
*
* The application shall maintain the live GL context itself. That is,
* gst_vaapi_window_glx_make_current() must be called beforehand, or
* any other function like glXMakeCurrent() if the context is managed
* outside of this library.
*
* Return value: the newly created #GstVaapiTexture object
*/
GstVaapiTexture * GstVaapiTexture *
gst_vaapi_texture_new_with_texture( gst_vaapi_texture_new_with_texture(
GstVaapiDisplay *display, GstVaapiDisplay *display,
@ -429,7 +467,7 @@ gst_vaapi_texture_get_size(
} }
/** /**
* gst_vaapi_window_put_texture: * gst_vaapi_texture_put_surface:
* @texture: a #GstVaapiTexture * @texture: a #GstVaapiTexture
* @surface: a #GstVaapiSurface * @surface: a #GstVaapiSurface
* @flags: postprocessing flags. See #GstVaapiTextureRenderFlags * @flags: postprocessing flags. See #GstVaapiTextureRenderFlags