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
95
96
97
98
99
100
101
|
/* Copyright (C) 2022 Wildfire Games.
* This file is part of 0 A.D.
*
* 0 A.D. is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 2 of the License, or
* (at your option) any later version.
*
* 0 A.D. is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with 0 A.D. If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef INCLUDED_RENDERER_BACKEND_IFRAMEBUFFER
#define INCLUDED_RENDERER_BACKEND_IFRAMEBUFFER
#include "graphics/Color.h"
#include "renderer/backend/IDeviceObject.h"
namespace Renderer
{
namespace Backend
{
class ITexture;
/**
* Load operation is set for each attachment, what should be done with its
* content on BeginFramebufferPass.
*/
enum class AttachmentLoadOp
{
// Loads the attachment content.
LOAD,
// Clears the attachment content without loading. Prefer to use that
// operation over manual ClearFramebuffer.
CLEAR,
// After BeginFramebufferPass the attachment content is undefined.
DONT_CARE
};
/**
* Store operation is set for each attachment, what should be done with its
* content on EndFramebufferPass.
*/
enum class AttachmentStoreOp
{
// Stores the attachment content.
STORE,
// After EndFramebufferPass the attachment content is undefined.
DONT_CARE
};
struct SColorAttachment
{
ITexture* texture = nullptr;
AttachmentLoadOp loadOp = AttachmentLoadOp::DONT_CARE;
AttachmentStoreOp storeOp = AttachmentStoreOp::DONT_CARE;
CColor clearColor;
};
struct SDepthStencilAttachment
{
ITexture* texture = nullptr;
AttachmentLoadOp loadOp = AttachmentLoadOp::DONT_CARE;
AttachmentStoreOp storeOp = AttachmentStoreOp::DONT_CARE;
};
/**
* IFramebuffer stores attachments which should be used by backend as rendering
* destinations. That combining allows to set these destinations at once.
* IFramebuffer doesn't own its attachments so clients must keep them alive.
* The number of framebuffers ever created for a device during its lifetime
* should be as small as possible.
*
* Framebuffer is a term from OpenGL/Vulkan worlds (D3D synonym is a render
* target).
*/
class IFramebuffer : public IDeviceObject<IFramebuffer>
{
public:
/**
* Returns a clear color for all color attachments of the framebuffer.
* @see IDevice::CreateFramebuffer()
*/
virtual const CColor& GetClearColor() const = 0;
virtual uint32_t GetWidth() const = 0;
virtual uint32_t GetHeight() const = 0;
};
} // namespace Backend
} // namespace Renderer
#endif // INCLUDED_RENDERER_BACKEND_IFRAMEBUFFER
|
