BCnEncoder.NET 使用教程

1. 项目介绍

BCnEncoder.NET 是一个跨平台的 .NET 库，用于将 RGBA 图像压缩到不同的块压缩格式。它不依赖本地代码，并且与 .NET Standard 2.1 兼容。支持的格式包括：

• 原始无符号字节 R、RG、RGB 和 RGBA 格式
• BC1 (S3TC DXT1)
• BC2 (S3TC DXT3)
• BC3 (S3TC DXT5)
• BC4 (RGTC1)
• BC5 (RGTC2)
• BC6 (BPTC_FLOAT)
• BC7 (BPTC)

该库当前处于开发阶段，但已经可以使用。开发者计划实现更多编解码器和不同算法的支持。当前版本能够编码和解码 BC1 到 BC7 图像，格式为 KTX 或 DDS。

2. 项目快速启动

首先，确保你的开发环境已经安装了 .NET SDK。

安装 BCnEncoder.NET

通过 NuGet 包管理器安装 BCnEncoder.NET：

Install-Package BCnEncoder.NET

编码图像

以下是如何使用 BCnEncoder.NET 将 PNG 图像编码为 BC1 格式并保存为 KTX 文件的示例：

using BCnEncoder;
using BCnEncoder.ImageSharp;
using SixLabors.ImageSharp;
using SixLabors.ImageSharp.PixelFormats;

// 加载 PNG 图像
Image<Rgba32> image = Image.Load<Rgba32>("example.png");

// 创建编码器实例
BcEncoder encoder = new BcEncoder();

// 设置输出选项
encoder.OutputOptions.GenerateMipMaps = true;
encoder.OutputOptions.Quality = CompressionQuality.Balanced;
encoder.OutputOptions.Format = CompressionFormat.Bc1;
encoder.OutputOptions.FileFormat = OutputFileFormat.Ktx;

// 编码图像并保存到文件
using FileStream fs = File.OpenWrite("example.ktx");
encoder.EncodeToStream(image, fs);

解码图像

以下是如何从 KTX 文件中解码 BC1 格式图像并将其保存为 PNG 文件的示例：

using BCnEncoder;
using SixLabors.ImageSharp;

// 打开 KTX 文件
using FileStream fs = File.OpenRead("compressed_bc1.ktx");

// 创建解码器实例
BcDecoder decoder = new BcDecoder();

// 解码图像
using Image<Rgba32> image = decoder.DecodeToImageRgba32(fs);

// 保存解码后的图像
using FileStream outFs = File.OpenWrite("decoding_test_bc1.png");
image.SaveAsPng(outFs);

3. 应用案例和最佳实践

案例一：HDR 图像编码

若要编码 HDR 图像为 BC6H 格式，可以使用以下代码：

// 读取 HDR 图像
HdrImage image = HdrImage.Read("example.hdr");

// 创建编码器实例
BcEncoder encoder = new BcEncoder();

// 设置输出选项
encoder.OutputOptions.GenerateMipMaps = true;
encoder.OutputOptions.Quality = CompressionQuality.Balanced;
encoder.OutputOptions.Format = CompressionFormat.Bc6U;
encoder.OutputOptions.FileFormat = OutputFileFormat.Ktx;

// 编码图像并保存到文件
using FileStream fs = File.OpenWrite("example.ktx");
encoder.EncodeToStreamHdr(image.PixelMemory, fs);

案例二：解码 BC6H 格式图像

以下是如何解码 BC6H 格式的文件：

// 打开 BC6H 编码的文件
using FileStream fs = File.OpenRead("compressed_bc6.ktx");

// 创建解码器实例
BcDecoder decoder = new BcDecoder();

// 解码图像
Memory2D<ColorRgbFloat> pixels = decoder.DecodeHdr2D(fs);

// 创建 HDR 图像
HdrImage decodedImage = new HdrImage(pixels.Span);

// 保存解码后的 HDR 图像
using FileStream outFs = File.OpenWrite("decoded.hdr");
decodedImage.Write(outFs);

4. 典型生态项目

目前，BCnEncoder.NET 项目的主要生态项目包括与 ImageSharp 的集成。ImageSharp 是一个强大的图像处理库，可以与 BCnEncoder.NET 结合使用，以简化图像的编码和解码过程。

以上是 BCnEncoder.NET 的基本使用教程，你可以根据具体需求调整编码和解码的参数，以达到最佳的效果。