CtkEffectGlow

CtkEffectGlow — A glow effect.

Synopsis

#include <ctk-effect-glow.h>

#define             CTK_EFFECT_GLOW_MIN_FACTOR
#define             CTK_EFFECT_GLOW_MAX_FACTOR
#define             CTK_EFFECT_GLOW_DEFAULT_FACTOR
                    CtkEffectGlow;
                    CtkEffectGlowClass;
                    CtkEffectGlowPrivate;
CtkEffect *         ctk_effect_glow_new                 (void);
void                ctk_effect_glow_set_factor          (CtkEffectGlow *glow,
                                                         gfloat factor);
gfloat              ctk_effect_glow_get_factor          (CtkEffectGlow *glow);
void                ctk_effect_glow_set_color           (CtkEffectGlow *glow,
                                                         ClutterColor *c);
void                ctk_effect_glow_get_color           (CtkEffectGlow *glow,
                                                         ClutterColor *color);
void                ctk_effect_glow_set_background_texture
                                                        (CtkEffectGlow *self,
                                                         GdkPixbuf *pixbuf);

Object Hierarchy

  GObject
   +----GInitiallyUnowned
         +----CtkEffect
               +----CtkEffectGlow

Properties

  "color"                    ClutterColor*         : Read / Write
  "factor"                   gfloat                : Read / Write

Description

CtkEffectGlow is an implementation of CtkEffect that causes the CtkActor it's attached to to glow.

Details

CTK_EFFECT_GLOW_MIN_FACTOR

#define CTK_EFFECT_GLOW_MIN_FACTOR            0.0f


CTK_EFFECT_GLOW_MAX_FACTOR

#define CTK_EFFECT_GLOW_MAX_FACTOR            1.0f


CTK_EFFECT_GLOW_DEFAULT_FACTOR

#define CTK_EFFECT_GLOW_DEFAULT_FACTOR        1.0f


CtkEffectGlow

typedef struct _CtkEffectGlow CtkEffectGlow;


CtkEffectGlowClass

typedef struct {
} CtkEffectGlowClass;


CtkEffectGlowPrivate

typedef struct _CtkEffectGlowPrivate CtkEffectGlowPrivate;


ctk_effect_glow_new ()

CtkEffect *         ctk_effect_glow_new                 (void);

Returns :

A new CtkEffectGlow

ctk_effect_glow_set_factor ()

void                ctk_effect_glow_set_factor          (CtkEffectGlow *glow,
                                                         gfloat factor);

glow: A pointer to a CtkEffectGlow object factor: A float representing the intensity of the glow effect.

glow :

factor :


ctk_effect_glow_get_factor ()

gfloat              ctk_effect_glow_get_factor          (CtkEffectGlow *glow);

glow: A pointer to a CtkEffectGlow object

glow :

Returns :

The glow intensity

ctk_effect_glow_set_color ()

void                ctk_effect_glow_set_color           (CtkEffectGlow *glow,
                                                         ClutterColor *c);

glow: A pointer to a CtkEffectGlow object color: The glow color to set

glow :

c :


ctk_effect_glow_get_color ()

void                ctk_effect_glow_get_color           (CtkEffectGlow *glow,
                                                         ClutterColor *color);

glow: A pointer to a CtkEffectGlow object color: Returns the glow color

glow :

color :


ctk_effect_glow_set_background_texture ()

void                ctk_effect_glow_set_background_texture
                                                        (CtkEffectGlow *self,
                                                         GdkPixbuf *pixbuf);

glow: A pointer to a CtkEffectGlow object pixbuf: Pixbux image containing the background texture

This function takes a GdkPixbuf as parameter to create an opengl texture for the GlowEffect object. The created opengl texture must remain private to the GlowEffect.

self :

pixbuf :

Property Details

The "color" property

  "color"                    ClutterColor*         : Read / Write

glow color.


The "factor" property

  "factor"                   gfloat                : Read / Write

glow intensity.

Allowed values: [0,1]

Default value: 1