quakeforge/libs/video/renderer/vid_render_vulkan.c

/*
	vid_render_vulkan.c

	Vulkan version of the renderer

	Copyright (C) 2019 Bill Currie <bill@taniwha.org>

	This program is free software; you can redistribute it and/or
	modify it under the terms of the GNU General Public License
	as published by the Free Software Foundation; either version 2
	of the License, or (at your option) any later version.

	This program is distributed in the hope that it will be useful,
	but WITHOUT ANY WARRANTY; without even the implied warranty of
	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.

	See the GNU General Public License for more details.

	You should have received a copy of the GNU General Public License
	along with this program; if not, write to:

		Free Software Foundation, Inc.
		59 Temple Place - Suite 330
		Boston, MA  02111-1307, USA

*/
#ifdef HAVE_CONFIG_H
# include "config.h"
#endif

#include <stdlib.h>
#include <string.h>

#include "QF/cvar.h"
#include "QF/darray.h"
#include "QF/dstring.h"
#include "QF/quakefs.h"
#include "QF/sys.h"
#include "QF/va.h"

#include "QF/plugin/general.h"
#include "QF/plugin/vid_render.h"

#include "QF/Vulkan/qf_alias.h"
#include "QF/Vulkan/qf_bsp.h"
#include "QF/Vulkan/qf_compose.h"
#include "QF/Vulkan/qf_draw.h"
#include "QF/Vulkan/qf_iqm.h"
#include "QF/Vulkan/qf_lighting.h"
#include "QF/Vulkan/qf_lightmap.h"
#include "QF/Vulkan/qf_main.h"
#include "QF/Vulkan/qf_matrices.h"
#include "QF/Vulkan/qf_palette.h"
#include "QF/Vulkan/qf_particles.h"
#include "QF/Vulkan/qf_renderpass.h"
#include "QF/Vulkan/qf_scene.h"
#include "QF/Vulkan/qf_sprite.h"
#include "QF/Vulkan/qf_texture.h"
#include "QF/Vulkan/qf_vid.h"
#include "QF/Vulkan/capture.h"
#include "QF/Vulkan/command.h"
#include "QF/Vulkan/debug.h"
#include "QF/Vulkan/device.h"
#include "QF/Vulkan/image.h"
#include "QF/Vulkan/instance.h"
#include "QF/Vulkan/projection.h"
#include "QF/Vulkan/staging.h"
#include "QF/Vulkan/swapchain.h"
#include "QF/ui/view.h"

#include "QF/scene/entity.h"
#include "QF/scene/scene.h"

#include "mod_internal.h"
#include "r_internal.h"
#include "vid_internal.h"
#include "vid_vulkan.h"

static vulkan_ctx_t *vulkan_ctx;

static struct psystem_s *
vulkan_ParticleSystem (void)
{
	return Vulkan_ParticleSystem (vulkan_ctx);
}

static void
vulkan_R_Init (void)
{
	Vulkan_CreateStagingBuffers (vulkan_ctx);
	Vulkan_CreateFrames (vulkan_ctx);
	Vulkan_Texture_Init (vulkan_ctx);
	Vulkan_Palette_Init (vulkan_ctx, vid.palette);

	Vulkan_CreateSwapchain (vulkan_ctx);
	Vulkan_CreateCapture (vulkan_ctx);
	Vulkan_CreateRenderPasses (vulkan_ctx);

	Vulkan_Matrix_Init (vulkan_ctx);
	Vulkan_Scene_Init (vulkan_ctx);
	Vulkan_Alias_Init (vulkan_ctx);
	Vulkan_Bsp_Init (vulkan_ctx);
	Vulkan_IQM_Init (vulkan_ctx);
	Vulkan_Particles_Init (vulkan_ctx);
	Vulkan_Sprite_Init (vulkan_ctx);
	Vulkan_Draw_Init (vulkan_ctx);
	Vulkan_Lighting_Init (vulkan_ctx);
	Vulkan_Compose_Init (vulkan_ctx);

	Skin_Init ();

	SCR_Init ();
}

static void
vulkan_R_ClearState (void)
{
	QFV_DeviceWaitIdle (vulkan_ctx->device);
	r_refdef.worldmodel = 0;
	R_ClearDlights ();
	R_ClearParticles ();
	Vulkan_LoadLights (0, vulkan_ctx);
}

static void
vulkan_R_LoadSkys (const char *skyname)
{
	Vulkan_LoadSkys (skyname, vulkan_ctx);
}

static void
vulkan_R_NewScene (scene_t *scene)
{
	Vulkan_NewScene (scene, vulkan_ctx);
}

static void
vulkan_R_LineGraph (int x, int y, int *h_vals, int count, int height)
{
	Vulkan_LineGraph (x, y, h_vals, count, height, vulkan_ctx);
}

static void
vulkan_Draw_CharBuffer (int x, int y, draw_charbuffer_t *buffer)
{
	Vulkan_Draw_CharBuffer (x, y, buffer, vulkan_ctx);
}

static void
vulkan_Draw_SetScale (int scale)
{
	vulkan_ctx->twod_scale = max (1, scale);
}

static void
vulkan_Draw_Character (int x, int y, unsigned ch)
{
	Vulkan_Draw_Character (x, y, ch, vulkan_ctx);
}

static void
vulkan_Draw_String (int x, int y, const char *str)
{
	Vulkan_Draw_String (x, y, str, vulkan_ctx);
}

static void
vulkan_Draw_nString (int x, int y, const char *str, int count)
{
	Vulkan_Draw_nString (x, y, str, count, vulkan_ctx);
}

static void
vulkan_Draw_AltString (int x, int y, const char *str)
{
	Vulkan_Draw_AltString (x, y, str, vulkan_ctx);
}

static void
vulkan_Draw_ConsoleBackground (int lines, byte alpha)
{
	Vulkan_Draw_ConsoleBackground (lines, alpha, vulkan_ctx);
}

static void
vulkan_Draw_Crosshair (void)
{
	Vulkan_Draw_Crosshair (vulkan_ctx);
}

static void
vulkan_Draw_CrosshairAt (int ch, int x, int y)
{
	Vulkan_Draw_CrosshairAt (ch, x, y, vulkan_ctx);
}

static void
vulkan_Draw_TileClear (int x, int y, int w, int h)
{
	Vulkan_Draw_TileClear (x, y, w, h, vulkan_ctx);
}

static void
vulkan_Draw_Fill (int x, int y, int w, int h, int c)
{
	Vulkan_Draw_Fill (x, y, w, h, c, vulkan_ctx);
}

static void
vulkan_Draw_Line (int x0, int y0, int x1, int y1, int c)
{
	Vulkan_Draw_Line (x0, y0, x1, y1, c, vulkan_ctx);
}

static void
vulkan_Draw_TextBox (int x, int y, int width, int lines, byte alpha)
{
	Vulkan_Draw_TextBox (x, y, width, lines, alpha, vulkan_ctx);
}

static void
vulkan_Draw_FadeScreen (void)
{
	Vulkan_Draw_FadeScreen (vulkan_ctx);
}

static void
vulkan_Draw_BlendScreen (quat_t color)
{
	Vulkan_Draw_BlendScreen (color, vulkan_ctx);
}

static qpic_t *
vulkan_Draw_CachePic (const char *path, qboolean alpha)
{
	return Vulkan_Draw_CachePic (path, alpha, vulkan_ctx);
}

static void
vulkan_Draw_UncachePic (const char *path)
{
	Vulkan_Draw_UncachePic (path, vulkan_ctx);
}

static qpic_t *
vulkan_Draw_MakePic (int width, int height, const byte *data)
{
	return Vulkan_Draw_MakePic (width, height, data, vulkan_ctx);
}

static void
vulkan_Draw_DestroyPic (qpic_t *pic)
{
	Vulkan_Draw_DestroyPic (pic, vulkan_ctx);
}

