offapi/com/sun/star/rendering/CompositeOperation.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: CompositeOperation.idl,v $
  10  * $Revision: 1.5 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_rendering_CompositeOperation_idl__
  31 #define __com_sun_star_rendering_CompositeOperation_idl__
  32
  33 module com { module sun { module star { module rendering {
  34
  35 /** These constants determine how the primitive color is combined with
  36     the background.<p>
  37
  38     When performing this calculations, it is assumed that all color
  39     values are premultiplied with the corresponding alpha values (if
  40     no alpha is specified, 1.0 is assumed). Then, the following
  41     general compositing operation is performed:
  42     <p>
  43     C = Ca * Fa + Cb * Fb
  44     <p>
  45     where C is the result color, Ca and Cb are the input colors,
  46     premultiplied with alpha, and Fa and Fb are described for the
  47     different composite modes (wherein Aa and Ab denote source and
  48     destination alpha, respectively).<p>
  49
  50     @since OOo 2.0.0
  51  */
  52 constants CompositeOperation
  53 {
  54     /** Clear the destination.<p>
  55
  56         Clear the destination area. The function values are: Fa = Fb =
  57         0.<p>
  58      */
  59     const byte CLEAR = 0;
  60
  61     /** Copy source as-is to the destination.<p>
  62
  63         Copy source as-is to the destination. The function values are:
  64         Fa = 1, Fb = 0.<p>
  65      */
  66     const byte SOURCE = 1;
  67
  68     /** Leave the destination as-is.<p>
  69
  70         Leave the destination as-is. The function values are: Fa = 0,
  71         Fb = 1.<p>
  72      */
  73     const byte DESTINATION = 2;
  74
  75     /** Copy the source over the destination.<p>
  76
  77         Copy the source over the destination. The function values are:
  78         Fa = 1, Fb = 1-Aa.<p>
  79      */
  80     const byte OVER = 3;
  81
  82     /** Copy the source under the destination.<p>
  83
  84         Copy the source under the destination. The function values
  85         are: Fa = 1-Ab, Fb = 1.<p>
  86      */
  87     const byte UNDER = 4;
  88
  89     /** Copy the source to the destination.<p>
  90
  91         Copy the source to the destination, but limited to where the
  92         destination is. The function values are: Fa = Ab, Fb = 0.<p>
  93      */
  94     const byte INSIDE = 5;
  95
  96     /** Leave the destination as is.<p>
  97
  98         Leave the destination as is, but only where the source
  99         was. The function values are: Fa = 0, Fb = Aa.<p>
 100      */
 101     const byte INSIDE_REVERSE = 6;
 102
 103     /** Copy the source to the destination<p>
 104
 105         Copy the source to the destination, but limited to where the
 106         destination is not. The function values are: Fa = 1-Ab, Fb =
 107         0.<p>
 108      */
 109     const byte OUTSIDE = 7;
 110
 111     /** Leave the destination as is.<p>
 112
 113         Leave the destination as is, but only where the source has not
 114         been. The function values are: Fa = 0, Fb = 1-Aa.<p>
 115      */
 116     const byte OUTSIDE_REVERSE = 8;
 117
 118     /** Copy the source over the destination<p>
 119
 120         Copy the source over the destination, but only where the
 121         destination is. Keep the destination. The function values are:
 122         Fa = Ab, Fb = 1-Aa.<p>
 123      */
 124     const byte ATOP = 9;
 125
 126     /** Copy the destination over the source.<p>
 127
 128         Copy the destination over the source, but only where the
 129         source is. Keep the source. The function values are: Fa =
 130         1-Ab, Fb = Aa.<p>
 131      */
 132     const byte ATOP_REVERSE = 10;
 133
 134     /** Combine source and destination by exclusive or.<p>
 135
 136         Take only the parts where either source or destination, but
 137         not both visible. The function values are: Fa = 1-Ab, Fb =
 138         1-Aa.<p>
 139      */
 140     const byte XOR = 11;
 141
 142     /** Add source and destination values.<p>
 143
 144         Simply add contributions of both source and destination. The
 145         resulting color values are limited to the permissible color
 146         range, and clipped to the maximal value, if exceeded. The
 147         function values are: Fa = 1, Fb = 1.<p>
 148     */
 149     const byte ADD = 12;
 150
 151     /** Saturate source and destination.<p>
 152
 153         Saturate destination with source values. The function values
 154         are: Fa = min(1,(1-Ab)/Aa), Fb = 1<p>
 155      */
 156     const byte SATURATE = 13;
 157 };
 158
 159 }; }; }; };
 160
 161 #endif