Internal
Ploy3D / Internal
Interface: Internal
内核接口。
Table of contents
Properties
- AnimationClip_AddRef
- AnimationClip_Release
- AnimationClip_Update
- AnimationData_Release
- Camera_ScreenPointToRay
- Camera_Update
- Collider_Init
- Collider_UpdateCharacterCtrl
- Engine_CameraCulling
- Engine_ComputeVsmLightSpaceMatrix
- Engine_CreateAnimation
- Engine_CreateMesh
- Engine_CreateObject
- Engine_CreateScene
- Engine_CreateSkeletonSkin
- Engine_CreateSkin
- Engine_CreateTexture
- Engine_CreateUniform
- Engine_DestroyScenes
- Engine_GetMaterialBranchKey
- Engine_SetActiveScene
- Engine_UploadInstanceArray
- Matrix4x4_Cofactor
- Matrix4x4_CorrectCullingProjection
- Matrix4x4_CorrectProjection
- Matrix4x4_Decompose
- Matrix4x4_Determinant
- Matrix4x4_FromLookAt
- Matrix4x4_FromTransform
- Matrix4x4_Invert
- Matrix4x4_MakeFrustumRH
- Matrix4x4_MakeLensProjectionRH
- Matrix4x4_MakePerspectiveProjectionRH
- Matrix4x4_MultiplyMatrices
- Matrix4x4_MultiplyVector
- Matrix4x4_Project
- Matrix4x4_Transpose
- MeshRenderer_SetMaterial
- Mesh_Release
- Object3D_AddAnimator
- Object3D_AddCamera
- Object3D_AddCollider
- Object3D_AddMeshRenderer
- Object3D_Destroy
- Object3D_GetAABB
- Object3D_RemoveCamera
- Object3D_RemoveMeshRenderer
- Object3D_SetHighlight
- Object3D_SetMeshRenderer
- Object3D_Update
- Object3D_UploadG1
- Quaternion_ComputeTangentFrame2
- Quaternion_FromEulerAngles
- Quaternion_FromRotationMatrix
- Quaternion_FromVectors
- Quaternion_Invert
- Quaternion_Multiply
- Quaternion_Normalize
- Quaternion_RotateVector
- Quaternion_Slerp
- Quaternion_ToEulerAngles
- SH_GetColorEstimate
- SH_GetDirectionEstimate
- Scene_Destroy
- Scene_GetMainCamera
- Scene_GetRootObjectList
- Scene_Update
- SkeletonSkin_Release
- Skin_Release
- System_Analyse
- System_Delete
- System_New
- System_Shutdown
- System_Startup
- TRI_CalNormals
- TRI_CalTangents
- TRI_MixTangents
- Texture_Release
- Transform_SetLocalMatrix
- Transform_SetParent
- Transform_SetPosition
- Transform_SetRotation
- Transform_Update
- Uniform_Release
- Uniform_ReplaceTextureRef
- Util_Compress_lz4
- Util_Decompress_lz4
- Util_Free_ktx2
- Util_Transcoder_ktx2
- Vector3_Add
- Vector3_Cross
- Vector3_Dot
- Vector3_Length
- Vector3_Lerp
- Vector3_Max
- Vector3_MaxElement
- Vector3_MultiplyScalar
- Vector3_Normalize
- Vector3_Sub
- Vector4_Max
- Vector4_MaxElement
- Vector4_MultiplyScalar
- __stack_pointer
Properties
AnimationClip_AddRef
• AnimationClip_AddRef: (animationClip
: io_ptr
) => void
Type declaration
▸ (animationClip
): void
增加动画片段引用。
Parameters
Name | Type |
---|---|
animationClip | io_ptr |
Returns
void
AnimationClip_Release
• AnimationClip_Release: (animationClip
: io_ptr
) => void
Type declaration
▸ (animationClip
): void
释放动画片段实例引用。
Parameters
Name | Type |
---|---|
animationClip | io_ptr |
Returns
void
AnimationClip_Update
• AnimationClip_Update: (animationClip
: io_ptr
, curTS
: number
, startTS
: number
) => void
Type declaration
▸ (animationClip
, curTS
, startTS
): void
更新动画片段(后两参数可默认设置为0)。
Parameters
Name | Type |
---|---|
animationClip | io_ptr |
curTS | number |
startTS | number |
Returns
void
AnimationData_Release
• AnimationData_Release: (animationData
: io_ptr
) => void
Type declaration
▸ (animationData
): void
释放动画片段数据引用。
Parameters
Name | Type |
---|---|
animationData | io_ptr |
Returns
void
Camera_ScreenPointToRay
• Camera_ScreenPointToRay: (camera
: io_ptr
, x
: number
, y
: number
, origin
: io_ptr
, dir
: io_ptr
) => void
Type declaration
▸ (camera
, x
, y
, origin
, dir
): void
获取相机屏幕拾取射线(XY取值[0, 1])。
Parameters
Name | Type |
---|---|
camera | io_ptr |
x | number |
y | number |
origin | io_ptr |
dir | io_ptr |
Returns
void
Camera_Update
• Camera_Update: (camera
: io_ptr
) => void
Type declaration
▸ (camera
): void
更新应用相机最新参数。
Parameters
Name | Type |
---|---|
camera | io_ptr |
Returns
void
Collider_Init
• Collider_Init: (collider
: io_ptr
) => void
Type declaration
▸ (collider
): void
初始化碰撞组件。
Parameters
Name | Type |
---|---|
collider | io_ptr |
Returns
void
Collider_UpdateCharacterCtrl
• Collider_UpdateCharacterCtrl: (collider
: io_ptr
, moveZ
: number
, moveX
: number
, rotY
: number
, jump
: number
, speed
: number
) => void
Type declaration
▸ (collider
, moveZ
, moveX
, rotY
, jump
, speed
): void
控制角色控制器。
Parameters
Name | Type |
---|---|
collider | io_ptr |
moveZ | number |
moveX | number |
rotY | number |
jump | number |
speed | number |
Returns
void
Engine_CameraCulling
• Engine_CameraCulling: (scene
: io_ptr
, camera
: io_ptr
, layerMask
: number
, sort
: number
) => io_ptr
Type declaration
▸ (scene
, camera
, layerMask
, sort
): io_ptr
裁剪场景可见对象。
Parameters
Name | Type |
---|---|
scene | io_ptr |
camera | io_ptr |
layerMask | number |
sort | number |
Returns
Engine_ComputeVsmLightSpaceMatrix
• Engine_ComputeVsmLightSpaceMatrix: (dirX
: number
, dirY
: number
, dirZ
: number
, camera
: io_ptr
, outMat
: io_ptr
, ptrSphere
: io_ptr
) => void
Type declaration
▸ (dirX
, dirY
, dirZ
, camera
, outMat
, ptrSphere
): void
构造用于VSM的光照空间矩阵。
Parameters
Name | Type |
---|---|
dirX | number |
dirY | number |
dirZ | number |
camera | io_ptr |
outMat | io_ptr |
ptrSphere | io_ptr |
Returns
void
Engine_CreateAnimation
• Engine_CreateAnimation: (data
: io_ptr
, startTrack
: number
, samplerCount
: number
, channelCount
: number
) => io_ptr
Type declaration
▸ (data
, startTrack
, samplerCount
, channelCount
): io_ptr
创建动画数据对象。
Parameters
Name | Type |
---|---|
data | io_ptr |
startTrack | number |
samplerCount | number |
channelCount | number |
Returns
Engine_CreateMesh
• Engine_CreateMesh: (vbCount
: number
, ibCount
: number
) => io_ptr
Type declaration
▸ (vbCount
, ibCount
): io_ptr
创建网格对象。
Parameters
Name | Type |
---|---|
vbCount | number |
ibCount | number |
Returns
Engine_CreateObject
• Engine_CreateObject: () => io_ptr
Type declaration
▸ (): io_ptr
创建3D对象。
Returns
Engine_CreateScene
• Engine_CreateScene: () => io_ptr
Type declaration
▸ (): io_ptr
创建新场景。
Returns
Engine_CreateSkeletonSkin
• Engine_CreateSkeletonSkin: (skin
: io_ptr
) => io_ptr
Type declaration
▸ (skin
): io_ptr
创建骨骼蒙皮数据,分配存储空间。
Parameters
Name | Type |
---|---|
skin | io_ptr |
Returns
Engine_CreateSkin
• Engine_CreateSkin: (jointCount
: number
) => io_ptr
Type declaration
▸ (jointCount
): io_ptr
创建骨骼蒙皮中蒙皮数据,分配存储空间。
Parameters
Name | Type |
---|---|
jointCount | number |
Returns
Engine_CreateTexture
• Engine_CreateTexture: (format
: number
, width
: number
, height
: number
) => io_ptr
Type declaration
▸ (format
, width
, height
): io_ptr
创建贴图对象。
Parameters
Name | Type |
---|---|
format | number |
width | number |
height | number |
Returns
Engine_CreateUniform
• Engine_CreateUniform: (shader
: number
, group
: number
, tuple
: number
, size
: number
) => io_ptr
Type declaration
▸ (shader
, group
, tuple
, size
): io_ptr
创建着色器统一数据缓存接口。
Parameters
Name | Type |
---|---|
shader | number |
group | number |
tuple | number |
size | number |
Returns
Engine_DestroyScenes
• Engine_DestroyScenes: () => void
Type declaration
▸ (): void
销毁所有场景实例。
Returns
void
Engine_GetMaterialBranchKey
• Engine_GetMaterialBranchKey: (link
: io_ptr
) => number
Type declaration
▸ (link
): number
获取材质分支键。
Parameters
Name | Type |
---|---|
link | io_ptr |
Returns
number
Engine_SetActiveScene
• Engine_SetActiveScene: (scene
: io_ptr
) => io_ptr
Type declaration
▸ (scene
): io_ptr
设置活动场景。
Parameters
Name | Type |
---|---|
scene | io_ptr |
Returns
Engine_UploadInstanceArray
• Engine_UploadInstanceArray: (meshRenderer
: io_ptr
, offset
: number
) => number
Type declaration
▸ (meshRenderer
, offset
): number
上传指定网格渲染器实例绘制数组。
Parameters
Name | Type |
---|---|
meshRenderer | io_ptr |
offset | number |
Returns
number
Matrix4x4_Cofactor
• Matrix4x4_Cofactor: (m1
: io_ptr
, mO
: io_ptr
) => void
Type declaration
▸ (m1
, mO
): void
生成矩阵的代数余子式矩阵(transpose(inverse(M)) = cof(M) / det(M))。
Parameters
Name | Type |
---|---|
m1 | io_ptr |
mO | io_ptr |
Returns
void
Matrix4x4_CorrectCullingProjection
• Matrix4x4_CorrectCullingProjection: (mO
: io_ptr
, offsetX
: number
, offsetY
: number
, scaleX
: number
, scaleY
: number
) => void
Type declaration
▸ (mO
, offsetX
, offsetY
, scaleX
, scaleY
): void
修正右手坐标系用于裁剪的投影矩阵。
Parameters
Name | Type |
---|---|
mO | io_ptr |
offsetX | number |
offsetY | number |
scaleX | number |
scaleY | number |
Returns
void
Matrix4x4_CorrectProjection
• Matrix4x4_CorrectProjection: (mO
: io_ptr
, offsetX
: number
, offsetY
: number
, scaleX
: number
, scaleY
: number
, nearZ
: number
, reversedZ
: number
) => void
Type declaration
▸ (mO
, offsetX
, offsetY
, scaleX
, scaleY
, nearZ
, reversedZ
): void
修正右手坐标系投影矩阵。
Parameters
Name | Type |
---|---|
mO | io_ptr |
offsetX | number |
offsetY | number |
scaleX | number |
scaleY | number |
nearZ | number |
reversedZ | number |
Returns
void
Matrix4x4_Decompose
• Matrix4x4_Decompose: (m1
: io_ptr
, posO
: io_ptr
, rotO
: io_ptr
, scaleO
: io_ptr
) => void
Type declaration
▸ (m1
, posO
, rotO
, scaleO
): void
解压变换矩阵到变换组件参数。
Parameters
Name | Type |
---|---|
m1 | io_ptr |
posO | io_ptr |
rotO | io_ptr |
scaleO | io_ptr |
Returns
void
Matrix4x4_Determinant
• Matrix4x4_Determinant: (m1
: io_ptr
) => number
Type declaration
▸ (m1
): number
计算矩阵行列式。
Parameters
Name | Type |
---|---|
m1 | io_ptr |
Returns
number
Matrix4x4_FromLookAt
• Matrix4x4_FromLookAt: (mO
: io_ptr
, veye
: io_ptr
, vtarget
: io_ptr
, vup
: io_ptr
) => void
Type declaration
▸ (mO
, veye
, vtarget
, vup
): void
根据观察状态计算模型矩阵。
Parameters
Name | Type |
---|---|
mO | io_ptr |
veye | io_ptr |
vtarget | io_ptr |
vup | io_ptr |
Returns
void
Matrix4x4_FromTransform
• Matrix4x4_FromTransform: (mO
: io_ptr
, posX
: number
, posY
: number
, posZ
: number
, rotX
: number
, rotY
: number
, rotZ
: number
, rotW
: number
, scaleX
: number
, scaleY
: number
, scaleZ
: number
) => void
Type declaration
▸ (mO
, posX
, posY
, posZ
, rotX
, rotY
, rotZ
, rotW
, scaleX
, scaleY
, scaleZ
): void
根据变换数据计算模型矩阵。
Parameters
Name | Type |
---|---|
mO | io_ptr |
posX | number |
posY | number |
posZ | number |
rotX | number |
rotY | number |
rotZ | number |
rotW | number |
scaleX | number |
scaleY | number |
scaleZ | number |
Returns
void
Matrix4x4_Invert
• Matrix4x4_Invert: (m1
: io_ptr
, mO
: io_ptr
) => void
Type declaration
▸ (m1
, mO
): void
获取矩阵的逆矩阵。
Parameters
Name | Type |
---|---|
m1 | io_ptr |
mO | io_ptr |
Returns
void
Matrix4x4_MakeFrustumRH
• Matrix4x4_MakeFrustumRH: (mO
: io_ptr
, left
: number
, right
: number
, bottom
: number
, top
: number
, nearZ
: number
, farZ
: number
) => void
Type declaration
▸ (mO
, left
, right
, bottom
, top
, nearZ
, farZ
): void
构造右手坐标系透视投影矩阵。
Parameters
Name | Type |
---|---|
mO | io_ptr |
left | number |
right | number |
bottom | number |
top | number |
nearZ | number |
farZ | number |
Returns
void
Matrix4x4_MakeLensProjectionRH
• Matrix4x4_MakeLensProjectionRH: (mO
: io_ptr
, aspect
: number
, focalLength
: number
, nearZ
: number
, farZ
: number
) => void
Type declaration
▸ (mO
, aspect
, focalLength
, nearZ
, farZ
): void
计算右手坐标系透视投影矩阵。
Parameters
Name | Type |
---|---|
mO | io_ptr |
aspect | number |
focalLength | number |
nearZ | number |
farZ | number |
Returns
void
Matrix4x4_MakePerspectiveProjectionRH
• Matrix4x4_MakePerspectiveProjectionRH: (mO
: io_ptr
, aspect
: number
, fovY
: number
, nearZ
: number
, farZ
: number
) => void
Type declaration
▸ (mO
, aspect
, fovY
, nearZ
, farZ
): void
计算右手坐标系透视投影矩阵。
Parameters
Name | Type |
---|---|
mO | io_ptr |
aspect | number |
fovY | number |
nearZ | number |
farZ | number |
Returns
void
Matrix4x4_MultiplyMatrices
• Matrix4x4_MultiplyMatrices: (m1
: io_ptr
, m2
: io_ptr
, mO
: io_ptr
) => void
Type declaration
▸ (m1
, m2
, mO
): void
左乘矩阵。
Parameters
Name | Type |
---|---|
m1 | io_ptr |
m2 | io_ptr |
mO | io_ptr |
Returns
void
Matrix4x4_MultiplyVector
• Matrix4x4_MultiplyVector: (m1
: io_ptr
, v1
: io_ptr
, vO
: io_ptr
) => void
Type declaration
▸ (m1
, v1
, vO
): void
向量左乘矩阵。
Parameters
Name | Type |
---|---|
m1 | io_ptr |
v1 | io_ptr |
vO | io_ptr |
Returns
void
Matrix4x4_Project
• Matrix4x4_Project: (m1
: io_ptr
, v1
: io_ptr
, vO
: io_ptr
) => void
Type declaration
▸ (m1
, v1
, vO
): void
通过当前矩阵将点投影到NDC空间(进行透视除法)。
Parameters
Name | Type |
---|---|
m1 | io_ptr |
v1 | io_ptr |
vO | io_ptr |
Returns
void
Matrix4x4_Transpose
• Matrix4x4_Transpose: (m1
: io_ptr
, mO
: io_ptr
) => void
Type declaration
▸ (m1
, mO
): void
获取当前矩阵的转置矩阵。
Parameters
Name | Type |
---|---|
m1 | io_ptr |
mO | io_ptr |
Returns
void
MeshRenderer_SetMaterial
• MeshRenderer_SetMaterial: (renderer
: io_ptr
, index
: number
, g2
: io_ptr
) => void
Type declaration
▸ (renderer
, index
, g2
): void
网格渲染器设置子网格材质。
Parameters
Name | Type |
---|---|
renderer | io_ptr |
index | number |
g2 | io_ptr |
Returns
void
Mesh_Release
• Mesh_Release: (mesh
: io_ptr
) => void
Type declaration
▸ (mesh
): void
释放网格引用。
Parameters
Name | Type |
---|---|
mesh | io_ptr |
Returns
void
Object3D_AddAnimator
• Object3D_AddAnimator: (object
: io_ptr
, controller
: number
) => io_ptr
Type declaration
▸ (object
, controller
): io_ptr
添加动画组件。
Parameters
Name | Type |
---|---|
object | io_ptr |
controller | number |
Returns
Object3D_AddCamera
• Object3D_AddCamera: (object
: io_ptr
) => io_ptr
Type declaration
▸ (object
): io_ptr
添加相机组件。
Parameters
Name | Type |
---|---|
object | io_ptr |
Returns
Object3D_AddCollider
• Object3D_AddCollider: (object
: io_ptr
) => io_ptr
Type declaration
▸ (object
): io_ptr
添加碰撞组件。
Parameters
Name | Type |
---|---|
object | io_ptr |
Returns
Object3D_AddMeshRenderer
• Object3D_AddMeshRenderer: (object
: io_ptr
, mesh
: io_ptr
, bonesG3
: io_ptr
) => io_ptr
Type declaration
▸ (object
, mesh
, bonesG3
): io_ptr
添加网格渲染器组件。
Parameters
Name | Type |
---|---|
object | io_ptr |
mesh | io_ptr |
bonesG3 | io_ptr |
Returns
Object3D_Destroy
• Object3D_Destroy: (object
: io_ptr
) => void
Type declaration
▸ (object
): void
销毁对象。
Parameters
Name | Type |
---|---|
object | io_ptr |
Returns
void
Object3D_GetAABB
• Object3D_GetAABB: (object
: io_ptr
, center
: io_ptr
, extents
: io_ptr
, withChildren
: number
) => void
Type declaration
▸ (object
, center
, extents
, withChildren
): void
获取对象包围盒参数。
Parameters
Name | Type |
---|---|
object | io_ptr |
center | io_ptr |
extents | io_ptr |
withChildren | number |
Returns
void
Object3D_RemoveCamera
• Object3D_RemoveCamera: (object
: io_ptr
) => void
Type declaration
▸ (object
): void
移除相机组件。
Parameters
Name | Type |
---|---|
object | io_ptr |
Returns
void
Object3D_RemoveMeshRenderer
• Object3D_RemoveMeshRenderer: (object
: io_ptr
) => void
Type declaration
▸ (object
): void
移除网格渲染器组件。
Parameters
Name | Type |
---|---|
object | io_ptr |
Returns
void
Object3D_SetHighlight
• Object3D_SetHighlight: (object
: io_ptr
, light
: number
, toChildren
: number
) => void
Type declaration
▸ (object
, light
, toChildren
): void
设置对象高亮状态。
Parameters
Name | Type |
---|---|
object | io_ptr |
light | number |
toChildren | number |
Returns
void
Object3D_SetMeshRenderer
• Object3D_SetMeshRenderer: (object
: io_ptr
, renderer
: io_ptr
) => void
Type declaration
▸ (object
, renderer
): void
切换设置网格渲染器组件(一般在共享设置时使用)。
Parameters
Name | Type |
---|---|
object | io_ptr |
renderer | io_ptr |
Returns
void
Object3D_Update
• Object3D_Update: (object
: io_ptr
) => void
Type declaration
▸ (object
): void
更新应用对象最新参数。
Parameters
Name | Type |
---|---|
object | io_ptr |
Returns
void
Object3D_UploadG1
• Object3D_UploadG1: (object
: io_ptr
) => void
Type declaration
▸ (object
): void
上传最新对象数据到G1中。
Parameters
Name | Type |
---|---|
object | io_ptr |
Returns
void
Quaternion_ComputeTangentFrame2
• Quaternion_ComputeTangentFrame2: (qO
: io_ptr
, normalX
: number
, normalY
: number
, normalZ
: number
, tangentX
: number
, tangentY
: number
, tangentZ
: number
, tangentW
: number
) => void
Type declaration
▸ (qO
, normalX
, normalY
, normalZ
, tangentX
, tangentY
, tangentZ
, tangentW
): void
计算TangentFrame四元数。
Parameters
Name | Type |
---|---|
qO | io_ptr |
normalX | number |
normalY | number |
normalZ | number |
tangentX | number |
tangentY | number |
tangentZ | number |
tangentW | number |
Returns
void
Quaternion_FromEulerAngles
• Quaternion_FromEulerAngles: (qO
: io_ptr
, x
: number
, y
: number
, z
: number
) => void
Type declaration
▸ (qO
, x
, y
, z
): void
从欧拉角转换,Y-X-Z的内旋顺序,正方向为看向旋转轴方向顺时针旋转。
Parameters
Name | Type |
---|---|
qO | io_ptr |
x | number |
y | number |
z | number |
Returns
void
Quaternion_FromRotationMatrix
• Quaternion_FromRotationMatrix: (qO
: io_ptr
, m1
: io_ptr
) => void
Type declaration
▸ (qO
, m1
): void
从旋转矩阵转换。
Parameters
Name | Type |
---|---|
qO | io_ptr |
m1 | io_ptr |
Returns
void
Quaternion_FromVectors
• Quaternion_FromVectors: (qO
: io_ptr
, vfrom
: io_ptr
, vto
: io_ptr
) => void
Type declaration
▸ (qO
, vfrom
, vto
): void
根据一个方向变换到另一个方向的描述构造四元数。
Parameters
Name | Type |
---|---|
qO | io_ptr |
vfrom | io_ptr |
vto | io_ptr |
Returns
void
Quaternion_Invert
• Quaternion_Invert: (q1
: io_ptr
, qO
: io_ptr
) => void
Type declaration
▸ (q1
, qO
): void
获取当前四元数的逆。
Parameters
Name | Type |
---|---|
q1 | io_ptr |
qO | io_ptr |
Returns
void
Quaternion_Multiply
• Quaternion_Multiply: (q1
: io_ptr
, q2
: io_ptr
, qO
: io_ptr
) => void
Type declaration
▸ (q1
, q2
, qO
): void
当前四元数乘以参数四元数(q1 * q2 = qO)。
Parameters
Name | Type |
---|---|
q1 | io_ptr |
q2 | io_ptr |
qO | io_ptr |
Returns
void
Quaternion_Normalize
• Quaternion_Normalize: (q1
: io_ptr
, qO
: io_ptr
) => void
Type declaration
▸ (q1
, qO
): void
单位化四元数。
Parameters
Name | Type |
---|---|
q1 | io_ptr |
qO | io_ptr |
Returns
void
Quaternion_RotateVector
• Quaternion_RotateVector: (q1
: io_ptr
, v1
: io_ptr
, vO
: io_ptr
) => void
Type declaration
▸ (q1
, v1
, vO
): void
使用四元数旋转向量。
Parameters
Name | Type |
---|---|
q1 | io_ptr |
v1 | io_ptr |
vO | io_ptr |
Returns
void
Quaternion_Slerp
• Quaternion_Slerp: (q1
: io_ptr
, q2
: io_ptr
, s1
: number
, qO
: io_ptr
) => void
Type declaration
▸ (q1
, q2
, s1
, qO
): void
与指定四元数插值。
Parameters
Name | Type |
---|---|
q1 | io_ptr |
q2 | io_ptr |
s1 | number |
qO | io_ptr |
Returns
void
Quaternion_ToEulerAngles
• Quaternion_ToEulerAngles: (q1
: io_ptr
, vO
: io_ptr
) => void
Type declaration
▸ (q1
, vO
): void
转换为欧拉角。
Parameters
Name | Type |
---|---|
q1 | io_ptr |
vO | io_ptr |
Returns
void
SH_GetColorEstimate
• SH_GetColorEstimate: (sh
: io_ptr
, direction
: io_ptr
, intensity
: number
, vO
: io_ptr
) => void
Type declaration
▸ (sh
, direction
, intensity
, vO
): void
根据球谐系数计算主光照颜色。
Parameters
Name | Type |
---|---|
sh | io_ptr |
direction | io_ptr |
intensity | number |
vO | io_ptr |
Returns
void
SH_GetDirectionEstimate
• SH_GetDirectionEstimate: (sh
: io_ptr
, vO
: io_ptr
) => void
Type declaration
▸ (sh
, vO
): void
根据球谐系数计算主光照方向。
Parameters
Name | Type |
---|---|
sh | io_ptr |
vO | io_ptr |
Returns
void
Scene_Destroy
• Scene_Destroy: (scene
: io_ptr
) => io_ptr
Type declaration
▸ (scene
): io_ptr
销毁场景。
Parameters
Name | Type |
---|---|
scene | io_ptr |
Returns
Scene_GetMainCamera
• Scene_GetMainCamera: (scene
: io_ptr
) => io_ptr
Type declaration
▸ (scene
): io_ptr
获取场景主相机。
Parameters
Name | Type |
---|---|
scene | io_ptr |
Returns
Scene_GetRootObjectList
• Scene_GetRootObjectList: (scene
: io_ptr
) => io_ptr
Type declaration
▸ (scene
): io_ptr
获取场景根对象列表。
Parameters
Name | Type |
---|---|
scene | io_ptr |
Returns
Scene_Update
• Scene_Update: (scene
: io_ptr
, physStep
: number
) => io_ptr
Type declaration
▸ (scene
, physStep
): io_ptr
更新场景状态(physStep为以秒为单位的物理流逝时间)。
Parameters
Name | Type |
---|---|
scene | io_ptr |
physStep | number |
Returns
SkeletonSkin_Release
• SkeletonSkin_Release: (skeletonSkin
: io_ptr
) => void
Type declaration
▸ (skeletonSkin
): void
释放骨骼蒙皮引用。
Parameters
Name | Type |
---|---|
skeletonSkin | io_ptr |
Returns
void
Skin_Release
• Skin_Release: (skin
: io_ptr
) => void
Type declaration
▸ (skin
): void
释放蒙皮引用。
Parameters
Name | Type |
---|---|
skin | io_ptr |
Returns
void
System_Analyse
• System_Analyse: () => io_ptr
Type declaration
▸ (): io_ptr
系统运行状态分析。
Returns
System_Delete
• System_Delete: (ptr
: io_ptr
) => void
Type declaration
▸ (ptr
): void
系统堆内存回收方法。
Parameters
Name | Type |
---|---|
ptr | io_ptr |
Returns
void
System_New
• System_New: (size
: number
) => io_ptr
Type declaration
▸ (size
): io_ptr
系统堆内存分配方法。
Parameters
Name | Type |
---|---|
size | number |
Returns
System_Shutdown
• System_Shutdown: () => void
Type declaration
▸ (): void
系统关闭方法。
Returns
void
System_Startup
• System_Startup: (ptr
: io_ptr
) => io_ptr
Type declaration
▸ (ptr
): io_ptr
系统启动方法。
Parameters
Name | Type |
---|---|
ptr | io_ptr |
Returns
TRI_CalNormals
• TRI_CalNormals: (vertices
: io_ptr
, normals
: io_ptr
) => void
Type declaration
▸ (vertices
, normals
): void
计算三角面元法线。
Parameters
Name | Type |
---|---|
vertices | io_ptr |
normals | io_ptr |
Returns
void
TRI_CalTangents
• TRI_CalTangents: (vertices
: io_ptr
, normals
: io_ptr
, uvs
: io_ptr
, tangents
: io_ptr
, binormals
: io_ptr
) => void
Type declaration
▸ (vertices
, normals
, uvs
, tangents
, binormals
): void
计算三角面元切线。
Parameters
Name | Type |
---|---|
vertices | io_ptr |
normals | io_ptr |
uvs | io_ptr |
tangents | io_ptr |
binormals | io_ptr |
Returns
void
TRI_MixTangents
• TRI_MixTangents: (qtbn
: io_ptr
, tangent
: io_ptr
, binormal
: io_ptr
, normal
: io_ptr
) => void
Type declaration
▸ (qtbn
, tangent
, binormal
, normal
): void
混合多面元共享顶点的法线和切线。
Parameters
Name | Type |
---|---|
qtbn | io_ptr |
tangent | io_ptr |
binormal | io_ptr |
normal | io_ptr |
Returns
void
Texture_Release
• Texture_Release: (texture
: io_ptr
) => void
Type declaration
▸ (texture
): void
释放贴图引用。
Parameters
Name | Type |
---|---|
texture | io_ptr |
Returns
void
Transform_SetLocalMatrix
• Transform_SetLocalMatrix: (object
: io_ptr
, mat
: io_ptr
) => void
Type declaration
▸ (object
, mat
): void
设置本地变换矩阵(模型->父级)。
Parameters
Name | Type |
---|---|
object | io_ptr |
mat | io_ptr |
Returns
void
Transform_SetParent
• Transform_SetParent: (object
: io_ptr
, parent
: io_ptr
, staysWorld
: number
) => void
Type declaration
▸ (object
, parent
, staysWorld
): void
设置父级对象。
Parameters
Name | Type |
---|---|
object | io_ptr |
parent | io_ptr |
staysWorld | number |
Returns
void
Transform_SetPosition
• Transform_SetPosition: (object
: io_ptr
, x
: number
, y
: number
, z
: number
) => void
Type declaration
▸ (object
, x
, y
, z
): void
设置世界空间坐标。
Parameters
Name | Type |
---|---|
object | io_ptr |
x | number |
y | number |
z | number |
Returns
void
Transform_SetRotation
• Transform_SetRotation: (object
: io_ptr
, q
: io_ptr
) => void
Type declaration
▸ (object
, q
): void
设置世界空间旋转四元数。
Parameters
Name | Type |
---|---|
object | io_ptr |
q | io_ptr |
Returns
void
Transform_Update
• Transform_Update: (object
: io_ptr
) => void
Type declaration
▸ (object
): void
变换组件更新。
Parameters
Name | Type |
---|---|
object | io_ptr |
Returns
void
Uniform_Release
• Uniform_Release: (uniform
: io_ptr
) => void
Type declaration
▸ (uniform
): void
释放统一数据引用。
Parameters
Name | Type |
---|---|
uniform | io_ptr |
Returns
void
Uniform_ReplaceTextureRef
• Uniform_ReplaceTextureRef: (new_
: io_ptr
, old_
: io_ptr
) => void
Type declaration
▸ (new_
, old_
): void
替换统一资源描述符中引用的贴图。
Parameters
Name | Type |
---|---|
new_ | io_ptr |
old_ | io_ptr |
Returns
void
Util_Compress_lz4
• Util_Compress_lz4: (src
: io_ptr
, dst
: io_ptr
, srcSize
: number
, dstCapacity
: number
) => number
Type declaration
▸ (src
, dst
, srcSize
, dstCapacity
): number
压缩LZ4数据。
Parameters
Name | Type |
---|---|
src | io_ptr |
dst | io_ptr |
srcSize | number |
dstCapacity | number |
Returns
number
Util_Decompress_lz4
• Util_Decompress_lz4: (src
: io_ptr
, dst
: io_ptr
, compressedSize
: number
, dstCapacity
: number
) => number
Type declaration
▸ (src
, dst
, compressedSize
, dstCapacity
): number
解压缩LZ4数据。
Parameters
Name | Type |
---|---|
src | io_ptr |
dst | io_ptr |
compressedSize | number |
dstCapacity | number |
Returns
number
Util_Free_ktx2
• Util_Free_ktx2: (ptr
: io_ptr
) => void
Type declaration
▸ (ptr
): void
释放压缩纹理数据。
Parameters
Name | Type |
---|---|
ptr | io_ptr |
Returns
void
Util_Transcoder_ktx2
• Util_Transcoder_ktx2: (data
: io_ptr
, size
: number
, format
: number
) => io_ptr
Type declaration
▸ (data
, size
, format
): io_ptr
转换压缩纹理数据,目标格式:2:BC1_RGB,3:BC3_RGBA,10:ASTC_4x4_RGBA。
Parameters
Name | Type |
---|---|
data | io_ptr |
size | number |
format | number |
Returns
Vector3_Add
• Vector3_Add: (v1
: io_ptr
, v2
: io_ptr
, vO
: io_ptr
) => void
Type declaration
▸ (v1
, v2
, vO
): void
当前向量加参数向量(v1 + v2 = vO)。
Parameters
Name | Type |
---|---|
v1 | io_ptr |
v2 | io_ptr |
vO | io_ptr |
Returns
void
Vector3_Cross
• Vector3_Cross: (v1
: io_ptr
, v2
: io_ptr
, vO
: io_ptr
) => void
Type declaration
▸ (v1
, v2
, vO
): void
当前向量叉乘参数向量(v1 x v2 = vO,结果向量垂直与两向量所在平面,指向由右手规则从v1转向v2来确定)。
Parameters
Name | Type |
---|---|
v1 | io_ptr |
v2 | io_ptr |
vO | io_ptr |
Returns
void
Vector3_Dot
• Vector3_Dot: (v1
: io_ptr
, v2
: io_ptr
) => number
Type declaration
▸ (v1
, v2
): number
当前向量点乘参数向量(v1·v2 = sO)。 点乘满足交换率,如果一向量为单位向量,则结果可表示为另一向量在该向量上的投影长度。 如果两个向量都为单位向量,则结果可表示为两个向量夹角的Cos值。
Parameters
Name | Type |
---|---|
v1 | io_ptr |
v2 | io_ptr |
Returns
number
Vector3_Length
• Vector3_Length: (v1
: io_ptr
) => number
Type declaration
▸ (v1
): number
向量长度。
Parameters
Name | Type |
---|---|
v1 | io_ptr |
Returns
number
Vector3_Lerp
• Vector3_Lerp: (v1
: io_ptr
, v2
: io_ptr
, s0
: number
, vO
: io_ptr
) => void
Type declaration
▸ (v1
, v2
, s0
, vO
): void
与指定向量插值。
Parameters
Name | Type |
---|---|
v1 | io_ptr |
v2 | io_ptr |
s0 | number |
vO | io_ptr |
Returns
void
Vector3_Max
• Vector3_Max: (v1
: io_ptr
, v2
: io_ptr
, vO
: io_ptr
) => void
Type declaration
▸ (v1
, v2
, vO
): void
获取向量各元素最大值。
Parameters
Name | Type |
---|---|
v1 | io_ptr |
v2 | io_ptr |
vO | io_ptr |
Returns
void
Vector3_MaxElement
• Vector3_MaxElement: (v1
: io_ptr
) => number
Type declaration
▸ (v1
): number
获取向量最大元素值。
Parameters
Name | Type |
---|---|
v1 | io_ptr |
Returns
number
Vector3_MultiplyScalar
• Vector3_MultiplyScalar: (v1
: io_ptr
, s1
: number
, vO
: io_ptr
) => void
Type declaration
▸ (v1
, s1
, vO
): void
当前向量与标量相乘(缩放向量长度)。
Parameters
Name | Type |
---|---|
v1 | io_ptr |
s1 | number |
vO | io_ptr |
Returns
void
Vector3_Normalize
• Vector3_Normalize: (v1
: io_ptr
, vO
: io_ptr
) => void
Type declaration
▸ (v1
, vO
): void
单位化向量。
Parameters
Name | Type |
---|---|
v1 | io_ptr |
vO | io_ptr |
Returns
void
Vector3_Sub
• Vector3_Sub: (v1
: io_ptr
, v2
: io_ptr
, vO
: io_ptr
) => void
Type declaration
▸ (v1
, v2
, vO
): void
当前向量减参数向量(v1 - v2 = vO,结果向量由v2的末端指向v1的末端)。
Parameters
Name | Type |
---|---|
v1 | io_ptr |
v2 | io_ptr |
vO | io_ptr |
Returns
void
Vector4_Max
• Vector4_Max: (v1
: io_ptr
, v2
: io_ptr
, vO
: io_ptr
) => void
Type declaration
▸ (v1
, v2
, vO
): void
获取向量各元素最大值。
Parameters
Name | Type |
---|---|
v1 | io_ptr |
v2 | io_ptr |
vO | io_ptr |
Returns
void
Vector4_MaxElement
• Vector4_MaxElement: (v1
: io_ptr
) => number
Type declaration
▸ (v1
): number
获取向量最大元素值。
Parameters
Name | Type |
---|---|
v1 | io_ptr |
Returns
number
Vector4_MultiplyScalar
• Vector4_MultiplyScalar: (v1
: io_ptr
, s1
: number
, vO
: io_ptr
) => void
Type declaration
▸ (v1
, s1
, vO
): void
当前向量与标量相乘(缩放向量长度)。
Parameters
Name | Type |
---|---|
v1 | io_ptr |
s1 | number |
vO | io_ptr |
Returns
void
__stack_pointer
• __stack_pointer: Global
<keyof ValueTypeMap
>
栈指针,向低地址增长。