MenuTypes.h File Reference

#include <libultraship/libultraship.h>
#include "UIWidgets.h"

Include dependency graph for MenuTypes.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	WidgetInfo
struct	WidgetPath
struct	disabledInfo
struct	SidebarEntry
struct	MainMenuEntry
struct	MenuInit
struct	RegisterMenuInitFunc
struct	RegisterMenuUpdateFunc

Typedefs
using	VoidFunc = void (*)()
using	DisableInfoFunc = bool (*)(disabledInfo&)
using	DisableVec = std::vector<DisableOption>
using	WidgetFunc = void (*)(WidgetInfo&)
using	CVarVariant = std::variant<int32_t, const char*, float, Color_RGBA8, Color_RGB8>
using	OptionsVariant

Enumerations
enum	DisableOption {   DISABLE_FOR_FREE_CAM_ON , DISABLE_FOR_FREE_CAM_OFF , DISABLE_FOR_EDITOR_ON , DISABLE_FOR_EDITOR_OFF ,   DISABLE_FOR_DEBUG_MODE_OFF , DISABLE_FOR_NO_VSYNC , DISABLE_FOR_NO_WINDOWED_FULLSCREEN , DISABLE_FOR_NO_MULTI_VIEWPORT ,   DISABLE_FOR_NOT_DIRECTX , DISABLE_FOR_DIRECTX , DISABLE_FOR_MATCH_REFRESH_RATE_ON , DISABLE_FOR_ADVANCED_RESOLUTION_ON ,   DISABLE_FOR_VERTICAL_RES_TOGGLE_ON , DISABLE_FOR_LOW_RES_MODE_ON }
enum	WidgetType {   WIDGET_CHECKBOX , WIDGET_COMBOBOX , WIDGET_SLIDER_INT , WIDGET_SLIDER_FLOAT ,   WIDGET_CVAR_CHECKBOX , WIDGET_CVAR_COMBOBOX , WIDGET_CVAR_SLIDER_INT , WIDGET_CVAR_SLIDER_FLOAT ,   WIDGET_BUTTON , WIDGET_COLOR_24 , WIDGET_COLOR_32 , WIDGET_SEARCH ,   WIDGET_SEPARATOR , WIDGET_SEPARATOR_TEXT , WIDGET_TEXT , WIDGET_WINDOW_BUTTON ,   WIDGET_AUDIO_BACKEND , WIDGET_VIDEO_BACKEND , WIDGET_CUSTOM }
enum	SectionColumns { SECTION_COLUMN_1 , SECTION_COLUMN_2 , SECTION_COLUMN_3 }
enum	MotionBlurOption { MOTION_BLUR_DYNAMIC , MOTION_BLUR_ALWAYS_OFF , MOTION_BLUR_ALWAYS_ON }
enum	DebugLogOption {   DEBUG_LOG_TRACE , DEBUG_LOG_DEBUG , DEBUG_LOG_INFO , DEBUG_LOG_WARN ,   DEBUG_LOG_ERROR , DEBUG_LOG_CRITICAL , DEBUG_LOG_OFF }

Variables
static const std::unordered_map< Ship::AudioBackend, const char * >	audioBackendsMap
static const std::unordered_map< Ship::WindowBackend, const char * >	windowBackendsMap

Typedef Documentation

CVarVariant

using CVarVariant = std::variant<int32_t, const char*, float, Color_RGBA8, Color_RGB8>

DisableInfoFunc

using DisableInfoFunc = bool (*)(disabledInfo&)

DisableVec

using DisableVec = std::vector<DisableOption>

OptionsVariant

using OptionsVariant

Initial value:

 
    std::variant<UIWidgets::ButtonOptions, UIWidgets::CheckboxOptions, UIWidgets::ComboboxOptions,
                 UIWidgets::FloatSliderOptions, UIWidgets::IntSliderOptions, UIWidgets::WidgetOptions>

VoidFunc

using VoidFunc = void (*)()

WidgetFunc

using WidgetFunc = void (*)(WidgetInfo&)

Enumeration Type Documentation

DebugLogOption

enum DebugLogOption

Enumerator
DEBUG_LOG_TRACE
DEBUG_LOG_DEBUG
DEBUG_LOG_INFO
DEBUG_LOG_WARN
DEBUG_LOG_ERROR
DEBUG_LOG_CRITICAL
DEBUG_LOG_OFF

DisableOption

enum DisableOption

Enumerator
DISABLE_FOR_FREE_CAM_ON
DISABLE_FOR_FREE_CAM_OFF
DISABLE_FOR_EDITOR_ON
DISABLE_FOR_EDITOR_OFF
DISABLE_FOR_DEBUG_MODE_OFF
DISABLE_FOR_NO_VSYNC
DISABLE_FOR_NO_WINDOWED_FULLSCREEN
DISABLE_FOR_NO_MULTI_VIEWPORT
DISABLE_FOR_NOT_DIRECTX
DISABLE_FOR_DIRECTX
DISABLE_FOR_MATCH_REFRESH_RATE_ON
DISABLE_FOR_ADVANCED_RESOLUTION_ON
DISABLE_FOR_VERTICAL_RES_TOGGLE_ON
DISABLE_FOR_LOW_RES_MODE_ON

MotionBlurOption

enum MotionBlurOption

Enumerator
MOTION_BLUR_DYNAMIC
MOTION_BLUR_ALWAYS_OFF
MOTION_BLUR_ALWAYS_ON

SectionColumns

enum SectionColumns

Enumerator
SECTION_COLUMN_1
SECTION_COLUMN_2
SECTION_COLUMN_3

WidgetType

enum WidgetType

Enumerator
WIDGET_CHECKBOX
WIDGET_COMBOBOX
WIDGET_SLIDER_INT
WIDGET_SLIDER_FLOAT
WIDGET_CVAR_CHECKBOX
WIDGET_CVAR_COMBOBOX
WIDGET_CVAR_SLIDER_INT
WIDGET_CVAR_SLIDER_FLOAT
WIDGET_BUTTON
WIDGET_COLOR_24
WIDGET_COLOR_32
WIDGET_SEARCH
WIDGET_SEPARATOR
WIDGET_SEPARATOR_TEXT
WIDGET_TEXT
WIDGET_WINDOW_BUTTON
WIDGET_AUDIO_BACKEND
WIDGET_VIDEO_BACKEND
WIDGET_CUSTOM

Variable Documentation

audioBackendsMap

const std::unordered_map<Ship::AudioBackend, const char*> audioBackendsMap

static

Initial value:

= {
    { Ship::AudioBackend::WASAPI, "Windows Audio Session API" },
    { Ship::AudioBackend::SDL, "SDL" },
}

windowBackendsMap

const std::unordered_map<Ship::WindowBackend, const char*> windowBackendsMap

static

Initial value:

= {
    { Ship::WindowBackend::FAST3D_DXGI_DX11, "DirectX" },
    { Ship::WindowBackend::FAST3D_SDL_OPENGL, "OpenGL" },
    { Ship::WindowBackend::FAST3D_SDL_METAL, "Metal" },
}