d11bfcc4ab0cc24fa91bdc68272d14aafc4003fa
[WebKit-https.git] / Source / WebCore / platform / graphics / gpu / GPUTexture.h
1 /*
2  * Copyright (C) 2018 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 #pragma once
27
28 #if ENABLE(WEBGPU)
29
30 #include "GPUTextureUsage.h"
31 #include <wtf/OptionSet.h>
32 #include <wtf/RefCounted.h>
33 #include <wtf/RefPtr.h>
34 #include <wtf/RetainPtr.h>
35
36 OBJC_PROTOCOL(MTLTexture);
37
38 namespace WebCore {
39
40 class GPUDevice;
41
42 struct GPUTextureDescriptor;
43
44 using PlatformTexture = MTLTexture;
45 using PlatformTextureSmartPtr = RetainPtr<MTLTexture>;
46
47 class GPUTexture : public RefCounted<GPUTexture> {
48 public:
49     static RefPtr<GPUTexture> tryCreate(const GPUDevice&, const GPUTextureDescriptor&);
50     static Ref<GPUTexture> create(PlatformTextureSmartPtr&&, OptionSet<GPUTextureUsage::Flags>);
51
52     PlatformTexture *platformTexture() const { return m_platformTexture.get(); }
53     bool isTransferSource() const { return m_usage.contains(GPUTextureUsage::Flags::TransferSource); }
54     bool isTransferDestination() const { return m_usage.contains(GPUTextureUsage::Flags::TransferDestination); }
55     bool isOutputAttachment() const { return m_usage.contains(GPUTextureUsage::Flags::OutputAttachment); }
56     bool isReadOnly() const { return m_usage.containsAny({ GPUTextureUsage::Flags::TransferSource, GPUTextureUsage::Flags::Sampled }); }
57
58     RefPtr<GPUTexture> tryCreateDefaultTextureView();
59     void destroy() { m_platformTexture = nullptr; }
60
61 private:
62     explicit GPUTexture(PlatformTextureSmartPtr&&, OptionSet<GPUTextureUsage::Flags>);
63
64     PlatformTextureSmartPtr m_platformTexture;
65
66     OptionSet<GPUTextureUsage::Flags> m_usage;
67 };
68
69 } // namespace WebCore
70
71 #endif // ENABLE(WEBGPU)