static qpic_t *
vulkan_Draw_PicFromWad (const char *name)
{
	return Vulkan_Draw_PicFromWad (name, vulkan_ctx);
}

static void
vulkan_Draw_Pic (int x, int y, qpic_t *pic)
{
	Vulkan_Draw_Pic (x, y, pic, vulkan_ctx);
}

static void
vulkan_Draw_Picf (float x, float y, qpic_t *pic)
{
	Vulkan_Draw_Picf (x, y, pic, vulkan_ctx);
}

static void
vulkan_Draw_SubPic (int x, int y, qpic_t *pic, int srcx, int srcy, int width, int height)
{
	Vulkan_Draw_SubPic (x, y, pic, srcx, srcy, width, height, vulkan_ctx);
}

static int
vulkan_Draw_AddFont (struct rfont_s *font)
{
	return Vulkan_Draw_AddFont (font, vulkan_ctx);
}

static void
vulkan_Draw_FontString (int x, int y, int fontid, const char *str)
{
	Vulkan_Draw_FontString (x, y, fontid, str, vulkan_ctx);
}

static void
vulkan_begin_frame (void)
{
	uint32_t imageIndex = 0;
	qfv_device_t *device = vulkan_ctx->device;
	qfv_devfuncs_t *dfunc = device->funcs;
	VkDevice    dev = device->dev;

	__auto_type frame = &vulkan_ctx->frames.a[vulkan_ctx->curFrame];

	dfunc->vkWaitForFences (dev, 1, &frame->fence, VK_TRUE, 2000000000);
	if (!QFV_AcquireNextImage (vulkan_ctx->swapchain,
							   frame->imageAvailableSemaphore,
							   0, &imageIndex)) {
		QFV_DeviceWaitIdle (device);
		if (vulkan_ctx->capture) {
			QFV_DestroyCapture (vulkan_ctx->capture);
		}
		Vulkan_CreateSwapchain (vulkan_ctx);
		Vulkan_CreateCapture (vulkan_ctx);

		//FIXME
		qfv_output_t output = {
			.extent    = vulkan_ctx->swapchain->extent,
			.view      = vulkan_ctx->swapchain->imageViews->a[0],
			.format    = vulkan_ctx->swapchain->format,
			.view_list = vulkan_ctx->swapchain->imageViews->a,
		};
		vulkan_ctx->main_renderpass->viewport.width = output.extent.width;
		vulkan_ctx->main_renderpass->viewport.height = output.extent.height;
		vulkan_ctx->main_renderpass->scissor.extent = output.extent;
		vulkan_ctx->output = output;
		Vulkan_CreateAttachments (vulkan_ctx, vulkan_ctx->main_renderpass);
		QFV_AcquireNextImage (vulkan_ctx->swapchain,
								   frame->imageAvailableSemaphore,
								   0, &imageIndex);
	}
	vulkan_ctx->swapImageIndex = imageIndex;
}

static void
vulkan_render_view (void)
{
	uint32_t imageIndex = vulkan_ctx->swapImageIndex;

	for (size_t i = 0; i < vulkan_ctx->renderPasses.size; i++) {
		__auto_type rp = vulkan_ctx->renderPasses.a[i];
		__auto_type rpFrame = &rp->frames.a[vulkan_ctx->curFrame];
		if (rp->framebuffers) {
			rpFrame->framebuffer = rp->framebuffers->a[imageIndex];
		}
		rp->draw (rpFrame);
	}
}

static void
vulkan_draw_particles (struct psystem_s *psystem)
{
}

static void
vulkan_draw_transparent (void)
{
}

static void
vulkan_post_process (framebuffer_t *src)
{
}

static void
vulkan_set_2d (int scaled)
{
	//FIXME this should not be done every frame
	__auto_type mctx = vulkan_ctx->matrix_context;
	__auto_type mat = &mctx->matrices;
	int         scale = vulkan_ctx->twod_scale;

	float       left = 0;
	float       top = 0;
	float       right = left + vid.width / scale;
	float       bottom = top + vid.height / scale;
	QFV_Orthographic (mat->Projection2d, left, right, top, bottom, 0, 99999);

	mctx->dirty = mctx->frames.size;
}

static void
vulkan_end_frame (void)
{
	qfv_device_t *device = vulkan_ctx->device;
	VkDevice    dev = device->dev;
	qfv_devfuncs_t *dfunc = device->funcs;
	qfv_queue_t *queue = &device->queue;
	uint32_t    curFrame = vulkan_ctx->curFrame;
	__auto_type frame = &vulkan_ctx->frames.a[curFrame];
	uint32_t    imageIndex = vulkan_ctx->swapImageIndex;

	VkCommandBufferBeginInfo beginInfo
		= { VK_STRUCTURE_TYPE_COMMAND_BUFFER_BEGIN_INFO };

	VkRenderPassBeginInfo renderPassInfo = {
		.sType = VK_STRUCTURE_TYPE_RENDER_PASS_BEGIN_INFO,
		.renderArea = { {0, 0}, vulkan_ctx->swapchain->extent },
	};

	__auto_type cmdBufs = (qfv_cmdbufferset_t) DARRAY_STATIC_INIT (4);
	DARRAY_APPEND (&cmdBufs, frame->cmdBuffer);

	dfunc->vkBeginCommandBuffer (frame->cmdBuffer, &beginInfo);
	for (size_t i = 0; i < vulkan_ctx->renderPasses.size; i++) {
		__auto_type rp = vulkan_ctx->renderPasses.a[i];
		__auto_type rpFrame = &rp->frames.a[curFrame];

		if (rp->primary_commands) {
			for (int j = 0; j < rpFrame->subpassCount; j++) {
				__auto_type cmdSet = &rpFrame->subpassCmdSets[j];
				size_t      base = cmdBufs.size;
				DARRAY_RESIZE (&cmdBufs, base + cmdSet->size);
				memcpy (&cmdBufs.a[base], cmdSet->a,
						cmdSet->size * sizeof (VkCommandBuffer));
			}
			continue;
		}

		QFV_CmdBeginLabel (device, frame->cmdBuffer, rp->name, rp->color);
		if (rpFrame->renderpass && rp->renderpass) {
			renderPassInfo.framebuffer = rp->framebuffers->a[imageIndex];
			renderPassInfo.renderPass = rp->renderpass;
			renderPassInfo.clearValueCount = rp->clearValues->size;
			renderPassInfo.pClearValues = rp->clearValues->a;

			dfunc->vkCmdBeginRenderPass (frame->cmdBuffer, &renderPassInfo,
										 rpFrame->subpassContents);

			for (int j = 0; j < rpFrame->subpassCount; j++) {
				__auto_type cmdSet = &rpFrame->subpassCmdSets[j];
				if (cmdSet->size) {
					QFV_CmdBeginLabel (device, frame->cmdBuffer,
									   rpFrame->subpassInfo[j].name,
									   rpFrame->subpassInfo[j].color);
					dfunc->vkCmdExecuteCommands (frame->cmdBuffer,
												 cmdSet->size, cmdSet->a);
					QFV_CmdEndLabel (device, frame->cmdBuffer);
				}
				// reset for next time around
				cmdSet->size = 0;

				//Regardless of whether any commands were submitted for this
				//subpass, must step through each and every subpass, otherwise
				//the attachments won't be transitioned correctly.
				if (j < rpFrame->subpassCount - 1) {
					dfunc->vkCmdNextSubpass (frame->cmdBuffer,
											 rpFrame->subpassContents);
				}
			}
			dfunc->vkCmdEndRenderPass (frame->cmdBuffer);
		} else {
			for (int j = 0; j < rpFrame->subpassCount; j++) {
				__auto_type cmdSet = &rpFrame->subpassCmdSets[j];
				if (cmdSet->size) {
					dfunc->vkCmdExecuteCommands (frame->cmdBuffer,
												 cmdSet->size, cmdSet->a);
				}
				// reset for next time around
				cmdSet->size = 0;
			}
		}
		QFV_CmdEndLabel (device, frame->cmdBuffer);
	}

	if (vulkan_ctx->capture_callback) {
		VkImage     srcImage = vulkan_ctx->swapchain->images->a[imageIndex];
		VkCommandBuffer cmd = QFV_CaptureImage (vulkan_ctx->capture, srcImage,
												curFrame);
		dfunc->vkCmdExecuteCommands (frame->cmdBuffer, 1, &cmd);
	}
	dfunc->vkEndCommandBuffer (frame->cmdBuffer);

	VkPipelineStageFlags waitStage
		= VK_PIPELINE_STAGE_COLOR_ATTACHMENT_OUTPUT_BIT;
	VkSubmitInfo submitInfo = {
		VK_STRUCTURE_TYPE_SUBMIT_INFO, 0,
		1, &frame->imageAvailableSemaphore, &waitStage,
		cmdBufs.size, cmdBufs.a,
		1, &frame->renderDoneSemaphore,
	};
	dfunc->vkResetFences (dev, 1, &frame->fence);
	dfunc->vkQueueSubmit (queue->queue, 1, &submitInfo, frame->fence);

	DARRAY_CLEAR (&cmdBufs);

	if (vulkan_ctx->capture_callback) {
		//FIXME look into "threading" this rather than waiting here
		dfunc->vkWaitForFences (device->dev, 1, &frame->fence, VK_TRUE,
								1000000000ull);
		vulkan_ctx->capture_callback (QFV_CaptureData (vulkan_ctx->capture,
													   curFrame),
									  vulkan_ctx->capture->extent.width,
									  vulkan_ctx->capture->extent.height);
		vulkan_ctx->capture_callback = 0;
	}

	VkPresentInfoKHR presentInfo = {
		VK_STRUCTURE_TYPE_PRESENT_INFO_KHR, 0,
		1, &frame->renderDoneSemaphore,
		1, &vulkan_ctx->swapchain->swapchain, &imageIndex,
		0
	};
	dfunc->vkQueuePresentKHR (queue->queue, &presentInfo);

	vulkan_ctx->curFrame++;
	vulkan_ctx->curFrame %= vulkan_ctx->frames.size;
}

static framebuffer_t *
vulkan_create_cube_map (int size)
{
	return 0;
}

static framebuffer_t *
vulkan_create_frame_buffer (int width, int height)
{
	return 0;
}

static void
vulkan_destroy_frame_buffer (framebuffer_t *framebuffer)
{
}

static void
vulkan_bind_framebuffer (framebuffer_t *framebuffer)
{
}

static void
vulkan_set_viewport (const vrect_t *view)
{
}

static void
vulkan_set_fov (float x, float y)
{
	if (!vulkan_ctx || !vulkan_ctx->matrix_context) {
		return;
	}
	__auto_type mctx = vulkan_ctx->matrix_context;
	__auto_type mat = &mctx->matrices;

	QFV_PerspectiveTan (mat->Projection3d, x, y);

	mctx->dirty = mctx->frames.size;
}

static int
is_bgr (VkFormat format)
{
	return (format >= VK_FORMAT_B8G8R8A8_UNORM
			&& format <= VK_FORMAT_B8G8R8A8_SRGB);
}

static void
capture_screenshot (const byte *data, int width, int height)
{
	int         count = width * height;
	tex_t      *tex = malloc (sizeof (tex_t) + count * 3);

	if (tex) {
		tex->data = (byte *) (tex + 1);
		tex->flagbits = 0;
		tex->width = width;
		tex->height = height;
		tex->format = tex_rgb;
		tex->palette = 0;
		tex->flagbits = 0;
		tex->loaded = 1;

		if (is_bgr (vulkan_ctx->swapchain->format)) {
			tex->bgr = 1;
		}
		const byte *src = data;
		byte       *dst = tex->data;
		for (int count = width * height; count-- > 0; ) {
			*dst++ = *src++;
			*dst++ = *src++;
			*dst++ = *src++;
			src++;
		}
	}
	capfunc_t   callback = vulkan_ctx->capture_complete;
	callback (tex, vulkan_ctx->capture_complete_data);;
}

static void
vulkan_capture_screen (capfunc_t callback, void *data)
{
	if (!vulkan_ctx->capture) {
		Sys_Printf ("Capture not supported\n");
		callback (0, data);
		return;
	}
	vulkan_ctx->capture_callback = capture_screenshot;
	vulkan_ctx->capture_complete = callback;
	vulkan_ctx->capture_complete_data = data;
}

static void
vulkan_Mod_LoadLighting (model_t *mod, bsp_t *bsp)
{
	Vulkan_Mod_LoadLighting (mod, bsp, vulkan_ctx);
}

static void
vulkan_Mod_SubdivideSurface (model_t *mod, msurface_t *fa)
{
}

static void
vulkan_Mod_ProcessTexture (model_t *mod, texture_t *tx)
{
	Vulkan_Mod_ProcessTexture (mod, tx, vulkan_ctx);
}

static void
vulkan_Mod_MakeAliasModelDisplayLists (mod_alias_ctx_t *alias_ctx,
									   void *_m, int _s, int extra)
{
	Vulkan_Mod_MakeAliasModelDisplayLists (alias_ctx, _m, _s, extra,
										   vulkan_ctx);
}

static void
vulkan_Mod_LoadAllSkins (mod_alias_ctx_t *alias_ctx)
{
	Vulkan_Mod_LoadAllSkins (alias_ctx, vulkan_ctx);
}

static void
vulkan_Mod_FinalizeAliasModel (mod_alias_ctx_t *alias_ctx)
{
	Vulkan_Mod_FinalizeAliasModel (alias_ctx, vulkan_ctx);
}

static void
vulkan_Mod_LoadExternalSkins (mod_alias_ctx_t *alias_ctx)
{
}

static void
vulkan_Mod_IQMFinish (model_t *mod)
{
	Vulkan_Mod_IQMFinish (mod, vulkan_ctx);
}

static void
vulkan_Mod_SpriteLoadFrames (mod_sprite_ctx_t *sprite_ctx)
{
	Vulkan_Mod_SpriteLoadFrames (sprite_ctx, vulkan_ctx);
}

static void
vulkan_Skin_SetupSkin (struct skin_s *skin, int cmap)
{
}

static void
vulkan_Skin_ProcessTranslation (int cmap, const byte *translation)
{
}

static void
vulkan_Skin_InitTranslations (void)
{
}

static void
set_palette (void *data, const byte *palette)
{
	if (vulkan_ctx->palette_context) {
		Vulkan_Palette_Update (vulkan_ctx, palette);
	}
}

static void
vulkan_vid_render_choose_visual (void *data)
{
	Vulkan_CreateDevice (vulkan_ctx);
	if (!vulkan_ctx->device) {
		Sys_Error ("Unable to create Vulkan device.%s",
				   vulkan_use_validation ? ""
					: "\nSet vulkan_use_validation for details");
	}
	vulkan_ctx->choose_visual (vulkan_ctx);
	vulkan_ctx->cmdpool = QFV_CreateCommandPool (vulkan_ctx->device,
									 vulkan_ctx->device->queue.queueFamily,
									 0, 1);
	Sys_MaskPrintf (SYS_vulkan, "vk choose visual %p %p %d %#zx\n",
					vulkan_ctx->device->dev, vulkan_ctx->device->queue.queue,
					vulkan_ctx->device->queue.queueFamily,
					(size_t) vulkan_ctx->cmdpool);
}

static void
vulkan_vid_render_create_context (void *data)
{
	vulkan_ctx->create_window (vulkan_ctx);
	vulkan_ctx->surface = vulkan_ctx->create_surface (vulkan_ctx);
	Sys_MaskPrintf (SYS_vulkan, "vk create context: surface:%#zx\n",
					(size_t) vulkan_ctx->surface);
}

