FSkinWeightVertexBuffer

A container for skin weights data vertex buffer and lookup vertex buffer.

Windows
MacOS
Linux

References

Module

Engine

Header

/Engine/Source/Runtime/Engine/Public/Rendering/SkinWeightVertexBuffer.h

Include

#include "Rendering/SkinWeightVertexBuffer.h"

Syntax

class FSkinWeightVertexBuffer

Remarks

A container for skin weights data vertex buffer and lookup vertex buffer.

Constructors

Name Description

Public function

FSkinWeightVertexBuffer()

Default constructor.

Public function

FSkinWeightVertexBuffer

(
    const FSkinWeightVertexBuffer & Oth...
)

Constructor (copy)

Destructors

Name Description

Public function

~FSkinWeightVertexBuffer()

Destructor.

Functions

Name Description

Public function

void

 

BeginInitResources()

Public function

void

 

BeginReleaseResources()

Public function

void

 

CleanUp()

Delete existing resources

Public function

void

 

CopyMetaData

(
    const FSkinWeightVertexBuffer & Oth...
)

Public function

FSkinWeightR ...

 

CreateRHIBuffer_Async()

Public function

FSkinWeightR ...

 

CreateRHIBuffer_RenderThread()

Public function Const

uint32

 

GetBoneIndex

(
    uint32 VertexIndex,
    uint32 InfluenceIndex
)

Public function Const

uint32

 

GetBoneIndexByteSize()

Public function Const

GPUSkinBoneI ...

 

GetBoneInfluenceType()

Public function Const

uint8

 

GetBoneWeight

(
    uint32 VertexIndex,
    uint32 InfluenceIndex
)

Public function Const

uint32

 

GetConstantInfluencesBoneWeightsOffset()

Public function Const

uint32

 

GetConstantInfluencesVertexStride()

Public function Const

const FSkinW ...

 

GetDataVertexBuffer()

Public function Const

const FSkinW ...

 

GetLookupVertexBuffer()

Public function Const

uint32

 

GetMaxBoneInfluences()

Public function Const

bool

 

GetNeedsCPUAccess()

Public function Const

uint32

 

GetNumVertices()

Public function Const

bool

 

GetRigidWeightBone

(
    uint32 VertexIndex,
    int32 & OutBoneIndex
)

Public function Const

void

 

GetSkinWeights

(
    TArray < FSkinWeightInfo >& OutVert...
)

Public function Const

bool

 

GetVariableBonesPerVertex()

Public function Const

uint32

 

GetVertexDataSize()

Public function Const

void

 

GetVertexInfluenceOffsetCount

(
    uint32 VertexIndex,
    uint32 & VertexWeightOffset,
    uint32 & VertexInfluenceCount
)

Public function Const

FSkinWeightI ...

 

GetVertexSkinWeights

(
    uint32 VertexIndex
)

Public function

void

 

Init

(
    const TArray < FSoftSkinVertex >& I...
)

Init from another skin weight buffer

Public function

void

 

InitRHIForStreaming

(
    const FSkinWeightRHIInfo & RHIInfo,
    TRHIResourceUpdateBatcher < MaxNumUp...
)

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

Public function

void

 

ReleaseResources()

Public function

void

 

ReleaseRHIForStreaming

(
    TRHIResourceUpdateBatcher < MaxNumUp...
)

Public function

void

 

ResetVertexBoneWeights

(
    uint32 VertexIndex
)

Public function

void

 

SerializeMetaData

(
    FArchive & Ar
)

Public function

void

 

SetBoneIndex

(
    uint32 VertexIndex,
    uint32 InfluenceIndex,
    uint32 BoneIndex
)

Public function

void

 

SetBoneWeight

(
    uint32 VertexIndex,
    uint32 InfluenceIndex,
    uint8 BoneWeight
)

Public function

void

 

SetMaxBoneInfluences

(
    uint32 InMaxBoneInfluences
)

Public function

void

 

SetNeedsCPUAccess

(
    bool bInNeedsCPUAccess
)

Public function

void

 

SetUse16BitBoneIndex

(
    bool bInUse16BitBoneIndex
)

Public function Const

bool

 

Use16BitBoneIndex()

Operators

Name Description

Public function

FSkinWeightV ...

 

operator=

(
    const FSkinWeightVertexBuffer & Oth...
)

  1. Assumes that vertex buffer will be rebuilt

Public function

FSkinWeightV ...

 

operator=

(
    const TArray < FSkinWeightInfo >& I...
)

Assignment operator for assigning array of weights to this buffer

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback