mirror of
https://github.com/scratchfoundation/bgfx.git
synced 2024-12-04 21:31:11 -05:00
278 lines
11 KiB
C++
278 lines
11 KiB
C++
/*
|
|
* Copyright 2011-2016 Branimir Karadzic. All rights reserved.
|
|
* License: https://github.com/bkaradzic/bgfx#license-bsd-2-clause
|
|
*/
|
|
|
|
// This code is based on:
|
|
//
|
|
// Copyright (c) 2009-2010 Mikko Mononen memon@inside.org
|
|
//
|
|
// This software is provided 'as-is', without any express or implied
|
|
// warranty. In no event will the authors be held liable for any damages
|
|
// arising from the use of this software.
|
|
// Permission is granted to anyone to use this software for any purpose,
|
|
// including commercial applications, and to alter it and redistribute it
|
|
// freely, subject to the following restrictions:
|
|
// 1. The origin of this software must not be misrepresented; you must not
|
|
// claim that you wrote the original software. If you use this software
|
|
// in a product, an acknowledgment in the product documentation would be
|
|
// appreciated but is not required.
|
|
// 2. Altered source versions must be plainly marked as such, and must not be
|
|
// misrepresented as being the original software.
|
|
// 3. This notice may not be removed or altered from any source distribution.
|
|
//
|
|
// Source altered and distributed from https://github.com/AdrienHerubel/imgui
|
|
|
|
#ifndef IMGUI_H_HEADER_GUARD
|
|
#define IMGUI_H_HEADER_GUARD
|
|
|
|
#include <bgfx/bgfx.h>
|
|
#include <ocornut-imgui/imgui.h>
|
|
#include <ocornut-imgui/imgui_wm.h>
|
|
|
|
#define IMGUI_MBUT_LEFT 0x01
|
|
#define IMGUI_MBUT_RIGHT 0x02
|
|
#define IMGUI_MBUT_MIDDLE 0x04
|
|
|
|
/// For custom values, define these macros before including imgui.h
|
|
|
|
#ifndef IMGUI_SCROLL_AREA_R
|
|
# define IMGUI_SCROLL_AREA_R 6
|
|
#endif //IMGUI_SCROLL_AREA_R
|
|
|
|
#ifndef IMGUI_SCROLL_BAR_R
|
|
# define IMGUI_SCROLL_BAR_R 5
|
|
#endif //IMGUI_SCROLL_BAR_R
|
|
|
|
#ifndef IMGUI_BUTTON_R
|
|
# define IMGUI_BUTTON_R 9
|
|
#endif //IMGUI_BUTTON_R
|
|
|
|
#ifndef IMGUI_BUTTON_RGB0
|
|
# define IMGUI_BUTTON_RGB0 imguiRGBA(128, 128, 128, 0)
|
|
#endif //IMGUI_BUTTON_RGB0
|
|
|
|
#ifndef IMGUI_INPUT_R
|
|
# define IMGUI_INPUT_R 4
|
|
#endif //IMGUI_INPUT_R
|
|
|
|
#ifndef IMGUI_TABS_HEIGHT
|
|
# define IMGUI_TABS_HEIGHT 20
|
|
#endif //IMGUI_TABS_HEIGHT
|
|
|
|
#ifndef IMGUI_TABS_R
|
|
# define IMGUI_TABS_R 9
|
|
#endif //IMGUI_TABS_R
|
|
|
|
#ifndef IMGUI_INDENT_VALUE
|
|
# define IMGUI_INDENT_VALUE 16
|
|
#endif //IMGUI_INDENT_VALUE
|
|
|
|
#ifndef IMGUI_SEPARATOR_VALUE
|
|
# define IMGUI_SEPARATOR_VALUE 12
|
|
#endif //IMGUI_SEPARATOR_VALUE
|
|
|
|
struct ImguiTextAlign
|
|
{
|
|
enum Enum
|
|
{
|
|
Left,
|
|
Center,
|
|
Right,
|
|
|
|
Count
|
|
};
|
|
};
|
|
|
|
struct ImguiAlign
|
|
{
|
|
enum Enum
|
|
{
|
|
Left,
|
|
LeftIndented,
|
|
Center,
|
|
CenterIndented,
|
|
Right,
|
|
};
|
|
};
|
|
|
|
struct ImguiCubemap
|
|
{
|
|
enum Enum
|
|
{
|
|
Cross,
|
|
Latlong,
|
|
Hex,
|
|
|
|
Count,
|
|
};
|
|
};
|
|
|
|
struct ImguiBorder
|
|
{
|
|
enum Enum
|
|
{
|
|
Left,
|
|
Right,
|
|
Top,
|
|
Bottom
|
|
};
|
|
};
|
|
|
|
inline uint32_t imguiRGBA(uint8_t _r, uint8_t _g, uint8_t _b, uint8_t _a = 255)
|
|
{
|
|
return 0
|
|
| (uint32_t(_r) << 0)
|
|
| (uint32_t(_g) << 8)
|
|
| (uint32_t(_b) << 16)
|
|
| (uint32_t(_a) << 24)
|
|
;
|
|
}
|
|
|
|
BGFX_HANDLE(ImguiFontHandle);
|
|
|
|
ImguiFontHandle imguiCreateFont(const void* _data, float _fontSize=15.0f);
|
|
void imguiSetFont(ImguiFontHandle _handle);
|
|
ImguiFontHandle imguiGetCurrentFont();
|
|
|
|
namespace bx { struct AllocatorI; }
|
|
|
|
ImguiFontHandle imguiCreate(const void* _data = NULL, uint32_t _size = 0, float _fontSize = 15.0f, bx::AllocatorI* _allocator = NULL);
|
|
void imguiDestroy();
|
|
|
|
void imguiBeginFrame(int32_t _mx, int32_t _my, uint8_t _button, int32_t _scroll, uint16_t _width, uint16_t _height, char _inputChar = 0, uint8_t _view = 255);
|
|
void imguiBeginFrame(int32_t _mx, int32_t _my, uint8_t _button, int32_t _scroll, uint16_t _width, uint16_t _height, uint16_t _surfaceWidth, uint16_t _surfaceHeight, char _inputChar = 0, uint8_t _view = 255);
|
|
void imguiEndFrame();
|
|
|
|
void imguiDrawText(int _x, int _y, ImguiTextAlign::Enum _align, const char* _text, uint32_t _argb);
|
|
void imguiDrawLine(float _x0, float _y0, float _x1, float _y1, float _r, uint32_t _argb);
|
|
void imguiDrawRoundedRect(float _x, float _y, float _w, float _h, float _r, uint32_t _argb);
|
|
void imguiDrawRect(float _x, float _y, float _w, float _h, uint32_t _argb);
|
|
|
|
/// Notice: this function is not to be called between imguiBeginArea() and imguiEndArea().
|
|
bool imguiBorderButton(ImguiBorder::Enum _border, bool _checked, bool _enabled = true);
|
|
|
|
bool imguiBeginArea(const char* _name, int _x, int _y, int _width, int _height, bool _enabled = true, int32_t _r = IMGUI_SCROLL_AREA_R);
|
|
void imguiEndArea();
|
|
bool imguiBeginScroll(int32_t _height, int32_t* _scroll, bool _enabled = true);
|
|
void imguiEndScroll(int32_t _r = IMGUI_SCROLL_BAR_R);
|
|
|
|
bool imguiBeginScrollArea(const char* _name, int _x, int _y, int _width, int _height, int* _scroll, bool _enabled = true, int32_t _r = IMGUI_SCROLL_AREA_R);
|
|
void imguiEndScrollArea(int32_t _r = IMGUI_SCROLL_BAR_R);
|
|
|
|
void imguiIndent(uint16_t _width = IMGUI_INDENT_VALUE);
|
|
void imguiUnindent(uint16_t _width = IMGUI_INDENT_VALUE);
|
|
void imguiSeparator(uint16_t _height = IMGUI_SEPARATOR_VALUE);
|
|
void imguiSeparatorLine(uint16_t _height = IMGUI_SEPARATOR_VALUE, ImguiAlign::Enum = ImguiAlign::LeftIndented);
|
|
|
|
int32_t imguiGetWidgetX();
|
|
int32_t imguiGetWidgetY();
|
|
int32_t imguiGetWidgetW();
|
|
void imguiSetCurrentScissor(); // Call before drawing custom widgets over imgui area.
|
|
|
|
bool imguiButton(const char* _text, bool _enabled = true, ImguiAlign::Enum _align = ImguiAlign::LeftIndented, uint32_t _rgb0 = IMGUI_BUTTON_RGB0, int32_t _r = IMGUI_BUTTON_R);
|
|
bool imguiItem(const char* _text, bool _enabled = true);
|
|
bool imguiCheck(const char* _text, bool _checked, bool _enabled = true);
|
|
bool imguiBool(const char* _text, bool& _flag, bool _enabled = true);
|
|
bool imguiCollapse(const char* _text, const char* _subtext, bool _checked, bool _enabled = true);
|
|
void imguiLabel(const char* _format, ...);
|
|
void imguiLabel(uint32_t _rgba, const char* _format, ...);
|
|
void imguiValue(const char* _text);
|
|
bool imguiSlider(const char* _text, float& _val, float _vmin, float _vmax, float _vinc, bool _enabled = true, ImguiAlign::Enum _align = ImguiAlign::LeftIndented);
|
|
bool imguiSlider(const char* _text, int32_t& _val, int32_t _vmin, int32_t _vmax, bool _enabled = true, ImguiAlign::Enum _align = ImguiAlign::LeftIndented);
|
|
void imguiInput(const char* _label, char* _str, uint32_t _len, bool _enabled = true, ImguiAlign::Enum _align = ImguiAlign::LeftIndented, int32_t _r = IMGUI_INPUT_R);
|
|
|
|
/// Usage example:
|
|
/// imguiTabs(0, true, ImguiAlign::CenterIndented, 20, 0, 3, 2, "Tab0", "Tab1", "Tab2", true, false);
|
|
/// _nTabs - Number of tabs (in the above example, 3, and their labes are 'Tab0', 'Tab1' and 'Tab2'.
|
|
/// _nEnabled - Number of specified 'enabled' flags. All other unspecified tabs are considered enabled by default.
|
|
/// In the above example, there are 2 enabled flags: 'Tab0' is specified as enabled and 'Tab1' is specified as disabled.
|
|
/// Tab2 is unspecified and therefore is treated as enabled.
|
|
uint8_t imguiTabs(uint8_t _selected, bool _enabled, ImguiAlign::Enum _align, int32_t _height, int32_t _r, uint8_t _nTabs, uint8_t _nEnabled, ...);
|
|
uint8_t imguiTabs(uint8_t _selected, bool _enabled, ImguiAlign::Enum _align, int32_t _height, int32_t _r, uint8_t _nTabs, ...);
|
|
|
|
uint32_t imguiChooseUseMacroInstead(uint32_t _selected, ...);
|
|
#define imguiChoose(...) imguiChooseUseMacroInstead(__VA_ARGS__, NULL)
|
|
|
|
void imguiColorWheel(float _rgb[3], bool _respectIndentation = false, float _size = 0.8f, bool _enabled = true);
|
|
void imguiColorWheel(const char* _str, float _rgb[3], bool& _activated, float _size = 0.8f, bool _enabled = true);
|
|
|
|
bool imguiImage(bgfx::TextureHandle _image, float _lod, int32_t _width, int32_t _height, ImguiAlign::Enum _align = ImguiAlign::LeftIndented, bool _enabled = true, bool _originBottomLeft = false);
|
|
bool imguiImage(bgfx::TextureHandle _image, float _lod, float _scale, float _aspect, ImguiAlign::Enum _align = ImguiAlign::LeftIndented, bool _enabled = true, bool _originBottomLeft = false);
|
|
bool imguiImageChannel(bgfx::TextureHandle _image, uint8_t _channel, float _lod, int32_t _width, int32_t _height, ImguiAlign::Enum _align = ImguiAlign::LeftIndented, bool _enabled = true);
|
|
bool imguiImageChannel(bgfx::TextureHandle _image, uint8_t _channel, float _lod, float _scale, float _aspect, ImguiAlign::Enum _align = ImguiAlign::LeftIndented, bool _enabled = true);
|
|
bool imguiCube(bgfx::TextureHandle _cubemap, float _lod = 0.0f, ImguiCubemap::Enum _display = ImguiCubemap::Cross, bool _sameHeight = false, ImguiAlign::Enum _align = ImguiAlign::LeftIndented, bool _enabled = true);
|
|
|
|
float imguiGetTextLength(const char* _text, ImguiFontHandle _handle);
|
|
bool imguiMouseOverArea();
|
|
|
|
namespace ImGui
|
|
{
|
|
#define IMGUI_FLAGS_NONE UINT8_C(0x00)
|
|
#define IMGUI_FLAGS_ALPHA_BLEND UINT8_C(0x01)
|
|
|
|
// Helper function for passing bgfx::TextureHandle to ImGui::Image.
|
|
inline void Image(bgfx::TextureHandle _handle
|
|
, uint8_t _flags
|
|
, uint8_t _mip
|
|
, const ImVec2& _size
|
|
, const ImVec2& _uv0 = ImVec2(0.0f, 0.0f)
|
|
, const ImVec2& _uv1 = ImVec2(1.0f, 1.0f)
|
|
, const ImVec4& _tintCol = ImVec4(1.0f, 1.0f, 1.0f, 1.0f)
|
|
, const ImVec4& _borderCol = ImVec4(0.0f, 0.0f, 0.0f, 0.0f)
|
|
)
|
|
{
|
|
union { struct { bgfx::TextureHandle handle; uint8_t flags; uint8_t mip; } s; ImTextureID ptr; } texture;
|
|
texture.s.handle = _handle;
|
|
texture.s.flags = _flags;
|
|
texture.s.mip = _mip;
|
|
Image(texture.ptr, _size, _uv0, _uv1, _tintCol, _borderCol);
|
|
}
|
|
|
|
// Helper function for passing bgfx::TextureHandle to ImGui::Image.
|
|
inline void Image(bgfx::TextureHandle _handle
|
|
, const ImVec2& _size
|
|
, const ImVec2& _uv0 = ImVec2(0.0f, 0.0f)
|
|
, const ImVec2& _uv1 = ImVec2(1.0f, 1.0f)
|
|
, const ImVec4& _tintCol = ImVec4(1.0f, 1.0f, 1.0f, 1.0f)
|
|
, const ImVec4& _borderCol = ImVec4(0.0f, 0.0f, 0.0f, 0.0f)
|
|
)
|
|
{
|
|
Image(_handle, IMGUI_FLAGS_ALPHA_BLEND, 0, _size, _uv0, _uv1, _tintCol, _borderCol);
|
|
}
|
|
|
|
// Helper function for passing bgfx::TextureHandle to ImGui::ImageButton.
|
|
inline bool ImageButton(bgfx::TextureHandle _handle
|
|
, uint8_t _flags
|
|
, uint8_t _mip
|
|
, const ImVec2& _size
|
|
, const ImVec2& _uv0 = ImVec2(0.0f, 0.0f)
|
|
, const ImVec2& _uv1 = ImVec2(1.0f, 1.0f)
|
|
, int _framePadding = -1
|
|
, const ImVec4& _bgCol = ImVec4(0.0f, 0.0f, 0.0f, 0.0f)
|
|
, const ImVec4& _tintCol = ImVec4(1.0f, 1.0f, 1.0f, 1.0f)
|
|
)
|
|
{
|
|
union { struct { bgfx::TextureHandle handle; uint8_t flags; uint8_t mip; } s; ImTextureID ptr; } texture;
|
|
texture.s.handle = _handle;
|
|
texture.s.flags = _flags;
|
|
texture.s.mip = _mip;
|
|
return ImageButton(texture.ptr, _size, _uv0, _uv1, _framePadding, _bgCol, _tintCol);
|
|
}
|
|
|
|
// Helper function for passing bgfx::TextureHandle to ImGui::ImageButton.
|
|
inline bool ImageButton(bgfx::TextureHandle _handle
|
|
, const ImVec2& _size
|
|
, const ImVec2& _uv0 = ImVec2(0.0f, 0.0f)
|
|
, const ImVec2& _uv1 = ImVec2(1.0f, 1.0f)
|
|
, int _framePadding = -1
|
|
, const ImVec4& _bgCol = ImVec4(0.0f, 0.0f, 0.0f, 0.0f)
|
|
, const ImVec4& _tintCol = ImVec4(1.0f, 1.0f, 1.0f, 1.0f)
|
|
)
|
|
{
|
|
return ImageButton(_handle, IMGUI_FLAGS_ALPHA_BLEND, 0, _size, _uv0, _uv1, _framePadding, _bgCol, _tintCol);
|
|
}
|
|
|
|
} // namespace ImGui
|
|
|
|
#endif // IMGUI_H_HEADER_GUARD
|