inc/FGrpCanvasCommon.h

   1 //
   2 // Open Service Platform
   3 // Copyright (c) 2012-2013 Samsung Electronics Co., Ltd.
   4 //
   5 // Licensed under the Apache License, Version 2.0 (the License);
   6 // you may not use this file except in compliance with the License.
   7 // You may obtain a copy of the License at
   8 //
   9 //     http://www.apache.org/licenses/LICENSE-2.0/
  10 //
  11 // Unless required by applicable law or agreed to in writing, software
  12 // distributed under the License is distributed on an "AS IS" BASIS,
  13 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14 // See the License for the specific language governing permissions and
  15 // limitations under the License.
  16 //
  17
  18 /**
  19  * @file        FGrpCanvasCommon.h
  20  * @brief       This is the header file for the enumerations of the Canvas class.
  21  *
  22  * This header file contains the definitions of the enumerations of the Canvas class.
  23  */
  24
  25 #ifndef _FGRP_CANVAS_COMMON_H_
  26 #define _FGRP_CANVAS_COMMON_H_
  27
  28 namespace Tizen { namespace Graphics
  29 {
  30 /**
  31  * @enum        LineStyle
  32  *
  33  * Defines the line style.
  34  *
  35  * @since       2.0
  36  */
  37 enum LineStyle
  38 {
  39         LINE_STYLE_SOLID = 1, /**< The solid line style */
  40         LINE_STYLE_MAX, // This enum value is for internal use only. Using this enum value can cause behavioral, security-related, and consistency-related issues in the application.
  41         LINE_STYLE_MIN = 0 // This enum value is for internal use only. Using this enum value can cause behavioral, security-related, and consistency-related issues in the application.
  42 };
  43
  44 /**
  45  * @enum        ArcStyle
  46  *
  47  * Defines the arc style.
  48  *
  49  * @since       2.0
  50  */
  51 enum ArcStyle
  52 {
  53         ARC_STYLE_ONLY = 1, /**< An arc line is drawn */
  54         ARC_STYLE_PIE, /**< A pie (arc and chords) is drawn */
  55         ARC_STYLE_CHORD, /**< A chord is drawn */
  56         ARC_STYLE_FILLED_PIE, /**< A filled pie is drawn */
  57         ARC_STYLE_FILLED_CHORD, /**< A filled chord is drawn */
  58         ARC_STYLE_MAX, // This enum value is for internal use only. Using this enum value can cause behavioral, security-related, and consistency-related issues in the application.
  59         ARC_STYLE_MIN = 0 // This enum value is for internal use only. Using this enum value can cause behavioral, security-related, and consistency-related issues in the application.
  60 };
  61
  62 /**
  63  * @enum        FlipDirection
  64  *
  65  * Defines the flip direction.
  66  *
  67  * @since       2.0
  68  */
  69 enum FlipDirection
  70 {
  71         FLIP_DIRECTION_HORIZONTAL = 1, /**< The horizontal type */
  72         FLIP_DIRECTION_VERTICAL, /**< The vertical type */
  73         FLIP_DIRECTION_MAX, // This enum value is for internal use only. Using this enum value can cause behavioral, security-related, and consistency-related issues in the application.
  74         FLIP_DIRECTION_MIN = 0 // This enum value is for internal use only. Using this enum value can cause behavioral, security-related, and consistency-related issues in the application.
  75 };
  76
  77 /**
  78  * @enum                LineCapStyle
  79  *
  80  * Defines the line cap style.
  81  *
  82  * @since       2.1
  83  */
  84 enum LineCapStyle
  85 {
  86         LINE_CAP_STYLE_ROUND, /**< A rounded end */
  87         LINE_CAP_STYLE_BUTT, /**< A flat end */
  88         LINE_CAP_STYLE_SQUARE /**< A square end */
  89 };
  90
  91 /**
  92  * @enum                LineJoinStyle
  93  *
  94  * Defines the line join style.
  95  *
  96  * @since       2.1
  97  */
  98 enum LineJoinStyle
  99 {
 100         LINE_JOIN_STYLE_ROUND, /**< A rounded corner */
 101         LINE_JOIN_STYLE_MITER, /**< A sharp corner */
 102         LINE_JOIN_STYLE_BEVEL /**< A beveled corner */
 103 };
 104
 105 /**
 106 * @enum        CompositeMode
 107 *
 108 * Defines the composite mode.
 109 *
 110 * @since         2.1
 111 *
 112 * @remarks       The area affected by Canvas::CompositeMode can be either bounded or unbounded.
 113 *                In some cases, the area in which composition is performed can be bounded by the source region, or unbounded and the composition affects all of the Canvas pixels.
 114 */
 115 enum CompositeMode
 116 {
 117            COMPOSITE_MODE_CLEAR, /**< Clearing destination that is bounded */
 118            COMPOSITE_MODE_SRC, /**< Replacing source that is bounded */
 119            COMPOSITE_MODE_DST, /**< Ignoring the destination */
 120            COMPOSITE_MODE_SRC_OVER, /**< Drawing source on top of a destination */
 121            COMPOSITE_MODE_DST_OVER, /**< Drawing destination on top of a source */
 122            COMPOSITE_MODE_SRC_IN, /**< Drawing source only on the area that is overlapped by source and destination and it is unbounded */
 123            COMPOSITE_MODE_DST_IN, /**< Drawing destination only on the area that is overlapped by source and destination and it is unbounded */
 124            COMPOSITE_MODE_SRC_OUT, /**< Drawing source only on the area that is not overlapped by source and destination and it is unbounded */
 125            COMPOSITE_MODE_DST_OUT, /**< Drawing destination only on the area that is not overlapped by source and destination */
 126            COMPOSITE_MODE_SRC_ATOP, /**< Replacing source only on the area that is overlapped by source and destination */
 127            COMPOSITE_MODE_DST_ATOP, /**< Replacing destination only on the area that is overlapped by source and destination and it is unbounded */
 128            COMPOSITE_MODE_DST_XOR, /**< Drawing source and destination on the area that is other than the area overlapped by source and destination */
 129            COMPOSITE_MODE_ADD, /**< Adding source and destination */
 130            COMPOSITE_MODE_SATURATE, /**< Compositing like @c COMPOSITE_MODE_SRC_OVER as long as source and destination are disjoint geometries */
 131            COMPOSITE_MODE_MULTIPLY, /**< Multiplying source and destination */
 132            COMPOSITE_MODE_SCREEN, /**< Complementing and multiplying source and destination */
 133            COMPOSITE_MODE_OVERLAY, /**< Multiplying and screening destination based on the area that is overlapped by source and destination and destination color */
 134            COMPOSITE_MODE_DARKEN, /**< Darkening the destination based on the area that is overlapped by source and destination and destination color */
 135            COMPOSITE_MODE_LIGHTEN /**< Lightening destination based on the area that is overlapped by source and destination and destination color */
 136 };
 137
 138 } } // Tizen::Graphics
 139
 140 #endif // _FGRP_CANVAS_COMMON_H_