Skip to content

Commit 0ae6729

Browse files
Updated rasterizer state documentation
1 parent 0a73e12 commit 0ae6729

File tree

1 file changed

+19
-8
lines changed

1 file changed

+19
-8
lines changed

Graphics/GraphicsEngine/interface/RasterizerState.h

Lines changed: 19 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2019-2022 Diligent Graphics LLC
2+
* Copyright 2019-2025 Diligent Graphics LLC
33
* Copyright 2015-2019 Egor Yusov
44
*
55
* Licensed under the Apache License, Version 2.0 (the "License");
@@ -96,49 +96,60 @@ DILIGENT_TYPED_ENUM(CULL_MODE, Int8)
9696
struct RasterizerStateDesc
9797
{
9898
/// Determines triangle fill mode, see Diligent::FILL_MODE for details.
99+
99100
/// Default value: Diligent::FILL_MODE_SOLID.
100101
FILL_MODE FillMode DEFAULT_INITIALIZER(FILL_MODE_SOLID);
101102

102103
/// Determines triangle cull mode, see Diligent::CULL_MODE for details.
104+
103105
/// Default value: Diligent::CULL_MODE_BACK.
104106
CULL_MODE CullMode DEFAULT_INITIALIZER(CULL_MODE_BACK);
105107

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
108112
/// on the render target and considered back-facing if they are clockwise.
109113
/// If this parameter is False, the opposite is true.
110114
/// Default value: False.
111115
Bool FrontCounterClockwise DEFAULT_INITIALIZER(False);
112116

113117
/// Enable clipping against near and far clip planes.
118+
114119
/// Default value: True.
115120
///
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.
119124
///
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.
122127
Bool DepthClipEnable DEFAULT_INITIALIZER(True);
123128

124129
/// Enable scissor-rectangle culling. All pixels outside an active scissor rectangle are culled.
130+
125131
/// Default value: False.
126132
Bool ScissorEnable DEFAULT_INITIALIZER(False);
127133

128134
/// Specifies whether to enable line antialiasing.
135+
129136
/// Default value: False.
130137
Bool AntialiasedLineEnable DEFAULT_INITIALIZER(False);
131138

132139
/// Constant value added to the depth of a given pixel.
140+
133141
/// Default value: 0.
134142
Int32 DepthBias DEFAULT_INITIALIZER(0);
135143

136144
/// Maximum depth bias of a pixel.
145+
137146
/// \warning Depth bias clamp is not available in OpenGL
147+
///
138148
/// Default value: 0.
139149
Float32 DepthBiasClamp DEFAULT_INITIALIZER(0.f);
140150

141151
/// Scalar that scales the given pixel's slope before adding to the pixel's depth.
152+
142153
/// Default value: 0.
143154
Float32 SlopeScaledDepthBias DEFAULT_INITIALIZER(0.f);
144155

0 commit comments

Comments
 (0)