UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
RHIShaderPlatform.h File Reference
#include "Misc/AssertionMacros.h"
#include "RHIDefinitions.h"
#include "HAL/Platform.h"

Go to the source code of this file.

Classes

struct  FStaticShaderPlatform
 

Macros

#define DDPI_NUM_STATIC_SHADER_PLATFORMS   16
 

Enumerations

enum  EShaderPlatform : uint16 {
  SP_PCD3D_SM5 = 0 , SP_METAL_ES3_1_IOS = 11 , UE_DEPRECATED =(5.6, "Use SP_METAL_ES3_1_IOS enumeration value instead.") = SP_METAL_ES3_1_IOS , SP_METAL_SM5_IOS = 12 ,
  UE_DEPRECATED =(5.6, "Use SP_METAL_ES3_1_IOS enumeration value instead.") = SP_METAL_ES3_1_IOS , SP_PCD3D_ES3_1 = 14 , SP_OPENGL_PCES3_1 = 15 , SP_METAL_SM5 = 16 ,
  SP_VULKAN_PCES3_1 = 17 , SP_VULKAN_SM5 = 20 , SP_VULKAN_ES3_1_ANDROID = 21 , SP_METAL_ES3_1 = 22 ,
  UE_DEPRECATED =(5.6, "Use SP_METAL_ES3_1_IOS enumeration value instead.") = SP_METAL_ES3_1_IOS , SP_OPENGL_ES3_1_ANDROID = 24 , SP_METAL_ES3_1_TVOS = 30 , UE_DEPRECATED =(5.6, "Use SP_METAL_ES3_1_IOS enumeration value instead.") = SP_METAL_ES3_1_IOS ,
  SP_METAL_SM5_TVOS = 31 , UE_DEPRECATED =(5.6, "Use SP_METAL_ES3_1_IOS enumeration value instead.") = SP_METAL_ES3_1_IOS , SP_StaticPlatform_First = 32 , SP_StaticPlatform_Last = (SP_StaticPlatform_First + DDPI_NUM_STATIC_SHADER_PLATFORMS - 1) ,
  SP_VULKAN_SM5_ANDROID = SP_StaticPlatform_Last + 1 , SP_PCD3D_SM6 = SP_StaticPlatform_Last + 2 , SP_VULKAN_SM6 = SP_StaticPlatform_Last + 4 , SP_METAL_SM6 = SP_StaticPlatform_Last + 5 ,
  SP_METAL_SIM = SP_StaticPlatform_Last + 6 , SP_CUSTOM_PLATFORM_FIRST , SP_CUSTOM_PLATFORM_LAST = (SP_CUSTOM_PLATFORM_FIRST + 100) , SP_NumPlatforms ,
  SP_NumBits = 16
}
 

Functions

EShaderPlatform GetMaxShaderPlatformChecked ()
 
bool IsCustomPlatform (const FStaticShaderPlatform Platform)
 

Variables

RHI_API EShaderPlatform GMaxRHIShaderPlatform
 

Macro Definition Documentation

◆ DDPI_NUM_STATIC_SHADER_PLATFORMS

#define DDPI_NUM_STATIC_SHADER_PLATFORMS   16

Pre-allocated block of shader platform enum values for platform extensions

Enumeration Type Documentation

◆ EShaderPlatform

Warning
: update LegacyShaderPlatform when the below changes
Enumerator
SP_PCD3D_SM5 
SP_METAL_ES3_1_IOS 
UE_DEPRECATED 
SP_METAL_SM5_IOS 
UE_DEPRECATED 
SP_PCD3D_ES3_1 
SP_OPENGL_PCES3_1 
SP_METAL_SM5 
SP_VULKAN_PCES3_1 
SP_VULKAN_SM5 
SP_VULKAN_ES3_1_ANDROID 
SP_METAL_ES3_1 
UE_DEPRECATED 
SP_OPENGL_ES3_1_ANDROID 
SP_METAL_ES3_1_TVOS 
UE_DEPRECATED 
SP_METAL_SM5_TVOS 
UE_DEPRECATED 
SP_StaticPlatform_First 
SP_StaticPlatform_Last 
SP_VULKAN_SM5_ANDROID 
SP_PCD3D_SM6 
SP_VULKAN_SM6 
SP_METAL_SM6 
SP_METAL_SIM 
SP_CUSTOM_PLATFORM_FIRST 
SP_CUSTOM_PLATFORM_LAST 
SP_NumPlatforms 
SP_NumBits 

Function Documentation

◆ GetMaxShaderPlatformChecked()

EShaderPlatform GetMaxShaderPlatformChecked ( )
inline

◆ IsCustomPlatform()

bool IsCustomPlatform ( const FStaticShaderPlatform  Platform)
inline

Variable Documentation

◆ GMaxRHIShaderPlatform

RHI_API EShaderPlatform GMaxRHIShaderPlatform
extern