1. Epic GamesDeveloper
  3. FColorVertexBuffer

FColorVertexBuffer

A vertex buffer of colors.

Unreal Engine C++ API Reference > Runtime > Engine > Rendering

Inheritance Hierarchy

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

  Type Name Description
Public function   Default constructor.

Destructors

  Type Name Description
Public function   Destructor.

Functions

  Type Name Description
Public function bool

AppendVertices ( const FStaticMeshBuildVertex* Vertices,
const uint32 NumVerticesToAppend
)

 Appends the specified vertices to the end of the buffer
Public function Const void

BindColorVertexBuffer ( const FVertexFactory* VertexFactory,
FStaticMeshDataType& StaticMeshData
)

  
Public function Static void

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

  
Public function void

CleanUp ()

 Delete existing resources
Public function void  
Public function FBufferRHIRef  
Public function FBufferRHIRef Create an RHI vertex buffer with CPU data.
Public function Const void

ExportText ( FString& ValueStr
)

 Export the data to a string, used for editor Copy&Paste.
Public function Const uint32 Useful for memory profiling.
Public function Const bool  
Public function Const FRHIShaderResourceView *  
Public function Const uint32  
Public function Const uint32 Other accessors.
Public function Const void

GetVertexColors ( TArray< FColor >& OutColors
)

 Gets all vertex colors in the buffer
Public function void *  
Public function Const const void *  
Public function void

ImportText ( const TCHAR* SourceText
)

 Export the data from a string, used for editor Copy&Paste.
Public function void

Init ( const FColorVertexBuffer& InVertexBuffer,
bool bNeedsCPUAccess
)

 Initializes this vertex buffer with the contents of the given vertex buffer.
Public function void

Init ( const FConstMeshBuildVertexView& InVertices,
bool bNeedsCPUAccess
)

  
Public function void

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

 Initializes the buffer with the given vertices, used to convert legacy layouts.
Public function void

Init ( uint32 InNumVertices,
bool bNeedsCPUAccess
)

  
Public function void

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

 Load from a array of colors Load from raw color array
Public function void

InitFromColorArray ( const TArray< FColor >& InColors
)

 Load from raw color array.
Public function void

InitFromSingleColor ( const FColor& InColor,
uint32 Count
)

 Load from single color.
Public function void

InitRHIForStreaming ( FRHIBuffer* IntermediateBuffer,
FRHIResourceUpdateBatcher& Batcher
)

 Similar to Init/ReleaseRHI but only update existing SRV so references to the SRV stays valid
Public function void  
Public function void

Serialize ( FArchive& Ar,
bool bNeedsCPUAccess
)

 SerializerSerializer
Public function void  
Public function FColor &

VertexColor ( uint32 VertexIndex
)

  
Public function Const const FColor &

VertexColor ( uint32 VertexIndex
)

  

Overridden from FRenderResource

  Type Name Description
Public function Virtual Const FString  
Public function Virtual void

InitRHI ( FRHICommandListBase& RHICmdList
)

 Initializes the RHI resources used by this resource.
Public function Virtual void Releases the RHI resources used by this resource.

Operators

  Type Name Description
Public function void

operator= ( const FColorVertexBuffer& Other
)

 Specialized assignment operator, only used when importing LOD's.

Enums

  Type Name Description
Public enum NullBindStride    

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page