code: FNiagaraDispatchIndirectArgsGenCS ( const [ShaderMetaType::CompiledShaderInitializerType](API\Runtime\RenderCore\FGlobalShaderType\CompiledShaderInitializerType) & Initializer )


className: FNiagaraDispatchIndirectArgsGenCS

module: NiagaraVertexFactories

code: class FNiagaraDispatchIndirectArgsGenCS : public [FGlobalShader](API\Runtime\RenderCore\FGlobalShader)


code: FNiagaraDispatchIndirectInfoCS()


code: FNiagaraDispatchIndirectInfoCS ( const FUintVector & InCounterOffsets, const FIntVector & InThreadGroupSize, uint32 InIndirectArgsOffset )


className: FNiagaraDispatchIndirectInfoCS

code: struct FNiagaraDispatchIndirectInfoCS

CounterOffsets

type: FUintVector

ThreadGroupSize

type: FIntVector


className: FNiagaraDispatchIndirectParametersCS


code: bool operator== ( const [FNiagaraDrawIndirectArgGenTaskInfo](API\Plugins\NiagaraVertexFactories\FNiagaraDrawIndirectArgGenTaskIn-) & Rhs ) const


code: FNiagaraDrawIndirectArgGenTaskInfo ( uint32 InInstanceCountBufferOffset, uint32 InNumIndicesPerInstance, uint32 InStartIndexLocation, [ENiagaraDrawIndirectArgGenTaskFlags](API\Plugins\NiagaraVertexFactories\ENiagaraDrawIndirectArgGenTaskFl-) InFlags )


className: FNiagaraDrawIndirectArgGenTaskInfo

description: Task info when generating draw indirect frame buffer. Task is either about generate Niagara renderers drawindirect buffer, or about resetting released instance counters.


code: static [FShader](API\Runtime\RenderCore\FShader) * ConstructCompiledInstance ( const typename [FShader::CompiledShaderInitializerType](API\Runtime\RenderCore\FShader\CompiledShaderInitializerType) & Initializer )


code: static [FShader](API\Runtime\RenderCore\FShader) * ConstructSerializedInstance()


className: CounterBase

code: static constexpr int CounterBase = __COUNTER__;


code: static FUniformBufferRHIRef CreateUniformBuffer &40; const FParameters & InContents, EUniformBufferUsage InUsage &41;


className: Alignment

code: static Alignment = 16;


className: bIsStoredInConstantBuffer

code: static bIsStoredInConstantBuffer = true;


className: FileLine

code: static FileLine = builtin_LINE();


className: FileName

code: static FileName = builtin_FILE();


code: static const FShaderParametersMetadata &42; GetStructMetadata&40;&41;


className: NumColumns

code: static NumColumns = 1;


className: NumElements

code: static NumElements = 0;


className: NumRows

code: static NumRows = 1;


className: TAlignedType

code: typedef FParameters TAlignedType


className: FTypeInfo

description: GetStructMetadata()

code: struct FTypeInfo


className: zzFuncPtr

code: typedef void &42; zzFuncPtr


code: static TArray< FShaderParametersMetadata::FMember > zzGetMembers&40;&41;


className: zzMemberFunc

