third_party/WebKit/Source/platform/graphics/GraphicsTypes.h

/*
 * Copyright (C) 2004, 2005, 2006 Apple Computer, Inc.  All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY APPLE COMPUTER, INC. ``AS IS'' AND ANY
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE COMPUTER, INC. OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
 * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef GraphicsTypes_h
#define GraphicsTypes_h

#include "platform/PlatformExport.h"
#include "public/platform/WebBlendMode.h"
#include "third_party/skia/include/core/SkFilterQuality.h"
#include "third_party/skia/include/core/SkPaint.h"
#include "third_party/skia/include/core/SkPath.h"
#include "wtf/Forward.h"
#include "wtf/build_config.h"

namespace blink {

enum StrokeStyle {
  NoStroke,
  SolidStroke,
  DottedStroke,
  DashedStroke,
  DoubleStroke,
  WavyStroke,
};

enum InterpolationQuality {
  InterpolationNone = kNone_SkFilterQuality,
  InterpolationLow = kLow_SkFilterQuality,
  InterpolationMedium = kMedium_SkFilterQuality,
  InterpolationHigh = kHigh_SkFilterQuality,
#if USE(LOW_QUALITY_IMAGE_INTERPOLATION)
  InterpolationDefault = InterpolationLow,
#else
  InterpolationDefault = InterpolationHigh,
#endif
};

enum CompositeOperator {
  CompositeClear,
  CompositeCopy,
  CompositeSourceOver,
  CompositeSourceIn,
  CompositeSourceOut,
  CompositeSourceAtop,
  CompositeDestinationOver,
  CompositeDestinationIn,
  CompositeDestinationOut,
  CompositeDestinationAtop,
  CompositeXOR,
  CompositePlusLighter
};

enum OpacityMode {
  NonOpaque,
  Opaque,
};

enum AccelerationHint {
  PreferAcceleration,
  // The PreferAccelerationAfterVisibilityChange hint suggests we should switch
  // back to acceleration in the context of the canvas becoming visible again.
  PreferAccelerationAfterVisibilityChange,
  PreferNoAcceleration,
};

enum SnapshotReason {
  SnapshotReasonUnknown,
  SnapshotReasonGetImageData,
  SnapshotReasonCopyToWebGLTexture,
  SnapshotReasonPaint,
  SnapshotReasonToDataURL,
  SnapshotReasonToBlob,
  SnapshotReasonCanvasListenerCapture,
  SnapshotReasonDrawImage,
  SnapshotReasonCreatePattern,
  SnapshotReasonTransferToImageBitmap,
  SnapshotReasonUnitTests,
  SnapshotReasonGetCopiedImage,
  SnapshotReasonWebGLDrawImageIntoBuffer,
};

// Note: enum used directly for histogram, values must not change
enum DisableDeferralReason {
  DisableDeferralReasonUnknown =
      0,  // Should not appear in production histograms
  DisableDeferralReasonExpensiveOverdrawHeuristic = 1,
  DisableDeferralReasonUsingTextureBackedPattern = 2,
  DisableDeferralReasonDrawImageOfVideo = 3,
  DisableDeferralReasonDrawImageOfAnimated2dCanvas = 4,
  DisableDeferralReasonSubPixelTextAntiAliasingSupport = 5,
  DisableDeferralDrawImageWithTextureBackedSourceImage = 6,
  DisableDeferralReasonCount,
};

enum FlushReason {
  FlushReasonUnknown,
  FlushReasonInitialClear,
  FlushReasonDrawImageOfWebGL,
};

enum ImageInitializationMode {
  InitializeImagePixels,
  DoNotInitializeImagePixels,
};

// TODO(junov): crbug.com/453113 Relocate ShadowMode to
// CanvasRenderingContext2DState.h once GraphicsContext no longer uses it.
enum ShadowMode { DrawShadowAndForeground, DrawShadowOnly, DrawForegroundOnly };

enum AntiAliasingMode { NotAntiAliased, AntiAliased };

enum GradientSpreadMethod {
  SpreadMethodPad,
  SpreadMethodReflect,
  SpreadMethodRepeat
};

enum LineCap {
  ButtCap = SkPaint::kButt_Cap,
  RoundCap = SkPaint::kRound_Cap,
  SquareCap = SkPaint::kSquare_Cap
};

enum LineJoin {
  MiterJoin = SkPaint::kMiter_Join,
  RoundJoin = SkPaint::kRound_Join,
  BevelJoin = SkPaint::kBevel_Join
};

enum HorizontalAlignment { AlignLeft, AlignRight, AlignHCenter };

enum TextBaseline {
  AlphabeticTextBaseline,
  TopTextBaseline,
  MiddleTextBaseline,
  BottomTextBaseline,
  IdeographicTextBaseline,
  HangingTextBaseline
};

enum TextAlign {
  StartTextAlign,
  EndTextAlign,
  LeftTextAlign,
  CenterTextAlign,
  RightTextAlign
};

enum TextDrawingMode {
  TextModeFill = 1 << 0,
  TextModeStroke = 1 << 1,
};
typedef unsigned TextDrawingModeFlags;

enum ColorFilter {
  ColorFilterNone,
  ColorFilterLuminanceToAlpha,
  ColorFilterSRGBToLinearRGB,
  ColorFilterLinearRGBToSRGB
};

enum WindRule {
  RULE_NONZERO = SkPath::kWinding_FillType,
  RULE_EVENODD = SkPath::kEvenOdd_FillType
};

PLATFORM_EXPORT String compositeOperatorName(CompositeOperator, WebBlendMode);
PLATFORM_EXPORT bool parseCompositeAndBlendOperator(const String&,
                                                    CompositeOperator&,
                                                    WebBlendMode&);

PLATFORM_EXPORT String lineCapName(LineCap);
PLATFORM_EXPORT bool parseLineCap(const String&, LineCap&);

PLATFORM_EXPORT String lineJoinName(LineJoin);
PLATFORM_EXPORT bool parseLineJoin(const String&, LineJoin&);

PLATFORM_EXPORT String textAlignName(TextAlign);
PLATFORM_EXPORT bool parseTextAlign(const String&, TextAlign&);

PLATFORM_EXPORT String textBaselineName(TextBaseline);
PLATFORM_EXPORT bool parseTextBaseline(const String&, TextBaseline&);

}  // namespace blink

#endif