UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Classes | Macros | Variables
VulkanExtensions.cpp File Reference
#include "VulkanExtensions.h"
#include "VulkanDevice.h"
#include "VulkanRHIPrivate.h"
#include "IHeadMountedDisplayModule.h"
#include "IHeadMountedDisplayVulkanExtensions.h"
#include "Misc/CommandLine.h"
#include "RHICore.h"
#include "RHICoreNvidiaAftermath.h"

Classes

class  FVulkanKHRMaintenance4Extension
 
class  FVulkanKHRMaintenance5Extension
 
class  FVulkanKHRMaintenance7Extension
 
class  FVulkanKHRDriverPropertiesExtension
 
class  FVulkanShaderAtomicInt64Extension
 
class  FVulkanShaderImageAtomicInt64Extension
 
class  FVulkanEXTShaderViewportIndexLayerExtension
 
class  FVulkanKHRSeparateDepthStencilLayoutsExtension
 
class  FVulkanKHRSynchronization2
 
class  FVulkanKHRMultiviewExtension
 
class  FVulkanEXTScalarBlockLayoutExtension
 
class  FVulkanEXTDescriptorIndexingExtension
 
class  FVulkanKHRFragmentShadingRateExtension
 
class  FVulkanEXTFragmentDensityMapExtension
 
class  FVulkanEXTFragmentDensityMap2Extension
 
class  FVulkanKHRFragmentShaderBarycentricExtension
 
class  FVulkanKHRComputeShaderDerivatives
 
class  FVulkanKHRGetMemoryRequirements2Extension
 
class  FVulkanKHRBufferDeviceAddressExtension
 
class  FVulkanKHRAccelerationStructureExtension
 
class  FVulkanKHRRayTracingPipelineExtension
 
class  FVulkanKHRRayQueryExtension
 
class  FVulkanKHRRayTracingPositionFetchExtension
 
class  FVulkanKHRTimelineSemaphoreExtension
 
class  FVulkanEXTMeshShaderExtension
 
class  FVulkanAMDBufferMarkerExtension
 
class  FVulkanNVDeviceDiagnosticCheckpointsExtension
 
class  FVulkanNVDeviceDiagnosticConfigExtension
 
class  FVulkanNVRayTracingValidationExtension
 
class  FVulkanEXTDeviceFaultExtension
 
class  FVulkanEXTHostQueryResetExtension
 
class  FVulkanEXTSubgroupSizeControlExtension
 
class  FVulkanEXTShaderDemoteToHelperInvocationExtension
 
class  FVulkanEXTCalibratedTimestampsExtension
 
class  FVulkanEXTDescriptorBuffer
 
class  FVulkanKHR16BitStorageExtension
 
class  FVulkanKHRShaderFloat16Int8Extension
 
class  FVulkanKHRDepthStencilResolveExtension
 
class  FVulkanEXTPipelineCreationCacheControlExtension
 
class  FVulkanKHRSamplerYcbcrConversionExtension
 
class  FVulkanEXTImageCompressionControlExtension
 
class  FVulkanEXTGraphicsPipelineLibraryExtension
 
class  FVulkanEXTMutableDescriptorTypeExtension
 
class  FVulkanKHRDynamicRenderingExtension
 
class  FVulkanKHRDynamicRenderingLocalReadExtension
 
class  FVulkanKHRDynamicRenderingUnusedAttachmentsExtension
 
class  FVulkanEXTExtendedDynamicStateExtension
 
class  FVulkanEXTExtendedDynamicState2Extension
 
class  FVulkanEXTExtendedDynamicState3Extension
 
class  FVulkanEXTVertexInputDynamicStateExtension
 
class  FVulkanEXTShaderObjectExtension
 
class  FVulkanEXTHostImageCopyExtension
 
class  FVulkanEXTValidationFeaturesExtension
 

Macros

#define VERIFYVULKANRESULT_INIT(VkFunction)
 
