Skip to main content

rendering Namespace

Graphics rendering infrastructure. More...

Definition

namespace helios::rendering { ... }

Namespaces Index

namespaceasset

Rendering asset management. More...

namespacematerial
namespacemodel

3D model and mesh management. More...

namespacemesh

Mesh rendering abstractions and command types. More...

namespaceshader

Shader program management. More...

namespacetext

Text rendering abstractions and data types. More...

Classes Index

classLegacyRenderPass

Encapsulates a single rendering pass with its associated resources. More...

classRenderable

Abstract base class for objects that can be rendered by the rendering system. More...

classRenderingDevice

Abstract interface for a low-level rendering device. More...

classRenderPassFactory

Factory for constructing `LegacyRenderPass` objects from scene snapshots. More...

classRenderPrototype

An immutable, shared prototype of a renderable object. More...

classRenderQueue

Manages collections of render commands for geometry and text. More...

classRenderTarget

Represents a destination for rendering operations, such as a window's framebuffer. More...

structVertex

Represents a standard vertex with position, normal, and texture coordinates. More...

structViewportKey

A passkey used to establish a parent-child relationship between a RenderTarget and a Viewport. More...

classViewport

Represents a rectangular area within a RenderTarget where a scene is rendered. More...

structViewportSnapshot

Immutable snapshot of a Viewport's state at a specific point in time. More...

Enumerations Index

enum classClearFlags { ... }

Defines bitmask flags for clearing render buffers before drawing. More...

Description

Graphics rendering infrastructure.

This namespace provides the core rendering system including rendering devices, render commands, queues, passes, and vertex definitions. Encompasses asset, model, and shader management functionality for comprehensive 3D graphics rendering. Provides a platform-independent rendering abstraction that can be implemented by various graphics APIs (OpenGL, Vulkan, DirectX).

Enumerations

ClearFlags

enum class helios::rendering::ClearFlags
strong

Defines bitmask flags for clearing render buffers before drawing.

Enumeration values
NoneNo buffers are cleared (= 0)
ColorThe color buffer is cleared (= 1 << 0)
DepthThe depth buffer is cleared (= 1 << 1)
StencilThe stencil buffer is cleared (= 1 << 2)

These flags can be combined using bitwise OR operations to specify which buffers (color, depth, stencil) should be cleared before rendering.

Example usage: ```cpp // Clear both color and depth buffers int clearFlags = std::to_underlying(ClearFlags::Color) | std::to_underlying(ClearFlags::Depth); viewport.setClearFlags(clearFlags); ```

See Also

https://registry.khronos.org/OpenGL-Refpages/gl4/html/glClear.xhtml

Definition at line 27 of file ClearFlags.ixx.

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 };

The documentation for this namespace was generated from the following file:


Generated via doxygen2docusaurus 2.0.0 by Doxygen 1.15.0.