1/*
2 * Copyright (C) 2012 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 WebExternalTextureLayerClient_h
27#define WebExternalTextureLayerClient_h
28
29#include "WebCommon.h"
30#include "WebSize.h"
31
32namespace WebKit {
33
34class WebGraphicsContext3D;
35class WebExternalBitmap;
36struct WebExternalTextureMailbox;
37
38class WebExternalTextureLayerClient {
39public:
40    virtual WebGraphicsContext3D* context() = 0;
41
42    // Returns true and provides a mailbox if a new frame is available. If the WebExternalBitmap
43    // isn't 0, then it should also be filled in with the contents of this frame.
44    // Returns false if no new data is available and the old mailbox and bitmap are to be reused.
45    virtual bool prepareMailbox(WebExternalTextureMailbox*, WebExternalBitmap* = 0) = 0;
46
47    // Notifies the client when a mailbox is no longer in use by the compositor and provides
48    // a sync point to wait on before the mailbox could be consumes again by the client.
49    virtual void mailboxReleased(const WebExternalTextureMailbox&) = 0;
50
51protected:
52    virtual ~WebExternalTextureLayerClient() { }
53};
54
55} // namespace WebKit
56
57#endif // WebExternalTextureLayerClient_h
58