Add native pipeline support and texture related functionality by sepcnt · Pull Request #8871 · MonoGame/MonoGame

sepcnt · 2025-07-02T12:48:51Z

This PR addresses bounty #8641 by replacing the FreeImage and StbImageSharp dependencies with a new, in-house native C++ pipeline library (mgpipeline) for texture importing.
The changes improve modularity and performance by consolidating image-related operations into the mgpipeline library. Additionally, submodule management and project dependencies have been updated to reflect these changes.

Image Processing Refactor:

MonoGame.Framework.Content.Pipeline/Graphics/GraphicsUtil.cs: Refactored the Resize method to use the MGCP_Bitmap structure and MGCP.MP_ResizeBitmap function from the mgpipeline library, replacing FreeImage-based resizing logic.
MonoGame.Framework.Content.Pipeline/TextureImporter.cs: Replaced FreeImage and Stb-based image importing with MGCP.MP_ImportBitmap and added support for new texture types. Removed redundant methods for channel swapping and BMP loading.

Native Library Integration:

MonoGame.Framework.Content.Pipeline/Native/Texture.Interop.cs: Introduced a new interop file defining MGCP_Bitmap structure and native methods (MP_ImportBitmap, MP_ResizeBitmap, MP_ExportBitmap, etc.) for interacting with the mgpipeline library.
MonoGame.Framework.Content.Pipeline/MonoGame.Framework.Content.Pipeline.csproj: Added mgpipeline native library files (mgpipeline.dll, libmgpipeline.so, libmgpipeline.dylib) to the project for cross-platform support. Removed references to FreeImage and Stb libraries.

Submodule and Workflow Updates:

.gitmodules: Added a new submodule for external/stb, ensuring proper version control for dependencies.
.github/workflows/main.yml: Updated the repository cloning step to include submodules recursively in deploy stage.

File Format Export:

MonoGame.Framework.Content.Pipeline/Utilities/FileHelpers.cs: Refactored PNG export logic to use MGCP.MP_ExportBitmap instead of StbImageWriteSharp, improving error handling and efficiency.

Cleanup and Simplification:

MonoGame.Framework.Content.Pipeline/MonoGame.Framework.Content.Pipeline.csproj: Removed unused references to StbImageSharp and StbImageWriteSharp, as well as the FreeImage library. [1] [2]
MonoGame.Framework.Content.Pipeline/Graphics/GraphicsUtil.cs: Removed the BGRAtoRGBA method, as channel swapping is no longer required with the new library.

- Updated .gitignore to include Premake generated files. - Added new submodule for stb_image. - Created native pipeline library with C API for bitmap import. - Implemented texture importing using native methods in TextureImporter. - Enhanced build process for native pipeline with Premake and MSBuild. - Added README and API headers for the native pipeline.

harry-cpp

You can remove the test that is failing, for the switching to stb_image we have decided to not support any image format not supported by it for importing.

native/pipeline/mgcp_pipeline.cpp

MonoGame.Framework.Content.Pipeline/MonoGame.Framework.Content.Pipeline.csproj

build/BuildToolsTasks/BuildContentPipelineTask.cs

native/pipeline/README.md

MonoGame.Framework.Content.Pipeline/TextureImporter.cs

native/pipeline/mgcp_pipeline.cpp

- Rename native pipeline to `mgpipeline` - Remove TIFF format test and asset - Update .gitignore and enhance BuildContentPipelineTask for cross-platform support - Remove system-specific path from platform target in premake5.lua - Refactor API export macros for improved cross-platform compatibility - Refactor `MGCP_Bitmap` to use reference types for better memory management and error handling - Fix Linux native pipeline library reference in project file - Refactor `MP_ImportBitmap` to satisfy GCC

sepcnt · 2025-07-03T07:47:46Z

To totally remove FreeImage and StbImage(Write)Sharp, there are few more APIs to implement:

MG_ResizeBitmap
MG_ExportBitmap

However, there's a critical bug in BasicUHelpers and CrunchHelpers:

MonoGame/MonoGame.Framework.Content.Pipeline/Utilities/BasisUHelpers.cs

Lines 375 to 377 in 7c11dd0


	PngFileHelper.WritePngToIntermediate(sourceBitmap, out pngFileName);

MonoGame/MonoGame.Framework.Content.Pipeline/Utilities/FileHelpers.cs

Line 51 in 7c11dd0

    
           var colorBitmap = new PixelBitmapContent<Color>(sourceBitmap.Width, sourceBitmap.Height);

That means all textures are converts to rgba8 regardless of there original color depth (16bit or float)

harry-cpp · 2025-07-03T12:25:58Z

Since its happening on the current develop branch I'd recommend just leaving it working as is in here, and just opening a new issue about it (with a couple of comments in code about the issue).

Tho if its something thats easy to fix, feel free to do it here.

sepcnt · 2025-07-03T12:37:30Z

Since its happening on the current develop branch I'd recommend just leaving it working as is in here, and just opening a new issue about it (with a couple of comments in code about the issue).

Tho if its something thats easy to fix, feel free to do it here.

Okay, it's weird but works. I opened an issue for it here #8874

harry-cpp

You'll need to setup a way to package up MonoGame.Content.Pipeline for all the platforms, right now each platform is makings its own nuget that only has 1 native assembly in it for itself which would break stuff.

To do this I recommend:

Upload each mgpipeline native lib as an artifact during build
Download each mgpipeline native lib during Deploy, place them in the Artifacts folder and combine then rebuild just the MonoGame.Content.Pipeline by creating a brand new cake task

We use GitHub actions located in .github/workflows and C# Cake project located by opening Build.sln in root for CI operations, I believe you just need to modify the C# side of things for this, you can test on your local fork by enabling github actions on it.

Another thing to note is that mgpipeline needs to be statically linked and the CI should check for that. You can grab the code for that from: https://github.com/MonoGame/MonoGame.Library.BuildScripts/blob/5cd1ee39dfa0e570b125260d4d19753232c1c29e/Tasks/TestLinuxTask.cs#L5 (there is 1 task for each platform)

MonoGame.Framework.Content.Pipeline/MonoGame.Framework.Content.Pipeline.csproj

native/pipeline/mgcp_pipeline.cpp

native/pipeline/premake5.lua

MonoGame.Framework.Content.Pipeline/TextureImporter.cs

harry-cpp · 2025-07-04T08:52:42Z

PS. Feel free to ping me on discord for me to review the PR or if you have any questions about this, I should notice it much quicker then on github ^^

…p processing, add resizing functionality, and update related enums and structures.

…stom export functionality.

…y management, update import/export paths.

build/BuildToolsTasks/BuildContentPipelineTask.cs

MonoGame.Framework.Content.Pipeline/Graphics/GraphicsUtil.cs

…TF-8 encoding.

…elop

- Fix bpp calculation bug to avoid wasting memory - Add static library check task - Fix premake5 configuration for macOS universal support, static linkage on Windows

MonoGame.Framework.Content.Pipeline/Graphics/GraphicsUtil.cs

build/StaticLibCheck.cs

tomspilman · 2025-07-05T20:28:51Z

native/monogame/include/api_common.h


 #define MG_FIELD_OFFSET(off, type, name) struct { char _pad_##name[off]; type name; }

+#if defined(_WIN32) || defined(__CYGWIN__)


Not sure how these changes in the export will affect the consoles... will have to test it later and fix things. It however worked before.

…Check class for clarity

harry-cpp · 2025-07-06T16:00:50Z

Looking good so merging! Thank you very much for getting this work done @sepcnt !

harry-cpp requested changes Jul 2, 2025

View reviewed changes

sepcnt force-pushed the develop branch 3 times, most recently from d3cfc00 to 8589466 Compare July 3, 2025 04:44

sepcnt requested a review from harry-cpp July 3, 2025 05:25

sepcnt force-pushed the develop branch from c174dee to 48200b9 Compare July 3, 2025 06:55

Add HDR support in native pipeline MP_ImportBitmap

4dd2b24

sepcnt changed the title ~~Add native pipeline support and texture importing functionality~~ Add native pipeline support and texture related functionality Jul 3, 2025

Remove duplicate stb headers in native/monogame/common

8836a49

harry-cpp requested changes Jul 4, 2025

View reviewed changes

sepcnt added 3 commits July 4, 2025 23:00

Refactor native texture handling: replace FreeImage with custom bitma…

ca96c81

…p processing, add resizing functionality, and update related enums and structures.

Refactor bitmap handling: remove stb image dependencies, implement cu…

7ee3d12

…stom export functionality.

Refactor bitmap handling: replace unsafe code with GCHandle for memor…

3c33a80

…y management, update import/export paths.

sepcnt requested a review from harry-cpp July 4, 2025 15:42

harry-cpp requested changes Jul 4, 2025

View reviewed changes

build/BuildToolsTasks/BuildContentPipelineTask.cs Show resolved Hide resolved

MonoGame.Framework.Content.Pipeline/Graphics/GraphicsUtil.cs Outdated Show resolved Hide resolved

sepcnt and others added 4 commits July 5, 2025 00:11

Update error message handling and native pipeline on Windows to use U…

bd10d9a

…TF-8 encoding.

Merge branch 'develop' into develop

cbef16a

Pack all-in-one nuget package for ContentPipeline during the CI

6905cbf

Merge branch 'develop' of https://github.com/sepcnt/MonoGame into dev…

7f25f73

…elop

sepcnt requested a review from harry-cpp July 4, 2025 18:44

sepcnt force-pushed the develop branch 2 times, most recently from da0fe76 to 6ae52f8 Compare July 5, 2025 04:41

Fix CI and build configuration

44fb60e

- Fix bpp calculation bug to avoid wasting memory - Add static library check task - Fix premake5 configuration for macOS universal support, static linkage on Windows

sepcnt force-pushed the develop branch from 6ae52f8 to 44fb60e Compare July 5, 2025 04:44

tomspilman reviewed Jul 5, 2025

View reviewed changes

MonoGame.Framework.Content.Pipeline/Graphics/GraphicsUtil.cs Outdated Show resolved Hide resolved

tomspilman reviewed Jul 5, 2025

View reviewed changes

build/StaticLibCheck.cs Outdated Show resolved Hide resolved

tomspilman reviewed Jul 5, 2025

View reviewed changes

Manage MP_ResizeBitmap dstBitmap.data on C# side and update StaticLib…

c8eb4a4

…Check class for clarity

harry-cpp approved these changes Jul 6, 2025

View reviewed changes

harry-cpp merged commit 7c9db54 into MonoGame:develop Jul 6, 2025
7 checks passed

harry-cpp mentioned this pull request Jul 6, 2025

[PAID BOUNTY][LOCKED] Create native backend for Content Pipeline #8641

Closed


		#define MG_FIELD_OFFSET(off, type, name) struct { char _pad_##name[off]; type name; }

		#if defined(_WIN32) \|\| defined(__CYGWIN__)

Uh oh!

Conversation

sepcnt commented Jul 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Image Processing Refactor:

Native Library Integration:

Submodule and Workflow Updates:

File Format Export:

Cleanup and Simplification:

Uh oh!

harry-cpp left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

sepcnt commented Jul 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

harry-cpp commented Jul 3, 2025

Uh oh!

sepcnt commented Jul 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

harry-cpp left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

harry-cpp commented Jul 4, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

tomspilman Jul 5, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

harry-cpp commented Jul 6, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

sepcnt commented Jul 2, 2025 •

edited

Loading

sepcnt commented Jul 3, 2025 •

edited

Loading

sepcnt commented Jul 3, 2025 •

edited

Loading