UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Public Member Functions | Public Attributes | List of all members
FMetalComputeShader Class Reference

#include <MetalComputeShader.h>

+ Inheritance diagram for FMetalComputeShader:

Public Member Functions

 FMetalComputeShader (FMetalDevice &Device, TArrayView< const uint8 > InCode, MTLLibraryPtr InLibrary)
 
virtual ~FMetalComputeShader ()
 
FMetalShaderPipelinePtr GetPipeline ()
 
MTLFunctionPtr GetFunction ()
 
- Public Member Functions inherited from TMetalBaseShader< FRHIComputeShader, SF_Compute >
 TMetalBaseShader (FMetalDevice &MetalDevice)
 
virtual ~TMetalBaseShader ()
 
void Init (TArrayView< const uint8 > InCode, FMetalCodeHeader &Header, MTLLibraryPtr InLibrary)
 
void Destroy ()
 
NS::String * GetSourceCode ()
 
- Public Member Functions inherited from FRHIComputeShader
 FRHIComputeShader ()
 
void SetStats (struct FPipelineStateStats *Ptr)
 
RHI_API void UpdateStats ()
 
- Public Member Functions inherited from FRHIShader
void SetHash (const FSHAHash &InHash)
 
const FSHAHash & GetHash () const
 
bool HasShaderName () const
 
const TCHAR * GetShaderName () const
 
FString GetUniformBufferName (uint32 Index) const
 
 FRHIShader ()=delete
 
 FRHIShader (ERHIResourceType InResourceType, EShaderFrequency InFrequency)
 
EShaderFrequency GetFrequency () const
 
void SetNoDerivativeOps (bool bValue)
 
bool HasNoDerivativeOps () const
 
void SetShaderBundleUsage (bool bValue)
 
bool HasShaderBundleUsage () const
 
- Public Member Functions inherited from FRHIResource
RHI_API FRHIResource (ERHIResourceType InResourceType)
 
uint32 AddRef () const
 
uint32 Release () const
 
uint32 GetRefCount () const
 
bool IsValid () const
 
void DisableLifetimeExtension ()
 
ERHIResourceType GetType () const
 
FName GetOwnerName () const
 
void SetOwnerName (FName InOwnerName)
 
- Public Member Functions inherited from FRHIShaderData
const FShaderResourceTable & GetShaderResourceTable () const
 
const TArray< FUniformBufferStaticSlot > & GetStaticSlots () const
 
void SerializeShaderResourceTable (FArchive &Ar)
 

Public Attributes

int32 NumThreadsX
 
int32 NumThreadsY
 
int32 NumThreadsZ
 
- Public Attributes inherited from FRHIShader
struct { 
 
   FString   ShaderName 
 
   TArray< FName >   UniformBufferNames 
 
} Debug 
 
TArray< FShaderCodeValidationStride > DebugStrideValidationData
 
TArray< FShaderCodeValidationType > DebugSRVTypeValidationData
 
TArray< FShaderCodeValidationType > DebugUAVTypeValidationData
 
TArray< FShaderCodeValidationUBSize > DebugUBSizeValidationData
 
- Public Attributes inherited from FMetalShaderData
FMetalShaderBindings Bindings
 
TMap< uint32, MTL::ArgumentEncoder * > ArgumentEncoders
 
TMap< uint32, TBitArray<> > ArgumentBitmasks
 
TArray< FUniformBufferStaticSlot > StaticSlots
 
int32 SideTableBinding = -1
 
uint32 SourceLen = 0
 
uint32 SourceCRC = 0
 
uint32 ConstantValueHash = 0
 
MTLFunctionPtr Function
 
MTLLibraryPtr Library
 
NS::String * GlslCodeNSString = nullptr
 
TArray< uint8 > CompressedSource
 
uint32 CodeSize = 0
 
bool bHasFunctionConstants = false
 
bool bDeviceFunctionConstants = false
 
uint32 LibraryFunctionIndex = -1
 

Additional Inherited Members

- Public Types inherited from TMetalBaseShader< FRHIComputeShader, SF_Compute >
enum  
 
- Protected Member Functions inherited from TMetalBaseShader< FRHIComputeShader, SF_Compute >
MTLFunctionPtr GetCompiledFunction (bool const bAsync=false, const int32 FunctionIndex=-1)
 
- Protected Member Functions inherited from FRHIResource
virtual RHI_API ~FRHIResource ()
 
- Protected Attributes inherited from TMetalBaseShader< FRHIComputeShader, SF_Compute >
FMetalDevice & Device
 
- Protected Attributes inherited from FRHIShaderData
FShaderResourceTable ShaderResourceTable
 
TArray< FUniformBufferStaticSlot > StaticSlots
 

Constructor & Destructor Documentation

◆ FMetalComputeShader()

FMetalComputeShader::FMetalComputeShader ( FMetalDevice &  Device,
TArrayView< const uint8 >  InCode,
MTLLibraryPtr  InLibrary 
)

◆ ~FMetalComputeShader()

FMetalComputeShader::~FMetalComputeShader ( )
virtual

Member Function Documentation

◆ GetFunction()

MTLFunctionPtr FMetalComputeShader::GetFunction ( )

◆ GetPipeline()

FMetalShaderPipelinePtr FMetalComputeShader::GetPipeline ( )

Member Data Documentation

◆ NumThreadsX

int32 FMetalComputeShader::NumThreadsX

◆ NumThreadsY

int32 FMetalComputeShader::NumThreadsY

◆ NumThreadsZ

int32 FMetalComputeShader::NumThreadsZ
The documentation for this class was generated from the following files: