2011-02-23 Anders Carlsson <andersca@apple.com>
[WebKit-https.git] / Source / WebKit2 / Shared / ShareableBitmap.h
1 /*
2  * Copyright (C) 2010 Apple 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  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23  * THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #ifndef ShareableBitmap_h
27 #define ShareableBitmap_h
28
29 #include "SharedMemory.h"
30 #include <WebCore/IntRect.h>
31 #include <wtf/PassOwnPtr.h>
32 #include <wtf/PassRefPtr.h>
33 #include <wtf/RefCounted.h>
34 #include <wtf/RefPtr.h>
35
36 namespace WebCore {
37     class GraphicsContext;
38 }
39
40 namespace WebKit {
41     
42 class ShareableBitmap : public RefCounted<ShareableBitmap> {
43 public:
44     // Create a shareable bitmap that uses malloced memory.
45     static PassRefPtr<ShareableBitmap> create(const WebCore::IntSize&);
46
47     // Create a shareable bitmap whose backing memory can be shared with another process.
48     static PassRefPtr<ShareableBitmap> createShareable(const WebCore::IntSize&);
49
50     // Create a shareable bitmap from an already existing shared memory block.
51     static PassRefPtr<ShareableBitmap> create(const WebCore::IntSize&, PassRefPtr<SharedMemory>);
52
53     // Create a shareable bitmap from a shared memory handle.
54     static PassRefPtr<ShareableBitmap> create(const WebCore::IntSize&, const SharedMemory::Handle&);
55
56     // Create a shared memory handle.
57     bool createHandle(SharedMemory::Handle&);
58
59     ~ShareableBitmap();
60
61     const WebCore::IntSize& size() const { return m_size; }
62     WebCore::IntRect bounds() const { return WebCore::IntRect(WebCore::IntPoint(), size()); }
63
64     bool resize(const WebCore::IntSize& size);
65
66     // Create a graphics context that can be used to paint into the backing store.
67     PassOwnPtr<WebCore::GraphicsContext> createGraphicsContext();
68
69     // Paint the backing store into the given context.
70     void paint(WebCore::GraphicsContext&, const WebCore::IntPoint& dstPoint, const WebCore::IntRect& srcRect);
71
72     bool isBackedBySharedMemory() const { return m_sharedMemory; }
73
74 private:
75     ShareableBitmap(const WebCore::IntSize&, void*);
76     ShareableBitmap(const WebCore::IntSize&, PassRefPtr<SharedMemory>);
77
78     static size_t numBytesForSize(const WebCore::IntSize& size) { return size.width() * size.height() * 4; }
79
80     void* data() const;
81     size_t sizeInBytes() const { return numBytesForSize(m_size); }
82
83     WebCore::IntSize m_size;
84
85     // If the shareable bitmap is backed by shared memory, this points to the shared memory object.
86     RefPtr<SharedMemory> m_sharedMemory;
87
88     // If the shareable bitmap is backed by fastMalloced memory, this points to the data.
89     void* m_data;
90 };
91
92 } // namespace WebKit
93
94 #endif // ShareableBitmap_h