GESTimelineTextOverlay

GESTimelineTextOverlay — Render text onto another stream in a GESTimelineLayer

Synopsis

#include <ges/ges.h>

                    GESTimelineTextOverlay;
GESTimelineTextOverlay * ges_timeline_text_overlay_new  (void);
void                ges_timeline_text_overlay_set_text  (GESTimelineTextOverlay *self,
                                                         const gchar *text);
void                ges_timeline_text_overlay_set_font_desc
                                                        (GESTimelineTextOverlay *self,
                                                         const gchar *font_desc);
void                ges_timeline_text_overlay_set_valign
                                                        (GESTimelineTextOverlay *self,
                                                         GESTextVAlign valign);
void                ges_timeline_text_overlay_set_halign
                                                        (GESTimelineTextOverlay *self,
                                                         GESTextHAlign halign);
const gchar *       ges_timeline_text_overlay_get_text  (GESTimelineTextOverlay *self);
const gchar *       ges_timeline_text_overlay_get_font_desc
                                                        (GESTimelineTextOverlay *self);
GESTextVAlign       ges_timeline_text_overlay_get_valignment
                                                        (GESTimelineTextOverlay *self);
GESTextHAlign       ges_timeline_text_overlay_get_halignment
                                                        (GESTimelineTextOverlay *self);

Object Hierarchy

  GObject
   +----GInitiallyUnowned
         +----GESTimelineObject
               +----GESTimelineOperation
                     +----GESTimelineOverlay
                           +----GESTimelineTextOverlay

Properties

  "font-desc"                gchar*                : Read / Write / Construct
  "halignment"               GESTextHAlign         : Read / Write / Construct
  "text"                     gchar*                : Read / Write / Construct
  "valignment"               GESTextVAlign         : Read / Write / Construct

Description

Renders text onto the next lower priority stream using textrender.

Details

GESTimelineTextOverlay

typedef struct _GESTimelineTextOverlay GESTimelineTextOverlay;

ges_timeline_text_overlay_new ()

GESTimelineTextOverlay * ges_timeline_text_overlay_new  (void);

Creates a new GESTimelineTextOverlay

Returns :

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

ges_timeline_text_overlay_set_text ()

void                ges_timeline_text_overlay_set_text  (GESTimelineTextOverlay *self,
                                                         const gchar *text);

Sets the text this timeline object will render.

self :

the GESTimelineTextOverlay* to set text on

text :

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

ges_timeline_text_overlay_set_font_desc ()

void                ges_timeline_text_overlay_set_font_desc
                                                        (GESTimelineTextOverlay *self,
                                                         const gchar *font_desc);

Sets the pango font description of the text

self :

the GESTimelineTextOverlay*

font_desc :

the pango font description

ges_timeline_text_overlay_set_valign ()

void                ges_timeline_text_overlay_set_valign
                                                        (GESTimelineTextOverlay *self,
                                                         GESTextVAlign valign);

Sets the vertical aligment of the text.

self :

the GESTimelineTextOverlay* to set vertical alignement of text on

valign :

GESTextVAlign

ges_timeline_text_overlay_set_halign ()

void                ges_timeline_text_overlay_set_halign
                                                        (GESTimelineTextOverlay *self,
                                                         GESTextHAlign halign);

Sets the horizontal aligment of the text.

self :

the GESTimelineTextOverlay* to set horizontal alignement of text on

halign :

GESTextHAlign

ges_timeline_text_overlay_get_text ()

const gchar *       ges_timeline_text_overlay_get_text  (GESTimelineTextOverlay *self);

Get the text currently set on self.

self :

a GESTimelineTextOverlay

Returns :

The text currently set on self.

ges_timeline_text_overlay_get_font_desc ()

const gchar *       ges_timeline_text_overlay_get_font_desc
                                                        (GESTimelineTextOverlay *self);

Get the pango font description used by self.

self :

a GESTimelineTextOverlay

Returns :

The pango font description used by self.

ges_timeline_text_overlay_get_valignment ()

GESTextVAlign       ges_timeline_text_overlay_get_valignment
                                                        (GESTimelineTextOverlay *self);

Get the vertical aligment used by self.

self :

a GESTimelineTextOverlay

Returns :

The vertical aligment used by self.

ges_timeline_text_overlay_get_halignment ()

GESTextHAlign       ges_timeline_text_overlay_get_halignment
                                                        (GESTimelineTextOverlay *self);

Get the horizontal aligment used by self.

self :

a GESTimelineTextOverlay

Returns :

The horizontal aligment used by self.

Property Details

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