Vulkan Renderer openFrameworks

.gitignore

@@ -133,3 +133,4 @@ Desktop.ini
 
 .mailmap
 /apps*/
+openframeworksLib.vcxproj.user

.gitmodules

@@ -3,4 +3,4 @@
 	url = https://github.com/openframeworks/projectGenerator.git
 [submodule "scripts/apothecary"]
 	path = scripts/apothecary
-	url = https://github.com/openframeworks/apothecary
+	url = https://github.com/openframeworks-vk/apothecary.git 

README.md

@@ -1,3 +1,14 @@
+================
+
+# Experimental Vulkan Renderer branch 
+
+For mainline openFrameworks goto: 
+[https://github.com/openframeworks/openFrameworks](https://github.com/openframeworks/openFrameworks)
+
+Also take a look at the Vulkan specific README in [libs/openFrameworks/vk](https://github.com/openframeworks-vk/openFrameworks/tree/vk/libs/openFrameworks/vk)
+
+================
+
 [openFrameworks](http://openframeworks.cc/)
 ================
 
@@ -6,7 +17,6 @@ openFrameworks is a C++ toolkit for creative coding.  If you are new to OF, welc
 [![Slack Status](https://ofslack.herokuapp.com/badge.svg)](https://ofslack.herokuapp.com)
 
 Build status
---------
 
 Linux, OSX, iOS and Android     [![Build Status](https://travis-ci.org/openframeworks/openFrameworks.svg?branch=master)](https://travis-ci.org/openframeworks/openFrameworks)
 

apps/devApps/testVk/bin/data/default.frag

@@ -0,0 +1,33 @@
+#version 450 core
+
+#extension GL_ARB_separate_shader_objects : enable
+#extension GL_ARB_shading_language_420pack : enable
+
+layout (location = 0) in vec4 inColor;
+layout (location = 1) in vec3 inNormal;
+layout (location = 2) in vec2 inTexCoord;
+
+// uniforms (resources)
+layout (set = 0, binding = 0) uniform DefaultMatrices 
+{
+	mat4 projectionMatrix;
+	mat4 modelMatrix;
+	mat4 viewMatrix;
+};
+// layout (set = 1, binding = 0) uniform StyleSet
+// {
+// 	vec4 globalColor;
+// } style;
+
+
+layout (location = 0) out vec4 outFragColor;
+
+void main() 
+{
+
+  vec4 normalColor = vec4((inNormal + vec3(1.0)) * vec3(0.5) , 1.0);
+  vec4 vertexColor = inColor;
+
+  // set the actual fragment color here
+  outFragColor = vertexColor;
+}

apps/devApps/testVk/bin/data/default.vert

@@ -0,0 +1,43 @@
+#version 450 core
+
+#extension GL_ARB_separate_shader_objects : enable
+#extension GL_ARB_shading_language_420pack : enable
+
+// uniforms (resources)
+layout (set = 0, binding = 0) uniform DefaultMatrices 
+{
+	mat4 projectionMatrix;
+	mat4 modelMatrix;
+	mat4 viewMatrix;
+}; // note: if you don't specify a variable name for the block its elements will live in the global namespace.
+
+layout (set = 0, binding = 1) uniform Style
+{
+	vec4 globalColor;
+} style;
+
+// inputs (vertex attributes)
+layout (location = 0) in vec3 inPos;
+layout (location = 1) in vec4 inColor;
+layout (location = 2) in vec3 inNormal;
+layout (location = 3) in vec2 inTexCoord;
+
+// outputs 
+layout (location = 0) out vec4 outColor;
+layout (location = 1) out vec3 outNormal;
+layout (location = 2) out vec2 outTexCoord;
+
+// we override the built-in fixed function outputs
+// to have more control over the SPIR-V code created.
+out gl_PerVertex
+{
+    vec4 gl_Position;
+};
+
+void main() 
+{
+	outNormal    = (inverse(transpose( viewMatrix * modelMatrix)) * vec4(inNormal, 0.0)).xyz;
+	outColor     = style.globalColor;
+	outTexCoord = inTexCoord;
+	gl_Position  = projectionMatrix * viewMatrix * modelMatrix * vec4(inPos.xyz, 1.0);
+}

apps/devApps/testVk/bin/data/fullScreenQuad.frag

@@ -0,0 +1,14 @@
+#version 450 core
+
+#extension GL_ARB_separate_shader_objects : enable
+#extension GL_ARB_shading_language_420pack : enable
+
+// inputs 
+layout (location = 0) in vec2 inTexCoord;
+
+// outputs
+layout (location = 0) out vec4 outFragColor;
+
+void main(){
+	outFragColor = vec4(inTexCoord, 1, 1.0);
+}

apps/devApps/testVk/bin/data/fullScreenQuad.vert

@@ -0,0 +1,24 @@
+#version 450 core
+
+#extension GL_ARB_separate_shader_objects : enable
+#extension GL_ARB_shading_language_420pack : enable
+
+// outputs 
+layout (location = 0) out vec2 outTexCoord;
+
+// we override the built-in fixed function outputs
+// to have more control over the SPIR-V code created.
+out gl_PerVertex
+{
+    vec4 gl_Position;
+};
+
+// This shader built after a technique introduced in:
+// http://www.saschawillems.de/?page_id=2122
+
+void main() 
+{
+	outTexCoord = vec2((gl_VertexIndex << 1) & 2, gl_VertexIndex & 2);
+	gl_Position = vec4(outTexCoord * 2.0f + -1.0f, 0.0f, 1.0f);
+
+}

apps/devApps/testVk/icon.rc

@@ -0,0 +1,8 @@
+// Icon Resource Definition
+#define MAIN_ICON                       102
+
+#if defined(_DEBUG)
+MAIN_ICON               ICON                    "icon_debug.ico"
+#else
+MAIN_ICON               ICON                    "icon.ico"
+#endif

apps/devApps/testVk/src/main.cpp

@@ -0,0 +1,38 @@
+#include "ofMain.h"
+#include "ofApp.h"
+
+int main(){
+	// Do basic initialisation (mostly setup timers, and randseed)
+	ofInit();
+
+	auto consoleLogger = new ofConsoleLoggerChannel();
+	ofSetLoggerChannel( std::shared_ptr<ofBaseLoggerChannel>( consoleLogger, []( ofBaseLoggerChannel * lhs){} ) );
+
+	// Create a new window 
+	auto mainWindow = std::make_shared<ofAppGLFWWindow>();
+	//auto mainWindow = std::make_shared<ofAppVkNoWindow>();
+
+	// Store main window in mainloop
+	ofGetMainLoop()->addWindow( mainWindow );
+
+	{
+		ofVkWindowSettings settings;
+		settings.rendererSettings.setVkVersion( 1, 0, 46 );
+		settings.rendererSettings.numSwapchainImages = 3;
+		settings.rendererSettings.numVirtualFrames = 3;
+		settings.rendererSettings.presentMode = ::vk::PresentModeKHR::eMailbox;
+
+#ifdef NDEBUG
+		settings.rendererSettings.useDebugLayers = false;
+#else
+		settings.rendererSettings.useDebugLayers = true;
+#endif
+
+		// Initialise main window, and associated renderer.
+		mainWindow->setup( settings );
+}
+
+	// Initialise and start application
+	ofRunApp( new ofApp() );
+
+}

apps/devApps/testVk/src/ofApp.cpp

@@ -0,0 +1,159 @@
+#include "ofApp.h"
+#include "ofVkRenderer.h"
+
+// We keep a shared pointer to the renderer so we don't have to 
+// fetch it anew every time we need it.
+shared_ptr<ofVkRenderer> renderer;
+
+//--------------------------------------------------------------
+void ofApp::setup(){
+	ofDisableSetupScreen();
+
+	renderer = dynamic_pointer_cast<ofVkRenderer>( ofGetCurrentRenderer() );
+
+	{
+		// Set up a Draw Command which draws a full screen quad.
+		//
+		// This command uses the vertex shader to emit vertices, so 
+		// doesn't need any geometry to render. 
+
+		of::vk::Shader::Settings shaderSettings;
+
+		shaderSettings.device = renderer->getVkDevice();
+		shaderSettings.printDebugInfo = true;
+		shaderSettings.setSource(::vk::ShaderStageFlagBits::eVertex  ,"fullScreenQuad.vert");
+		shaderSettings.setSource(::vk::ShaderStageFlagBits::eFragment,"fullScreenQuad.frag");
+
+		mShaderFullscreen = std::make_shared<of::vk::Shader>( shaderSettings );
+
+		of::vk::GraphicsPipelineState pipeline;
+
+		pipeline.setShader( mShaderFullscreen );
+
+		// Our full screen quad needs to draw just the back face. This is due to 
+		// how we emit the vertices on the vertex shader. Since this differs from
+		// the default (back culling) behaviour, we have to set this explicitly.
+		pipeline.rasterizationState
+			.setCullMode( ::vk::CullModeFlagBits::eFront )
+			.setFrontFace( ::vk::FrontFace::eCounterClockwise );
+
+		// We don't care about depth testing when drawing the full screen quad. 
+		// It shall always cover the full screen.
+		pipeline.depthStencilState
+			.setDepthTestEnable( VK_FALSE )
+			.setDepthWriteEnable( VK_FALSE )
+			;
+		pipeline.blendAttachmentStates[0].blendEnable = VK_TRUE;
+
+		fullscreenQuad.setup( pipeline );
+
+		// As this draw command issues vertices on the vertex shader
+		// we must tell it how many vertices to render.
+		fullscreenQuad.setNumVertices( 3 );
+	}
+
+}
+
+//--------------------------------------------------------------
+void ofApp::update(){
+	ofSetWindowTitle( ofToString( ofGetFrameRate(), 10, ' ' ) );
+}
+
+//--------------------------------------------------------------
+void ofApp::draw(){
+
+	// Fetch the default context. This context is automatically
+	// set up upon app initialisation to draw to the swapchain.
+	auto & context = renderer->getDefaultContext();
+
+	// Batch is a light-weight helper object which encapsulates
+	// a Vulkan Command Buffer. The command buffer is associated 
+	// with the context it has been created from. As long as the 
+	// command buffer lives on the same thread as the context, and 
+	// only uses resources which are either global readonly static, 
+	// or resources which are temporarily allocated though the 
+	// context inside the context's thread, this is thread-safe. 
+
+	// setup the main pass renderbatch
+	//
+	of::vk::RenderBatch::Settings settings;
+
+	settings
+		.setContext(context.get())
+		.setFramebufferAttachmentsExtent(renderer->getSwapchain()->getWidth(), renderer->getSwapchain()->getHeight())
+		.setRenderAreaExtent(renderer->getViewportWidth(), renderer->getViewportHeight())
+		.setRenderPass(*renderer->getDefaultRenderpass())
+		.addFramebufferAttachment(context->getSwapchainImageView())
+		.addClearColorValue(ofFloatColor::blueSteel)
+		.addFramebufferAttachment(renderer->getDepthStencilImageView())
+		.addClearDepthStencilValue({ 1.f,0 })
+		;
+
+	of::vk::RenderBatch batch{ settings };
+
+	batch.begin();
+	batch.draw( fullscreenQuad );
+	batch.end();
+
+
+}
+
+//--------------------------------------------------------------
+void ofApp::keyPressed(int key){
+
+}
+
+//--------------------------------------------------------------
+void ofApp::keyReleased(int key){
+	if ( key == ' ' ){
+		// Recompile the full screen shader and 
+		// touch (force implicit re-creation of) any 
+		// associated pipelines.
+		mShaderFullscreen->compile();
+	}
+}
+
+//--------------------------------------------------------------
+void ofApp::mouseMoved(int x, int y ){
+
+}
+
+//--------------------------------------------------------------
+void ofApp::mouseDragged(int x, int y, int button){
+
+}
+
+//--------------------------------------------------------------
+void ofApp::mousePressed(int x, int y, int button){
+
+}
+
+//--------------------------------------------------------------
+void ofApp::mouseReleased(int x, int y, int button){
+
+}
+
+//--------------------------------------------------------------
+void ofApp::mouseEntered(int x, int y){
+
+}
+
+//--------------------------------------------------------------
+void ofApp::mouseExited(int x, int y){
+
+}
+
+//--------------------------------------------------------------
+void ofApp::windowResized(int w, int h){
+
+}
+
+//--------------------------------------------------------------
+void ofApp::gotMessage(ofMessage msg){
+
+}
+
+//--------------------------------------------------------------
+void ofApp::dragEvent(ofDragInfo dragInfo){ 
+
+}

apps/devApps/testVk/src/ofApp.h

@@ -0,0 +1,29 @@
+#pragma once
+
+#include "ofMain.h"
+#include "vk/DrawCommand.h"
+
+class ofApp : public ofBaseApp{
+
+	of::vk::DrawCommand fullscreenQuad;
+
+	std::shared_ptr<of::vk::Shader> mShaderFullscreen;
+
+	public:
+		void setup();
+		void update();
+		void draw();
+
+		void keyPressed(int key);
+		void keyReleased(int key);
+		void mouseMoved(int x, int y );
+		void mouseDragged(int x, int y, int button);
+		void mousePressed(int x, int y, int button);
+		void mouseReleased(int x, int y, int button);
+		void mouseEntered(int x, int y);
+		void mouseExited(int x, int y);
+		void windowResized(int w, int h);
+		void dragEvent(ofDragInfo dragInfo);
+		void gotMessage(ofMessage msg);
+
+};