Initial commit

Author: Const-me

.gitignore

@@ -0,0 +1,13 @@
+*.deb
+net-core/dotnet-runtime-2.1.18-linux-arm.tar.gz
+RenderSamples/bin/
+RenderSamples/obj/
+Vrmac/bin/
+Vrmac/obj/
+VrmacInterop/bin/
+VrmacInterop/obj/
+*.user
+.vs/
+Vrmac/linux-arm/libVrmac.so
+Vrmac/win10-x64/VrmacFT.dll
+Vrmac/win10-x64/Vrmac.dll

EULA.txt

@@ -0,0 +1,28 @@
+Copyright (c) 2020 Konstantin, const.me
+
+Vrmac Graphics End User License Agreement
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files
+(the "Software"), to use, copy, publish, distribute, sublicense, and/or sell copies of the Software,
+and to permit persons to whom the Software is furnished to do so, subject to the following conditions.
+
+1. The software is provided “as is”, without warranty of any kind, express or implied, including but not limited to
+the warranties of merchantability, fitness for a particular purpose and noninfringement.
+In no event shall the authors or copyright holders be liable for any claim, damages or other liability,
+whether in an action of contract, tort or otherwise, arising from, out of or in connection with the software
+or the use or other dealings in the software.
+
+2. The complete text of this agreement, including the above copyright notice,
+shall be included in all copies or substantial portions of the software.
+If you distribute a derivative product in binary form, this license must be available to end users of the software. 
+
+3. You may not reverse engineer the software, except when this is allowed by EU Directive 2009/24
+https://eur-lex.europa.eu/legal-content/EN/TXT/HTML/?uri=CELEX:32009L0024&from=EN or the laws of your jurisdiction.
+
+4. If any provision of this License is invalid or unenforceable under applicable law, it shall not affect the validity
+or enforceability of the remainder of the terms of this Agreement, and without further action by the parties hereto,
+such provision shall be reformed to the minimum extent necessary to make such provision valid and enforceable.
+
+5. If you institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit)
+alleging that the program itself (excluding combinations of the program with other software or hardware) infringes your patent(s),
+then your rights granted by this license agreement shall terminate as of the date such litigation is filed.

Installation.md

@@ -0,0 +1 @@
+# Installation## Windows 10On Windows 10 you only need the nuget package, and .NET Core runtime. I have only tested with 2.1 and 2.2, will probably work with newer versions, too.Microsoft did decent job packaging their .NET core for Windows.Download an installer [from their official web site](https://dotnet.microsoft.com/download/dotnet-core), and very likely it’ll work just fine.If you want to compile apps, you’ll need SDK, not just the runtime.The native binary is only available for 64-bit Windows.Make sure that damn “Prefer 32-bit” checkbox is **not** checked in the properties of your project.It won’t run otherwise, you’ll get a startup exception telling something about not being able to load Vrmac.dll.## Raspberry Pi### .NET CoreMicrosoft did poor job packaging their .NET Core for ARM Linux.I had to come up with something better.From the Releases page of this repository, download `dotnet-runtime_2.1.18_armhf.deb` to the Pi, and run this command on the Pi:```sudo dpkg -i ./dotnet-runtime_2.1.18_armhf.deb```This will install .NET Core version 2.1.18 LTS. The sources of that Debian package are in this repository, in `net-core` subfolder. The `package` bash script from that folder compiles the package.### Other Runtime DependenciesIn addition to that, Vrmac Graphics requires some Debian packages which may or may not be installed on your Pi.To install all of them, copy-paste the following to the Linux command-line shell, and run it:```sudo apt-get install -y libegl1 libgles2 libgbm1 libdrm2 libx11-6 libxcb1 libx11-xcb1 libpng16-16 \libfreetype6 libtiff5 libjpeg62-turbo libstdc++6 libc6 libgcc1 fonts-liberation2 fonts-quicksand```All these packages are from the official repository. Presumably, they are supported by Debian maintainers.### Video Driver Setup```sudo raspi-config7    Advanced Options   Configure advanced settingsA8   GL Driver          Enable/Disable experimental desktop GL driverG2   GL (Fake KMS)      OpenGL desktop driver with fake KMS```By default, Linux doesn’t grant you permissions to 3D render things. Here’s a fix:```sudo usermod -a -G render pi```Reboot after all these changes, with `sudo reboot` command.### Running SamplesOnce the above setup is complete, you should be able to run samples with the following command:```dotnet RenderSamples.dll```Vrmac graphics doesn’t care about SSH sessions or X windows.If you’ll run it anyhow on the Pi, and the X server is running, it will create a window on the monitor plugged into the Pi.If no X server is running, will render directly into the physical monitor plugged into Pi, using that lower-level workflow with drm/kms and raw input.If both methods fail, the library should throw some exception with a meaningful error message about that.If you have DSI display, or two HDMI displays, should work in theory but I never tested.The API to select display, resolution and refresh rate is exposed to .NET.It does work on my Pi 4 when a single monitor is a FullHD one plugged into MicroHDMI, but I haven’t tested anything else.ARM Linux doesn’t currently have .NET SDK, just the runtime. To build stuff for Pi4, you’ll need some non-ARM PC which supports the SDK.Windows, OSX or Linux should all work. On Windows, click Build / Publish, in command line that’s `dotnet publish`, then copy output folder to the Pi.Personally, I shared a network drive in Windows 10 PC, and mounted it on the Pi with a long command which starts with `sudo mount -t cifs`

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Konstantin
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

Pre-existing IP.txt

@@ -0,0 +1,92 @@
+Diligent Engine (c) Diligent Graphics
+https://github.com/DiligentGraphics/DiligentEngine
+Apache License 2.0
+
+.NET Core (c) Microsoft
+https://dotnet.microsoft.com/download/dotnet-core
+MIT license
+
+ComLightInterop (c) const.me
+https://github.com/Const-me/ComLightInterop
+MIT license
+
+PlexAllocator (c) const.me
+https://github.com/Const-me/CollectionMicrobench/tree/master/Source/PlexAlloc
+MIT license
+
+MonoGame
+https://github.com/MonoGame/MonoGame
+The source files I used say "MIT license", check the sources in VrmacInterop/MonoGame folder.
+
+DirectXMath (c) Microsoft
+https://github.com/Microsoft/DirectXMath
+MIT license
+
+LibTess2 (c) Silicon Graphics, Inc. and Mikko Mononen
+https://github.com/memononen/libtess2
+SGI FREE SOFTWARE LICENSE B
+
+NanoVG ClearType Fork (c) Mikko Mononen and const.me
+https://github.com/Const-me/nanovg/
+MIT license
+
+Mesh Optimizer (c) Arseny Kapoulkine
+https://github.com/zeux/meshoptimizer
+MIT license
+
+-------------------------------------------------------------------
+ The following libraries are only present in Windows C++ DLLs.
+ On Linux, OS-provided equivalents are linked dynamically instead.
+-------------------------------------------------------------------
+
+FreeType 2.10.2
+https://www.freetype.org/index.html
+FreeType Project License
+
+LibPNG 1.6.17
+http://www.libpng.org/pub/png/libpng.html
+libpng license
+
+zlib 1.2.8
+http://www.zlib.net/
+zlib license
+
+libjpeg 9a (c) Independent JPEG Group
+http://ijg.org/
+Custom BSD-like license
+
+libtiff 4.0.10 (c) Sam Leffler, Silicon Graphics, Inc.
+http://simplesystems.org/libtiff/
+BSD-like licence
+
+-------------------------------------------------------------------
+ The following data files are compiled into .NET DLLs.
+ Mouse cursors are in VrmacGraphics.dll
+ The rest of them are for samples, compiled into RenderSamples.dll
+-------------------------------------------------------------------
+
+Mouse cursors, found on the Internets somewhere.
+They look suspiciously close to Windows Vista or Windows 7 cursors.
+Might be a copyrighted work by Microsoft.
+Ideally, please replace these assets with your own ones.
+I’m not a graphics designer and don’t have skills for that.
+They are in the *.gz files in Vrmac/Utils/Cursor/Assets folder.
+
+Utah teapot (c) Martin Newell
+STL model by zzubnik (Nik Clark, Norwich, UK)
+https://commons.wikimedia.org/wiki/File:Utah_teapot_(solid).stl
+
+Tiger from the Ghostscript examples (c) Ghostscript authors
+https://commons.wikimedia.org/wiki/File:Ghostscript_Tiger.svg
+
+Well-known Standard Test Image "Lenna" (c) 1973 Playboy Magazine
+Use of 512x512 scan is "overlooked" and by implication permitted by Playboy.
+https://en.wikipedia.org/wiki/File:Lenna_(test_image).png
+
+Picture of jelly beans taken at USC.
+Free to use for any purpose including unrestricted redistribution, commercial use, and modification.
+https://commons.wikimedia.org/wiki/File:SIPI_Jelly_Beans_4.1.07.tiff
+
+Random PNG icons found on some third-party web site related to World of Warcraft.
+Probably a copyrighted work by Activision Blizzard.
+If so, including them in the samples of a freeware software library is fair use.

README.md

@@ -0,0 +1,110 @@
+using Diligent.Graphics;
+using Vrmac;
+
+namespace RenderSamples
+{
+	class HelloTriangle: SampleBase
+	{
+		IPipelineState pipelineState;
+
+		protected override void createResources( IRenderDevice device )
+		{
+			// Diligent Engine can use HLSL source on all supported platforms.
+			// It will convert HLSL to GLSL in OpenGL mode, while Vulkan backend will compile it directly to SPIRV.
+			string VSSource = @"
+struct PSInput 
+{ 
+    float4 Pos   : SV_POSITION; 
+    float3 Color : COLOR; 
+};
+
+void main( in uint VertId : SV_VertexID, out PSInput PSIn ) 
+{
+    float4 Pos[3];
+    Pos[0] = float4(-0.5, -0.5, 0.0, 1.0);
+    Pos[1] = float4( 0.0, +0.5, 0.0, 1.0);
+    Pos[2] = float4(+0.5, -0.5, 0.0, 1.0);
+
+    float3 Col[3];
+    Col[0] = float3(1.0, 0.0, 0.0); // red
+    Col[1] = float3(0.0, 1.0, 0.0); // green
+    Col[2] = float3(0.0, 0.0, 1.0); // blue
+
+    PSIn.Pos   = Pos[VertId];
+    PSIn.Color = Col[VertId];
+}";
+
+			string PSSource = @"
+struct PSInput 
+{ 
+    float4 Pos   : SV_POSITION; 
+    float3 Color : COLOR; 
+};
+
+struct PSOutput
+{ 
+    float4 Color : SV_TARGET; 
+};
+
+void main( in PSInput PSIn, out PSOutput PSOut )
+{
+    PSOut.Color = float4(PSIn.Color.rgb, 1.0);
+}
+";
+			PipelineStateDesc PSODesc = new PipelineStateDesc( false );
+
+			PSODesc.setBufferFormats( context );
+
+			// Primitive topology defines what kind of primitives will be rendered by this pipeline state
+			PSODesc.GraphicsPipeline.PrimitiveTopology = PrimitiveTopology.TriangleList;
+			// No back face culling for this tutorial
+			PSODesc.GraphicsPipeline.RasterizerDesc.CullMode = CullMode.None;
+			// Disable depth testing
+			PSODesc.GraphicsPipeline.DepthStencilDesc.DepthEnable = false;
+
+			iShaderFactory shaderFactory = device.GetShaderFactory();
+
+			// We won't be using the device object after this, `using` is to release the COM interface once finished
+			using( iPipelineStateFactory stateFactory = device.CreatePipelineStateFactory() )
+			{
+				// Compile the two shaders
+				ShaderSourceInfo sourceInfo = new ShaderSourceInfo( ShaderType.Vertex, ShaderSourceLanguage.Hlsl );
+				sourceInfo.combinedTextureSamplers = true;  // This appears to be the requirement of OpenGL backend.
+
+				using( var vs = shaderFactory.compileFromSource( VSSource, sourceInfo ) )
+					stateFactory.graphicsVertexShader( vs );
+
+				sourceInfo.shaderType = ShaderType.Pixel;
+				using( var ps = shaderFactory.compileFromSource( PSSource, sourceInfo ) )
+					stateFactory.graphicsPixelShader( ps );
+
+				stateFactory.apply( ref PSODesc );
+
+				pipelineState = device.CreatePipelineState( ref PSODesc );
+			}
+		}
+
+		static readonly Vector4 clearColor = Color.parse( "#ccc" );
+
+		protected override void render( ITextureView swapChainRgb, ITextureView swapChainDepthStencil )
+		{
+			var ic = context.context;
+
+			ic.SetRenderTarget( swapChainRgb, swapChainDepthStencil );
+
+			// Clear the back buffer
+			float[] ClearColor = new float[ 4 ] { 0.350f, 0.350f, 0.350f, 1.0f };
+			// Let the engine perform required state transitions
+			ic.ClearRenderTarget( swapChainRgb, clearColor );
+			ic.ClearDepthStencil( swapChainDepthStencil, ClearDepthStencilFlags.DepthFlag, 1.0f, 0 );
+
+			// Set the pipeline state in the immediate context
+			ic.SetPipelineState( pipelineState );
+			ic.CommitShaderResources( null );
+
+			DrawAttribs drawAttrs = new DrawAttribs( true );
+			drawAttrs.NumVertices = 3; // We will render 3 vertices
+			ic.Draw( ref drawAttrs );
+		}
+	}
+}