Berserk
RHIFramebuffer.hpp
Go to the documentation of this file.
1 /**********************************************************************************/
2 /* This file is part of Berserk Engine project */
3 /* https://github.com/EgorOrachyov/Berserk */
4 /**********************************************************************************/
5 /* MIT License */
6 /* */
7 /* Copyright (c) 2018 - 2021 Egor Orachyov */
8 /* */
9 /* Permission is hereby granted, free of charge, to any person obtaining a copy */
10 /* of this software and associated documentation files (the "Software"), to deal */
11 /* in the Software without restriction, including without limitation the rights */
12 /* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell */
13 /* copies of the Software, and to permit persons to whom the Software is */
14 /* furnished to do so, subject to the following conditions: */
15 /* */
16 /* The above copyright notice and this permission notice shall be included in all */
17 /* copies or substantial portions of the Software. */
18 /* */
19 /* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR */
20 /* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, */
21 /* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE */
22 /* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER */
23 /* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, */
24 /* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE */
25 /* SOFTWARE. */
26 /**********************************************************************************/
27 
28 #ifndef BERSERK_RHIFRAMEBUFFER_HPP
29 #define BERSERK_RHIFRAMEBUFFER_HPP
30 
31 #include <core/Config.hpp>
32 #include <core/Typedefs.hpp>
34 #include <rhi/RHIResource.hpp>
35 #include <rhi/RHITexture.hpp>
36 
37 #include <vector>
38 
40 
53  uint32 face = 0;
55 };
56 
66  std::vector<RHIAttachmentDesc> colorTargets;
67 };
68 
73 class RHIFramebuffer : public RHIResource {
74 public:
75  BRK_API ~RHIFramebuffer() override = default;
76 
78  uint32 GetWidth() const { return mDesc.width; }
79 
81  uint32 GetHeight() const { return mDesc.height; }
82 
84  size_t GetColorAttachmentsCount() const { return mDesc.colorTargets.size(); }
85 
87  const StringName &GetName() const { return mDesc.name; }
88 
90  const RHIFramebufferDesc &GetDesc() const { return mDesc; }
91 
92 protected:
95 };
96 
102 
103 #endif//BERSERK_RHIFRAMEBUFFER_HPP
#define BRK_NS_END
Definition: Config.hpp:48
#define BRK_API
Definition: Config.hpp:32
std::uint32_t uint32
Definition: Typedefs.hpp:44
Collection of render targets for drawing.
Definition: RHIFramebuffer.hpp:73
uint32 GetHeight() const
Definition: RHIFramebuffer.hpp:81
const RHIFramebufferDesc & GetDesc() const
Definition: RHIFramebuffer.hpp:90
size_t GetColorAttachmentsCount() const
Definition: RHIFramebuffer.hpp:84
uint32 GetWidth() const
Definition: RHIFramebuffer.hpp:78
RHIFramebufferDesc mDesc
Definition: RHIFramebuffer.hpp:94
BRK_API ~RHIFramebuffer() override=default
const StringName & GetName() const
Definition: RHIFramebuffer.hpp:87
Base class for RHI resource.
Definition: RHIResource.hpp:55
Cached shared utf-8 string id.
Definition: StringName.hpp:61
Definition: GLDevice.cpp:46
Describes single render target attachment.
Definition: RHIFramebuffer.hpp:50
uint32 face
Definition: RHIFramebuffer.hpp:53
uint32 arraySlice
Definition: RHIFramebuffer.hpp:52
Ref< RHITexture > target
Definition: RHIFramebuffer.hpp:51
uint32 mipLevel
Definition: RHIFramebuffer.hpp:54
RHI framebuffer descriptor.
Definition: RHIFramebuffer.hpp:61
std::vector< RHIAttachmentDesc > colorTargets
Definition: RHIFramebuffer.hpp:66
StringName name
Definition: RHIFramebuffer.hpp:62
uint32 height
Definition: RHIFramebuffer.hpp:64
uint32 width
Definition: RHIFramebuffer.hpp:63
RHIAttachmentDesc depthStencilTarget
Definition: RHIFramebuffer.hpp:65