2 * Copyright (C) 2010 Google Inc. All rights reserved.
3 * Copyright (C) 2009 Apple Inc. All rights reserved.
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions are
9 * * Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 * * Redistributions in binary form must reproduce the above
12 * copyright notice, this list of conditions and the following disclaimer
13 * in the documentation and/or other materials provided with the
15 * * Neither the name of Google Inc. nor the names of its
16 * contributors may be used to endorse or promote products derived from
17 * this software without specific prior written permission.
19 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
22 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
23 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
24 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
25 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
26 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
27 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
28 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
29 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
34 * This file borrows code heavily from platform/graphics/win/GraphicsLayerCACF.cpp
35 * (and hence it includes both copyrights)
36 * Ideally the common code (mostly the code that keeps track of the layer hierarchy)
37 * should be kept separate and shared between platforms. It would be a well worthwhile
38 * effort once the Windows implementation (binaries and headers) of CoreAnimation is
39 * checked in to the WebKit repository. Until then only Apple can make this happen.
44 #if USE(ACCELERATED_COMPOSITING)
46 #include "GraphicsLayerChromium.h"
48 #include "Canvas2DLayerChromium.h"
49 #include "ContentLayerChromium.h"
50 #include "DrawingBuffer.h"
51 #include "FloatConversion.h"
52 #include "FloatRect.h"
54 #include "ImageLayerChromium.h"
55 #include "LayerChromium.h"
56 #include "PlatformString.h"
57 #include "SystemTime.h"
59 #include <wtf/CurrentTime.h>
60 #include <wtf/StringExtras.h>
61 #include <wtf/text/CString.h>
67 static void setLayerBorderColor(LayerChromium& layer, const Color& color)
69 layer.setBorderColor(color);
72 static void clearBorderColor(LayerChromium& layer)
74 layer.setBorderColor(static_cast<RGBA32>(0));
77 static void setLayerBackgroundColor(LayerChromium& layer, const Color& color)
79 layer.setBackgroundColor(color);
82 static void clearLayerBackgroundColor(LayerChromium& layer)
84 layer.setBackgroundColor(static_cast<RGBA32>(0));
87 PassOwnPtr<GraphicsLayer> GraphicsLayer::create(GraphicsLayerClient* client)
89 return new GraphicsLayerChromium(client);
92 GraphicsLayerChromium::GraphicsLayerChromium(GraphicsLayerClient* client)
93 : GraphicsLayer(client)
94 , m_contentsLayerPurpose(NoContentsLayer)
95 , m_contentsLayerHasBackgroundColor(false)
97 m_layer = ContentLayerChromium::create(this);
99 updateDebugIndicators();
102 GraphicsLayerChromium::~GraphicsLayerChromium()
105 m_layer->setOwner(0);
107 m_contentsLayer->setOwner(0);
108 if (m_transformLayer)
109 m_transformLayer->setOwner(0);
112 void GraphicsLayerChromium::setName(const String& inName)
114 String name = String::format("GraphicsLayerChromium(%p) GraphicsLayer(%p) ", m_layer.get(), this) + inName;
115 GraphicsLayer::setName(name);
118 bool GraphicsLayerChromium::setChildren(const Vector<GraphicsLayer*>& children)
120 bool childrenChanged = GraphicsLayer::setChildren(children);
121 // FIXME: GraphicsLayer::setChildren calls addChild() for each sublayer, which
122 // will end up calling updateSublayerList() N times.
124 updateSublayerList();
126 return childrenChanged;
129 void GraphicsLayerChromium::addChild(GraphicsLayer* childLayer)
131 GraphicsLayer::addChild(childLayer);
132 updateSublayerList();
135 void GraphicsLayerChromium::addChildAtIndex(GraphicsLayer* childLayer, int index)
137 GraphicsLayer::addChildAtIndex(childLayer, index);
138 updateSublayerList();
141 void GraphicsLayerChromium::addChildBelow(GraphicsLayer* childLayer, GraphicsLayer* sibling)
143 GraphicsLayer::addChildBelow(childLayer, sibling);
144 updateSublayerList();
147 void GraphicsLayerChromium::addChildAbove(GraphicsLayer* childLayer, GraphicsLayer *sibling)
149 GraphicsLayer::addChildAbove(childLayer, sibling);
150 updateSublayerList();
153 bool GraphicsLayerChromium::replaceChild(GraphicsLayer* oldChild, GraphicsLayer* newChild)
155 if (GraphicsLayer::replaceChild(oldChild, newChild)) {
156 updateSublayerList();
162 void GraphicsLayerChromium::removeFromParent()
164 GraphicsLayer::removeFromParent();
165 layerForSuperlayer()->removeFromSuperlayer();
168 void GraphicsLayerChromium::setPosition(const FloatPoint& point)
170 GraphicsLayer::setPosition(point);
171 updateLayerPosition();
174 void GraphicsLayerChromium::setAnchorPoint(const FloatPoint3D& point)
176 if (point == m_anchorPoint)
179 GraphicsLayer::setAnchorPoint(point);
183 void GraphicsLayerChromium::setSize(const FloatSize& size)
188 GraphicsLayer::setSize(size);
192 void GraphicsLayerChromium::setTransform(const TransformationMatrix& transform)
194 if (transform == m_transform)
197 GraphicsLayer::setTransform(transform);
201 void GraphicsLayerChromium::setChildrenTransform(const TransformationMatrix& transform)
203 if (transform == m_childrenTransform)
206 GraphicsLayer::setChildrenTransform(transform);
207 updateChildrenTransform();
210 void GraphicsLayerChromium::setPreserves3D(bool preserves3D)
212 if (preserves3D == m_preserves3D)
215 GraphicsLayer::setPreserves3D(preserves3D);
216 updateLayerPreserves3D();
219 void GraphicsLayerChromium::setMasksToBounds(bool masksToBounds)
221 if (masksToBounds == m_masksToBounds)
224 GraphicsLayer::setMasksToBounds(masksToBounds);
225 updateMasksToBounds();
228 void GraphicsLayerChromium::setDrawsContent(bool drawsContent)
230 if (drawsContent == m_drawsContent)
233 GraphicsLayer::setDrawsContent(drawsContent);
234 updateLayerDrawsContent();
237 void GraphicsLayerChromium::setBackgroundColor(const Color& color)
239 if (m_backgroundColorSet && m_backgroundColor == color)
242 GraphicsLayer::setBackgroundColor(color);
244 m_contentsLayerHasBackgroundColor = true;
245 updateLayerBackgroundColor();
248 void GraphicsLayerChromium::clearBackgroundColor()
250 if (!m_backgroundColorSet)
253 GraphicsLayer::clearBackgroundColor();
254 clearLayerBackgroundColor(*m_contentsLayer);
257 void GraphicsLayerChromium::setContentsOpaque(bool opaque)
259 if (m_contentsOpaque == opaque)
262 GraphicsLayer::setContentsOpaque(opaque);
263 updateContentsOpaque();
266 void GraphicsLayerChromium::setMaskLayer(GraphicsLayer* maskLayer)
268 if (maskLayer == m_maskLayer)
271 GraphicsLayer::setMaskLayer(maskLayer);
273 LayerChromium* maskLayerChromium = m_maskLayer ? m_maskLayer->platformLayer() : 0;
274 m_layer->setMaskLayer(maskLayerChromium);
277 void GraphicsLayerChromium::setBackfaceVisibility(bool visible)
279 if (m_backfaceVisibility == visible)
282 GraphicsLayer::setBackfaceVisibility(visible);
283 updateBackfaceVisibility();
286 void GraphicsLayerChromium::setOpacity(float opacity)
288 float clampedOpacity = max(min(opacity, 1.0f), 0.0f);
290 if (m_opacity == clampedOpacity)
293 GraphicsLayer::setOpacity(clampedOpacity);
294 primaryLayer()->setOpacity(opacity);
297 void GraphicsLayerChromium::setReplicatedByLayer(GraphicsLayer* layer)
299 GraphicsLayerChromium* layerChromium = static_cast<GraphicsLayerChromium*>(layer);
300 GraphicsLayer::setReplicatedByLayer(layer);
301 LayerChromium* replicaLayer = layerChromium ? layerChromium->primaryLayer() : 0;
302 primaryLayer()->setReplicaLayer(replicaLayer);
306 void GraphicsLayerChromium::setContentsNeedsDisplay()
309 m_contentsLayer->setNeedsDisplay();
312 void GraphicsLayerChromium::setNeedsDisplay()
315 m_layer->setNeedsDisplay();
318 void GraphicsLayerChromium::setNeedsDisplayInRect(const FloatRect& rect)
321 m_layer->setNeedsDisplay(rect);
324 void GraphicsLayerChromium::setContentsRect(const IntRect& rect)
326 if (rect == m_contentsRect)
329 GraphicsLayer::setContentsRect(rect);
330 updateContentsRect();
333 void GraphicsLayerChromium::setContentsToImage(Image* image)
335 bool childrenChanged = false;
337 if (!m_contentsLayer.get() || m_contentsLayerPurpose != ContentsLayerForImage) {
338 RefPtr<ImageLayerChromium> imageLayer = ImageLayerChromium::create(this);
339 setupContentsLayer(imageLayer.get());
340 m_contentsLayer = imageLayer;
341 m_contentsLayerPurpose = ContentsLayerForImage;
342 childrenChanged = true;
344 ImageLayerChromium* imageLayer = static_cast<ImageLayerChromium*>(m_contentsLayer.get());
345 imageLayer->setContents(image);
346 updateContentsRect();
348 if (m_contentsLayer) {
349 childrenChanged = true;
351 // The old contents layer will be removed via updateSublayerList.
357 updateSublayerList();
360 void GraphicsLayerChromium::setContentsToCanvas(PlatformLayer* platformLayer)
362 bool childrenChanged = false;
364 platformLayer->setOwner(this);
365 if (m_contentsLayer.get() != platformLayer) {
366 setupContentsLayer(platformLayer);
367 m_contentsLayer = platformLayer;
368 m_contentsLayerPurpose = ContentsLayerForCanvas;
369 childrenChanged = true;
371 m_contentsLayer->setNeedsDisplay();
372 updateContentsRect();
374 if (m_contentsLayer) {
375 childrenChanged = true;
377 // The old contents layer will be removed via updateSublayerList.
383 updateSublayerList();
386 void GraphicsLayerChromium::setContentsToMedia(PlatformLayer* layer)
388 bool childrenChanged = false;
390 if (!m_contentsLayer.get() || m_contentsLayerPurpose != ContentsLayerForVideo) {
391 setupContentsLayer(layer);
392 m_contentsLayer = layer;
393 m_contentsLayerPurpose = ContentsLayerForVideo;
394 childrenChanged = true;
396 layer->setOwner(this);
397 layer->setNeedsDisplay();
398 updateContentsRect();
400 if (m_contentsLayer) {
401 childrenChanged = true;
403 // The old contents layer will be removed via updateSublayerList.
409 updateSublayerList();
412 PlatformLayer* GraphicsLayerChromium::hostLayerForSublayers() const
414 return m_transformLayer ? m_transformLayer.get() : m_layer.get();
417 PlatformLayer* GraphicsLayerChromium::layerForSuperlayer() const
419 return m_transformLayer ? m_transformLayer.get() : m_layer.get();
422 PlatformLayer* GraphicsLayerChromium::platformLayer() const
424 return primaryLayer();
427 void GraphicsLayerChromium::setDebugBackgroundColor(const Color& color)
430 setLayerBackgroundColor(*m_layer, color);
432 clearLayerBackgroundColor(*m_layer);
435 void GraphicsLayerChromium::setDebugBorder(const Color& color, float borderWidth)
437 if (color.isValid()) {
438 setLayerBorderColor(*m_layer, color);
439 m_layer->setBorderWidth(borderWidth);
441 clearBorderColor(*m_layer);
442 m_layer->setBorderWidth(0);
446 void GraphicsLayerChromium::updateSublayerList()
448 Vector<RefPtr<LayerChromium> > newSublayers;
450 if (m_transformLayer) {
451 // Add the primary layer first. Even if we have negative z-order children, the primary layer always comes behind.
452 newSublayers.append(m_layer.get());
453 } else if (m_contentsLayer) {
454 // FIXME: add the contents layer in the correct order with negative z-order children.
455 // This does not cause visible rendering issues because currently contents layers are only used
456 // for replaced elements that don't have children.
457 newSublayers.append(m_contentsLayer.get());
460 const Vector<GraphicsLayer*>& childLayers = children();
461 size_t numChildren = childLayers.size();
462 for (size_t i = 0; i < numChildren; ++i) {
463 GraphicsLayerChromium* curChild = static_cast<GraphicsLayerChromium*>(childLayers[i]);
465 LayerChromium* childLayer = curChild->layerForSuperlayer();
466 newSublayers.append(childLayer);
469 for (size_t i = 0; i < newSublayers.size(); ++i)
470 newSublayers[i]->removeFromSuperlayer();
472 if (m_transformLayer) {
473 m_transformLayer->setSublayers(newSublayers);
475 if (m_contentsLayer) {
476 // If we have a transform layer, then the contents layer is parented in the
477 // primary layer (which is itself a child of the transform layer).
478 m_layer->removeAllSublayers();
479 m_layer->addSublayer(m_contentsLayer);
482 m_layer->setSublayers(newSublayers);
485 void GraphicsLayerChromium::updateLayerPosition()
487 // Position is offset on the layer by the layer anchor point.
488 FloatPoint layerPosition(m_position.x() + m_anchorPoint.x() * m_size.width(),
489 m_position.y() + m_anchorPoint.y() * m_size.height());
491 primaryLayer()->setPosition(layerPosition);
494 void GraphicsLayerChromium::updateLayerSize()
496 IntSize layerSize(m_size.width(), m_size.height());
497 if (m_transformLayer) {
498 m_transformLayer->setBounds(layerSize);
499 // The anchor of the contents layer is always at 0.5, 0.5, so the position is center-relative.
500 FloatPoint centerPoint(m_size.width() / 2, m_size.height() / 2);
501 m_layer->setPosition(centerPoint);
504 m_layer->setBounds(layerSize);
506 // Note that we don't resize m_contentsLayer. It's up the caller to do that.
508 // If we've changed the bounds, we need to recalculate the position
509 // of the layer, taking anchor point into account.
510 updateLayerPosition();
513 void GraphicsLayerChromium::updateAnchorPoint()
515 primaryLayer()->setAnchorPoint(FloatPoint(m_anchorPoint.x(), m_anchorPoint.y()));
516 primaryLayer()->setAnchorPointZ(m_anchorPoint.z());
518 updateLayerPosition();
521 void GraphicsLayerChromium::updateTransform()
523 primaryLayer()->setTransform(m_transform);
526 void GraphicsLayerChromium::updateChildrenTransform()
528 primaryLayer()->setSublayerTransform(m_childrenTransform);
531 void GraphicsLayerChromium::updateMasksToBounds()
533 m_layer->setMasksToBounds(m_masksToBounds);
534 updateDebugIndicators();
537 void GraphicsLayerChromium::updateContentsOpaque()
539 m_layer->setOpaque(m_contentsOpaque);
542 void GraphicsLayerChromium::updateBackfaceVisibility()
544 m_layer->setDoubleSided(m_backfaceVisibility);
547 void GraphicsLayerChromium::updateLayerPreserves3D()
549 if (m_preserves3D && !m_transformLayer) {
550 // Create the transform layer.
551 m_transformLayer = LayerChromium::create(this);
553 // Copy the position from this layer.
554 updateLayerPosition();
558 updateChildrenTransform();
560 m_layer->setPosition(FloatPoint(m_size.width() / 2.0f, m_size.height() / 2.0f));
562 m_layer->setAnchorPoint(FloatPoint(0.5f, 0.5f));
563 TransformationMatrix identity;
564 m_layer->setTransform(identity);
566 // Set the old layer to opacity of 1. Further down we will set the opacity on the transform layer.
567 m_layer->setOpacity(1);
569 // Move this layer to be a child of the transform layer.
570 if (m_layer->superlayer())
571 m_layer->superlayer()->replaceSublayer(m_layer.get(), m_transformLayer.get());
572 m_transformLayer->addSublayer(m_layer.get());
574 updateSublayerList();
575 } else if (!m_preserves3D && m_transformLayer) {
576 // Relace the transformLayer in the parent with this layer.
577 m_layer->removeFromSuperlayer();
578 m_transformLayer->superlayer()->replaceSublayer(m_transformLayer.get(), m_layer.get());
580 // Release the transform layer.
581 m_transformLayer = 0;
583 updateLayerPosition();
587 updateChildrenTransform();
589 updateSublayerList();
592 updateOpacityOnLayer();
595 void GraphicsLayerChromium::updateLayerDrawsContent()
598 m_layer->setNeedsDisplay();
600 updateDebugIndicators();
603 void GraphicsLayerChromium::updateLayerBackgroundColor()
605 if (!m_contentsLayer)
608 // We never create the contents layer just for background color yet.
609 if (m_backgroundColorSet)
610 setLayerBackgroundColor(*m_contentsLayer, m_backgroundColor);
612 clearLayerBackgroundColor(*m_contentsLayer);
615 void GraphicsLayerChromium::updateContentsVideo()
620 void GraphicsLayerChromium::updateContentsRect()
622 if (!m_contentsLayer)
625 m_contentsLayer->setPosition(FloatPoint(m_contentsRect.x(), m_contentsRect.y()));
626 m_contentsLayer->setBounds(IntSize(m_contentsRect.width(), m_contentsRect.height()));
629 void GraphicsLayerChromium::setupContentsLayer(LayerChromium* contentsLayer)
631 if (contentsLayer == m_contentsLayer)
634 if (m_contentsLayer) {
635 m_contentsLayer->removeFromSuperlayer();
640 m_contentsLayer = contentsLayer;
642 m_contentsLayer->setAnchorPoint(FloatPoint(0, 0));
644 // Insert the content layer first. Video elements require this, because they have
645 // shadow content that must display in front of the video.
646 m_layer->insertSublayer(m_contentsLayer.get(), 0);
648 updateContentsRect();
650 if (showDebugBorders()) {
651 setLayerBorderColor(*m_contentsLayer, Color(0, 0, 128, 180));
652 m_contentsLayer->setBorderWidth(1);
655 updateDebugIndicators();
658 // This function simply mimics the operation of GraphicsLayerCA
659 void GraphicsLayerChromium::updateOpacityOnLayer()
661 primaryLayer()->setOpacity(m_opacity);
664 } // namespace WebCore
666 #endif // USE(ACCELERATED_COMPOSITING)