refactor api documentation structure
This commit is contained in:
@@ -0,0 +1,64 @@
|
||||
# TextureImportSettings
|
||||
|
||||
**命名空间**: `XCEngine::Resources`
|
||||
|
||||
**类型**: `class`
|
||||
|
||||
**头文件**: `XCEngine/Resources/Texture/TextureImportSettings.h`
|
||||
|
||||
**描述**: 定义 `XCEngine/Resources/Texture` 子目录中的 `TextureImportSettings` public API。
|
||||
|
||||
## 概述
|
||||
|
||||
`TextureImportSettings.h` 是 `XCEngine/Resources/Texture` 子目录 下的 public header,当前页面作为平行目录中的 canonical 总览,用于汇总该头文件暴露的主要声明。
|
||||
|
||||
## 声明概览
|
||||
|
||||
| 声明 | 类型 | 说明 |
|
||||
|------|------|------|
|
||||
| `MipmapFilter` | `enum class` | 头文件中的公开声明。 |
|
||||
| `CompressionQuality` | `enum class` | 头文件中的公开声明。 |
|
||||
| `TextureImportSettings` | `class` | 继承自 `ImportSettings` 的公开声明。 |
|
||||
|
||||
## 公共方法
|
||||
|
||||
| 方法 | 描述 |
|
||||
|------|------|
|
||||
| [TextureImportSettings()](Constructor.md) | 构造对象。 |
|
||||
| [~TextureImportSettings()](Destructor.md) | 销毁对象并释放相关资源。 |
|
||||
| [Clone](Clone.md) | 公开方法,详见头文件声明。 |
|
||||
| [LoadFromJSON](LoadFromJSON.md) | 加载资源或数据。 |
|
||||
| [SaveToJSON](SaveToJSON.md) | 公开方法,详见头文件声明。 |
|
||||
| [SetTextureType](SetTextureType.md) | 设置相关状态或配置。 |
|
||||
| [GetTextureType](GetTextureType.md) | 获取相关状态或对象。 |
|
||||
| [SetTargetFormat](SetTargetFormat.md) | 设置相关状态或配置。 |
|
||||
| [GetTargetFormat](GetTargetFormat.md) | 获取相关状态或对象。 |
|
||||
| [SetGenerateMipmaps](SetGenerateMipmaps.md) | 设置相关状态或配置。 |
|
||||
| [GetGenerateMipmaps](GetGenerateMipmaps.md) | 获取相关状态或对象。 |
|
||||
| [SetMipmapFilter](SetMipmapFilter.md) | 设置相关状态或配置。 |
|
||||
| [GetMipmapFilter](GetMipmapFilter.md) | 获取相关状态或对象。 |
|
||||
| [SetMaxAnisotropy](SetMaxAnisotropy.md) | 设置相关状态或配置。 |
|
||||
| [GetMaxAnisotropy](GetMaxAnisotropy.md) | 获取相关状态或对象。 |
|
||||
| [SetSRGB](SetSRGB.md) | 设置相关状态或配置。 |
|
||||
| [GetSRGB](GetSRGB.md) | 获取相关状态或对象。 |
|
||||
| [SetFlipVertical](SetFlipVertical.md) | 设置相关状态或配置。 |
|
||||
| [GetFlipVertical](GetFlipVertical.md) | 获取相关状态或对象。 |
|
||||
| [SetFlipHorizontal](SetFlipHorizontal.md) | 设置相关状态或配置。 |
|
||||
| [GetFlipHorizontal](GetFlipHorizontal.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) | 获取相关状态或对象。 |
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [当前目录](../Texture.md) - 返回 `Texture` 平行目录
|
||||
- [API 总索引](../../../../main.md) - 返回顶层索引
|
||||
Reference in New Issue
Block a user