UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FCopyUIntBufferCS Class Reference
+ Inheritance diagram for FCopyUIntBufferCS:

Public Member Functions

 FCopyUIntBufferCS ()
 
 FCopyUIntBufferCS (const ShaderMetaType::CompiledShaderInitializerType &Initializer)
 
void SetParameters (FRHIBatchedShaderParameters &BatchedParameters, FRHIShaderResourceView *InSourceData, FRHIUnorderedAccessView *const *InDestDatas, const int32 *InUsedIndexCounts, int32 StartingIndex, int32 DestCount)
 
void UnsetParameters (FRHIBatchedShaderUnbinds &BatchedUnbinds)
 
void Begin (FRHICommandList &RHICmdList)
 
void End (FRHICommandList &RHICmdList)
 
- Public Member Functions inherited from FGlobalShader
 FGlobalShader ()=default
 
RENDERCORE_API FGlobalShader (const ShaderMetaType::CompiledShaderInitializerType &Initializer)
 
template<typename TViewUniformShaderParameters >
void SetParameters (FRHIBatchedShaderParameters &BatchedParameters, FRHIUniformBuffer *ViewUniformBuffer)
 
- Public Member Functions inherited from FShader
RENDERCORE_API FShader ()
 
RENDERCORE_API FShader (const CompiledShaderInitializerType &Initializer)
 
RENDERCORE_API ~FShader ()
 
RENDERCORE_API const FSHAHashGetHash () const
 
RENDERCORE_API const FSHAHashGetVertexFactoryHash () const
 
RENDERCORE_API const FSHAHashGetOutputHash () const
 
uint32 GetSortKey () const
 
RENDERCORE_API void Finalize (const FShaderMapResourceCode *Code)
 
FShaderTypeGetType (const FShaderMapPointerTable &InPointerTable) const
 
FShaderTypeGetType (const FPointerTableBase *InPointerTable) const
 
FVertexFactoryTypeGetVertexFactoryType (const FShaderMapPointerTable &InPointerTable) const
 
FVertexFactoryTypeGetVertexFactoryType (const FPointerTableBase *InPointerTable) const
 
FShaderTypeGetTypeUnfrozen () const
 
int32 GetResourceIndex () const
 
EShaderPlatform GetShaderPlatform () const
 
EShaderFrequency GetFrequency () const
 
const FShaderTarget GetTarget () const
 
bool IsFrozen () const
 
uint32 GetNumInstructions () const
 
uint32 GetNumTextureSamplers () const
 
uint32 GetCodeSize () const
 
void SetNumInstructions (uint32 Value)
 
template<typename UniformBufferStructType >
const TShaderUniformBufferParameter< UniformBufferStructType > & GetUniformBufferParameter () const
 
const FShaderUniformBufferParameterGetUniformBufferParameter (const FShaderParametersMetadata *SearchStruct) const
 
const FShaderUniformBufferParameterGetUniformBufferParameter (const FHashedName SearchName) const
 
RENDERCORE_API const FShaderParametersMetadataFindAutomaticallyBoundUniformBufferStruct (int32 BaseIndex) const
 
RENDERCORE_API void DumpDebugInfo (const FShaderMapPointerTable &InPtrTable)
 
 LAYOUT_FIELD (FShaderParameterBindings, Bindings)
 
 LAYOUT_FIELD (FShaderParameterMapInfo, ParameterMapInfo)
 

Static Public Member Functions

static void ModifyCompilationEnvironment (const FGlobalShaderPermutationParameters &Parameters, FShaderCompilerEnvironment &OutEnvironment)
 
- Static Public Member Functions inherited from FGlobalShader
static void ModifyCompilationEnvironment (const FGlobalShaderPermutationParameters &Parameters, FShaderCompilerEnvironment &Environment)
 
static bool ShouldCompilePermutation (const FShaderPermutationParameters &)
 
