ce87bb23876252ce15d593641bc344b246212de8
[WebKit-https.git] / Source / WebKit / chromium / public / platform / WebExternalTextureLayer.h
1 /*
2  * Copyright (C) 2011 Google Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  *
8  * 1.  Redistributions of source code must retain the above copyright
9  *     notice, this list of conditions and the following disclaimer.
10  * 2.  Redistributions in binary form must reproduce the above copyright
11  *     notice, this list of conditions and the following disclaimer in the
12  *     documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
15  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
16  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
17  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
18  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
19  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
20  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
21  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
23  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #ifndef WebExternalTextureLayer_h
27 #define WebExternalTextureLayer_h
28
29 #include "WebCommon.h"
30 #include "WebFloatRect.h"
31 #include "WebLayer.h"
32
33 namespace WebKit {
34 class WebExternalTextureLayerImpl;
35
36 // This class represents a layer that renders a texture that is generated
37 // externally (not managed by the WebLayerTreeView).
38 // The texture will be used by the WebLayerTreeView during compositing passes.
39 // When in single-thread mode, this means during WebLayerTreeView::composite().
40 // When using the threaded compositor, this can mean at an arbitrary time until
41 // the WebLayerTreeView is destroyed.
42 class WebExternalTextureLayer : public WebLayer {
43 public:
44     WEBKIT_EXPORT static WebExternalTextureLayer create();
45
46     WebExternalTextureLayer() { }
47     WebExternalTextureLayer(const WebExternalTextureLayer& layer) : WebLayer(layer) { }
48     virtual ~WebExternalTextureLayer() { }
49     WebExternalTextureLayer& operator=(const WebExternalTextureLayer& layer)
50     {
51         WebLayer::assign(layer);
52         return *this;
53     }
54
55     // Sets the texture id that represents the layer, in the namespace of the
56     // compositor context.
57     WEBKIT_EXPORT void setTextureId(unsigned);
58     WEBKIT_EXPORT unsigned textureId() const;
59
60     // Sets whether or not the texture should be flipped in the Y direction when
61     // rendered.
62     WEBKIT_EXPORT void setFlipped(bool);
63     WEBKIT_EXPORT bool flipped() const;
64
65     // Sets the rect in UV space of the texture that is mapped to the layer
66     // bounds.
67     WEBKIT_EXPORT void setUVRect(const WebFloatRect&);
68     WEBKIT_EXPORT WebFloatRect uvRect() const;
69
70     // Marks a region of the layer as needing a display. These regions are
71     // collected in a union until the display occurs.
72     WEBKIT_EXPORT void invalidateRect(const WebFloatRect&);
73
74 #if WEBKIT_IMPLEMENTATION
75     WebExternalTextureLayer(const WTF::PassRefPtr<WebExternalTextureLayerImpl>&);
76     WebExternalTextureLayer& operator=(const WTF::PassRefPtr<WebExternalTextureLayerImpl>&);
77     operator WTF::PassRefPtr<WebExternalTextureLayerImpl>() const;
78 #endif
79 };
80
81 } // namespace WebKit
82
83 #endif // WebExternalTextureLayer_h