diff --git a/README.md b/README.md index 77149342..22174ddb 100644 --- a/README.md +++ b/README.md @@ -24,18 +24,19 @@ XCEngine/ │ │ │ ├── AudioTypes.h # 音频类型定义 │ │ │ ├── AudioConfig.h # 音频配置 │ │ │ ├── AudioMixer.h # 音频混音器 -│ │ │ ├── AudioSourceComponent.h # 音频源组件 -│ │ │ ├── AudioListenerComponent.h # 音频监听器组件 │ │ │ ├── HRTF.h # HRTF 空间音频 │ │ │ ├── FFTFilter.h # FFT 滤波器 │ │ │ ├── Reverbation.h # 混响效果 │ │ │ ├── Equalizer.h # 均衡器 +│ │ │ ├── IAudioEffect.h # 音频效果接口 │ │ │ ├── WASAPI/ # WASAPI 后端实现 │ │ │ └── IAudioBackend.h # 音频后端接口 │ │ ├── Components/ # 游戏组件系统 │ │ │ ├── Component.h # 组件基类 │ │ │ ├── GameObject.h # 游戏对象 -│ │ │ └── TransformComponent.h # 变换组件 +│ │ │ ├── TransformComponent.h # 变换组件 +│ │ │ ├── AudioSourceComponent.h # 音频源组件 +│ │ │ └── AudioListenerComponent.h # 音频监听器组件 │ │ ├── Containers/ # 容器模块 │ │ │ ├── Array.h # 动态数组 │ │ │ ├── String.h # 字符串类 @@ -73,8 +74,7 @@ XCEngine/ │ │ │ ├── Ray.h # 射线 │ │ │ ├── AABB.h # 轴对齐包围盒 │ │ │ ├── Bounds.h # 包围体 -│ │ │ ├── OBB.h # 方向包围盒 -│ │ │ ├── Frustum.h # 视锥体 +│ │ │ └── Frustum.h # 视锥体 │ │ │ └── Math.h # 数学库统一头文件 │ │ ├── Memory/ # 内存管理模块 │ │ │ ├── Allocator.h # 分配器接口 @@ -91,6 +91,7 @@ XCEngine/ │ │ │ ├── LambdaTask.h # Lambda 任务 │ │ │ ├── TaskGroup.h # 任务组 │ │ │ ├── TaskSystem.h # 任务系统 +│ │ │ ├── TaskSystemConfig.h # 任务系统配置 │ │ │ └── Threading.h # 线程模块统一头文件 │ │ ├── Resources/ # 资源管理模块 │ │ │ ├── ResourceTypes.h # 资源类型定义 @@ -102,7 +103,7 @@ XCEngine/ │ │ │ ├── ResourceFileSystem.h # 资源文件系统 │ │ │ ├── ResourcePath.h # 资源路径 │ │ │ ├── FileArchive.h # 文件归档 -│ │ │ ├── DependencyGraph.h # 依赖图 +│ │ │ ├── ResourceDependencyGraph.h # 依赖图 │ │ │ ├── ImportSettings.h # 导入设置基类 │ │ │ ├── IResourceLoader.h # 资源加载器接口 │ │ │ ├── AsyncLoader.h # 异步加载器 @@ -139,7 +140,6 @@ XCEngine/ │ │ ├── RHIPipelineState.h # 管线状态抽象 │ │ ├── RHIPipelineLayout.h # 管线布局抽象 │ │ ├── RHIDescriptorPool.h # 描述符池抽象 -│ │ ├── RHIDescriptor.h # 描述符抽象 │ │ ├── OpenGL/ # OpenGL 后端实现 │ │ │ ├── OpenGLDevice.h │ │ │ ├── OpenGLCommandQueue.h @@ -153,7 +153,8 @@ XCEngine/ │ │ │ ├── OpenGLFence.h │ │ │ ├── OpenGLVertexArray.h │ │ │ ├── OpenGLRenderTargetView.h -│ │ │ └── OpenGLDepthStencilView.h +│ │ │ ├── OpenGLDepthStencilView.h +│ │ │ └── OpenGLScreenshot.h │ │ └── D3D12/ # DirectX 12 后端实现 │ │ ├── D3D12Device.h │ │ ├── D3D12CommandQueue.h @@ -175,8 +176,8 @@ XCEngine/ │ │ ├── D3D12ConstantBufferView.h │ │ ├── D3D12QueryHeap.h │ │ ├── D3D12Screenshot.h -│ │ ├── D3D12Types.h │ │ ├── D3D12Enum.h +│ │ ├── D3D12Types.h │ │ └── D3D12Common.h │ ├── src/ # 实现文件 │ │ ├── Audio/ diff --git a/docs/api/resources/textureimportsettings/clone.md b/docs/api/resources/texture-import-settings/clone.md similarity index 100% rename from docs/api/resources/textureimportsettings/clone.md rename to docs/api/resources/texture-import-settings/clone.md diff --git a/docs/api/resources/textureimportsettings/getbordercolor.md b/docs/api/resources/texture-import-settings/getbordercolor.md similarity index 100% rename from docs/api/resources/textureimportsettings/getbordercolor.md rename to docs/api/resources/texture-import-settings/getbordercolor.md diff --git a/docs/api/resources/textureimportsettings/getcompressionquality.md b/docs/api/resources/texture-import-settings/getcompressionquality.md similarity index 100% rename from docs/api/resources/textureimportsettings/getcompressionquality.md rename to docs/api/resources/texture-import-settings/getcompressionquality.md diff --git a/docs/api/resources/textureimportsettings/getfliphhorizontal.md b/docs/api/resources/texture-import-settings/getfliphhorizontal.md similarity index 100% rename from docs/api/resources/textureimportsettings/getfliphhorizontal.md rename to docs/api/resources/texture-import-settings/getfliphhorizontal.md diff --git a/docs/api/resources/textureimportsettings/getflipvertical.md b/docs/api/resources/texture-import-settings/getflipvertical.md similarity index 100% rename from docs/api/resources/textureimportsettings/getflipvertical.md rename to docs/api/resources/texture-import-settings/getflipvertical.md diff --git a/docs/api/resources/textureimportsettings/getgeneratemipmaps.md b/docs/api/resources/texture-import-settings/getgeneratemipmaps.md similarity index 100% rename from docs/api/resources/textureimportsettings/getgeneratemipmaps.md rename to docs/api/resources/texture-import-settings/getgeneratemipmaps.md diff --git a/docs/api/resources/textureimportsettings/getgeneratenormalmap.md b/docs/api/resources/texture-import-settings/getgeneratenormalmap.md similarity index 100% rename from docs/api/resources/textureimportsettings/getgeneratenormalmap.md rename to docs/api/resources/texture-import-settings/getgeneratenormalmap.md diff --git a/docs/api/resources/textureimportsettings/getmaxanisotropy.md b/docs/api/resources/texture-import-settings/getmaxanisotropy.md similarity index 100% rename from docs/api/resources/textureimportsettings/getmaxanisotropy.md rename to docs/api/resources/texture-import-settings/getmaxanisotropy.md diff --git a/docs/api/resources/textureimportsettings/getmaxsize.md b/docs/api/resources/texture-import-settings/getmaxsize.md similarity index 100% rename from docs/api/resources/textureimportsettings/getmaxsize.md rename to docs/api/resources/texture-import-settings/getmaxsize.md diff --git a/docs/api/resources/textureimportsettings/getmipmapfilter.md b/docs/api/resources/texture-import-settings/getmipmapfilter.md similarity index 100% rename from docs/api/resources/textureimportsettings/getmipmapfilter.md rename to docs/api/resources/texture-import-settings/getmipmapfilter.md diff --git a/docs/api/resources/textureimportsettings/getnormalmapstrength.md b/docs/api/resources/texture-import-settings/getnormalmapstrength.md similarity index 100% rename from docs/api/resources/textureimportsettings/getnormalmapstrength.md rename to docs/api/resources/texture-import-settings/getnormalmapstrength.md diff --git a/docs/api/resources/textureimportsettings/getsrgb.md b/docs/api/resources/texture-import-settings/getsrgb.md similarity index 100% rename from docs/api/resources/textureimportsettings/getsrgb.md rename to docs/api/resources/texture-import-settings/getsrgb.md diff --git a/docs/api/resources/textureimportsettings/gettargetformat.md b/docs/api/resources/texture-import-settings/gettargetformat.md similarity index 100% rename from docs/api/resources/textureimportsettings/gettargetformat.md rename to docs/api/resources/texture-import-settings/gettargetformat.md diff --git a/docs/api/resources/textureimportsettings/gettexturetype.md b/docs/api/resources/texture-import-settings/gettexturetype.md similarity index 100% rename from docs/api/resources/textureimportsettings/gettexturetype.md rename to docs/api/resources/texture-import-settings/gettexturetype.md diff --git a/docs/api/resources/textureimportsettings/getusehardwarecompression.md b/docs/api/resources/texture-import-settings/getusehardwarecompression.md similarity index 100% rename from docs/api/resources/textureimportsettings/getusehardwarecompression.md rename to docs/api/resources/texture-import-settings/getusehardwarecompression.md diff --git a/docs/api/resources/textureimportsettings/loadfromjson.md b/docs/api/resources/texture-import-settings/loadfromjson.md similarity index 100% rename from docs/api/resources/textureimportsettings/loadfromjson.md rename to docs/api/resources/texture-import-settings/loadfromjson.md diff --git a/docs/api/resources/textureimportsettings/savetojson.md b/docs/api/resources/texture-import-settings/savetojson.md similarity index 100% rename from docs/api/resources/textureimportsettings/savetojson.md rename to docs/api/resources/texture-import-settings/savetojson.md diff --git a/docs/api/resources/textureimportsettings/setbordercolor.md b/docs/api/resources/texture-import-settings/setbordercolor.md similarity index 100% rename from docs/api/resources/textureimportsettings/setbordercolor.md rename to docs/api/resources/texture-import-settings/setbordercolor.md diff --git a/docs/api/resources/textureimportsettings/setcompressionquality.md b/docs/api/resources/texture-import-settings/setcompressionquality.md similarity index 100% rename from docs/api/resources/textureimportsettings/setcompressionquality.md rename to docs/api/resources/texture-import-settings/setcompressionquality.md diff --git a/docs/api/resources/textureimportsettings/setfliphhorizontal.md b/docs/api/resources/texture-import-settings/setfliphhorizontal.md similarity index 100% rename from docs/api/resources/textureimportsettings/setfliphhorizontal.md rename to docs/api/resources/texture-import-settings/setfliphhorizontal.md diff --git a/docs/api/resources/textureimportsettings/setflipvertical.md b/docs/api/resources/texture-import-settings/setflipvertical.md similarity index 100% rename from docs/api/resources/textureimportsettings/setflipvertical.md rename to docs/api/resources/texture-import-settings/setflipvertical.md diff --git a/docs/api/resources/textureimportsettings/setgeneratemipmaps.md b/docs/api/resources/texture-import-settings/setgeneratemipmaps.md similarity index 100% rename from docs/api/resources/textureimportsettings/setgeneratemipmaps.md rename to docs/api/resources/texture-import-settings/setgeneratemipmaps.md diff --git a/docs/api/resources/textureimportsettings/setgeneratenormalmap.md b/docs/api/resources/texture-import-settings/setgeneratenormalmap.md similarity index 100% rename from docs/api/resources/textureimportsettings/setgeneratenormalmap.md rename to docs/api/resources/texture-import-settings/setgeneratenormalmap.md diff --git a/docs/api/resources/textureimportsettings/setmaxanisotropy.md b/docs/api/resources/texture-import-settings/setmaxanisotropy.md similarity index 100% rename from docs/api/resources/textureimportsettings/setmaxanisotropy.md rename to docs/api/resources/texture-import-settings/setmaxanisotropy.md diff --git a/docs/api/resources/textureimportsettings/setmaxsize.md b/docs/api/resources/texture-import-settings/setmaxsize.md similarity index 100% rename from docs/api/resources/textureimportsettings/setmaxsize.md rename to docs/api/resources/texture-import-settings/setmaxsize.md diff --git a/docs/api/resources/textureimportsettings/setmipmapfilter.md b/docs/api/resources/texture-import-settings/setmipmapfilter.md similarity index 100% rename from docs/api/resources/textureimportsettings/setmipmapfilter.md rename to docs/api/resources/texture-import-settings/setmipmapfilter.md diff --git a/docs/api/resources/textureimportsettings/setnormalmapstrength.md b/docs/api/resources/texture-import-settings/setnormalmapstrength.md similarity index 100% rename from docs/api/resources/textureimportsettings/setnormalmapstrength.md rename to docs/api/resources/texture-import-settings/setnormalmapstrength.md diff --git a/docs/api/resources/textureimportsettings/setsrgb.md b/docs/api/resources/texture-import-settings/setsrgb.md similarity index 100% rename from docs/api/resources/textureimportsettings/setsrgb.md rename to docs/api/resources/texture-import-settings/setsrgb.md diff --git a/docs/api/resources/textureimportsettings/settargetformat.md b/docs/api/resources/texture-import-settings/settargetformat.md similarity index 100% rename from docs/api/resources/textureimportsettings/settargetformat.md rename to docs/api/resources/texture-import-settings/settargetformat.md diff --git a/docs/api/resources/textureimportsettings/settexturetype.md b/docs/api/resources/texture-import-settings/settexturetype.md similarity index 100% rename from docs/api/resources/textureimportsettings/settexturetype.md rename to docs/api/resources/texture-import-settings/settexturetype.md diff --git a/docs/api/resources/textureimportsettings/setusehardwarecompression.md b/docs/api/resources/texture-import-settings/setusehardwarecompression.md similarity index 100% rename from docs/api/resources/textureimportsettings/setusehardwarecompression.md rename to docs/api/resources/texture-import-settings/setusehardwarecompression.md diff --git a/docs/api/resources/textureimportsettings/textureimportsettings.md b/docs/api/resources/textureimportsettings/textureimportsettings.md deleted file mode 100644 index a7798ad2..00000000 --- a/docs/api/resources/textureimportsettings/textureimportsettings.md +++ /dev/null @@ -1,101 +0,0 @@ -# TextureImportSettings - -**命名空间**: `XCEngine::Resources` - -**类型**: `class` - -**继承**: `ImportSettings` - -**描述**: 纹理资源导入设置类,配置纹理导入时的各种参数选项。 - -## 概述 - -`TextureImportSettings` 继承自 `ImportSettings`,提供了纹理资源导入时的完整配置选项。包括纹理类型、目标格式、Mipmap 生成、压缩质量、各向异性、sRGB 转换、翻转操作、法线图生成等功能。 - -## 公共方法 - -| 方法 | 描述 | -|------|------| -| [`Clone`](clone.md) | 克隆一份导入设置 | -| [`LoadFromJSON`](loadfromjson.md) | 从 JSON 加载设置 | -| [`SaveToJSON`](savetojson.md) | 保存设置到 JSON | -| [`SetTextureType`](settexturetype.md) | 设置纹理类型 | -| [`GetTextureType`](gettexturetype.md) | 获取纹理类型 | -| [`SetTargetFormat`](settargetformat.md) | 设置目标格式 | -| [`GetTargetFormat`](gettargetformat.md) | 获取目标格式 | -| [`SetGenerateMipmaps`](setgeneratemipmaps.md) | 设置是否生成 Mipmap | -| [`GetGenerateMipmaps`](getgeneratemipmaps.md) | 获取是否生成 Mipmap | -| [`SetMipmapFilter`](setmipmapfilter.md) | 设置 Mipmap 滤波器 | -| [`GetMipmapFilter`](getmipmapfilter.md) | 获取 Mipmap 滤波器 | -| [`SetMaxAnisotropy`](setmaxanisotropy.md) | 设置最大各向异性级别 | -| [`GetMaxAnisotropy`](getmaxanisotropy.md) | 获取最大各向异性级别 | -| [`SetSRGB`](setsrgb.md) | 设置是否 sRGB | -| [`GetSRGB`](getsrgb.md) | 获取 sRGB 设置 | -| [`SetFlipVertical`](setflipvertical.md) | 设置是否垂直翻转 | -| [`GetFlipVertical`](getflipvertical.md) | 获取垂直翻转设置 | -| [`SetFlipHorizontal`](setfliphhorizontal.md) | 设置是否水平翻转 | -| [`GetFlipHorizontal`](getfliphhorizontal.md) | 获取水平翻转设置 | -| [`SetBorderColor`](setbordercolor.md) | 设置边框颜色 | -| [`GetBorderColor`](getbordercolor.md) | 获取边框颜色 | -| [`SetCompressionQuality`](setcompressionquality.md) | 设置压缩质量 | -| [`GetCompressionQuality`](getcompressionquality.md) | 获取压缩质量 | -| [`SetUseHardwareCompression`](setusehardwarecompression.md) | 设置是否使用硬件压缩 | -| [`GetUseHardwareCompression`](getusehardwarecompression.md) | 获取硬件压缩设置 | -| [`SetMaxSize`](setmaxsize.md) | 设置最大纹理尺寸 | -| [`GetMaxSize`](getmaxsize.md) | 获取最大纹理尺寸 | -| [`SetGenerateNormalMap`](setgeneratenormalmap.md) | 设置是否生成法线贴图 | -| [`GetGenerateNormalMap`](getgeneratenormalmap.md) | 获取法线贴图生成设置 | -| [`SetNormalMapStrength`](setnormalmapstrength.md) | 设置法线贴图强度 | -| [`GetNormalMapStrength`](getnormalmapstrength.md) | 获取法线贴图强度 | - -## 枚举类型 - -### MipmapFilter - -Mipmap 滤波算法。 - -| 值 | 描述 | -|----|------| -| `Box` | Box 滤波器 | -| `Kaiser` | Kaiser 滤波器 | - -### CompressionQuality - -纹理压缩质量级别。 - -| 值 | 描述 | -|----|------| -| `Low` | 低质量压缩 | -| `Medium` | 中等质量压缩 | -| `High` | 高质量压缩 | -| `Ultra` | 超高质量压缩 | - -## 使用示例 - -```cpp -#include - -TextureImportSettings settings; -settings.SetTextureType(TextureType::Texture2D); -settings.SetGenerateMipmaps(true); -settings.SetMipmapFilter(MipmapFilter::Kaiser); -settings.SetSRGB(true); -settings.SetCompressionQuality(CompressionQuality::High); -settings.SetMaxAnisotropy(16); -settings.SetMaxSize(2048); -settings.SetGenerateNormalMap(true); -settings.SetNormalMapStrength(1.0f); - -// 保存设置 -Containers::String json = settings.SaveToJSON(); - -// 克隆设置 -auto cloned = settings.Clone(); -``` - -## 相关文档 - -- [ImportSettings](../importsettings/importsettings.md) - 导入设置基类 -- [Texture](../texture/texture.md) - 纹理资源 -- [ResourceManager](../resourcemanager/resourcemanager.md) - 资源管理器 -- [Resources 总览](../resources.md) - 返回模块总览