GstVaapiWindow

GstVaapiWindow — VA window abstraction

Synopsis

struct              GstVaapiWindow;
struct              GstVaapiWindowClass;
GstVaapiDisplay *   gst_vaapi_window_get_display        (GstVaapiWindow *window);
void                gst_vaapi_window_show               (GstVaapiWindow *window);
void                gst_vaapi_window_hide               (GstVaapiWindow *window);
gboolean            gst_vaapi_window_get_fullscreen     (GstVaapiWindow *window);
void                gst_vaapi_window_set_fullscreen     (GstVaapiWindow *window,
                                                         gboolean fullscreen);
guint               gst_vaapi_window_get_width          (GstVaapiWindow *window);
guint               gst_vaapi_window_get_height         (GstVaapiWindow *window);
void                gst_vaapi_window_get_size           (GstVaapiWindow *window,
                                                         guint *pwidth,
                                                         guint *pheight);
void                gst_vaapi_window_set_width          (GstVaapiWindow *window,
                                                         guint width);
void                gst_vaapi_window_set_height         (GstVaapiWindow *window,
                                                         guint height);
void                gst_vaapi_window_set_size           (GstVaapiWindow *window,
                                                         guint width,
                                                         guint height);
gboolean            gst_vaapi_window_put_surface        (GstVaapiWindow *window,
                                                         GstVaapiSurface *surface,
                                                         const GstVaapiRectangle *src_rect,
                                                         const GstVaapiRectangle *dst_rect,
                                                         guint flags);

Object Hierarchy

  GObject
   +----GstVaapiObject
         +----GstVaapiWindow
               +----GstVaapiWindowX11

Properties

  "fullscreen"               gboolean              : Read / Write
  "height"                   guint                 : Read / Write
  "width"                    guint                 : Read / Write

Description

Details

struct GstVaapiWindow

struct GstVaapiWindow;

Base class for system-dependent windows.


struct GstVaapiWindowClass

struct GstVaapiWindowClass {
    gboolean    (*create) (GstVaapiWindow *window, guint *width, guint *height);
    void        (*destroy)(GstVaapiWindow *window);
    gboolean    (*show)   (GstVaapiWindow *window);
    gboolean    (*hide)   (GstVaapiWindow *window);
    gboolean    (*get_geometry)  (GstVaapiWindow *window,
                                  gint *px, gint *py,
                                  guint *pwidth, guint *pheight);
    gboolean    (*set_fullscreen)(GstVaapiWindow *window, gboolean fullscreen);
    gboolean    (*resize) (GstVaapiWindow *window, guint width, guint height);
    gboolean    (*render) (GstVaapiWindow *window,
                           GstVaapiSurface *surface,
                           const GstVaapiRectangle *src_rect,
                           const GstVaapiRectangle *dst_rect,
                           guint flags);
};

Base class for system-dependent windows.

create ()

virtual function to create a window with width and height

destroy ()

virtual function to destroy a window

show ()

virtual function to show (map) a window

hide ()

virtual function to hide (unmap) a window

get_geometry ()

set_fullscreen ()

virtual function to change window fullscreen state

resize ()

virtual function to resize a window

render ()

virtual function to render a GstVaapiSurface into a window

gst_vaapi_window_get_display ()

GstVaapiDisplay *   gst_vaapi_window_get_display        (GstVaapiWindow *window);

Returns the GstVaapiDisplay this window is bound to.

window :

a GstVaapiWindow

Returns :

the parent GstVaapiDisplay object

gst_vaapi_window_show ()

void                gst_vaapi_window_show               (GstVaapiWindow *window);

Flags a window to be displayed. Any window that is not shown will not appear on the screen.

window :

a GstVaapiWindow

gst_vaapi_window_hide ()

void                gst_vaapi_window_hide               (GstVaapiWindow *window);

Reverses the effects of gst_vaapi_window_show(), causing the window to be hidden (invisible to the user).

window :

a GstVaapiWindow

gst_vaapi_window_get_fullscreen ()

gboolean            gst_vaapi_window_get_fullscreen     (GstVaapiWindow *window);

Retrieves whether the window is fullscreen or not

window :

a GstVaapiWindow

Returns :

TRUE if the window is fullscreen

gst_vaapi_window_set_fullscreen ()

void                gst_vaapi_window_set_fullscreen     (GstVaapiWindow *window,
                                                         gboolean fullscreen);

Requests to place the window in fullscreen or unfullscreen states.

window :

a GstVaapiWindow

fullscreen :

TRUE to request window to get fullscreen

gst_vaapi_window_get_width ()

guint               gst_vaapi_window_get_width          (GstVaapiWindow *window);

Retrieves the width of a GstVaapiWindow.

window :

a GstVaapiWindow

Returns :

the width of the window, in pixels

gst_vaapi_window_get_height ()

guint               gst_vaapi_window_get_height         (GstVaapiWindow *window);

Retrieves the height of a GstVaapiWindow

window :

a GstVaapiWindow

Returns :

the height of the window, in pixels

gst_vaapi_window_get_size ()

void                gst_vaapi_window_get_size           (GstVaapiWindow *window,
                                                         guint *pwidth,
                                                         guint *pheight);

Retrieves the dimensions of a GstVaapiWindow.

window :

a GstVaapiWindow

pwidth :

return location for the width, or NULL

pheight :

return location for the height, or NULL

gst_vaapi_window_set_width ()

void                gst_vaapi_window_set_width          (GstVaapiWindow *window,
                                                         guint width);

Resizes the window to match the specified width.

window :

a GstVaapiWindow

width :

requested new width for the window, in pixels

gst_vaapi_window_set_height ()

void                gst_vaapi_window_set_height         (GstVaapiWindow *window,
                                                         guint height);

Resizes the window to match the specified height.

window :

a GstVaapiWindow

height :

requested new height for the window, in pixels

gst_vaapi_window_set_size ()

void                gst_vaapi_window_set_size           (GstVaapiWindow *window,
                                                         guint width,
                                                         guint height);

Resizes the window to match the specified width and height.

window :

a GstVaapiWindow

width :

requested new width for the window, in pixels

height :

requested new height for the window, in pixels

gst_vaapi_window_put_surface ()

gboolean            gst_vaapi_window_put_surface        (GstVaapiWindow *window,
                                                         GstVaapiSurface *surface,
                                                         const GstVaapiRectangle *src_rect,
                                                         const GstVaapiRectangle *dst_rect,
                                                         guint flags);

Renders the surface region specified by src_rect into the window region specified by dst_rect. The flags specify how de-interlacing (if needed), color space conversion, scaling and other postprocessing transformations are performed.

window :

a GstVaapiWindow

surface :

a GstVaapiSurface

src_rect :

the sub-rectangle of the source surface to extract and process. If NULL, the entire surface will be used.

dst_rect :

the sub-rectangle of the destination window into which the surface is rendered. If NULL, the entire window will be used.

flags :

postprocessing flags. See GstVaapiSurfaceRenderFlags

Returns :

TRUE on success

Property Details

The "fullscreen" property

  "fullscreen"               gboolean              : Read / Write

The fullscreen state of the window.

Default value: FALSE


The "height" property

  "height"                   guint                 : Read / Write

The window height.

Allowed values: >= 1

Default value: 1


The "width" property

  "width"                    guint                 : Read / Write

The window width.

Allowed values: >= 1

Default value: 1