mask

mask — Filter through rectangular mask

Synopsis

                    GstMask;

Object Hierarchy

  GObject
   +----GstObject
         +----GstElement
               +----GstBaseTransform
                     +----GstVideoFilter
                           +----GstMask

Properties

  "bottom-right-x"           guint                 : Read / Write
  "bottom-right-y"           guint                 : Read / Write
  "fill"                     GstMaskFill           : Read / Write
  "upper-left-x"             guint                 : Read / Write
  "upper-left-y"             guint                 : Read / Write

Description

History

This filter applies a rectangular mask to an image. The mask is specified by an upper left and bottom right corner; everything outside of the maks is set to color indicated by fill (as borders are in the videobox filter).

It is akin to and named after transcode mask filter [Thomas Oestreich, Chad Page].

Details

GstMask

typedef struct _GstMask GstMask;

Property Details

The `"bottom-right-x"` property

  "bottom-right-x"           guint                 : Read / Write

Bottom right corner x-coordinate.

Default value: 32

The `"bottom-right-y"` property

  "bottom-right-y"           guint                 : Read / Write

Bottom right corner y-coordinate.

Default value: 32

The `"fill"` property

  "fill"                     GstMaskFill           : Read / Write

How to fill masked parts.

Default value: Black

The `"upper-left-x"` property

  "upper-left-x"             guint                 : Read / Write

Upper left corner x-coordinate.

Default value: 0

The `"upper-left-y"` property

  "upper-left-y"             guint                 : Read / Write

Upper left corner y-coordinate.