#define ADD_SIMPLE_EXTENSION(EXTENSION_NAME, ENABLED_IN_CODE, PROMOTED_VER, FLAG_SETTER)    OutUEDeviceExtensions.Add(MakeUnique<FVulkanDeviceExtension>(InDevice, EXTENSION_NAME, ENABLED_IN_CODE, PROMOTED_VER, FLAG_SETTER, FVulkanExtensionBase::AutoActivate))
 
#define ADD_EXTERNAL_EXTENSION(EXTENSION_NAME, ENABLED_IN_CODE, PROMOTED_VER, FLAG_SETTER)    OutUEDeviceExtensions.Add(MakeUnique<FVulkanDeviceExtension>(InDevice, EXTENSION_NAME, ENABLED_IN_CODE, PROMOTED_VER, FLAG_SETTER, FVulkanExtensionBase::ManuallyActivate))
 
#define ADD_CUSTOM_EXTENSION(EXTENSION_CLASS)    OutUEDeviceExtensions.Add(MakeUnique<EXTENSION_CLASS>(InDevice));
 

Variables

TAutoConsoleVariable< int32 > GRHIAllow64bitShaderAtomicsCvar (TEXT("r.Vulkan.Allow64bitShaderAtomics"), 1, TEXT("1 to enable (default)"), ECVF_ReadOnly)
 
TAutoConsoleVariable< int32 > GRHIAllow16bitOps (TEXT("r.Vulkan.Allow16bitOps"), 1, TEXT("1 to enable (default)"), ECVF_ReadOnly)
 
TAutoConsoleVariable< int32 > GVulkanRayTracingCVar (TEXT("r.Vulkan.RayTracing"), 1, TEXT("1: Enable experimental ray tracing support (default)"), ECVF_ReadOnly)
 
TAutoConsoleVariable< int32 > GVulkanAllowHostQueryResetCVar (TEXT("r.Vulkan.AllowHostQueryReset"), 1, TEXT("1: Enable Host Query Reset (default)"), ECVF_ReadOnly)
 
TAutoConsoleVariable< int32 > GVulkanAllowSync2BarriersCVar (TEXT("r.Vulkan.AllowSynchronization2"), 1, TEXT("1: Enable sync2 barriers (default)"), ECVF_ReadOnly)
 
TAutoConsoleVariable< int32 > GVulkanAllowDynamicRenderingCVar (TEXT("r.Vulkan.AllowDynamicRendering"), 0, TEXT("1: Enable dynamic rendering"), ECVF_ReadOnly)
 
TAutoConsoleVariable< int32 > GVulkanAllowDynamicStatesCVar (TEXT("r.Vulkan.AllowDynamicStates"), 0, TEXT("1: Enable all the dynamic state extensions"), ECVF_ReadOnly)
 
TAutoConsoleVariable< int32 > GVulkanAllowShaderObjectCVar (TEXT("r.Vulkan.AllowShaderObject"), 0, TEXT("1: Enable shader objects"), ECVF_ReadOnly)
 
TAutoConsoleVariable< int32 > GVulkanAllowGraphicPipelineLibraryCVar (TEXT("r.Vulkan.AllowGraphicPipelineLibrary"), 0, TEXT("1: Enable graphic pipeline library"), ECVF_ReadOnly)
 
TAutoConsoleVariable< int32 > GVulkanAllowHostImageCopyCVar (TEXT("r.Vulkan.AllowHostImageCopy"), 0, TEXT("1: Enable Host Image Copy"), ECVF_ReadOnly)
 
TAutoConsoleVariable< int32 > GVulkanVariableRateShadingFormatCVar (TEXT("r.Vulkan.VRSFormat"), 0, TEXT("5: Require Fragment Density Map. Will generate an error if the extension is not available."), ECVF_ReadOnly)
 

Macro Definition Documentation

