1. Epic GamesDeveloper
  3. FRHIGlobals

FRHIGlobals

API > API/Runtime > API/Runtime/RHI

References

   
Module RHI
Header /Engine/Source/Runtime/RHI/Public/RHIGlobals.h
Include #include "RHIGlobals.h"

Syntax

struct FRHIGlobals

Variables

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

Constructors

  Type Name Description
Public function    

Destructors

  Type Name Description
Public function    

Classes

  Type Name Description
Public struct FGpuInfo    
Public struct FRayTracing    
Public struct FReservedResources    
Public struct FVariableRateShading    

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page