1. Epic GamesDeveloper
  3. FVertexFactory

FVertexFactory

Encapsulates a vertex data source which can be linked into a vertex shader.

API > API/Runtime > API/Runtime/RenderCore

Inheritance Hierarchy

References

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

Syntax

class FVertexFactory : public FRenderResource

Remarks

Encapsulates a vertex data source which can be linked into a vertex shader.

Variables

  Type Name Description
Protected variable bool bNeedsDeclaration VF can explicitly set this to false to avoid errors without decls; this is for VFs that fetch from buffers directly (e.g. Niagara)
Protected variable FVertexStreamList Streams The vertex streams used to render the factory.

Constructors

  Type Name Description
Public function    

Functions

  Type Name Description
Protected function Static FVertexElement

AccessStreamComponent ( const FVertexStreamComponent& Component,
uint8 AttributeIndex,
VertexStreamListType& InOutStreams
)

 Creates a vertex element for a vertex stream components.
Protected function FVertexElement

AccessStreamComponent ( const FVertexStreamComponent& Component,
uint8 AttributeIndex,
EVertexInputStreamType InputStreamType
)

 Creates a vertex element for a vertex stream component.
Protected function FVertexElement

AccessStreamComponent ( const FVertexStreamComponent& Component,
uint8 AttributeIndex
)

 Creates a vertex element for a vertex stream components.
Protected function bool

AddPrimitiveIdStreamElement ( EVertexInputStreamType InputStreamType,
FVertexDeclarationElementList& Elements,
uint8 AttributeIndex,
uint8 AttributeIndex_Mobile
)

  
Public function FVertexDeclarationRHIRef & Accessors.
Public function Const const FVertexDeclarationRHIRef &

GetDeclaration ( EVertexInputStreamType InputStreamType
)

  
Public function Const int32

GetPrimitiveIdStreamIndex ( const FStaticFeatureLevel InFeatureLevel,
EVertexInputStreamType InputStreamType
)

  
Public function Static void

GetPSOPrecacheVertexFetchElements ( EVertexInputStreamType VertexInputStreamType,
FVertexDeclarationElementList& Elements
)

 Can be overridden by FVertexFactory subclasses which have EVertexFactoryFlags::SupportsPSOPrecaching set - this function will only be called when that flag is set
Public function Const void

GetStreams ( ERHIFeatureLevel::Type InFeatureLevel,
EVertexInputStreamType VertexStreamType,
FVertexInputStreamArray& OutVertexStreams
)

  
Public function Virtual Const FVertexFactoryType *

GetType ()

  
Protected function void

InitDeclaration ( const FVertexDeclarationElementList& Elements,
EVertexInputStreamType StreamType
)

 Initializes the vertex declaration.
Public function Virtual Const bool  
Public function Static void Can be overridden by FVertexFactory subclasses to modify their compile environment just before compilation occurs.
Public function Const bool  
Public function Const void

OffsetInstanceStreams ( uint32 InstanceOffset,
EVertexInputStreamType VertexStreamType,
FVertexInputStreamArray& VertexStreams
)

  
Public function Virtual Const bool  
Public function void

SetDeclaration ( FVertexDeclarationRHIRef& NewDeclaration
)

  
Protected function void

SetPrimitiveIdStreamIndex ( const FStaticFeatureLevel InFeatureLevel,
EVertexInputStreamType InputStreamType,
int32 StreamIndex
)

  
Public function Const bool

SupportsGPUScene ( const FStaticFeatureLevel InFeatureLevel
)

  
Public function Const bool

SupportsManualVertexFetch ( const FStaticFeatureLevel InFeatureLevel
)

  
Public function Const bool Indicates whether the vertex factory supports a null pixel shader.
Public function Virtual Const bool Indicates whether the vertex factory supports a position-and-normal-only stream.
Public function Virtual Const bool Indicates whether the vertex factory supports a position-only stream.
Public function Static void

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

 Can be overridden by FVertexFactory subclasses to fail a compile based on compilation output.

Overridden from FRenderResource

  Type Name Description
Public function Virtual void Releases the RHI resources used by this resource.

Classes

  Type Name Description
Protected struct FVertexStream Information needed to set a vertex stream.  

Typedefs

Name Description
FVertexStreamList  

Constants

Name Description
PrimitiveIdStreamStride  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page