mutter/doc/reference/tmpl/clutter-alpha.sgml
Emmanuele Bassi 3c2defee9d 2007-06-07 Emmanuele Bassi <ebassi@openedhand.com>
* clutter/clutter-container.[ch]: Add a generic actor container
	interface, for actors to implement without subclassing ClutterGroup.

	* clutter/clutter-group.[ch]: Make ClutterGroup implement the
	ClutterContainer interface, and deprecate the colliding methods.

	* clutter/clutter-layout.[ch]: Add extended layout interface.
	Actors and containers requiring or honouring complex layout
	management should implement this interface and provide at least
	one of the available layout types: width for height, height for
	width, natural size, iterative size request.

	* clutter/clutter-label.c: A ClutterLabel requires height for
	width layout management, so it implements the ClutterLayout
	interface.

	* clutter/Makefile.am: Add new files to the build.

	* tests/*.c:
	* examples/*.c: Update tests and examples code to use the
	new ClutterContainer API instead of ClutterGroup.
2007-06-07 14:41:35 +00:00

296 lines
3.8 KiB
Plaintext

<!-- ##### SECTION Title ##### -->
ClutterAlpha
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
#ClutterBehaviour, #ClutterTimeline
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### STRUCT ClutterAlpha ##### -->
<para>
The #ClutterAlpha structure contains only private data and should not be
accessed directly.
</para>
<!-- ##### ARG ClutterAlpha:alpha ##### -->
<para>
</para>
<!-- ##### ARG ClutterAlpha:timeline ##### -->
<para>
</para>
<!-- ##### STRUCT ClutterAlphaClass ##### -->
<para>
Class structure for #ClutterApha.
</para>
@parent_class:
@_clutter_alpha_1:
@_clutter_alpha_2:
@_clutter_alpha_3:
@_clutter_alpha_4:
@_clutter_alpha_5:
<!-- ##### FUNCTION clutter_alpha_new ##### -->
<para>
</para>
@Returns:
<!-- ##### FUNCTION clutter_alpha_new_full ##### -->
<para>
</para>
@timeline:
@func:
@data:
@destroy:
@Returns:
<!-- ##### FUNCTION clutter_alpha_get_alpha ##### -->
<para>
</para>
@alpha:
@Returns:
<!-- ##### MACRO CLUTTER_ALPHA_MAX_ALPHA ##### -->
<para>
Maximum value of the alpha function. You should use this value to
scale the computed alpha value.
</para>
<!-- ##### USER_FUNCTION ClutterAlphaFunc ##### -->
<para>
The alpha function is a function of time. You should provide a function
transforming the current position in the timeline.
</para>
@alpha: a #ClutterAlpha
@user_data: optional user defined data passed to the function
@Returns: a value between 0 and CLUTTER_ALPHA_MAX_ALPHA
<!-- ##### FUNCTION clutter_alpha_set_func ##### -->
<para>
</para>
@alpha:
@func:
@data:
@destroy:
<!-- ##### FUNCTION clutter_alpha_set_timeline ##### -->
<para>
</para>
@alpha:
@timeline:
<!-- ##### FUNCTION clutter_alpha_get_timeline ##### -->
<para>
</para>
@alpha:
@Returns:
<!-- ##### MACRO CLUTTER_ALPHA_RAMP_INC ##### -->
<para>
Symbolic name for passing clutter_ramp_inc_func().
</para>
<!-- ##### FUNCTION clutter_ramp_inc_func ##### -->
<para>
</para>
@alpha:
@dummy:
@Returns:
<!-- ##### MACRO CLUTTER_ALPHA_RAMP_DEC ##### -->
<para>
Symbolic name for passing clutter_ramp_dec_func().
</para>
<!-- ##### FUNCTION clutter_ramp_dec_func ##### -->
<para>
</para>
@alpha:
@dummy:
@Returns:
<!-- ##### MACRO CLUTTER_ALPHA_RAMP ##### -->
<para>
Symbolic name for passing clutter_ramp_func().
</para>
<!-- ##### FUNCTION clutter_ramp_func ##### -->
<para>
</para>
@alpha:
@dummy:
@Returns:
<!-- ##### MACRO CLUTTER_ALPHA_SINE ##### -->
<para>
Symbolic name for passing clutter_sine_func().
</para>
<!-- ##### FUNCTION clutter_sine_func ##### -->
<para>
</para>
@alpha:
@dummy:
@Returns:
<!-- ##### MACRO CLUTTER_ALPHA_SINE_INC ##### -->
<para>
</para>
<!-- ##### FUNCTION clutter_sine_inc_func ##### -->
<para>
</para>
@alpha:
@dummy:
@Returns:
<!-- ##### MACRO CLUTTER_ALPHA_SINE_DEC ##### -->
<para>
</para>
<!-- ##### FUNCTION clutter_sine_dec_func ##### -->
<para>
</para>
@alpha:
@dummy:
@Returns:
<!-- ##### MACRO CLUTTER_ALPHA_SINE_HALF ##### -->
<para>
</para>
<!-- ##### FUNCTION clutter_sine_half_func ##### -->
<para>
</para>
@alpha:
@dummy:
@Returns:
<!-- ##### MACRO CLUTTER_ALPHA_SQUARE ##### -->
<para>
Symbolic name for passing clutter_square_func().
</para>
<!-- ##### FUNCTION clutter_square_func ##### -->
<para>
</para>
@alpha:
@dummy:
@Returns:
<!-- ##### MACRO CLUTTER_ALPHA_EXP_INC ##### -->
<para>
Symbolic name for passing clutter_exp_inc_func().
</para>
<!-- ##### FUNCTION clutter_exp_inc_func ##### -->
<para>
</para>
@alpha:
@dummy:
@Returns:
<!-- ##### MACRO CLUTTER_ALPHA_EXP_DEC ##### -->
<para>
Symbolic name for passing clutter_exp_dec_func().
</para>
<!-- ##### FUNCTION clutter_exp_dec_func ##### -->
<para>
</para>
@alpha:
@dummy:
@Returns: