Home

Introduction

Welcome to the Topaz documentation.

• To read documentation for a specific API function or type, you should try searching for it using the searchbox above.
• To read documentation for a subsystem/module, you can navigate to the C++ API Reference or TZSL API Reference sections.
• If you're still learning the basics, or need a general overview of the engine, you'd prefer the wiki.

Links

These might come in useful, or you might find some of these interesting.

• Topaz Engine Repository
• Topaz Engine Wiki
• Development Playlist (YouTube)

Worked Example

The code snippet you're about to see is the source code of the simplest demo, which simply draws a triangle to the screen. This is known as tz_triangle_demo.

#include "tz/tz.hpp"
#include "tz/gl/device.hpp"
#include "tz/gl/renderer.hpp"
#include "tz/gl/imported_shaders.hpp"
#include "tz/dbgui/dbgui.hpp"
 
#include ImportedShaderHeader(tz_triangle_demo, vertex)
#include ImportedShaderHeader(tz_triangle_demo, fragment)
 
int main()
{
    tz::initialise
    ({
        .name = "tz_triangle_demo",
    });
    {
        tz::gl::renderer_info rinfo;
        rinfo.state().graphics.tri_count = 1;
        rinfo.shader().set_shader(tz::gl::shader_stage::vertex, ImportedShaderSource(tz_triangle_demo, vertex));
        rinfo.shader().set_shader(tz::gl::shader_stage::fragment, ImportedShaderSource(tz_triangle_demo, fragment));
        rinfo.set_options({tz::gl::renderer_option::no_depth_testing});
 
        tz::gl::renderer_handle renh = tz::gl::get_device().create_renderer(rinfo);
        tz::gl::get_device().render_graph().timeline = {renh};
        while(!tz::window().is_close_requested())
        {
            tz::begin_frame();
            tz::gl::get_device().get_renderer(renh).render();
            tz::end_frame();
        }
    }
    tz::terminate();
}