b19c05f3e3b098d8eb03ee561279646b9081f454
[WebKit-https.git] / Source / Platform / chromium / public / 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 WebCore {
34 class TextureLayerChromium;
35 }
36
37 namespace WebKit {
38
39 class WebExternalTextureLayerClient;
40
41 // This class represents a layer that renders a texture that is generated
42 // externally (not managed by the WebLayerTreeView).
43 // The texture will be used by the WebLayerTreeView during compositing passes.
44 // When in single-thread mode, this means during WebLayerTreeView::composite().
45 // When using the threaded compositor, this can mean at an arbitrary time until
46 // the WebLayerTreeView is destroyed.
47 class WebExternalTextureLayer : public WebLayer {
48 public:
49     // The owner of this layer may optionally provide a client. This client will
50     // be called whenever the compositor wishes to produce a new frame and can
51     // provide a new front buffer texture ID. This is useful if the client wants to
52     // implement a double-buffering scheme that is synchronized with the compositor, for instance.
53     WEBKIT_EXPORT static WebExternalTextureLayer create(WebExternalTextureLayerClient* = 0);
54
55     // Indicates that the client for this layer is going away and shouldn't be used.
56     WEBKIT_EXPORT void clearClient();
57
58     WebExternalTextureLayer() { }
59     virtual ~WebExternalTextureLayer() { }
60
61     // Sets the texture id that represents the layer, in the namespace of the
62     // compositor context.
63     WEBKIT_EXPORT void setTextureId(unsigned);
64
65     // Sets whether or not the texture should be flipped in the Y direction when
66     // rendered.
67     WEBKIT_EXPORT void setFlipped(bool);
68
69     // Sets the rect in UV space of the texture that is mapped to the layer
70     // bounds.
71     WEBKIT_EXPORT void setUVRect(const WebFloatRect&);
72
73     // Sets whether every pixel in this layer is opaque. Defaults to false.
74     WEBKIT_EXPORT void setOpaque(bool);
75
76     // Sets whether this layer's texture has premultiplied alpha or not. Defaults to true.
77     WEBKIT_EXPORT void setPremultipliedAlpha(bool);
78
79     // Indicates that the most recently provided texture ID is about to be modified externally.
80     WEBKIT_EXPORT void willModifyTexture();
81
82     // Sets whether this context should be rate limited by the compositor. Rate limiting works by blocking
83     // invalidate() and invalidateRect() calls if the compositor is too many frames behind.
84     WEBKIT_EXPORT void setRateLimitContext(bool);
85
86 private:
87 #if WEBKIT_IMPLEMENTATION
88     explicit WebExternalTextureLayer(PassRefPtr<WebCore::TextureLayerChromium>);
89 #endif
90 };
91
92 } // namespace WebKit
93
94 #endif // WebExternalTextureLayer_h