Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > Engine > Rendering > FColorVertexBuffer

Light Theme

Dark Theme

FColorVertexBuffer

A vertex buffer of colors.

Windows

MacOS

Linux

Inheritance Hierarchy

FRenderResource

FVertexBuffer

FColorVertexBuffer

References

Module	Engine
Header	/Engine/Source/Runtime/Engine/Public/Rendering/ColorVertexBuffer.h
Include	#include "Rendering/ColorVertexBuffer.h"

Syntax

class FColorVertexBuffer : public FVertexBuffer

Remarks

A vertex buffer of colors.

Constructors

	Name	Description
	FColorVertexBuffer()	Default constructor.

Destructors

	Name	Description
	~FColorVertexBuffer()	Destructor.

Functions

	Name	Description
void	AppendVertices ( const FStaticMeshBuildVertex* ..., const uint32 NumVerticesToAppend )	Appends the specified vertices to the end of the buffer
void	BindColorVertexBuffer ( const FVertexFactory* VertexFa..., FStaticMeshDataType& StaticMeshDat... )
void	BindDefaultColorVertexBuffer ( const FVertexFactory* VertexFa..., FStaticMeshDataType& StaticMeshDat..., NullBindStride BindStride )
void	CleanUp()	Delete existing resources
void	ClearMetaData()
void	CopyRHIForStreaming ( const FColorVertexBuffer& Other, bool InAllowCPUAccess )	Copy everything, keeping reference to the same RHI resources.
FVertexBuffe...	CreateRHIBuffer_Async()
FVertexBuffe...	CreateRHIBuffer_RenderThread()	Create an RHI vertex buffer with CPU data.
void	ExportText ( FString& ValueStr )	Export the data to a string, used for editor Copy&Paste.
uint32	GetAllocatedSize()	Useful for memory profiling.
FRHIShaderRe...	GetColorComponentsSRV()
uint32	GetNumVertices()
uint32	GetStride()	Other accessors.
void	GetVertexColors ( TArray< FColor >& OutColors )	Gets all vertex colors in the buffer
void *	GetVertexData()
void	ImportText ( const TCHAR* SourceText )	Export the data from a string, used for editor Copy&Paste.
void	Init ( uint32 InNumVertices, bool bNeedsCPUAccess )
void	Init ( const TArray< FStaticMeshBuildVerte..., bool bNeedsCPUAccess )	Initializes the buffer with the given vertices, used to convert legacy layouts.
void	Init ( const FColorVertexBuffer& InVertex..., bool bNeedsCPUAccess )	Initializes this vertex buffer with the contents of the given vertex buffer.
void	InitFromColorArray ( const TArray< FColor >& InColors )	Load from raw color array.
void	InitFromColorArray ( const FColor* InColors, uint32 Count, uint32 Stride, bool bNeedsCPUAccess )	Load from a array of colors Load from raw color array
void	InitFromSingleColor ( const FColor& InColor, uint32 Count )	Load from single color.
void	InitRHIForStreaming ( FRHIVertexBuffer* Intermediate..., TRHIResourceUpdateBatcher< MaxNumUp... )	Similar to Init/ReleaseRHI but only update existing SRV so references to the SRV stays valid
void	ReleaseRHIForStreaming ( TRHIResourceUpdateBatcher< MaxNumUp... )
void	Serialize ( FArchive& Ar, bool bNeedsCPUAccess )	Serializer Serializer
void	SerializeMetaData ( FArchive& Ar )
FColor &	VertexColor ( uint32 VertexIndex )
const FColor...	VertexColor ( uint32 VertexIndex )

Overridden from FRenderResource

	Name	Description
FString	GetFriendlyName()
void	InitRHI()	Initializes the RHI resources used by this resource.
void	ReleaseRHI()	Releases the RHI resources used by this resource.

Operators

		Name	Description
	void	operator= ( const FColorVertexBuffer& Other )	Specialized assignment operator, only used when importing LOD's.

Enums

	Name	Description
	NullBindStride

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss