[PAID BOUNTY] A shared base for public and console repos #8309

tomspilman · 2024-05-20T13:21:04Z

This is a WIP on the shared native base for future platform work.

Looking for feedback on the structure of things before i finish the implementation and finalize it.

~~C# to C++ wrapper generator.~~
~~C# native wrapper.~~
~~Windows VK setup.~~
C++ native wrapper. (WIP)
SDL native backend. (WIP)
Vulkan rendering backend. (WIP)
Input native backend (WIP).
WindowsVK unit tests. (WIP)

tomspilman · 2024-05-20T13:26:13Z

MonoGame.Framework/Platform/Native/Interop.cs

+ public int MaxVertexBufferSlots;
+}
+
+internal static unsafe partial class MGG


We need to wart these with something that works for us in C# and in C++ (don't want conflicts with other native libs).

So i'm thinking:

MGG for Graphics.

MGA for Audio.

MGI for Input.

MGF for Framework?

Thoughts?

tomspilman · 2024-05-20T13:30:51Z

src/monogame/include/csharp_MGG.h

+#include "csharp_structs.h"
+
+
+struct MGG_GraphicsDevice;


The idea here is the C++ implementation will define the internals of these pre-declared structures.

For example one for DX could look like:

struct MGG_GraphicsDevice { ID3D12Device* _device; ID3D12GraphicsCommandList* _commandList; ID3D12CommandQueue* _commandQueue; // etc! }

This would be how native platforms pass along its data across pinvokes.

The C# just passes pointers and the C++ is responsible for allocation and freeing of these types.

src/monogame/include/csharp_common.h

tomspilman · 2024-05-20T13:32:17Z

src/monogame/include/csharp_enums.h

+
+#include "csharp_common.h"
+
+enum CSSurfaceFormat : csint


Same here... MGSurfaceFormat instead of CSSurfaceFormat ?

Tools/MonoGame.Generator.CTypes/PInvokeWritter.cs

src/monogame/null_device/MGG.cpp

tomspilman · 2024-05-25T18:44:58Z

Both projects need to be fully hooked up to the CAKE Frosting build system

@harry-cpp what do i need to do for this?

Is it just building? Or is it also a project generator for C++?

I had assumed we would maintain C++ projects manually on a per-platform basis.

tomspilman · 2024-05-25T21:04:26Z

MonoGame.Framework/Platform/Native/Interop.cs

+/// <summary>
+/// MonoGame image native calls.
+/// </summary>
+internal static unsafe partial class MGI


I think we should ditch StbSharp for native stb directly since we have a native library.

This API exposes reading images (jpg/png) from memory as well as writing jpg and png.

We could implement more here in the future.

tomspilman · 2024-05-25T22:31:25Z

@harry-cpp @mrhelmut

I assume we'll have one Windows C++ project for a monogame.native.dll that depending on build configuration would build Vulkan or DirectX?

Or should we plan on multiple C++ Windows projects?

I assume we won't support runtime swapping of Vulkan or DX12? Especially since we pre-build the effects for the platform. (IMO this is a gimmick and not actually useful in shipping games)

So we will end up with WindowsVK and WindowsDX as platforms sort of like we had before with WindowsGL.

Also i assume WindowsGL is going away.

mrhelmut · 2024-05-26T06:28:13Z

I assume we'll have one Windows C++ project for a monogame.native.dll that depending on build configuration would build Vulkan or DirectX?

I don't have a strong opinion on this. Whatever seems smooth enough in regard to Linux, macOS, and consoles moving to that too.

I assume we won't support runtime swapping of Vulkan or DX12? Especially since we pre-build the effects for the platform. (IMO this is a gimmick and not actually useful in shipping games)

It doesn't feel useful to me. Not on the C++ at least. Worst case we can manage that on the C# side of things with a simple switch loading either native dll at launch.

harry-cpp · 2024-05-26T08:37:22Z

@harry-cpp what do i need to do for this?

It should:

build all the generator projects
run all the generators
ensure no file is now in modified state compared to before running the generators (aka. all the generated files were properly committed)
build all the native projects

Is it just building? Or is it also a project generator for C++?

I had assumed we would maintain C++ projects manually on a per-platform basis.

CAKE is just building the projects. But.

We should use some cross platform solution for building the projects as VS projects are Windows only. Some of them even support generating a VS project for you to work in. Good options are meson and cmake.

tomspilman · 2024-05-26T16:23:23Z

MonoGame.Framework/Graphics/Texture3D.cs

@@ -74,11 +74,7 @@ protected Texture3D (GraphicsDevice graphicsDevice, int width, int height, int d
 {
 ValidateParams(level, left, top, right, bottom, front, back, data, startIndex, elementCount);

- var width = right - left;


I figured i would fix bad platform apis when i could.

Here it was passing left, top, right, bottom, front, back.... AND width, height, depth.

So i removed the extra data passing that not all platforms need.

tomspilman · 2024-05-27T16:04:03Z

MonoGame.Framework/Graphics/SamplerStateCollection.cs


- internal SamplerStateCollection(GraphicsDevice device, int maxSamplers, bool applyToVertexStage)
+ internal SamplerStateCollection(GraphicsDevice device, int maxSamplers, ShaderStage stage)


This felt like a better design moving forward.

tomspilman · 2024-05-27T16:13:28Z

src/monogame/include/csharp_GameWrapper.h

+
+#pragma once
+
+#include "csharp_common.h"


The prefix csharp_ feels wrong here. Better ideas? gen_ or api_ or something?

tomspilman · 2024-06-04T14:16:47Z

src/monogame/vulkan/RebuildMGFX.bat

@@ -0,0 +1,19 @@
+@echo off


Decided it was best to keep the generated binary effect files in per-platform folders instead of all in a common place.

This seems like a good direction considering console support.

tomspilman · 2024-06-04T14:18:39Z

MonoGame.Framework/Platform/Native/TitleContainer.Native.cs

+ // Or do we make the native code transform the string?
+ //
+ var absolutePath = Path.Combine(Location, safeName);
+ return File.OpenRead(absolutePath);


Will be moving the file path fixup to native code.

MonoGame.Framework.Content.Pipeline/TargetPlatform.cs

tomspilman · 2024-06-19T12:29:53Z

src/monogame/sdl/MGP_sdl.cpp

+ // TODO: Why did this start with SDL_WINDOW_FULLSCREEN_DESKTOP in the old C# SDL?
+ // We should write coments to document odd behaviors like this.
+
+ Uint32 flags = SDL_WINDOW_HIDDEN;// | SDL_WINDOW_FULLSCREEN_DESKTOP;


@harry-cpp do you remember why the C# SDL implementation was making this a SDL_WINDOW_FULLSCREEN_DESKTOP by default?

On DesktopGL we create the window twice, once before initialize to setup some opengl stuff, and once afterwards to recreate it with the set attributes: https://github.com/MonoGame/MonoGame/blob/develop/MonoGame.Framework/Platform/GraphicsDeviceManager.SDL.cs#L52

tomspilman · 2024-06-29T22:51:10Z

For visibility here is the initial rendering under SDL2 + Vulkan on the new native backend:

ice_video_20240616-215942.mp4

Has bugs, but we have progress too.

dogruis · 2024-06-29T22:54:55Z

MonoGame.Framework/MonoGame.Framework.Native.csproj

@@ -1,4 +1,4 @@
-<Project Sdk="Microsoft.NET.Sdk">
+<Project Sdk="Microsoft.NET.Sdk">


I wonder why git is showing a diff here

A whitespace change of some sort. It happens.

I wonder why git is showing a diff here.

Different line endings (probably \r\n vs \n). Git might normalize line endings depending on configuration

dogruis · 2024-06-29T23:22:05Z

src/monogame/sdl/MGP_sdl.cpp

+ platform->exit = true;
+ break;
+
+ /*


Just a reminder to not leave so much comments.

WIP... i expect these will be restored in the next week.

MonoGame.Framework/Platform/Native/GamePlatform.Native.cs

dogruis · 2024-07-01T09:09:41Z

src/monogame/vulkan/MGG_Vulkan.cpp

+ std::map<uint32_t, MGVK_TargetSetCache*> targetCache;
+
+
+ //


Empty comment

harry-cpp · 2024-07-02T12:03:02Z

MonoGame.Framework/Platform/Native/Platform.Interop.cs

+internal struct MGP_Event
+{
+ [FieldOffset(0)]
+ public EventType Type;


Add a field for Timestamp bellow Type.

# Conflicts: # MonoGame.Framework/Graphics/GraphicsDevice.cs # MonoGame.Framework/Platform/Native/Mouse.Native.cs

harry-cpp and others added 3 commits February 21, 2024 20:00

[Native] Add generator for c# types used on c++ side

0cf7078

backup

802cd49

Merge branch 'feature-native-enumexporter' of https://github.com/harr…

4305687

…y-cpp/MonoGame into native

tomspilman added the Bounty label May 20, 2024

tomspilman changed the title ~~[PAID BOUNTY] A shared base for public and console repos~~ [PAID BOUNTY] [WIP] A shared base for public and console repos May 20, 2024

tomspilman marked this pull request as draft May 20, 2024 13:22

tomspilman changed the title ~~[PAID BOUNTY] [WIP] A shared base for public and console repos~~ [PAID BOUNTY] A shared base for public and console repos May 20, 2024

tomspilman commented May 20, 2024

View reviewed changes

src/monogame/include/csharp_common.h Outdated Show resolved Hide resolved

tomspilman commented May 20, 2024

View reviewed changes

Tools/MonoGame.Generator.CTypes/PInvokeWritter.cs Outdated Show resolved Hide resolved

tomspilman force-pushed the native branch from f66c58e to 6b9557f Compare May 25, 2024 06:37

tomspilman commented May 25, 2024

View reviewed changes

src/monogame/null_device/MGG.cpp Show resolved Hide resolved

tomspilman force-pushed the native branch 2 times, most recently from 37fb5ff to 5f845ec Compare May 25, 2024 18:43

tomspilman commented May 25, 2024

View reviewed changes

tomspilman force-pushed the native branch from 5f845ec to 93dd444 Compare May 26, 2024 16:21

tomspilman commented May 26, 2024

View reviewed changes

tomspilman force-pushed the native branch 2 times, most recently from 73e2947 to 948100b Compare May 27, 2024 16:03

tomspilman commented May 27, 2024

View reviewed changes

tomspilman force-pushed the native branch from 948100b to 0ff0249 Compare June 4, 2024 14:13

tomspilman commented Jun 4, 2024

View reviewed changes

tomspilman force-pushed the native branch from 0ff0249 to dc37621 Compare June 19, 2024 12:23

tomspilman commented Jun 19, 2024

View reviewed changes

MonoGame.Framework.Content.Pipeline/TargetPlatform.cs Show resolved Hide resolved

tomspilman commented Jun 19, 2024

View reviewed changes

tomspilman mentioned this pull request Jun 29, 2024

Planning for Vulkan, DirectX 12, and Metal #4571

Open

dogruis reviewed Jun 29, 2024

View reviewed changes

tomspilman force-pushed the native branch from dc37621 to 14266cd Compare June 30, 2024 02:29

dogruis reviewed Jul 1, 2024

View reviewed changes

MonoGame.Framework/Platform/Native/GamePlatform.Native.cs Outdated Show resolved Hide resolved

dogruis reviewed Jul 1, 2024

View reviewed changes

src/monogame/vulkan/MGG_Vulkan.cpp

std::map<uint32_t, MGVK_TargetSetCache*> targetCache;

//

Copy link

dogruis Jul 1, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Empty comment

tomspilman force-pushed the native branch from 14266cd to 60688f1 Compare July 1, 2024 20:28

harry-cpp reviewed Jul 2, 2024

View reviewed changes

tomspilman force-pushed the native branch from 60688f1 to 239a9d1 Compare July 6, 2024 21:53

tomspilman added 2 commits July 6, 2024 16:58

WIP on native wrapper, generator, and vulkan graphics.

d828bef

Merge remote-tracking branch 'upstream/develop' into native

b6a7322

# Conflicts: # MonoGame.Framework/Graphics/GraphicsDevice.cs # MonoGame.Framework/Platform/Native/Mouse.Native.cs

tomspilman force-pushed the native branch 2 times, most recently from ece8412 to 5acd92a Compare July 6, 2024 22:32

Fix build.

7bb79bf

tomspilman force-pushed the native branch from 5acd92a to 5abf938 Compare July 7, 2024 00:06

Removed DesktopVK task for now.

9b295e8

tomspilman force-pushed the native branch from 5abf938 to 9b295e8 Compare July 7, 2024 04:47

Test of using xmake for building/generating C++ projects.

7f3bc9d

tomspilman force-pushed the native branch 6 times, most recently from 0c62578 to 70b38cc Compare July 8, 2024 13:58

Trying to setup xmake to work via github actions

e1652d4

tomspilman force-pushed the native branch from 70b38cc to e1652d4 Compare July 9, 2024 13:20

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[PAID BOUNTY] A shared base for public and console repos #8309

[PAID BOUNTY] A shared base for public and console repos #8309

tomspilman commented May 20, 2024 •

edited

Loading

tomspilman May 20, 2024

tomspilman May 20, 2024

tomspilman May 20, 2024

tomspilman commented May 25, 2024

tomspilman May 25, 2024

tomspilman commented May 25, 2024 •

edited

Loading

mrhelmut commented May 26, 2024

harry-cpp commented May 26, 2024

tomspilman May 26, 2024

tomspilman May 27, 2024

tomspilman May 27, 2024

tomspilman Jun 4, 2024

tomspilman Jun 4, 2024

tomspilman Jun 19, 2024

harry-cpp Jul 2, 2024

tomspilman commented Jun 29, 2024

dogruis Jun 29, 2024

tomspilman Jun 29, 2024

Maniekko Jul 2, 2024 •

edited

Loading

dogruis Jun 29, 2024

tomspilman Jun 29, 2024

dogruis Jul 1, 2024

harry-cpp Jul 2, 2024


		internal SamplerStateCollection(GraphicsDevice device, int maxSamplers, bool applyToVertexStage)
		internal SamplerStateCollection(GraphicsDevice device, int maxSamplers, ShaderStage stage)

		@@ -1,4 +1,4 @@
		<Project Sdk="Microsoft.NET.Sdk">
		<Project Sdk="Microsoft.NET.Sdk">


		#pragma once

		#include "csharp_common.h"

[PAID BOUNTY] A shared base for public and console repos #8309

Are you sure you want to change the base?

[PAID BOUNTY] A shared base for public and console repos #8309

Conversation

tomspilman commented May 20, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tomspilman commented May 25, 2024

Choose a reason for hiding this comment

tomspilman commented May 25, 2024 • edited Loading

mrhelmut commented May 26, 2024

harry-cpp commented May 26, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tomspilman commented Jun 29, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Maniekko Jul 2, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tomspilman commented May 20, 2024 •

edited

Loading

tomspilman commented May 25, 2024 •

edited

Loading

Maniekko Jul 2, 2024 •

edited

Loading