code: typedef zzFuncPtr(&42; zzMemberFunc


className: zzMemberIdCulledInstanceCounts


className: zzMemberIdRWDrawIndirectArgs


className: zzMemberIdRWInstanceCounts


className: zzMemberIdTaskCount


className: zzMemberIdTaskInfos


className: zzTThisStruct

code: typedef FParameters zzTThisStruct


className: FParameters

code: class FParameters

CulledInstanceCounts

type: TShaderResource...

TaskCount

type: TShaderParamete...


className: FPermutationDomain


className: DefineName

code: static DefineName = TEXT( "SUPPORTS_TEXTURE_RW" );


className: FSupportsTextureRW

code: class FSupportsTextureRW : public [TShaderPermutationInt< int32, 2 >](API\Runtime\RenderCore\TShaderPermutationInt)


code: static const [FShaderParametersMetadata](API\Runtime\RenderCore\FShaderParametersMetadata) * GetRootParametersMetadata()


code: NIAGARAVERTEXFACTORIES_API const [FTypeLayoutDesc](API\Runtime\Core\Serialization\FTypeLayoutDesc) & GetTypeLayout() const


code: static NIAGARAVERTEXFACTORIES_API [ShaderMetaType](API\Runtime\RenderCore\FGlobalShader\ShaderMetaType) & GetStaticType()


className: InterfaceType

code: static constexpr [ETypeLayoutInterface::Type](API\Runtime\Core\Serialization\ETypeLayoutInterface__Type) InterfaceType = ETypeLayoutInterface:: NonVirtual;


code: static void Initialize &40; FTypeLayoutDesc & TypeDesc &41;


className: InternalLinkType

code: template<int Counter> struct InternalLinkType


code: static void ModifyCompilationEnvironmentImpl ( const [FShaderPermutationParameters](API\Runtime\RenderCore\FShaderPermutationParameters) & Parameters, [FShaderCompilerEnvironment](API\Runtime\RenderCore\FShaderCompilerEnvironment) & OutEnvironment )


code: static void ModifyCompilationEnvironment ( const [FGlobalShaderPermutationParameters](API\Runtime\RenderCore\FGlobalShaderPermutationParamete-) & Parameters, [FShaderCompilerEnvironment](API\Runtime\RenderCore\FShaderCompilerEnvironment) & OutEnvironment )


className: ShaderTypeRegistration


code: static bool ShouldCompilePermutationImpl ( const [FShaderPermutationParameters](API\Runtime\RenderCore\FShaderPermutationParameters) & Parameters )


code: static NIAGARAVERTEXFACTORIES_API [FTypeLayoutDesc](API\Runtime\Core\Serialization\FTypeLayoutDesc) & StaticGetTypeLayout()


code: FNiagaraDrawIndirectArgsGenCS()


code: FNiagaraDrawIndirectArgsGenCS ( const [ShaderMetaType::CompiledShaderInitializerType](API\Runtime\RenderCore\FGlobalShaderType\CompiledShaderInitializerType) & Initializer )


className: FNiagaraDrawIndirectArgsGenCS

description: Compute shader used to generate GPU emitter draw indirect args. It also resets unused instance count entries.

code: class FNiagaraDrawIndirectArgsGenCS : public [FGlobalShader](API\Runtime\RenderCore\FGlobalShader)


code: static [FShader](API\Runtime\RenderCore\FShader) * ConstructCompiledInstance ( const typename [FShader::CompiledShaderInitializerType](API\Runtime\RenderCore\FShader\CompiledShaderInitializerType) & Initializer )


code: static [FShader](API\Runtime\RenderCore\FShader) * ConstructSerializedInstance()


className: CounterBase

code: static constexpr int CounterBase = __COUNTER__;


className: Alignment

code: static Alignment = 16;


code: static FUniformBufferRHIRef CreateUniformBuffer &40; const FParameters & InContents, EUniformBufferUsage InUsage &41;


className: bIsStoredInConstantBuffer

code: static bIsStoredInConstantBuffer = true;


className: FileLine

code: static FileLine = builtin_LINE();


code: static const FShaderParametersMetadata &42; GetStructMetadata&40;&41;


className: FileName

code: static FileName = builtin_FILE();


className: NumColumns

code: static NumColumns = 1;


className: NumElements

code: static NumElements = 0;


className: NumRows

code: static NumRows = 1;


className: TAlignedType

code: typedef FParameters TAlignedType


className: FTypeInfo

description: GetStructMetadata()

code: struct FTypeInfo


className: zzFuncPtr

code: typedef void &42; zzFuncPtr


code: static TArray< FShaderParametersMetadata::FMember > zzGetMembers&40;&41;


className: zzMemberFunc

code: typedef zzFuncPtr(&42; zzMemberFunc


className: zzMemberIdRWInstanceCounts


className: zzMemberIdTaskCount


className: zzMemberIdTaskInfos


className: FParameters

code: class FParameters


className: zzTThisStruct

code: typedef FParameters zzTThisStruct


className: FPermutationDomain


code: static NIAGARAVERTEXFACTORIES_API [ShaderMetaType](API\Runtime\RenderCore\FGlobalShader\ShaderMetaType) & GetStaticType()


code: static const [FShaderParametersMetadata](API\Runtime\RenderCore\FShaderParametersMetadata) * GetRootParametersMetadata()


code: NIAGARAVERTEXFACTORIES_API const [FTypeLayoutDesc](API\Runtime\Core\Serialization\FTypeLayoutDesc) & GetTypeLayout() const


code: static void Initialize &40; FTypeLayoutDesc & TypeDesc &41;


className: InterfaceType

code: static constexpr [ETypeLayoutInterface::Type](API\Runtime\Core\Serialization\ETypeLayoutInterface__Type) InterfaceType = ETypeLayoutInterface:: NonVirtual;


className: InternalLinkType

code: template<int Counter> struct InternalLinkType


code: static void ModifyCompilationEnvironmentImpl ( const [FShaderPermutationParameters](API\Runtime\RenderCore\FShaderPermutationParameters) & Parameters, [FShaderCompilerEnvironment](API\Runtime\RenderCore\FShaderCompilerEnvironment) & OutEnvironment )


code: static void ModifyCompilationEnvironment ( const [FGlobalShaderPermutationParameters](API\Runtime\RenderCore\FGlobalShaderPermutationParamete-) & Parameters, [FShaderCompilerEnvironment](API\Runtime\RenderCore\FShaderCompilerEnvironment) & OutEnvironment )


className: ShaderTypeRegistration


code: static bool ShouldCompilePermutationImpl ( const [FShaderPermutationParameters](API\Runtime\RenderCore\FShaderPermutationParameters) & Parameters )


code: static NIAGARAVERTEXFACTORIES_API [FTypeLayoutDesc](API\Runtime\Core\Serialization\FTypeLayoutDesc) & StaticGetTypeLayout()


code: FNiagaraDrawIndirectResetCountsCS()


code: FNiagaraDrawIndirectResetCountsCS ( const [ShaderMetaType::CompiledShaderInitializerType](API\Runtime\RenderCore\FGlobalShaderType\CompiledShaderInitializerType) & Initializer )


className: FNiagaraDrawIndirectResetCountsCS

description: Compute shader used to reset unused instance count entries. Used if the platform doesn't support RW texture buffers

code: class FNiagaraDrawIndirectResetCountsCS : public [FGlobalShader](API\Runtime\RenderCore\FGlobalShader)


code: static [FShader](API\Runtime\RenderCore\FShader) * ConstructCompiledInstance ( const typename [FShader::CompiledShaderInitializerType](API\Runtime\RenderCore\FShader\CompiledShaderInitializerType) & Initializer )


code: static [FShader](API\Runtime\RenderCore\FShader) * ConstructSerializedInstance()


className: CounterBase

code: static constexpr int CounterBase = __COUNTER__;


className: Alignment

code: static Alignment = 16;


code: static FUniformBufferRHIRef CreateUniformBuffer &40; const FParameters & InContents, EUniformBufferUsage InUsage &41;


className: bIsStoredInConstantBuffer

code: static bIsStoredInConstantBuffer = true;


className: FileLine

code: static FileLine = builtin_LINE();


className: FileName

code: static FileName = builtin_FILE();


code: static const FShaderParametersMetadata &42; GetStructMetadata&40;&41;


className: NumColumns

code: static NumColumns = 1;


className: NumElements

code: static NumElements = 0;


className: TAlignedType

code: typedef FParameters TAlignedType


className: NumRows

code: static NumRows = 1;


className: zzFuncPtr

code: typedef void &42; zzFuncPtr


className: FTypeInfo

description: GetStructMetadata()

code: struct FTypeInfo


code: static TArray< FShaderParametersMetadata::FMember > zzGetMembers&40;&41;


className: zzMemberFunc

code: typedef zzFuncPtr(&42; zzMemberFunc


className: zzMemberIdbLocalSpace


className: zzMemberIdCPUNumInstances


className: zzMemberIdDefaultPosition


className: zzMemberIdDefaultRotation


className: zzMemberIdDefaultScale


className: zzMemberIdGPUInstanceCountBuffer


className: zzMemberIdInstanceCountOffset


className: zzMemberIdLocalTransform


className: zzMemberIdLocalTransformTile


className: zzMemberIdMeshIndexOffset


className: zzMemberIdMeshIndexValue


className: zzMemberIdMeshRotation


className: zzMemberIdMeshScale


className: zzMemberIdParticleDataFloatStride


className: zzMemberIdParticleDataIntStride

description: SHADER_PARAMETER(uint32,    ParticleDataHalfStride)


className: zzMemberIdParticleDataFloatBuffer


className: zzMemberIdParticleDataIntBuffer

description: SHADER_PARAMETER_SRV(Buffer,  ParticleDataHalfBuffer)


className: zzMemberIdPositionDataOffset


className: zzMemberIdRelativePreViewTranslation


className: zzMemberIdRenderVisibilityOffset


className: zzMemberIdRenderVisibilityValue


className: zzMemberIdRotationDataOffset


className: zzMemberIdScaleDataOffset


className: zzMemberIdSystemLWCTile


className: zzMemberIdTLASTransforms


className: zzMemberIdViewTilePosition


className: zzTThisStruct

code: typedef FParameters zzTThisStruct


className: FParameters

code: class FParameters


className: FPermutationDomain


code: static const [FShaderParametersMetadata](API\Runtime\RenderCore\FShaderParametersMetadata) * GetRootParametersMetadata()


code: static NIAGARAVERTEXFACTORIES_API [ShaderMetaType](API\Runtime\RenderCore\FGlobalShader\ShaderMetaType) & GetStaticType()


code: NIAGARAVERTEXFACTORIES_API const [FTypeLayoutDesc](API\Runtime\Core\Serialization\FTypeLayoutDesc) & GetTypeLayout() const


className: InterfaceType

code: static constexpr [ETypeLayoutInterface::Type](API\Runtime\Core\Serialization\ETypeLayoutInterface__Type) InterfaceType = ETypeLayoutInterface:: NonVirtual;


code: static void Initialize &40; FTypeLayoutDesc & TypeDesc &41;


className: InternalLinkType

code: template<int Counter> struct InternalLinkType


code: static void ModifyCompilationEnvironmentImpl ( const [FShaderPermutationParameters](API\Runtime\RenderCore\FShaderPermutationParameters) & Parameters, [FShaderCompilerEnvironment](API\Runtime\RenderCore\FShaderCompilerEnvironment) & OutEnvironment )


code: static void ModifyCompilationEnvironment ( const [FGlobalShaderPermutationParameters](API\Runtime\RenderCore\FGlobalShaderPermutationParamete-) & Parameters, [FShaderCompilerEnvironment](API\Runtime\RenderCore\FShaderCompilerEnvironment) & OutEnvironment )


code: static bool ShouldCompilePermutationImpl ( const [FShaderPermutationParameters](API\Runtime\RenderCore\FShaderPermutationParameters) & Parameters )


code: static bool ShouldCompilePermutation ( const [FGlobalShaderPermutationParameters](API\Runtime\RenderCore\FGlobalShaderPermutationParamete-) & Parameters )


code: static NIAGARAVERTEXFACTORIES_API [FTypeLayoutDesc](API\Runtime\Core\Serialization\FTypeLayoutDesc) & StaticGetTypeLayout()


className: ThreadGroupSize

code: static constexpr uint32 ThreadGroupSize = 64;


code: FNiagaraGPURayTracingTransformsCS()


code: FNiagaraGPURayTracingTransformsCS ( const [ShaderMetaType::CompiledShaderInitializerType](API\Runtime\RenderCore\FGlobalShaderType\CompiledShaderInitializerType) & Initializer )


className: FNiagaraGPURayTracingTransformsCS

description: Compute shader used to pass GPU instances transforms to the ray tracing TLAS.

code: class FNiagaraGPURayTracingTransformsCS : public [FGlobalShader](API\Runtime\RenderCore\FGlobalShader)


code: static FUniformBufferRHIRef CreateUniformBuffer ( const [FNiagaraMeshCommonParameters](API\Plugins\NiagaraVertexFactories\FNiagaraMeshCommonParameters) & InContents, EUniformBufferUsage InUsage )


className: ShaderTypeRegistration


className: Alignment

code: static Alignment = 16;


className: FileLine

code: static FileLine = builtin_LINE();


className: bIsStoredInConstantBuffer

code: static bIsStoredInConstantBuffer = true;


className: FileName

code: static FileName = builtin_FILE();


code: static const FShaderParametersMetadata &42; GetStructMetadata&40;&41;


className: NumElements

code: static NumElements = 0;


className: NumColumns

code: static NumColumns = 1;


className: NumRows

code: static NumRows = 1;


className: FTypeInfo

code: struct FTypeInfo


className: zzFuncPtr

code: typedef void * zzFuncPtr


className: zzMemberFunc

code: typedef zzFuncPtr(* zzMemberFunc


className: zzMemberIdAccurateMotionVectors


className: zzMemberIdbLocalSpace


className: zzMemberIdbLockedAxisEnable


className: zzMemberIdbMeshOffsetIsWorldSpace


className: zzMemberIdDefaultScale


className: zzMemberIdCameraOffsetDataOffset


className: zzMemberIdDefaultRotation


className: zzMemberIdDefaultPosition


className: zzMemberIdDefaultVelocity


className: zzMemberIdDefaultCameraOffset


className: zzMemberIdDefaultPrevScale


className: zzMemberIdDefaultPrevRotation


className: zzMemberIdDefaultPrevPosition


className: zzMemberIdDefaultPrevVelocity


className: zzMemberIdDefaultPrevCameraOffset


className: zzMemberIdDeltaSeconds


className: zzMemberIdFacingMode


className: zzMemberIdLockedAxis


className: zzMemberIdLockedAxisSpace


className: zzMemberIdMeshOffset


className: zzMemberIdMeshRotation


className: zzMemberIdMeshScale


className: zzMemberIdNiagaraParticleDataFloat


className: zzMemberIdNiagaraParticleDataInt


className: zzMemberIdNiagaraParticleDataHalf


className: zzMemberIdNiagaraFloatDataStride


className: zzMemberIdNiagaraIntDataStride


className: zzMemberIdPositionDataOffset


className: zzMemberIdPrevCameraOffsetDataOffset


className: zzMemberIdPrevRotationDataOffset


className: zzMemberIdPrevScaleDataOffset


className: zzMemberIdPrevVelocityDataOffset


className: zzMemberIdRotationDataOffset


className: zzMemberIdScaleDataOffset


className: zzMemberIdSortedIndices


className: zzMemberIdSortedIndicesOffset


className: zzMemberIdPrevPositionDataOffset


className: zzMemberIdSystemLWCTile


className: zzMemberIdVelocityDataOffset


code: FNiagaraMeshCommonParameters()


className: FNiagaraMeshCommonParameters

description: Common shader parameters for mesh particle renderers (used by multiple shaders)

code: class FNiagaraMeshCommonParameters


className: FNiagaraMeshUniformBufferRef


code: static FUniformBufferRHIRef CreateUniformBuffer ( const [FNiagaraMeshUniformParameters](API\Plugins\NiagaraVertexFactories\FNiagaraMeshUniformParameters) & InContents, EUniformBufferUsage InUsage )


className: Alignment


className: bIsStoredInConstantBuffer


className: FileLine


className: FileName


className: NumColumns


className: NumElements


className: NumRows


className: FTypeInfo


code: static const [FShaderParametersMetadata](API\Runtime\RenderCore\FShaderParametersMetadata) * GetStructMetadata()


className: zzFuncPtr


className: zzMemberFunc


className: zzMemberIdColorDataOffset


className: zzMemberIdDefaultNormAge


className: zzMemberIdDefaultSubImage


className: zzMemberIdDefaultMatRandom


className: zzMemberIdDefaultColor


className: zzMemberIdMaterialParamValidMask


className: zzMemberIdMaterialRandomDataOffset


className: zzMemberIdMaterialParamDataOffset


className: zzMemberIdSubImageSize


className: zzMemberIdSubImageDataOffset


className: zzMemberIdSubImageBlendMode


className: zzMemberIdTexCoordWeightB


className: zzMemberIdTexCoordWeightA


className: zzMemberIdNormalizedAgeDataOffset


code: FNiagaraMeshUniformParameters()


className: FNiagaraMeshUniformParameters

code: class FNiagaraMeshUniformParameters

Common

type: FNiagaraMeshCom...


code: void EnablePrimitiveIDElement ( bool bEnable )


code: [FRHIShaderResourceView](API\Runtime\RHI\FRHIShaderResourceView) * GetColorComponentsSRV() const


code: uint32 GetColorIndexMask() const


code: int32 GetLODIndex() const


code: int32 GetMeshIndex() const


code: int GetNumTexcoords() const


description: Get vertex elements used when during PSO precaching materials using this vertex factory type

code: static void GetPSOPrecacheVertexFetchElements ( EVertexInputStreamType VertexInputStreamType, FVertexDeclarationElementList & Elements )


code: [FRHIShaderResourceView](API\Runtime\RHI\FRHIShaderResourceView) * GetTextureCoordinatesSRV() const


code: [FRHIShaderResourceView](API\Runtime\RHI\FRHIShaderResourceView) * GetTangentsSRV() const


code: virtual NIAGARAVERTEXFACTORIES_API [FVertexFactoryType](API\Runtime\RenderCore\FVertexFactoryType) * GetType() const


description: Retrieve the uniform buffer for this vertex factory.

code: [FRHIUniformBuffer](API\Runtime\RHI\FRHIUniformBuffer) * GetUniformBuffer() const


code: static void GetVertexElements ( [ERHIFeatureLevel::Type](API\Runtime\RHI\ERHIFeatureLevel__Type) FeatureLevel, bool bSupportsManualVertexFetch, [FStaticMeshDataType](API\Runtime\Engine\FStaticMeshDataType) & Data, FVertexDeclarationElementList & Elements )


code: static void GetVertexElements ( [ERHIFeatureLevel::Type](API\Runtime\RHI\ERHIFeatureLevel__Type) FeatureLevel, bool bSupportsManualVertexFetch, [FStaticMeshDataType](API\Runtime\Engine\FStaticMeshDataType) & Data, FVertexDeclarationElementList & Elements, [FVertexStreamList](API\Runtime\RenderCore\FVertexFactory\FVertexStreamList) & InOutStreams )


description: Initializes the RHI resources used by this resource. Called when entering the state where both the resource and the RHI have been initialized. This is only called by the rendering thread.

code: virtual void InitRHI ( [FRHICommandListBase](API\Runtime\RHI\FRHICommandListBase) & RHICmdList )


description: Modify compile environment to enable instancing

code: static void ModifyCompilationEnvironment ( const [FVertexFactoryShaderPermutationParameters](API\Runtime\Renderer\FVertexFactoryShaderPermutationP-) & Parameters, [FShaderCompilerEnvironment](API\Runtime\RenderCore\FShaderCompilerEnvironment) & OutEnvironment )


description: An implementation of the interface used by TSynchronizedResource to update the resource with new data from the game thread.

code: void SetData ( const [FStaticMeshDataType](API\Runtime\Engine\FStaticMeshDataType) & InData )


code: void SetLODIndex ( int32 InLODIndex )


code: void SetMeshIndex ( int32 InMeshIndex )


code: void SetNiagaraMeshFeatureLevel ( [ERHIFeatureLevel::Type](API\Runtime\RHI\ERHIFeatureLevel__Type) InFeatureLevel )


description: Set the uniform buffer for this vertex factory.

code: void SetUniformBuffer ( const [FNiagaraMeshUniformBufferRef](API\Plugins\NiagaraVertexFactories\FNiagaraMeshUniformBufferRef) & InMeshParticleUniformBuffer )


description: Should we cache the material's shadertype on this platform with this vertex factory?

code: static bool ShouldCompilePermutation ( const [FVertexFactoryShaderPermutationParameters](API\Runtime\Renderer\FVertexFactoryShaderPermutationP-) & Parameters )


className: StaticType

code: static NIAGARAVERTEXFACTORIES_API [FVertexFactoryType](API\Runtime\RenderCore\FVertexFactoryType) StaticType;


code: FNiagaraMeshVertexFactory()


description: Default constructor.

code: FNiagaraMeshVertexFactory ( [ENiagaraVertexFactoryType](API\Plugins\NiagaraVertexFactories\ENiagaraVertexFactoryType) InType, [ERHIFeatureLevel::Type](API\Runtime\RHI\ERHIFeatureLevel__Type) InFeatureLevel )


className: FNiagaraMeshVertexFactory

description: Vertex factory for rendering instanced mesh particles with out dynamic parameter support.

code: class FNiagaraMeshVertexFactory : public [FNiagaraVertexFactoryBase](API\Plugins\NiagaraVertexFactories\FNiagaraVertexFactoryBase)

bAddPrimitiveIDElement

type: bool

Data

type: FStaticMeshData...

MeshParticleUniformBuffer

type: FRHIUniformBuff...

description: Uniform buffer with mesh particle parameters.


description: Initialize the RHI for this rendering resource


description: Releases the RHI resources used by this resource. Called when leaving the state where both the resource and the RHI have been initialized. This is only called by the rendering thread.

code: virtual void ReleaseRHI()


className: FNiagaraNullSortedIndicesVertexBuffer

code: class FNiagaraNullSortedIndicesVertexBuffer : public [FVertexBuffer](API\Runtime\RenderCore\FVertexBuffer)

VertexBufferSRV

type: FShaderResource...


className: FNiagaraRibbonUniformBufferRef


code: static FUniformBufferRHIRef CreateUniformBuffer ( const [FNiagaraRibbonUniformParameters](API\Plugins\NiagaraVertexFactories\FNiagaraRibbonUniformParameters) & InContents, EUniformBufferUsage InUsage )


className: Alignment

code: static Alignment = 16;


className: bIsStoredInConstantBuffer

code: static bIsStoredInConstantBuffer = true;


className: FileLine

code: static FileLine = builtin_LINE();


className: FileName

code: static FileName = builtin_FILE();


className: NumColumns

code: static NumColumns = 1;


code: static const FShaderParametersMetadata &42; GetStructMetadata&40;&41;


className: NumElements

code: static NumElements = 0;


className: NumRows

code: static NumRows = 1;


className: FTypeInfo

code: struct FTypeInfo


className: zzFuncPtr

code: typedef void * zzFuncPtr


code: static const [FShaderParametersMetadata](API\Runtime\RenderCore\FShaderParametersMetadata) * GetStructMetadata()


className: zzMemberFunc

code: typedef zzFuncPtr(* zzMemberFunc


className: zzMemberIdbLocalSpace


className: zzMemberIdCameraUp


className: zzMemberIdCameraRight


className: zzMemberIdColorDataOffset


className: zzMemberIdDeltaSeconds


className: zzMemberIdDistanceFromStartOffset


className: zzMemberIdFacingDataOffset


className: zzMemberIdInterpCount


className: zzMemberIdInterpIdShift


className: zzMemberIdInterpIdMask


className: zzMemberIdMaterialRandomDataOffset


className: zzMemberIdMaterialParamValidMask


className: zzMemberIdMaterialParamDataOffset


className: zzMemberIdNormalizedAgeDataOffset


className: zzMemberIdOneOverInterpCount


className: zzMemberIdPackedVData


className: zzMemberIdParticleIdShift


className: zzMemberIdParticleIdMask


className: zzMemberIdPositionDataOffset


className: zzMemberIdPrevFacingDataOffset


className: zzMemberIdPrevTwistDataOffset


className: zzMemberIdPrevPositionDataOffset


className: zzMemberIdPrevWidthDataOffset


className: zzMemberIdScreenAlignment


className: zzMemberIdShouldFlipNormalToView


className: zzMemberIdShouldUseMultiRibbon


className: zzMemberIdSliceVertexIdMask


className: zzMemberIdSystemLWCTile


className: zzMemberIdTwistDataOffset


className: zzMemberIdVelocityDataOffset


className: zzMemberIdWidthDataOffset


code: FNiagaraRibbonUniformParameters()


className: FNiagaraRibbonUniformParameters

code: class FNiagaraRibbonUniformParameters


className: FNiagaraRibbonVertexDynamicParameter

description: FNiagaraRibbonVertexDynamicParameter.

DynamicValue

description: The dynamic parameter of the particle


code: static void GetPSOPrecacheVertexFetchElements ( EVertexInputStreamType VertexInputStreamType, FVertexDeclarationElementList & Elements )


code: virtual NIAGARAVERTEXFACTORIES_API [FVertexFactoryType](API\Runtime\RenderCore\FVertexFactoryType) * GetType() const


description: Initialize the Render Hardware Interface for this vertex factory

code: virtual void InitRHI ( [FRHICommandListBase](API\Runtime\RHI\FRHICommandListBase) & RHICmdList )


description: Can be overridden byFVertexFactorysubclasses to modify their compile environment just before compilation occurs.

code: static void ModifyCompilationEnvironment ( const [FVertexFactoryShaderPermutationParameters](API\Runtime\Renderer\FVertexFactoryShaderPermutationP-) & Parameters, [FShaderCompilerEnvironment](API\Runtime\RenderCore\FShaderCompilerEnvironment) & OutEnvironment )


description: Set the source vertex buffer that contains particle dynamic parameter data.

code: void SetDynamicParameterBuffer ( const [FVertexBuffer](API\Runtime\RenderCore\FVertexBuffer) * InDynamicParameterBuffer, int32 ParameterIndex, uint32 StreamOffset, uint32 Stride )


code: void SetRibbonUniformBuffer ( [FNiagaraRibbonUniformBufferRef](API\Plugins\NiagaraVertexFactories\FNiagaraRibbonUniformBufferRef) InSpriteUniformBuffer )


description: Set the source vertex buffer.

code: void SetVertexBuffer ( const [FVertexBuffer](API\Runtime\RenderCore\FVertexBuffer) * InBuffer, uint32 StreamOffset, uint32 Stride )


code: static bool ShouldCompilePermutation ( const [FVertexFactoryShaderPermutationParameters](API\Runtime\Renderer\FVertexFactoryShaderPermutationP-) & Parameters )


className: StaticType

code: static NIAGARAVERTEXFACTORIES_API [FVertexFactoryType](API\Runtime\RenderCore\FVertexFactoryType) StaticType;


code: FNiagaraRibbonVertexFactory()


description: Default constructor.

code: FNiagaraRibbonVertexFactory ( [ENiagaraVertexFactoryType](API\Plugins\NiagaraVertexFactories\ENiagaraVertexFactoryType) InType, [ERHIFeatureLevel::Type](API\Runtime\RHI\ERHIFeatureLevel__Type) InFeatureLevel )


className: FNiagaraRibbonVertexFactory

description: Beam/Trail particle vertex factory.

code: class FNiagaraRibbonVertexFactory : public [FNiagaraVertexFactoryBase](API\Plugins\NiagaraVertexFactories\FNiagaraVertexFactoryBase)

LooseParameterUniformBuffer

type: FUniformBufferR...


code: static FUniformBufferRHIRef CreateUniformBuffer ( const [FNiagaraRibbonVFLooseParameters](API\Plugins\NiagaraVertexFactories\FNiagaraRibbonVFLooseParameters) & InContents, EUniformBufferUsage InUsage )


className: Alignment

code: static Alignment = 16;


className: bIsStoredInConstantBuffer

code: static bIsStoredInConstantBuffer = true;


className: FileLine

code: static FileLine = builtin_LINE();


className: FileName

code: static FileName = builtin_FILE();


code: static const FShaderParametersMetadata &42; GetStructMetadata&40;&41;


className: NumElements

code: static NumElements = 0;


className: NumColumns

code: static NumColumns = 1;


className: NumRows

code: static NumRows = 1;


className: FTypeInfo

code: struct FTypeInfo


code: static const [FShaderParametersMetadata](API\Runtime\RenderCore\FShaderParametersMetadata) * GetStructMetadata()


className: zzFuncPtr

code: typedef void * zzFuncPtr


className: zzMemberFunc

code: typedef zzFuncPtr(* zzMemberFunc


className: zzMemberIdFacingMode


className: zzMemberIdIndirectDrawOutput


className: zzMemberIdIndirectDrawOutputOffset


className: zzMemberIdMultiRibbonIndices


className: zzMemberIdNeedsPreciseMotionVectors


className: zzMemberIdNiagaraFloatDataStride


className: zzMemberIdNiagaraParticleDataFloat


className: zzMemberIdNiagaraParticleDataHalf


className: zzMemberIdPackedPerRibbonDataByIndex


className: zzMemberIdSliceVertexData


className: zzMemberIdSortedIndices


className: zzMemberIdTangentsAndDistances


code: FNiagaraRibbonVFLooseParameters()


className: FNiagaraRibbonVFLooseParameters

code: class FNiagaraRibbonVFLooseParameters


className: FNiagaraRibbonVFLooseParametersRef


code: static [FShader](API\Runtime\RenderCore\FShader) * ConstructCompiledInstance ( const typename [FShader::CompiledShaderInitializerType](API\Runtime\RenderCore\FShader\CompiledShaderInitializerType) & Initializer )


code: static [FShader](API\Runtime\RenderCore\FShader) * ConstructSerializedInstance()


className: CounterBase

code: static constexpr int CounterBase = __COUNTER__;


className: DefineName

code: static DefineName = TEXT( "ENABLE_CULLING" );


className: FEnableCulling

code: class FEnableCulling : public [FShaderPermutationBool](API\Runtime\RenderCore\FShaderPermutationBool)


code: static FUniformBufferRHIRef CreateUniformBuffer &40; const FParameters & InContents, EUniformBufferUsage InUsage &41;


className: Alignment

code: static Alignment = 16;


className: bIsStoredInConstantBuffer

code: static bIsStoredInConstantBuffer = true;


className: FileLine

code: static FileLine = builtin_LINE();


className: FileName

code: static FileName = builtin_FILE();


code: static const FShaderParametersMetadata &42; GetStructMetadata&40;&41;


className: NumColumns

code: static NumColumns = 1;


className: NumElements

code: static NumElements = 0;


className: NumRows

code: static NumRows = 1;


className: TAlignedType

code: typedef FParameters TAlignedType


className: FTypeInfo

description: GetStructMetadata()

code: struct FTypeInfo


className: zzFuncPtr

code: typedef void &42; zzFuncPtr


code: static TArray< FShaderParametersMetadata::FMember > zzGetMembers&40;&41;


className: zzMemberFunc

code: typedef zzFuncPtr(&42; zzMemberFunc


className: zzMemberIdCameraPosition


className: zzMemberIdCameraDirection


className: zzMemberIdCullDistanceRangeSquared


className: zzMemberIdCulledGPUParticleCountOffset


className: zzMemberIdCullingWorldSpaceOffset


className: zzMemberIdCullPlanes


className: zzMemberIdCullPositionAttributeOffset


className: zzMemberIdCullScaleAttributeOffset


className: zzMemberIdEmitterKey


className: zzMemberIdFloatDataStride


className: zzMemberIdGPUParticleCountBuffer


className: zzMemberIdGPUParticleCountOffset


className: zzMemberIdIntDataStride


className: zzMemberIdHalfDataStride


className: zzMemberIdLocalBoundingSphere


className: zzMemberIdMeshIndex


className: zzMemberIdMeshIndexAttributeOffset


className: zzMemberIdNiagaraParticleDataFloat


className: zzMemberIdNiagaraParticleDataHalf


className: zzMemberIdNiagaraParticleDataInt


className: zzMemberIdNumCullPlanes


className: zzMemberIdOutCulledParticleCounts


className: zzMemberIdOutputOffset


className: zzMemberIdOutParticleIndices


className: zzMemberIdParticleCount


className: zzMemberIdRendererVisibility


className: zzMemberIdRendererVisTagAttributeOffset


className: zzMemberIdSortAttributeOffset


className: zzMemberIdSortKeyMask


className: zzMemberIdSortKeyShift


className: zzMemberIdSortKeySignBit


className: zzMemberIdSortMode


className: zzMemberIdSystemLWCTile


className: zzTThisStruct

code: typedef FParameters zzTThisStruct


className: FParameters

code: class FParameters


className: FPermutationDomain


className: DefineName

code: static DefineName = TEXT( "SORT_MAX_PRECISION" );


className: FSortUsingMaxPrecision

description: class FMyShaderDim : SHADER_PERMUTATION_BOOL("MY_SHADER_DEFINE_NAME");

code: class FSortUsingMaxPrecision : public [FShaderPermutationBool](API\Runtime\RenderCore\FShaderPermutationBool)


code: static DefineName = TEXT( "DIM_USE_WAVE_OPS" );


className: FUseWaveOps

code: class FUseWaveOps : public [FShaderPermutationBool](API\Runtime\RenderCore\FShaderPermutationBool)


code: static const [FShaderParametersMetadata](API\Runtime\RenderCore\FShaderParametersMetadata) * GetRootParametersMetadata()


code: static NIAGARAVERTEXFACTORIES_API [ShaderMetaType](API\Runtime\RenderCore\FGlobalShader\ShaderMetaType) & GetStaticType()


code: NIAGARAVERTEXFACTORIES_API const [FTypeLayoutDesc](API\Runtime\Core\Serialization\FTypeLayoutDesc) & GetTypeLayout() const


className: InterfaceType

code: static constexpr [ETypeLayoutInterface::Type](API\Runtime\Core\Serialization\ETypeLayoutInterface__Type) InterfaceType = ETypeLayoutInterface:: NonVirtual;


className: InternalBaseType

code: typedef typename [TGetBaseTypeHelper](API\Runtime\Core\Serialization\TGetBaseTypeHelper)< [FNiagaraSortKeyGenCS](API\Plugins\NiagaraVertexFactories\FNiagaraSortKeyGenCS) >::Type InternalBaseType


code: static void Initialize &40; FTypeLayoutDesc & TypeDesc &41;


code: static void ModifyCompilationEnvironmentImpl ( const [FShaderPermutationParameters](API\Runtime\RenderCore\FShaderPermutationParameters) & Parameters, [FShaderCompilerEnvironment](API\Runtime\RenderCore\FShaderCompilerEnvironment) & OutEnvironment )


className: InternalLinkType

code: template<int Counter> struct InternalLinkType


code: static void ModifyCompilationEnvironment ( const [FGlobalShaderPermutationParameters](API\Runtime\RenderCore\FGlobalShaderPermutationParamete-) & Parameters, [FShaderCompilerEnvironment](API\Runtime\RenderCore\FShaderCompilerEnvironment) & OutEnvironment )


className: ShaderTypeRegistration


code: static bool ShouldCompilePermutationImpl ( const [FShaderPermutationParameters](API\Runtime\RenderCore\FShaderPermutationParameters) & Parameters )


code: static bool ShouldCompilePermutation ( const [FGlobalShaderPermutationParameters](API\Runtime\RenderCore\FGlobalShaderPermutationParamete-) & Parameters )


code: static NIAGARAVERTEXFACTORIES_API [FTypeLayoutDesc](API\Runtime\Core\Serialization\FTypeLayoutDesc) & StaticGetTypeLayout()


code: static bool UseWaveOps ( EShaderPlatform ShaderPlatform )


code: FNiagaraSortKeyGenCS()


code: FNiagaraSortKeyGenCS ( const [ShaderMetaType::CompiledShaderInitializerType](API\Runtime\RenderCore\FGlobalShaderType\CompiledShaderInitializerType) & Initializer )


className: FNiagaraSortKeyGenCS

description: Compute shader used to generate particle sort keys.

code: class FNiagaraSortKeyGenCS : public [FGlobalShader](API\Runtime\RenderCore\FGlobalShader)


className: FNiagaraSpriteUniformBufferRef


code: static FUniformBufferRHIRef CreateUniformBuffer ( const [FNiagaraSpriteUniformParameters](API\Plugins\NiagaraVertexFactories\FNiagaraSpriteUniformParameters) & InContents, EUniformBufferUsage InUsage )


className: Alignment

code: static Alignment = 16;


className: bIsStoredInConstantBuffer

code: static bIsStoredInConstantBuffer = true;


className: FileLine

code: static FileLine = builtin_LINE();


className: FileName

code: static FileName = builtin_FILE();


code: static const FShaderParametersMetadata &42; GetStructMetadata&40;&41;


className: NumElements

code: static NumElements = 0;


className: NumColumns

code: static NumColumns = 1;


className: NumRows

code: static NumRows = 1;


className: FTypeInfo

code: struct FTypeInfo


code: static const [FShaderParametersMetadata](API\Runtime\RenderCore\FShaderParametersMetadata) * GetStructMetadata()


className: zzFuncPtr

code: typedef void * zzFuncPtr


className: zzMemberFunc

code: typedef zzFuncPtr(* zzMemberFunc


className: zzMemberIdAccurateMotionVectors


className: zzMemberIdAlignmentDataOffset


className: zzMemberIdbLocalSpace


className: zzMemberIdCameraFacingBlend


className: zzMemberIdCameraOffsetDataOffset


className: zzMemberIdColorDataOffset


className: zzMemberIdDefaultPivotOffset


className: zzMemberIdDefaultPrevPivotOffset


className: zzMemberIdDefaultPrevRotation


className: zzMemberIdDefaultColor


className: zzMemberIdDefaultMatRandom


className: zzMemberIdDefaultCamOffset


className: zzMemberIdDefaultNormAge


className: zzMemberIdDefaultSubImage


className: zzMemberIdDefaultFacing


className: zzMemberIdDefaultPrevFacing


className: zzMemberIdDefaultAlignment


className: zzMemberIdDefaultPos


className: zzMemberIdDefaultPrevAlignment


className: zzMemberIdDefaultPrevCamOffset


className: zzMemberIdDefaultPrevPos


className: zzMemberIdDefaultSize


className: zzMemberIdDefaultPrevSize


className: zzMemberIdDefaultUVScale


className: zzMemberIdDefaultVelocity


className: zzMemberIdDefaultPrevVelocity


className: zzMemberIdDefaultRotation


className: zzMemberIdDeltaSeconds


className: zzMemberIdFacingDataOffset


className: zzMemberIdMacroUVParameters


className: zzMemberIdMaterialParamValidMask


className: zzMemberIdMaterialParamDataOffset


className: zzMemberIdMaterialRandomDataOffset


className: zzMemberIdNormalsSphereCenter


className: zzMemberIdNormalsCylinderUnitDirection


className: zzMemberIdNormalsType


className: zzMemberIdNormalizedAgeDataOffset


className: zzMemberIdPivotOffsetDataOffset


className: zzMemberIdPixelCoverageEnabled


className: zzMemberIdPixelCoverageColorBlend


className: zzMemberIdPositionDataOffset


className: zzMemberIdPrevCameraOffsetDataOffset


className: zzMemberIdPrevAlignmentDataOffset


className: zzMemberIdPrevFacingDataOffset


className: zzMemberIdPrevPivotOffsetDataOffset


className: zzMemberIdPrevPositionDataOffset


className: zzMemberIdPrevRotationDataOffset


className: zzMemberIdPrevSizeDataOffset


className: zzMemberIdPrevVelocityDataOffset


className: zzMemberIdRotationScale


className: zzMemberIdRemoveHMDRoll


className: zzMemberIdRotationBias


className: zzMemberIdRotationDataOffset


className: zzMemberIdSizeDataOffset


className: zzMemberIdSubImageSize


className: zzMemberIdSubimageDataOffset


className: zzMemberIdSubImageBlendMode


className: zzMemberIdSystemLWCTile


className: zzMemberIdTangentSelector


className: zzMemberIdUVScaleDataOffset


className: zzMemberIdVelocityDataOffset


code: FNiagaraSpriteUniformParameters()


className: FNiagaraSpriteUniformParameters

code: class FNiagaraSpriteUniformParameters


code: uint32 GetAlignmentMode() const


code: [FRHIShaderResourceView](API\Runtime\RHI\FRHIShaderResourceView) * GetCutoutGeometrySRV() const


code: uint32 GetFacingMode() const


code: static void GetPSOPrecacheVertexFetchElements ( EVertexInputStreamType VertexInputStreamType, FVertexDeclarationElementList & Elements )


code: [FRHIShaderResourceView](API\Runtime\RHI\FRHIShaderResourceView) * GetSortedIndicesSRV() const


code: int32 GetSortedIndicesOffset() const


code: [FRHIUniformBuffer](API\Runtime\RHI\FRHIUniformBuffer) * GetSpriteUniformBuffer() const


code: virtual NIAGARAVERTEXFACTORIES_API [FVertexFactoryType](API\Runtime\RenderCore\FVertexFactoryType) * GetType() const


code: virtual void InitRHI ( [FRHICommandListBase](API\Runtime\RHI\FRHICommandListBase) & RHICmdList )


description: Initialize streams for this vertex factory.

code: void InitStreams()


code: static void ModifyCompilationEnvironment ( const [FVertexFactoryShaderPermutationParameters](API\Runtime\Renderer\FVertexFactoryShaderPermutationP-) & Parameters, [FShaderCompilerEnvironment](API\Runtime\RenderCore\FShaderCompilerEnvironment) & OutEnvironment )


code: virtual bool RendersPrimitivesAsCameraFacingSprites() const


code: void SetAlignmentMode ( uint32 InMode )


code: void SetCutoutParameters ( int32 InNumCutoutVerticesPerFrame, [FRHIShaderResourceView](API\Runtime\RHI\FRHIShaderResourceView) * InCutoutGeometrySRV )


code: void SetFacingMode ( uint32 InMode )


code: void SetSortedIndices ( const FShaderResourceViewRHIRef & InSortedIndicesSRV, uint32 InSortedIndicesOffset )


code: void SetSpriteUniformBuffer ( const [FNiagaraSpriteUniformBufferRef](API\Plugins\NiagaraVertexFactories\FNiagaraSpriteUniformBufferRef) & InSpriteUniformBuffer )


code: void SetTexCoordBuffer ( const [FVertexBuffer](API\Runtime\RenderCore\FVertexBuffer) * InTexCoordBuffer )


code: void SetVertexBufferOverride ( const [FVertexBuffer](API\Runtime\RenderCore\FVertexBuffer) * InVertexBufferOverride )


code: static bool ShouldCompilePermutation ( const [FVertexFactoryShaderPermutationParameters](API\Runtime\Renderer\FVertexFactoryShaderPermutationP-) & Parameters )


className: StaticType

code: static NIAGARAVERTEXFACTORIES_API [FVertexFactoryType](API\Runtime\RenderCore\FVertexFactoryType) StaticType;


code: FNiagaraSpriteVertexFactory()


description: Default constructor.

code: FNiagaraSpriteVertexFactory ( [ENiagaraVertexFactoryType](API\Plugins\NiagaraVertexFactories\ENiagaraVertexFactoryType) InType, [ERHIFeatureLevel::Type](API\Runtime\RHI\ERHIFeatureLevel__Type) InFeatureLevel )


className: FNiagaraSpriteVertexFactory

description: Vertex factory for rendering particle sprites.

code: class FNiagaraSpriteVertexFactory : public [FNiagaraVertexFactoryBase](API\Plugins\NiagaraVertexFactories\FNiagaraVertexFactoryBase)


code: static FUniformBufferRHIRef CreateUniformBuffer ( const [FNiagaraSpriteVFLooseParameters](API\Plugins\NiagaraVertexFactories\FNiagaraSpriteVFLooseParameters) & InContents, EUniformBufferUsage InUsage )


className: Alignment

code: static Alignment = 16;


className: bIsStoredInConstantBuffer

code: static bIsStoredInConstantBuffer = true;


className: FileLine

code: static FileLine = builtin_LINE();


className: FileName

code: static FileName = builtin_FILE();


code: static const FShaderParametersMetadata &42; GetStructMetadata&40;&41;


className: NumColumns

code: static NumColumns = 1;


className: NumElements

code: static NumElements = 0;


className: NumRows

code: static NumRows = 1;


className: FTypeInfo

code: struct FTypeInfo


code: static const [FShaderParametersMetadata](API\Runtime\RenderCore\FShaderParametersMetadata) * GetStructMetadata()


className: zzFuncPtr

code: typedef void * zzFuncPtr


className: zzMemberFunc

code: typedef zzFuncPtr(* zzMemberFunc


className: zzMemberIdCutoutGeometry


className: zzMemberIdIndirectArgsOffset


className: zzMemberIdIndirectArgsBuffer


className: zzMemberIdNiagaraFloatDataStride


className: zzMemberIdNiagaraParticleDataHalf


className: zzMemberIdNiagaraParticleDataFloat


className: zzMemberIdNumCutoutVerticesPerFrame


className: zzMemberIdParticleAlignmentMode


className: zzMemberIdParticleFacingMode


className: zzMemberIdSortedIndicesOffset


className: zzMemberIdSortedIndices


code: FNiagaraSpriteVFLooseParameters()


className: FNiagaraSpriteVFLooseParameters

code: class FNiagaraSpriteVFLooseParameters


className: FNiagaraSpriteVFLooseParametersRef


code: bool CheckAndUpdateLastFrame ( const [FSceneViewFamily](API\Runtime\Engine\FSceneViewFamily) & ViewFamily, const [FSceneView](API\Runtime\Engine\FSceneView) * View ) const


description: Return the vertex factory type

code: bool GetInUse() const


description: Return the vertex factory type


code: static void ModifyCompilationEnvironment ( const [FVertexFactoryShaderPermutationParameters](API\Runtime\Renderer\FVertexFactoryShaderPermutationP-) & Parameters, [FShaderCompilerEnvironment](API\Runtime\RenderCore\FShaderCompilerEnvironment) & OutEnvironment )


description: Specify whether the factory is in use or not.

code: void SetInUse ( bool bInInUse )


code: void SetParticleFactoryType ( [ENiagaraVertexFactoryType](API\Plugins\NiagaraVertexFactories\ENiagaraVertexFactoryType) InType )


description: Default constructor.

code: FNiagaraVertexFactoryBase ( [ENiagaraVertexFactoryType](API\Plugins\NiagaraVertexFactories\ENiagaraVertexFactoryType) Type, [ERHIFeatureLevel::Type](API\Runtime\RHI\ERHIFeatureLevel__Type) InFeatureLevel )


className: FNiagaraVertexFactoryBase

description: Base class for particle vertex factories.

code: class FNiagaraVertexFactoryBase : public [FVertexFactory](API\Runtime\RenderCore\FVertexFactory)


code: void Bind ( const [FShaderParameterMap](API\Runtime\RenderCore\FShaderParameterMap) & ParameterMap )


className: CounterBase

code: static constexpr int CounterBase = __COUNTER__;


code: void GetElementShaderBindings ( const [FSceneInterface](API\Runtime\Engine\FSceneInterface) * Scene, const [FSceneView](API\Runtime\Engine\FSceneView) * View, const [FMeshMaterialShader](API\Runtime\Renderer\FMeshMaterialShader) * Shader, const EVertexInputStreamType VertexStreamType, [ERHIFeatureLevel::Type](API\Runtime\RHI\ERHIFeatureLevel__Type) FeatureLevel, const [FVertexFactory](API\Runtime\RenderCore\FVertexFactory) * VertexFactory, const [FMeshBatchElement](API\Runtime\Engine\FMeshBatchElement) & BatchElement, class [FMeshDrawSingleShaderBindings](API\Runtime\Renderer\FMeshDrawSingleShaderBindings) & ShaderBindings, FVertexInputStreamArray & VertexStreams ) const


code: const [FTypeLayoutDesc](API\Runtime\Core\Serialization\FTypeLayoutDesc) & GetTypeLayout() const


code: static void Initialize &40; FTypeLayoutDesc & TypeDesc &41;


className: InternalLinkType

code: template<int Counter> struct InternalLinkType


code: static [FTypeLayoutDesc](API\Runtime\Core\Serialization\FTypeLayoutDesc) & StaticGetTypeLayout()


description: Base class for Niagara vertex factory shader parameters.

code: class FNiagaraVertexFactoryShaderParametersBase : public [FVertexFactoryShaderParameters](API\Runtime\RenderCore\FVertexFactoryShaderParameters)


code: NIAGARAVERTEXFACTORIES_API const [FShaderParametersMetadata](API\Runtime\RenderCore\FShaderParametersMetadata) * GetForwardDeclaredShaderParametersStructMetadata ( const [FNiagaraMeshUniformParameters](API\Plugins\NiagaraVertexFactories\FNiagaraMeshUniformParameters) * DummyPtr )


code: NIAGARAVERTEXFACTORIES_API const [FShaderParametersMetadata](API\Runtime\RenderCore\FShaderParametersMetadata) * GetForwardDeclaredShaderParametersStructMetadata ( const [FNiagaraRibbonUniformParameters](API\Plugins\NiagaraVertexFactories\FNiagaraRibbonUniformParameters) * DummyPtr )


code: NIAGARAVERTEXFACTORIES_API const [FShaderParametersMetadata](API\Runtime\RenderCore\FShaderParametersMetadata) * GetForwardDeclaredShaderParametersStructMetadata ( const [FNiagaraRibbonVFLooseParameters](API\Plugins\NiagaraVertexFactories\FNiagaraRibbonVFLooseParameters) * DummyPtr )


code: NIAGARAVERTEXFACTORIES_API const [FShaderParametersMetadata](API\Runtime\RenderCore\FShaderParametersMetadata) * GetForwardDeclaredShaderParametersStructMetadata ( const [FNiagaraSpriteUniformParameters](API\Plugins\NiagaraVertexFactories\FNiagaraSpriteUniformParameters) * DummyPtr )


code: NIAGARAVERTEXFACTORIES_API const [FShaderParametersMetadata](API\Runtime\RenderCore\FShaderParametersMetadata) * GetForwardDeclaredShaderParametersStructMetadata ( const [FNiagaraSpriteVFLooseParameters](API\Plugins\NiagaraVertexFactories\FNiagaraSpriteVFLooseParameters) * DummyPtr )


description: Called before the module is unloaded, right before the module object is destroyed. During normal shutdown, this is called in reverse order that modules finishStartupModule(). This means that, as long as a module references dependent modules in it'sStartupModule(), it can safely reference those dependencies inShutdownModule()as well.

code: virtual void ShutdownModule()


description: FModuleManager::Get().LoadModuleChecked(TEXT("HTTP"));

code: virtual void StartupModule()


className: InterfaceType

code: static constexpr [ETypeLayoutInterface::Type](API\Runtime\Core\Serialization\ETypeLayoutInterface__Type) InterfaceType = ETypeLayoutInterface:: NonVirtual;


className: INiagaraVertexFactoriesModule

description: Niagara vertex factories module interface

code: class INiagaraVertexFactoriesModule : public [IModuleInterface](API\Runtime\Core\Modules\IModuleInterface)


className: operator&=

code: [ENiagaraDrawIndirectArgGenTaskFlags](API\Plugins\NiagaraVertexFactories\ENiagaraDrawIndirectArgGenTaskFl-) & operator&= ( [ENiagaraDrawIndirectArgGenTaskFlags](API\Plugins\NiagaraVertexFactories\ENiagaraDrawIndirectArgGenTaskFl-) & Lhs, [ENiagaraDrawIndirectArgGenTaskFlags](API\Plugins\NiagaraVertexFactories\ENiagaraDrawIndirectArgGenTaskFl-) Rhs )


className: operator^=

code: [ENiagaraDrawIndirectArgGenTaskFlags](API\Plugins\NiagaraVertexFactories\ENiagaraDrawIndirectArgGenTaskFl-) & operator^= ( [ENiagaraDrawIndirectArgGenTaskFlags](API\Plugins\NiagaraVertexFactories\ENiagaraDrawIndirectArgGenTaskFl-) & Lhs, [ENiagaraDrawIndirectArgGenTaskFlags](API\Plugins\NiagaraVertexFactories\ENiagaraDrawIndirectArgGenTaskFl-) Rhs )


className: operator!

code: constexpr bool operator! ( [ENiagaraDrawIndirectArgGenTaskFlags](API\Plugins\NiagaraVertexFactories\ENiagaraDrawIndirectArgGenTaskFl-) E )


className: ENNETensorDataType

description: The enum lists all tensor data types used in NNE

module: NNE

code: enum ENNETensorDataType { None, Char, Boolean, Half, Float, Double, Int8, Int16, Int32, Int64, UInt8, UInt16, UInt32, UInt64, Complex64, Complex128, BFloat16, }


description:
Get the dimensions of the symbolic tensor shape.
a view on the dimensions of the symbolic tensor shape.

code: TConstArrayView< int32 > GetData() const


description:
Check if the symbolic tensor shape has no variable dimensions, aka is concrete.
true if the symbolic tensor shape is concrete, false otherwise.

code: bool IsConcrete() const


description:
Construct a symbolic tensor shape with the given dimensions.
a symbolic tensor shape with the given dimensions.

code: static [FSymbolicTensorShape](API\Plugins\NNE\FSymbolicTensorShape) Make ( TConstArrayView< int32 > Data )


className: MaxRank

description: The maximum number of dimensions supported by the symbolic tensor shape, aka the rank.

code: static constexpr int32 MaxRank = 8;


description: Assign this symbolic tensor shape from another one.

code: void operator= ( const [FSymbolicTensorShape](API\Plugins\NNE\FSymbolicTensorShape) & OtherShape )


description:
Check if the symbolic tensor shape is equal to another one.
true if the symbolic tensor shape is equal to the other one, false otherwise.

code: bool operator== ( const [FSymbolicTensorShape](API\Plugins\NNE\FSymbolicTensorShape) & OtherShape ) const


description:
Check if the symbolic tensor shape is different from another one.
true if the symbolic tensor shape is different from the other one, false otherwise.

code: bool operator!= ( const [FSymbolicTensorShape](API\Plugins\NNE\FSymbolicTensorShape) & OtherShape ) const


description:
Get the number of dimensions of the symbolic tensor shape, aka the rank.
the number of dimensions of the symbolic tensor shape.

code: int32 Rank() const


description: Default construct a symbolic tensor shape.

code: FSymbolicTensorShape()


description: Construct this symbolic tensor shape from another one.

code: FSymbolicTensorShape ( const [FSymbolicTensorShape](API\Plugins\NNE\FSymbolicTensorShape) & OtherShape )


className: FSymbolicTensorShape

description: The variable dimensions are represented by -1 values.

code: class FSymbolicTensorShape


className: FTensorBindingCPU

description: Memory is owned by the caller. The caller must make sure the buffer is large enough and at least as large as SizeInBytes.

code: struct FTensorBindingCPU

Data

type: void *


className: FTensorBindingGPU

code: struct FTensorBindingGPU


className: FTensorBindingRDG

description: Memory is owned by the caller. The caller must make sure the buffer is large enough.

code: struct FTensorBindingRDG

Buffer

type: FRDGBufferRef


description:
Get the data type of the tensor
the data type of the tensor.


description:
Get the size in bytes of one element of the tensor.
the size in bytes of one element of the tensor.

code: uint32 GetElemByteSize() const


description:
Get the name of the tensor
the name of the tensor.

code: const [FString](API\Runtime\Core\Containers\FString) & GetName() const


description:
Get the symbolic shape of the tensor.
the symbolic shape of the tensor.

code: const [FSymbolicTensorShape](API\Plugins\NNE\FSymbolicTensorShape) & GetShape() const


description:
Construct a tensor description for model input/output
a tensor shape with the given dimensions.

code: static [FTensorDesc](API\Plugins\NNE\FTensorDesc) Make ( const [FString](API\Runtime\Core\Containers\FString) & Name, const [FSymbolicTensorShape](API\Plugins\NNE\FSymbolicTensorShape) & Shape, [ENNETensorDataType](API\Plugins\NNE\ENNETensorDataType) DataType )


className: FTensorDesc

description: No constructors are accessible with public or protected access.

code: class FTensorDesc


description:
Get the dimensions of the tensor shape.
a view on the dimensions of the tensor shape.

code: TConstArrayView< uint32 > GetData() const


description:
For example [1,2] is compatible with [-1,2] and [1,2] but not with [2,2] or [1,2,3].
true if this tensor shape is compatible with the symbolic shape, false otherwise.

code: bool IsCompatibleWith ( const [FSymbolicTensorShape](API\Plugins\NNE\FSymbolicTensorShape) & SymbolicShape ) const


description:
Construct a tensor shape with the given dimensions.
a tensor shape with the given dimensions.

code: static [FTensorShape](API\Plugins\NNE\FTensorShape) Make ( TConstArrayView< uint32 > Data )


description:
Negative dimension values are replaced by 1.
a tensor shape with the given dimensions.

code: static [FTensorShape](API\Plugins\NNE\FTensorShape) MakeFromSymbolic ( const [FSymbolicTensorShape](API\Plugins\NNE\FSymbolicTensorShape) & SymbolicShape )


description: The maximum number of dimensions supported by the tensor shape, aka the rank.

code: static constexpr int32 MaxRank = FSymbolicTensorShape::MaxRank;


description: Assign this tensor shape from another one.

code: void operator= ( const [FTensorShape](API\Plugins\NNE\FTensorShape) & OtherShape )


description:
Check if the tensor shape is equal to another one.
true if the tensor shape is equal to the other one, false otherwise.

code: bool operator== ( const [FTensorShape](API\Plugins\NNE\FTensorShape) & OtherShape ) const


description:
Check if the tensor shape is different from another one.
true if the tensor shape is different from the other one, false otherwise.

code: bool operator!= ( const [FTensorShape](API\Plugins\NNE\FTensorShape) & OtherShape ) const


description:
Get the number of dimensions of the tensor shape, aka the rank.
the number of dimensions of the tensor shape.

code: int32 Rank() const


description:
Get the number of elements in this tensor shape.
the number of element in this tensor shape.

code: uint64 Volume() const


description: Default construct a tensor shape.

code: FTensorShape()


description: Construct this tensor shape from another one.

code: FTensorShape ( const [FTensorShape](API\Plugins\NNE\FTensorShape) & OtherShape )


className: FTensorShape

description: Concrete tensor shapes are well defined through strictly positive values and thus have a defined volume.

code: class FTensorShape


description:
The runtime have the opportunity to share the model weights among multipleIModelInstanceCPUcreated from anIModelCPUinstance, however this is not mandatory. The caller can decide to convert the result into a shared pointer if required (e.g. if the model needs to be shared with an async task for evaluation).
A caller owned model representing the neural network instance created.


className: IModelCPU

description: Use UE::NNE::GetRuntime(RuntimeName) to get a runtime capable of creating CPU models.

code: class IModelCPU


description:
The runtime have the opportunity to share the model weights among multipleIModelInstanceGPUcreated from anIModelGPUinstance, however this is not mandatory. The caller can decide to convert the result into a shared pointer if required (e.g. if the model needs to be shared with an async task for evaluation).
A caller owned model representing the neural network instance created.


className: IModelGPU

description: Use UE::NNE::GetRuntime(RuntimeName) to get a runtime capable of creating GPU models.

code: class IModelGPU


description:
Get the input tensor descriptions as defined by the model, potentially with variable dimensions.
An array containing a tensor descriptor for each input tensor of the model.

code: TConstArrayView< [FTensorDesc](API\Plugins\NNE\FTensorDesc) > GetInputTensorDescs() const


description:
Get the output tensor descriptions as defined by the model, potentially with variable dimensions.
An array containing a tensor descriptor for each output tensor of the model.

code: TConstArrayView< [FTensorDesc](API\Plugins\NNE\FTensorDesc) > GetOutputTensorDescs() const


description:
SetInputTensorShapes must be called prior of running a model.
An array of input shapes or an empty array if SetInputTensorShapes has not been called.

code: TConstArrayView< [FTensorShape](API\Plugins\NNE\FTensorShape) > GetInputTensorShapes() const


description:
Output shapes might be resolved after a call to SetInputTensorShapes if the model and runtime supports it. Otherwise they will be resolved while running the model
An array of output shapes or an empty array if not resolved yet.

code: TConstArrayView< [FTensorShape](API\Plugins\NNE\FTensorShape) > GetOutputTensorShapes() const


description:
SetInputTensorShapes must be called prior to this call. This function will block the calling thread until the inference is complete. The caller owns the memory inside the bindings and must make sure that they are big enough. Clients can call this function from an async task but must make sure the memory remains valid throughout the evaluation.
0 on success or a non-zero number otherwise.

code: int RunSync ( TConstArrayView< [FTensorBindingCPU](API\Plugins\NNE\FTensorBindingCPU) > InInputTensors, TConstArrayView< [FTensorBindingCPU](API\Plugins\NNE\FTensorBindingCPU) > InOutputTensors )


description:
The call is mandatory before a model can be run. The function will run shape inference and resolve, if possible, the output shapes which can then be accessed by callingGetOutputTensorShapes(). This is a potentially expensive call and should be called lazily if possible.
0 on success or a non-zero number otherwise.

code: int SetInputTensorShapes ( TConstArrayView< [FTensorShape](API\Plugins\NNE\FTensorShape) > InInputShapes )


className: IModelInstanceCPU

description: UseUE::NNE::IModelCPU::CreateModelInstance()to get a model instance. Use UE::NNE::GetRuntime(RuntimeName) to get a runtime capable of creating CPU models.

code: class IModelInstanceCPU


code: int RunSync ( TConstArrayView< [FTensorBindingGPU](API\Plugins\NNE\FTensorBindingGPU) > InInputTensors, TConstArrayView< [FTensorBindingGPU](API\Plugins\NNE\FTensorBindingGPU) > InOutputTensors )


className: IModelInstanceGPU

description: UseUE::NNE::IModelGPU::CreateModelInstance()to get a model instance. Use UE::NNE::GetRuntime(RuntimeName) to get a runtime capable of creating GPU models.

code: class IModelInstanceGPU


description:
This function must be called from the render thread. SetInputTensorShapes must be called prior to this call. The caller owns the memory inside the bindings and must make sure that they are big enough.
0 on success or a non-zero number otherwise.

code: int EnqueueRDG ( [FRDGBuilder](API\Runtime\RenderCore\FRDGBuilder) & RDGBuilder, TConstArrayView< [FTensorBindingRDG](API\Plugins\NNE\FTensorBindingRDG) > Inputs, TConstArrayView< [FTensorBindingRDG](API\Plugins\NNE\FTensorBindingRDG) > Outputs )


description:
The call is mandatory before a model can be run. This function might be called from the render thread, if not it is up to the caller to ensure thread safety. The function will run shape inference and resolve, if possible, the output shapes which can then be accessed by callingGetOutputTensorShapes(). This is a potentially expensive call and should be called lazily if possible.
0 on success or a non-zero number otherwise.


description:
The runtime have the opportunity to share the model weights among multipleIModelInstanceRDGcreated from anIModelRDGinstance, however this is not mandatory. The caller can decide to convert the result into a shared pointer if required (e.g. if the model needs to be shared with an async task for evaluation).
A caller owned model representing the neural network instance created.


className: IModelInstanceRDG

description: UseUE::NNE::IModelRDG::CreateModelInstance()to get a model instance. Use UE::NNE::GetRuntime(RuntimeName) to get a runtime capable of creating RDG models.

code: class IModelInstanceRDG


className: IModelRDG

description: Use UE::NNE::GetRuntime(RuntimeName) to get a runtime capable of creating RDG models.

code: class IModelRDG


description:
Check if the runtime is able to create model data given some file data representing a neural network.
True if the runtime is able to create model data, false otherwise.

code: bool CanCreateModelData ( [FString](API\Runtime\Core\Containers\FString) FileType, TConstArrayView< uint8 > FileData, [FGuid](API\Runtime\Core\Misc\FGuid) FileId, const [ITargetPlatform](API\Developer\TargetPlatform\Interfaces\ITargetPlatform) * TargetPlatform ) const


description:
Create model data given some raw file data.
Data representing the runtime specific representation of the model to be stored byUNNEModelDataon success or an empty array otherwise.

code: [TArray](API\Runtime\Core\Containers\TArray)< uint8 > CreateModelData ( [FString](API\Runtime\Core\Containers\FString) FileType, TConstArrayView< uint8 > FileData, [FGuid](API\Runtime\Core\Misc\FGuid) FileId, const [ITargetPlatform](API\Developer\TargetPlatform\Interfaces\ITargetPlatform) * TargetPlatform )


description:
Get an id uniquely identifying the model data. This is used byUNNEModelDatato create a FCacheKey to get and add the model data from and to a DDC.
A string that identifies the model data uniquely, e.g. by containing the FileId, model data version and target platform display name.

code: [FString](API\Runtime\Core\Containers\FString) GetModelDataIdentifier ( [FString](API\Runtime\Core\Containers\FString) FileType, TConstArrayView< uint8 > FileData, [FGuid](API\Runtime\Core\Misc\FGuid) FileId, const [ITargetPlatform](API\Developer\TargetPlatform\Interfaces\ITargetPlatform) * TargetPlatform )


description:
Get the name of the runtime.
The name of the runtime.


description:
This function is used internally in the cooking process ofUNNEModelData.
True if the platform is supported, false otherwise.

code: bool IsPlatformSupported ( const [ITargetPlatform](API\Developer\TargetPlatform\Interfaces\ITargetPlatform) * TargetPlatform ) const


className: INNERuntime

description: This interface is mainly used internally byUNNEModelDatato cook a model given in a file format (e.g. .onnx) into runtime specific model data. The model data is then stored insideUNNEModelDatawhich then can be used in game to create an inferable model. SeeINNERuntimeCPUandINNERuntimeRDGon how to create a model given aUNNEModelDataasset.

code: class INNERuntime


description:
Check if the runtime is able to create a model given some ModelData.
True if the runtime is able to create the model, false otherwise.

code: bool CanCreateModelCPU ( [TObjectPtr](API\Runtime\Core\Delegates\TObjectPtr)< [UNNEModelData](API\Plugins\NNE\UNNEModelData) > ModelData ) const


description:
The caller must make sure ModelData remains valid throughout the call. ModelData is not required anymore after the model has been created. The caller can decide to convert the result into a shared pointer if required (e.g. if the model needs to be shared with an async task for evaluation).
A caller owned model representing the neural network created from ModelData.

code: [TUniquePtr](API\Runtime\Core\Templates\TUniquePtr)< [UE::NNE::IModelCPU](API\Plugins\NNE\IModelCPU) > CreateModel ( [TObjectPtr](API\Runtime\Core\Delegates\TObjectPtr)< [UNNEModelData](API\Plugins\NNE\UNNEModelData) > ModelData )


className: INNERuntimeCPU

description: Call UE::NNE::GetRuntime(RuntimeName) to get a runtime implementing this interface.

code: class INNERuntimeCPU


code: [TUniquePtr](API\Runtime\Core\Templates\TUniquePtr)< [UE::NNE::IModelGPU](API\Plugins\NNE\IModelGPU) > CreateModel ( [TObjectPtr](API\Runtime\Core\Delegates\TObjectPtr)< [UNNEModelData](API\Plugins\NNE\UNNEModelData) > ModelData )


code: bool CanCreateModelGPU ( [TObjectPtr](API\Runtime\Core\Delegates\TObjectPtr)< [UNNEModelData](API\Plugins\NNE\UNNEModelData) > ModelData ) const


className: INNERuntimeGPU

code: class INNERuntimeGPU


code: bool CanCreateModelRDG ( [TObjectPtr](API\Runtime\Core\Delegates\TObjectPtr)< [UNNEModelData](API\Plugins\NNE\UNNEModelData) > ModelData ) const


description:
The caller must make sure ModelData remains valid throughout the call. ModelData is not required anymore after the model has been created. The caller can decide to convert the result into a shared pointer if required (e.g. if the model needs to be shared with the render thread).
A caller owned model representing the neural network created from ModelData.

code: [TUniquePtr](API\Runtime\Core\Templates\TUniquePtr)< [UE::NNE::IModelRDG](API\Plugins\NNE\IModelRDG) > CreateModel ( [TObjectPtr](API\Runtime\Core\Delegates\TObjectPtr)< [UNNEModelData](API\Plugins\NNE\UNNEModelData) > ModelData )


className: INNERuntimeRDG

code: class INNERuntimeRDG


description:
This function tries to find a runtime by name and casts it to the interface passed as template argument (e.g.INNERuntime,INNERuntimeCPUorINNERuntimeRDG).
A weak pointer to the runtime if it has been found and implements the interface in the template argument or an invalid pointer otherwise.

code: namespace UE { namespace NNE { template<class T> [TWeakInterfacePtr](API\Runtime\CoreUObject\UObject\TWeakInterfacePtr)< T > UE::NNE::GetRuntime ( const [FString](API\Runtime\Core\Containers\FString) & Name ) } }


description: Gathers a list of asset registry searchable tags which are name/value pairs with some type information This only needs to be implemented for asset objects

code: virtual void GetAssetRegistryTags ( [TArray](API\Runtime\Core\Containers\TArray)< [FAssetRegistryTag](API\Runtime\CoreUObject\UObject\UObject\FAssetRegistryTag) > & OutTags ) const


description:
The FileData contains the binary data of the file which has been used to create the asset.
The FileData.

code: TConstArrayView< uint8 > GetFileData()


description:
The FileId is created on import of an asset. It can be used to identify the FileData, e.g. when putting corresponding data into the DDC or caching data locally.
The FileId.


description:
The FileType identifies the type of data inside FileData and typically is the extension of the file used to create the asset.
The FileType.


description:
This function is used by runtimes when creating a model. In editor, the function will create the optimized model data with the passed runtime in case it has not been cached in the DCC yet. In game, the cooked data is accessed.
The optimized and runtime specific model data or an empty view in case of a failure.

code: TConstArrayView< uint8 > GetModelData ( const [FString](API\Runtime\Core\Containers\FString) & RuntimeName )


description:
Get the target runtimes this model data will be cooked for. An empty list mean all runtimes.
The target runtimes names.

code: [TArrayView](API\Runtime\Core\Containers\TArrayView)< const [FString](API\Runtime\Core\Containers\FString) > GetTargetRuntimes() const


className: GUID

description: A Guid used for asset versioning.

code: static const [FGuid](API\Runtime\Core\Misc\FGuid) GUID;


description: This function is called by theUNNEModelDataFactoryclass when importing a neural network model file.

code: void Init ( const [FString](API\Runtime\Core\Containers\FString) & Type, TConstArrayView< uint8 > Buffer )


description: Implements custom serialization of this asset.

code: virtual void Serialize ( [FArchive](API\Runtime\Core\Serialization\FArchive) & Ar )


description: Called after the C++ constructor and after the properties have been initialized, including those loaded from config. This is called before any serialization or other setup has happened.

code: virtual void PostInitProperties()


className: UNNEModelData

description: Neural network models typically consist of a graph of operations and corresponding parameters as e.g. weights.UNNEModelDataassets store such model data as imported e.g. by theUNNEModelDataFactoryclass. AnINNERuntimeobject retrieved byUE::NNE::GetRuntime(const FString& Name)can be used to create an inferable neural network model.

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(BlueprintType, Category="NNE") class UNNEModelData : public [UObject](API\Runtime\CoreUObject\UObject\UObject)

AssetImportData

type: TObjectPtr< cla...

description: Importing data used for this asset.


description: Set the target runtimes this model data will be cooked for. An empty list mean all runtimes.

code: void SetTargetRuntimes ( [TArrayView](API\Runtime\Core\Containers\TArrayView)< const [FString](API\Runtime\Core\Containers\FString) > RuntimeNames )


className: UNNERuntime

code: class UNNERuntime : public [UInterface](API\Runtime\CoreUObject\UObject\UInterface)


className: UNNERuntimeCPU

code: class UNNERuntimeCPU : public [UInterface](API\Runtime\CoreUObject\UObject\UInterface)


className: UNNERuntimeGPU

code: class UNNERuntimeGPU : public [UInterface](API\Runtime\CoreUObject\UObject\UInterface)


className: UNNERuntimeRDG

code: class UNNERuntimeRDG : public [UInterface](API\Runtime\CoreUObject\UObject\UInterface)


description:
Check to see if the handler is capable of reimporting the object
true if this handler is capable of reimporting the provided object

module: NNEEditorTools

code: virtual bool CanReimport ( [UObject](API\Runtime\CoreUObject\UObject\UObject) * Obj, [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & OutFilenames )


description:
Whether the specified file can be imported by this factory.
true if the file is supported, false otherwise.

code: virtual bool FactoryCanImport ( const [FString](API\Runtime\Core\Containers\FString) & Filename )


description:
Create a new object by importing it from a binary buffer.
The new object.

code: virtual [UObject](API\Runtime\CoreUObject\UObject\UObject) * FactoryCreateBinary ( [UClass](API\Runtime\CoreUObject\UObject\UClass) * InClass, [UObject](API\Runtime\CoreUObject\UObject\UObject) * InParent, [FName](API\Runtime\Core\UObject\FName) InName, EObjectFlags Flags, [UObject](API\Runtime\CoreUObject\UObject\UObject) * Context, const TCHAR * Type, const uint8 *& Buffer, const uint8 * BufferEnd, [FFeedbackContext](API\Runtime\Core\Misc\FFeedbackContext) * Warn )


description: Attempt to reimport the specified object from its sourceEReimportResult::Succeededif this handler was able to handle reimporting the provided object,EReimportResult::Failedif this handler was unable to handle reimporting the provided object orEReimportResult::Cancelledif the handler was cancelled part-way through re-importing the provided object.

code: virtual [EReimportResult::Type](API\Editor\UnrealEd\EReimportResult__Type) Reimport ( [UObject](API\Runtime\CoreUObject\UObject\UObject) * Obj )


description: Sets the reimport path(s) for the specified object

code: virtual void SetReimportPaths ( [UObject](API\Runtime\CoreUObject\UObject\UObject) * Obj, const [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & NewReimportPaths )


code: UNNEModelDataFactory ( const [FObjectInitializer](API\Runtime\CoreUObject\UObject\FObjectInitializer) & ObjectInitializer )


className: UNNEModelDataFactory

description: The currently supported format is .onnx. The factory is invoked when a file of this format is dragged to the editor's content browser.

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)() class UNNEModelDataFactory : public [UFactory](API\Editor\UnrealEd\Factories\UFactory), public [FReimportHandler](API\Editor\UnrealEd\FReimportHandler)


description:
Returns the default map name, that should be used with unit tests, for the current game
Returns the default map name

module: NUTUnrealEngine

code: virtual [FString](API\Runtime\Core\Containers\FString) GetDefaultMap ( [EUnitTestFlags](API\Plugins\NetcodeUnitTest\EUnitTestFlags) UnitTestFlags )


className: FQAGameEnvironment

description: Implements unit test environment settings, for QAGame

code: class FQAGameEnvironment : public [FUnitTestEnvironment](API\Plugins\NetcodeUnitTest\FUnitTestEnvironment)


code: FShooterGameEnvironment()


className: FShooterGameEnvironment

description: Forward declarations Implements unit test environment settings, for ShooterGame

code: class FShooterGameEnvironment : public [FUnitTestEnvironment](API\Plugins\NetcodeUnitTest\FUnitTestEnvironment)


description:
Returns the default URL that minimal clients should use, when connecting to a server, for the current game
Returns the default URL


className: FUTEnvironment

description: Implements unit test environment settings, for UnrealTournament

code: class FUTEnvironment : public [FUnitTestEnvironment](API\Plugins\NetcodeUnitTest\FUnitTestEnvironment)


code: static [INUTUnrealEngine](API\Plugins\NUTUnrealEngine\INUTUnrealEngine) & Get()


code: static bool IsAvailable()


className: INUTUnrealEngine

description: Includes.

code: class INUTUnrealEngine : public [FNUTModuleInterface](API\Plugins\NetcodeUnitTest\FNUTModuleInterface)


description: Interface and hooked events for client unit tests Override this, to implement the client unit test NOTE: Should be called last, in overridden functions IMPORTANT: EndUnitTest should be triggered, upon completion of the unit test (which may be delayed, for many unit tests)

code: virtual void ExecuteClientUnitTest()


description: Finishes initializing unit test settings, that rely upon the current unit test environment being loaded


description: Notification triggered BEFORE a replicated actor has been created (allowing you to block creation, based on class)

code: virtual void NotifyAllowNetActor ( [UClass](API\Runtime\CoreUObject\UObject\UClass) * ActorClass, bool bActorChannel, bool & bBlockActor )


description: Override this, to receive notification AFTER an actor channel actor has been created

code: virtual void NotifyNetActor ( [UActorChannel](API\Runtime\Engine\Engine\UActorChannel) * ActorChannel, [AActor](API\Runtime\Engine\GameFramework\AActor) * Actor )


description: Interface for process unit tests For implementation in subclasses, for helping to verify success/fail upon completion of unit tests NOTE: Not called again once VerificationState is set WARNING: Be careful when iterating InLogLines in multiple different for loops, if the sequence of detected logs is important

code: virtual void NotifyProcessLog ( [TWeakPtr](API\Runtime\Core\Templates\TWeakPtr)< [FUnitTestProcess](API\Plugins\NetcodeUnitTest\FUnitTestProcess) > InProcess, const [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & InLogLines )


code: UUTT61_DebugReplicateData ( const [FObjectInitializer](API\Runtime\CoreUObject\UObject\FObjectInitializer) & ObjectInitializer )


description: This is the same function that was affected by the bug 55 reported the 27 March, anyway remember that it's NOT used in shipping builds.

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)() class UUTT61_DebugReplicateData : public [UClientUnitTest](API\Plugins\NetcodeUnitTest\UClientUnitTest)

RepClass

type: TObjectPtr<UCl...

description: Reference to the GameplayDebuggingReplicator class


description: UFTextCrash

code: UFTextCrash ( const [FObjectInitializer](API\Runtime\CoreUObject\UObject\FObjectInitializer) & ObjectInitializer )


className: UFTextCrash

description: Thanks, Oliver

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)() class UFTextCrash : public [UClientUnitTest](API\Plugins\NetcodeUnitTest\UClientUnitTest)


description:
Executes the main unit test
Whether or not the unit test kicked off execution successfully

code: virtual bool ExecuteUnitTest()


description: UNetBitsTest

code: UNetBitsTest ( const [FObjectInitializer](API\Runtime\CoreUObject\UObject\FObjectInitializer) & ObjectInitializer )


className: UNetBitsTest

description: Includes.

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)() class UNetBitsTest : public [UUnitTest](API\Plugins\NetcodeUnitTest\UUnitTest)


module: NVCodecs

code: FCUDAContextScope ( CUcontext Context )


className: FCUDAContextScope

code: struct FCUDAContextScope


code: FVideoContextCUDA ( CUcontext const & Raw )


className: FVideoContextCUDA

code: class FVideoContextCUDA : public [FAVContext](API\Plugins\AVCodecsCore\FAVContext)

Raw

type: CUcontext


code: [FAVResult](API\Plugins\AVCodecsCore\FAVResult) CopyFrom ( CUdeviceptr Target, uint32 MapPitch )


code: [FAVResult](API\Plugins\AVCodecsCore\FAVResult) CopyFromAsync ( CUdeviceptr Target, uint32 MapPitch )


code: [FAVResult](API\Plugins\AVCodecsCore\FAVResult) CopyTo ( CUdeviceptr Source, uint32 MapPitch )


code: [FAVResult](API\Plugins\AVCodecsCore\FAVResult) CopyToAsync ( CUdeviceptr Source, uint32 MapPitch )


code: [FAVResult](API\Plugins\AVCodecsCore\FAVResult) ReadData ( TArray64< uint8 > & OutData ) const


description: FAVResult.

code: virtual [FAVResult](API\Plugins\AVCodecsCore\FAVResult) Validate() const


code: FVideoResourceCUDA ( [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FAVDevice](API\Plugins\AVCodecsCore\FAVDevice) > const & Device, CUarray Raw, [FAVLayout](API\Plugins\AVCodecsCore\FAVLayout) const & Layout, [FVideoDescriptor](API\Plugins\AVCodecsCore\Video\FVideoDescriptor) const & Descriptor )


code: FVideoResourceCUDA ( [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FAVDevice](API\Plugins\AVCodecsCore\FAVDevice) > const & Device, CUDA_EXTERNAL_MEMORY_HANDLE_DESC const & ExternalResourceDesc, CUDA_EXTERNAL_SEMAPHORE_HANDLE_DESC const & ExternalFenceDesc, [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FVideoResource](API\Plugins\AVCodecsCore\Video\FVideoResource) > const & ExternalResource, uint64 FenceValue )


code: FVideoResourceCUDA ( [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FAVDevice](API\Plugins\AVCodecsCore\FAVDevice) > const & Device, CUDA_EXTERNAL_MEMORY_HANDLE_DESC const & ExternalResourceDesc, CUDA_EXTERNAL_SEMAPHORE_HANDLE_DESC const & ExternalFenceDesc, [FAVLayout](API\Plugins\AVCodecsCore\FAVLayout) const & Layout, [FVideoDescriptor](API\Plugins\AVCodecsCore\Video\FVideoDescriptor) const & Descriptor, uint64 FenceValue )


className: FVideoResourceCUDA

code: class FVideoResourceCUDA : public [TVideoResource< FVideoContextCUDA >](API\Plugins\AVCodecsCore\Video\TVideoResource)


module: NVDEC

code: [FString](API\Runtime\Core\Containers\FString) GetErrorString ( CUresult ErrorCode ) const


description:
Test if the API loaded correctly, or has since been cleaned up.
True if the API is valid.

code: virtual bool IsValid() const


className: FNVDEC

code: class FNVDEC : public [FAPI](API\Plugins\AVCodecsCore\FAPI), public [NV_DECODE_API_FUNCTION_LIST](API\Plugins\NVDEC\NV_DECODE_API_FUNCTION_LIST)


description: TODO (aidan) some of this includes a video stream parser we likely want to do this externally so that we can process our various stream types ourselves

code: struct NV_DECODE_API_FUNCTION_LIST

cuvidCreateDecoder

type: cuvidCreateDeco...

cuvidCreateVideoParser

type: cuvidCreateVide...

cuvidCtxLockCreate

type: cuvidCtxLockCre...

cuvidCtxLockDestroy

type: cuvidCtxLockDes...

cuvidDecodePicture

type: cuvidDecodePict...

cuvidDestroyDecoder

type: cuvidDestroyDec...

cuvidGetDecoderCaps

type: cuvidGetDecoder...

cuvidGetDecodeStatus

type: cuvidGetDecodeS...

cuvidMapVideoFrame

type: cuvidMapVideoFr...

cuvidParseVideoData

type: cuvidParseVideo...

cuvidReconfigureDecoder

type: cuvidReconfigur...

cuvidUnmapVideoFrame

type: cuvidUnmapVideo...


className: FParsedPicture

code: struct FParsedPicture : public CUVIDPICPARAMS

DecodeCreateInfo

type: CUVIDDECODECREA...

SliceOffsets

type: TArray< uint32 ...


code: [FVideoDecoderConfigNVDEC](API\Plugins\NVDEC\Video\Decoders\Configs\FVideoDecoderConfigNVDEC) & operator= ( [FVideoDecoderConfigNVDEC](API\Plugins\NVDEC\Video\Decoders\Configs\FVideoDecoderConfigNVDEC) const & Other )


code: bool operator!= ( [FVideoDecoderConfigNVDEC](API\Plugins\NVDEC\Video\Decoders\Configs\FVideoDecoderConfigNVDEC) const & Other ) const


code: bool operator== ( [FVideoDecoderConfigNVDEC](API\Plugins\NVDEC\Video\Decoders\Configs\FVideoDecoderConfigNVDEC) const & Other ) const


code: [FAVResult](API\Plugins\AVCodecsCore\FAVResult) Parse ( [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FAVInstance](API\Plugins\AVCodecsCore\FAVInstance) > const & Instance, [FVideoPacket](API\Plugins\AVCodecsCore\Video\FVideoPacket) const & Packet, [TArray](API\Runtime\Core\Containers\TArray)< [FParsedPicture](API\Plugins\NVDEC\Video\Decoders\Configs\FVideoDecoderConfigNVDEC\FParsedPicture) > & OutPictures )


code: FVideoDecoderConfigNVDEC ( [EAVPreset](API\Plugins\AVCodecsCore\EAVPreset) Preset )


code: FVideoDecoderConfigNVDEC ( [FVideoDecoderConfigNVDEC](API\Plugins\NVDEC\Video\Decoders\Configs\FVideoDecoderConfigNVDEC) const & Other )


className: FVideoDecoderConfigNVDEC

code: struct FVideoDecoderConfigNVDEC : public CUVIDDECODECREATEINFO, public [FAVConfig](API\Plugins\AVCodecsCore\FAVConfig)


description: FAVResult.


code: bool GetCapability ( CUVIDDECODECAPS & CapsToQuery ) const


code: virtual [FAVResult](API\Plugins\AVCodecsCore\FAVResult) Open ( [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FAVDevice](API\Plugins\AVCodecsCore\FAVDevice) > const & NewDevice, [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FAVInstance](API\Plugins\AVCodecsCore\FAVInstance) > const & NewInstance )


code: virtual [FAVResult](API\Plugins\AVCodecsCore\FAVResult) ReceiveFrame ( [TResolvableVideoResource](API\Plugins\AVCodecsCore\Video\TResolvableVideoResource)< [FVideoResourceCUDA](API\Plugins\NVCodecs\Video\Resources\FVideoResourceCUDA) > & InOutResource )


code: virtual [FAVResult](API\Plugins\AVCodecsCore\FAVResult) SendPacket ( [FVideoPacket](API\Plugins\AVCodecsCore\Video\FVideoPacket) const & Packet )


className: FVideoDecoderNVDEC

code: class FVideoDecoderNVDEC : public [TVideoDecoder< FVideoResourceCUDA, FVideoDecoderConfigNVDEC >](API\Plugins\AVCodecsCore\Video\TVideoDecoder)


module: NVENC

code: [FString](API\Runtime\Core\Containers\FString) GetErrorString ( void * Encoder, NVENCSTATUS ForStatus ) const


code: virtual bool IsValid() const


className: FNVENC

code: class FNVENC : public [FAPI](API\Plugins\AVCodecsCore\FAPI), public NV_ENCODE_API_FUNCTION_LIST

bHasCompatibleGPU

type: bool


code: static [TAVResult](API\Plugins\AVCodecsCore\TAVResult)< NV_ENC_BUFFER_FORMAT > ConvertFormat ( [EVideoFormat](API\Plugins\AVCodecsCore\Video\EVideoFormat) const & Format )


code: static [TAVResult](API\Plugins\AVCodecsCore\TAVResult)< NV_ENC_MULTI_PASS > ConvertMultipassMode ( [EMultipassMode](API\Plugins\AVCodecsCore\Video\EMultipassMode) Mode )


code: static [TAVResult](API\Plugins\AVCodecsCore\TAVResult)< [EMultipassMode](API\Plugins\AVCodecsCore\Video\EMultipassMode) > ConvertMultipassMode ( NV_ENC_MULTI_PASS Mode )


code: static [TAVResult](API\Plugins\AVCodecsCore\TAVResult)< NV_ENC_PARAMS_RC_MODE > ConvertRateControlMode ( [ERateControlMode](API\Plugins\AVCodecsCore\Video\ERateControlMode) Mode )


code: static [TAVResult](API\Plugins\AVCodecsCore\TAVResult)< [ERateControlMode](API\Plugins\AVCodecsCore\Video\ERateControlMode) > ConvertRateControlMode ( NV_ENC_PARAMS_RC_MODE Mode )


code: bool operator== ( [FVideoEncoderConfigNVENC](API\Plugins\NVENC\Video\Encoders\Configs\FVideoEncoderConfigNVENC) const & Other ) const


code: [FVideoEncoderConfigNVENC](API\Plugins\NVENC\Video\Encoders\Configs\FVideoEncoderConfigNVENC) & operator= ( [FVideoEncoderConfigNVENC](API\Plugins\NVENC\Video\Encoders\Configs\FVideoEncoderConfigNVENC) const & Other )


code: bool operator!= ( [FVideoEncoderConfigNVENC](API\Plugins\NVENC\Video\Encoders\Configs\FVideoEncoderConfigNVENC) const & Other ) const


code: FVideoEncoderConfigNVENC ( [FVideoEncoderConfigNVENC](API\Plugins\NVENC\Video\Encoders\Configs\FVideoEncoderConfigNVENC) const & Other )


className: FVideoEncoderConfigNVENC

code: struct FVideoEncoderConfigNVENC : public [FAVConfig](API\Plugins\AVCodecsCore\FAVConfig), public NV_ENC_INITIALIZE_PARAMS


code: virtual [FAVResult](API\Plugins\AVCodecsCore\FAVResult) ApplyConfig ( [FVideoEncoderConfigNVENC](API\Plugins\NVENC\Video\Encoders\Configs\FVideoEncoderConfigNVENC) const & AppliedConfig, [FVideoEncoderConfigNVENC](API\Plugins\NVENC\Video\Encoders\Configs\FVideoEncoderConfigNVENC) const & PendingConfig, [TFunction](API\Runtime\Core\GenericPlatform\TFunction)< [FAVResult](API\Plugins\AVCodecsCore\FAVResult)()> ApplyConfigFunc )


code: int GetCapability ( GUID EncodeGUID, NV_ENC_CAPS CapsToQuery ) const


code: virtual [FAVResult](API\Plugins\AVCodecsCore\FAVResult) Open ( [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FAVDevice](API\Plugins\AVCodecsCore\FAVDevice) > const & NewDevice, [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FAVInstance](API\Plugins\AVCodecsCore\FAVInstance) > const & NewInstance, [TFunction](API\Runtime\Core\GenericPlatform\TFunction)< void(NV_ENC_OPEN_ENCODE_SESSION_EX_PARAMS &)> SetupEncoderSessionFunc )


code: virtual [FAVResult](API\Plugins\AVCodecsCore\FAVResult) ReceivePacket ( [FVideoPacket](API\Plugins\AVCodecsCore\Video\FVideoPacket) & OutPacket )


code: [FAVResult](API\Plugins\AVCodecsCore\FAVResult) SendFrame ( NV_ENC_PIC_PARAMS Input )


code: virtual [FAVResult](API\Plugins\AVCodecsCore\FAVResult) SendFrameCUDA ( [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FVideoResourceCUDA](API\Plugins\NVCodecs\Video\Resources\FVideoResourceCUDA) > const & Resource, uint32 Timestamp, bool bForceKeyframe, [TFunction](API\Runtime\Core\GenericPlatform\TFunction)< [FAVResult](API\Plugins\AVCodecsCore\FAVResult)()> ApplyConfigFunc )


className: FEncoderNVENC

description: This class is the core of the NVENC encoder logic. It is embedded inside NVCodecEncoders using composition instead of inheritance because templates + inheritance was bit messy here where we need concrete types.

code: class FEncoderNVENC


description: FAVResult.


code: virtual [FAVResult](API\Plugins\AVCodecsCore\FAVResult) Open ( [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FAVDevice](API\Plugins\AVCodecsCore\FAVDevice) > const & NewDevice, [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FAVInstance](API\Plugins\AVCodecsCore\FAVInstance) > const & NewInstance )


code: virtual [FAVResult](API\Plugins\AVCodecsCore\FAVResult) SendFrame ( [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FVideoResourceCUDA](API\Plugins\NVCodecs\Video\Resources\FVideoResourceCUDA) > const & Resource, uint32 Timestamp, bool bForceKeyframe )


code: virtual [FAVResult](API\Plugins\AVCodecsCore\FAVResult) SendFrame ( [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FVideoResource](API\Plugins\AVCodecsCore\Video\FVideoResource) > const & Resource, uint32 Timestamp, bool bForceKeyframe, [TFunction](API\Runtime\Core\GenericPlatform\TFunction)< [FAVResult](API\Plugins\AVCodecsCore\FAVResult)()> ApplyConfigFunc, [TFunction](API\Runtime\Core\GenericPlatform\TFunction)< void(NV_ENC_REGISTER_RESOURCE &)> SetResourceToRegisterFunc )


className: FVideoEncoderNVENCCUDA

description: An AVCodecs VideoEncoder that takes aFVideoResourceCUDA.

code: class FVideoEncoderNVENCCUDA : public [TVideoEncoder< FVideoResourceCUDA, FVideoEncoderConfigNVENC >](API\Plugins\AVCodecsCore\Video\TVideoEncoder)


module: ObjectMixerEditor

code: FLogCategoryLogObjectMixerEditor()


className: FLogCategoryLogObjectMixerEditor

code: struct FLogCategoryLogObjectMixerEditor : public [FLogCategory< ELogVerbosity::Log, ELogVerbosity::All >](API\Runtime\Core\Logging\FLogCategory)


code: bool operator== ( const [FObjectMixerCollectionObjectData](API\Plugins\ObjectMixerEditor\FObjectMixerCollectionObjectData) & Other ) const


className: FObjectMixerCollectionObjectData

ObjectPath

type: FSoftObjectPath


code: bool operator== ( const [FObjectMixerCollectionObjectSet](API\Plugins\ObjectMixerEditor\FObjectMixerCollectionObjectSet) & Other ) const


className: FObjectMixerCollectionObjectSet

CollectionName

type: FName

CollectionObjects

type: TArray<FObject...


code: bool operator== ( const [FObjectMixerColumnData](API\Plugins\ObjectMixerEditor\FObjectMixerColumnData) & Other ) const


className: FObjectMixerColumnData


className: BaseObjectMixerModuleName

code: static const [FName](API\Runtime\Core\UObject\FName) BaseObjectMixerModuleName;


code: virtual void BindDelegates()


description: Tries to find the nomad tab assigned to this instance of Object Mixer. If DockTab is not set, will try to find the tab usingGetTabSpawnerId().

code: virtual [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [SDockTab](API\Runtime\Slate\Widgets\Docking\SDockTab) > FindNomadTab()


className: FOnBlueprintFilterCompiled

code: typedef TMulticastDelegate_NoParams< void > FOnBlueprintFilterCompiled


code: static [FObjectMixerEditorModule](API\Plugins\ObjectMixerEditor\FObjectMixerEditorModule) & Get()


description: This is the filter class used to initialize the ListModel. This filter class cannot be turned off by the end user.

code: const [TSubclassOf](API\Runtime\CoreUObject\Templates\TSubclassOf)< [UObjectMixerObjectFilter](API\Plugins\ObjectMixerEditor\ObjectFilter\UObjectMixerObjectFilter) > & GetDefaultFilterClass() const


code: virtual [FName](API\Runtime\Core\UObject\FName) GetModuleName() const


description: If a property is changed that has a name found in this set, the panel will be refreshed.

code: [TSet](API\Runtime\Core\Containers\TSet)< [FName](API\Runtime\Core\UObject\FName) > GetPropertiesThatRequireRefresh() const


code: virtual [UWorld](API\Runtime\Engine\Engine\UWorld) * GetWorld()


code: virtual void Initialize()


description: Called when the Rename command is executed from the UI or hotkey.

code: virtual void OnRenameCommand()


code: virtual [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [SWidget](API\Runtime\SlateCore\Widgets\SWidget) > MakeObjectMixerDialog ( [TSubclassOf](API\Runtime\CoreUObject\Templates\TSubclassOf)< [UObjectMixerObjectFilter](API\Plugins\ObjectMixerEditor\ObjectFilter\UObjectMixerObjectFilter) > InDefaultFilterClass )


code: static void OpenProjectSettings()


description: Refresh filters and sorting. Useful for when the list state has gone stale but the variable count has not changed.

code: virtual void RefreshList() const


description:
Build the List widget from scratch. If DockTab is not set, will try to find the tab usingGetTabSpawnerId().
True if the widget was regenerated. False if the DockTab was invalid and could not be found.

code: bool RegenerateListWidget()


description:
Add a tab spawner to the Object Mixer menu group.
If adding the item to the menu was successful

code: bool RegisterItemInMenuGroup ( [FWorkspaceItem](API\Runtime\Slate\Framework\Docking\FWorkspaceItem) & InItem )


code: void RegisterMenuGroup()


code: virtual void RegisterSettings() const


code: virtual void RegisterTabSpawner()


description: Regenerate the list items and refresh the list. Call when adding or removing variables.

code: virtual void RequestRebuildList() const


code: virtual void SetupMenuItemVariables()


description: Called before the module is unloaded, right before the module object is destroyed. During normal shutdown, this is called in reverse order that modules finishStartupModule(). This means that, as long as a module references dependent modules in it'sStartupModule(), it can safely reference those dependencies inShutdownModule()as well.

code: virtual void ShutdownModule()


code: virtual [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [SDockTab](API\Runtime\Slate\Widgets\Docking\SDockTab) > SpawnTab ( const [FSpawnTabArgs](API\Runtime\Slate\Framework\Docking\FSpawnTabArgs) & Args )


description: FModuleManager::Get().LoadModuleChecked(TEXT("HTTP"));

code: virtual void StartupModule()


code: virtual void Teardown()


code: void UnregisterMenuGroup()


code: virtual void UnregisterSettings() const


code: virtual void UnregisterTabSpawner()


className: FObjectMixerEditorModule

code: class FObjectMixerEditorModule : public [IModuleInterface](API\Runtime\Core\Modules\IModuleInterface)

DefaultFilterClass

type: TSubclassOf<UO...

description: If set, this is the filter class used to initialize the ListModel.

DelegateHandles

type: TSet<FDelegate...

DockTab

type: TWeakPtr<SDock...

description: The actual spawned nomad tab

ListModel

type: TSharedPtr<FOb...

description: Lives for as long as the module is loaded.

MenuItemIcon

type: FSlateIcon

MenuItemName

type: FText

description: Menu Item variables

OnBlueprintFilterCompiledDelegate

type: FOnBlueprintFil...

TabLabel

description: The text that appears on the spawned nomad tab

TabSpawnerType

type: ETabSpawnerMenu...


code: static const [ISlateStyle](API\Runtime\SlateCore\Styling\ISlateStyle) & Get()


description: anFSlateBrushproperty.

code: virtual const [FSlateBrush](API\Runtime\SlateCore\Styling\FSlateBrush) * GetBrush ( const [FName](API\Runtime\Core\UObject\FName) PropertyName, const ANSICHAR * Specifier, const [ISlateStyle](API\Runtime\SlateCore\Styling\ISlateStyle) * RequestingStyle ) const


description: The name used to identity this style set

code: virtual const [FName](API\Runtime\Core\UObject\FName) & GetStyleSetName() const


code: template<typename WidgetStyleType> static const WidgetStyleType & GetWidgetStyle ( [FName](API\Runtime\Core\UObject\FName) PropertyName, const ANSICHAR * Specifier )


code: static void Initialize()


code: static void ReloadTextures()


className: StyleInstance

code: static [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FSlateStyleSet](API\Runtime\SlateCore\Styling\FSlateStyleSet) > StyleInstance = nullptr;


className: FObjectMixerEditorStyle

code: class FObjectMixerEditorStyle : private [FSlateStyleSet](API\Runtime\SlateCore\Styling\FSlateStyleSet)


code: bool operator== ( const [FObjectMixerSerializationDataPerFilter](API\Plugins\ObjectMixerEditor\FObjectMixerSerializationDataPer-) & Other ) const


className: FObjectMixerSerializationDataPerFilter

SerializedColumnData

type: TSet<FObjectMi...


className: FOnObjectMixerCollectionChanged

code: typedef TMulticastDelegate_NoParams< void > FOnObjectMixerCollectionChanged


className: FOnObjectMixerCollectionRenamed

code: typedef TMulticastDelegate_TwoParams< void, [FName](API\Runtime\Core\UObject\FName), [FName](API\Runtime\Core\UObject\FName) > FOnObjectMixerCollectionRenamed


className: EObjectMixerInheritanceInclusionOptions

code: enum EObjectMixerInheritanceInclusionOptions { None, IncludeOnlyImmediateParent, IncludeOnlyImmediateChildren, IncludeOnlyImmediateParentAndChildren, IncludeAllParents, IncludeAllChildren, IncludeAllParentsAndChildren, IncludeAllParentsAndOnlyImmediateChildren, IncludeOnlyImmediateParentAndAllChildren, }


className: EObjectMixerTreeViewMode

code: enum EObjectMixerTreeViewMode { NoFolders, Folders, }


description: Specify a list of property names corresponding to columns you don't want to ever show. For example, you can specify "Intensity" and "LightColor" to ensure that they can't be enabled or shown in the UI. Columns not specified can be enabled by the user in the UI.

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintNativeEvent, BlueprintCallable, Category="Object Mixer") virtual [TSet](API\Runtime\Core\Containers\TSet)< [FName](API\Runtime\Core\UObject\FName) > GetColumnsToExclude() const


code: [TSet](API\Runtime\Core\Containers\TSet)< [FName](API\Runtime\Core\UObject\FName) > GetColumnsToExclude_Implementation() const


description: Specify a list of property names corresponding to columns you want to show by default. For example, you can specify "Intensity" and "LightColor" to show only those property columns by default in the UI. Columns not specified will not be shown by default but can be enabled by the user in the UI.

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintNativeEvent, BlueprintCallable, Category="Object Mixer") virtual [TSet](API\Runtime\Core\Containers\TSet)< [FName](API\Runtime\Core\UObject\FName) > GetColumnsToShowByDefault() const


code: [TSet](API\Runtime\Core\Containers\TSet)< [FName](API\Runtime\Core\UObject\FName) > GetColumnsToShowByDefault_Implementation() const


description: Specify a list of property names found in parent classes you want to show that aren't in the specified classes. Note that properties specified here do not override the properties specified inGetColumnsToExclude(). For example, aULightComponentdisplays "LightColor" in the editor's details panel, butULightComponentitself doesn't have a property named "LightColor". Instead it's in its parent class,ULightComponentBase. In this scenario,ULightComponentis specified and PropertyInheritanceInclusionOptions is None, so "LightColor" won't appear by default. Specify "LightColor" in this function to ensure that "LightColor" will appear as a column as long as the property is accessible to one of the specified classes regardless of which parent class it comes from.

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintNativeEvent, BlueprintCallable, Category="Object Mixer") virtual [TSet](API\Runtime\Core\Containers\TSet)< [FName](API\Runtime\Core\UObject\FName) > GetForceAddedColumns() const


code: [TSet](API\Runtime\Core\Containers\TSet)< [FName](API\Runtime\Core\UObject\FName) > GetForceAddedColumns_Implementation() const


description: Specify whether we should return only the properties of the specified classes or the properties of parent and child classes. Defaults to 'None' which only considers the properties of the specified classes. If you're not seeing all the properties you expected, try overloading this function.


code: [TSet](API\Runtime\Core\Containers\TSet)< [UClass](API\Runtime\CoreUObject\UObject\UClass) * > GetObjectClassesToFilter_Implementation() const