GESTimelineTextOverlay

GESTimelineTextOverlay — Render text onto another stream in a GESTimelineLayer

Functions

Properties

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

Types and Values

Object Hierarchy

    GObject
    ╰── GInitiallyUnowned
        ╰── GESTimelineObject
            ╰── GESTimelineOperation
                ╰── GESTimelineOverlay
                    ╰── GESTimelineTextOverlay

Includes

#include <ges/ges.h>

Description

Renders text onto the next lower priority stream using textrender.

Functions

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.

Parameters

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

Parameters

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.

Parameters

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.

Parameters

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 .

Parameters

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 .

Parameters

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 .

Parameters

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 .

Parameters

Returns

The horizontal aligment used by self .

Types and Values

GESTimelineTextOverlay

typedef struct _GESTimelineTextOverlay GESTimelineTextOverlay;

Property Details

The “font-desc” property

  “font-desc”                gchar *

Pango font description string

Flags: Read / Write / Construct

Default value: "Serif 36"


The “halignment” property

  “halignment”               GESTextHAlign

Horizontal alignment of the text

Flags: Read / Write / Construct

Default value: center


The “text” property

  “text”                     gchar *

The text to diplay

Flags: Read / Write / Construct

Default value: ""


The “valignment” property

  “valignment”               GESTextVAlign

Vertical alignent of the text

Flags: Read / Write / Construct

Default value: baseline