summaryrefslogtreecommitdiff
path: root/Source/Platform/chromium/public/WebExternalTextureLayer.h
blob: b19c05f3e3b098d8eb03ee561279646b9081f454 (plain)
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
/*
 * Copyright (C) 2011 Google 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 AND ITS CONTRIBUTORS "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 OR ITS 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 WebExternalTextureLayer_h
#define WebExternalTextureLayer_h

#include "WebCommon.h"
#include "WebFloatRect.h"
#include "WebLayer.h"

namespace WebCore {
class TextureLayerChromium;
}

namespace WebKit {

class WebExternalTextureLayerClient;

// This class represents a layer that renders a texture that is generated
// externally (not managed by the WebLayerTreeView).
// The texture will be used by the WebLayerTreeView during compositing passes.
// When in single-thread mode, this means during WebLayerTreeView::composite().
// When using the threaded compositor, this can mean at an arbitrary time until
// the WebLayerTreeView is destroyed.
class WebExternalTextureLayer : public WebLayer {
public:
    // The owner of this layer may optionally provide a client. This client will
    // be called whenever the compositor wishes to produce a new frame and can
    // provide a new front buffer texture ID. This is useful if the client wants to
    // implement a double-buffering scheme that is synchronized with the compositor, for instance.
    WEBKIT_EXPORT static WebExternalTextureLayer create(WebExternalTextureLayerClient* = 0);

    // Indicates that the client for this layer is going away and shouldn't be used.
    WEBKIT_EXPORT void clearClient();

    WebExternalTextureLayer() { }
    virtual ~WebExternalTextureLayer() { }

    // Sets the texture id that represents the layer, in the namespace of the
    // compositor context.
    WEBKIT_EXPORT void setTextureId(unsigned);

    // Sets whether or not the texture should be flipped in the Y direction when
    // rendered.
    WEBKIT_EXPORT void setFlipped(bool);

    // Sets the rect in UV space of the texture that is mapped to the layer
    // bounds.
    WEBKIT_EXPORT void setUVRect(const WebFloatRect&);

    // Sets whether every pixel in this layer is opaque. Defaults to false.
    WEBKIT_EXPORT void setOpaque(bool);

    // Sets whether this layer's texture has premultiplied alpha or not. Defaults to true.
    WEBKIT_EXPORT void setPremultipliedAlpha(bool);

    // Indicates that the most recently provided texture ID is about to be modified externally.
    WEBKIT_EXPORT void willModifyTexture();

    // Sets whether this context should be rate limited by the compositor. Rate limiting works by blocking
    // invalidate() and invalidateRect() calls if the compositor is too many frames behind.
    WEBKIT_EXPORT void setRateLimitContext(bool);

private:
#if WEBKIT_IMPLEMENTATION
    explicit WebExternalTextureLayer(PassRefPtr<WebCore::TextureLayerChromium>);
#endif
};

} // namespace WebKit

#endif // WebExternalTextureLayer_h