mirror of https://github.com/GNOME/gimp.git
Updated/improved/organised documentation comments.
* app/composite/gimp-composite-generic.c: * app/composite/gimp-composite.[ch]: Updated/improved/organised documentation comments.
This commit is contained in:
Helvetix Victorinox
parent
6ebaccd6d1
commit
39790c8801
|
|
@ -1,3 +1,9 @@
|
|||
2003-10-13 Helvetix Victorinox <helvetix@gimp.org>
|
||||
|
||||
* app/composite/gimp-composite-generic.c:
|
||||
* app/composite/gimp-composite.[ch]: Updated/improved/organised
|
||||
documentation comments.
|
||||
|
||||
2003-10-13 Sven Neumann <sven@gimp.org>
|
||||
|
||||
* libgimp/gimptile.c: code cleanup and some documentation.
|
||||
|
|
|
|||
|
|
@ -208,9 +208,12 @@ gimp_composite_color_any_any_any_generic (guchar *dest,
|
|||
|
||||
/**
|
||||
* gimp_composite_blend_any_any_any_generic:
|
||||
* @ctx:
|
||||
* @ctx: The compositing context.
|
||||
*
|
||||
* Perform a blend operation between sources ctx->A and ctx->B, using
|
||||
* the generalised algorithm: D = A * (255 - β) + B * β
|
||||
*
|
||||
* The result is left in ctx->D
|
||||
**/
|
||||
void
|
||||
gimp_composite_blend_any_any_any_generic (GimpCompositeContext *ctx)
|
||||
|
|
@ -260,8 +263,14 @@ gimp_composite_shade_generic (const guchar *src, guchar *dest, const guchar *col
|
|||
|
||||
/**
|
||||
* gimp_composite_darken_any_any_any_generic:
|
||||
* @ctx:
|
||||
* @ctx: The compositing context.
|
||||
*
|
||||
* Perform a darken operation between sources ctx->A and ctx->B, using
|
||||
* the generalised algorithm:
|
||||
* D_r = min(A_r, B_r);
|
||||
* D_g = min(A_g, B_g);
|
||||
* D_b = min(A_b, B_b);
|
||||
* D_a = min(A_a, B_a);
|
||||
*
|
||||
**/
|
||||
void
|
||||
|
|
@ -301,8 +310,14 @@ gimp_composite_darken_any_any_any_generic (GimpCompositeContext * ctx)
|
|||
|
||||
/**
|
||||
* gimp_composite_lighten_any_any_any_generic:
|
||||
* @ctx:
|
||||
* @ctx: The compositing context.
|
||||
*
|
||||
* Perform a lighten operation between sources ctx->A and ctx->B, using the
|
||||
* generalised algorithm:
|
||||
* D_r = max(A_r, B_r);
|
||||
* D_g = max(A_g, B_g);
|
||||
* D_b = max(A_b, B_b);
|
||||
* D_a = min(A_a, B_a);
|
||||
*
|
||||
**/
|
||||
void
|
||||
|
|
@ -343,9 +358,10 @@ gimp_composite_lighten_any_any_any_generic (GimpCompositeContext * ctx)
|
|||
|
||||
/**
|
||||
* gimp_composite_hue_any_any_any_generic:
|
||||
* @ctx:
|
||||
*
|
||||
* @ctx: The compositing context.
|
||||
*
|
||||
* Perform a conversion to hue only of the source ctx->A using
|
||||
* the hue of ctx->B.
|
||||
**/
|
||||
void
|
||||
gimp_composite_hue_any_any_any_generic (GimpCompositeContext * ctx)
|
||||
|
|
@ -396,8 +412,10 @@ gimp_composite_hue_any_any_any_generic (GimpCompositeContext * ctx)
|
|||
|
||||
/**
|
||||
* gimp_composite_saturation_any_any_any_generic:
|
||||
* @ctx:
|
||||
* @ctx: The compositing context.
|
||||
*
|
||||
* Perform a conversion to saturation only of the source ctx->A using
|
||||
* the saturation level of ctx->B.
|
||||
*
|
||||
**/
|
||||
void
|
||||
|
|
@ -449,8 +467,10 @@ gimp_composite_saturation_any_any_any_generic (GimpCompositeContext * ctx)
|
|||
|
||||
/**
|
||||
* gimp_composite_value_any_any_any_generic:
|
||||
* @ctx:
|
||||
* @ctx: The compositing context.
|
||||
*
|
||||
* Perform a conversion to value only of the source ctx->A using
|
||||
* the value of ctx->B.
|
||||
*
|
||||
**/
|
||||
void
|
||||
|
|
@ -502,8 +522,10 @@ gimp_composite_value_any_any_any_generic (GimpCompositeContext * ctx)
|
|||
|
||||
/**
|
||||
* gimp_composite_color_only_any_any_any_generic:
|
||||
* @ctx:
|
||||
* @ctx: The compositing context.
|
||||
*
|
||||
* Perform a conversion to of the source ctx->A using
|
||||
* the hue and saturation values of ctx->B.
|
||||
*
|
||||
**/
|
||||
void
|
||||
|
|
@ -556,8 +578,9 @@ gimp_composite_color_only_any_any_any_generic (GimpCompositeContext * ctx)
|
|||
|
||||
/**
|
||||
* gimp_composite_behind_any_any_any_generic:
|
||||
* @ctx:
|
||||
* @ctx: The compositing context.
|
||||
*
|
||||
* Perform a behind operation to between the pixel sources ctx->A and ctx->B.
|
||||
*
|
||||
**/
|
||||
void
|
||||
|
|
@ -571,8 +594,10 @@ gimp_composite_behind_any_any_any_generic (GimpCompositeContext * ctx)
|
|||
|
||||
/**
|
||||
* gimp_composite_multiply_any_any_any_generic:
|
||||
* @ctx:
|
||||
* @ctx: The compositing context.
|
||||
*
|
||||
* Perform an RGB[A] multiply operation between the pixel sources
|
||||
* ctx->A and ctx->B.
|
||||
*
|
||||
**/
|
||||
void
|
||||
|
|
@ -629,8 +654,10 @@ gimp_composite_multiply_any_any_any_generic (GimpCompositeContext * ctx)
|
|||
|
||||
/**
|
||||
* gimp_composite_divide_any_any_any_generic:
|
||||
* @ctx:
|
||||
* @ctx: The compositing context.
|
||||
*
|
||||
* Perform an RGB[A] divide operation between the pixel sources
|
||||
* ctx->A and ctx->B.
|
||||
*
|
||||
**/
|
||||
void
|
||||
|
|
@ -669,8 +696,12 @@ gimp_composite_divide_any_any_any_generic (GimpCompositeContext * ctx)
|
|||
|
||||
/**
|
||||
* gimp_composite_screen_any_any_any_generic:
|
||||
* @ctx:
|
||||
* @ctx: The compositing context.
|
||||
*
|
||||
* Perform an RGB[A] screen operation between the pixel sources
|
||||
* ctx->A and ctx->B, using the generalised algorithm:
|
||||
*
|
||||
* D = 255 - (255 - A) * (255 - B)
|
||||
*
|
||||
**/
|
||||
void
|
||||
|
|
@ -706,8 +737,12 @@ gimp_composite_screen_any_any_any_generic (GimpCompositeContext * ctx)
|
|||
|
||||
/**
|
||||
* gimp_composite_overlay_any_any_any_generic:
|
||||
* @ctx:
|
||||
* @ctx: The compositing context.
|
||||
*
|
||||
* Perform an RGB[A] overlay operation between the pixel sources
|
||||
* ctx->A and ctx->B, using the generalised algorithm:
|
||||
*
|
||||
* D = A * (B + (2 * B) * (255 - A))
|
||||
*
|
||||
**/
|
||||
void
|
||||
|
|
@ -745,8 +780,12 @@ gimp_composite_overlay_any_any_any_generic (GimpCompositeContext * ctx)
|
|||
|
||||
/**
|
||||
* gimp_composite_dodge_any_any_any_generic:
|
||||
* @ctx:
|
||||
* @ctx: The compositing context.
|
||||
*
|
||||
* Perform an RGB[A] dodge operation between the pixel sources
|
||||
* ctx->A and ctx->B, using the generalised algorithm:
|
||||
*
|
||||
* D = saturation of 255 or (A * 256) / (256 - B)
|
||||
*
|
||||
**/
|
||||
void
|
||||
|
|
@ -786,8 +825,12 @@ gimp_composite_dodge_any_any_any_generic (GimpCompositeContext * ctx)
|
|||
|
||||
/**
|
||||
* gimp_composite_burn_any_any_any_generic:
|
||||
* @ctx:
|
||||
* @ctx: The compositing context.
|
||||
*
|
||||
* Perform an RGB[A] dodge operation between the pixel sources
|
||||
* ctx->A and ctx->B, using the generalised algorithm:
|
||||
*
|
||||
* D = saturation of 255 or depletion of 0, of ((255 - A) * 256) / (B + 1)
|
||||
*
|
||||
**/
|
||||
void
|
||||
|
|
@ -830,8 +873,10 @@ gimp_composite_burn_any_any_any_generic (GimpCompositeContext * ctx)
|
|||
|
||||
/**
|
||||
* gimp_composite_hardlight_any_any_any_generic:
|
||||
* @ctx:
|
||||
* @ctx: The compositing context.
|
||||
*
|
||||
* Perform an RGB[A] hardlight operation between the pixel sources
|
||||
* ctx->A and ctx->B.
|
||||
*
|
||||
**/
|
||||
void
|
||||
|
|
@ -878,8 +923,10 @@ gimp_composite_hardlight_any_any_any_generic (GimpCompositeContext * ctx)
|
|||
|
||||
/**
|
||||
* gimp_composite_softlight_any_any_any_generic:
|
||||
* @ctx:
|
||||
* @ctx: The compositing context.
|
||||
*
|
||||
* Perform an RGB[A] softlight operation between the pixel sources
|
||||
* ctx->A and ctx->B.
|
||||
*
|
||||
**/
|
||||
void
|
||||
|
|
@ -920,8 +967,10 @@ gimp_composite_softlight_any_any_any_generic (GimpCompositeContext * ctx)
|
|||
|
||||
/**
|
||||
* gimp_composite_grain_extract_any_any_any_generic:
|
||||
* @ctx:
|
||||
* @ctx: The compositing context.
|
||||
*
|
||||
* Perform an RGB[A] grain-extract operation between the pixel sources
|
||||
* ctx->A and ctx->B.
|
||||
*
|
||||
**/
|
||||
void
|
||||
|
|
@ -961,8 +1010,10 @@ gimp_composite_grain_extract_any_any_any_generic (GimpCompositeContext * ctx)
|
|||
|
||||
/**
|
||||
* gimp_composite_grain_merge_any_any_any_generic:
|
||||
* @ctx:
|
||||
* @ctx: The compositing context.
|
||||
*
|
||||
* Perform an RGB[A] grain-merge operation between the pixel sources
|
||||
* ctx->A and ctx->B.
|
||||
*
|
||||
**/
|
||||
void
|
||||
|
|
@ -1002,8 +1053,10 @@ gimp_composite_grain_merge_any_any_any_generic (GimpCompositeContext * ctx)
|
|||
|
||||
/**
|
||||
* gimp_composite_addition_any_any_any_generic:
|
||||
* @ctx:
|
||||
* @ctx: The compositing context.
|
||||
*
|
||||
* Perform an RGB[A] addition operation of the pixel sources ctx->A
|
||||
* and ctx->B.
|
||||
*
|
||||
**/
|
||||
void
|
||||
|
|
@ -1055,8 +1108,10 @@ gimp_composite_addition_any_any_any_generic (GimpCompositeContext * ctx)
|
|||
|
||||
/**
|
||||
* gimp_composite_subtract_any_any_any_generic:
|
||||
* @ctx:
|
||||
* @ctx: The compositing context.
|
||||
*
|
||||
* Perform an RGB[A] subtract operation of the pixel source
|
||||
* ctx-B from ctx->A.
|
||||
*
|
||||
**/
|
||||
void
|
||||
|
|
@ -1096,8 +1151,10 @@ gimp_composite_subtract_any_any_any_generic (GimpCompositeContext * ctx)
|
|||
|
||||
/**
|
||||
* gimp_composite_difference_any_any_any_generic:
|
||||
* @ctx:
|
||||
* @ctx: The compositing context.
|
||||
*
|
||||
* Perform an RGB[A] difference operation between the pixel sources
|
||||
* ctx->A and ctx->B.
|
||||
*
|
||||
**/
|
||||
void
|
||||
|
|
@ -1137,8 +1194,10 @@ gimp_composite_difference_any_any_any_generic (GimpCompositeContext * ctx)
|
|||
|
||||
/**
|
||||
* gimp_composite_dissolve_any_any_any_generic:
|
||||
* @ctx:
|
||||
* @ctx: The compositing context.
|
||||
*
|
||||
* Perform an RGB[A] alpha dissolve operation between the pixel
|
||||
* sources ctx->A and ctx->B.
|
||||
*
|
||||
**/
|
||||
void
|
||||
|
|
@ -1216,8 +1275,10 @@ gimp_composite_dissolve_any_any_any_generic (GimpCompositeContext * ctx)
|
|||
|
||||
/**
|
||||
* gimp_composite_replace_any_any_any_generic:
|
||||
* @ctx:
|
||||
* @ctx: The compositing context.
|
||||
*
|
||||
* Perform an RGB[A] replace operation of the pixel
|
||||
* source ctx->A with the ctx->B.
|
||||
*
|
||||
**/
|
||||
void
|
||||
|
|
@ -1230,8 +1291,9 @@ gimp_composite_replace_any_any_any_generic (GimpCompositeContext *ctx)
|
|||
|
||||
/**
|
||||
* gimp_composite_swap_any_any_any_generic:
|
||||
* @ctx:
|
||||
* @ctx: The compositing context.
|
||||
*
|
||||
* Swap the contents of ctx->A and ctx->B.
|
||||
*
|
||||
**/
|
||||
void
|
||||
|
|
@ -1255,8 +1317,10 @@ gimp_composite_swap_any_any_any_generic (GimpCompositeContext * ctx)
|
|||
|
||||
/**
|
||||
* gimp_composite_normal_any_any_any_generic:
|
||||
* @ctx:
|
||||
* @ctx: The compositing context.
|
||||
*
|
||||
* Perform an RGB[A] over operation of the pixel
|
||||
* source ctx->B on ctx->A.
|
||||
*
|
||||
**/
|
||||
void
|
||||
|
|
@ -1268,8 +1332,10 @@ gimp_composite_normal_any_any_any_generic (GimpCompositeContext * ctx)
|
|||
|
||||
/**
|
||||
* gimp_composite_erase_any_any_any_generic:
|
||||
* @ctx:
|
||||
* @ctx: The compositing context.
|
||||
*
|
||||
* Perform an RGB[A] "erase" operation of the pixel
|
||||
* source ctx->A using the alpha information in ctx->B.
|
||||
*
|
||||
**/
|
||||
void
|
||||
|
|
@ -1281,8 +1347,10 @@ gimp_composite_erase_any_any_any_generic (GimpCompositeContext *ctx)
|
|||
|
||||
/**
|
||||
* gimp_composite_anti_erase_any_any_any_generic:
|
||||
* @ctx:
|
||||
* @ctx: The compositing context.
|
||||
*
|
||||
* Perform an RGB[A] "anti-erase" operation of the pixel
|
||||
* source ctx->A using the alpha information in ctx->B.
|
||||
*
|
||||
**/
|
||||
void
|
||||
|
|
@ -1294,8 +1362,10 @@ gimp_composite_anti_erase_any_any_any_generic (GimpCompositeContext *ctx)
|
|||
|
||||
/**
|
||||
* gimp_composite_color_erase_any_any_any_generic:
|
||||
* @ctx:
|
||||
* @ctx: The compositing context.
|
||||
*
|
||||
* Perform an RGB[A] "color-erase" operation of the pixel
|
||||
* source ctx->A using the alpha information in ctx->B.
|
||||
*
|
||||
**/
|
||||
void
|
||||
|
|
@ -1310,8 +1380,10 @@ gimp_composite_color_erase_any_any_any_generic (GimpCompositeContext *ctx)
|
|||
|
||||
/**
|
||||
* gimp_composite_scale_any_any_any_generic:
|
||||
* @ctx:
|
||||
* @ctx: The compositing context.
|
||||
*
|
||||
* Perform an RGB[A] scale operation of the pixel source ctx->A using
|
||||
* the scale coefficient on the compositing context, @ctx.
|
||||
*
|
||||
**/
|
||||
void
|
||||
|
|
@ -1337,7 +1409,7 @@ gimp_composite_scale_any_any_any_generic (GimpCompositeContext * ctx)
|
|||
/**
|
||||
* gimp_composite_generic_init:
|
||||
*
|
||||
*
|
||||
* Initialise the generic set of compositing functions.
|
||||
*
|
||||
* Return value:
|
||||
**/
|
||||
|
|
|
|||
|
|
@ -253,7 +253,7 @@ gimp_composite_context_print (GimpCompositeContext *ctx)
|
|||
* Given a GimpCompositeOperatin, return a string representation of the name
|
||||
* of that operation.
|
||||
*
|
||||
* Return value:
|
||||
* Returns: gchar *, the name
|
||||
**/
|
||||
const gchar *
|
||||
gimp_composite_mode_astext (GimpCompositeOperation op)
|
||||
|
|
@ -306,7 +306,7 @@ gimp_composite_mode_astext (GimpCompositeOperation op)
|
|||
* Given a GimpPixelFormat, return a string representation of the name
|
||||
* of that format.
|
||||
*
|
||||
* Return value:
|
||||
* Returns: gchar *, the name
|
||||
**/
|
||||
const gchar *
|
||||
gimp_composite_pixelformat_astext (GimpPixelFormat format)
|
||||
|
|
@ -345,7 +345,7 @@ gimp_composite_pixelformat_astext (GimpPixelFormat format)
|
|||
* compositing operation handlers, followed by overloading those which
|
||||
* are supported by the current cpu/hardware.
|
||||
*
|
||||
* Return value: void
|
||||
* Return: void
|
||||
**/
|
||||
void
|
||||
gimp_composite_init (void)
|
||||
|
|
|
|||
|
|
@ -118,7 +118,7 @@ struct GimpCompositeOperationEffects
|
|||
|
||||
extern struct GimpCompositeOperationEffects gimp_composite_operation_effects[];
|
||||
|
||||
/*
|
||||
/**
|
||||
* This is structure for communicating all that is necessary to a
|
||||
* compositing operation.
|
||||
*/
|
||||
|
|
|
|||
Loading…
Reference in New Issue