◆ ADD_CUSTOM_EXTENSION

#define ADD_CUSTOM_EXTENSION (   EXTENSION_CLASS)     OutUEDeviceExtensions.Add(MakeUnique<EXTENSION_CLASS>(InDevice));

◆ ADD_EXTERNAL_EXTENSION

#define ADD_EXTERNAL_EXTENSION (   EXTENSION_NAME,
  ENABLED_IN_CODE,
  PROMOTED_VER,
  FLAG_SETTER 
)     OutUEDeviceExtensions.Add(MakeUnique<FVulkanDeviceExtension>(InDevice, EXTENSION_NAME, ENABLED_IN_CODE, PROMOTED_VER, FLAG_SETTER, FVulkanExtensionBase::ManuallyActivate))

◆ ADD_SIMPLE_EXTENSION

#define ADD_SIMPLE_EXTENSION (   EXTENSION_NAME,
  ENABLED_IN_CODE,
  PROMOTED_VER,
  FLAG_SETTER 
)     OutUEDeviceExtensions.Add(MakeUnique<FVulkanDeviceExtension>(InDevice, EXTENSION_NAME, ENABLED_IN_CODE, PROMOTED_VER, FLAG_SETTER, FVulkanExtensionBase::AutoActivate))

◆ VERIFYVULKANRESULT_INIT

