xuanchi/XCEngine
1
1
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: fix Resources module API docs naming conventions and broken links

Browse Source 
- Rename constructor/destructor files to follow template spec:
  - ctor.md → constructor.md, dtor.md → destructor.md (audioclip)
  - texture_constructor.md → constructor.md, texture_destructor.md → destructor.md (texture)
  - material-loader-constructor.md → constructor.md, material-loader-destructor.md → destructor.md

- Create missing constructor/destructor docs:
  - audio-loader: constructor.md, destructor.md
  - texture-loader: constructor.md, destructor.md

- Fix broken links to ResourceManager:
  - shader-loader/index.md
  - material-loader/index.md

- Remove duplicate folders (keep hyphenated versions):
  - Delete shaderloader/ (keep shader-loader/)
  - Delete resourcepackage/ (keep resource-package/)
  - Merge textureimportsettings/ into texture-import-settings/

- Rename audio-loader method files:
  - canload.md → can-load.md
  - getdefaultsettings.md → get-default-settings.md
  - getsupportedextensions.md → get-supported-extensions.md

- Update overview pages with proper method links and constructor/destructor entries
This commit is contained in:
ssdfasd
2026-03-22 14:42:27 +08:00
parent 1797e7fe17
commit 6af872e9eb
11 changed files with 224 additions and 99 deletions
Download Patch File Download Diff File Expand all files Collapse all files

63
docs/api/resources/texture-import-settings/texture-import-settings.md
View File

@@ -24,37 +24,37 @@
|------|------|
| `TextureImportSettings()` | 构造函数 |
| `virtual ~TextureImportSettings() override` | 析构函数 |
| `Core::UniqueRef<ImportSettings> Clone() const override` | 克隆设置对象 |
| `bool LoadFromJSON(const Containers::String& json) override` | 从 JSON 加载设置（stub） |
| `Containers::String SaveToJSON() const override` | 保存为 JSON（stub） |
| `void SetTextureType(TextureType type)` | 设置纹理类型 |
| `TextureType GetTextureType() const` | 获取纹理类型 |
| `void SetTargetFormat(TextureFormat format)` | 设置目标格式 |
| `TextureFormat GetTargetFormat() const` | 获取目标格式 |
| `void SetGenerateMipmaps(bool generate)` | 设置是否生成 Mipmap |
| `bool GetGenerateMipmaps() const` | 获取是否生成 Mipmap |
| `void SetMipmapFilter(MipmapFilter filter)` | 设置 Mipmap 滤波器 |
| `MipmapFilter GetMipmapFilter() const` | 获取 Mipmap 滤波器 |
| `void SetMaxAnisotropy(Core::uint32 anisotropy)` | 设置最大各向异性级别 |
| `Core::uint32 GetMaxAnisotropy() const` | 获取最大各向异性级别 |
| `void SetSRGB(bool srgb)` | 设置是否 sRGB |
| `bool GetSRGB() const` | 获取 sRGB 设置 |
| `void SetFlipVertical(bool flip)` | 设置是否垂直翻转 |
| `bool GetFlipVertical() const` | 获取垂直翻转设置 |
| `void SetFlipHorizontal(bool flip)` | 设置是否水平翻转 |
| `bool GetFlipHorizontal() const` | 获取水平翻转设置 |
| `void SetBorderColor(const Math::Vector3& color)` | 设置边框颜色 |
| `const Math::Vector3& GetBorderColor() const` | 获取边框颜色 |
| `void SetCompressionQuality(CompressionQuality quality)` | 设置压缩质量 |
| `CompressionQuality GetCompressionQuality() const` | 获取压缩质量 |
| `void SetUseHardwareCompression(bool use)` | 设置是否使用硬件压缩 |
| `bool GetUseHardwareCompression() const` | 获取硬件压缩设置 |
| `void SetMaxSize(Core::uint32 size)` | 设置最大纹理尺寸 |
| `Core::uint32 GetMaxSize() const` | 获取最大纹理尺寸 |
| `void SetGenerateNormalMap(bool generate)` | 设置是否生成法线贴图 |
| `bool GetGenerateNormalMap() const` | 获取法线贴图生成设置 |
| `void SetNormalMapStrength(float strength)` | 设置法线贴图强度 |
| `float GetNormalMapStrength() const` | 获取法线贴图强度 |
| [Clone](clone.md) | 克隆设置对象 |
| [LoadFromJSON](loadfromjson.md) | 从 JSON 加载设置（stub） |
| [SaveToJSON](savetojson.md) | 保存为 JSON（stub） |
| [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) | 获取法线贴图强度 |
---
@@ -112,7 +112,6 @@ ResourceHandle<Texture> tex = ResourceManager::Get().Load<Texture>("textures/dif
## 相关文档
- [方法详情](methods.md) - 所有方法的详细文档
- [ImportSettings](../importsettings/importsettings.md) - 导入设置基类
- [IResourceLoader](../iloader/iloader.md) - 资源加载器接口
- [ResourceManager](../resourcemanager/resourcemanager.md) - 资源管理器