GESTextOverlayClip

GESTextOverlayClip — Render text onto another stream in a GESLayer

Synopsis

#include <ges/ges.h>

                    GESTextOverlayClip;
GESTextOverlayClip * ges_text_overlay_clip_new          (void);
void                ges_text_overlay_clip_set_text      (GESTextOverlayClip *self,
                                                         const gchar *text);
void                ges_text_overlay_clip_set_font_desc (GESTextOverlayClip *self,
                                                         const gchar *font_desc);
void                ges_text_overlay_clip_set_valign    (GESTextOverlayClip *self,
                                                         GESTextVAlign valign);
void                ges_text_overlay_clip_set_halign    (GESTextOverlayClip *self,
                                                         GESTextHAlign halign);
void                ges_text_overlay_clip_set_color     (GESTextOverlayClip *self,
                                                         guint32 color);
void                ges_text_overlay_clip_set_xpos      (GESTextOverlayClip *self,
                                                         gdouble position);
void                ges_text_overlay_clip_set_ypos      (GESTextOverlayClip *self,
                                                         gdouble position);
const gchar *       ges_text_overlay_clip_get_text      (GESTextOverlayClip *self);
const gchar *       ges_text_overlay_clip_get_font_desc (GESTextOverlayClip *self);
GESTextVAlign       ges_text_overlay_clip_get_valignment
                                                        (GESTextOverlayClip *self);
GESTextHAlign       ges_text_overlay_clip_get_halignment
                                                        (GESTextOverlayClip *self);
const guint32       ges_text_overlay_clip_get_color     (GESTextOverlayClip *self);
const gdouble       ges_text_overlay_clip_get_xpos      (GESTextOverlayClip *self);
const gdouble       ges_text_overlay_clip_get_ypos      (GESTextOverlayClip *self);

Object Hierarchy

  GObject
   +----GInitiallyUnowned
         +----GESTimelineElement
               +----GESContainer
                     +----GESClip
                           +----GESOperationClip
                                 +----GESOverlayClip
                                       +----GESTextOverlayClip

Implemented Interfaces

GESTextOverlayClip implements GESExtractable and GESMetaContainer.

Properties

  "color"                    guint                 : Read / Write / Construct
  "font-desc"                gchar*                : Read / Write / Construct
  "halignment"               GESTextHAlign         : Read / Write / Construct
  "text"                     gchar*                : Read / Write / Construct
  "valignment"               GESTextVAlign         : Read / Write / Construct
  "xpos"                     gdouble               : Read / Write / Construct
  "ypos"                     gdouble               : Read / Write / Construct

Description

Renders text onto the next lower priority stream using textrender.

Details

GESTextOverlayClip

typedef struct _GESTextOverlayClip GESTextOverlayClip;

ges_text_overlay_clip_new ()

GESTextOverlayClip * ges_text_overlay_clip_new          (void);

Creates a new GESTextOverlayClip

Returns :

The newly created GESTextOverlayClip, or NULL if there was an error.

ges_text_overlay_clip_set_text ()

void                ges_text_overlay_clip_set_text      (GESTextOverlayClip *self,
                                                         const gchar *text);

Sets the text this clip will render.

self :

the GESTextOverlayClip* to set text on

text :

the text to render. an internal copy of this text will be made.

ges_text_overlay_clip_set_font_desc ()

void                ges_text_overlay_clip_set_font_desc (GESTextOverlayClip *self,
                                                         const gchar *font_desc);

Sets the pango font description of the text

self :

the GESTextOverlayClip*

font_desc :

the pango font description

ges_text_overlay_clip_set_valign ()

void                ges_text_overlay_clip_set_valign    (GESTextOverlayClip *self,
                                                         GESTextVAlign valign);

Sets the vertical aligment of the text.

self :

the GESTextOverlayClip* to set vertical alignement of text on

valign :

GESTextVAlign

ges_text_overlay_clip_set_halign ()

void                ges_text_overlay_clip_set_halign    (GESTextOverlayClip *self,
                                                         GESTextHAlign halign);

Sets the horizontal aligment of the text.

self :

the GESTextOverlayClip* to set horizontal alignement of text on

halign :

GESTextHAlign

ges_text_overlay_clip_set_color ()

void                ges_text_overlay_clip_set_color     (GESTextOverlayClip *self,
                                                         guint32 color);

Sets the color of the text.

self :

the GESTextOverlayClip* to set

color :

The color self is being set to

ges_text_overlay_clip_set_xpos ()

void                ges_text_overlay_clip_set_xpos      (GESTextOverlayClip *self,
                                                         gdouble position);

Sets the horizontal position of the text.

self :

the GESTextOverlayClip* to set

position :

The horizontal position self is being set to

ges_text_overlay_clip_set_ypos ()

void                ges_text_overlay_clip_set_ypos      (GESTextOverlayClip *self,
                                                         gdouble position);

Sets the vertical position of the text.

self :

the GESTextOverlayClip* to set

position :

The vertical position self is being set to

ges_text_overlay_clip_get_text ()

const gchar *       ges_text_overlay_clip_get_text      (GESTextOverlayClip *self);

Get the text currently set on self.

self :

a GESTextOverlayClip

Returns :

The text currently set on self.

ges_text_overlay_clip_get_font_desc ()

const gchar *       ges_text_overlay_clip_get_font_desc (GESTextOverlayClip *self);

Get the pango font description used by self.

self :

a GESTextOverlayClip

Returns :

The pango font description used by self.

ges_text_overlay_clip_get_valignment ()

GESTextVAlign       ges_text_overlay_clip_get_valignment
                                                        (GESTextOverlayClip *self);

Get the vertical aligment used by self.

self :

a GESTextOverlayClip

Returns :

The vertical aligment used by self.

ges_text_overlay_clip_get_halignment ()

GESTextHAlign       ges_text_overlay_clip_get_halignment
                                                        (GESTextOverlayClip *self);

Get the horizontal aligment used by self.

self :

a GESTextOverlayClip

Returns :

The horizontal aligment used by self.

ges_text_overlay_clip_get_color ()

const guint32       ges_text_overlay_clip_get_color     (GESTextOverlayClip *self);

Get the color used by source.

self :

a GESTextOverlayClip

Returns :

The color used by source.

ges_text_overlay_clip_get_xpos ()

const gdouble       ges_text_overlay_clip_get_xpos      (GESTextOverlayClip *self);

Get the horizontal position used by source.

self :

a GESTextOverlayClip

Returns :

The horizontal position used by source.

ges_text_overlay_clip_get_ypos ()

const gdouble       ges_text_overlay_clip_get_ypos      (GESTextOverlayClip *self);

Get the vertical position used by source.

self :

a GESTextOverlayClip

Returns :

The vertical position used by source.

Property Details

The "color" property

  "color"                    guint                 : Read / Write / Construct

The color of the text

Default value: 4294967295


The "font-desc" property

  "font-desc"                gchar*                : Read / Write / Construct

Pango font description string

Default value: "Serif 36"


The "halignment" property

  "halignment"               GESTextHAlign         : Read / Write / Construct

Horizontal alignment of the text

Default value: center


The "text" property

  "text"                     gchar*                : Read / Write / Construct

The text to diplay

Default value: ""


The "valignment" property

  "valignment"               GESTextVAlign         : Read / Write / Construct

Vertical alignent of the text

Default value: baseline


The "xpos" property

  "xpos"                     gdouble               : Read / Write / Construct

The horizontal position of the text

Allowed values: [0,1]

Default value: 0.5


The "ypos" property

  "ypos"                     gdouble               : Read / Write / Construct

The vertical position of the text

Allowed values: [0,1]

Default value: 0.5