Skip to main content

helios Examples

This directory contains example applications demonstrating various features of the helios game framework.

Available Examples​

1. Simple Cube Rendering​

Location: simple_cube_rendering/

An example showing the fundamentals of 3D rendering with helios:

  • Creating and configuring shaders
  • Building materials and meshes
  • Working with the scene graph
  • Implementing a basic render loop

Controls:

  • ESC - Exit application

2. Game Controller Input​

Location: game_controller_input/

Demonstrates gamepad/controller input handling with helios.

Building the Examples​

All examples are automatically built when you build the helios project.

Configure and Build​

From the project root directory:

# Configure with CMake
cmake -S . -B build -DCMAKE_BUILD_TYPE=Release

# Build all targets (including examples)
cmake --build build --config Release

Running Examples​

Example executables are placed in:

build/examples/<example_name>/Release/

For example, to run the simple cube renderer:

# Windows
cd build/examples/simple_cube_rendering/Release
./main.exe

# Linux/macOS
cd build/examples/simple_cube_rendering/Release
./simple_cube_rendering

Note: Resources (shaders, textures, etc.) are automatically copied to the output directory during build.

Creating Your Own Example​

To add a new example:

  1. Create a new directory under examples/:

    examples/my_example/

  2. Add your main.cpp:

    #include <cstdlib>

    import helios.ext.glfw.app.GLFWFactory;

    int main() {
        const auto app = GLFWFactory::makeOpenGLApp("My Example");
        // Your code here...
        return EXIT_SUCCESS;
    }

  3. (Optional) Add a resources/ directory for shaders, textures, etc.:

    examples/my_example/resources/

  4. The CMake build system will automatically:

    • Detect your new example
    • Create an executable target
    • Copy resources to the build directory

  5. Rebuild the project:

    cmake --build build --config Release

Example Structure​

Each example should follow this structure:

example_name/
├── main.cpp              # Main application code
├── resources/            # Optional: shaders, textures, models, etc.
│   ├── shader.vert
│   ├── shader.frag
│   └── ...
└── README.md            # Optional: Tutorial/documentation

Common Patterns​

Application Setup​

const auto app = GLFWFactory::makeOpenGLApp("Window Title");
auto* win = dynamic_cast<GLFWWindow*>(app->current());

Main Loop​

while (!win->shouldClose()) {
    app->eventManager().dispatchAll();
    inputManager.poll(0.0f);
    
    // Update logic here...
    
    const auto& snapshot = scene->createSnapshot(*camera);
    auto renderPass = RenderPassFactory::getInstance().buildRenderPass(snapshot);
    app->renderingDevice().render(renderPass);
    
    win->swapBuffers();
}

Input Handling​

helios::input::InputManager& inputManager = app->inputManager();

if (inputManager.isKeyPressed(Key::SPACE)) {
    // Handle space key press
}

Dependencies​

Examples depend on:

  • helios Core - Main framework
  • GLFW - Windowing and input (via helios.ext.glfw)
  • OpenGL - Rendering backend (via helios.ext.opengl)

Troubleshooting​

"Module not found" errors​

Ensure you've built the entire helios project before building examples:

cmake --build build --config Release --target helios

Shader/Resource loading errors​

Check that:

  • Resources are in the resources/ subdirectory
  • Paths in code are relative (./resources/shader.vert)
  • CMake successfully copied resources to the build directory

Black screen / No output​

Common causes:

  • Shaders failed to compile (check console output)
  • Camera or objects positioned incorrectly
  • Rendering backend not properly initialized

Learning Path​

We recommend exploring examples in this order:

  1. simple_cube_rendering - Core rendering concepts
  2. game_controller_input - Input handling
  3. (More examples coming soon...)

Further Resources​

Contributing​

Found a bug in an example? Have an idea for a new example? Please open an issue or submit a pull request!

License​

All examples are part of the helios framework and are distributed under the MIT License.