anki-3d-engine/AnKi/Ui/Canvas.cpp

// Copyright (C) 2009-2021, Panagiotis Christopoulos Charitos and contributors.
// All rights reserved.
// Code licensed under the BSD License.
// http://www.anki3d.org/LICENSE

#include <AnKi/Ui/Canvas.h>
#include <AnKi/Ui/Font.h>
#include <AnKi/Ui/UiManager.h>
#include <AnKi/Resource/ResourceManager.h>
#include <AnKi/Core/StagingGpuMemoryManager.h>
#include <AnKi/Input/Input.h>
#include <AnKi/Gr/Sampler.h>
#include <AnKi/Gr/GrManager.h>

namespace anki {

class Canvas::DrawingState
{
public:
	ShaderProgramPtr m_program;
	Array<U8, 128 - sizeof(Vec4)> m_extraPushConstants;
	U32 m_extraPushConstantSize = 0;
};

/// Custom command that can manipulate the drawing state.
class Canvas::CustomCommand
{
public:
	virtual ~CustomCommand()
	{
	}

	virtual void operator()(DrawingState& state) = 0;
};

Canvas::Canvas(UiManager* manager)
	: UiObject(manager)
{
}

Canvas::~Canvas()
{
	if(m_imCtx)
	{
		setImAllocator();
		ImGui::DestroyContext(m_imCtx);
		unsetImAllocator();
	}
}

Error Canvas::init(FontPtr font, U32 fontHeight, U32 width, U32 height)
{
	m_font = font;
	m_dfltFontHeight = fontHeight;
	resize(width, height);

	// Create program
	ANKI_CHECK(m_manager->getResourceManager().loadResource("Shaders/Ui.ankiprog", m_prog));

	for(U32 i = 0; i < SHADER_COUNT; ++i)
	{
		const ShaderProgramResourceVariant* variant;
		ShaderProgramResourceVariantInitInfo variantInitInfo(m_prog);
		variantInitInfo.addMutation("TEXTURE_TYPE", i);
		m_prog->getOrCreateVariant(variantInitInfo, variant);
		m_grProgs[i] = variant->getProgram();
	}

	// Sampler
	SamplerInitInfo samplerInit("Canvas");
	samplerInit.m_minMagFilter = SamplingFilter::LINEAR;
	samplerInit.m_mipmapFilter = SamplingFilter::LINEAR;
	samplerInit.m_addressing = SamplingAddressing::REPEAT;
	m_linearLinearRepeatSampler = m_manager->getGrManager().newSampler(samplerInit);

	samplerInit.m_minMagFilter = SamplingFilter::NEAREST;
	samplerInit.m_mipmapFilter = SamplingFilter::NEAREST;
	m_nearestNearestRepeatSampler = m_manager->getGrManager().newSampler(samplerInit);

	// Allocator
	m_stackAlloc = StackAllocator<U8>(getAllocator().getMemoryPool().getAllocationCallback(),
									  getAllocator().getMemoryPool().getAllocationCallbackUserData(), 512_B);

	// Create the context
	setImAllocator();
	m_imCtx = ImGui::CreateContext(font->getImFontAtlas());
	ImGui::SetCurrentContext(m_imCtx);
	ImGui::GetIO().IniFilename = nullptr;
	ImGui::GetIO().LogFilename = nullptr;
	ImGui::StyleColorsLight();

#define ANKI_HANDLE(ak, im) ImGui::GetIO().KeyMap[im] = static_cast<int>(ak);

	ANKI_HANDLE(KeyCode::TAB, ImGuiKey_Tab)
	ANKI_HANDLE(KeyCode::LEFT, ImGuiKey_LeftArrow)
	ANKI_HANDLE(KeyCode::RIGHT, ImGuiKey_RightArrow)
	ANKI_HANDLE(KeyCode::UP, ImGuiKey_UpArrow)
	ANKI_HANDLE(KeyCode::DOWN, ImGuiKey_DownArrow)
	ANKI_HANDLE(KeyCode::PAGEUP, ImGuiKey_PageUp)
	ANKI_HANDLE(KeyCode::PAGEDOWN, ImGuiKey_PageDown)
	ANKI_HANDLE(KeyCode::HOME, ImGuiKey_Home)
	ANKI_HANDLE(KeyCode::END, ImGuiKey_End)
	ANKI_HANDLE(KeyCode::INSERT, ImGuiKey_Insert)
	ANKI_HANDLE(KeyCode::DELETE, ImGuiKey_Delete)
	ANKI_HANDLE(KeyCode::BACKSPACE, ImGuiKey_Backspace)
	ANKI_HANDLE(KeyCode::SPACE, ImGuiKey_Space)
	ANKI_HANDLE(KeyCode::RETURN, ImGuiKey_Enter)
	// ANKI_HANDLE(KeyCode::RETURN2, ImGuiKey_Enter)
	ANKI_HANDLE(KeyCode::ESCAPE, ImGuiKey_Escape)
	ANKI_HANDLE(KeyCode::A, ImGuiKey_A)
	ANKI_HANDLE(KeyCode::C, ImGuiKey_C)
	ANKI_HANDLE(KeyCode::V, ImGuiKey_V)
	ANKI_HANDLE(KeyCode::X, ImGuiKey_X)
	ANKI_HANDLE(KeyCode::Y, ImGuiKey_Y)
	ANKI_HANDLE(KeyCode::Z, ImGuiKey_Z)

#undef ANKI_HANDLE

	ImGui::SetCurrentContext(nullptr);
	unsetImAllocator();

	return Error::NONE;
}

void Canvas::handleInput()
{
	const Input& in = m_manager->getInput();

	// Begin
	setImAllocator();
	ImGui::SetCurrentContext(m_imCtx);
	ImGuiIO& io = ImGui::GetIO();

	// Handle mouse
	Array<U32, 4> viewport = {0, 0, m_width, m_height};
	Vec2 mousePosf = in.getMousePosition() / 2.0f + 0.5f;
	mousePosf.y() = 1.0f - mousePosf.y();
	const UVec2 mousePos(U32(mousePosf.x() * F32(viewport[2])), U32(mousePosf.y() * F32(viewport[3])));

	io.MousePos.x = F32(mousePos.x());
	io.MousePos.y = F32(mousePos.y());

	io.MouseClicked[0] = in.getMouseButton(MouseButton::LEFT) == 1;
	io.MouseDown[0] = in.getMouseButton(MouseButton::LEFT) > 0;

	if(in.getMouseButton(MouseButton::SCROLL_UP) == 1)
	{
		io.MouseWheel = F32(in.getMouseButton(MouseButton::SCROLL_UP));
	}
	else if(in.getMouseButton(MouseButton::SCROLL_DOWN) == 1)
	{
		io.MouseWheel = -F32(in.getMouseButton(MouseButton::SCROLL_DOWN));
	}

	io.KeyCtrl = (in.getKey(KeyCode::LCTRL) || in.getKey(KeyCode::RCTRL));

// Handle keyboard
#define ANKI_HANDLE(ak) io.KeysDown[static_cast<int>(ak)] = (in.getKey(ak) == 1);

	ANKI_HANDLE(KeyCode::TAB)
	ANKI_HANDLE(KeyCode::LEFT)
	ANKI_HANDLE(KeyCode::RIGHT)
	ANKI_HANDLE(KeyCode::UP)
	ANKI_HANDLE(KeyCode::DOWN)
	ANKI_HANDLE(KeyCode::PAGEUP)
	ANKI_HANDLE(KeyCode::PAGEDOWN)
	ANKI_HANDLE(KeyCode::HOME)
	ANKI_HANDLE(KeyCode::END)
	ANKI_HANDLE(KeyCode::INSERT)
	ANKI_HANDLE(KeyCode::DELETE)
	ANKI_HANDLE(KeyCode::BACKSPACE)
	ANKI_HANDLE(KeyCode::SPACE)
	ANKI_HANDLE(KeyCode::RETURN)
	// ANKI_HANDLE(KeyCode::RETURN2)
	ANKI_HANDLE(KeyCode::ESCAPE)
	ANKI_HANDLE(KeyCode::A)
	ANKI_HANDLE(KeyCode::C)
	ANKI_HANDLE(KeyCode::V)
	ANKI_HANDLE(KeyCode::X)
	ANKI_HANDLE(KeyCode::Y)
	ANKI_HANDLE(KeyCode::Z)

#undef ANKI_HANDLE

	io.AddInputCharactersUTF8(in.getTextInput().cstr());

	// End
	ImGui::SetCurrentContext(nullptr);
	unsetImAllocator();
}

void Canvas::beginBuilding()
{
	setImAllocator();
	ImGui::SetCurrentContext(m_imCtx);

	ImGuiIO& io = ImGui::GetIO();
	io.DeltaTime = 1.0f / 60.0f;
	io.DisplaySize = ImVec2(F32(m_width), F32(m_height));

	ImGui::NewFrame();
	ImGui::PushFont(&m_font->getImFont(m_dfltFontHeight));
}

void Canvas::pushFont(const FontPtr& font, U32 fontHeight)
{
	m_references.pushBack(m_stackAlloc, IntrusivePtr<UiObject>(const_cast<Font*>(font.get())));
	ImGui::PushFont(&font->getImFont(fontHeight));
}

void Canvas::appendToCommandBuffer(CommandBufferPtr cmdb)
{
	appendToCommandBufferInternal(cmdb);

	// Done
	ImGui::SetCurrentContext(nullptr);

	m_references.destroy(m_stackAlloc);
	m_stackAlloc.getMemoryPool().reset();
}

void Canvas::appendToCommandBufferInternal(CommandBufferPtr& cmdb)
{
	ImGui::PopFont();
	ImGui::Render();
	ImDrawData& drawData = *ImGui::GetDrawData();

	// Allocate index and vertex buffers
	StagingGpuMemoryToken vertsToken, indicesToken;
	{
		const U32 verticesSize = U32(drawData.TotalVtxCount) * sizeof(ImDrawVert);
		const U32 indicesSize = U32(drawData.TotalIdxCount) * sizeof(ImDrawIdx);

		if(verticesSize == 0 || indicesSize == 0)
		{
			return;
		}

		ImDrawVert* verts = static_cast<ImDrawVert*>(m_manager->getStagingGpuMemoryManager().allocateFrame(
			verticesSize, StagingGpuMemoryType::VERTEX, vertsToken));
		ImDrawIdx* indices = static_cast<ImDrawIdx*>(m_manager->getStagingGpuMemoryManager().allocateFrame(
			indicesSize, StagingGpuMemoryType::VERTEX, indicesToken));

		for(I n = 0; n < drawData.CmdListsCount; ++n)
		{
			const ImDrawList& cmdList = *drawData.CmdLists[n];
			memcpy(verts, cmdList.VtxBuffer.Data, cmdList.VtxBuffer.Size * sizeof(ImDrawVert));
			memcpy(indices, cmdList.IdxBuffer.Data, cmdList.IdxBuffer.Size * sizeof(ImDrawIdx));
			verts += cmdList.VtxBuffer.Size;
			indices += cmdList.IdxBuffer.Size;
		}
	}

	cmdb->setBlendFactors(0, BlendFactor::SRC_ALPHA, BlendFactor::ONE_MINUS_SRC_ALPHA);
	cmdb->setCullMode(FaceSelectionBit::NONE);

	const F32 fbWidth = drawData.DisplaySize.x * drawData.FramebufferScale.x;
	const F32 fbHeight = drawData.DisplaySize.y * drawData.FramebufferScale.y;
	cmdb->setViewport(0, 0, U32(fbWidth), U32(fbHeight));

	cmdb->bindVertexBuffer(0, vertsToken.m_buffer, vertsToken.m_offset, sizeof(ImDrawVert));
	cmdb->setVertexAttribute(0, 0, Format::R32G32_SFLOAT, 0);
	cmdb->setVertexAttribute(1, 0, Format::R8G8B8A8_UNORM, sizeof(Vec2) * 2);
	cmdb->setVertexAttribute(2, 0, Format::R32G32_SFLOAT, sizeof(Vec2));

	cmdb->bindIndexBuffer(indicesToken.m_buffer, indicesToken.m_offset, IndexType::U16);

	// Will project scissor/clipping rectangles into framebuffer space
	const Vec2 clipOff = drawData.DisplayPos; // (0,0) unless using multi-viewports
	const Vec2 clipScale = drawData.FramebufferScale; // (1,1) unless using retina display which are often (2,2)

	// Render
	U32 vertOffset = 0;
	U32 idxOffset = 0;
	DrawingState state;
	for(I32 n = 0; n < drawData.CmdListsCount; n++)
	{
		const ImDrawList& cmdList = *drawData.CmdLists[n];
		for(I32 i = 0; i < cmdList.CmdBuffer.Size; i++)
		{
			const ImDrawCmd& pcmd = cmdList.CmdBuffer[i];
			if(pcmd.UserCallback)
			{
				// User callback (registered via ImDrawList::AddCallback)
				CustomCommand* userCmd = static_cast<CustomCommand*>(pcmd.UserCallbackData);
				(*userCmd)(state);
				m_stackAlloc.deleteInstance(userCmd);
			}
			else
			{
				// Project scissor/clipping rectangles into framebuffer space. Flip Y
				Vec4 clipRect;
				clipRect.x() = (pcmd.ClipRect.x - clipOff.x()) * clipScale.x();
				clipRect.y() = (fbHeight - pcmd.ClipRect.w - clipOff.y()) * clipScale.y();
				clipRect.z() = (pcmd.ClipRect.z - clipOff.x()) * clipScale.x();
				clipRect.w() = (fbHeight - pcmd.ClipRect.y - clipOff.y()) * clipScale.y();

				if(clipRect.x() < fbWidth && clipRect.y() < fbHeight && clipRect.z() >= 0.0f && clipRect.w() >= 0.0f)
				{
					// Negative offsets are illegal for vkCmdSetScissor
					if(clipRect.x() < 0.0f)
					{
						clipRect.x() = 0.0f;
					}
					if(clipRect.y() < 0.0f)
					{
						clipRect.y() = 0.0f;
					}

					// Apply scissor/clipping rectangle
					cmdb->setScissor(U32(clipRect.x()), U32(clipRect.y()), U32(clipRect.z() - clipRect.x()),
									 U32(clipRect.w() - clipRect.y()));

					// Program
					if(state.m_program.isCreated())
					{
						cmdb->bindShaderProgram(state.m_program);
					}
					else if(pcmd.TextureId)
					{
						cmdb->bindShaderProgram(m_grProgs[RGBA_TEX]);
					}
					else
					{
						cmdb->bindShaderProgram(m_grProgs[NO_TEX]);
					}

					// Bindings
					if(pcmd.TextureId)
					{
						UiImageId id(pcmd.TextureId);
						TextureViewPtr view(numberToPtr<TextureView*>(id.m_bits.m_textureViewPtr));

						cmdb->bindSampler(0, 0,
										  (id.m_bits.m_pointSampling) ? m_nearestNearestRepeatSampler
																	  : m_linearLinearRepeatSampler);
						cmdb->bindTexture(0, 1, view);
					}

					// Push constants
					class PC
					{
					public:
						Vec4 m_transform;
						Array<U8, sizeof(DrawingState::m_extraPushConstants)> m_extra;
					} pc;
					pc.m_transform.x() = 2.0f / drawData.DisplaySize.x;
					pc.m_transform.y() = -2.0f / drawData.DisplaySize.y;
					pc.m_transform.z() = (drawData.DisplayPos.x / drawData.DisplaySize.x) * 2.0f - 1.0f;
					pc.m_transform.w() = -((drawData.DisplayPos.y / drawData.DisplaySize.y) * 2.0f - 1.0f);
					if(state.m_extraPushConstantSize)
					{
						memcpy(&pc.m_extra[0], &state.m_extraPushConstants[0], state.m_extraPushConstantSize);
					}
					cmdb->setPushConstants(&pc, sizeof(Vec4) + state.m_extraPushConstantSize);

					// Draw
					cmdb->drawElements(PrimitiveTopology::TRIANGLES, pcmd.ElemCount, 1, idxOffset, vertOffset);
				}
			}
			idxOffset += pcmd.ElemCount;
		}
		vertOffset += cmdList.VtxBuffer.Size;
	}

	// Restore state
	cmdb->setBlendFactors(0, BlendFactor::ONE, BlendFactor::ZERO);
	cmdb->setCullMode(FaceSelectionBit::BACK);
}

void Canvas::setShaderProgram(ShaderProgramPtr program, const void* extraPushConstants, U32 extraPushConstantSize)
{
	class Command : public CustomCommand
	{
	public:
		ShaderProgramPtr m_prog;
		Array<U8, sizeof(DrawingState::m_extraPushConstants)> m_extraPushConstants;
		U32 m_extraPushConstantSize;

		void operator()(DrawingState& state) override
		{
			state.m_program = m_prog;
			if(m_extraPushConstantSize)
			{
				ANKI_ASSERT(m_extraPushConstantSize <= sizeof(m_extraPushConstants));
				memcpy(&state.m_extraPushConstants[0], &m_extraPushConstants[0], m_extraPushConstantSize);
			}
			state.m_extraPushConstantSize = m_extraPushConstantSize;
		}
	};

	Command* newcmd = m_stackAlloc.newInstance<Command>();
	newcmd->m_prog = program;
	if(extraPushConstantSize)
	{
		ANKI_ASSERT(extraPushConstants);
		memcpy(&newcmd->m_extraPushConstants[0], extraPushConstants, extraPushConstantSize);
		newcmd->m_extraPushConstantSize = extraPushConstantSize;
	}
	else
	{
		newcmd->m_extraPushConstantSize = 0;
	}

	ImGui::GetWindowDrawList()->AddCallback(
		[](const ImDrawList* list, const ImDrawCmd* cmd) {
			// Do nothing, only care about the user data
		},
		newcmd);
}

} // end namespace anki