forked from GPUOpen-Drivers/pal
-
Notifications
You must be signed in to change notification settings - Fork 0
/
palMsaaState.h
188 lines (165 loc) · 9.13 KB
/
palMsaaState.h
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
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
/*
***********************************************************************************************************************
*
* Copyright (c) 2014-2019 Advanced Micro Devices, Inc. All Rights Reserved.
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all
* copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*
**********************************************************************************************************************/
/**
***********************************************************************************************************************
* @file palMsaaState.h
* @brief Defines the Platform Abstraction Library (PAL) IMsaaState interface and related types.
***********************************************************************************************************************
*/
#pragma once
#include "pal.h"
#include "palDestroyable.h"
namespace Pal
{
/// Specifies conservative rasterization mode
enum class ConservativeRasterizationMode : uint32
{
Overestimate = 0x0, ///< Fragments will be generated if the primitive area covers any portion of the pixel.
Underestimate = 0x1, ///< Fragments will be generated if all of the pixel is covered by the primitive.
Count
};
/// Maximum supported number of MSAA color samples.
constexpr uint32 MaxMsaaColorSamples = 16;
/// Maximum supported number of MSAA depth samples.
constexpr uint32 MaxMsaaDepthSamples = 8;
/// Maximum supported number of MSAA fragments.
constexpr uint32 MaxMsaaFragments = 8;
/// Sampling pattern grid size. This is a quad of pixels, i.e. 2x2 grid of pixels.
constexpr Extent2d MaxGridSize = { 2, 2 };
#if PAL_CLIENT_INTERFACE_MAJOR_VERSION < 493
/// 1xMSAA grid size in which sample locations can vary, i.e. all 4 pixels in quad must have the same sample location.
constexpr Extent2d Max1xMsaaGridSize = { 1, 1 };
#endif
/// The positions are rounded to 1/Pow2(SubPixelBits)
constexpr uint32 SubPixelBits = 4;
/// Each pixel is subdivided into Pow2(SubPixelBits) x Pow2(SubPixelBits) grid of possible sample locations.
constexpr Extent2d SubPixelGridSize = { 16, 16 };
/// Specifies a custom multisample pattern for a pixel quad.
struct MsaaQuadSamplePattern
{
Offset2d topLeft[MaxMsaaRasterizerSamples]; ///< Sample locations for TL pixel of quad.
Offset2d topRight[MaxMsaaRasterizerSamples]; ///< Sample locations for TR pixel of quad.
Offset2d bottomLeft[MaxMsaaRasterizerSamples]; ///< Sample locations for BL pixel of quad.
Offset2d bottomRight[MaxMsaaRasterizerSamples]; ///< Sample locations for BR pixel of quad.
};
/// Specifies properties for creation of an @ref IMsaaState object. Input structure to IDevice::CreateMsaaState().
struct MsaaStateCreateInfo
{
uint32 coverageSamples; ///< Number of rasterizer samples. Must be greater than or equal to all
/// sample rates in the pipeline. Valid values are 1, 2, 4, 8, and 16.
uint32 exposedSamples; ///< Number of samples exposed in the pixel shader coverage mask.
/// Must be less than or equal to coverageSamples.
/// Valid values are 1, 2, 4, and 8.
uint32 pixelShaderSamples; ///< Controls the pixel shader execution rate. Must be less than or equal to
/// coverageSamples. Valid values are 1, 2, 4, and 8.
uint32 depthStencilSamples; ///< Number of samples in the bound depth target. Must be less than or equal
/// to coverageSamples. Valid values are 1, 2, 4, and 8.
uint32 shaderExportMaskSamples; ///< Number of samples to use in the shader export mask. Should match the
/// number of color target samples clamped to 8.
uint32 sampleMask; ///< Bitmask of which color target samples should be
/// updated. The lowest bit corresponds to sample 0.
uint32 sampleClusters; ///< Number of sample clusters to control over-rasterization (all samples
/// in a cluster are rasterized if any are hit). Must be less than or
/// equal to coverageSamples. Valid values are 1, 2, 4, and 8.
uint32 alphaToCoverageSamples; ///< How many samples of quality to generate with alpha-to-coverage. Must be
/// less than or equal to coverageSamples.
/// Valid values are 1, 2, 4, 8, and 16.
uint32 occlusionQuerySamples; ///< Controls the number of samples to use for occlusion queries>
/// This value must never exceed the MSAA rate.
#if PAL_CLIENT_INTERFACE_MAJOR_VERSION < 523
bool disableAlphaToCoverageDither; ///< Disables coverage dithering.
#endif
ConservativeRasterizationMode conservativeRasterizationMode;
///< Selects overestimate or underestimate conservative
/// rasterization mode. Used only if
/// @ref MsaaStateCreateInfo::flags::enableConservativeRasterization
/// is set to true.
union
{
struct
{
uint32 enableConservativeRasterization : 1; ///< Set to true to enable conservative rasterization
uint32 enable1xMsaaSampleLocations : 1; ///< Set to true to enable 1xMSAA quad sample pattern
#if PAL_CLIENT_INTERFACE_MAJOR_VERSION >= 523
uint32 disableAlphaToCoverageDither : 1; ///< Disables coverage dithering.
#else
uint32 reserved0 : 1; ///< Reserved for future use.
#endif
#if PAL_CLIENT_INTERFACE_MAJOR_VERSION >= 525
uint32 enableLineStipple : 1; ///< Set to true to enable line stippling
#else
uint32 reserved1 : 1; ///< Reserved for future use.
#endif
uint32 reserved : 28; ///< Reserved for future use
};
uint32 u32All;
} flags;
};
/**
***********************************************************************************************************************
* @interface IMsaaState
* @brief Dynamic state object controlling fixed function MSAA state.
*
* Configures sample counts of various portions of the pipeline, specifies sample positions, etc. The full range of
* EQAA hardware features are exposed.
*
* @see IDevice::CreateMsaaState
***********************************************************************************************************************
*/
class IMsaaState : public IDestroyable
{
public:
/// Returns the value of the associated arbitrary client data pointer.
/// Can be used to associate arbitrary data with a particular PAL object.
///
/// @returns Pointer to client data.
PAL_INLINE void* GetClientData() const
{
return m_pClientData;
}
/// Sets the value of the associated arbitrary client data pointer.
/// Can be used to associate arbitrary data with a particular PAL object.
///
/// @param [in] pClientData A pointer to arbitrary client data.
PAL_INLINE void SetClientData(
void* pClientData)
{
m_pClientData = pClientData;
}
protected:
/// @internal Constructor. Prevent use of new operator on this interface. Client must create objects by explicitly
/// called the proper create method.
IMsaaState() : m_pClientData(nullptr) {}
/// @internal Destructor. Prevent use of delete operator on this interface. Client must destroy objects by
/// explicitly calling IDestroyable::Destroy() and is responsible for freeing the system memory allocated for the
/// object on their own.
virtual ~IMsaaState() { }
private:
/// @internal Client data pointer. This can have an arbitrary value and can be returned by calling GetClientData()
/// and set via SetClientData().
/// For non-top-layer objects, this will point to the layer above the current object.
void* m_pClientData;
};
} // Pal