Blame docs/libs/html/gst-plugins-base-libs-GstVideoOverlayRectangle.html

Packit 971217
Packit 971217
<html>
Packit 971217
<head>
Packit 971217
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
Packit 971217
<title>GstVideoOverlayRectangle: GStreamer Base Plugins 1.0 Library Reference Manual</title>
Packit 971217
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
Packit 971217
<link rel="home" href="index.html" title="GStreamer Base Plugins 1.0 Library Reference Manual">
Packit 971217
<link rel="up" href="gstreamer-video.html" title="Video Library">
Packit 971217
<link rel="prev" href="gst-plugins-base-libs-gstvideoaffinetransformationmeta.html" title="gstvideoaffinetransformationmeta">
Packit 971217
<link rel="next" href="GstVideoFilter.html" title="GstVideoFilter">
Packit 971217
<meta name="generator" content="GTK-Doc V1.27 (XML mode)">
Packit 971217
<link rel="stylesheet" href="style.css" type="text/css">
Packit 971217
</head>
Packit 971217
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
Packit 971217
Packit 971217
Packit 971217
Top  | 
Packit 971217
                  Description
Packit 971217
Packit 971217
Home
Packit 971217
Up
Packit 971217
Prev
Packit 971217
Next
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217

GstVideoOverlayRectangle

Packit 971217

GstVideoOverlayRectangle — Video Buffer Overlay Compositions (Subtitles, Logos)

Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217

Functions

Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
GstVideoOverlayComposition *
Packit 971217
Packit 971217
Packit 971217
gst_video_overlay_composition_new ()
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
GstVideoOverlayComposition *
Packit 971217
Packit 971217
Packit 971217
gst_video_overlay_composition_ref ()
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
void
Packit 971217
Packit 971217
Packit 971217
gst_video_overlay_composition_unref ()
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
void
Packit 971217
Packit 971217
Packit 971217
gst_video_overlay_composition_add_rectangle ()
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
guint
Packit 971217
Packit 971217
Packit 971217
gst_video_overlay_composition_n_rectangles ()
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
GstVideoOverlayRectangle *
Packit 971217
Packit 971217
Packit 971217
gst_video_overlay_composition_get_rectangle ()
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
guint
Packit 971217
Packit 971217
Packit 971217
gst_video_overlay_composition_get_seqnum ()
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
GstVideoOverlayComposition *
Packit 971217
Packit 971217
Packit 971217
gst_video_overlay_composition_copy ()
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
GstVideoOverlayComposition *
Packit 971217
Packit 971217
Packit 971217
gst_video_overlay_composition_make_writable ()
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
gboolean
Packit 971217
Packit 971217
Packit 971217
gst_video_overlay_composition_blend ()
Packit 971217
Packit 971217
Packit 971217
Packit 971217
const GstMetaInfo *
Packit 971217
Packit 971217
Packit 971217
gst_video_overlay_composition_meta_get_info ()
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
GstVideoOverlayCompositionMeta *
Packit 971217
Packit 971217
Packit 971217
gst_buffer_add_video_overlay_composition_meta ()
Packit 971217
Packit 971217
Packit 971217
Packit 971217
#define
Packit 971217
Packit 971217
gst_buffer_get_video_overlay_composition_meta()
Packit 971217
Packit 971217
Packit 971217
Packit 971217
#define
Packit 971217
Packit 971217
gst_buffer_remove_video_overlay_composition_meta()
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
GstVideoOverlayRectangle *
Packit 971217
Packit 971217
Packit 971217
gst_video_overlay_rectangle_new_raw ()
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
GstVideoOverlayRectangle *
Packit 971217
Packit 971217
Packit 971217
gst_video_overlay_rectangle_ref ()
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
void
Packit 971217
Packit 971217
Packit 971217
gst_video_overlay_rectangle_unref ()
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
GstBuffer *
Packit 971217
Packit 971217
Packit 971217
gst_video_overlay_rectangle_get_pixels_raw ()
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
GstBuffer *
Packit 971217
Packit 971217
Packit 971217
gst_video_overlay_rectangle_get_pixels_argb ()
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
GstBuffer *
Packit 971217
Packit 971217
Packit 971217
gst_video_overlay_rectangle_get_pixels_ayuv ()
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
GstBuffer *
Packit 971217
Packit 971217
Packit 971217
gst_video_overlay_rectangle_get_pixels_unscaled_raw ()
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
GstBuffer *
Packit 971217
Packit 971217
Packit 971217
gst_video_overlay_rectangle_get_pixels_unscaled_argb ()
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
GstBuffer *
Packit 971217
Packit 971217
Packit 971217
gst_video_overlay_rectangle_get_pixels_unscaled_ayuv ()
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
gboolean
Packit 971217
Packit 971217
Packit 971217
gst_video_overlay_rectangle_get_render_rectangle ()
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
guint
Packit 971217
Packit 971217
Packit 971217
gst_video_overlay_rectangle_get_seqnum ()
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
void
Packit 971217
Packit 971217
Packit 971217
gst_video_overlay_rectangle_set_render_rectangle ()
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
GstVideoOverlayRectangle *
Packit 971217
Packit 971217
Packit 971217
gst_video_overlay_rectangle_copy ()
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
GstVideoOverlayFormatFlags
Packit 971217
Packit 971217
Packit 971217
gst_video_overlay_rectangle_get_flags ()
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
gfloat
Packit 971217
Packit 971217
Packit 971217
gst_video_overlay_rectangle_get_global_alpha ()
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
void
Packit 971217
Packit 971217
Packit 971217
gst_video_overlay_rectangle_set_global_alpha ()
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217

Types and Values

Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
 
Packit 971217
GstVideoOverlayComposition
Packit 971217
Packit 971217
Packit 971217
#define
Packit 971217
GST_VIDEO_OVERLAY_COMPOSITION_BLEND_FORMATS
Packit 971217
Packit 971217
Packit 971217
struct
Packit 971217
GstVideoOverlayCompositionMeta
Packit 971217
Packit 971217
Packit 971217
enum
Packit 971217
GstVideoOverlayFormatFlags
Packit 971217
Packit 971217
Packit 971217
 
Packit 971217
GstVideoOverlayRectangle
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217

Includes

Packit 971217
#include <gst/video/video-overlay-composition.h>
Packit 971217
Packit 971217
Packit 971217
Packit 971217

Description

Packit 971217

Functions to create and handle overlay compositions on video buffers.

Packit 971217

An overlay composition describes one or more overlay rectangles to be

Packit 971217
blended on top of a video buffer.

Packit 971217

This API serves two main purposes:

Packit 971217
    Packit 971217
  • it can be used to attach overlay information (subtitles or logos)

  • Packit 971217
    to non-raw video buffers such as GL/VAAPI/VDPAU surfaces. The actual
    Packit 971217
    blending of the overlay can then be done by e.g. the video sink that
    Packit 971217
    processes these non-raw buffers.

    Packit 971217
  • it can also be used to blend overlay rectangles on top of raw video

  • Packit 971217
    buffers, thus consolidating blending functionality for raw video in
    Packit 971217
    one place.

    Packit 971217
    Packit 971217

    Together, this allows existing overlay elements to easily handle raw

    Packit 971217
    and non-raw video as input in without major changes (once the overlays
    Packit 971217
    have been put into a GstOverlayComposition object anyway) - for raw
    Packit 971217
    video the overlay can just use the blending function to blend the data
    Packit 971217
    on top of the video, and for surface buffers it can just attach them to
    Packit 971217
    the buffer and let the sink render the overlays.

    Packit 971217
    Packit 971217
    Packit 971217

    Functions

    Packit 971217
    Packit 971217

    gst_video_overlay_composition_new ()

    Packit 971217
    GstVideoOverlayComposition *
    Packit 971217
    gst_video_overlay_composition_new (GstVideoOverlayRectangle *rectangle);
    Packit 971217

    Creates a new video overlay composition object to hold one or more

    Packit 971217
    overlay rectangles.

    Packit 971217
    Packit 971217

    Parameters

    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217

    rectangle

    Packit 971217

    a GstVideoOverlayRectangle to add to the

    Packit 971217
    composition. 

    Packit 971217
    [transfer none]
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217

    Returns

    Packit 971217

    a new GstVideoOverlayComposition. Unref with

    Packit 971217
    gst_video_overlay_composition_unref() when no longer needed. 

    Packit 971217

    [transfer full]

    Packit 971217
    Packit 971217
    Packit 971217

    Packit 971217
    Packit 971217

    gst_video_overlay_composition_ref ()

    Packit 971217
    GstVideoOverlayComposition *
    Packit 971217
    gst_video_overlay_composition_ref (GstVideoOverlayComposition *comp);
    Packit 971217

    Increases the refcount of the given composition by one.

    Packit 971217

    Note that the refcount affects the writeability

    Packit 971217
    of comp
    Packit 971217
    , use gst_video_overlay_composition_make_writable() to ensure
    Packit 971217
    a composition and its rectangles can be modified.

    Packit 971217
    Packit 971217

    Parameters

    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217

    comp

    Packit 971217

    a a GstVideoOverlayComposition.

    Packit 971217
     
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217

    Returns

    Packit 971217

    comp

    Packit 971217
    . 

    Packit 971217

    [transfer full]

    Packit 971217
    Packit 971217
    Packit 971217

    Packit 971217
    Packit 971217

    gst_video_overlay_composition_unref ()

    Packit 971217
    void
    Packit 971217
    gst_video_overlay_composition_unref (GstVideoOverlayComposition *comp);
    Packit 971217

    Decreases the refcount of the composition. If the refcount reaches 0, the

    Packit 971217
    composition will be freed.

    Packit 971217
    Packit 971217

    Parameters

    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217

    comp

    Packit 971217

    a GstVideoOverlayComposition.

    Packit 971217
    [transfer full]
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217

    Packit 971217
    Packit 971217

    gst_video_overlay_composition_add_rectangle ()

    Packit 971217
    void
    Packit 971217
    gst_video_overlay_composition_add_rectangle
    Packit 971217
                                   (GstVideoOverlayComposition *comp,
    Packit 971217
                                    GstVideoOverlayRectangle *rectangle);
    Packit 971217

    Adds an overlay rectangle to an existing overlay composition object. This

    Packit 971217
    must be done right after creating the overlay composition.

    Packit 971217
    Packit 971217

    Parameters

    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217

    comp

    Packit 971217

    a GstVideoOverlayComposition

    Packit 971217
     
    Packit 971217
    Packit 971217
    Packit 971217

    rectangle

    Packit 971217

    a GstVideoOverlayRectangle to add to the

    Packit 971217
    composition. 

    Packit 971217
    [transfer none]
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217

    Packit 971217
    Packit 971217

    gst_video_overlay_composition_n_rectangles ()

    Packit 971217
    guint
    Packit 971217
    gst_video_overlay_composition_n_rectangles
    Packit 971217
                                   (GstVideoOverlayComposition *comp);
    Packit 971217

    Returns the number of GstVideoOverlayRectangles contained in comp

    Packit 971217
    .

    Packit 971217
    Packit 971217

    Parameters

    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217

    comp

    Packit 971217

    a GstVideoOverlayComposition

    Packit 971217
     
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217

    Returns

    Packit 971217

    the number of rectangles

    Packit 971217
    Packit 971217
    Packit 971217

    Packit 971217
    Packit 971217

    gst_video_overlay_composition_get_rectangle ()

    Packit 971217
    GstVideoOverlayRectangle *
    Packit 971217
    gst_video_overlay_composition_get_rectangle
    Packit 971217
                                   (GstVideoOverlayComposition *comp,
    Packit 971217
                                    guint n);
    Packit 971217

    Returns the n

    Packit 971217
    -th GstVideoOverlayRectangle contained in comp
    Packit 971217
    .

    Packit 971217
    Packit 971217

    Parameters

    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217

    comp

    Packit 971217

    a GstVideoOverlayComposition

    Packit 971217
     
    Packit 971217
    Packit 971217
    Packit 971217

    n

    Packit 971217

    number of the rectangle to get

    Packit 971217
     
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217

    Returns

    Packit 971217

    the n

    Packit 971217
    -th rectangle, or NULL if n
    Packit 971217
    is out of
    Packit 971217
    bounds. Will not return a new reference, the caller will need to
    Packit 971217
    obtain her own reference using gst_video_overlay_rectangle_ref()
    Packit 971217
    if needed. 

    Packit 971217

    [transfer none]

    Packit 971217
    Packit 971217
    Packit 971217

    Packit 971217
    Packit 971217

    gst_video_overlay_composition_get_seqnum ()

    Packit 971217
    guint
    Packit 971217
    gst_video_overlay_composition_get_seqnum
    Packit 971217
                                   (GstVideoOverlayComposition *comp);
    Packit 971217

    Returns the sequence number of this composition. Sequence numbers are

    Packit 971217
    monotonically increasing and unique for overlay compositions and rectangles
    Packit 971217
    (meaning there will never be a rectangle with the same sequence number as
    Packit 971217
    a composition).

    Packit 971217
    Packit 971217

    Parameters

    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217

    comp

    Packit 971217

    a GstVideoOverlayComposition

    Packit 971217
     
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217

    Returns

    Packit 971217

    the sequence number of comp

    Packit 971217

    Packit 971217
    Packit 971217
    Packit 971217

    Packit 971217
    Packit 971217

    gst_video_overlay_composition_copy ()

    Packit 971217
    GstVideoOverlayComposition *
    Packit 971217
    gst_video_overlay_composition_copy (GstVideoOverlayComposition *comp);
    Packit 971217

    Makes a copy of comp

    Packit 971217
     and all contained rectangles, so that it is possible
    Packit 971217
    to modify the composition and contained rectangles (e.g. add additional
    Packit 971217
    rectangles or change the render co-ordinates or render dimension). The
    Packit 971217
    actual overlay pixel data buffers contained in the rectangles are not
    Packit 971217
    copied.

    Packit 971217
    Packit 971217

    Parameters

    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217

    comp

    Packit 971217

    a GstVideoOverlayComposition to copy.

    Packit 971217
    [transfer none]
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217

    Returns

    Packit 971217

    a new GstVideoOverlayComposition equivalent

    Packit 971217
    to comp
    Packit 971217
    . 

    Packit 971217

    [transfer full]

    Packit 971217
    Packit 971217
    Packit 971217

    Packit 971217
    Packit 971217

    gst_video_overlay_composition_make_writable ()

    Packit 971217
    GstVideoOverlayComposition *
    Packit 971217
    gst_video_overlay_composition_make_writable
    Packit 971217
                                   (GstVideoOverlayComposition *comp);
    Packit 971217

    Takes ownership of comp

    Packit 971217
     and returns a version of comp
    Packit 971217
     that is writable
    Packit 971217
    (i.e. can be modified). Will either return comp
    Packit 971217
     right away, or create a
    Packit 971217
    new writable copy of comp
    Packit 971217
     and unref comp
    Packit 971217
     itself. All the contained
    Packit 971217
    rectangles will also be copied, but the actual overlay pixel data buffers
    Packit 971217
    contained in the rectangles are not copied.

    Packit 971217
    Packit 971217

    Parameters

    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217

    comp

    Packit 971217

    a GstVideoOverlayComposition to copy.

    Packit 971217
    [transfer full]
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217

    Returns

    Packit 971217

    a writable GstVideoOverlayComposition

    Packit 971217
    equivalent to comp
    Packit 971217
    . 

    Packit 971217

    [transfer full]

    Packit 971217
    Packit 971217
    Packit 971217

    Packit 971217
    Packit 971217

    gst_video_overlay_composition_blend ()

    Packit 971217
    gboolean
    Packit 971217
    gst_video_overlay_composition_blend (GstVideoOverlayComposition *comp,
    Packit 971217
                                         GstVideoFrame *video_buf);
    Packit 971217

    Blends the overlay rectangles in comp

    Packit 971217
     on top of the raw video data
    Packit 971217
    contained in video_buf
    Packit 971217
    . The data in video_buf
    Packit 971217
     must be writable and
    Packit 971217
    mapped appropriately.

    Packit 971217

    Since video_buf

    Packit 971217
     data is read and will be modified, it ought be
    Packit 971217
    mapped with flag GST_MAP_READWRITE.

    Packit 971217
    Packit 971217

    Parameters

    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217

    comp

    Packit 971217

    a GstVideoOverlayComposition

    Packit 971217
     
    Packit 971217
    Packit 971217
    Packit 971217

    video_buf

    Packit 971217

    a GstVideoFrame containing raw video data in a

    Packit 971217
    supported format. It should be mapped using GST_MAP_READWRITE

    Packit 971217
     
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217

    Packit 971217
    Packit 971217

    gst_video_overlay_composition_meta_get_info ()

    Packit 971217
    const GstMetaInfo *
    Packit 971217
    gst_video_overlay_composition_meta_get_info
    Packit 971217
                                   (void);
    Packit 971217
    Packit 971217

    Packit 971217
    Packit 971217

    gst_buffer_add_video_overlay_composition_meta ()

    Packit 971217
    GstVideoOverlayCompositionMeta *
    Packit 971217
    gst_buffer_add_video_overlay_composition_meta
    Packit 971217
                                   (GstBuffer *buf,
    Packit 971217
                                    GstVideoOverlayComposition *comp);
    Packit 971217

    Sets an overlay composition on a buffer. The buffer will obtain its own

    Packit 971217
    reference to the composition, meaning this function does not take ownership
    Packit 971217
    of comp
    Packit 971217
    .

    Packit 971217
    Packit 971217

    Parameters

    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217

    buf

    Packit 971217

    a GstBuffer

    Packit 971217
     
    Packit 971217
    Packit 971217
    Packit 971217

    comp

    Packit 971217

    a GstVideoOverlayComposition.

    Packit 971217
    [allow-none]
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217

    Returns

    Packit 971217

    a GstVideoOverlayCompositionMeta.

    Packit 971217

    [transfer none]

    Packit 971217
    Packit 971217
    Packit 971217

    Packit 971217
    Packit 971217

    gst_buffer_get_video_overlay_composition_meta()

    Packit 971217
    #define             gst_buffer_get_video_overlay_composition_meta(b)
    Packit 971217
    Packit 971217

    Packit 971217
    Packit 971217

    gst_buffer_remove_video_overlay_composition_meta()

    Packit 971217
    #define             gst_buffer_remove_video_overlay_composition_meta(b,m)
    Packit 971217
    Packit 971217

    Packit 971217
    Packit 971217

    gst_video_overlay_rectangle_new_raw ()

    Packit 971217
    GstVideoOverlayRectangle *
    Packit 971217
    gst_video_overlay_rectangle_new_raw (GstBuffer *pixels,
    Packit 971217
                                         gint render_x,
    Packit 971217
                                         gint render_y,
    Packit 971217
                                         guint render_width,
    Packit 971217
                                         guint render_height,
    Packit 971217
                                         GstVideoOverlayFormatFlags flags);
    Packit 971217

    Creates a new video overlay rectangle with ARGB or AYUV pixel data.

    Packit 971217
    The layout in case of ARGB of the components in memory is B-G-R-A
    Packit 971217
    on little-endian platforms
    Packit 971217
    (corresponding to GST_VIDEO_FORMAT_BGRA) and A-R-G-B on big-endian
    Packit 971217
    platforms (corresponding to GST_VIDEO_FORMAT_ARGB). In other words,
    Packit 971217
    pixels are treated as 32-bit words and the lowest 8 bits then contain
    Packit 971217
    the blue component value and the highest 8 bits contain the alpha
    Packit 971217
    component value. Unless specified in the flags, the RGB values are
    Packit 971217
    non-premultiplied. This is the format that is used by most hardware,
    Packit 971217
    and also many rendering libraries such as Cairo, for example.
    Packit 971217
    The pixel data buffer must have GstVideoMeta set.

    Packit 971217
    Packit 971217

    Parameters

    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217

    pixels

    Packit 971217

    a GstBuffer pointing to the pixel memory.

    Packit 971217
    [transfer none]
    Packit 971217
    Packit 971217
    Packit 971217

    render_x

    Packit 971217

    the X co-ordinate on the video where the top-left corner of this

    Packit 971217
    overlay rectangle should be rendered to

    Packit 971217
     
    Packit 971217
    Packit 971217
    Packit 971217

    render_y

    Packit 971217

    the Y co-ordinate on the video where the top-left corner of this

    Packit 971217
    overlay rectangle should be rendered to

    Packit 971217
     
    Packit 971217
    Packit 971217
    Packit 971217

    render_width

    Packit 971217

    the render width of this rectangle on the video

    Packit 971217
     
    Packit 971217
    Packit 971217
    Packit 971217

    render_height

    Packit 971217

    the render height of this rectangle on the video

    Packit 971217
     
    Packit 971217
    Packit 971217
    Packit 971217

    flags

    Packit 971217

    flags

    Packit 971217
     
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217

    Returns

    Packit 971217

    a new GstVideoOverlayRectangle. Unref with

    Packit 971217
    gst_video_overlay_rectangle_unref() when no longer needed. 

    Packit 971217

    [transfer full]

    Packit 971217
    Packit 971217
    Packit 971217

    Packit 971217
    Packit 971217

    gst_video_overlay_rectangle_ref ()

    Packit 971217
    GstVideoOverlayRectangle *
    Packit 971217
    gst_video_overlay_rectangle_ref (GstVideoOverlayRectangle *comp);
    Packit 971217

    Increases the refcount of the given rectangle by one.

    Packit 971217

    Note that the refcount affects the writeability

    Packit 971217
    of comp
    Packit 971217
    , use gst_video_overlay_rectangle_copy() to ensure a rectangle can
    Packit 971217
    be modified (there is no gst_video_overlay_rectangle_make_writable() because
    Packit 971217
    it is unlikely that someone will hold the single reference to the rectangle
    Packit 971217
    and not know that that's the case).

    Packit 971217
    Packit 971217

    Parameters

    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217

    comp

    Packit 971217

    a a GstVideoOverlayRectangle.

    Packit 971217
     
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217

    Returns

    Packit 971217

    comp

    Packit 971217
    . 

    Packit 971217

    [transfer full]

    Packit 971217
    Packit 971217
    Packit 971217

    Packit 971217
    Packit 971217

    gst_video_overlay_rectangle_unref ()

    Packit 971217
    void
    Packit 971217
    gst_video_overlay_rectangle_unref (GstVideoOverlayRectangle *comp);
    Packit 971217

    Decreases the refcount of the rectangle. If the refcount reaches 0, the

    Packit 971217
    rectangle will be freed.

    Packit 971217
    Packit 971217

    Parameters

    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217

    comp

    Packit 971217

    a GstVideoOverlayRectangle.

    Packit 971217
    [transfer full]
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217

    Packit 971217
    Packit 971217

    gst_video_overlay_rectangle_get_pixels_raw ()

    Packit 971217
    GstBuffer *
    Packit 971217
    gst_video_overlay_rectangle_get_pixels_raw
    Packit 971217
                                   (GstVideoOverlayRectangle *rectangle,
    Packit 971217
                                    GstVideoOverlayFormatFlags flags);
    Packit 971217
    Packit 971217

    Parameters

    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217

    rectangle

    Packit 971217

    a GstVideoOverlayRectangle

    Packit 971217
     
    Packit 971217
    Packit 971217
    Packit 971217

    flags

    Packit 971217

    flags

    Packit 971217
    If a global_alpha value != 1 is set for the rectangle, the caller
    Packit 971217
    should set the GST_VIDEO_OVERLAY_FORMAT_FLAG_GLOBAL_ALPHA flag
    Packit 971217
    if he wants to apply global-alpha himself. If the flag is not set
    Packit 971217
    global_alpha is applied internally before returning the pixel-data.

    Packit 971217
     
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217

    Returns

    Packit 971217

    a GstBuffer holding the pixel data with

    Packit 971217
    format as originally provided and specified in video meta with
    Packit 971217
    width and height of the render dimensions as per
    Packit 971217
    gst_video_overlay_rectangle_get_render_rectangle(). This function does
    Packit 971217
    not return a reference, the caller should obtain a reference of her own
    Packit 971217
    with gst_buffer_ref() if needed. 

    Packit 971217

    [transfer none]

    Packit 971217
    Packit 971217
    Packit 971217

    Packit 971217
    Packit 971217

    gst_video_overlay_rectangle_get_pixels_argb ()

    Packit 971217
    GstBuffer *
    Packit 971217
    gst_video_overlay_rectangle_get_pixels_argb
    Packit 971217
                                   (GstVideoOverlayRectangle *rectangle,
    Packit 971217
                                    GstVideoOverlayFormatFlags flags);
    Packit 971217
    Packit 971217

    Parameters

    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217

    rectangle

    Packit 971217

    a GstVideoOverlayRectangle

    Packit 971217
     
    Packit 971217
    Packit 971217
    Packit 971217

    flags

    Packit 971217

    flags

    Packit 971217
    If a global_alpha value != 1 is set for the rectangle, the caller
    Packit 971217
    should set the GST_VIDEO_OVERLAY_FORMAT_FLAG_GLOBAL_ALPHA flag
    Packit 971217
    if he wants to apply global-alpha himself. If the flag is not set
    Packit 971217
    global_alpha is applied internally before returning the pixel-data.

    Packit 971217
     
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217

    Returns

    Packit 971217

    a GstBuffer holding the ARGB pixel data with

    Packit 971217
    width and height of the render dimensions as per
    Packit 971217
    gst_video_overlay_rectangle_get_render_rectangle(). This function does
    Packit 971217
    not return a reference, the caller should obtain a reference of her own
    Packit 971217
    with gst_buffer_ref() if needed. 

    Packit 971217

    [transfer none]

    Packit 971217
    Packit 971217
    Packit 971217

    Packit 971217
    Packit 971217

    gst_video_overlay_rectangle_get_pixels_ayuv ()

    Packit 971217
    GstBuffer *
    Packit 971217
    gst_video_overlay_rectangle_get_pixels_ayuv
    Packit 971217
                                   (GstVideoOverlayRectangle *rectangle,
    Packit 971217
                                    GstVideoOverlayFormatFlags flags);
    Packit 971217
    Packit 971217

    Parameters

    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217

    rectangle

    Packit 971217

    a GstVideoOverlayRectangle

    Packit 971217
     
    Packit 971217
    Packit 971217
    Packit 971217

    flags

    Packit 971217

    flags

    Packit 971217
    If a global_alpha value != 1 is set for the rectangle, the caller
    Packit 971217
    should set the GST_VIDEO_OVERLAY_FORMAT_FLAG_GLOBAL_ALPHA flag
    Packit 971217
    if he wants to apply global-alpha himself. If the flag is not set
    Packit 971217
    global_alpha is applied internally before returning the pixel-data.

    Packit 971217
     
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217

    Returns

    Packit 971217

    a GstBuffer holding the AYUV pixel data with

    Packit 971217
    width and height of the render dimensions as per
    Packit 971217
    gst_video_overlay_rectangle_get_render_rectangle(). This function does
    Packit 971217
    not return a reference, the caller should obtain a reference of her own
    Packit 971217
    with gst_buffer_ref() if needed. 

    Packit 971217

    [transfer none]

    Packit 971217
    Packit 971217
    Packit 971217

    Packit 971217
    Packit 971217

    gst_video_overlay_rectangle_get_pixels_unscaled_raw ()

    Packit 971217
    GstBuffer *
    Packit 971217
    gst_video_overlay_rectangle_get_pixels_unscaled_raw
    Packit 971217
                                   (GstVideoOverlayRectangle *rectangle,
    Packit 971217
                                    GstVideoOverlayFormatFlags flags);
    Packit 971217

    Retrieves the pixel data as it is. This is useful if the caller can

    Packit 971217
    do the scaling itself when handling the overlaying. The rectangle will
    Packit 971217
    need to be scaled to the render dimensions, which can be retrieved using
    Packit 971217
    gst_video_overlay_rectangle_get_render_rectangle().

    Packit 971217
    Packit 971217

    Parameters

    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217

    rectangle

    Packit 971217

    a GstVideoOverlayRectangle

    Packit 971217
     
    Packit 971217
    Packit 971217
    Packit 971217

    flags

    Packit 971217

    flags.

    Packit 971217
    If a global_alpha value != 1 is set for the rectangle, the caller
    Packit 971217
    should set the GST_VIDEO_OVERLAY_FORMAT_FLAG_GLOBAL_ALPHA flag
    Packit 971217
    if he wants to apply global-alpha himself. If the flag is not set
    Packit 971217
    global_alpha is applied internally before returning the pixel-data.

    Packit 971217
     
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217

    Returns

    Packit 971217

    a GstBuffer holding the pixel data with

    Packit 971217
    GstVideoMeta set. This function does not return a reference, the caller
    Packit 971217
    should obtain a reference of her own with gst_buffer_ref() if needed. 

    Packit 971217

    [transfer none]

    Packit 971217
    Packit 971217
    Packit 971217

    Packit 971217
    Packit 971217

    gst_video_overlay_rectangle_get_pixels_unscaled_argb ()

    Packit 971217
    GstBuffer *
    Packit 971217
    gst_video_overlay_rectangle_get_pixels_unscaled_argb
    Packit 971217
                                   (GstVideoOverlayRectangle *rectangle,
    Packit 971217
                                    GstVideoOverlayFormatFlags flags);
    Packit 971217

    Retrieves the pixel data as it is. This is useful if the caller can

    Packit 971217
    do the scaling itself when handling the overlaying. The rectangle will
    Packit 971217
    need to be scaled to the render dimensions, which can be retrieved using
    Packit 971217
    gst_video_overlay_rectangle_get_render_rectangle().

    Packit 971217
    Packit 971217

    Parameters

    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217

    rectangle

    Packit 971217

    a GstVideoOverlayRectangle

    Packit 971217
     
    Packit 971217
    Packit 971217
    Packit 971217

    flags

    Packit 971217

    flags.

    Packit 971217
    If a global_alpha value != 1 is set for the rectangle, the caller
    Packit 971217
    should set the GST_VIDEO_OVERLAY_FORMAT_FLAG_GLOBAL_ALPHA flag
    Packit 971217
    if he wants to apply global-alpha himself. If the flag is not set
    Packit 971217
    global_alpha is applied internally before returning the pixel-data.

    Packit 971217
     
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217

    Returns

    Packit 971217

    a GstBuffer holding the ARGB pixel data with

    Packit 971217
    GstVideoMeta set. This function does not return a reference, the caller
    Packit 971217
    should obtain a reference of her own with gst_buffer_ref() if needed. 

    Packit 971217

    [transfer none]

    Packit 971217
    Packit 971217
    Packit 971217

    Packit 971217
    Packit 971217

    gst_video_overlay_rectangle_get_pixels_unscaled_ayuv ()

    Packit 971217
    GstBuffer *
    Packit 971217
    gst_video_overlay_rectangle_get_pixels_unscaled_ayuv
    Packit 971217
                                   (GstVideoOverlayRectangle *rectangle,
    Packit 971217
                                    GstVideoOverlayFormatFlags flags);
    Packit 971217

    Retrieves the pixel data as it is. This is useful if the caller can

    Packit 971217
    do the scaling itself when handling the overlaying. The rectangle will
    Packit 971217
    need to be scaled to the render dimensions, which can be retrieved using
    Packit 971217
    gst_video_overlay_rectangle_get_render_rectangle().

    Packit 971217
    Packit 971217

    Parameters

    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217

    rectangle

    Packit 971217

    a GstVideoOverlayRectangle

    Packit 971217
     
    Packit 971217
    Packit 971217
    Packit 971217

    flags

    Packit 971217

    flags.

    Packit 971217
    If a global_alpha value != 1 is set for the rectangle, the caller
    Packit 971217
    should set the GST_VIDEO_OVERLAY_FORMAT_FLAG_GLOBAL_ALPHA flag
    Packit 971217
    if he wants to apply global-alpha himself. If the flag is not set
    Packit 971217
    global_alpha is applied internally before returning the pixel-data.

    Packit 971217
     
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217

    Returns

    Packit 971217

    a GstBuffer holding the AYUV pixel data with

    Packit 971217
    GstVideoMeta set. This function does not return a reference, the caller
    Packit 971217
    should obtain a reference of her own with gst_buffer_ref() if needed. 

    Packit 971217

    [transfer none]

    Packit 971217
    Packit 971217
    Packit 971217

    Packit 971217
    Packit 971217

    gst_video_overlay_rectangle_get_render_rectangle ()

    Packit 971217
    gboolean
    Packit 971217
    gst_video_overlay_rectangle_get_render_rectangle
    Packit 971217
                                   (GstVideoOverlayRectangle *rectangle,
    Packit 971217
                                    gint *render_x,
    Packit 971217
                                    gint *render_y,
    Packit 971217
                                    guint *render_width,
    Packit 971217
                                    guint *render_height);
    Packit 971217

    Retrieves the render position and render dimension of the overlay

    Packit 971217
    rectangle on the video.

    Packit 971217
    Packit 971217

    Parameters

    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217

    rectangle

    Packit 971217

    a GstVideoOverlayRectangle

    Packit 971217
     
    Packit 971217
    Packit 971217
    Packit 971217

    render_x

    Packit 971217

    address where to store the X render offset.

    Packit 971217
    [out][allow-none]
    Packit 971217
    Packit 971217
    Packit 971217

    render_y

    Packit 971217

    address where to store the Y render offset.

    Packit 971217
    [out][allow-none]
    Packit 971217
    Packit 971217
    Packit 971217

    render_width

    Packit 971217

    address where to store the render width.

    Packit 971217
    [out][allow-none]
    Packit 971217
    Packit 971217
    Packit 971217

    render_height

    Packit 971217

    address where to store the render height.

    Packit 971217
    [out][allow-none]
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217

    Returns

    Packit 971217

    TRUE if valid render dimensions were retrieved.

    Packit 971217
    Packit 971217
    Packit 971217

    Packit 971217
    Packit 971217

    gst_video_overlay_rectangle_get_seqnum ()

    Packit 971217
    guint
    Packit 971217
    gst_video_overlay_rectangle_get_seqnum
    Packit 971217
                                   (GstVideoOverlayRectangle *rectangle);
    Packit 971217

    Returns the sequence number of this rectangle. Sequence numbers are

    Packit 971217
    monotonically increasing and unique for overlay compositions and rectangles
    Packit 971217
    (meaning there will never be a rectangle with the same sequence number as
    Packit 971217
    a composition).

    Packit 971217

    Using the sequence number of a rectangle as an indicator for changed

    Packit 971217
    pixel-data of a rectangle is dangereous. Some API calls, like e.g.
    Packit 971217
    gst_video_overlay_rectangle_set_global_alpha(), automatically update
    Packit 971217
    the per rectangle sequence number, which is misleading for renderers/
    Packit 971217
    consumers, that handle global-alpha themselves. For them  the
    Packit 971217
    pixel-data returned by gst_video_overlay_rectangle_get_pixels_*()
    Packit 971217
    wont be different for different global-alpha values. In this case a
    Packit 971217
    renderer could also use the GstBuffer pointers as a hint for changed
    Packit 971217
    pixel-data.

    Packit 971217
    Packit 971217

    Parameters

    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217

    rectangle

    Packit 971217

    a GstVideoOverlayRectangle

    Packit 971217
     
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217

    Returns

    Packit 971217

    the sequence number of rectangle

    Packit 971217

    Packit 971217
    Packit 971217
    Packit 971217

    Packit 971217
    Packit 971217

    gst_video_overlay_rectangle_set_render_rectangle ()

    Packit 971217
    void
    Packit 971217
    gst_video_overlay_rectangle_set_render_rectangle
    Packit 971217
                                   (GstVideoOverlayRectangle *rectangle,
    Packit 971217
                                    gint render_x,
    Packit 971217
                                    gint render_y,
    Packit 971217
                                    guint render_width,
    Packit 971217
                                    guint render_height);
    Packit 971217

    Sets the render position and dimensions of the rectangle on the video.

    Packit 971217
    This function is mainly for elements that modify the size of the video
    Packit 971217
    in some way (e.g. through scaling or cropping) and need to adjust the
    Packit 971217
    details of any overlays to match the operation that changed the size.

    Packit 971217

    rectangle

    Packit 971217
     must be writable, meaning its refcount must be 1. You can
    Packit 971217
    make the rectangles inside a GstVideoOverlayComposition writable using
    Packit 971217
    gst_video_overlay_composition_make_writable() or
    Packit 971217
    gst_video_overlay_composition_copy().

    Packit 971217
    Packit 971217

    Parameters

    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217

    rectangle

    Packit 971217

    a GstVideoOverlayRectangle

    Packit 971217
     
    Packit 971217
    Packit 971217
    Packit 971217

    render_x

    Packit 971217

    render X position of rectangle on video

    Packit 971217
     
    Packit 971217
    Packit 971217
    Packit 971217

    render_y

    Packit 971217

    render Y position of rectangle on video

    Packit 971217
     
    Packit 971217
    Packit 971217
    Packit 971217

    render_width

    Packit 971217

    render width of rectangle

    Packit 971217
     
    Packit 971217
    Packit 971217
    Packit 971217

    render_height

    Packit 971217

    render height of rectangle

    Packit 971217
     
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217

    Packit 971217
    Packit 971217

    gst_video_overlay_rectangle_copy ()

    Packit 971217
    GstVideoOverlayRectangle *
    Packit 971217
    gst_video_overlay_rectangle_copy (GstVideoOverlayRectangle *rectangle);
    Packit 971217

    Makes a copy of rectangle

    Packit 971217
    , so that it is possible to modify it
    Packit 971217
    (e.g. to change the render co-ordinates or render dimension). The
    Packit 971217
    actual overlay pixel data buffers contained in the rectangle are not
    Packit 971217
    copied.

    Packit 971217
    Packit 971217

    Parameters

    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217

    rectangle

    Packit 971217

    a GstVideoOverlayRectangle to copy.

    Packit 971217
    [transfer none]
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217

    Returns

    Packit 971217

    a new GstVideoOverlayRectangle equivalent

    Packit 971217
    to rectangle
    Packit 971217
    . 

    Packit 971217

    [transfer full]

    Packit 971217
    Packit 971217
    Packit 971217

    Packit 971217
    Packit 971217

    gst_video_overlay_rectangle_get_flags ()

    Packit 971217
    GstVideoOverlayFormatFlags
    Packit 971217
    gst_video_overlay_rectangle_get_flags (GstVideoOverlayRectangle *rectangle);
    Packit 971217

    Retrieves the flags associated with a GstVideoOverlayRectangle.

    Packit 971217
    This is useful if the caller can handle both premultiplied alpha and
    Packit 971217
    non premultiplied alpha, for example. By knowing whether the rectangle
    Packit 971217
    uses premultiplied or not, it can request the pixel data in the format
    Packit 971217
    it is stored in, to avoid unnecessary conversion.

    Packit 971217
    Packit 971217

    Parameters

    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217

    rectangle

    Packit 971217

    a GstVideoOverlayRectangle

    Packit 971217
     
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217

    Returns

    Packit 971217

    the GstVideoOverlayFormatFlags associated with the rectangle.

    Packit 971217
    Packit 971217
    Packit 971217

    Packit 971217
    Packit 971217

    gst_video_overlay_rectangle_get_global_alpha ()

    Packit 971217
    gfloat
    Packit 971217
    gst_video_overlay_rectangle_get_global_alpha
    Packit 971217
                                   (GstVideoOverlayRectangle *rectangle);
    Packit 971217

    Retrieves the global-alpha value associated with a GstVideoOverlayRectangle.

    Packit 971217
    Packit 971217

    Parameters

    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217

    rectangle

    Packit 971217

    a GstVideoOverlayRectangle

    Packit 971217
     
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217

    Returns

    Packit 971217

    the global-alpha value associated with the rectangle.

    Packit 971217
    Packit 971217
    Packit 971217

    Packit 971217
    Packit 971217

    gst_video_overlay_rectangle_set_global_alpha ()

    Packit 971217
    void
    Packit 971217
    gst_video_overlay_rectangle_set_global_alpha
    Packit 971217
                                   (GstVideoOverlayRectangle *rectangle,
    Packit 971217
                                    gfloat global_alpha);
    Packit 971217

    Sets the global alpha value associated with a GstVideoOverlayRectangle. Per-

    Packit 971217
    pixel alpha values are multiplied with this value. Valid
    Packit 971217
    values: 0 <= global_alpha <= 1; 1 to deactivate.

    Packit 971217

    rectangle

    Packit 971217
     must be writable, meaning its refcount must be 1. You can
    Packit 971217
    make the rectangles inside a GstVideoOverlayComposition writable using
    Packit 971217
    gst_video_overlay_composition_make_writable() or
    Packit 971217
    gst_video_overlay_composition_copy().

    Packit 971217
    Packit 971217

    Parameters

    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217

    rectangle

    Packit 971217

    a GstVideoOverlayRectangle

    Packit 971217
     
    Packit 971217
    Packit 971217
    Packit 971217

    global_alpha

    Packit 971217

    Global alpha value (0 to 1.0)

    Packit 971217
     
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217

    Types and Values

    Packit 971217
    Packit 971217

    GstVideoOverlayComposition

    Packit 971217
    typedef struct _GstVideoOverlayComposition GstVideoOverlayComposition;
    Packit 971217

    An opaque video overlay composition object. A composition contains

    Packit 971217
    multiple overlay rectangles.

    Packit 971217
    Packit 971217

    Packit 971217
    Packit 971217

    GST_VIDEO_OVERLAY_COMPOSITION_BLEND_FORMATS

    Packit 971217
    #define             GST_VIDEO_OVERLAY_COMPOSITION_BLEND_FORMATS
    Packit 971217

    Video formats supported by gst_video_overlay_composition_blend(), for

    Packit 971217
    use in overlay elements' pad template caps.

    Packit 971217

    Since: 1.2

    Packit 971217
    Packit 971217

    Packit 971217
    Packit 971217

    struct GstVideoOverlayCompositionMeta

    Packit 971217
    struct GstVideoOverlayCompositionMeta {
    Packit 971217
      GstMeta meta;
    Packit 971217
    Packit 971217
      GstVideoOverlayComposition *overlay;
    Packit 971217
    };
    Packit 971217
    Packit 971217

    Extra buffer metadata describing image overlay data.

    Packit 971217
    Packit 971217

    Members

    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217

    GstMeta meta;

    Packit 971217

    parent GstMeta

    Packit 971217
     
    Packit 971217
    Packit 971217
    Packit 971217

    GstVideoOverlayComposition *overlay;

    Packit 971217

    the attached GstVideoOverlayComposition

    Packit 971217
     
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217

    Packit 971217
    Packit 971217

    enum GstVideoOverlayFormatFlags

    Packit 971217

    Overlay format flags.

    Packit 971217
    Packit 971217

    Members

    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217

    GST_VIDEO_OVERLAY_FORMAT_FLAG_NONE

    Packit 971217
    Packit 971217

    no flags

    Packit 971217
    Packit 971217
     
    Packit 971217
    Packit 971217
    Packit 971217

    GST_VIDEO_OVERLAY_FORMAT_FLAG_PREMULTIPLIED_ALPHA

    Packit 971217
    Packit 971217

    RGB are premultiplied by A/255.

    Packit 971217
    Packit 971217
     
    Packit 971217
    Packit 971217
    Packit 971217

    GST_VIDEO_OVERLAY_FORMAT_FLAG_GLOBAL_ALPHA

    Packit 971217
    Packit 971217

    a global-alpha value != 1 is set.

    Packit 971217
    Packit 971217
     
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217

    Packit 971217
    Packit 971217

    GstVideoOverlayRectangle

    Packit 971217
    typedef struct _GstVideoOverlayRectangle GstVideoOverlayRectangle;
    Packit 971217

    An opaque video overlay rectangle object. A rectangle contains a single

    Packit 971217
    overlay rectangle which can be added to a composition.

    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217
    Packit 971217

    Generated by GTK-Doc V1.27
    Packit 971217
    </body>
    Packit 971217
    </html>