English | 简体中文

Doc · 文档

---

欢迎通过讨论、问题和拉取请求参与GPUPixel的改进！

简介

GPUPixel是一个高性能、跨平台的图像与视频滤镜库，占用空间小。它基于C++11和OpenGL/ES构建，提供美颜滤镜功能，支持iOS、Android、Mac、Windows和Linux——兼容任何OpenGL/ES平台。

赞助商

特别赞助

我们感谢Facebetter对GPUPixel项目的慷慨赞助与支持。

更优的人脸美化特效SDK — 了解更多

效果预览

https://github.com/user-attachments/assets/6b760fa6-e28f-4428-bfca-dec54a4e82d8

开始之前

请在GitHub上给GPUPixel点个星，以便及时获取新版本通知！

快速入门

请参阅文档：简介 | 构建 | 示例 | 集成

参与贡献

我们欢迎任何形式的贡献！您可以通过加入讨论、提交问题或发起拉取请求来改进GPUPixel。更多详情请查看我们的贡献指南。

同时，我们也非常欢迎您在社交媒体及各类活动中分享GPUPixel。

贡献者

更多赞助商

感谢以下贡献者的慷慨支持：

联系与支持

• 文档：完整的文档和使用指南
• 问题：用于报告Bug或提出功能需求
• 邮件：直接联系我们

致谢

参考项目

1. GPUImage
2. GPUImage-x
3. CainCamera

许可证

本仓库采用Apache-2.0许可证开放使用。

GPUPixel 快速上手指南

GPUPixel 是一个基于 C++11 和 OpenGL/ES 开发的高性能、跨平台图像与视频滤镜库。它体积小巧，支持美颜滤镜，兼容 iOS、Android、Mac、Windows 和 Linux 等所有支持 OpenGL/ES 的平台。

环境准备

在开始之前，请确保您的开发环境满足以下要求：

• 操作系统：iOS, Android, macOS, Windows, 或 Linux
• 编译器：支持 C++11 标准的编译器
• 图形接口：系统需支持 OpenGL 或 OpenGL ES
• 构建工具：
  • Linux/macOS: CMake, Make/GCC/Clang
  • Windows: CMake, Visual Studio (MSVC)
  • Android: Android NDK, CMake
  • iOS: Xcode, CMake

安装步骤

推荐通过克隆源码并编译的方式进行集成。

1. 克隆仓库

git clone https://github.com/pixpark/gpupixel.git
cd gpupixel

2. 编译构建

GPUPixel 使用 CMake 进行跨平台构建。以下为通用构建流程（以 Linux/macOS 为例，其他平台请参考官方文档中的 Build 章节调整生成器）：

# 创建构建目录
mkdir build
cd build

# 配置项目 (可根据需要添加 -DCMAKE_BUILD_TYPE=Release 等参数)
cmake ..

# 编译
cmake --build .

提示：对于 Android 或 iOS 项目，通常需要将此库作为子模块集成到您的现有工程中，或使用特定的 Toolchain 文件进行交叉编译。详细集成方案请参阅 集成指南。

基本使用

GPUPixel 的核心用法是通过创建 Filter 对象并将其应用到图像或视频帧上。以下是一个简化的 C++ 使用逻辑示例：

#include "gpupixel/gpupixel.h"
#include "gpupixel/filter/beauty_filter.h"

using namespace gpupixel;

int main() {
    // 1. 初始化上下文 (具体初始化方式取决于平台，如 iOS/Android/Mac/Win)
    // Context::makeCurrent(...); 

    // 2. 创建滤镜实例 (例如：美颜滤镜)
    auto beauty_filter = std::make_shared<BeautyFilter>();
    
    // 设置滤镜参数 (例如：磨皮强度 0.5)
    beauty_filter->setIntensity(0.5f);

    // 3. 处理图像
    // 假设 input_texture 是已加载的 OpenGL 纹理 ID
    GLuint input_texture = loadTexture("input.jpg");
    GLuint output_texture = createTexture();

    // 将输入纹理绑定到滤镜并渲染到输出纹理
    beauty_filter->render(input_texture, output_texture);

    // 4. 读取或显示 output_texture
    // ...

    return 0;
}

核心流程说明：

1. 初始化：确保当前线程拥有有效的 OpenGL 上下文。
2. 创建滤镜：实例化所需的滤镜类（如 BeautyFilter, GaussianBlurFilter 等）。
3. 配置参数：调用 setIntensity 或其他特定方法调整效果强度。
4. 渲染：调用 render 方法，传入输入纹理和输出纹理 ID，完成 GPU 处理。

更多滤镜列表及详细 API 用法，请访问 官方文档。