UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
VulkanConfiguration.h File Reference
#include "HAL/LowLevelMemTracker.h"
#include "VulkanCommon.h"
#include "VulkanPlatform.h"

Go to the source code of this file.

Namespaces

namespace  VulkanRHI
 

Macros

#define UE_VK_API_VERSION   VK_API_VERSION_1_1
 
#define VULKAN_SHOULD_DEBUG_IN_DEVELOPMENT   1
 
#define VULKAN_HAS_DEBUGGING_ENABLED   (!IS_PROGRAM && (UE_BUILD_DEBUG || (UE_BUILD_DEVELOPMENT && VULKAN_SHOULD_DEBUG_IN_DEVELOPMENT)))
 
#define VULKAN_VALIDATION_DEFAULT_VALUE   (UE_BUILD_DEBUG ? 2 : 0)
 
#define VULKAN_SHOULD_ENABLE_DRAW_MARKERS   0
 
#define VULKAN_ENABLE_DUMP_LAYER   0
 
#define VULKAN_ENABLE_DRAW_MARKERS   VULKAN_SHOULD_ENABLE_DRAW_MARKERS
 
#define VULKAN_ENABLE_IMAGE_TRACKING_LAYER   0
 
#define VULKAN_ENABLE_BUFFER_TRACKING_LAYER   0
 
#define VULKAN_ENABLE_TRACKING_LAYER   (VULKAN_ENABLE_BUFFER_TRACKING_LAYER || VULKAN_ENABLE_IMAGE_TRACKING_LAYER)
 
#define VULKAN_ENABLE_WRAP_LAYER   (VULKAN_ENABLE_DUMP_LAYER || VULKAN_ENABLE_TRACKING_LAYER)
 
#define VULKAN_HASH_POOLS_WITH_TYPES_USAGE_ID   1
 
#define VULKAN_SINGLE_ALLOCATION_PER_RESOURCE   0
 
#define VULKAN_SHOULD_USE_LLM   0
 
#define VULKAN_USE_LLM   ((ENABLE_LOW_LEVEL_MEM_TRACKER) && VULKAN_SHOULD_USE_LLM)
 
#define VULKAN_CUSTOM_MEMORY_MANAGER_ENABLED   VULKAN_USE_LLM
 
#define VULKAN_SHOULD_USE_COMMANDWRAPPERS   VULKAN_ENABLE_WRAP_LAYER
 
#define VULKAN_COMMANDWRAPPERS_ENABLE   VULKAN_SHOULD_USE_COMMANDWRAPPERS
 
#define VULKAN_USE_IMAGE_ACQUIRE_FENCES   1
 
#define VULKAN_ENABLE_AGGRESSIVE_STATS   0
 
#define VULKAN_REUSE_FENCES   1
 
#define VULKAN_QUERY_CALLSTACK   0
 
#define VULKAN_ENABLE_DESKTOP_HMD_SUPPORT   0
 
#define VULKAN_SIGNAL_UNIMPLEMENTED()
 
#define VULKAN_ENABLE_LRU_CACHE   0
 
#define VULKAN_SUPPORTS_VALIDATION_CACHE   0
 
#define VULKAN_HAS_VALIDATION_FEATURES   0
 
#define VULKAN_SUPPORTS_DEDICATED_ALLOCATION   1
 
#define VULKAN_SUPPORTS_GOOGLE_DISPLAY_TIMING   0
 
#define VULKAN_USE_CREATE_ANDROID_SURFACE   0
 
#define VULKAN_USE_CREATE_WIN32_SURFACE   0
 
#define VULKAN_USE_DIFFERENT_POOL_CMDBUFFERS   1
 
#define VULKAN_DELETE_STALE_CMDBUFFERS   1
 
#define VULKAN_SUPPORTS_SCALAR_BLOCK_LAYOUT   1
 
#define VULKAN_SUPPORTS_MEMORY_BUDGET   1
 
#define VULKAN_SUPPORTS_MEMORY_PRIORITY   1
 
#define VULKAN_SUPPORTS_DRIVER_PROPERTIES   1
 
#define VULKAN_SUPPORTS_QCOM_RENDERPASS_SHADER_RESOLVE   0
 
#define VULKAN_SUPPORTS_FULLSCREEN_EXCLUSIVE   0
 
#define VULKAN_SUPPORTS_TEXTURE_COMPRESSION_ASTC_HDR   0
 
#define VULKAN_SUPPORTS_ANDROID_EXTERNAL_MEMORY_ANDROID_HARDWARE_BUFFER   1
 
#define VULKAN_SUPPORTS_RENDERPASS2   0
 
#define VULKAN_SUPPORTS_ASTC_DECODE_MODE   0
 
#define VULKAN_SUPPORTS_SHADER_VIEWPORT_INDEX_LAYER   0
 