#define VERIFYVULKANRESULT_INIT (   VkFunction)
Value:
{ const VkResult ScopedResult = VkFunction; \
if (ScopedResult == VK_ERROR_INITIALIZATION_FAILED) { \
UE_LOG(LogVulkanRHI, Error, \
TEXT("%s failed\n at %s:%u\nThis typically means Vulkan is not properly set up in your system; try running vulkaninfo from the Vulkan SDK."), \
ANSI_TO_TCHAR(#VkFunction), ANSI_TO_TCHAR(__FILE__), __LINE__); } \
else if (ScopedResult < VK_SUCCESS) { \
VulkanRHI::VerifyVulkanResult(ScopedResult, #VkFunction, __FILE__, __LINE__); }}
TEXT
#define TEXT(x)
Definition Platform.h:1272
StaticCastSharedRef
UE_FORCEINLINE_HINT TSharedRef< CastToType, Mode > StaticCastSharedRef(TSharedRef< CastFromType, Mode > const &InSharedRef)
Definition SharedPointer.h:127
ANSI_TO_TCHAR
#define ANSI_TO_TCHAR(str)
Definition StringConv.h:1020

Variable Documentation

◆ GRHIAllow16bitOps

TAutoConsoleVariable< int32 > GRHIAllow16bitOps(TEXT("r.Vulkan.Allow16bitOps"), 1, TEXT("1 to enable (default)"), ECVF_ReadOnly) ( TEXT("r.Vulkan.Allow16bitOps")  ,
1  ,
TEXT("1 to enable (default)")  ,
ECVF_ReadOnly   
)

◆ GRHIAllow64bitShaderAtomicsCvar

TAutoConsoleVariable< int32 > GRHIAllow64bitShaderAtomicsCvar(TEXT("r.Vulkan.Allow64bitShaderAtomics"), 1, TEXT("1 to enable (default)"), ECVF_ReadOnly) ( TEXT("r.Vulkan.Allow64bitShaderAtomics")  ,
1  ,
TEXT("1 to enable (default)")  ,
ECVF_ReadOnly   
)

◆ GVulkanAllowDynamicRenderingCVar

TAutoConsoleVariable< int32 > GVulkanAllowDynamicRenderingCVar(TEXT("r.Vulkan.AllowDynamicRendering"), 0, TEXT("1: Enable dynamic rendering"), ECVF_ReadOnly) ( TEXT("r.Vulkan.AllowDynamicRendering")  ,
0  ,
TEXT("1: Enable dynamic rendering")  ,
ECVF_ReadOnly   
)

◆ GVulkanAllowDynamicStatesCVar

TAutoConsoleVariable< int32 > GVulkanAllowDynamicStatesCVar(TEXT("r.Vulkan.AllowDynamicStates"), 0, TEXT("1: Enable all the dynamic state extensions"), ECVF_ReadOnly) ( TEXT("r.Vulkan.AllowDynamicStates")  ,
0  ,
TEXT("1: Enable all the dynamic state extensions")  ,
ECVF_ReadOnly   
)

◆ GVulkanAllowGraphicPipelineLibraryCVar

TAutoConsoleVariable< int32 > GVulkanAllowGraphicPipelineLibraryCVar(TEXT("r.Vulkan.AllowGraphicPipelineLibrary"), 0, TEXT("1: Enable graphic pipeline library"), ECVF_ReadOnly) ( TEXT("r.Vulkan.AllowGraphicPipelineLibrary")  ,
0  ,
TEXT("1: Enable graphic pipeline library")  ,
ECVF_ReadOnly   
)

◆ GVulkanAllowHostImageCopyCVar

TAutoConsoleVariable< int32 > GVulkanAllowHostImageCopyCVar(TEXT("r.Vulkan.AllowHostImageCopy"), 0, TEXT("1: Enable Host Image Copy"), ECVF_ReadOnly) ( TEXT("r.Vulkan.AllowHostImageCopy")  ,
0  ,
TEXT("1: Enable Host Image Copy")  ,
ECVF_ReadOnly   
)

◆ GVulkanAllowHostQueryResetCVar

TAutoConsoleVariable< int32 > GVulkanAllowHostQueryResetCVar(TEXT("r.Vulkan.AllowHostQueryReset"), 1, TEXT("1: Enable Host Query Reset (default)"), ECVF_ReadOnly) ( TEXT("r.Vulkan.AllowHostQueryReset")  ,
1  ,
TEXT("1: Enable Host Query Reset (default)")  ,
ECVF_ReadOnly   
)

◆ GVulkanAllowShaderObjectCVar

TAutoConsoleVariable< int32 > GVulkanAllowShaderObjectCVar(TEXT("r.Vulkan.AllowShaderObject"), 0, TEXT("1: Enable shader objects"), ECVF_ReadOnly) ( TEXT("r.Vulkan.AllowShaderObject")  ,
0  ,
TEXT("1: Enable shader objects")  ,
ECVF_ReadOnly   
)

◆ GVulkanAllowSync2BarriersCVar

TAutoConsoleVariable< int32 > GVulkanAllowSync2BarriersCVar(TEXT("r.Vulkan.AllowSynchronization2"), 1, TEXT("1: Enable sync2 barriers (default)"), ECVF_ReadOnly) ( TEXT("r.Vulkan.AllowSynchronization2")  ,
1  ,
TEXT("1: Enable sync2 barriers (default)")  ,
ECVF_ReadOnly   
)

◆ GVulkanRayTracingCVar

TAutoConsoleVariable< int32 > GVulkanRayTracingCVar(TEXT("r.Vulkan.RayTracing"), 1, TEXT("1: Enable experimental ray tracing support (default)"), ECVF_ReadOnly) ( TEXT("r.Vulkan.RayTracing")  ,
1  ,
TEXT("1: Enable experimental ray tracing support (default)")  ,
ECVF_ReadOnly   
)

◆ GVulkanVariableRateShadingFormatCVar

TAutoConsoleVariable< int32 > GVulkanVariableRateShadingFormatCVar(TEXT("r.Vulkan.VRSFormat"), 0, TEXT("5: Require Fragment Density Map. Will generate an error if the extension is not available."), ECVF_ReadOnly) ( TEXT("r.Vulkan.VRSFormat")  ,
0  ,
TEXT("5: Require Fragment Density Map. Will generate an error if the extension is not available.")  ,
ECVF_ReadOnly   
)