Describes the parameter information required by HMS_FG_Dispatch_VK. The parameter information needs to be updated for each frame. This API applies only to the Vulkan graphics API.
Since: 5.0.0(12)
Related module: GraphicsAccelerate
Header file: frame_generation_vk.h
| Name | Description |
|---|---|
| FG_ImageInfo_VK inputColorInfo | Image instance of the real frame color buffer. It is created by HMS_FG_CreateImage_VK and destroyed by HMS_FG_DestroyImage_VK. |
| FG_ImageInfo_VK inputDepthStencilInfo | Image instance of the real frame depth stencil buffer. It is created by HMS_FG_CreateImage_VK and destroyed by HMS_FG_DestroyImage_VK. |
| FG_ImageInfo_VK outputColorInfo | Image instance of the predicted frame buffer. It is created by HMS_FG_CreateImage_VK and destroyed by HMS_FG_DestroyImage_VK. |
| FG_Mat4x4 viewProj | View projection matrix of real frames, that is, the matrix used for coordinate system conversion from the world space to the camera clip space. The matrix must be a 4x4 matrix in column-major order. |
| FG_Mat4x4 invViewProj | Inverse view projection matrix of real frames, that is, the matrix used for coordinate system conversion from the camera clip space to the world space. The matrix must be a 4x4 matrix in column-major order. |
| VkCommandBuffer vkCommandBuffer | Command buffer used to record frame drawing commands. |
| uint8_t frameIdx | Sequence number of the current frame. The sequence number starts from 0. The value must be less than that of framesInFlight in FG_ContextDescription_VK. Otherwise, the error code FG_INVALID_PARAMETER is returned. |
uint8_t FG_DispatchDescription_VK::frameIdx
Description
Sequence number of the current frame. The sequence number starts from 0. The value must be less than that of framesInFlight in FG_ContextDescription_VK. Otherwise, the error code FG_INVALID_PARAMETER is returned.
FG_ImageInfo_VK FG_DispatchDescription_VK::inputColorInfo
Description
Image instance of the real frame color buffer. It is created by HMS_FG_CreateImage_VK and destroyed by HMS_FG_DestroyImage_VK.
FG_ImageInfo_VK FG_DispatchDescription_VK::inputDepthStencilInfo
Description
Image instance of the real frame depth stencil buffer. It is created by HMS_FG_CreateImage_VK and destroyed by HMS_FG_DestroyImage_VK.
FG_Mat4x4 FG_DispatchDescription_VK::invViewProj
Description
Inverse view projection matrix of real frames, that is, the matrix used for coordinate system conversion from the camera clip space to the world space. The matrix must be a 4x4 matrix in column-major order.
FG_ImageInfo_VK FG_DispatchDescription_VK::outputColorInfo
Description
Image instance of the predicted frame buffer. It is created by HMS_FG_CreateImage_VK and destroyed by HMS_FG_DestroyImage_VK.