GESTitleClip

GESTitleClip — Render stand-alone titles in GESLayer.

Synopsis

#include <ges/ges.h>

                    GESTitleClip;
GESTitleClip *      ges_title_clip_new                  (void);
void                ges_title_clip_set_text             (GESTitleClip *self,
                                                         const gchar *text);
void                ges_title_clip_set_font_desc        (GESTitleClip *self,
                                                         const gchar *font_desc);
void                ges_title_clip_set_halignment       (GESTitleClip *self,
                                                         GESTextHAlign halign);
void                ges_title_clip_set_valignment       (GESTitleClip *self,
                                                         GESTextVAlign valign);
void                ges_title_clip_set_color            (GESTitleClip *self,
                                                         guint32 color);
void                ges_title_clip_set_background       (GESTitleClip *self,
                                                         guint32 background);
void                ges_title_clip_set_xpos             (GESTitleClip *self,
                                                         gdouble position);
void                ges_title_clip_set_ypos             (GESTitleClip *self,
                                                         gdouble position);
const gchar *       ges_title_clip_get_text             (GESTitleClip *self);
const gchar *       ges_title_clip_get_font_desc        (GESTitleClip *self);
GESTextVAlign       ges_title_clip_get_valignment       (GESTitleClip *self);
GESTextHAlign       ges_title_clip_get_halignment       (GESTitleClip *self);
const guint32       ges_title_clip_get_text_color       (GESTitleClip *self);
const guint32       ges_title_clip_get_background_color (GESTitleClip *self);
const gdouble       ges_title_clip_get_xpos             (GESTitleClip *self);
const gdouble       ges_title_clip_get_ypos             (GESTitleClip *self);

Object Hierarchy

  GObject
   +----GInitiallyUnowned
         +----GESTimelineElement
               +----GESContainer
                     +----GESClip
                           +----GESSourceClip
                                 +----GESTitleClip

Implemented Interfaces

GESTitleClip implements GESExtractable and GESMetaContainer.

Properties

  "background"               guint                 : Read / Write / Construct
  "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 the given text in the specified font, at specified position, and with the specified background pattern.

Details

GESTitleClip

typedef struct _GESTitleClip GESTitleClip;

Render stand-alone titles in GESLayer.


ges_title_clip_new ()

GESTitleClip *      ges_title_clip_new                  (void);

Creates a new GESTitleClip

Returns :

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

ges_title_clip_set_text ()

void                ges_title_clip_set_text             (GESTitleClip *self,
                                                         const gchar *text);

Sets the text this clip will render.

self :

the GESTitleClip* to set text on

text :

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

ges_title_clip_set_font_desc ()

void                ges_title_clip_set_font_desc        (GESTitleClip *self,
                                                         const gchar *font_desc);

Sets the pango font description of the text.

self :

the GESTitleClip*

font_desc :

the pango font description

ges_title_clip_set_halignment ()

void                ges_title_clip_set_halignment       (GESTitleClip *self,
                                                         GESTextHAlign halign);

Sets the horizontal aligment of the text.

self :

the GESTitleClip* to set horizontal alignement of text on

halign :

GESTextHAlign

ges_title_clip_set_valignment ()

void                ges_title_clip_set_valignment       (GESTitleClip *self,
                                                         GESTextVAlign valign);

Sets the vertical aligment of the text.

self :

the GESTitleClip* to set vertical alignement of text on

valign :

GESTextVAlign

ges_title_clip_set_color ()

void                ges_title_clip_set_color            (GESTitleClip *self,
                                                         guint32 color);

Sets the color of the text.

self :

the GESTitleClip* to set

color :

The color self is being set to

ges_title_clip_set_background ()

void                ges_title_clip_set_background       (GESTitleClip *self,
                                                         guint32 background);

Sets the background of the text.

self :

the GESTitleClip* to set

background :

The color self is being set to

ges_title_clip_set_xpos ()

void                ges_title_clip_set_xpos             (GESTitleClip *self,
                                                         gdouble position);

Sets the horizontal position of the text.

self :

the GESTitleClip* to set

position :

The horizontal position self is being set to

ges_title_clip_set_ypos ()

void                ges_title_clip_set_ypos             (GESTitleClip *self,
                                                         gdouble position);

Sets the vertical position of the text.

self :

the GESTitleClip* to set

position :

The vertical position self is being set to

ges_title_clip_get_text ()

const gchar *       ges_title_clip_get_text             (GESTitleClip *self);

Get the text currently set on self.

self :

a GESTitleClip

Returns :

The text currently set on self.

ges_title_clip_get_font_desc ()

const gchar *       ges_title_clip_get_font_desc        (GESTitleClip *self);

Get the pango font description used by self.

self :

a GESTitleClip

Returns :

The pango font description used by self.

ges_title_clip_get_valignment ()

GESTextVAlign       ges_title_clip_get_valignment       (GESTitleClip *self);

Get the vertical aligment used by self.

self :

a GESTitleClip

Returns :

The vertical aligment used by self.

ges_title_clip_get_halignment ()

GESTextHAlign       ges_title_clip_get_halignment       (GESTitleClip *self);

Get the horizontal aligment used by self.

self :

a GESTitleClip

Returns :

The horizontal aligment used by self.

ges_title_clip_get_text_color ()

const guint32       ges_title_clip_get_text_color       (GESTitleClip *self);

Get the color used by self.

self :

a GESTitleClip

Returns :

The color used by self.

ges_title_clip_get_background_color ()

const guint32       ges_title_clip_get_background_color (GESTitleClip *self);

Get the background used by self.

self :

a GESTitleClip

Returns :

The color used by self.

ges_title_clip_get_xpos ()

const gdouble       ges_title_clip_get_xpos             (GESTitleClip *self);

Get the horizontal position used by self.

self :

a GESTitleClip

Returns :

The horizontal position used by self.

ges_title_clip_get_ypos ()

const gdouble       ges_title_clip_get_ypos             (GESTitleClip *self);

Get the vertical position used by self.

self :

a GESTitleClip

Returns :

The vertical position used by self.

Property Details

The "background" property

  "background"               guint                 : Read / Write / Construct

The background of the text

Default value: 4294967295


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