|
1 | 1 | /* |
2 | | - * Copyright 2019-2022 Diligent Graphics LLC |
| 2 | + * Copyright 2019-2025 Diligent Graphics LLC |
3 | 3 | * Copyright 2015-2019 Egor Yusov |
4 | 4 | * |
5 | 5 | * Licensed under the Apache License, Version 2.0 (the "License"); |
@@ -96,49 +96,60 @@ DILIGENT_TYPED_ENUM(CULL_MODE, Int8) |
96 | 96 | struct RasterizerStateDesc |
97 | 97 | { |
98 | 98 | /// Determines triangle fill mode, see Diligent::FILL_MODE for details. |
| 99 | + |
99 | 100 | /// Default value: Diligent::FILL_MODE_SOLID. |
100 | 101 | FILL_MODE FillMode DEFAULT_INITIALIZER(FILL_MODE_SOLID); |
101 | 102 |
|
102 | 103 | /// Determines triangle cull mode, see Diligent::CULL_MODE for details. |
| 104 | + |
103 | 105 | /// Default value: Diligent::CULL_MODE_BACK. |
104 | 106 | CULL_MODE CullMode DEFAULT_INITIALIZER(CULL_MODE_BACK); |
105 | 107 |
|
106 | | - /// Determines if a triangle is front- or back-facing. If this parameter is True, |
107 | | - /// a triangle will be considered front-facing if its vertices are counter-clockwise |
| 108 | + /// Determines if a triangle is front- or back-facing. |
| 109 | + |
| 110 | + /// If this parameter is True, a triangle will be considered front-facing if |
| 111 | + /// its vertices are counter-clockwise |
108 | 112 | /// on the render target and considered back-facing if they are clockwise. |
109 | 113 | /// If this parameter is False, the opposite is true. |
110 | 114 | /// Default value: False. |
111 | 115 | Bool FrontCounterClockwise DEFAULT_INITIALIZER(False); |
112 | 116 |
|
113 | 117 | /// Enable clipping against near and far clip planes. |
| 118 | + |
114 | 119 | /// Default value: True. |
115 | 120 | /// |
116 | | - /// \remarks By default polygon faces are clipped against the near and far planes of the view |
117 | | - /// frustum. If depth clipping is disabled, the depth of the fragments that would be |
118 | | - /// clipped is clamped to the near/far plane instead of discarding them. |
| 121 | + /// By default polygon faces are clipped against the near and far planes of the view |
| 122 | + /// frustum. If depth clipping is disabled, the depth of the fragments that would be |
| 123 | + /// clipped is clamped to the near/far plane instead of discarding them. |
119 | 124 | /// |
120 | | - /// To check if the device supports depth clamping, use the DepthClamp device feature. |
121 | | - /// If it is not supported, the value of this member must be True. |
| 125 | + /// To check if the device supports depth clamping, use the DepthClamp device feature. |
| 126 | + /// If it is not supported, the value of this member must be True. |
122 | 127 | Bool DepthClipEnable DEFAULT_INITIALIZER(True); |
123 | 128 |
|
124 | 129 | /// Enable scissor-rectangle culling. All pixels outside an active scissor rectangle are culled. |
| 130 | + |
125 | 131 | /// Default value: False. |
126 | 132 | Bool ScissorEnable DEFAULT_INITIALIZER(False); |
127 | 133 |
|
128 | 134 | /// Specifies whether to enable line antialiasing. |
| 135 | + |
129 | 136 | /// Default value: False. |
130 | 137 | Bool AntialiasedLineEnable DEFAULT_INITIALIZER(False); |
131 | 138 |
|
132 | 139 | /// Constant value added to the depth of a given pixel. |
| 140 | + |
133 | 141 | /// Default value: 0. |
134 | 142 | Int32 DepthBias DEFAULT_INITIALIZER(0); |
135 | 143 |
|
136 | 144 | /// Maximum depth bias of a pixel. |
| 145 | + |
137 | 146 | /// \warning Depth bias clamp is not available in OpenGL |
| 147 | + /// |
138 | 148 | /// Default value: 0. |
139 | 149 | Float32 DepthBiasClamp DEFAULT_INITIALIZER(0.f); |
140 | 150 |
|
141 | 151 | /// Scalar that scales the given pixel's slope before adding to the pixel's depth. |
| 152 | + |
142 | 153 | /// Default value: 0. |
143 | 154 | Float32 SlopeScaledDepthBias DEFAULT_INITIALIZER(0.f); |
144 | 155 |
|
|
0 commit comments