Skip to main content

ClearFlags.ixx File

Enum class defining bitmask flags for clearing render buffers before drawing. More...

Namespaces Index​

namespacehelios
namespacerendering

Graphics rendering infrastructure. More...

Description​

Enum class defining bitmask flags for clearing render buffers before drawing.

File Listing​

The file content with the documentation metadata removed is:

1/**
2 * @file ClearFlags.ixx
3 *
4 * @brief Enum class defining bitmask flags for clearing render buffers before drawing.
5 */
6
7export module helios.rendering.ClearFlags;
8
9export namespace helios::rendering {
10
11
12 /**
13 * @brief Defines bitmask flags for clearing render buffers before drawing.
14 *
15 * These flags can be combined using bitwise OR operations to specify which buffers
16 * (color, depth, stencil) should be cleared before rendering.
17 *
18 * Example usage:
19 * ```cpp
20 * // Clear both color and depth buffers
21 * int clearFlags = std::to_underlying(ClearFlags::Color) | std::to_underlying(ClearFlags::Depth);
22 * viewport.setClearFlags(clearFlags);
23 * ```
24 *
25 * @see https://registry.khronos.org/OpenGL-Refpages/gl4/html/glClear.xhtml
26 */
27 enum class ClearFlags {
28 /**
29 * @brief No buffers are cleared.
30 */
31 None = 0,
32
33 /**
34 * @brief The color buffer is cleared.
35 */
36 Color = 1 << 0,
37
38 /**
39 * @brief The depth buffer is cleared.
40 */
41 Depth = 1 << 1,
42
43 /**
44 * @brief The stencil buffer is cleared.
45 */
46 Stencil = 1 << 2,
47 };
48
49
50}

Generated via doxygen2docusaurus 2.0.0 by Doxygen 1.15.0.