1. Epic GamesDeveloper
  3. FVertexFactoryType

FVertexFactoryType

An object used to represent the type of a vertex factory.

Unreal Engine C++ API Reference > Runtime > RenderCore

References

   
Module RenderCore
Header /Engine/Source/Runtime/RenderCore/Public/VertexFactory.h
Include #include "VertexFactory.h"

Syntax

class FVertexFactoryType

Remarks

An object used to represent the type of a vertex factory.

Constructors

  Type Name Description
Public function  

FVertexFactoryType ( const TCHAR* InName,
const TCHAR* InShaderFilename,
EVertexFactoryFlags InFlags,
ConstructParametersType InConstructParameters,
GetParameterTypeLayoutType InGetParameterTypeLayout,
GetParameterTypeElementShaderBindingsType InGetParameterTypeElementShaderBindings,
GetPSOPrecacheVertexFetchElementsType InGetPSOPrecacheVertexFetchElements,
ShouldCacheType InShouldCache,
ModifyCompilationEnvironmentType InModifyCompilationEnvironment,
ValidateCompiledResultType InValidateCompiledResult
)

  

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function Const void

AddUniformBufferIncludesToEnvironment ( FShaderCompilerEnvironment& OutEnvironment,
EShaderPlatform Platform
)

 Adds include statements for uniform buffers that this shader type references, and builds a prefix for the shader file with the include statements.
Public function Static bool  
Public function Const FVertexFactoryShaderParameters *

CreateShaderParameters ( EShaderFrequency ShaderFrequency,
const FShaderParameterMap& ParameterMap
)

  
Public function Const EVertexFactoryFlags  
Public function Const FName  
Public function Const const FHashedName &  
Public function Const const TCHAR *

GetName ()

 Accessors.
Public function Static int32  
Public function Const const TSet< const TCHAR *, TStringPointerSetKeyFuncs_DEPRECATED< const TCHAR * > > &  
Public function Const const TCHAR *  
Public function Const void

GetShaderParameterElementShaderBindings ( EShaderFrequency ShaderFrequency,
const FVertexFactoryShaderParameters* Parameters,
const FSceneInterface* Scene,
const FSceneView* View,
const FMeshMaterialShader* Shader,
const EVertexInputStreamType InputStreamType,
ERHIFeatureLevel::Type FeatureLevel,
const FVertexFactory* VertexFactory,
const FMeshBatchElement& BatchElement,
FMeshDrawSingleShaderBindings& ShaderBindings,
FVertexInputStreamArray& VertexStreams
)

  
Public function Const const FTypeLayoutDesc *

GetShaderParameterLayout ( EShaderFrequency ShaderFrequency
)

  
Public function Const void

GetShaderPSOPrecacheVertexFetchElements ( EVertexInputStreamType VertexInputStreamType,
FVertexDeclarationElementList& Elements
)

  
Public function Static const TArray< FVertexFactoryType * > &  
Public function Const const FSHAHash &

GetSourceHash ( EShaderPlatform ShaderPlatform
)

 Calculates a Hash based on this vertex factory type's source code and includes
Public function Static TLinkedList< FVertexFactoryType * > *&  
Public function Static FVertexFactoryType *

GetVFByName ( const FHashedName& VFName
)

 Finds a FVertexFactoryType by name.
Public function Const bool

HasFlags ( EVertexFactoryFlags FlagsToCheck
)

 Returns true if this vertex factory supports ALL feature flags in FlagsToCheck
Public function Static void

Initialize ( const TMap< FString, TArray< const TCHAR* > >& ShaderFileToUniformBufferVariables
)

 Initialize FVertexFactoryType static members, this must be called before any VF types are created.
Public function Const bool  
Public function Const void Calls the function ptr for the shader type on the given environment
Public function Const bool Should we cache the material's shadertype on this platform with this vertex factory?
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Static void Uninitializes FVertexFactoryType cached data.
Public function void

UpdateReferencedUniformBufferNames ( const TMap< FString, TArray< const TCHAR* >>& ShaderFileToUniformBufferVariables
)

  
Public function Const void

ValidateCompiledResult ( EShaderPlatform Platform,
const FShaderParameterMap& ParameterMap,
TArray< FString >& OutErrors
)

  

Typedefs

Name Description
ConstructParametersType  
GetParameterTypeElementShaderBindingsType  
GetParameterTypeLayoutType  
GetPSOPrecacheVertexFetchElementsType  
ModifyCompilationEnvironmentType  
ShouldCacheType  
ValidateCompiledResultType  

Constants

Name Description
bInitializedSerializationHistory Tracks whether serialization history for all shader types has been initialized.
NumVertexFactories  

Deprecated Functions

  Type Name Description
Public function Const void

AddReferencedUniformBufferIncludes ( FShaderCompilerEnvironment& OutEnvironment,
FString& OutSourceFilePrefix,
EShaderPlatform Platform
)

 AddReferencedUniformBufferIncludes has moved to AddUniformBufferIncludesToEnvironment and no longer takes a prefix argument.
Public function void

FlushShaderFileCache ( const TMap< FString, TArray< const TCHAR* > >& ShaderFileToUniformBufferVariables
)

 FlushShaderFileCache is deprecated. UpdateReferencedUniformBufferNames should be used to flush any uniform buffer changes

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page