1. Epic GamesDeveloper
  3. FColorVertexBuffer

FColorVertexBuffer

A vertex buffer of colors.

API > API/Runtime > API/Runtime/Engine

A vertex buffer of colors.

   
Name FColorVertexBuffer
Type class
Header File /Engine/Source/Runtime/Engine/Public/Rendering/ColorVertexBuffer.h
Include Path #include "Rendering/ColorVertexBuffer.h"

Syntax

class FColorVertexBuffer : public FVertexBuffer

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers
Default constructor. Rendering/ColorVertexBuffer.h  
Purposely hidden Rendering/ColorVertexBuffer.h  

Destructors

Name Remarks Include Path Unreal Specifiers

~FColorVertexBuffer()

 Destructor. Rendering/ColorVertexBuffer.h  

Enums

Public

Name Remarks
NullBindStride  

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
ColorComponentsSRV FShaderResourceViewRHIRef   Rendering/ColorVertexBuffer.h  
Data uint8 * The cached vertex data pointer. Rendering/ColorVertexBuffer.h  
NeedsCPUAccess bool   Rendering/ColorVertexBuffer.h  
NumVertices uint32 The cached number of vertices. Rendering/ColorVertexBuffer.h  
Stride uint32 The cached vertex stride. Rendering/ColorVertexBuffer.h  
VertexData FColorVertexData * The vertex data storage type Rendering/ColorVertexBuffer.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

bool AppendVertices ( const FStaticMeshBuildVertex* Vertices,
const uint32 NumVerticesToAppend
)

 Appends the specified vertices to the end of the buffer Rendering/ColorVertexBuffer.h  

void BindColorVertexBuffer ( const FVertexFactory* VertexFactory,
FStaticMeshDataType& StaticMeshData
) const

   Rendering/ColorVertexBuffer.h  

void CleanUp()

 Delete existing resources Rendering/ColorVertexBuffer.h  

void ClearMetaData()

   Rendering/ColorVertexBuffer.h  

FBufferRHIRef CreateRHIBuffer ( FRHICommandListBase& RHICmdList
)

 Create an RHI vertex buffer with CPU data. Rendering/ColorVertexBuffer.h  

void ExportText ( FString& ValueStr
) const

 Export the data to a string, used for editor Copy&Paste. Rendering/ColorVertexBuffer.h  

uint32 GetAllocatedSize()

 Useful for memory profiling. Rendering/ColorVertexBuffer.h  

bool GetAllowCPUAccess()

   Rendering/ColorVertexBuffer.h  

FRHIShaderResourceView * GetColorComponentsSRV()

   Rendering/ColorVertexBuffer.h  

uint32 GetNumVertices()

   Rendering/ColorVertexBuffer.h  

uint32 GetStride()

 Other accessors. Rendering/ColorVertexBuffer.h  

void GetVertexColors ( TArray< FColor >& OutColors
) const

 Gets all vertex colors in the buffer Rendering/ColorVertexBuffer.h  

const void * GetVertexData ()

   Rendering/ColorVertexBuffer.h  

void * GetVertexData ()

   Rendering/ColorVertexBuffer.h  

void ImportText ( const TCHAR* SourceText
)

 Export the data from a string, used for editor Copy&Paste. Rendering/ColorVertexBuffer.h  

void Init ( const FColorVertexBuffer& InVertexBuffer,
bool bNeedsCPUAccess
)

 Initializes this vertex buffer with the contents of the given vertex buffer. Rendering/ColorVertexBuffer.h  

void Init ( const FConstMeshBuildVertexView& InVertices,
bool bNeedsCPUAccess
)

   Rendering/ColorVertexBuffer.h  

void Init ( const TArray< FStaticMeshBuildVertex >& InVertices,
bool bNeedsCPUAccess
)

 Initializes the buffer with the given vertices, used to convert legacy layouts. Rendering/ColorVertexBuffer.h  

void Init ( uint32 InNumVertices,
bool bNeedsCPUAccess
)

   Rendering/ColorVertexBuffer.h  

void InitFromColorArray ( const FColor* InColors,
uint32 Count,
uint32 Stride,
bool bNeedsCPUAccess
)

 Load from a array of colors Load from raw color array Rendering/ColorVertexBuffer.h  

void InitFromColorArray ( const TArray< FColor >& InColors
)

 Load from raw color array. Rendering/ColorVertexBuffer.h  

void InitFromSingleColor ( const FColor& InColor,
uint32 Count
)

 Load from single color. Rendering/ColorVertexBuffer.h  

void InitRHIForStreaming ( FRHIBuffer* IntermediateBuffer,
FRHIResourceReplaceBatcher& Batcher
)

 Similar to Init/ReleaseRHI but only update existing SRV so references to the SRV stays valid Rendering/ColorVertexBuffer.h  

void ReleaseRHIForStreaming ( FRHIResourceReplaceBatcher& Batcher
)

   Rendering/ColorVertexBuffer.h  

void Serialize ( FArchive& Ar,
bool bNeedsCPUAccess
)

 SerializerSerializer Rendering/ColorVertexBuffer.h  

void SerializeMetaData ( FArchive& Ar
)

   Rendering/ColorVertexBuffer.h  

void SetMetaData ( uint32 InStride,
uint32 InNumVertices
)

   Rendering/ColorVertexBuffer.h  

FColor & VertexColor ( uint32 VertexIndex
)

   Rendering/ColorVertexBuffer.h  

const FColor & VertexColor ( uint32 VertexIndex
) const

   Rendering/ColorVertexBuffer.h  

Overridden from FRenderResource

Name Remarks Include Path Unreal Specifiers

virtual FString GetFriendlyName()

   Rendering/ColorVertexBuffer.h  

virtual void InitRHI ( FRHICommandListBase& RHICmdList
)

   Rendering/ColorVertexBuffer.h  

virtual void ReleaseRHI()

   Rendering/ColorVertexBuffer.h  

Static

Name Remarks Include Path Unreal Specifiers

static void BindDefaultColorVertexBuffer ( const FVertexFactory* VertexFactory,
FStaticMeshDataType& StaticMeshData,
NullBindStride BindStride
)

   Rendering/ColorVertexBuffer.h  

Operators

Name Remarks Include Path Unreal Specifiers

void operator= ( const FColorVertexBuffer& Other
)

 Specialized assignment operator, only used when importing LOD's. Rendering/ColorVertexBuffer.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page