File: CanvasRenderingContext.h

package info (click to toggle)
chromium-browser 57.0.2987.98-1~deb8u1
  • links: PTS, VCS
  • area: main
  • in suites: jessie
  • size: 2,637,852 kB
  • ctags: 2,544,394
  • sloc: cpp: 12,815,961; ansic: 3,676,222; python: 1,147,112; asm: 526,608; java: 523,212; xml: 286,794; perl: 92,654; sh: 86,408; objc: 73,271; makefile: 27,698; cs: 18,487; yacc: 13,031; tcl: 12,957; pascal: 4,875; ml: 4,716; lex: 3,904; sql: 3,862; ruby: 1,982; lisp: 1,508; php: 1,368; exp: 404; awk: 325; csh: 117; jsp: 39; sed: 37
file content (200 lines) | stat: -rw-r--r-- 7,326 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
/*
 * Copyright (C) 2009 Apple 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 CanvasRenderingContext_h
#define CanvasRenderingContext_h

#include "core/CoreExport.h"
#include "core/html/HTMLCanvasElement.h"
#include "core/html/canvas/CanvasContextCreationAttributes.h"
#include "core/layout/HitTestCanvasResult.h"
#include "core/offscreencanvas/OffscreenCanvas.h"
#include "platform/graphics/ColorBehavior.h"
#include "third_party/skia/include/core/SkColorSpace.h"
#include "third_party/skia/include/core/SkImageInfo.h"
#include "wtf/HashSet.h"
#include "wtf/Noncopyable.h"
#include "wtf/text/StringHash.h"

class SkCanvas;

namespace blink {

class CanvasImageSource;
class HTMLCanvasElement;
class ImageData;
class ImageBitmap;
class WebLayer;

enum CanvasColorSpace {
  kLegacyCanvasColorSpace,
  kSRGBCanvasColorSpace,
  kLinearRGBCanvasColorSpace,
};

class CORE_EXPORT CanvasRenderingContext
    : public GarbageCollectedFinalized<CanvasRenderingContext>,
      public ScriptWrappable {
  WTF_MAKE_NONCOPYABLE(CanvasRenderingContext);
  USING_PRE_FINALIZER(CanvasRenderingContext, dispose);

 public:
  virtual ~CanvasRenderingContext() {}

  // A Canvas can either be "2D" or "webgl" but never both. If you request a 2D
  // canvas and the existing context is already 2D, just return that. If the
  // existing context is WebGL, then destroy it before creating a new 2D
  // context. Vice versa when requesting a WebGL canvas. Requesting a context
  // with any other type string will destroy any existing context.
  enum ContextType {
    // Do not change assigned numbers of existing items: add new features to the
    // end of the list.
    Context2d = 0,
    ContextExperimentalWebgl = 2,
    ContextWebgl = 3,
    ContextWebgl2 = 4,
    ContextImageBitmap = 5,
    ContextTypeCount,
  };

  static ContextType contextTypeFromId(const String& id);
  static ContextType resolveContextTypeAliases(ContextType);

  HTMLCanvasElement* canvas() const { return m_canvas; }

  CanvasColorSpace colorSpace() const { return m_colorSpace; };
  WTF::String colorSpaceAsString() const;
  sk_sp<SkColorSpace> skColorSpace() const;
  SkColorType colorType() const;
  ColorBehavior colorBehaviorForMediaDrawnToCanvas() const;

  virtual PassRefPtr<Image> getImage(AccelerationHint,
                                     SnapshotReason) const = 0;
  virtual ImageData* toImageData(SnapshotReason reason) { return nullptr; }
  virtual ContextType getContextType() const = 0;
  virtual bool isAccelerated() const { return false; }
  virtual bool shouldAntialias() const { return false; }
  virtual void setIsHidden(bool) = 0;
  virtual bool isContextLost() const { return true; }
  virtual void setCanvasGetContextResult(RenderingContext&) { NOTREACHED(); };
  virtual void setOffscreenCanvasGetContextResult(OffscreenRenderingContext&) {
    NOTREACHED();
  }
  virtual bool isPaintable() const = 0;

  // Return true if the content is updated.
  virtual bool paintRenderingResultsToCanvas(SourceDrawingBuffer) {
    return false;
  }

  virtual WebLayer* platformLayer() const { return nullptr; }

  enum LostContextMode {
    NotLostContext,

    // Lost context occurred at the graphics system level.
    RealLostContext,

    // Lost context provoked by WEBGL_lose_context.
    WebGLLoseContextLostContext,

    // Lost context occurred due to internal implementation reasons.
    SyntheticLostContext,
  };
  virtual void loseContext(LostContextMode) {}

  // Canvas2D-specific interface
  virtual bool is2d() const { return false; }
  virtual void restoreCanvasMatrixClipStack(SkCanvas*) const {}
  virtual void reset() {}
  virtual void clearRect(double x, double y, double width, double height) {}
  virtual void didSetSurfaceSize() {}
  virtual void setShouldAntialias(bool) {}
  virtual unsigned hitRegionsCount() const { return 0; }
  virtual void setFont(const String&) {}
  virtual void styleDidChange(const ComputedStyle* oldStyle,
                              const ComputedStyle& newStyle) {}
  virtual HitTestCanvasResult* getControlAndIdIfHitRegionExists(
      const LayoutPoint& location) {
    NOTREACHED();
    return HitTestCanvasResult::create(String(), nullptr);
  }
  virtual String getIdFromControl(const Element* element) { return String(); }
  virtual bool isAccelerationOptimalForCanvasContent() const { return true; }
  virtual void resetUsageTracking(){};
  virtual void incrementFrameCount(){};

  // WebGL-specific interface
  virtual bool is3d() const { return false; }
  virtual void setFilterQuality(SkFilterQuality) { NOTREACHED(); }
  virtual void reshape(int width, int height) { NOTREACHED(); }
  virtual void markLayerComposited() { NOTREACHED(); }
  virtual ImageData* paintRenderingResultsToImageData(SourceDrawingBuffer) {
    NOTREACHED();
    return nullptr;
  }
  virtual int externallyAllocatedBytesPerPixel() {
    NOTREACHED();
    return 0;
  }

  // ImageBitmap-specific interface
  virtual bool paint(GraphicsContext&, const IntRect&) { return false; }

  // OffscreenCanvas-specific methods
  OffscreenCanvas* offscreenCanvas() const { return m_offscreenCanvas; }
  virtual ImageBitmap* transferToImageBitmap(ScriptState*) { return nullptr; }

  bool wouldTaintOrigin(CanvasImageSource*, SecurityOrigin* = nullptr);
  void didMoveToNewDocument(Document*);

  void detachCanvas() { m_canvas = nullptr; }
  void detachOffscreenCanvas() { m_offscreenCanvas = nullptr; }

  const CanvasContextCreationAttributes& creationAttributes() const {
    return m_creationAttributes;
  }

 protected:
  CanvasRenderingContext(HTMLCanvasElement*,
                         OffscreenCanvas*,
                         const CanvasContextCreationAttributes&);
  DECLARE_VIRTUAL_TRACE();
  virtual void stop() = 0;

 private:
  void dispose();

  Member<HTMLCanvasElement> m_canvas;
  Member<OffscreenCanvas> m_offscreenCanvas;
  HashSet<String> m_cleanURLs;
  HashSet<String> m_dirtyURLs;
  CanvasColorSpace m_colorSpace;
  CanvasContextCreationAttributes m_creationAttributes;
};

}  // namespace blink

#endif