static EShaderPermutationPrecacheRequest ShouldPrecachePermutation (const FShaderPermutationParameters &Parameters)
 
- Static Public Member Functions inherited from FShader
static void ModifyCompilationEnvironment (const FShaderPermutationParameters &, FShaderCompilerEnvironment &)
 
static const FShaderBindingLayoutGetShaderBindingLayout (const FShaderPermutationParameters &)
 
static bool ShouldCompilePermutation (const FShaderPermutationParameters &)
 
static EShaderPermutationPrecacheRequest ShouldPrecachePermutation (const FShaderPermutationParameters &Parameters)
 
static bool ValidateCompiledResult (EShaderPlatform InPlatform, const FShaderParameterMap &InParameterMap, TArray< FString > &OutError)
 
static EShaderCompileJobPriority GetOverrideJobPriority ()
 
static ERayTracingPayloadType GetRayTracingPayloadType (const int32 PermutationId)
 
static const FShaderParametersMetadataGetRootParametersMetadata ()
 

Additional Inherited Members

- Public Types inherited from FGlobalShader
using ShaderMetaType = FGlobalShaderType
 
using FPermutationParameters = FGlobalShaderPermutationParameters
 
- Public Types inherited from FShader
using FPermutationDomain = FShaderPermutationNone
 
using FPermutationParameters = FShaderPermutationParameters
 
using CompiledShaderInitializerType = FShaderCompiledShaderInitializerType
 
using ShaderMetaType = FShaderType
 
using ShaderStatKeyType = FMemoryImageName
 
using FShaderStatisticMap = TMemoryImageMap< ShaderStatKeyType, FShaderStatVariant >
 
- Protected Member Functions inherited from FShader
 LAYOUT_FIELD (TMemoryImageArray< FHashedName >, UniformBufferParameterStructs)
 
 LAYOUT_FIELD (TMemoryImageArray< FShaderUniformBufferParameter >, UniformBufferParameters)
 
 LAYOUT_FIELD_EDITORONLY (FSHAHash, OutputHash)
 
 LAYOUT_FIELD_EDITORONLY (FSHAHash, VFSourceHash)
 
 LAYOUT_FIELD_EDITORONLY (FSHAHash, SourceHash)
 

Detailed Description

Compute shader used to copy a reference buffer split in several buffers. Each buffer contains a segment of the buffer, and each buffer is increasingly bigger to hold the next part. Could alternatively use DMA copy, if the RHI provided a way to copy buffer regions.

Constructor & Destructor Documentation

◆ FCopyUIntBufferCS() [1/2]

FCopyUIntBufferCS::FCopyUIntBufferCS ( )
inline

Default constructor.

◆ FCopyUIntBufferCS() [2/2]

FCopyUIntBufferCS::FCopyUIntBufferCS ( const ShaderMetaType::CompiledShaderInitializerType Initializer)
explicit

Initialization constructor.

Member Function Documentation

◆ Begin()

void FCopyUIntBufferCS::Begin ( FRHICommandList RHICmdList)

◆ End()

void FCopyUIntBufferCS::End ( FRHICommandList RHICmdList)

◆ ModifyCompilationEnvironment()

static void FCopyUIntBufferCS::ModifyCompilationEnvironment ( const FGlobalShaderPermutationParameters Parameters,
FShaderCompilerEnvironment OutEnvironment 
)
inlinestatic

◆ SetParameters()

void FCopyUIntBufferCS::SetParameters ( FRHIBatchedShaderParameters BatchedParameters,
FRHIShaderResourceView InSourceData,
FRHIUnorderedAccessView *const *  InDestDatas,
const int32 InUsedIndexCounts,
int32  StartingIndex,
int32  DestCount 
)

Set parameters.

◆ UnsetParameters()

void FCopyUIntBufferCS::UnsetParameters ( FRHIBatchedShaderUnbinds BatchedUnbinds)

The documentation for this class was generated from the following file: