xref: /aoo4110/main/offapi/com/sun/star/rendering/RenderingIntent.idl (revision b1cdbd2c)

/**************************************************************
 *
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 *
 *************************************************************/


#ifndef __com_sun_star_rendering_RenderingIntent_idl__
#define __com_sun_star_rendering_RenderingIntent_idl__

module com { module sun { module star { module rendering {

/** The rendering intent for a color space.<p>

    The rendering intent for a color space mostly determines how
    out-of-gamut color is treated. See <a
    href="http://en.wikipedia.org/wiki/Rendering_intent">Wikipedia</a>
    for a thorough explanation.

    @since OpenOffice 2.0
 */
constants RenderingIntent
{
    /** Also known as the image intent, this rendering intent
        aims to preserve the visual relationship between
        colors in a way that is perceived as natural to the
        human eye, although the color values themselves may
        change. This intent is most suitable for photographic
        images.
    */
    const byte PERCEPTUAL=0;

	//-------------------------------------------------------------------------

    /** The rendering intent for business graphics that
        maintains vivid color at the expense of accurate
        color. It scales the source gamut to the destination
        gamut but preserves relative saturation instead of
        hue, so when scaling to a smaller gamut, hues may
        shift. This rendering intent is primarily designed for
        business graphics, where bright saturated colors are
        more important than the exact relationship between
        colors (such as in a photographic image).
    */
    const byte SATURATION=1;

    /** The rendering intent almost identical to Absolute
        Colorimetric except for the following difference:
        Relative Colorimetric compares the white point
        (extreme highlight) of the source color space to that
        of the destination color space and shifts all colors
        accordingly.
    */
    const byte RELATIVE_COLORIMETRIC=2;

    /** The rendering intent that leaves colors that fall
        inside the destination gamut unchanged. Out of gamut
        colors are clipped. No scaling of colors to
        destination white point is performed. This intent aims
        to maintain color accuracy at the expense of
        preserving relationships between colors, and is useful
        for seeing how output will look on a non-neutral
        substrate.
    */
    const byte ABSOLUTE_COLORIMETRIC=3;
};

}; }; }; };

#endif