目录

Overview

Class Summary

Class

Description

AABB

描述网格包围盒的类,包围盒为一个立方体。包括包围盒对象间的赋值、比较,获取包围盒最小、最大坐标、中心点坐标、角坐标等。

AnimationComponent

动画组件类。主要提供动画组件的播放、暂停、停止及每帧更新,设置动画播放速度及播放模式等功能。

BaseApplication

应用场景使用类,负责引擎初始化,Shader系统初始化,渲染管线初始化;负责场景系统更新,渲染流程管理。

BufferMemoryBarrier

缓冲存储屏障类,用于缓冲存储屏障的创建。

Buffer

数据缓冲类,用于数据缓存区的创建。

Camera

相机类,主要提供相机的位置、投影类型、视场角、近裁平面、远裁平面的设置和获取。

CGKitInterface

CG Kit接口类,可设置、获取应用程序,获取屏幕宽高比及宽度、高度等。

注意:

V6.8.0版本开始,该类已融合到BaseApplication类,原有的参数设置可直接调用BaseApplication中相关接口设置即可。

Color

描述颜色的类,包含颜色对象间的赋值、比较操作,及固定颜色值的设置。

CommandBuffer

命令缓冲类,用于命令缓存区的有关操作。

CameraFrameGraph

CameraFrameGraph类,专用于FrameGraph的Camera类。

DynamicArray

动态数组类。包括元素的存储和清理操作,可以根据元素大小动态调整数组的空间,释放资源。

DynamicBuffer

动态缓冲类,创建动态缓冲。

DescriptorSet

描述符集类,用于描述符集的创建。

DescriptorSetLayout

描述符集布局类,用于描述符集布局的创建。

DirectedAcyclicGraph

有向无环图类,用于构造FrameGraph的数据结构。

EdgeFG

FrameGraph有向无环图中的边类,对应FrameGraph中有向无环图中的一个边。

FrameBuffer

帧缓冲类,包括帧缓冲对象的新增和获取创建信息操作。

FrameGraph

FrameGraph类,处理多个Pass关系。

FGBuilder

FGBuilder类,创建资源以及添加资源与Pass的读写关系。

FGHandle

FGHandle类,资源的下标索引。

FGTexture

FGTexture类,FrameGraph对Texture的封装。

FGRenderPass

FrameGraph渲染通道类,用于FrameGraph中实际的渲染操作。

GraphicsRenderer

图形渲染器类,提供贴图创建、管线创建和缓冲创建等功能。

IComponent

组件基类,主要提供组件启动、每帧更新等功能。

InputEvent

事件消息类,目前包括键盘,触摸事件类型。

IResource

通用资源类,继承自RefCount,存储纹理、模型、材质等二进制数据,含有资源路径、资源大小、资源类型、ID、读取状态等信息。

IPassExecuter

Pass执行器接口,提供Pass执行器所需的虚函数。

KeyInputEvent

键盘输入事件类,具有识别键盘输入键值及按键动作的能力。

Light

灯光类。主要提供灯光颜色,类型,强度,光源位置设置及获取等功能。

Log

日志类。包含日志记录器的注册、注销,及char数组类型数据作为log信息输出。

Material

材质类,负责管线初始化,着色器的绑定,纹理、光栅化状态、深度测试、混合操作的设置和获取。

注意:

V6.0.0.300版本开始,该类已融合到MaterialInstance类,您无需额外调用Material,即可实现材质属性信息的定义。

MaterialInstance

材质实例类,负责实现材质属性信息的定义,完成材质文件脚本化,实现加载与解析。创建材质实例,结合Pipeline state实现Pipeline共用,减少重复Pipeline创建时间。

Matrix4

4*4矩阵类。包含矩阵的赋值、比较、加减乘法、求行列式、求逆、转置等操作,及作为旋转矩阵协助旋转操作。

Mesh

网格类,主要提供子网格的添加、删除、查询和网格包围盒的获取等功能。

MeshRenderer

网格渲染类,主要对网格进行渲染。配置当前网格的所有子网格的模型矩阵、材质参数。

Model

模型资源类,继承自IResource,通过资源读取过程生成完整的Mesh实例。

MouseInputEvent

鼠标输入事件类。可以监听单击、右击和滑轮等事件,可以获取鼠标位置和滚轮变化值。

MemoryAllocator

FrameGraph中的内存分配器。

NodeFG

FrameGraph有向无环图中的节点,对应FrameGraph中有向无环图中的一个节点。

Plane

平面类。包含平面类对象的赋值、比较操作,及设置平面法向量、原点到平面距离等。

PostProcessStage

后处理基类,用于派生拥有具体特效的后处理。

Pipeline

管线类,用于渲染管线的创建。

PipelineLayout

管线布局类,用于渲染管线布局的创建。

PassExecuter

Pass的执行类。

PassNode

PassNode类,各种类型Pass的基类。

Quaternion

四元数类。包含四元数的赋值、比较、加减乘除、点乘、求逆、归一化、转轴角对、转欧拉角等操作。

Queue

队列类,用于队列的创建。

RefCount

资源引用计数类。包含资源引用计数的增加、减少,以及判断资源是否可销毁等功能。

Renderable

渲染基类。 包括设置和获取网格,轴对齐包围盒(AABB)检测更新。

ResourceManager

单例类。资源管理器类,管理已知格式资源,包括模型、纹理、材质等资源的加载和删除等功能。

RenderPass

渲染通道类,用于渲染通道的创建。

RenderTarget

渲染目标类,渲染目标就是一个缓冲区,用来记录渲染后输出的结果,不是直接将帧缓冲绘制到屏幕。

RenderingPath

渲染路径类,与渲染目标使用光照的流程相关。

RenderStage

渲染阶段基类,是渲染的一个阶段,收集渲染数据并执行渲染。

ResourceAllocator

资源分配器类,用于分配FrameGraph中的资源对象并初始化。

ResourceEdge

FrameGraph资源边类,对应FrameGraph中有向无环图中的一个资源边。

ResourceNode

FrameGraph资源节点类,对应FrameGraph中有向无环图中的一个资源节点。

SceneManager

单例类。场景管理类,主要提供场景系统初始化,资源释放,场景对象增删,渲染队列管理,Camera对象获取和设置。

SceneObject

场景对象类,主要提供当前场景中组件管理,模型旋转、缩放,场景可见性配置,父场景配置,子场景配置等功能。

Singleton

单例模板类。

SubMesh

子网格类,保存顶点缓冲、索引缓冲、图元类型、材质等数据,是完成渲染任务的最小单元。

Sampler

采样器类。用于对纹理的采样。

SwapChain

交换链类,包括交换链的创建、调整交换链的大小等。

Shader

着色器类,用于保存着色器的资源等详细信息。

ShaderStage

着色器阶段类,用于保存着色器的详细信息。

ScreenQuad

屏幕四边形类,用于生成经过渲染后显示在屏幕上的纹理。

TimerManager

定时器类,可以按照计划执行任务,延迟一定时间执行某个任务或重复执行。

TouchInputEvent

触摸输入事件类,具有监控单指,多指操作的能力。

Transform

坐标转换类,主要提供不同坐标系下向量平移、旋转和缩放功能,以及不同坐标间的转换矩阵。

TweenManager

单例类。关键帧动画管理类,主要管理动画效果对象的新增和删除。

Texture

纹理类。包括纹理的创建、更新等操作。

TextureMemoryBarrier

纹理存储屏障类,用于纹理存储屏障的创建。

UniformBuffer

UniformBuffer类,创建UniformBuffer。

Vector2

二维向量类。包括二维向量的取负、加法、减法、乘法、除法、点乘计算。

Vector3

三维向量类。包括三维向量的取负、加法、减法、乘法、除法、点乘、叉乘计算。

Vector4

四维向量类。包括四维向量的取负、加法、减法、乘法、除法、点乘计算。

VirtualResourceBase

VirtualResourceBase类,表示资源的基类。

VirtualResource

虚拟资源。虚拟资源为FrameGraph类中对资源的封装。

Enum Value Summary

Enum

Description

AnimationPlayMode

播放模式枚举。

AccessFlagBits

权限类型枚举。

AttachmentFlages

附件加载方式。

BlendFactor

混合因子类型枚举。

BlendOperation

混合操作类型枚举。

BufferCreateUsage

数据缓存区用法枚举。

CompareOperation

深度测试操作类型枚举。

CornerType

网格包围盒八个角的枚举。

ConstantType

着色器里结构体类型枚举。

ConstantValueType

结构体下变量对应的数据类型枚举。

CullMode

渲染剔除类型枚举。

CommandBufferLevelType

命令缓冲级别类型枚举。

DynamicFlag

管线渲染期间可以修改的动态状态枚举。

EventSource

输入事件类型枚举。

FillMode

渲染填充类型枚举。

FrontFace

三角形顶点绕序类型枚举。

FenceFlag

指定Fence创建时的信号状态。

ImageType

纹理类型枚举。

ImageTiling

纹素平铺排列的方式。

ImageUsageFlagBits

指定图像的使用标志枚举。

ImageCreateFlagBits

图像创建标志枚举。

ImageLayout

图像布局方式枚举。

KeyAction

按键事件类型枚举。

KeyCode

全键盘按键键值枚举。

LayerType

相机显示的场景类型枚举。

LightType

灯光类型枚举。

LoadState

资源读取状态枚举。

LogicOp

帧缓冲与输入像素的逻辑操作方式枚举。

LogPathType

日志输出路径类型枚举。

LogType

日志输出类型枚举。

LoadOp

子通道在渲染之前对附件中数据的操作方式枚举。

MouseAction

鼠标事件枚举类型。

MemoryPropertyFlagBits

内存的类型。

MemCreateUsage

内存用法枚举。

PixelFormat

像素组织形式枚举。

PrimitiveMode

投射源类型枚举。

ProjectionType

灯光投影类型枚举。

PipelineBindPoint

子通道支持的管道类型枚举。

PipelineStageFlagBits

渲染管线阶段标志枚举。

PassType

渲染Pass类型。

QueueType

队列类型枚举。

RenderingPathType

渲染路径类型枚举。

RenderingSortType

渲染排序枚举。

RenderTargetType

渲染目标类型枚举。

ResourceType

根据资源内容定义的资源类型枚举。

ResourceUsage

资源用途。

SamplerAddress

纹理寻址模式枚举。

SampleCountFlagBits

采样数枚举。

SamplerFilter

采样过滤器类型枚举。

SamplerMipmapMode

采样器Mipmap模式枚举。

SceneManagerType

场景管理器类型枚举。

ShaderStageType

着色器阶段类型枚举。

StencilOperation

模板操作测试枚举。

ShaderResourceType

着色器中资源类型枚举。

ShaderSourceType

着色器文件类型枚举。

StoreOp

子通道在渲染之后对附件中数据的操作方式枚举。

StageType

定义渲染阶段类型枚举。

StencilFaceFlag

定义模板状态枚举。

SubpassContents

子通道内容。

SubpassType

渲染子流程类型。

TextureType

纹理类型枚举。

注意:

V6.8.0版本开始,该枚举类已废弃。

TouchAction

触摸事件类型枚举。

TextureUsage

指定图像用途枚举。

VertexLayout

顶点属性的组织枚举。

Struct Summary

Struct

Description

Attachment

附件参数信息,用于创建渲染通道。

BufferMemoryBarrierAccessAndQueueInfo

缓冲存储屏障的权限与队列参数信息结构体。

BufferCreateInfo

缓存区创建信息结构体。

BufferMemoryBarrierInfo

缓冲存储屏障参数信息结构体。

BufferViewCreateInfo

缓存切片区创建信息结构体。

BlendAttachmentState

颜色附着的混合配置。

BufferAllocation

缓存切片区信息结构体。

CameraSortFunc

两个相机对象间的排序函数结构体。

ClearValue

清屏色参数信息结构体。

CascadeViewProjMatrixUniform

记录级联拆分相关的VP矩阵、深度的信息结构体。

ColorBlendState

管线的颜色混合配置。

CommandBufferCreateInfo

命令缓冲区的创建信息。

DepthStencilOp

深度测试和模板测试操作信息。

DepthStencilState

深度测试和模板测试配置信息。

DescriptorSetCreateInfo

描述符集参数信息,用于创建描述符集。

DescriptorSetLayoutCreateInfo

帧缓冲参数信息,用于创建帧缓冲对象。

DescriptorSetLayoutBinding

描述符集布局绑定信息。

Descriptor(FGTexture)

FrameGraph中对纹理的描述。

FrameBufferCreateInfo

帧缓冲参数信息,用于创建帧缓冲对象。

IResourceDesc

资源描述信息结构体。

注意:

V6.8.0版本开始,该结构体已废弃。

MouseCoord

鼠标坐标信息结构体。

MultiSampleInfo

多重采样抗锯齿参数结构体。

QueueCreateInfo

队列参数信息,用于创建队列对象。

PipelineCreateInfo

管线的创建信息。

PipelineLayoutCreateInfo

管线布局的创建信息。

PassExecuteParam

FrameGraph中渲染所需信息。

ResourceLoadInfo

资源加载的相关输入信息结构体。

RenderPassCreateInfo

渲染通道参数信息,用于创建一个渲染通道。

RenderTargetCreateInfo

创建渲染目标的数据结构体。

RasterizationState

管线的光栅化参数信息。

ResourceHandle(ResourceAllocator)

FrameGraph中资源的封装。

SamplerParam

采样器参数结构体。

注意:

该结构体已废弃,请使用SamplerCreateInfo结构体替代。

SamplerCreateInfo

采样器参数。

ScheduleInfo

定时器参数结构体。

SubpassInfo

子通道参数信息,用于创建渲染通道。

SwapChainCreateInfo

交换链参数信息,用于创建交换链。

ShaderResource

着色器资源信息结构体。

ShaderStageCreateInfo

shader stage创建参数信息结构体。

ShaderCreateInfo

着色器创建信息结构体。

TouchCoord

触摸事件坐标结构体。

TextureCreateInfo

纹理参数信息,用于创建纹理。

TextureMemoryBarrierAccessAndQueueInfo

纹理存储屏障的权限与队列参数信息结构体。

TextureMemoryBarrierInfo

纹理存储屏障参数信息结构体。

TextureViewCreateInfo

纹理视图参数信息,用于创建纹理。

TextureUpdateRegion

纹理参数信息,用于指定要更新的纹理区域。

TextureExtent

纹理区域的参数信息,用于指定要更新的纹理区域位置大小。

TextureSubresLayers

纹理区域的附加信息,用于指定要更新的纹理区域附加信息。

VertexAttribute

顶点属性结构体。

Viewport

视口信息结构体。

Namespace Summary

Namespace

Description

Math

数学处理函数库。

ModelHelper

生成和删除Model对象。

ShadowParams

阴影参数。