ARenderingContextOptions

Defines rendering API priority and options for your application.

Header:	#include <AUI/Platform/ARenderingContextOptions.h>
CMake:	aui_link(my_target PUBLIC aui::views)

Detailed Description

By default, AUI uses the following settings:

ARenderingContextOptions::set({
   OpenGL {},
   Software {},
});

You may call this before initializating windows in order to define your own settings and priorities.

The priority can be overridden by --aui-renderer=GRAPHICS_API argument passed to your application.

Examples

examples/ui/opengl_simple/src/main.cpp

OpenGL Example - Demonstrates how to integrate custom OpenGL rendering with AUI Framework.

}   // namespace

AUI_ENTRY {
    // ask aui to provide opengl context for us. (no fallback to software rendering)
    ARenderingContextOptions::set({
        .initializationOrder = {
            ARenderingContextOptions::OpenGL{},
        },
        .flags = ARenderContextFlags::NO_SMOOTH | ARenderContextFlags::NO_VSYNC,
    });

Public Types

---

DirectX11

struct ARenderingContextOptions::DirectX11

Empty structure.

---

OpenGL

struct ARenderingContextOptions::OpenGL

Examples:

Empty structure.

---

Software

struct ARenderingContextOptions::Software

Empty structure.