1. Epic GamesDeveloper
  3. FPositionVertexBuffer

FPositionVertexBuffer

A vertex buffer of positions.

API > API/Runtime > API/Runtime/Engine

A vertex buffer of positions.

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

Syntax

class FPositionVertexBuffer : public FVertexBuffer

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

FPositionVertexBuffer()

 Default constructor. Rendering/PositionVertexBuffer.h  

Destructors

Name Remarks Include Path Unreal Specifiers

~FPositionVertexBuffer()

 Destructor. Rendering/PositionVertexBuffer.h  

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
bNeedsCPUAccess bool   Rendering/PositionVertexBuffer.h  
Data uint8 * The cached vertex data pointer. Rendering/PositionVertexBuffer.h  
NumVertices uint32 The cached number of vertices. Rendering/PositionVertexBuffer.h  
PositionComponentSRV FShaderResourceViewRHIRef   Rendering/PositionVertexBuffer.h  
Stride uint32 The cached vertex stride. Rendering/PositionVertexBuffer.h  
VertexData FPositionVertexData * The vertex data storage type Rendering/PositionVertexBuffer.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/PositionVertexBuffer.h  

void BindPositionVertexBuffer ( const FVertexFactory* VertexFactory,
FStaticMeshDataType& Data
) const

   Rendering/PositionVertexBuffer.h  

void CleanUp()

 Delete existing resources Rendering/PositionVertexBuffer.h  

void ClearMetaData()

   Rendering/PositionVertexBuffer.h  

FBufferRHIRef CreateRHIBuffer ( FRHICommandListBase& RHICmdList
)

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

SIZE_T GetAllocatedSize()

   Rendering/PositionVertexBuffer.h  

bool GetAllowCPUAccess()

   Rendering/PositionVertexBuffer.h  

uint32 GetNumVertices()

   Rendering/PositionVertexBuffer.h  
  Rendering/PositionVertexBuffer.h  

uint32 GetStride()

 Other accessors. Rendering/PositionVertexBuffer.h  

const void * GetVertexData ()

   Rendering/PositionVertexBuffer.h  

void * GetVertexData ()

   Rendering/PositionVertexBuffer.h  

void Init ( const TArray< FVector3f >& InPositions,
bool bInNeedsCPUAccess
)

   Rendering/PositionVertexBuffer.h  

void Init ( const FPositionVertexBuffer& InVertexBuffer,
bool bInNeedsCPUAccess
)

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

void Init ( const FConstMeshBuildVertexView& InVertices,
bool bInNeedsCPUAccess
)

   Rendering/PositionVertexBuffer.h  

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

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

void Init ( uint32 NumVertices,
bool bInNeedsCPUAccess
)

   Rendering/PositionVertexBuffer.h  

void InitRHIForStreaming ( FRHIBuffer* IntermediateBuffer,
FRHIResourceReplaceBatcher& Batcher
)

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

void ReleaseRHIForStreaming ( FRHIResourceReplaceBatcher& Batcher
)

   Rendering/PositionVertexBuffer.h  

void Serialize ( FArchive& Ar,
bool bInNeedsCPUAccess
)

 Serializer Rendering/PositionVertexBuffer.h  

void SerializeMetaData ( FArchive& Ar
)

   Rendering/PositionVertexBuffer.h  

void SetMetaData ( uint32 InStride,
uint32 InNumVertices
)

   Rendering/PositionVertexBuffer.h  

FVector3f & VertexPosition ( uint32 VertexIndex
)

 Vertex data accessors. Rendering/PositionVertexBuffer.h  

const FVector3f & VertexPosition ( uint32 VertexIndex
) const

   Rendering/PositionVertexBuffer.h  

Overridden from FRenderResource

Name Remarks Include Path Unreal Specifiers

virtual FString GetFriendlyName()

   Rendering/PositionVertexBuffer.h  

virtual void InitRHI ( FRHICommandListBase& RHICmdList
)

   Rendering/PositionVertexBuffer.h  

virtual void ReleaseRHI()

   Rendering/PositionVertexBuffer.h  

Operators

Name Remarks Include Path Unreal Specifiers

void operator= ( const FPositionVertexBuffer& Other
)

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

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page