#define VULKAN_SUPPORTS_DESCRIPTOR_INDEXING   0
 
#define VULKAN_OBJECT_TRACKING   0
 
#define VULKAN_CPU_ALLOCATOR   nullptr
 
#define VULKAN_PURGE_SHADER_MODULES   0
 
#define VULKAN_SUPPORTS_TRANSIENT_RESOURCE_ALLOCATOR   1
 
#define VK_TYPE_TO_STRING(Type, Value)   *FString::Printf(TEXT("%u"), (uint32)Value)
 
#define VK_FLAGS_TO_STRING(Type, Value)   *FString::Printf(TEXT("%u"), (uint32)Value)
 

Functions

VULKANRHI_API DECLARE_LOG_CATEGORY_EXTERN (LogVulkanRHI, Log, All)
 

Macro Definition Documentation

◆ UE_VK_API_VERSION

#define UE_VK_API_VERSION   VK_API_VERSION_1_1

◆ VK_FLAGS_TO_STRING

#define VK_FLAGS_TO_STRING (   Type,
  Value 
)    *FString::Printf(TEXT("%u"), (uint32)Value)

◆ VK_TYPE_TO_STRING

#define VK_TYPE_TO_STRING (   Type,
  Value 
)    *FString::Printf(TEXT("%u"), (uint32)Value)

◆ VULKAN_COMMANDWRAPPERS_ENABLE

#define VULKAN_COMMANDWRAPPERS_ENABLE   VULKAN_SHOULD_USE_COMMANDWRAPPERS

◆ VULKAN_CPU_ALLOCATOR

#define VULKAN_CPU_ALLOCATOR   nullptr

◆ VULKAN_CUSTOM_MEMORY_MANAGER_ENABLED

#define VULKAN_CUSTOM_MEMORY_MANAGER_ENABLED   VULKAN_USE_LLM

◆ VULKAN_DELETE_STALE_CMDBUFFERS

#define VULKAN_DELETE_STALE_CMDBUFFERS   1

◆ VULKAN_ENABLE_AGGRESSIVE_STATS

#define VULKAN_ENABLE_AGGRESSIVE_STATS   0

◆ VULKAN_ENABLE_BUFFER_TRACKING_LAYER

#define VULKAN_ENABLE_BUFFER_TRACKING_LAYER   0

◆ VULKAN_ENABLE_DESKTOP_HMD_SUPPORT

#define VULKAN_ENABLE_DESKTOP_HMD_SUPPORT   0

◆ VULKAN_ENABLE_DRAW_MARKERS

#define VULKAN_ENABLE_DRAW_MARKERS   VULKAN_SHOULD_ENABLE_DRAW_MARKERS

◆ VULKAN_ENABLE_DUMP_LAYER

#define VULKAN_ENABLE_DUMP_LAYER   0

◆ VULKAN_ENABLE_IMAGE_TRACKING_LAYER

#define VULKAN_ENABLE_IMAGE_TRACKING_LAYER   0

◆ VULKAN_ENABLE_LRU_CACHE

#define VULKAN_ENABLE_LRU_CACHE   0

◆ VULKAN_ENABLE_TRACKING_LAYER

◆ VULKAN_ENABLE_WRAP_LAYER

#define VULKAN_ENABLE_WRAP_LAYER   (VULKAN_ENABLE_DUMP_LAYER || VULKAN_ENABLE_TRACKING_LAYER)

◆ VULKAN_HAS_DEBUGGING_ENABLED

#define VULKAN_HAS_DEBUGGING_ENABLED   (!IS_PROGRAM && (UE_BUILD_DEBUG || (UE_BUILD_DEVELOPMENT && VULKAN_SHOULD_DEBUG_IN_DEVELOPMENT)))

◆ VULKAN_HAS_VALIDATION_FEATURES

#define VULKAN_HAS_VALIDATION_FEATURES   0

◆ VULKAN_HASH_POOLS_WITH_TYPES_USAGE_ID

#define VULKAN_HASH_POOLS_WITH_TYPES_USAGE_ID   1

◆ VULKAN_OBJECT_TRACKING

#define VULKAN_OBJECT_TRACKING   0

◆ VULKAN_PURGE_SHADER_MODULES

#define VULKAN_PURGE_SHADER_MODULES   0

◆ VULKAN_QUERY_CALLSTACK

#define VULKAN_QUERY_CALLSTACK   0

◆ VULKAN_REUSE_FENCES

#define VULKAN_REUSE_FENCES   1

◆ VULKAN_SHOULD_DEBUG_IN_DEVELOPMENT

#define VULKAN_SHOULD_DEBUG_IN_DEVELOPMENT   1

◆ VULKAN_SHOULD_ENABLE_DRAW_MARKERS

#define VULKAN_SHOULD_ENABLE_DRAW_MARKERS   0

◆ VULKAN_SHOULD_USE_COMMANDWRAPPERS

#define VULKAN_SHOULD_USE_COMMANDWRAPPERS   VULKAN_ENABLE_WRAP_LAYER

◆ VULKAN_SHOULD_USE_LLM

#define VULKAN_SHOULD_USE_LLM   0

◆ VULKAN_SIGNAL_UNIMPLEMENTED

#define VULKAN_SIGNAL_UNIMPLEMENTED ( )

◆ VULKAN_SINGLE_ALLOCATION_PER_RESOURCE

#define VULKAN_SINGLE_ALLOCATION_PER_RESOURCE   0

◆ VULKAN_SUPPORTS_ANDROID_EXTERNAL_MEMORY_ANDROID_HARDWARE_BUFFER

#define VULKAN_SUPPORTS_ANDROID_EXTERNAL_MEMORY_ANDROID_HARDWARE_BUFFER   1

◆ VULKAN_SUPPORTS_ASTC_DECODE_MODE

#define VULKAN_SUPPORTS_ASTC_DECODE_MODE   0

◆ VULKAN_SUPPORTS_DEDICATED_ALLOCATION

#define VULKAN_SUPPORTS_DEDICATED_ALLOCATION   1

◆ VULKAN_SUPPORTS_DESCRIPTOR_INDEXING

#define VULKAN_SUPPORTS_DESCRIPTOR_INDEXING   0

◆ VULKAN_SUPPORTS_DRIVER_PROPERTIES

#define VULKAN_SUPPORTS_DRIVER_PROPERTIES   1

◆ VULKAN_SUPPORTS_FULLSCREEN_EXCLUSIVE

#define VULKAN_SUPPORTS_FULLSCREEN_EXCLUSIVE   0

◆ VULKAN_SUPPORTS_GOOGLE_DISPLAY_TIMING

#define VULKAN_SUPPORTS_GOOGLE_DISPLAY_TIMING   0

◆ VULKAN_SUPPORTS_MEMORY_BUDGET

#define VULKAN_SUPPORTS_MEMORY_BUDGET   1

◆ VULKAN_SUPPORTS_MEMORY_PRIORITY

#define VULKAN_SUPPORTS_MEMORY_PRIORITY   1

◆ VULKAN_SUPPORTS_QCOM_RENDERPASS_SHADER_RESOLVE

#define VULKAN_SUPPORTS_QCOM_RENDERPASS_SHADER_RESOLVE   0

◆ VULKAN_SUPPORTS_RENDERPASS2

#define VULKAN_SUPPORTS_RENDERPASS2   0

◆ VULKAN_SUPPORTS_SCALAR_BLOCK_LAYOUT

#define VULKAN_SUPPORTS_SCALAR_BLOCK_LAYOUT   1

◆ VULKAN_SUPPORTS_SHADER_VIEWPORT_INDEX_LAYER

#define VULKAN_SUPPORTS_SHADER_VIEWPORT_INDEX_LAYER   0

◆ VULKAN_SUPPORTS_TEXTURE_COMPRESSION_ASTC_HDR

#define VULKAN_SUPPORTS_TEXTURE_COMPRESSION_ASTC_HDR   0

◆ VULKAN_SUPPORTS_TRANSIENT_RESOURCE_ALLOCATOR

#define VULKAN_SUPPORTS_TRANSIENT_RESOURCE_ALLOCATOR   1

◆ VULKAN_SUPPORTS_VALIDATION_CACHE

#define VULKAN_SUPPORTS_VALIDATION_CACHE   0

◆ VULKAN_USE_CREATE_ANDROID_SURFACE

#define VULKAN_USE_CREATE_ANDROID_SURFACE   0

◆ VULKAN_USE_CREATE_WIN32_SURFACE

#define VULKAN_USE_CREATE_WIN32_SURFACE   0

◆ VULKAN_USE_DIFFERENT_POOL_CMDBUFFERS

#define VULKAN_USE_DIFFERENT_POOL_CMDBUFFERS   1

◆ VULKAN_USE_IMAGE_ACQUIRE_FENCES

#define VULKAN_USE_IMAGE_ACQUIRE_FENCES   1

◆ VULKAN_USE_LLM

◆ VULKAN_VALIDATION_DEFAULT_VALUE

#define VULKAN_VALIDATION_DEFAULT_VALUE   (UE_BUILD_DEBUG ? 2 : 0)

Function Documentation

◆ DECLARE_LOG_CATEGORY_EXTERN()

VULKANRHI_API DECLARE_LOG_CATEGORY_EXTERN ( LogVulkanRHI  ,
Log  ,
All   
)