static vid_model_funcs_t model_funcs = {
	.texture_render_size  = sizeof (vulktex_t) + 2 * sizeof (qfv_tex_t),

	.Mod_LoadLighting     = vulkan_Mod_LoadLighting,
	.Mod_SubdivideSurface = vulkan_Mod_SubdivideSurface,
	.Mod_ProcessTexture   = vulkan_Mod_ProcessTexture,

	.Mod_LoadIQM         = Mod_LoadIQM,
	.Mod_LoadAliasModel  = Mod_LoadAliasModel,
	.Mod_LoadSpriteModel = Mod_LoadSpriteModel,

	.Mod_MakeAliasModelDisplayLists = vulkan_Mod_MakeAliasModelDisplayLists,
	.Mod_LoadAllSkins               = vulkan_Mod_LoadAllSkins,
	.Mod_FinalizeAliasModel         = vulkan_Mod_FinalizeAliasModel,
	.Mod_LoadExternalSkins          = vulkan_Mod_LoadExternalSkins,
	.Mod_IQMFinish                  = vulkan_Mod_IQMFinish,
	.alias_cache                    = 0,
	.Mod_SpriteLoadFrames           = vulkan_Mod_SpriteLoadFrames,

	.Skin_Free               = Skin_Free,
	.Skin_SetColormap        = Skin_SetColormap,
	.Skin_SetSkin            = Skin_SetSkin,
	.Skin_SetupSkin          = vulkan_Skin_SetupSkin,
	.Skin_SetTranslation     = Skin_SetTranslation,
	.Skin_ProcessTranslation = vulkan_Skin_ProcessTranslation,
	.Skin_InitTranslations   = vulkan_Skin_InitTranslations,
};

static void
vulkan_vid_render_init (void)
{
	if (!vr_data.vid->vid_internal->vulkan_context) {
		Sys_Error ("Sorry, Vulkan not supported by this program.");
	}
	vulkan_ctx = vr_data.vid->vid_internal->vulkan_context ();
	vulkan_ctx->load_vulkan (vulkan_ctx);

	Vulkan_Init_Common (vulkan_ctx);

	vr_data.vid->vid_internal->data = vulkan_ctx;
	vr_data.vid->vid_internal->set_palette = set_palette;
	vr_data.vid->vid_internal->choose_visual = vulkan_vid_render_choose_visual;
	vr_data.vid->vid_internal->create_context = vulkan_vid_render_create_context;

	vr_funcs = &vulkan_vid_render_funcs;
	m_funcs = &model_funcs;
}

static void
vulkan_vid_render_shutdown (void)
{
	if (!vulkan_ctx || !vulkan_ctx->device) {
		return;
	}
	qfv_device_t *device = vulkan_ctx->device;
	qfv_devfuncs_t *df = device->funcs;
	VkDevice    dev = device->dev;
	QFV_DeviceWaitIdle (device);

	Mod_ClearAll ();

	Vulkan_Compose_Shutdown (vulkan_ctx);
	Vulkan_Lighting_Shutdown (vulkan_ctx);
	Vulkan_Draw_Shutdown (vulkan_ctx);
	Vulkan_Sprite_Shutdown (vulkan_ctx);
	Vulkan_Particles_Shutdown (vulkan_ctx);
	Vulkan_IQM_Shutdown (vulkan_ctx);
	Vulkan_Bsp_Shutdown (vulkan_ctx);
	Vulkan_Alias_Shutdown (vulkan_ctx);
	Vulkan_Scene_Shutdown (vulkan_ctx);
	Vulkan_Matrix_Shutdown (vulkan_ctx);

	Vulkan_Palette_Shutdown (vulkan_ctx);
	Vulkan_Texture_Shutdown (vulkan_ctx);
	Vulkan_DestroyRenderPasses (vulkan_ctx);

	QFV_DestroyStagingBuffer (vulkan_ctx->staging);
	df->vkDestroyCommandPool (dev, vulkan_ctx->cmdpool, 0);

	Vulkan_Shutdown_Common (vulkan_ctx);
}

