1. Epic GamesDeveloper
  3. FRHIGlobals

FRHIGlobals

API > API/Runtime > API/Runtime/RHI

   
Name FRHIGlobals
Type struct
Header File /Engine/Source/Runtime/RHI/Public/RHIGlobals.h
Include Path #include "RHIGlobals.h"

Syntax

struct FRHIGlobals

Constructors

Name Remarks Include Path Unreal Specifiers

FRHIGlobals()

   RHIGlobals.h  

Destructors

Name Remarks Include Path Unreal Specifiers

~FRHIGlobals()

   RHIGlobals.h  

Structs

Name Remarks
FGpuInfo  
FRayTracing  
FReservedResources  
FShaderBundles  
FVariableRateShading  

Constants

Name Type Remarks Include Path
MinGuaranteedSimultaneousUAVs int32 The guaranteed minimum number of simultaneously bound UAV's across all stages in a single pipeline RHIGlobals.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
BindlessSupport ERHIBindlessSupport Whether dynamic (bindless) resources are supported RHIGlobals.h  
BufferMemorySize volatile uint64 Amount of memory allocated by buffers RHIGlobals.h  
DefaultMSAASampleOffsets FVector2f Tables of all MSAA sample offset for all MSAA supported. Use GetMSAASampleOffsets() to read it. RHIGlobals.h  
DemotedLocalMemorySize uint64 Amount of local video memory demoted to system memory. In bytes. RHIGlobals.h  
DeviceIsIntegrated bool Whether or not the current GPU is integrated into to CPU RHIGlobals.h  
DrawUPIndexCheckCount int32 The size to check against for Draw*UP call index counts. RHIGlobals.h  
DrawUPVertexCheckCount int32 The size to check against for Draw*UP call vertex counts. RHIGlobals.h  
ForceNoDeletionLatencyForStreamingTextures bool Allow opt-out default RHI resource deletion latency for streaming textures RHIGlobals.h  
GpuInfo FRHIGlobals::FGpuInfo   RHIGlobals.h  
GPUTraceFileName FString Non-empty if we are performing a gpu trace. Also says where to place trace file. RHIGlobals.h  
HardwareHiddenSurfaceRemoval bool True if the GPU supports hidden surface removal in hardware. RHIGlobals.h  
HDRDisplayOutputFormat EPixelFormat Format used for the backbuffer when outputting to a HDR display. RHIGlobals.h  
HDRNeedsVendorExtensions bool True if HDR requires vendor specific extensions RHIGlobals.h  
IsDebugLayerEnabled bool True if the RHI has initialized a device with the debug layer enabled. RHIGlobals.h  
IsHDREnabled bool Whether or not HDR is currently enabled RHIGlobals.h  
IsRHIInitialized bool True if the render hardware has been initialized. RHIGlobals.h  
LazyShaderCodeLoading bool If true, then avoiding loading shader code and instead force the "native" path, which sends a library and a hash instead. RHIGlobals.h  
MaxComputeDispatchDimension TRHIGlobal< int32 > The maximum size allowed for a computeshader dispatch. RHIGlobals.h  
MaxComputeSharedMemory TRHIGlobal< int64 > The maximum size allowed for Shared Compute Memory. RHIGlobals.h  
MaxConstantBufferByteSize TRHIGlobal< int64 > The maximum size allowed for a contant buffer. RHIGlobals.h  
MaxCubeTextureDimensions TRHIGlobal< int32 > The maximum size allowed for cube textures. RHIGlobals.h  
MaxDispatchThreadGroupsPerDimension FIntVector The maximum number of groups that can be dispatched in each dimensions. RHIGlobals.h  
MaximumInFlightQueries int32 The maximum number of in-flight GPU queries the current RHI can handle without stalling and waiting for the GPU. RHIGlobals.h  
MaximumWaveSize int32   RHIGlobals.h  
MaxShadowDepthBufferSizeX TRHIGlobal< int32 > The maximum size to allow for the shadow depth buffer in the X dimension. RHIGlobals.h  
MaxShadowDepthBufferSizeY TRHIGlobal< int32 > The maximum size to allow for the shadow depth buffer in the Y dimension. RHIGlobals.h  
MaxSimultaneousUAVs int32 The maximum number of simultaneously bound UAV's across all stages in a single pipeline RHIGlobals.h  
MaxTextureArrayLayers int32 The Maximum number of layers in a 1D or 2D texture array. RHIGlobals.h  
MaxTextureDimensions TRHIGlobal< int32 > The maximum size allowed for 2D textures in both dimensions. RHIGlobals.h  
MaxTextureMipCount int32 The maximum number of mip-maps that a texture can contain. RHIGlobals.h  
MaxTextureSamplers int32   RHIGlobals.h  
MaxViewDimensionForTypedBuffer TRHIGlobal< uint64 > The maximum number of elements allowed for Typed Buffers. RHIGlobals.h  
MaxViewSizeBytesForNonTypedBuffer TRHIGlobal< uint64 > The maximum size(in Bytes) for non Typed Buffers. RHIGlobals.h  
MaxVolumeTextureDimensions TRHIGlobal< int32 > The maximum size allowed for 3D textures in all three dimensions. RHIGlobals.h  
MaxWorkGroupInvocations TRHIGlobal< int32 > The maximum work group invocations allowed for compute shader. RHIGlobals.h  
MinimumWaveSize int32 Specifies the minimum and maximum number of lanes in the SIMD wave that this GPU can support. RHIGlobals.h  
NeedsExtraDeletionLatency bool Does this RHI need to wait for deletion of resources due to ref counting. RHIGlobals.h  
NeedsExtraTransitions bool True if RHI needs the transitions from the high level for COPYSRC/COPYDEST RHIGlobals.h  
NeedsShaderUnbinds bool True if the RHI needs shader unbinds (SetShaderUnbinds). RHIGlobals.h  
NeedsTransientDiscardOnGraphicsWorkaround bool True if RHI is unable to service transitioning to ERHIAccess::Discard from all pipes to async compute. RHIGlobals.h  
NeedsTransientDiscardStateTracking bool True if RHI needs to track states when transitioning between Discard. RHIGlobals.h  
NeedsUnatlasedCSMDepthsWorkaround bool True if the RHI has artifacts with atlased CSM depths. RHIGlobals.h  
NonStreamingTextureMemorySizeInKB volatile uint64 Amount of memory allocated by non streaming textures. In kilobytes. RHIGlobals.h  
ParallelRHIExecuteChildWait bool Used for parallel render pass support. RHIGlobals.h  
ParallelRHIExecuteParentWait bool Used for parallel render pass support. RHIGlobals.h  
PersistentThreadGroupCount int32 Optimal number of persistent thread groups to fill the GPU. RHIGlobals.h  
PoolSizeVRAMPercentage int32 In percent. If non-zero, the texture pool size is a percentage of TotalGraphicsMemory. RHIGlobals.h  
PresentCounter uint64 Counter incremented once on each frame present. RHIGlobals.h  
RayTracing FRHIGlobals::FRayTracing   RHIGlobals.h  
RequiresRenderTargetForPixelShaderUAVs bool True if the RHI requires a valid RT bound during UAV scatter operation inside the pixel shader RHIGlobals.h  
ReservedResources FRHIGlobals::FReservedResources   RHIGlobals.h  
RHIThreadNeedsKicking bool If an RHI is so slow, that it is the limiting factor for the entire frame, we can kick early to try to give it as much as possible. RHIGlobals.h  
ShaderBundles FRHIGlobals::FShaderBundles   RHIGlobals.h  
ShaderPlatformForFeatureLevel EShaderPlatform Table for finding out which shader platform corresponds to a given feature level for this RHI. RHIGlobals.h  
StreamingTextureMemorySizeInKB volatile uint64 Amount of memory allocated by streaming textures. In kilobytes. RHIGlobals.h  
SupportLinearTextureVolumeFormat bool True if RHI supports Linear texture format in 3D/Cube/Array texture RHIGlobals.h  
SupportsArrayIndexFromAnyShader bool True if the RHI supports setting the render target array index from any shader stage RHIGlobals.h  
SupportsAsyncComputeTransientAliasing bool True if the RHI supports aliasing transient resources on the async compute pipe. RHIGlobals.h  
SupportsAsyncGetRenderQueryResult bool Whether RHIGetRenderQueryResult can be safely called off the render thread. RHIGlobals.h  
SupportsAsyncPipelinePrecompile bool True if the RHI supports pipeline precompiling from any thread. RHIGlobals.h  
SupportsAsyncTextureCreation bool True if the RHI supports asynchronous creation of texture resources RHIGlobals.h  
SupportsAsyncTextureStreamOut bool Support using async thread for texture stream out operations RHIGlobals.h  
SupportsAtomicUInt64 bool True if the RHI supports 64 bit uint atomics. RHIGlobals.h  
SupportsBackBufferWithCustomDepthStencil bool Whether or not the RHI can render to the backbuffer with a custom depth/stencil surface bound. RHIGlobals.h  
SupportsBarycentricsSemantic bool True if the RHI supports shaders with barycentrics RHIGlobals.h  
SupportsBaseVertexIndex bool Whether or not the RHI can handle a non-zero BaseVertexIndex - extra SetStreamSource calls will be needed if this is false RHIGlobals.h  
SupportsBindingTexArrayPerSlice bool True if RHI supports supports using any slice or all slices of a texture array as render targets without creating the texture with the TargetArraySlicesIndependently flag. RHIGlobals.h  
SupportsConservativeRasterization bool Whether current RHI supports overestimated conservative rasterization. RHIGlobals.h  
SupportsDepthBoundsTest bool True if the RHI and current hardware supports supports depth bounds testing RHIGlobals.h  
SupportsDepthStencilResolve bool Whether Depth Stencil MSAA Resolve Targets are supported. RHIGlobals.h  
SupportsDepthUAV bool True if the RHI supports depth target unordered access views. RHIGlobals.h  
SupportsDirectGPUMemoryLock bool True if the pointer returned by Lock is a persistent direct pointer to gpu memory RHIGlobals.h  
SupportsDrawIndirect bool True if the RHI supports Draw Indirect RHIGlobals.h  
SupportsDualSrcBlending bool True if the RHI supports dual src blending. RHIGlobals.h  
SupportsDX12AtomicUInt64 bool True if the RHI supports 64 bit uint atomics using DX12 SM6.6 - TEMP / DEPRECATED - DO NOT USE RHIGlobals.h  
SupportsDynamicResolution bool Whether or not the RHI can handle dynamic resolution or not. RHIGlobals.h  
SupportsEfficientAsyncCompute bool True if the RHI and current hardware supports efficient AsyncCompute (by default we assume false and later we can enable this for more hardware) RHIGlobals.h  
SupportsEfficientUploadOnResourceCreation bool   RHIGlobals.h  
SupportsExactOcclusionQueries bool Some RHIs can only do visible or not occlusion queries. RHIGlobals.h  
SupportsExplicitFMask bool True if the RHI supports explicit access to MSAA target FMask meta data. RHIGlobals.h  
SupportsExplicitHTile bool True if the RHI supports explicit access to depth target HTile meta data. RHIGlobals.h  
SupportsFirstInstance bool Whether or not the RHI can handle a non-zero FirstInstance to DrawIndexedPrimitive and friends - extra SetStreamSource calls will be needed if this is false RHIGlobals.h  
SupportsFrameCyclesBubblesRemoval bool True if RHIGetGPUFrameCycles removes CPu generated bubbles. RHIGlobals.h  
SupportsGPUTimestampBubblesRemoval bool True if RQT_AbsoluteTime is supported by RHICreateRenderQuery RHIGlobals.h  
SupportsGPUUsage bool True if RHIGetGPUUsage() is supported. RHIGlobals.h  
SupportsHDROutput bool Whether the present adapter/display offers HDR output capabilities. RHIGlobals.h  
SupportsImageExternal bool True if the RHI supports image external RHIGlobals.h  
SupportsLazyShaderCodeLoading bool If true, then it is possible to turn on LazyShaderCodeLoading. RHIGlobals.h  
SupportsLossyFramebufferCompression bool True if lossy/fixed-rate compression of render targets is supporterd. RHIGlobals.h  
SupportsMapWriteNoOverwrite bool True if the RHI supports RLM_WriteOnly_NoOverwrite RHIGlobals.h  
SupportsMeshShadersTier0 bool True if the RHI supports Mesh and Amplification shaders with tier0 capability RHIGlobals.h  
SupportsMeshShadersTier1 bool True if the RHI supports Mesh and Amplification shaders with tier1 capability RHIGlobals.h  
SupportsMobileMultiView bool True if the RHI supports mobile multi-view RHIGlobals.h  
SupportsMSAADepthSampleAccess bool Whether or not the RHI can perform MSAA sample load. RHIGlobals.h  
SupportsMSAAShaderResolve bool True if RHI supports MSAA resolve with a custom shader RHIGlobals.h  
SupportsMultiDrawIndirect bool True if the RHI supports Multi Draw Indirect, a variant of Draw Indirect with variable number of sub-commands generated by GPU RHIGlobals.h  
SupportsMultithreadedResources bool Does the RHI support parallel resource commands (i.e. create / lock / unlock) on non-immediate command list APIs, recorded off the render thread. RHIGlobals.h  
SupportsMultithreadedShaderCreation bool True if the multi-threaded shader creation is supported by (or desirable for) the RHI. RHIGlobals.h  
SupportsMultithreading bool Whether the RHI can send commands to the device context from multiple threads. RHIGlobals.h  
SupportsNative16BitOps bool Whether or not the RHI supports 16bit VALU and resource loads (HLSL shader model 6.2). RHIGlobals.h  
SupportsParallelOcclusionQueries bool True if the RHI supports getting the result of occlusion queries when on a thread other than the render thread RHIGlobals.h  
SupportsParallelRenderingTasksWithSeparateRHIThread bool Temporary. RHIGlobals.h  
SupportsParallelRenderPasses bool Enables support for platforms that use render passes to split command list translation across multiple threads. RHIGlobals.h  
SupportsParallelRHIExecute bool Whether or not the RHI supports parallel RHIThread executes / translates Requirements: RHICreateBoundShaderState & RHICreateGraphicsPipelineState is threadsafe and GetCachedBoundShaderState must not be used. RHIGlobals.h  
SupportsPipelineFileCache bool True if the pipeline file cache can be used with this RHI RHIGlobals.h  
SupportsPipelineStateSortKey bool True if the RHI supports optimal low level pipeline state sort keys. RHIGlobals.h  
SupportsPixelLocalStorage bool True if mobile pixel local storage is supported RHIGlobals.h  
SupportsPixelShaderUAVs bool True if the RHI supports Pixel Shader UAV RHIGlobals.h  
SupportsPrimitiveShaders bool True if the RHI supports primitive shaders. RHIGlobals.h  
SupportsPSOPrecaching bool True if the RHI support PSO precaching RHIGlobals.h  
SupportsQuadBufferStereo bool True if this platform has quad buffer stereo support. RHIGlobals.h  
SupportsQuadTopology bool True if the RHI supports quad topology (PT_QuadList). RHIGlobals.h  
SupportsRasterOrderViews bool True if the RHI supports raster order views. RHIGlobals.h  
SupportsRawViewsForAnyBuffer bool Whether a raw (ByteAddress) buffer view can be created for any buffer, regardless of its EBufferUsageFlags::ByteAddressBuffer flag. RHIGlobals.h  
SupportsRectTopology bool True if the RHI supports rectangular topology (PT_RectList). RHIGlobals.h  
SupportsRenderDepthTargetableShaderResources bool True if the RHI supports textures that may be bound as both a render target and a shader resource. RHIGlobals.h  
SupportsRenderTargetFormat_PF_FloatRGBA TRHIGlobal< bool > True if PF_FloatRGBA render targets are supported RHIGlobals.h  
SupportsRenderTargetFormat_PF_G8 TRHIGlobal< bool > True if PF_G8 render targets are supported RHIGlobals.h  
SupportsResummarizeHTile bool True if the RHI supports resummarizing depth target HTile meta data. RHIGlobals.h  
SupportsRHIOnTaskThread bool As above, but we run the commands on arbitrary task threads RHIGlobals.h  
SupportsRHIThread bool Whether or not the RHI supports an RHI thread. RHIGlobals.h  
SupportsRWTextureBuffers bool Whether RW texture buffers are supported RHIGlobals.h  
SupportsSeparateDepthStencilCopyAccess bool Whether depth or stencil can individually be set to CopySrc/Dest access. RHIGlobals.h  
SupportsSeparateRenderTargetBlendState bool True if the RHI supports separate blend states per render target. RHIGlobals.h  
SupportsShaderDepthStencilFetch bool True if mobile depth & stencil fetch is supported RHIGlobals.h  
SupportsShaderExecutionReordering bool True if the RHI supports shader execution reordering. RHIGlobals.h  
SupportsShaderFramebufferFetch bool True if mobile framebuffer fetch is supported RHIGlobals.h  
SupportsShaderFramebufferFetchProgrammableBlending bool True if mobile framebuffer fetch can be used for programmable blending, does not imply that framebuffer fetch is supported RHIGlobals.h  
SupportsShaderMRTFramebufferFetch bool True if mobile framebuffer fetch is supported from MRT's RHIGlobals.h  
SupportsShaderRootConstants bool Whether current RHI supports shader root constants. RHIGlobals.h  
SupportsShaderTimestamp bool True if the RHI supports reading system timer in shaders via GetShaderTimestamp(). RHIGlobals.h  
SupportsShaderWorkGraphsTier1 bool Whether current RHI supports work graphs with tier1_0 capability. RHIGlobals.h  
SupportsShaderWorkGraphsTier1_1 bool Whether current RHI supports work graphs with tier1_1 capability. RHIGlobals.h  
SupportsStencilRefFromPixelShader bool True if the RHI supports setting the stencil ref at pixel granularity from the pixel shader RHIGlobals.h  
SupportsTexture3D bool Whether to initialize 3D textures using a bulk data (or through a mip update if false). RHIGlobals.h  
SupportsTextureStreaming bool True if the RHI supports texture streaming RHIGlobals.h  
SupportsTextureViews bool True if the RHI supports texture views (data aliasing) RHIGlobals.h  
SupportsTimestampRenderQueries bool True if RQT_AbsoluteTime is supported by RHICreateRenderQuery RHIGlobals.h  
SupportsUAVFormatAliasing bool True if the RHI supports unordered access view format aliasing RHIGlobals.h  
SupportsUpdateFromBufferTexture bool True if the RHI supports UpdateFromBufferTexture method RHIGlobals.h  
SupportsVertexShaderUAVs bool True if the RHI supports Vertex Shader UAV RHIGlobals.h  
SupportsVolumeTextureRendering bool True if and only if the GPU support rendering to volume textures (2D Array, 3D). RHIGlobals.h  
SupportsWaveOperations bool Whether or not the RHI supports shader wave operations (shader model 6.0). RHIGlobals.h  
SupportsWideMRT bool True if the RHI supports 256bit MRT RHIGlobals.h  
TexturePoolSize int64 Current texture streaming pool size, in bytes. 0 means unlimited. RHIGlobals.h  
TriggerGPUCrash ERequestedGPUCrash Whether an intentional GPU crash has been scheduled. RHIGlobals.h  
TriggerGPUHitchProfile bool Whether we are profiling GPU hitches. RHIGlobals.h  
TriggerGPUProfile bool Whether the next frame should profile the GPU. RHIGlobals.h  
UniformBufferMemorySize volatile uint64 Amount of memory allocated by uniform buffers RHIGlobals.h  
UseTexture3DBulkData bool True if bulk data should be used with 3d textures RHIGlobals.h  
UsingNullRHI bool True if we are running with the NULL RHI RHIGlobals.h  
VariableRateShading FRHIGlobals::FVariableRateShading   RHIGlobals.h  
VertexElementTypeSupport FVertexElementTypeSupportInfo True for each VET that is supported. One-to-one mapping with EVertexElementType RHIGlobals.h  

Functions

Public

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page