MxTextureFrame

MxTextureFrame — Stretch a texture to fit the entire allocation

Synopsis

                    MxTextureFrame;
ClutterActor*       mx_texture_frame_new                (ClutterTexture *texture,
                                                         gfloat top,
                                                         gfloat right,
                                                         gfloat bottom,
                                                         gfloat left);
void                mx_texture_frame_set_parent_texture (MxTextureFrame *frame,
                                                         ClutterTexture *texture);
ClutterTexture*     mx_texture_frame_get_parent_texture (MxTextureFrame *frame);
void                mx_texture_frame_set_border_values  (MxTextureFrame *frame,
                                                         gfloat top,
                                                         gfloat right,
                                                         gfloat bottom,
                                                         gfloat left);
void                mx_texture_frame_get_border_values  (MxTextureFrame *frame,
                                                         gfloat *top,
                                                         gfloat *right,
                                                         gfloat *bottom,
                                                         gfloat *left);

Object Hierarchy

  GObject
   +----GInitiallyUnowned
         +----ClutterActor
               +----MxTextureFrame

Implemented Interfaces

MxTextureFrame implements ClutterScriptable.

Properties

  "bottom"                   gfloat                : Read / Write / Construct
  "left"                     gfloat                : Read / Write / Construct
  "parent-texture"           ClutterTexture*       : Read / Write / Construct
  "right"                    gfloat                : Read / Write / Construct
  "top"                      gfloat                : Read / Write / Construct

Description

MxTextureFrame

Details

MxTextureFrame

typedef struct _MxTextureFrame MxTextureFrame;

The contents of this structure are private and should only be accessed through the public API.


mx_texture_frame_new ()

ClutterActor*       mx_texture_frame_new                (ClutterTexture *texture,
                                                         gfloat top,
                                                         gfloat right,
                                                         gfloat bottom,
                                                         gfloat left);

A MxTextureFrame is a specialized texture that efficiently clones an area of the given texture while keeping preserving portions of the same texture.

A MxTextureFrame can be used to make a rectangular texture fit a given size without stretching its borders.

texture : a ClutterTexture or NULL
top : top margin preserving its content
right : right margin preserving its content
bottom : bottom margin preserving its content
left : left margin preserving its content
Returns : the newly created MxTextureFrame

mx_texture_frame_set_parent_texture ()

void                mx_texture_frame_set_parent_texture (MxTextureFrame *frame,
                                                         ClutterTexture *texture);

Set the ClutterTexture used by this MxTextureFrame

frame : A MxTextureFrame
texture : A ClutterTexture

mx_texture_frame_get_parent_texture ()

ClutterTexture*     mx_texture_frame_get_parent_texture (MxTextureFrame *frame);

Return the texture used by the MxTextureFrame

frame : A MxTextureFrame
Returns : (transfer none): a ClutterTexture owned by the MxTextureFrame

mx_texture_frame_set_border_values ()

void                mx_texture_frame_set_border_values  (MxTextureFrame *frame,
                                                         gfloat top,
                                                         gfloat right,
                                                         gfloat bottom,
                                                         gfloat left);

Set the slice lines of the specified frame. The slices are calculated as widths from the edge of the frame.

frame : A MxTextureFrame
top : width of the top slice
right : width of the right slice
bottom : width of the bottom slice
left : width of the left slice

mx_texture_frame_get_border_values ()

void                mx_texture_frame_get_border_values  (MxTextureFrame *frame,
                                                         gfloat *top,
                                                         gfloat *right,
                                                         gfloat *bottom,
                                                         gfloat *left);

Retrieve the current slice lines from the specified frame.

frame : A MxTextureFrame
top : width of the top slice
right : width of the right slice
bottom : width of the bottom slice
left : width of the left slice

Property Details

The "bottom" property

  "bottom"                   gfloat                : Read / Write / Construct

Bottom offset.

Allowed values: >= 0

Default value: 0


The "left" property

  "left"                     gfloat                : Read / Write / Construct

Left offset.

Allowed values: >= 0

Default value: 0


The "parent-texture" property

  "parent-texture"           ClutterTexture*       : Read / Write / Construct

The parent ClutterTexture.


The "right" property

  "right"                    gfloat                : Read / Write / Construct

Right offset.

Allowed values: >= 0

Default value: 0


The "top" property

  "top"                      gfloat                : Read / Write / Construct

Top offset.

Allowed values: >= 0

Default value: 0