vid_render_funcs_t vulkan_vid_render_funcs = {
	.init = vulkan_vid_render_init,

	.Draw_CharBuffer        = vulkan_Draw_CharBuffer,
	.Draw_SetScale          = vulkan_Draw_SetScale,
	.Draw_Character         = vulkan_Draw_Character,
	.Draw_String            = vulkan_Draw_String,
	.Draw_nString           = vulkan_Draw_nString,
	.Draw_AltString         = vulkan_Draw_AltString,
	.Draw_ConsoleBackground = vulkan_Draw_ConsoleBackground,
	.Draw_Crosshair         = vulkan_Draw_Crosshair,
	.Draw_CrosshairAt       = vulkan_Draw_CrosshairAt,
	.Draw_TileClear         = vulkan_Draw_TileClear,
	.Draw_Fill              = vulkan_Draw_Fill,
	.Draw_Line              = vulkan_Draw_Line,
	.Draw_TextBox           = vulkan_Draw_TextBox,
	.Draw_FadeScreen        = vulkan_Draw_FadeScreen,
	.Draw_BlendScreen       = vulkan_Draw_BlendScreen,
	.Draw_CachePic          = vulkan_Draw_CachePic,
	.Draw_UncachePic        = vulkan_Draw_UncachePic,
	.Draw_MakePic           = vulkan_Draw_MakePic,
	.Draw_DestroyPic        = vulkan_Draw_DestroyPic,
	.Draw_PicFromWad        = vulkan_Draw_PicFromWad,
	.Draw_Pic               = vulkan_Draw_Pic,
	.Draw_Picf              = vulkan_Draw_Picf,
	.Draw_SubPic            = vulkan_Draw_SubPic,
	.Draw_AddFont           = vulkan_Draw_AddFont,
	.Draw_FontString        = vulkan_Draw_FontString,

	.ParticleSystem   = vulkan_ParticleSystem,
	.R_Init           = vulkan_R_Init,
	.R_ClearState     = vulkan_R_ClearState,
	.R_LoadSkys       = vulkan_R_LoadSkys,
	.R_NewScene       = vulkan_R_NewScene,
	.R_LineGraph      = vulkan_R_LineGraph,
	.begin_frame      = vulkan_begin_frame,
	.render_view      = vulkan_render_view,
	.draw_particles   = vulkan_draw_particles,
	.draw_transparent = vulkan_draw_transparent,
	.post_process     = vulkan_post_process,
	.set_2d           = vulkan_set_2d,
	.end_frame        = vulkan_end_frame,

	.create_cube_map      = vulkan_create_cube_map,
	.create_frame_buffer  = vulkan_create_frame_buffer,
	.destroy_frame_buffer = vulkan_destroy_frame_buffer,
	.bind_framebuffer     = vulkan_bind_framebuffer,
	.set_viewport         = vulkan_set_viewport,
	.set_fov              = vulkan_set_fov,

	.capture_screen = vulkan_capture_screen,

	.model_funcs = &model_funcs
};

static general_funcs_t plugin_info_general_funcs = {
	.shutdown = vulkan_vid_render_shutdown,
};

static general_data_t plugin_info_general_data;

static plugin_funcs_t plugin_info_funcs = {
	.general = &plugin_info_general_funcs,
	.vid_render = &vulkan_vid_render_funcs,
};

static plugin_data_t plugin_info_data = {
	.general = &plugin_info_general_data,
	.vid_render = &vid_render_data,
};

static plugin_t plugin_info = {
	qfp_vid_render,
	0,
	QFPLUGIN_VERSION,
	"0.1",
	"Vulkan Renderer",
	"Copyright (C) 2019 Bill Currie <bill@taniwha.org>\n"
	"Please see the file \"AUTHORS\" for a list of contributors",
	&plugin_info_funcs,
	&plugin_info_data,
};

PLUGIN_INFO(vid_render, vulkan)
{
	return &plugin_info;
}