目录

FG_ContextDescription_VK

Overview

Describes the property information required for creating a frame generation context instance FG_Context_VK. This API applies only to the Vulkan graphics API.

Since: 5.0.0(12)

Related module: GraphicsAccelerate

Header file: frame_generation_vk.h

Summary

[h2]Member Variables

Name Description
VkInstance vkInstance Vulkan instance, which must be valid throughout the entire lifecycle of FG_Context_VK.
VkPhysicalDevice vkPhysicalDevice Vulkan physical device handle, which must be valid throughout the entire lifecycle of FG_Context_VK.
VkDevice vkDevice Vulkan logical device handle, which must be valid throughout the entire lifecycle of FG_Context_VK.
uint8_t framesInFlight

Number of frames rendered in parallel. For example, if a frame needs to be rendered after the previous frame is sent for display, framesInFlight should be set to 1. If a frame is being rendered when the previous frame is sent for display, framesInFlight should be set to 2. Note: framesInFlight cannot be set to 0. If the value is out of the range, the error code FG_INVALID_PARAMETER is returned.

Value range: [1, 2]

PFN_vkGetInstanceProcAddr fnVulkanLoaderFunction Function pointer that points to vkGetInstanceProcAddr in Vulkan. The pointer should not be null.

Struct Member Variable Description

[h2]fnVulkanLoaderFunction

PFN_vkGetInstanceProcAddr FG_ContextDescription_VK::fnVulkanLoaderFunction

Description

Function pointer that points to vkGetInstanceProcAddr in Vulkan. The pointer should not be null.

[h2]framesInFlight

uint8_t FG_ContextDescription_VK::framesInFlight

Description

Number of frames rendered in parallel. For example, if a frame needs to be rendered after the previous frame is sent for display, framesInFlight should be set to 1. If a frame is being rendered when the previous frame is sent for display, framesInFlight should be set to 2. Note: framesInFlight cannot be set to 0. If the value is out of the range, the error code FG_INVALID_PARAMETER is returned.

[h2]vkDevice

VkDevice FG_ContextDescription_VK::vkDevice

Description

Vulkan logical device handle, which must be valid throughout the entire lifecycle of FG_Context_VK.

[h2]vkInstance

VkInstance FG_ContextDescription_VK::vkInstance

Description

Vulkan instance, which must be valid throughout the entire lifecycle of FG_Context_VK.

[h2]vkPhysicalDevice

VkPhysicalDevice FG_ContextDescription_VK::vkPhysicalDevice

Description

Vulkan physical device handle, which must be valid throughout the entire lifecycle of FG_Context_VK.